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 extern const char vlc_usage[];
33 extern const struct hotkey libvlc_hotkeys[];
34 extern const size_t libvlc_hotkeys_size;
35 extern int vlc_key_to_action (vlc_object_t *, const char *,
36 vlc_value_t, vlc_value_t, void *);
39 * OS-specific initialization
41 void system_Init ( libvlc_int_t *, int *, const char *[] );
42 void system_Configure ( libvlc_int_t *, int *, const char *[] );
43 void system_End ( libvlc_int_t * );
49 /* Hopefully, no need to export this. There is a new thread API instead. */
50 void vlc_thread_cancel (vlc_object_t *);
51 int vlc_object_waitpipe (vlc_object_t *obj);
52 void __vlc_object_signal_unlocked (vlc_object_t *);
53 #define vlc_object_signal_unlocked( obj ) \
54 __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
56 void vlc_trace (const char *fn, const char *file, unsigned line);
57 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
59 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
60 # define vlc_assert_locked( m ) \
61 assert (pthread_mutex_lock (m) == EDEADLK)
63 # define vlc_assert_locked( m ) (void)m
69 extern uint32_t cpu_flags;
70 uint32_t CPUCapabilities( void );
73 * Message/logging stuff
77 * Store all data required by messages interfaces.
79 typedef struct msg_bank_t
81 /** Message queue lock */
87 msg_subscription_t **pp_sub;
89 /* Logfile for WinCE */
95 void msg_Create (libvlc_int_t *);
96 void msg_Destroy (libvlc_int_t *);
98 /** Internal message stack context */
99 void msg_StackSet ( int, const char*, ... );
100 void msg_StackAdd ( const char*, ... );
101 const char* msg_StackMsg ( void );
102 void msg_StackDestroy (void *);
107 char *vlc_fix_readdir (const char *);
110 * LibVLC objects stuff
114 * Creates a VLC object.
116 * Note that because the object name pointer must remain valid, potentially
117 * even after the destruction of the object (through the message queues), this
118 * function CANNOT be exported to plugins as is. In this case, the old
119 * vlc_object_create() must be used instead.
121 * @param p_this an existing VLC object
122 * @param i_size byte size of the object structure
123 * @param i_type object type, usually VLC_OBJECT_CUSTOM
124 * @param psz_type object type name
125 * @return the created object, or NULL.
128 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
129 const char *psz_type);
130 #define vlc_custom_create(o, s, t, n) \
131 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
134 * To be cleaned-up module stuff:
136 extern char *psz_vlcpath;
138 /* Return a NULL terminated array with the names of the modules that have a
139 * certain capability.
140 * Free after uses both the string and the table. */
141 VLC_EXPORT(char **, module_GetModulesNamesForCapability,
142 ( const char * psz_capability, char ***psz_longname ) );
145 * Private LibVLC data for each object.
147 typedef struct vlc_object_internals_t
149 /* Object variables */
151 vlc_mutex_t var_lock;
155 /* Thread properties, if any */
156 vlc_thread_t thread_id;
159 /* Objects thread synchronization */
164 /* Objects management */
165 vlc_spinlock_t ref_spin;
167 vlc_destructor_t pf_destructor;
169 /* Objects tree structure */
170 vlc_object_t *prev, *next;
171 vlc_object_t **pp_children;
173 } vlc_object_internals_t;
175 #define ZOOM_SECTION N_("Zoom")
176 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
177 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
178 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
179 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
181 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
183 typedef struct sap_handler_t sap_handler_t;
186 * Private LibVLC instance data.
188 typedef struct libvlc_priv_t
190 libvlc_int_t public_data;
193 vlc_mutex_t config_lock; ///< config file lock
194 char * psz_configfile; ///< location of config file
196 int i_last_input_id ; ///< Last id of input item
199 msg_bank_t msg_bank; ///< The message bank
200 int i_verbose; ///< info messages
201 bool b_color; ///< color messages?
202 vlc_dictionary_t msg_enabled_objects; ///< Enabled objects
203 bool msg_all_objects_enabled; ///< Should we print all objects?
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
209 bool b_stats; ///< Whether to collect stats
211 void *p_stats_computer; ///< Input thread computing stats
214 /* Singleton objects */
215 module_t *p_memcpy_module; ///< Fast memcpy plugin used
216 playlist_t *p_playlist; //< the playlist singleton
217 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
218 interaction_t *p_interaction; ///< interface interaction object
219 intf_thread_t *p_interaction_intf; ///< XXX interface for interaction
220 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
222 sap_handler_t *p_sap; ///< SAP SDP advertiser
224 vlc_mutex_t structure_lock;
227 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
229 return (libvlc_priv_t *)libvlc;
232 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
234 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
237 * LibVLC "main module" configuration settings array.
239 extern module_config_t libvlc_config[];
240 extern const size_t libvlc_config_count;
245 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
248 * Replacement functions
250 # ifndef HAVE_DIRENT_H
252 # ifndef FILENAME_MAX
253 # define FILENAME_MAX (260)
257 long d_ino; /* Always zero. */
258 unsigned short d_reclen; /* Always zero. */
259 unsigned short d_namlen; /* Length of name in d_name. */
260 char d_name[FILENAME_MAX]; /* File name. */
262 # define opendir vlc_opendir
263 # define readdir vlc_readdir
264 # define closedir vlc_closedir
265 # define rewinddir vlc_rewindir
266 void *vlc_opendir (const char *);
267 void *vlc_readdir (void *);
268 int vlc_closedir(void *);
269 void vlc_rewinddir(void *);
274 void *vlc_wopendir (const wchar_t *);
275 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
276 struct _wdirent *vlc_wreaddir (void *);
277 void vlc_rewinddir (void *);
278 # define _wopendir vlc_wopendir
279 # define _wreaddir vlc_wreaddir
280 # define _wclosedir vlc_wclosedir
281 # define rewinddir vlc_rewinddir