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