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