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