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
55 /* Hopefully, no need to export this. There is a new thread API instead. */
56 void vlc_thread_cancel (vlc_object_t *);
62 extern uint32_t cpu_flags;
63 uint32_t CPUCapabilities( void );
66 * Message/logging stuff
69 typedef struct msg_queue_t
71 /** Message queue lock */
76 msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */
82 msg_subscription_t **pp_sub;
84 /* Logfile for WinCE */
91 * Store all data required by messages interfaces.
93 typedef struct msg_bank_t
99 void msg_Create (libvlc_int_t *);
100 void msg_Flush (libvlc_int_t *);
101 void msg_Destroy (libvlc_int_t *);
103 /** Internal message stack context */
110 void msg_StackSet ( int, const char*, ... );
111 void msg_StackAdd ( const char*, ... );
112 const char* msg_StackMsg ( void );
113 /** The global thread var for msg stack context
114 * We store this as a static global variable so we don't need a vlc_object_t
116 * This key is created in vlc_threads_init and is therefore ready to use at
117 * the very beginning of the universe */
118 extern vlc_threadvar_t msg_context_global_key;
119 void msg_StackDestroy (void *);
124 char *vlc_fix_readdir (const char *);
127 * LibVLC objects stuff
131 * Creates a VLC object.
133 * Note that because the object name pointer must remain valid, potentially
134 * even after the destruction of the object (through the message queues), this
135 * function CANNOT be exported to plugins as is. In this case, the old
136 * vlc_object_create() must be used instead.
138 * @param p_this an existing VLC object
139 * @param i_size byte size of the object structure
140 * @param i_type object type, usually VLC_OBJECT_CUSTOM
141 * @param psz_type object type name
142 * @return the created object, or NULL.
145 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
146 const char *psz_type);
147 #define vlc_custom_create(o, s, t, n) \
148 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
151 * libvlc_global_data_t (global variable)
153 * This structure has an unique instance, statically allocated in libvlc and
154 * never accessed from the outside. It stores process-wide VLC variables,
155 * mostly process-wide locks, and (currently) the module bank and objects tree.
157 typedef struct libvlc_global_data_t
161 module_bank_t * p_module_bank; ///< The module bank
164 } libvlc_global_data_t;
167 libvlc_global_data_t *vlc_global (void);
170 * Private LibVLC data for each object.
172 struct vlc_object_internals_t
174 /* Object variables */
176 vlc_mutex_t var_lock;
179 /* Thread properties, if any */
180 vlc_thread_t thread_id;
183 /* Objects thread synchronization */
189 /* Objects management */
190 vlc_spinlock_t ref_spin;
192 vlc_destructor_t pf_destructor;
193 #ifndef LIBVLC_REFCHECK
194 vlc_thread_t creator_id;
197 /* Objects tree structure */
198 vlc_object_t *prev, *next;
199 vlc_object_t **pp_children;
203 #define ZOOM_SECTION N_("Zoom")
204 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
205 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
206 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
207 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
209 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
211 /* Signal an object without checking for locking consistency. This is wrong. */
213 __attribute__((deprecated))
216 vlc_object_signal_maybe (vlc_object_t *p_this)
218 vlc_cond_signal (&(vlc_internals(p_this)->wait));
222 * Private LibVLC instance data.
224 typedef struct libvlc_priv_t
226 libvlc_int_t public_data;
229 vlc_mutex_t config_lock; ///< config file lock
230 char * psz_configfile; ///< location of config file
232 /* There is no real reason to keep a list of items, but not to break
233 * everything, let's keep it */
234 input_item_array_t input_items; ///< Array of all created input items
235 int i_last_input_id ; ///< Last id of input item
238 msg_bank_t msg_bank; ///< The message bank
239 int i_verbose; ///< info messages
240 bool b_color; ///< color messages?
243 vlc_mutex_t timer_lock; ///< Lock to protect timers
244 counter_t **pp_timers; ///< Array of all timers
245 int i_timers; ///< Number of timers
246 bool b_stats; ///< Whether to collect stats
248 void *p_stats_computer; ///< Input thread computing stats
251 /* Singleton objects */
252 module_t *p_memcpy_module; ///< Fast memcpy plugin used
253 playlist_t *p_playlist; //< the playlist singleton
254 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
255 interaction_t *p_interaction; ///< interface interaction object
256 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
258 /* Private playlist data (FIXME - playlist_t is too public...) */
259 sout_instance_t *p_sout; ///< kept sout instance (for playlist)
262 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
264 return (libvlc_priv_t *)libvlc;
267 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
269 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
272 * LibVLC "main module" configuration settings array.
274 extern module_config_t libvlc_config[];
275 extern const size_t libvlc_config_count;
280 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
283 * Replacement functions
285 # ifndef HAVE_DIRENT_H
287 # ifndef FILENAME_MAX
288 # define FILENAME_MAX (260)
292 long d_ino; /* Always zero. */
293 unsigned short d_reclen; /* Always zero. */
294 unsigned short d_namlen; /* Length of name in d_name. */
295 char d_name[FILENAME_MAX]; /* File name. */
297 # define opendir vlc_opendir
298 # define readdir vlc_readdir
299 # define closedir vlc_closedir
300 # define rewinddir vlc_rewindir
301 void *vlc_opendir (const char *);
302 void *vlc_readdir (void *);
303 int vlc_closedir(void *);
304 void vlc_rewinddir(void *);
309 void *vlc_wopendir (const wchar_t *);
310 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
311 struct _wdirent *vlc_wreaddir (void *);
312 void vlc_rewinddir (void *);
313 # define _wopendir vlc_wopendir
314 # define _wreaddir vlc_wreaddir
315 # define _wclosedir vlc_wclosedir
316 # define rewinddir vlc_rewinddir