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_InitActions (libvlc_int_t *);
  39 extern void vlc_DeinitActions (libvlc_int_t *);
  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 void vlc_object_detach (vlc_object_t *);
  52 #define vlc_object_detach( o ) vlc_object_detach(VLC_OBJECT(o))
  53
  54 /*
  55  * Threads subsystem
  56  */
  57
  58 /* This cannot be used as is from plugins: */
  59 void vlc_detach (vlc_thread_t);
  60
  61 /* Hopefully, no need to export this. There is a new thread API instead. */
  62 void vlc_thread_cancel (vlc_object_t *);
  63 int vlc_object_waitpipe (vlc_object_t *obj);
  64
  65 void vlc_threads_setup (libvlc_int_t *);
  66
  67 void vlc_trace (const char *fn, const char *file, unsigned line);
  68 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  69
  70 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
  71 void vlc_assert_locked (vlc_mutex_t *);
  72 #else
  73 # define vlc_assert_locked( m ) (void)m
  74 #endif
  75
  76 /*
  77  * CPU capabilities
  78  */
  79 extern uint32_t cpu_flags;
  80 uint32_t CPUCapabilities( void );
  81 bool vlc_CPU_CheckPluginDir (const char *name);
  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 module_t *module_find_by_shortcut (const char *psz_shortcut);
 155
 156 /**
 157  * Private LibVLC data for each object.
 158  */
 159 typedef struct vlc_object_internals vlc_object_internals_t;
 160
 161 struct vlc_object_internals
 162 {
 163     int             i_object_type; /* Object type, deprecated */
 164     char           *psz_name; /* given name */
 165
 166     /* Object variables */
 167     void           *var_root;
 168     vlc_mutex_t     var_lock;
 169     vlc_cond_t      var_wait;
 170
 171     /* Thread properties, if any */
 172     vlc_thread_t    thread_id;
 173     bool            b_thread;
 174
 175     /* Objects thread synchronization */
 176     int             pipes[2];
 177
 178     /* Objects management */
 179     vlc_spinlock_t   ref_spin;
 180     unsigned         i_refcount;
 181     vlc_destructor_t pf_destructor;
 182
 183     /* Objects tree structure */
 184     vlc_object_internals_t *next;  /* next sibling */
 185     vlc_object_internals_t *prev;  /* previous sibling */
 186     vlc_object_internals_t *first; /* first child */
 187     vlc_object_t   *old_parent;
 188 };
 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 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
 198
 199 typedef struct sap_handler_t sap_handler_t;
 200
 201 /**
 202  * Private LibVLC instance data.
 203  */
 204 typedef struct libvlc_priv_t
 205 {
 206     libvlc_int_t       public_data;
 207
 208     int                i_last_input_id ; ///< Last id of input item
 209     bool               playlist_active;
 210
 211     /* Messages */
 212     msg_bank_t         msg_bank;    ///< The message bank
 213     int                i_verbose;   ///< info messages
 214     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 215     bool               b_color;     ///< color messages?
 216     bool               msg_all_objects_enabled; ///< Should we print all objects?
 217
 218     /* Timer stats */
 219     bool               b_stats;     ///< Whether to collect 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
 224     /* Singleton objects */
 225     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 226     playlist_t        *p_playlist; //< the playlist singleton
 227     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 228     vlc_object_t      *p_dialog_provider; ///< dialog provider
 229     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 230 #ifdef ENABLE_SOUT
 231     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 232 #endif
 233
 234     /* Interfaces */
 235     struct intf_thread_t *p_intf; ///< Interfaces linked-list
 236
 237     /* Objects tree */
 238     vlc_mutex_t        structure_lock;
 239 } libvlc_priv_t;
 240
 241 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 242 {
 243     return (libvlc_priv_t *)libvlc;
 244 }
 245
 246 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 247 void intf_DestroyAll( libvlc_int_t * );
 248
 249 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 250
 251 /**
 252  * LibVLC "main module" configuration settings array.
 253  */
 254 extern module_config_t libvlc_config[];
 255 extern const size_t libvlc_config_count;
 256
 257 /*
 258  * Variables stuff
 259  */
 260 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 261
 262
 263 /*
 264  * Stats stuff
 265  */
 266 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
 267 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
 268 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
 269 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
 270 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
 271 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
 272
 273 void stats_CounterClean (counter_t * );
 274
 275 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
 276 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 277                                       int *value )
 278 {
 279     int i_ret;
 280     vlc_value_t val; val.i_int = 0;
 281     if( !p_counter ) return VLC_EGENERIC;
 282     i_ret = __stats_Get( p_obj, p_counter, &val );
 283     *value = val.i_int;
 284     return i_ret;
 285 }
 286
 287 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
 288 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 289                                     float *value )
 290 {
 291     int i_ret;
 292     vlc_value_t val; val.f_float = 0.0;
 293     if( !p_counter ) return VLC_EGENERIC;
 294     i_ret = __stats_Get( p_obj, p_counter, &val );
 295     *value = val.f_float;
 296     return i_ret;
 297 }
 298 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
 299 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
 300                                          int i, int *pi_new )
 301 {
 302     int i_ret;
 303     vlc_value_t val;
 304     vlc_value_t new_val; new_val.i_int = 0;
 305     if( !p_co ) return VLC_EGENERIC;
 306     val.i_int = i;
 307     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
 308     if( pi_new )
 309         *pi_new = new_val.i_int;
 310     return i_ret;
 311 }
 312 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
 313 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
 314                                        float f, float *pf_new )
 315 {
 316     vlc_value_t val;
 317     int i_ret;
 318     vlc_value_t new_val;new_val.f_float = 0.0;
 319     if( !p_co ) return VLC_EGENERIC;
 320     val.f_float = f;
 321     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
 322     if( pf_new )
 323         *pf_new = new_val.f_float;
 324     return i_ret;
 325 }
 326
 327 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
 328 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
 329 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
 330
 331 /*
 332  * Replacement functions
 333  */
 334 # ifndef HAVE_DIRENT_H
 335 typedef void DIR;
 336 #  ifndef FILENAME_MAX
 337 #      define FILENAME_MAX (260)
 338 #  endif
 339 struct dirent
 340 {
 341     long            d_ino;          /* Always zero. */
 342     unsigned short  d_reclen;       /* Always zero. */
 343     unsigned short  d_namlen;       /* Length of name in d_name. */
 344     char            d_name[FILENAME_MAX]; /* File name. */
 345 };
 346 #  define opendir vlc_opendir
 347 #  define readdir vlc_readdir
 348 #  define closedir vlc_closedir
 349 #  define rewinddir vlc_rewindir
 350 void *vlc_opendir (const char *);
 351 void *vlc_readdir (void *);
 352 int   vlc_closedir(void *);
 353 void  vlc_rewinddir(void *);
 354 # endif
 355
 356 #if defined (WIN32)
 357 #   include <dirent.h>
 358 void *vlc_wopendir (const wchar_t *);
 359 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 360 struct _wdirent *vlc_wreaddir (void *);
 361 void vlc_rewinddir (void *);
 362 #   define _wopendir vlc_wopendir
 363 #   define _wreaddir vlc_wreaddir
 364 #   define _wclosedir vlc_wclosedir
 365 #   define rewinddir vlc_rewinddir
 366 #endif
 367
 368 #endif