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
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
28 typedef struct variable_t variable_t;
30 /* Actions (hot keys) */
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 *);
42 * OS-specific initialization
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 * );
49 * Legacy object stuff that is still used within libvlccore (only)
51 void vlc_object_detach (vlc_object_t *);
52 #define vlc_object_detach( o ) vlc_object_detach(VLC_OBJECT(o))
58 /* This cannot be used as is from plugins: */
59 void vlc_detach (vlc_thread_t);
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);
65 void vlc_threads_setup (libvlc_int_t *);
67 void vlc_trace (const char *fn, const char *file, unsigned line);
68 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
70 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
71 void vlc_assert_locked (vlc_mutex_t *);
73 # define vlc_assert_locked( m ) (void)m
79 extern uint32_t cpu_flags;
80 uint32_t CPUCapabilities( void );
81 bool vlc_CPU_CheckPluginDir (const char *name);
84 * Message/logging stuff
87 typedef struct msg_bank_t msg_bank_t;
89 msg_bank_t *msg_Create (void);
90 void msg_Destroy (msg_bank_t *);
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 *);
101 char *vlc_fix_readdir (const char *);
104 * LibVLC objects stuff
108 * Creates a VLC object.
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.
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.
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)
128 * Assign a name to an object for vlc_object_find_name().
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)
134 * To be cleaned-up module stuff:
136 extern char *psz_vlcpath;
138 module_t *module_find_by_shortcut (const char *psz_shortcut);
141 * Private LibVLC data for each object.
143 typedef struct vlc_object_internals vlc_object_internals_t;
145 struct vlc_object_internals
147 int i_object_type; /* Object type, deprecated */
148 char *psz_name; /* given name */
150 /* Object variables */
152 vlc_mutex_t var_lock;
155 /* Thread properties, if any */
156 vlc_thread_t thread_id;
159 /* Objects thread synchronization */
162 /* Objects management */
163 vlc_spinlock_t ref_spin;
165 vlc_destructor_t pf_destructor;
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;
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")
180 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
181 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
183 typedef struct sap_handler_t sap_handler_t;
186 * Private LibVLC instance data.
188 typedef struct libvlc_priv_t
190 libvlc_int_t public_data;
192 int i_last_input_id ; ///< Last id of input item
193 bool playlist_active;
196 msg_bank_t *msg_bank; ///< The message bank
197 int i_verbose; ///< info messages
198 bool b_color; ///< color messages?
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
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)
213 sap_handler_t *p_sap; ///< SAP SDP advertiser
217 struct intf_thread_t *p_intf; ///< Interfaces linked-list
220 vlc_mutex_t structure_lock;
223 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
225 return (libvlc_priv_t *)libvlc;
228 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
229 void intf_DestroyAll( libvlc_int_t * );
231 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
234 * LibVLC "main module" configuration settings array.
236 extern module_config_t libvlc_config[];
237 extern const size_t libvlc_config_count;
242 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
248 int stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
249 counter_t * stats_CounterCreate (vlc_object_t*, int, int);
250 #define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c )
251 int stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
252 #define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c)
254 void stats_CounterClean (counter_t * );
256 static inline int stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
260 vlc_value_t val; val.i_int = 0;
261 if( !p_counter ) return VLC_EGENERIC;
262 i_ret = stats_Get( p_obj, p_counter, &val );
266 #define stats_GetInteger(a,b,c) stats_GetInteger( VLC_OBJECT(a), b, c )
268 static inline int stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
272 vlc_value_t val; val.f_float = 0.0;
273 if( !p_counter ) return VLC_EGENERIC;
274 i_ret = stats_Get( p_obj, p_counter, &val );
275 *value = val.f_float;
278 #define stats_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c )
280 static inline int stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
285 vlc_value_t new_val; new_val.i_int = 0;
286 if( !p_co ) return VLC_EGENERIC;
288 i_ret = stats_Update( p_obj, p_co, val, &new_val );
290 *pi_new = new_val.i_int;
293 #define stats_UpdateInteger(a,b,c,d) stats_UpdateInteger( 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 )
300 vlc_value_t new_val;new_val.f_float = 0.0;
301 if( !p_co ) return VLC_EGENERIC;
303 i_ret = stats_Update( p_obj, p_co, val, &new_val );
305 *pf_new = new_val.f_float;
308 #define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
310 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
311 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
312 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
315 * Replacement functions
317 # ifndef HAVE_DIRENT_H
319 # ifndef FILENAME_MAX
320 # define FILENAME_MAX (260)
324 long d_ino; /* Always zero. */
325 unsigned short d_reclen; /* Always zero. */
326 unsigned short d_namlen; /* Length of name in d_name. */
327 char d_name[FILENAME_MAX]; /* File name. */
329 # define opendir vlc_opendir
330 # define readdir vlc_readdir
331 # define closedir vlc_closedir
332 # define rewinddir vlc_rewindir
333 void *vlc_opendir (const char *);
334 void *vlc_readdir (void *);
335 int vlc_closedir(void *);
336 void vlc_rewinddir(void *);
341 void *vlc_wopendir (const wchar_t *);
342 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
343 struct _wdirent *vlc_wreaddir (void *);
344 void vlc_rewinddir (void *);
345 # define _wopendir vlc_wopendir
346 # define _wreaddir vlc_wreaddir
347 # define _wclosedir vlc_wclosedir
348 # define rewinddir vlc_rewinddir