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