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