94c21304d2c633dc4cea27cc08d0277de549b5c9
[vlc.git] / src / libvlc.h
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
6  * $Id$
7  *
8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
27
28 typedef struct variable_t variable_t;
29
30 extern const char vlc_usage[];
31
32 /* Actions (hot keys) */
33 typedef struct action
34 {
35     char name[24];
36     int  value;
37 } action_t;
38 extern const struct action libvlc_actions[];
39 extern const size_t libvlc_actions_count;
40 extern int vlc_key_to_action (vlc_object_t *, const char *,
41                               vlc_value_t, vlc_value_t, void *);
42
43 /*
44  * OS-specific initialization
45  */
46 void system_Init      ( libvlc_int_t *, int *, const char *[] );
47 void system_Configure ( libvlc_int_t *, int *, const char *[] );
48 void system_End       ( libvlc_int_t * );
49
50 /*
51  * Legacy object stuff that is still used within libvlccore (only)
52  */
53 #define vlc_object_signal_unlocked( obj )
54
55 vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
56 #define VLC_OBJECT_INTF        (-4)
57 #define VLC_OBJECT_PACKETIZER  (-13)
58
59 /*
60  * Threads subsystem
61  */
62
63 /* Hopefully, no need to export this. There is a new thread API instead. */
64 void vlc_thread_cancel (vlc_object_t *);
65 int vlc_object_waitpipe (vlc_object_t *obj);
66
67 void vlc_trace (const char *fn, const char *file, unsigned line);
68 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
69
70 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
71 void vlc_assert_locked (vlc_mutex_t *);
72 #else
73 # define vlc_assert_locked( m ) (void)m
74 #endif
75
76 /*
77  * CPU capabilities
78  */
79 extern uint32_t cpu_flags;
80 uint32_t CPUCapabilities( void );
81
82 /*
83  * Message/logging stuff
84  */
85
86 /**
87  * Store all data required by messages interfaces.
88  */
89 typedef struct msg_bank_t
90 {
91     /** Message queue lock */
92     vlc_mutex_t lock;
93     vlc_cond_t  wait;
94
95     /* Subscribers */
96     int i_sub;
97     msg_subscription_t **pp_sub;
98
99     /* Logfile for WinCE */
100 #ifdef UNDER_CE
101     FILE *logfile;
102 #endif
103 } msg_bank_t;
104
105 void msg_Create  (libvlc_int_t *);
106 void msg_Destroy (libvlc_int_t *);
107
108 /** Internal message stack context */
109 void msg_StackSet ( int, const char*, ... );
110 void msg_StackAdd ( const char*, ... );
111 const char* msg_StackMsg ( void );
112 void msg_StackDestroy (void *);
113
114 /*
115  * Unicode stuff
116  */
117 char *vlc_fix_readdir (const char *);
118
119 /*
120  * LibVLC objects stuff
121  */
122
123 /**
124  * Creates a VLC object.
125  *
126  * Note that because the object name pointer must remain valid, potentially
127  * even after the destruction of the object (through the message queues), this
128  * function CANNOT be exported to plugins as is. In this case, the old
129  * vlc_object_create() must be used instead.
130  *
131  * @param p_this an existing VLC object
132  * @param i_size byte size of the object structure
133  * @param i_type object type, usually VLC_OBJECT_CUSTOM
134  * @param psz_type object type name
135  * @return the created object, or NULL.
136  */
137 extern void *
138 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
139                      const char *psz_type);
140 #define vlc_custom_create(o, s, t, n) \
141         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
142
143 /*
144  * To be cleaned-up module stuff:
145  */
146 extern char *psz_vlcpath;
147
148 /* Return a NULL terminated array with the names of the modules that have a
149  * certain capability.
150  * Free after uses both the string and the table. */
151 char **module_GetModulesNamesForCapability (const char * psz_capability,
152                                             char ***psz_longname);
153 module_t *module_find_by_shortcut (const char *psz_shortcut);
154
155 /**
156  * Private LibVLC data for each object.
157  */
158 typedef struct vlc_object_internals_t
159 {
160     int             i_object_type; /* Object type, deprecated */
161
162     /* Object variables */
163     variable_t *    p_vars;
164     vlc_mutex_t     var_lock;
165     vlc_cond_t      var_wait;
166     int             i_vars;
167
168     /* Thread properties, if any */
169     vlc_thread_t    thread_id;
170     bool            b_thread;
171
172     /* Objects thread synchronization */
173     int             pipes[2];
174
175     /* Objects management */
176     vlc_spinlock_t   ref_spin;
177     unsigned         i_refcount;
178     vlc_destructor_t pf_destructor;
179
180     /* Objects tree structure */
181     vlc_object_t    *prev, *next;
182     vlc_object_t   **pp_children;
183     int              i_children;
184 } vlc_object_internals_t;
185
186 #define ZOOM_SECTION N_("Zoom")
187 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
188 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
189 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
190 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
191
192 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
193
194 typedef struct sap_handler_t sap_handler_t;
195
196 /**
197  * Private LibVLC instance data.
198  */
199 typedef struct libvlc_priv_t
200 {
201     libvlc_int_t       public_data;
202     vlc_cond_t         exiting; ///< signaled when VLC wants to exit
203
204     int                i_last_input_id ; ///< Last id of input item
205
206     /* Messages */
207     msg_bank_t         msg_bank;    ///< The message bank
208     int                i_verbose;   ///< info messages
209     bool               b_color;     ///< color messages?
210     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
211     bool               msg_all_objects_enabled; ///< Should we print all objects?
212
213     /* Timer stats */
214     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
215     counter_t        **pp_timers;   ///< Array of all timers
216     int                i_timers;    ///< Number of timers
217     bool               b_stats;     ///< Whether to collect stats
218
219     /* Singleton objects */
220     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
221     playlist_t        *p_playlist; //< the playlist singleton
222     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
223     vlc_object_t      *p_dialog_provider; ///< dialog provider
224     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
225 #ifdef ENABLE_SOUT
226     sap_handler_t     *p_sap; ///< SAP SDP advertiser
227 #endif
228     vlc_mutex_t        structure_lock;
229 } libvlc_priv_t;
230
231 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
232 {
233     return (libvlc_priv_t *)libvlc;
234 }
235
236 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
237
238 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
239
240 /**
241  * LibVLC "main module" configuration settings array.
242  */
243 extern module_config_t libvlc_config[];
244 extern const size_t libvlc_config_count;
245
246 /*
247  * Variables stuff
248  */
249 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
250
251
252 /*
253  * Stats stuff
254  */
255 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
256 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
257 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
258 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
259 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
260 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
261
262 void stats_CounterClean (counter_t * );
263
264 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
265 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
266                                       int *value )
267 {
268     int i_ret;
269     vlc_value_t val; val.i_int = 0;
270     if( !p_counter ) return VLC_EGENERIC;
271     i_ret = __stats_Get( p_obj, p_counter, &val );
272     *value = val.i_int;
273     return i_ret;
274 }
275
276 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
277 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
278                                     float *value )
279 {
280     int i_ret;
281     vlc_value_t val; val.f_float = 0.0;
282     if( !p_counter ) return VLC_EGENERIC;
283     i_ret = __stats_Get( p_obj, p_counter, &val );
284     *value = val.f_float;
285     return i_ret;
286 }
287 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
288 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
289                                          int i, int *pi_new )
290 {
291     int i_ret;
292     vlc_value_t val;
293     vlc_value_t new_val; new_val.i_int = 0;
294     if( !p_co ) return VLC_EGENERIC;
295     val.i_int = i;
296     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
297     if( pi_new )
298         *pi_new = new_val.i_int;
299     return i_ret;
300 }
301 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
302 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
303                                        float f, float *pf_new )
304 {
305     vlc_value_t val;
306     int i_ret;
307     vlc_value_t new_val;new_val.f_float = 0.0;
308     if( !p_co ) return VLC_EGENERIC;
309     val.f_float = f;
310     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
311     if( pf_new )
312         *pf_new = new_val.f_float;
313     return i_ret;
314 }
315
316 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
317 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
318 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
319
320 /*
321  * Replacement functions
322  */
323 # ifndef HAVE_DIRENT_H
324 typedef void DIR;
325 #  ifndef FILENAME_MAX
326 #      define FILENAME_MAX (260)
327 #  endif
328 struct dirent
329 {
330     long            d_ino;          /* Always zero. */
331     unsigned short  d_reclen;       /* Always zero. */
332     unsigned short  d_namlen;       /* Length of name in d_name. */
333     char            d_name[FILENAME_MAX]; /* File name. */
334 };
335 #  define opendir vlc_opendir
336 #  define readdir vlc_readdir
337 #  define closedir vlc_closedir
338 #  define rewinddir vlc_rewindir
339 void *vlc_opendir (const char *);
340 void *vlc_readdir (void *);
341 int   vlc_closedir(void *);
342 void  vlc_rewinddir(void *);
343 # endif
344
345 #if defined (WIN32)
346 #   include <dirent.h>
347 void *vlc_wopendir (const wchar_t *);
348 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
349 struct _wdirent *vlc_wreaddir (void *);
350 void vlc_rewinddir (void *);
351 #   define _wopendir vlc_wopendir
352 #   define _wreaddir vlc_wreaddir
353 #   define _wclosedir vlc_wclosedir
354 #   define rewinddir vlc_rewinddir
355 #endif
356
357 #endif