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 #include<vlc_media_library.h>
30 typedef struct variable_t variable_t;
32 /* Actions (hot keys) */
38 extern const struct action libvlc_actions[];
39 extern const size_t libvlc_actions_count;
40 extern int vlc_InitActions (libvlc_int_t *);
41 extern void vlc_DeinitActions (libvlc_int_t *);
44 * OS-specific initialization
46 void system_Init ( libvlc_int_t *, int *, const char *[] );
47 void system_Configure ( libvlc_int_t *, int, const char *const [] );
48 void system_End ( libvlc_int_t * );
54 /* This cannot be used as is from plugins: */
55 void vlc_detach (vlc_thread_t);
57 /* Hopefully, no need to export this. There is a new thread API instead. */
58 void vlc_thread_cancel (vlc_object_t *);
59 int vlc_object_waitpipe (vlc_object_t *obj);
61 void vlc_threads_setup (libvlc_int_t *);
63 void vlc_trace (const char *fn, const char *file, unsigned line);
64 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
66 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
67 void vlc_assert_locked (vlc_mutex_t *);
69 # define vlc_assert_locked( m ) (void)m
75 extern uint32_t cpu_flags;
76 uint32_t CPUCapabilities( void );
77 bool vlc_CPU_CheckPluginDir (const char *name);
80 * Message/logging stuff
83 typedef struct msg_bank_t msg_bank_t;
85 msg_bank_t *msg_Create (void);
86 void msg_Destroy (msg_bank_t *);
88 /** Internal message stack context */
89 void msg_StackSet ( int, const char*, ... );
90 void msg_StackAdd ( const char*, ... );
91 const char* msg_StackMsg ( void );
96 char *vlc_fix_readdir (const char *);
99 * LibVLC exit event handling
101 typedef struct vlc_exit
104 void (*handler) (void *);
109 void vlc_ExitInit( vlc_exit_t * );
110 void vlc_ExitDestroy( vlc_exit_t * );
113 * LibVLC objects stuff
117 * Creates a VLC object.
119 * Note that because the object name pointer must remain valid, potentially
120 * even after the destruction of the object (through the message queues), this
121 * function CANNOT be exported to plugins as is. In this case, the old
122 * vlc_object_create() must be used instead.
124 * @param p_this an existing VLC object
125 * @param i_size byte size of the object structure
126 * @param i_type object type, usually VLC_OBJECT_CUSTOM
127 * @param psz_type object type name
128 * @return the created object, or NULL.
131 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
132 const char *psz_type);
133 #define vlc_custom_create(o, s, t, n) \
134 vlc_custom_create(VLC_OBJECT(o), s, t, n)
137 * Assign a name to an object for vlc_object_find_name().
139 extern int vlc_object_set_name(vlc_object_t *, const char *);
140 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
143 * To be cleaned-up module stuff:
145 extern char *psz_vlcpath;
147 module_t *module_find_by_shortcut (const char *psz_shortcut);
150 * Private LibVLC data for each object.
152 typedef struct vlc_object_internals vlc_object_internals_t;
154 struct vlc_object_internals
156 int i_object_type; /* Object type, deprecated */
157 char *psz_name; /* given name */
159 /* Object variables */
161 vlc_mutex_t var_lock;
164 /* Thread properties, if any */
165 vlc_thread_t thread_id;
168 /* Objects thread synchronization */
171 /* Objects management */
172 vlc_spinlock_t ref_spin;
174 vlc_destructor_t pf_destructor;
176 /* Objects tree structure */
177 vlc_object_internals_t *next; /* next sibling */
178 vlc_object_internals_t *prev; /* previous sibling */
179 vlc_object_internals_t *first; /* first child */
182 #define ZOOM_SECTION N_("Zoom")
183 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
184 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
185 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
186 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
188 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
189 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 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;
200 int i_last_input_id ; ///< Last id of input item
201 bool playlist_active;
204 msg_bank_t *msg_bank; ///< The message bank
205 int i_verbose; ///< info messages
206 bool b_color; ///< color messages?
209 bool b_stats; ///< Whether to collect stats
210 vlc_mutex_t timer_lock; ///< Lock to protect timers
211 counter_t **pp_timers; ///< Array of all timers
212 int i_timers; ///< Number of timers
214 /* Singleton objects */
215 module_t *p_memcpy_module; ///< Fast memcpy plugin used
216 playlist_t *p_playlist; ///< the playlist singleton
217 media_library_t *p_ml; ///< the ML singleton
218 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
219 vlc_object_t *p_dialog_provider; ///< dialog provider
220 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
222 sap_handler_t *p_sap; ///< SAP SDP advertiser
226 struct intf_thread_t *p_intf; ///< Interfaces linked-list
229 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 int stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
261 counter_t * stats_CounterCreate (vlc_object_t*, int, int);
262 #define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c )
263 int stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
264 #define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c)
266 void stats_CounterClean (counter_t * );
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 );
278 #define stats_GetInteger(a,b,c) stats_GetInteger( 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_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c )
292 static inline int stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
297 vlc_value_t new_val; new_val.i_int = 0;
298 if( !p_co ) return VLC_EGENERIC;
300 i_ret = stats_Update( p_obj, p_co, val, &new_val );
302 *pi_new = new_val.i_int;
305 #define stats_UpdateInteger(a,b,c,d) stats_UpdateInteger( 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;
320 #define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
322 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
323 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
324 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
327 * Replacement functions
329 # ifndef HAVE_DIRENT_H
331 # ifndef FILENAME_MAX
332 # define FILENAME_MAX (260)
336 long d_ino; /* Always zero. */
337 unsigned short d_reclen; /* Always zero. */
338 unsigned short d_namlen; /* Length of name in d_name. */
339 char d_name[FILENAME_MAX]; /* File name. */
341 # define opendir vlc_opendir
342 # define readdir vlc_readdir
343 # define closedir vlc_closedir
344 # define rewinddir vlc_rewindir
345 void *vlc_opendir (const char *);
346 void *vlc_readdir (void *);
347 int vlc_closedir(void *);
348 void vlc_rewinddir(void *);
353 void *vlc_wopendir (const wchar_t *);
354 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
355 struct _wdirent *vlc_wreaddir (void *);
356 void vlc_rewinddir (void *);
357 # define _wopendir vlc_wopendir
358 # define _wreaddir vlc_wreaddir
359 # define _wclosedir vlc_wclosedir
360 # define rewinddir vlc_rewinddir