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 #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 bool vlc_CPU_CheckPluginDir (const char *name);
  83
  84 /*
  85  * Message/logging stuff
  86  */
  87
  88 /**
  89  * Store all data required by messages interfaces.
  90  */
  91 typedef struct msg_bank_t
  92 {
  93     /** Message queue lock */
  94     vlc_rwlock_t lock;
  95
  96     /* Subscribers */
  97     int i_sub;
  98     msg_subscription_t **pp_sub;
  99
 100     /* Logfile for WinCE */
 101 #ifdef UNDER_CE
 102     FILE *logfile;
 103 #endif
 104 } msg_bank_t;
 105
 106 void msg_Create  (libvlc_int_t *);
 107 void msg_Destroy (libvlc_int_t *);
 108
 109 /** Internal message stack context */
 110 void msg_StackSet ( int, const char*, ... );
 111 void msg_StackAdd ( const char*, ... );
 112 const char* msg_StackMsg ( void );
 113 void msg_StackDestroy (void *);
 114
 115 /*
 116  * Unicode stuff
 117  */
 118 char *vlc_fix_readdir (const char *);
 119
 120 /*
 121  * LibVLC objects stuff
 122  */
 123
 124 /**
 125  * Creates a VLC object.
 126  *
 127  * Note that because the object name pointer must remain valid, potentially
 128  * even after the destruction of the object (through the message queues), this
 129  * function CANNOT be exported to plugins as is. In this case, the old
 130  * vlc_object_create() must be used instead.
 131  *
 132  * @param p_this an existing VLC object
 133  * @param i_size byte size of the object structure
 134  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 135  * @param psz_type object type name
 136  * @return the created object, or NULL.
 137  */
 138 extern void *
 139 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 140                      const char *psz_type);
 141 #define vlc_custom_create(o, s, t, n) \
 142         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 143
 144 /**
 145  * Assign a name to an object for vlc_object_find_name().
 146  */
 147 extern int vlc_object_set_name(vlc_object_t *, const char *);
 148 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
 149
 150 /*
 151  * To be cleaned-up module stuff:
 152  */
 153 extern char *psz_vlcpath;
 154
 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_name; /* given name */
 164
 165     /* Object variables */
 166     void           *var_root;
 167     vlc_mutex_t     var_lock;
 168     vlc_cond_t      var_wait;
 169
 170     /* Thread properties, if any */
 171     vlc_thread_t    thread_id;
 172     bool            b_thread;
 173
 174     /* Objects thread synchronization */
 175     int             pipes[2];
 176
 177     /* Objects management */
 178     vlc_spinlock_t   ref_spin;
 179     unsigned         i_refcount;
 180     vlc_destructor_t pf_destructor;
 181
 182     /* Objects tree structure */
 183     vlc_object_t   **pp_children;
 184     int              i_children;
 185 } vlc_object_internals_t;
 186
 187 #define ZOOM_SECTION N_("Zoom")
 188 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 189 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 190 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 191 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 192
 193 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 194
 195 typedef struct sap_handler_t sap_handler_t;
 196
 197 /**
 198  * Private LibVLC instance data.
 199  */
 200 typedef struct libvlc_priv_t
 201 {
 202     libvlc_int_t       public_data;
 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     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 210     bool               b_color;     ///< color messages?
 211     bool               msg_all_objects_enabled; ///< Should we print all objects?
 212
 213     /* Timer stats */
 214     bool               b_stats;     ///< Whether to collect stats
 215     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 216     counter_t        **pp_timers;   ///< Array of all timers
 217     int                i_timers;    ///< Number of timers
 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     vlc_object_t      *p_dialog_provider; ///< dialog provider
 224     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 225 #ifdef ENABLE_SOUT
 226     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 227 #endif
 228
 229     /* Interfaces */
 230     struct intf_thread_t *p_intf; ///< Interfaces linked-list
 231
 232     /* Objects tree */
 233     vlc_mutex_t        structure_lock;
 234 } libvlc_priv_t;
 235
 236 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 237 {
 238     return (libvlc_priv_t *)libvlc;
 239 }
 240
 241 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 242 void intf_DestroyAll( libvlc_int_t * );
 243
 244 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 245
 246 /**
 247  * LibVLC "main module" configuration settings array.
 248  */
 249 extern module_config_t libvlc_config[];
 250 extern const size_t libvlc_config_count;
 251
 252 /*
 253  * Variables stuff
 254  */
 255 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 256
 257
 258 /*
 259  * Stats stuff
 260  */
 261 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
 262 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
 263 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
 264 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
 265 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
 266 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
 267
 268 void stats_CounterClean (counter_t * );
 269
 270 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
 271 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 272                                       int *value )
 273 {
 274     int i_ret;
 275     vlc_value_t val; val.i_int = 0;
 276     if( !p_counter ) return VLC_EGENERIC;
 277     i_ret = __stats_Get( p_obj, p_counter, &val );
 278     *value = val.i_int;
 279     return i_ret;
 280 }
 281
 282 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
 283 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 284                                     float *value )
 285 {
 286     int i_ret;
 287     vlc_value_t val; val.f_float = 0.0;
 288     if( !p_counter ) return VLC_EGENERIC;
 289     i_ret = __stats_Get( p_obj, p_counter, &val );
 290     *value = val.f_float;
 291     return i_ret;
 292 }
 293 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
 294 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
 295                                          int i, int *pi_new )
 296 {
 297     int i_ret;
 298     vlc_value_t val;
 299     vlc_value_t new_val; new_val.i_int = 0;
 300     if( !p_co ) return VLC_EGENERIC;
 301     val.i_int = i;
 302     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
 303     if( pi_new )
 304         *pi_new = new_val.i_int;
 305     return i_ret;
 306 }
 307 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
 308 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
 309                                        float f, float *pf_new )
 310 {
 311     vlc_value_t val;
 312     int i_ret;
 313     vlc_value_t new_val;new_val.f_float = 0.0;
 314     if( !p_co ) return VLC_EGENERIC;
 315     val.f_float = f;
 316     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
 317     if( pf_new )
 318         *pf_new = new_val.f_float;
 319     return i_ret;
 320 }
 321
 322 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
 323 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
 324 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
 325
 326 /*
 327  * Replacement functions
 328  */
 329 # ifndef HAVE_DIRENT_H
 330 typedef void DIR;
 331 #  ifndef FILENAME_MAX
 332 #      define FILENAME_MAX (260)
 333 #  endif
 334 struct dirent
 335 {
 336     long            d_ino;          /* Always zero. */
 337     unsigned short  d_reclen;       /* Always zero. */
 338     unsigned short  d_namlen;       /* Length of name in d_name. */
 339     char            d_name[FILENAME_MAX]; /* File name. */
 340 };
 341 #  define opendir vlc_opendir
 342 #  define readdir vlc_readdir
 343 #  define closedir vlc_closedir
 344 #  define rewinddir vlc_rewindir
 345 void *vlc_opendir (const char *);
 346 void *vlc_readdir (void *);
 347 int   vlc_closedir(void *);
 348 void  vlc_rewinddir(void *);
 349 # endif
 350
 351 #if defined (WIN32)
 352 #   include <dirent.h>
 353 void *vlc_wopendir (const wchar_t *);
 354 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 355 struct _wdirent *vlc_wreaddir (void *);
 356 void vlc_rewinddir (void *);
 357 #   define _wopendir vlc_wopendir
 358 #   define _wreaddir vlc_wreaddir
 359 #   define _wclosedir vlc_wclosedir
 360 #   define rewinddir vlc_rewinddir
 361 #endif
 362
 363 #endif