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