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 );
49 /* Hopefully, no need to export this. There is a new thread API instead. */
50 void vlc_thread_cancel (vlc_object_t *);
56 extern uint32_t cpu_flags;
57 uint32_t CPUCapabilities( void );
60 * Message/logging stuff
63 typedef struct msg_queue_t
65 /** Message queue lock */
70 msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */
76 msg_subscription_t **pp_sub;
78 /* Logfile for WinCE */
85 * Store all data required by messages interfaces.
87 typedef struct msg_bank_t
93 void msg_Create (libvlc_int_t *);
94 void msg_Flush (libvlc_int_t *);
95 void msg_Destroy (libvlc_int_t *);
97 /** Internal message stack context */
98 void msg_StackSet ( int, const char*, ... );
99 void msg_StackAdd ( const char*, ... );
100 const char* msg_StackMsg ( void );
101 void msg_StackDestroy (void *);
106 char *vlc_fix_readdir (const char *);
109 * LibVLC objects stuff
113 * Creates a VLC object.
115 * Note that because the object name pointer must remain valid, potentially
116 * even after the destruction of the object (through the message queues), this
117 * function CANNOT be exported to plugins as is. In this case, the old
118 * vlc_object_create() must be used instead.
120 * @param p_this an existing VLC object
121 * @param i_size byte size of the object structure
122 * @param i_type object type, usually VLC_OBJECT_CUSTOM
123 * @param psz_type object type name
124 * @return the created object, or NULL.
127 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
128 const char *psz_type);
129 #define vlc_custom_create(o, s, t, n) \
130 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
133 * libvlc_global_data_t (global variable)
135 * This structure has an unique instance, statically allocated in libvlc and
136 * never accessed from the outside. It stores process-wide VLC variables,
137 * mostly process-wide locks, and (currently) the module bank and objects tree.
139 typedef struct libvlc_global_data_t
143 module_bank_t * p_module_bank; ///< The module bank
146 } libvlc_global_data_t;
149 libvlc_global_data_t *vlc_global (void);
152 * Private LibVLC data for each object.
154 struct vlc_object_internals_t
156 /* Object variables */
158 vlc_mutex_t var_lock;
161 /* Thread properties, if any */
162 vlc_thread_t thread_id;
165 /* 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_t *prev, *next;
178 vlc_object_t **pp_children;
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)
191 * Private LibVLC instance data.
193 typedef struct libvlc_priv_t
195 libvlc_int_t public_data;
198 vlc_mutex_t config_lock; ///< config file lock
199 char * psz_configfile; ///< location of config file
201 /* There is no real reason to keep a list of items, but not to break
202 * everything, let's keep it */
203 input_item_array_t input_items; ///< Array of all created input items
204 int i_last_input_id ; ///< Last id of input item
207 msg_bank_t msg_bank; ///< The message bank
208 int i_verbose; ///< info messages
209 bool b_color; ///< color messages?
212 vlc_mutex_t timer_lock; ///< Lock to protect timers
213 counter_t **pp_timers; ///< Array of all timers
214 int i_timers; ///< Number of timers
215 bool b_stats; ///< Whether to collect stats
217 void *p_stats_computer; ///< Input thread computing stats
220 /* Singleton objects */
221 module_t *p_memcpy_module; ///< Fast memcpy plugin used
222 playlist_t *p_playlist; //< the playlist singleton
223 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
224 interaction_t *p_interaction; ///< interface interaction object
225 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
227 /* Private playlist data (FIXME - playlist_t is too public...) */
228 sout_instance_t *p_sout; ///< kept sout instance (for playlist)
231 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
233 return (libvlc_priv_t *)libvlc;
236 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
238 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
241 * LibVLC "main module" configuration settings array.
243 extern module_config_t libvlc_config[];
244 extern const size_t libvlc_config_count;
249 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
252 * Replacement functions
254 # ifndef HAVE_DIRENT_H
256 # ifndef FILENAME_MAX
257 # define FILENAME_MAX (260)
261 long d_ino; /* Always zero. */
262 unsigned short d_reclen; /* Always zero. */
263 unsigned short d_namlen; /* Length of name in d_name. */
264 char d_name[FILENAME_MAX]; /* File name. */
266 # define opendir vlc_opendir
267 # define readdir vlc_readdir
268 # define closedir vlc_closedir
269 # define rewinddir vlc_rewindir
270 void *vlc_opendir (const char *);
271 void *vlc_readdir (void *);
272 int vlc_closedir(void *);
273 void vlc_rewinddir(void *);
278 void *vlc_wopendir (const wchar_t *);
279 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
280 struct _wdirent *vlc_wreaddir (void *);
281 void vlc_rewinddir (void *);
282 # define _wopendir vlc_wopendir
283 # define _wreaddir vlc_wreaddir
284 # define _wclosedir vlc_wclosedir
285 # define rewinddir vlc_rewinddir