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_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 /*
  54  * Threads subsystem
  55  */
  56
  57 /* This cannot be used as is from plugins: */
  58 void vlc_detach (vlc_thread_t);
  59
  60 /* Hopefully, no need to export this. There is a new thread API instead. */
  61 void vlc_thread_cancel (vlc_object_t *);
  62 int vlc_object_waitpipe (vlc_object_t *obj);
  63
  64 void vlc_threads_setup (libvlc_int_t *);
  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 bool vlc_CPU_CheckPluginDir (const char *name);
  81
  82 /*
  83  * Message/logging stuff
  84  */
  85
  86 /**
  87  * Store all data required by messages interfaces.
  88  */
  89 typedef struct msg_bank_t
  90 {
  91     /** Message queue lock */
  92     vlc_rwlock_t lock;
  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  * Assign a name to an object for vlc_object_find_name().
 144  */
 145 extern int vlc_object_set_name(vlc_object_t *, const char *);
 146 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
 147
 148 /*
 149  * To be cleaned-up module stuff:
 150  */
 151 extern char *psz_vlcpath;
 152
 153 module_t *module_find_by_shortcut (const char *psz_shortcut);
 154
 155 /**
 156  * Private LibVLC data for each object.
 157  */
 158 typedef struct vlc_object_internals vlc_object_internals_t;
 159
 160 struct vlc_object_internals
 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_internals_t *next;  /* next sibling */
 184     vlc_object_internals_t *prev;  /* previous sibling */
 185     vlc_object_internals_t *first; /* first child */
 186     vlc_object_t   *old_parent;
 187 };
 188
 189 #define ZOOM_SECTION N_("Zoom")
 190 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 191 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 192 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 193 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 194
 195 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 196 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
 197
 198 typedef struct sap_handler_t sap_handler_t;
 199
 200 /**
 201  * Private LibVLC instance data.
 202  */
 203 typedef struct libvlc_priv_t
 204 {
 205     libvlc_int_t       public_data;
 206
 207     int                i_last_input_id ; ///< Last id of input item
 208
 209     /* Messages */
 210     msg_bank_t         msg_bank;    ///< The message bank
 211     int                i_verbose;   ///< info messages
 212     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 213     bool               b_color;     ///< color messages?
 214     bool               msg_all_objects_enabled; ///< Should we print all objects?
 215
 216     /* Timer stats */
 217     bool               b_stats;     ///< Whether to collect stats
 218     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 219     counter_t        **pp_timers;   ///< Array of all timers
 220     int                i_timers;    ///< Number of timers
 221
 222     /* Singleton objects */
 223     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 224     playlist_t        *p_playlist; //< the playlist singleton
 225     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 226     vlc_object_t      *p_dialog_provider; ///< dialog provider
 227     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 228 #ifdef ENABLE_SOUT
 229     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 230 #endif
 231
 232     /* Interfaces */
 233     struct intf_thread_t *p_intf; ///< Interfaces linked-list
 234
 235     /* Objects tree */
 236     vlc_mutex_t        structure_lock;
 237 } libvlc_priv_t;
 238
 239 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 240 {
 241     return (libvlc_priv_t *)libvlc;
 242 }
 243
 244 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 245 void intf_DestroyAll( libvlc_int_t * );
 246
 247 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 248
 249 /**
 250  * LibVLC "main module" configuration settings array.
 251  */
 252 extern module_config_t libvlc_config[];
 253 extern const size_t libvlc_config_count;
 254
 255 /*
 256  * Variables stuff
 257  */
 258 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 259
 260
 261 /*
 262  * Stats stuff
 263  */
 264 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
 265 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
 266 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
 267 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
 268 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
 269 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
 270
 271 void stats_CounterClean (counter_t * );
 272
 273 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
 274 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 275                                       int *value )
 276 {
 277     int i_ret;
 278     vlc_value_t val; val.i_int = 0;
 279     if( !p_counter ) return VLC_EGENERIC;
 280     i_ret = __stats_Get( p_obj, p_counter, &val );
 281     *value = val.i_int;
 282     return i_ret;
 283 }
 284
 285 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
 286 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 287                                     float *value )
 288 {
 289     int i_ret;
 290     vlc_value_t val; val.f_float = 0.0;
 291     if( !p_counter ) return VLC_EGENERIC;
 292     i_ret = __stats_Get( p_obj, p_counter, &val );
 293     *value = val.f_float;
 294     return i_ret;
 295 }
 296 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
 297 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
 298                                          int i, int *pi_new )
 299 {
 300     int i_ret;
 301     vlc_value_t val;
 302     vlc_value_t new_val; new_val.i_int = 0;
 303     if( !p_co ) return VLC_EGENERIC;
 304     val.i_int = i;
 305     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
 306     if( pi_new )
 307         *pi_new = new_val.i_int;
 308     return i_ret;
 309 }
 310 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
 311 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
 312                                        float f, float *pf_new )
 313 {
 314     vlc_value_t val;
 315     int i_ret;
 316     vlc_value_t new_val;new_val.f_float = 0.0;
 317     if( !p_co ) return VLC_EGENERIC;
 318     val.f_float = f;
 319     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
 320     if( pf_new )
 321         *pf_new = new_val.f_float;
 322     return i_ret;
 323 }
 324
 325 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
 326 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
 327 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
 328
 329 /*
 330  * Replacement functions
 331  */
 332 # ifndef HAVE_DIRENT_H
 333 typedef void DIR;
 334 #  ifndef FILENAME_MAX
 335 #      define FILENAME_MAX (260)
 336 #  endif
 337 struct dirent
 338 {
 339     long            d_ino;          /* Always zero. */
 340     unsigned short  d_reclen;       /* Always zero. */
 341     unsigned short  d_namlen;       /* Length of name in d_name. */
 342     char            d_name[FILENAME_MAX]; /* File name. */
 343 };
 344 #  define opendir vlc_opendir
 345 #  define readdir vlc_readdir
 346 #  define closedir vlc_closedir
 347 #  define rewinddir vlc_rewindir
 348 void *vlc_opendir (const char *);
 349 void *vlc_readdir (void *);
 350 int   vlc_closedir(void *);
 351 void  vlc_rewinddir(void *);
 352 # endif
 353
 354 #if defined (WIN32)
 355 #   include <dirent.h>
 356 void *vlc_wopendir (const wchar_t *);
 357 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 358 struct _wdirent *vlc_wreaddir (void *);
 359 void vlc_rewinddir (void *);
 360 #   define _wopendir vlc_wopendir
 361 #   define _wreaddir vlc_wreaddir
 362 #   define _wclosedir vlc_wclosedir
 363 #   define rewinddir vlc_rewinddir
 364 #endif
 365
 366 #endif