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