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 extern const char vlc_usage[];
32 /* Actions (hot keys) */
38 extern const struct action libvlc_actions[];
39 extern const size_t libvlc_actions_count;
40 extern int vlc_key_to_action (vlc_object_t *, const char *,
41 vlc_value_t, vlc_value_t, void *);
44 * OS-specific initialization
46 void system_Init ( libvlc_int_t *, int *, const char *[] );
47 void system_Configure ( libvlc_int_t *, int *, const char *[] );
48 void system_End ( libvlc_int_t * );
51 * Legacy object stuff that is still used within libvlccore (only)
53 #define vlc_object_signal_unlocked( obj )
55 vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
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_trace (const char *fn, const char *file, unsigned line);
66 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
68 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
69 void vlc_assert_locked (vlc_mutex_t *);
71 # define vlc_assert_locked( m ) (void)m
77 extern uint32_t cpu_flags;
78 uint32_t CPUCapabilities( void );
81 * Message/logging stuff
85 * Store all data required by messages interfaces.
87 typedef struct msg_bank_t
89 /** Message queue lock */
94 msg_subscription_t **pp_sub;
96 /* Logfile for WinCE */
102 void msg_Create (libvlc_int_t *);
103 void msg_Destroy (libvlc_int_t *);
105 /** Internal message stack context */
106 void msg_StackSet ( int, const char*, ... );
107 void msg_StackAdd ( const char*, ... );
108 const char* msg_StackMsg ( void );
109 void msg_StackDestroy (void *);
114 char *vlc_fix_readdir (const char *);
117 * LibVLC objects stuff
121 * Creates a VLC object.
123 * Note that because the object name pointer must remain valid, potentially
124 * even after the destruction of the object (through the message queues), this
125 * function CANNOT be exported to plugins as is. In this case, the old
126 * vlc_object_create() must be used instead.
128 * @param p_this an existing VLC object
129 * @param i_size byte size of the object structure
130 * @param i_type object type, usually VLC_OBJECT_CUSTOM
131 * @param psz_type object type name
132 * @return the created object, or NULL.
135 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
136 const char *psz_type);
137 #define vlc_custom_create(o, s, t, n) \
138 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
141 * To be cleaned-up module stuff:
143 extern char *psz_vlcpath;
145 /* Return a NULL terminated array with the names of the modules that have a
146 * certain capability.
147 * Free after uses both the string and the table. */
148 char **module_GetModulesNamesForCapability (const char * psz_capability,
149 char ***psz_longname);
150 module_t *module_find_by_shortcut (const char *psz_shortcut);
153 * Private LibVLC data for each object.
155 typedef struct vlc_object_internals_t
157 int i_object_type; /* Object type, deprecated */
159 /* Object variables */
161 vlc_mutex_t var_lock;
165 /* Thread properties, if any */
166 vlc_thread_t thread_id;
169 /* Objects thread synchronization */
172 /* Objects management */
173 vlc_spinlock_t ref_spin;
175 vlc_destructor_t pf_destructor;
177 /* Objects tree structure */
178 vlc_object_t *prev, *next;
179 vlc_object_t **pp_children;
181 } vlc_object_internals_t;
183 #define ZOOM_SECTION N_("Zoom")
184 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
185 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
186 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
187 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
189 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
191 typedef struct sap_handler_t sap_handler_t;
194 * Private LibVLC instance data.
196 typedef struct libvlc_priv_t
198 libvlc_int_t public_data;
199 vlc_cond_t exiting; ///< signaled when VLC wants to exit
201 int i_last_input_id ; ///< Last id of input item
204 msg_bank_t msg_bank; ///< The message bank
205 int i_verbose; ///< info messages
206 bool b_color; ///< color messages?
207 vlc_dictionary_t msg_enabled_objects; ///< Enabled objects
208 bool msg_all_objects_enabled; ///< Should we print all objects?
211 vlc_mutex_t timer_lock; ///< Lock to protect timers
212 counter_t **pp_timers; ///< Array of all timers
213 int i_timers; ///< Number of timers
214 bool b_stats; ///< Whether to collect stats
216 /* Singleton objects */
217 module_t *p_memcpy_module; ///< Fast memcpy plugin used
218 playlist_t *p_playlist; //< the playlist singleton
219 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
220 vlc_object_t *p_dialog_provider; ///< dialog provider
221 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
223 sap_handler_t *p_sap; ///< SAP SDP advertiser
227 struct intf_thread_t *p_intf; ///< Interfaces linked-list
230 vlc_mutex_t structure_lock;
233 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
235 return (libvlc_priv_t *)libvlc;
238 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
239 void intf_DestroyAll( libvlc_int_t * );
241 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
244 * LibVLC "main module" configuration settings array.
246 extern module_config_t libvlc_config[];
247 extern const size_t libvlc_config_count;
252 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
258 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
259 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
260 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
261 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
262 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
263 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
265 void stats_CounterClean (counter_t * );
267 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
268 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
272 vlc_value_t val; val.i_int = 0;
273 if( !p_counter ) return VLC_EGENERIC;
274 i_ret = __stats_Get( p_obj, p_counter, &val );
279 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
280 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
284 vlc_value_t val; val.f_float = 0.0;
285 if( !p_counter ) return VLC_EGENERIC;
286 i_ret = __stats_Get( p_obj, p_counter, &val );
287 *value = val.f_float;
290 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
291 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
296 vlc_value_t new_val; new_val.i_int = 0;
297 if( !p_co ) return VLC_EGENERIC;
299 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
301 *pi_new = new_val.i_int;
304 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
305 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
306 float f, float *pf_new )
310 vlc_value_t new_val;new_val.f_float = 0.0;
311 if( !p_co ) return VLC_EGENERIC;
313 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
315 *pf_new = new_val.f_float;
319 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
320 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
321 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
324 * Replacement functions
326 # ifndef HAVE_DIRENT_H
328 # ifndef FILENAME_MAX
329 # define FILENAME_MAX (260)
333 long d_ino; /* Always zero. */
334 unsigned short d_reclen; /* Always zero. */
335 unsigned short d_namlen; /* Length of name in d_name. */
336 char d_name[FILENAME_MAX]; /* File name. */
338 # define opendir vlc_opendir
339 # define readdir vlc_readdir
340 # define closedir vlc_closedir
341 # define rewinddir vlc_rewindir
342 void *vlc_opendir (const char *);
343 void *vlc_readdir (void *);
344 int vlc_closedir(void *);
345 void vlc_rewinddir(void *);
350 void *vlc_wopendir (const wchar_t *);
351 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
352 struct _wdirent *vlc_wreaddir (void *);
353 void vlc_rewinddir (void *);
354 # define _wopendir vlc_wopendir
355 # define _wreaddir vlc_wreaddir
356 # define _wclosedir vlc_wclosedir
357 # define rewinddir vlc_rewinddir