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 #define vlc_object_signal_unlocked( obj )
53 vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
59 /* This cannot be used as is from plugins: */
60 void vlc_detach (vlc_thread_t);
62 /* Hopefully, no need to export this. There is a new thread API instead. */
63 void vlc_thread_cancel (vlc_object_t *);
64 int vlc_object_waitpipe (vlc_object_t *obj);
66 void vlc_threads_setup (libvlc_int_t *);
68 void vlc_trace (const char *fn, const char *file, unsigned line);
69 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
71 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
72 void vlc_assert_locked (vlc_mutex_t *);
74 # define vlc_assert_locked( m ) (void)m
80 extern uint32_t cpu_flags;
81 uint32_t CPUCapabilities( void );
84 * Message/logging stuff
88 * Store all data required by messages interfaces.
90 typedef struct msg_bank_t
92 /** Message queue lock */
97 msg_subscription_t **pp_sub;
99 /* Logfile for WinCE */
105 void msg_Create (libvlc_int_t *);
106 void msg_Destroy (libvlc_int_t *);
108 /** Internal message stack context */
109 void msg_StackSet ( int, const char*, ... );
110 void msg_StackAdd ( const char*, ... );
111 const char* msg_StackMsg ( void );
112 void msg_StackDestroy (void *);
117 char *vlc_fix_readdir (const char *);
120 * LibVLC objects stuff
124 * Creates a VLC object.
126 * Note that because the object name pointer must remain valid, potentially
127 * even after the destruction of the object (through the message queues), this
128 * function CANNOT be exported to plugins as is. In this case, the old
129 * vlc_object_create() must be used instead.
131 * @param p_this an existing VLC object
132 * @param i_size byte size of the object structure
133 * @param i_type object type, usually VLC_OBJECT_CUSTOM
134 * @param psz_type object type name
135 * @return the created object, or NULL.
138 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
139 const char *psz_type);
140 #define vlc_custom_create(o, s, t, n) \
141 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
144 * Assign a name to an object for vlc_object_find_name().
146 extern int vlc_object_set_name(vlc_object_t *, const char *);
147 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
150 * To be cleaned-up module stuff:
152 extern char *psz_vlcpath;
154 module_t *module_find_by_shortcut (const char *psz_shortcut);
157 * Private LibVLC data for each object.
159 typedef struct vlc_object_internals_t
161 int i_object_type; /* Object type, deprecated */
162 char *psz_name; /* given name */
164 /* Object variables */
166 vlc_mutex_t var_lock;
169 /* Thread properties, if any */
170 vlc_thread_t thread_id;
173 /* Objects thread synchronization */
176 /* Objects management */
177 vlc_spinlock_t ref_spin;
179 vlc_destructor_t pf_destructor;
181 /* Objects tree structure */
182 vlc_object_t **pp_children;
184 } vlc_object_internals_t;
186 #define ZOOM_SECTION N_("Zoom")
187 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
188 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
189 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
190 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
192 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
194 typedef struct sap_handler_t sap_handler_t;
197 * Private LibVLC instance data.
199 typedef struct libvlc_priv_t
201 libvlc_int_t public_data;
203 int i_last_input_id ; ///< Last id of input item
206 msg_bank_t msg_bank; ///< The message bank
207 int i_verbose; ///< info messages
208 vlc_dictionary_t msg_enabled_objects; ///< Enabled objects
209 bool b_color; ///< color messages?
210 bool msg_all_objects_enabled; ///< Should we print all objects?
213 bool b_stats; ///< Whether to collect stats
214 vlc_mutex_t timer_lock; ///< Lock to protect timers
215 counter_t **pp_timers; ///< Array of all timers
216 int i_timers; ///< Number of timers
218 /* Singleton objects */
219 module_t *p_memcpy_module; ///< Fast memcpy plugin used
220 playlist_t *p_playlist; //< the playlist singleton
221 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
222 vlc_object_t *p_dialog_provider; ///< dialog provider
223 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
225 sap_handler_t *p_sap; ///< SAP SDP advertiser
229 struct intf_thread_t *p_intf; ///< Interfaces linked-list
232 vlc_mutex_t structure_lock;
235 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
237 return (libvlc_priv_t *)libvlc;
240 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
241 void intf_DestroyAll( libvlc_int_t * );
243 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
246 * LibVLC "main module" configuration settings array.
248 extern module_config_t libvlc_config[];
249 extern const size_t libvlc_config_count;
254 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
260 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
261 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
262 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
263 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
264 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
265 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
267 void stats_CounterClean (counter_t * );
269 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
270 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
274 vlc_value_t val; val.i_int = 0;
275 if( !p_counter ) return VLC_EGENERIC;
276 i_ret = __stats_Get( p_obj, p_counter, &val );
281 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
282 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
286 vlc_value_t val; val.f_float = 0.0;
287 if( !p_counter ) return VLC_EGENERIC;
288 i_ret = __stats_Get( p_obj, p_counter, &val );
289 *value = val.f_float;
292 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
293 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
298 vlc_value_t new_val; new_val.i_int = 0;
299 if( !p_co ) return VLC_EGENERIC;
301 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
303 *pi_new = new_val.i_int;
306 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
307 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
308 float f, float *pf_new )
312 vlc_value_t new_val;new_val.f_float = 0.0;
313 if( !p_co ) return VLC_EGENERIC;
315 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
317 *pf_new = new_val.f_float;
321 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
322 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
323 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
326 * Replacement functions
328 # ifndef HAVE_DIRENT_H
330 # ifndef FILENAME_MAX
331 # define FILENAME_MAX (260)
335 long d_ino; /* Always zero. */
336 unsigned short d_reclen; /* Always zero. */
337 unsigned short d_namlen; /* Length of name in d_name. */
338 char d_name[FILENAME_MAX]; /* File name. */
340 # define opendir vlc_opendir
341 # define readdir vlc_readdir
342 # define closedir vlc_closedir
343 # define rewinddir vlc_rewindir
344 void *vlc_opendir (const char *);
345 void *vlc_readdir (void *);
346 int vlc_closedir(void *);
347 void vlc_rewinddir(void *);
352 void *vlc_wopendir (const wchar_t *);
353 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
354 struct _wdirent *vlc_wreaddir (void *);
355 void vlc_rewinddir (void *);
356 # define _wopendir vlc_wopendir
357 # define _wreaddir vlc_wreaddir
358 # define _wclosedir vlc_wclosedir
359 # define rewinddir vlc_rewinddir