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_key_to_action (vlc_object_t *, const char *,
39 vlc_value_t, vlc_value_t, void *);
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 /* Return a NULL terminated array with the names of the modules that have a
155 * certain capability.
156 * Free after uses both the string and the table. */
157 char **module_GetModulesNamesForCapability (const char * psz_capability,
158 char ***psz_longname);
159 module_t *module_find_by_shortcut (const char *psz_shortcut);
162 * Private LibVLC data for each object.
164 typedef struct vlc_object_internals_t
166 int i_object_type; /* Object type, deprecated */
167 char *psz_name; /* given name */
169 /* Object variables */
171 vlc_mutex_t var_lock;
175 /* Thread properties, if any */
176 vlc_thread_t thread_id;
179 /* Objects thread synchronization */
182 /* Objects management */
183 vlc_spinlock_t ref_spin;
185 vlc_destructor_t pf_destructor;
187 /* Objects tree structure */
188 vlc_object_t *prev, *next;
189 vlc_object_t **pp_children;
191 } vlc_object_internals_t;
193 #define ZOOM_SECTION N_("Zoom")
194 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
195 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
196 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
197 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
199 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
201 static inline const char *vlc_object_get_name(const vlc_object_t *o)
203 return vlc_internals(o)->psz_name;
206 typedef struct sap_handler_t sap_handler_t;
209 * Private LibVLC instance data.
211 typedef struct libvlc_priv_t
213 libvlc_int_t public_data;
214 vlc_cond_t exiting; ///< signaled when VLC wants to exit
216 int i_last_input_id ; ///< Last id of input item
219 msg_bank_t msg_bank; ///< The message bank
220 int i_verbose; ///< info messages
221 bool b_color; ///< color messages?
222 vlc_dictionary_t msg_enabled_objects; ///< Enabled objects
223 bool msg_all_objects_enabled; ///< Should we print all objects?
226 vlc_mutex_t timer_lock; ///< Lock to protect timers
227 counter_t **pp_timers; ///< Array of all timers
228 int i_timers; ///< Number of timers
229 bool b_stats; ///< Whether to collect stats
231 /* Singleton objects */
232 module_t *p_memcpy_module; ///< Fast memcpy plugin used
233 playlist_t *p_playlist; //< the playlist singleton
234 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
235 vlc_object_t *p_dialog_provider; ///< dialog provider
236 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
238 sap_handler_t *p_sap; ///< SAP SDP advertiser
242 struct intf_thread_t *p_intf; ///< Interfaces linked-list
245 vlc_mutex_t structure_lock;
248 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
250 return (libvlc_priv_t *)libvlc;
253 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
254 void intf_DestroyAll( libvlc_int_t * );
256 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
259 * LibVLC "main module" configuration settings array.
261 extern module_config_t libvlc_config[];
262 extern const size_t libvlc_config_count;
267 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
273 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
274 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
275 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
276 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
277 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
278 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
280 void stats_CounterClean (counter_t * );
282 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
283 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
287 vlc_value_t val; val.i_int = 0;
288 if( !p_counter ) return VLC_EGENERIC;
289 i_ret = __stats_Get( p_obj, p_counter, &val );
294 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
295 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
299 vlc_value_t val; val.f_float = 0.0;
300 if( !p_counter ) return VLC_EGENERIC;
301 i_ret = __stats_Get( p_obj, p_counter, &val );
302 *value = val.f_float;
305 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
306 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
311 vlc_value_t new_val; new_val.i_int = 0;
312 if( !p_co ) return VLC_EGENERIC;
314 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
316 *pi_new = new_val.i_int;
319 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
320 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
321 float f, float *pf_new )
325 vlc_value_t new_val;new_val.f_float = 0.0;
326 if( !p_co ) return VLC_EGENERIC;
328 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
330 *pf_new = new_val.f_float;
334 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
335 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
336 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
339 * Replacement functions
341 # ifndef HAVE_DIRENT_H
343 # ifndef FILENAME_MAX
344 # define FILENAME_MAX (260)
348 long d_ino; /* Always zero. */
349 unsigned short d_reclen; /* Always zero. */
350 unsigned short d_namlen; /* Length of name in d_name. */
351 char d_name[FILENAME_MAX]; /* File name. */
353 # define opendir vlc_opendir
354 # define readdir vlc_readdir
355 # define closedir vlc_closedir
356 # define rewinddir vlc_rewindir
357 void *vlc_opendir (const char *);
358 void *vlc_readdir (void *);
359 int vlc_closedir(void *);
360 void vlc_rewinddir(void *);
365 void *vlc_wopendir (const wchar_t *);
366 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
367 struct _wdirent *vlc_wreaddir (void *);
368 void vlc_rewinddir (void *);
369 # define _wopendir vlc_wopendir
370 # define _wreaddir vlc_wreaddir
371 # define _wclosedir vlc_wclosedir
372 # define rewinddir vlc_rewinddir