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