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