git.sesse.net Git - vlc/blob - src/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h: Internal libvlc generic/misc declaration
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_LIBVLC_H
  26 # define LIBVLC_LIBVLC_H 1
  27
  28 typedef struct variable_t variable_t;
  29
  30 extern const char vlc_usage[];
  31
  32 /* Hotkey stuff */
  33 extern const struct hotkey libvlc_hotkeys[];
  34 extern const size_t libvlc_hotkeys_size;
  35 extern int vlc_key_to_action (vlc_object_t *, const char *,
  36                               vlc_value_t, vlc_value_t, void *);
  37
  38 /*
  39  * OS-specific initialization
  40  */
  41 void system_Init      ( libvlc_int_t *, int *, const char *[] );
  42 void system_Configure ( libvlc_int_t *, int *, const char *[] );
  43 void system_End       ( libvlc_int_t * );
  44
  45 /*
  46  * Legacy object stuff that is still used within libvlccore (only)
  47  */
  48 #define vlc_object_signal_unlocked( obj )
  49
  50 vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
  51 #define VLC_OBJECT_INTF        (-4)
  52 #define VLC_OBJECT_PACKETIZER  (-13)
  53
  54 /*
  55  * Threads subsystem
  56  */
  57
  58 /* Hopefully, no need to export this. There is a new thread API instead. */
  59 void vlc_thread_cancel (vlc_object_t *);
  60 int vlc_object_waitpipe (vlc_object_t *obj);
  61
  62 void vlc_trace (const char *fn, const char *file, unsigned line);
  63 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  64
  65 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
  66 # define vlc_assert_locked( m ) \
  67          assert (pthread_mutex_lock (m) == EDEADLK)
  68 #else
  69 # define vlc_assert_locked( m ) (void)m
  70 #endif
  71
  72 /*
  73  * CPU capabilities
  74  */
  75 extern uint32_t cpu_flags;
  76 uint32_t CPUCapabilities( void );
  77
  78 /*
  79  * Message/logging stuff
  80  */
  81
  82 /**
  83  * Store all data required by messages interfaces.
  84  */
  85 typedef struct msg_bank_t
  86 {
  87     /** Message queue lock */
  88     vlc_mutex_t lock;
  89     vlc_cond_t  wait;
  90
  91     /* Subscribers */
  92     int i_sub;
  93     msg_subscription_t **pp_sub;
  94
  95     /* Logfile for WinCE */
  96 #ifdef UNDER_CE
  97     FILE *logfile;
  98 #endif
  99 } msg_bank_t;
 100
 101 void msg_Create  (libvlc_int_t *);
 102 void msg_Destroy (libvlc_int_t *);
 103
 104 /** Internal message stack context */
 105 void msg_StackSet ( int, const char*, ... );
 106 void msg_StackAdd ( const char*, ... );
 107 const char* msg_StackMsg ( void );
 108 void msg_StackDestroy (void *);
 109
 110 /*
 111  * Unicode stuff
 112  */
 113 char *vlc_fix_readdir (const char *);
 114
 115 /*
 116  * LibVLC objects stuff
 117  */
 118
 119 /**
 120  * Creates a VLC object.
 121  *
 122  * Note that because the object name pointer must remain valid, potentially
 123  * even after the destruction of the object (through the message queues), this
 124  * function CANNOT be exported to plugins as is. In this case, the old
 125  * vlc_object_create() must be used instead.
 126  *
 127  * @param p_this an existing VLC object
 128  * @param i_size byte size of the object structure
 129  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 130  * @param psz_type object type name
 131  * @return the created object, or NULL.
 132  */
 133 extern void *
 134 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 135                      const char *psz_type);
 136 #define vlc_custom_create(o, s, t, n) \
 137         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 138
 139 /*
 140  * To be cleaned-up module stuff:
 141  */
 142 extern char *psz_vlcpath;
 143
 144 /* Return a NULL terminated array with the names of the modules that have a
 145  * certain capability.
 146  * Free after uses both the string and the table. */
 147 char **module_GetModulesNamesForCapability (const char * psz_capability,
 148                                             char ***psz_longname);
 149 module_t *module_find_by_shortcut (const char *psz_shortcut);
 150
 151 /**
 152  * Private LibVLC data for each object.
 153  */
 154 typedef struct vlc_object_internals_t
 155 {
 156     int             i_object_type; /* Object type, deprecated */
 157
 158     /* Object variables */
 159     variable_t *    p_vars;
 160     vlc_mutex_t     var_lock;
 161     vlc_cond_t      var_wait;
 162     int             i_vars;
 163
 164     /* Thread properties, if any */
 165     vlc_thread_t    thread_id;
 166     bool            b_thread;
 167
 168     /* Objects thread synchronization */
 169     int             pipes[2];
 170
 171     /* Objects management */
 172     vlc_spinlock_t   ref_spin;
 173     unsigned         i_refcount;
 174     vlc_destructor_t pf_destructor;
 175
 176     /* Objects tree structure */
 177     vlc_object_t    *prev, *next;
 178     vlc_object_t   **pp_children;
 179     int              i_children;
 180 } vlc_object_internals_t;
 181
 182 #define ZOOM_SECTION N_("Zoom")
 183 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 184 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 185 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 186 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 187
 188 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 189
 190 typedef struct sap_handler_t sap_handler_t;
 191
 192 /**
 193  * Private LibVLC instance data.
 194  */
 195 typedef struct libvlc_priv_t
 196 {
 197     libvlc_int_t       public_data;
 198     vlc_cond_t         exiting; ///< signaled when VLC wants to exit
 199
 200     /* Configuration */
 201     vlc_mutex_t        config_lock; ///< config file lock
 202     char *             psz_configfile;   ///< location of config file
 203
 204     int                i_last_input_id ; ///< Last id of input item
 205
 206     /* Messages */
 207     msg_bank_t         msg_bank;    ///< The message bank
 208     int                i_verbose;   ///< info messages
 209     bool               b_color;     ///< color messages?
 210     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 211     bool               msg_all_objects_enabled; ///< Should we print all objects?
 212
 213     /* Timer stats */
 214     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 215     counter_t        **pp_timers;   ///< Array of all timers
 216     int                i_timers;    ///< Number of timers
 217     bool               b_stats;     ///< Whether to collect stats
 218
 219     /* Singleton objects */
 220     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 221     playlist_t        *p_playlist; //< the playlist singleton
 222     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 223     interaction_t     *p_interaction;    ///< interface interaction object
 224     intf_thread_t     *p_interaction_intf; ///< XXX interface for interaction
 225     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 226 #ifdef ENABLE_SOUT
 227     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 228 #endif
 229     vlc_mutex_t        structure_lock;
 230 } libvlc_priv_t;
 231
 232 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 233 {
 234     return (libvlc_priv_t *)libvlc;
 235 }
 236
 237 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 238
 239 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 240
 241 /**
 242  * LibVLC "main module" configuration settings array.
 243  */
 244 extern module_config_t libvlc_config[];
 245 extern const size_t libvlc_config_count;
 246
 247 /*
 248  * Variables stuff
 249  */
 250 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 251
 252
 253 /*
 254  * Stats stuff
 255  */
 256 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
 257 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
 258 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
 259 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
 260 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
 261 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
 262
 263 void stats_CounterClean (counter_t * );
 264
 265 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
 266 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 267                                       int *value )
 268 {
 269     int i_ret;
 270     vlc_value_t val; val.i_int = 0;
 271     if( !p_counter ) return VLC_EGENERIC;
 272     i_ret = __stats_Get( p_obj, p_counter, &val );
 273     *value = val.i_int;
 274     return i_ret;
 275 }
 276
 277 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
 278 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 279                                     float *value )
 280 {
 281     int i_ret;
 282     vlc_value_t val; val.f_float = 0.0;
 283     if( !p_counter ) return VLC_EGENERIC;
 284     i_ret = __stats_Get( p_obj, p_counter, &val );
 285     *value = val.f_float;
 286     return i_ret;
 287 }
 288 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
 289 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
 290                                          int i, int *pi_new )
 291 {
 292     int i_ret;
 293     vlc_value_t val;
 294     vlc_value_t new_val; new_val.i_int = 0;
 295     if( !p_co ) return VLC_EGENERIC;
 296     val.i_int = i;
 297     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
 298     if( pi_new )
 299         *pi_new = new_val.i_int;
 300     return i_ret;
 301 }
 302 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
 303 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
 304                                        float f, float *pf_new )
 305 {
 306     vlc_value_t val;
 307     int i_ret;
 308     vlc_value_t new_val;new_val.f_float = 0.0;
 309     if( !p_co ) return VLC_EGENERIC;
 310     val.f_float = f;
 311     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
 312     if( pf_new )
 313         *pf_new = new_val.f_float;
 314     return i_ret;
 315 }
 316
 317 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
 318 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
 319 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
 320
 321 /*
 322  * Replacement functions
 323  */
 324 # ifndef HAVE_DIRENT_H
 325 typedef void DIR;
 326 #  ifndef FILENAME_MAX
 327 #      define FILENAME_MAX (260)
 328 #  endif
 329 struct dirent
 330 {
 331     long            d_ino;          /* Always zero. */
 332     unsigned short  d_reclen;       /* Always zero. */
 333     unsigned short  d_namlen;       /* Length of name in d_name. */
 334     char            d_name[FILENAME_MAX]; /* File name. */
 335 };
 336 #  define opendir vlc_opendir
 337 #  define readdir vlc_readdir
 338 #  define closedir vlc_closedir
 339 #  define rewinddir vlc_rewindir
 340 void *vlc_opendir (const char *);
 341 void *vlc_readdir (void *);
 342 int   vlc_closedir(void *);
 343 void  vlc_rewinddir(void *);
 344 # endif
 345
 346 #if defined (WIN32)
 347 #   include <dirent.h>
 348 void *vlc_wopendir (const wchar_t *);
 349 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 350 struct _wdirent *vlc_wreaddir (void *);
 351 void vlc_rewinddir (void *);
 352 #   define _wopendir vlc_wopendir
 353 #   define _wreaddir vlc_wreaddir
 354 #   define _wclosedir vlc_wclosedir
 355 #   define rewinddir vlc_rewinddir
 356 #endif
 357
 358 #endif