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 * );
46 * Legacy object stuff that is still used within libvlccore (only)
48 #define vlc_object_signal_unlocked( obj )
50 vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
51 #define VLC_OBJECT_INTF (-4)
52 #define VLC_OBJECT_PACKETIZER (-13)
58 /* Hopefully, no need to export this. There is a new thread API instead. */
59 void vlc_thread_cancel (vlc_object_t *);
60 int vlc_object_waitpipe (vlc_object_t *obj);
62 void vlc_trace (const char *fn, const char *file, unsigned line);
63 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
65 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
66 # define vlc_assert_locked( m ) \
67 assert (pthread_mutex_lock (m) == EDEADLK)
69 # define vlc_assert_locked( m ) (void)m
75 extern uint32_t cpu_flags;
76 uint32_t CPUCapabilities( void );
79 * Message/logging stuff
83 * Store all data required by messages interfaces.
85 typedef struct msg_bank_t
87 /** Message queue lock */
93 msg_subscription_t **pp_sub;
95 /* Logfile for WinCE */
101 void msg_Create (libvlc_int_t *);
102 void msg_Destroy (libvlc_int_t *);
104 /** Internal message stack context */
105 void msg_StackSet ( int, const char*, ... );
106 void msg_StackAdd ( const char*, ... );
107 const char* msg_StackMsg ( void );
108 void msg_StackDestroy (void *);
113 char *vlc_fix_readdir (const char *);
116 * LibVLC objects stuff
120 * Creates a VLC object.
122 * Note that because the object name pointer must remain valid, potentially
123 * even after the destruction of the object (through the message queues), this
124 * function CANNOT be exported to plugins as is. In this case, the old
125 * vlc_object_create() must be used instead.
127 * @param p_this an existing VLC object
128 * @param i_size byte size of the object structure
129 * @param i_type object type, usually VLC_OBJECT_CUSTOM
130 * @param psz_type object type name
131 * @return the created object, or NULL.
134 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
135 const char *psz_type);
136 #define vlc_custom_create(o, s, t, n) \
137 __vlc_custom_create(VLC_OBJECT(o), s, t, n)
140 * To be cleaned-up module stuff:
142 extern char *psz_vlcpath;
144 /* Return a NULL terminated array with the names of the modules that have a
145 * certain capability.
146 * Free after uses both the string and the table. */
147 char **module_GetModulesNamesForCapability (const char * psz_capability,
148 char ***psz_longname);
149 module_t *module_find_by_shortcut (const char *psz_shortcut);
152 * Private LibVLC data for each object.
154 typedef struct vlc_object_internals_t
156 int i_object_type; /* Object type, deprecated */
158 /* Object variables */
160 vlc_mutex_t var_lock;
164 /* Thread properties, if any */
165 vlc_thread_t thread_id;
168 /* Objects thread synchronization */
172 /* Objects management */
173 vlc_spinlock_t ref_spin;
175 vlc_destructor_t pf_destructor;
177 /* Objects tree structure */
178 vlc_object_t *prev, *next;
179 vlc_object_t **pp_children;
181 } vlc_object_internals_t;
183 #define ZOOM_SECTION N_("Zoom")
184 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
185 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
186 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
187 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
189 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
191 typedef struct sap_handler_t sap_handler_t;
194 * Private LibVLC instance data.
196 typedef struct libvlc_priv_t
198 libvlc_int_t public_data;
199 vlc_cond_t exiting; ///< signaled when VLC wants to exit
202 vlc_mutex_t config_lock; ///< config file lock
203 char * psz_configfile; ///< location of config file
205 int i_last_input_id ; ///< Last id of input item
208 msg_bank_t msg_bank; ///< The message bank
209 int i_verbose; ///< info messages
210 bool b_color; ///< color messages?
211 vlc_dictionary_t msg_enabled_objects; ///< Enabled objects
212 bool msg_all_objects_enabled; ///< Should we print all objects?
215 vlc_mutex_t timer_lock; ///< Lock to protect timers
216 counter_t **pp_timers; ///< Array of all timers
217 int i_timers; ///< Number of timers
218 bool b_stats; ///< Whether to collect stats
220 void *p_stats_computer; ///< Input thread computing stats
223 /* Singleton objects */
224 module_t *p_memcpy_module; ///< Fast memcpy plugin used
225 playlist_t *p_playlist; //< the playlist singleton
226 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
227 interaction_t *p_interaction; ///< interface interaction object
228 intf_thread_t *p_interaction_intf; ///< XXX interface for interaction
229 httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
231 sap_handler_t *p_sap; ///< SAP SDP advertiser
233 vlc_mutex_t structure_lock;
236 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
238 return (libvlc_priv_t *)libvlc;
241 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
243 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
246 * LibVLC "main module" configuration settings array.
248 extern module_config_t libvlc_config[];
249 extern const size_t libvlc_config_count;
254 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
257 * Replacement functions
259 # ifndef HAVE_DIRENT_H
261 # ifndef FILENAME_MAX
262 # define FILENAME_MAX (260)
266 long d_ino; /* Always zero. */
267 unsigned short d_reclen; /* Always zero. */
268 unsigned short d_namlen; /* Length of name in d_name. */
269 char d_name[FILENAME_MAX]; /* File name. */
271 # define opendir vlc_opendir
272 # define readdir vlc_readdir
273 # define closedir vlc_closedir
274 # define rewinddir vlc_rewindir
275 void *vlc_opendir (const char *);
276 void *vlc_readdir (void *);
277 int vlc_closedir(void *);
278 void vlc_rewinddir(void *);
283 void *vlc_wopendir (const wchar_t *);
284 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
285 struct _wdirent *vlc_wreaddir (void *);
286 void vlc_rewinddir (void *);
287 # define _wopendir vlc_wopendir
288 # define _wreaddir vlc_wreaddir
289 # define _wclosedir vlc_wclosedir
290 # define rewinddir vlc_rewinddir