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 extern const char vlc_usage[];
31 extern const struct hotkey libvlc_hotkeys[];
32 extern const size_t libvlc_hotkeys_size;
33 extern int vlc_key_to_action (vlc_object_t *, const char *,
34 vlc_value_t, vlc_value_t, void *);
37 * OS-specific initialization
39 void system_Init ( libvlc_int_t *, int *, const char *[] );
40 void system_Configure ( libvlc_int_t *, int *, const char *[] );
41 void system_End ( libvlc_int_t * );
46 int vlc_threads_init( void );
47 void vlc_threads_end( void );
48 vlc_object_t *vlc_threadobj (void);
49 #ifdef LIBVLC_REFCHECK
50 void vlc_refcheck (vlc_object_t *obj);
52 # define vlc_refcheck( obj ) (void)0
58 extern uint32_t cpu_flags;
59 uint32_t CPUCapabilities( void );
62 * Message/logging stuff
65 typedef struct msg_queue_t
67 /** Message queue lock */
72 msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */
78 msg_subscription_t **pp_sub;
80 /* Logfile for WinCE */
87 * Store all data required by messages interfaces.
89 typedef struct msg_bank_t
95 void msg_Create (libvlc_int_t *);
96 void msg_Flush (libvlc_int_t *);
97 void msg_Destroy (libvlc_int_t *);
99 /** Internal message stack context */
106 void msg_StackSet ( int, const char*, ... );
107 void msg_StackAdd ( const char*, ... );
108 const char* msg_StackMsg ( void );
109 /** The global thread var for msg stack context
110 * We store this as a static global variable so we don't need a vlc_object_t
112 * This key is created in vlc_threads_init and is therefore ready to use at
113 * the very beginning of the universe */
114 extern vlc_threadvar_t msg_context_global_key;
115 void msg_StackDestroy (void *);
120 char *vlc_fix_readdir (const char *);
123 * LibVLC objects stuff
127 * Creates a VLC object.
129 * Note that because the object name pointer must remain valid, potentially
130 * even after the destruction of the object (through the message queues), this
131 * function CANNOT be exported to plugins as is. In this case, the old
132 * vlc_object_create() must be used instead.
134 * @param p_this an existing VLC object
135 * @param i_size byte size of the object structure
136 * @param i_type object type, usually VLC_OBJECT_CUSTOM
137 * @param psz_type object type name
138 * @return the created object, or NULL.
141 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
142 const char *psz_type);
143 #define vlc_custom_create(o, s, t, n) \
144 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
147 * libvlc_global_data_t (global variable)
149 * This structure has an unique instance, statically allocated in libvlc and
150 * never accessed from the outside. It stores process-wide VLC variables,
151 * mostly process-wide locks, and (currently) the module bank and objects tree.
153 typedef struct libvlc_global_data_t
157 /* Object structure data */
158 int i_counter; ///< object counter
160 module_bank_t * p_module_bank; ///< The module bank
163 } libvlc_global_data_t;
166 libvlc_global_data_t *vlc_global (void);
169 * Private LibVLC data for each object.
171 struct vlc_object_internals_t
173 /* Object variables */
175 vlc_mutex_t var_lock;
178 /* Thread properties, if any */
179 vlc_thread_t thread_id;
182 /* Objects thread synchronization */
188 /* Objects management */
189 vlc_spinlock_t ref_spin;
191 vlc_destructor_t pf_destructor;
192 #ifndef LIBVLC_REFCHECK
193 vlc_thread_t creator_id;
196 /* Objects tree structure */
197 vlc_object_t *prev, *next;
198 vlc_object_t **pp_children;
202 #define ZOOM_SECTION N_("Zoom")
203 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
204 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
205 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
206 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
208 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
210 /* Signal an object without checking for locking consistency. This is wrong. */
212 __attribute__((deprecated))
215 vlc_object_signal_maybe (vlc_object_t *p_this)
217 vlc_cond_signal (&(vlc_internals(p_this)->wait));
221 * Private LibVLC instance data.
223 typedef struct libvlc_priv_t
225 libvlc_int_t public_data;
228 vlc_mutex_t config_lock; ///< config file lock
229 char * psz_configfile; ///< location of config file
231 /* There is no real reason to keep a list of items, but not to break
232 * everything, let's keep it */
233 input_item_array_t input_items; ///< Array of all created input items
234 int i_last_input_id ; ///< Last id of input item
237 msg_bank_t msg_bank; ///< The message bank
238 int i_verbose; ///< info messages
239 bool b_color; ///< color messages?
242 vlc_mutex_t timer_lock; ///< Lock to protect timers
243 counter_t **pp_timers; ///< Array of all timers
244 int i_timers; ///< Number of timers
245 bool b_stats; ///< Whether to collect stats
247 void *p_stats_computer; ///< Input thread computing stats
250 /* Singleton objects */
251 module_t *p_memcpy_module; ///< Fast memcpy plugin used
252 playlist_t *p_playlist; //< the playlist singleton
253 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
254 interaction_t *p_interaction; ///< interface interaction object
255 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
257 /* Private playlist data (FIXME - playlist_t is too public...) */
258 sout_instance_t *p_sout; ///< kept sout instance (for playlist)
261 unsigned threads_count;
262 vlc_mutex_t threads_lock;
263 vlc_cond_t threads_wait;
266 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
268 return (libvlc_priv_t *)libvlc;
271 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
273 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
276 * LibVLC "main module" configuration settings array.
278 extern module_config_t libvlc_config[];
279 extern const size_t libvlc_config_count;
284 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
287 * Replacement functions
289 # ifndef HAVE_DIRENT_H
291 # ifndef FILENAME_MAX
292 # define FILENAME_MAX (260)
296 long d_ino; /* Always zero. */
297 unsigned short d_reclen; /* Always zero. */
298 unsigned short d_namlen; /* Length of name in d_name. */
299 char d_name[FILENAME_MAX]; /* File name. */
301 # define opendir vlc_opendir
302 # define readdir vlc_readdir
303 # define closedir vlc_closedir
304 # define rewinddir vlc_rewindir
305 void *vlc_opendir (const char *);
306 void *vlc_readdir (void *);
307 int vlc_closedir(void *);
308 void vlc_rewinddir(void *);
313 void *vlc_wopendir (const wchar_t *);
314 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
315 struct _wdirent *vlc_wreaddir (void *);
316 void vlc_rewinddir (void *);
317 # define _wopendir vlc_wopendir
318 # define _wreaddir vlc_wreaddir
319 # define _wclosedir vlc_wclosedir
320 # define rewinddir vlc_rewinddir