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