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 *);
41 size_t vlc_towc (const char *str, uint32_t *restrict pwc);
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 yet: */
55 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
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 *);
89 * LibVLC exit event handling
91 typedef struct vlc_exit
94 void (*handler) (void *);
99 void vlc_ExitInit( vlc_exit_t * );
100 void vlc_ExitDestroy( vlc_exit_t * );
103 * LibVLC objects stuff
107 * Creates a VLC object.
109 * Note that because the object name pointer must remain valid, potentially
110 * even after the destruction of the object (through the message queues), this
111 * function CANNOT be exported to plugins as is. In this case, the old
112 * vlc_object_create() must be used instead.
114 * @param p_this an existing VLC object
115 * @param i_size byte size of the object structure
116 * @param i_type object type, usually VLC_OBJECT_CUSTOM
117 * @param psz_type object type name
118 * @return the created object, or NULL.
121 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
122 const char *psz_type);
123 #define vlc_custom_create(o, s, t, n) \
124 vlc_custom_create(VLC_OBJECT(o), s, t, n)
127 * Assign a name to an object for vlc_object_find_name().
129 extern int vlc_object_set_name(vlc_object_t *, const char *);
130 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
133 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
134 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
135 #define vlc_object_set_destructor(a,b) \
136 vlc_object_set_destructor (VLC_OBJECT(a), b)
139 * To be cleaned-up module stuff:
141 extern char *psz_vlcpath;
143 module_t *module_find_by_shortcut (const char *psz_shortcut);
146 * Private LibVLC data for each object.
148 typedef struct vlc_object_internals vlc_object_internals_t;
150 struct vlc_object_internals
152 int i_object_type; /* Object type, deprecated */
153 char *psz_name; /* given name */
155 /* Object variables */
157 vlc_mutex_t var_lock;
160 /* Thread properties, if any */
161 vlc_thread_t thread_id;
164 /* Objects thread synchronization */
167 /* Objects management */
168 vlc_spinlock_t ref_spin;
170 vlc_destructor_t pf_destructor;
172 /* Objects tree structure */
173 vlc_object_internals_t *next; /* next sibling */
174 vlc_object_internals_t *prev; /* previous sibling */
175 vlc_object_internals_t *first; /* first child */
178 #define ZOOM_SECTION N_("Zoom")
179 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
180 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
181 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
182 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
184 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
185 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
187 typedef struct sap_handler_t sap_handler_t;
190 * Private LibVLC instance data.
192 typedef struct libvlc_priv_t
194 libvlc_int_t public_data;
196 int i_last_input_id ; ///< Last id of input item
197 bool playlist_active;
200 msg_bank_t *msg_bank; ///< The message bank
201 int i_verbose; ///< info messages
202 bool b_color; ///< color messages?
205 bool b_stats; ///< Whether to collect stats
206 vlc_mutex_t timer_lock; ///< Lock to protect timers
207 counter_t **pp_timers; ///< Array of all timers
208 int i_timers; ///< Number of timers
210 /* Singleton objects */
211 module_t *p_memcpy_module; ///< Fast memcpy plugin used
212 playlist_t *p_playlist; ///< the playlist singleton
213 struct media_library_t *p_ml; ///< the ML singleton
214 vlc_mutex_t ml_lock; ///< Mutex for ML creation
215 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
216 vlc_object_t *p_dialog_provider; ///< dialog provider
217 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
219 sap_handler_t *p_sap; ///< SAP SDP advertiser
223 struct intf_thread_t *p_intf; ///< Interfaces linked-list
226 vlc_mutex_t structure_lock;
232 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
234 return (libvlc_priv_t *)libvlc;
237 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
238 void intf_DestroyAll( libvlc_int_t * );
240 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
243 * LibVLC "main module" configuration settings array.
245 extern module_config_t libvlc_config[];
246 extern const size_t libvlc_config_count;
251 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
257 int stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
258 counter_t * stats_CounterCreate (vlc_object_t*, int, int);
259 #define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c )
260 int stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
261 #define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c)
263 void stats_CounterClean (counter_t * );
265 static inline int stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
269 vlc_value_t val; val.i_int = 0;
270 if( !p_counter ) return VLC_EGENERIC;
271 i_ret = stats_Get( p_obj, p_counter, &val );
275 #define stats_GetInteger(a,b,c) stats_GetInteger( VLC_OBJECT(a), b, c )
277 static inline int stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
281 vlc_value_t val; val.f_float = 0.0;
282 if( !p_counter ) return VLC_EGENERIC;
283 i_ret = stats_Get( p_obj, p_counter, &val );
284 *value = val.f_float;
287 #define stats_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c )
289 static inline int stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
294 vlc_value_t new_val; new_val.i_int = 0;
295 if( !p_co ) return VLC_EGENERIC;
297 i_ret = stats_Update( p_obj, p_co, val, &new_val );
299 *pi_new = new_val.i_int;
302 #define stats_UpdateInteger(a,b,c,d) stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
304 static inline int stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
305 float f, float *pf_new )
309 vlc_value_t new_val;new_val.f_float = 0.0;
310 if( !p_co ) return VLC_EGENERIC;
312 i_ret = stats_Update( p_obj, p_co, val, &new_val );
314 *pf_new = new_val.f_float;
317 #define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
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 *) );