Remove module_GetModulesNamesForCapability
[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_key_to_action (vlc_object_t *, const char *,
39                               vlc_value_t, vlc_value_t, void *);
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 *[] );
46 void system_End       ( libvlc_int_t * );
47
48 /*
49  * Legacy object stuff that is still used within libvlccore (only)
50  */
51 #define vlc_object_signal_unlocked( obj )
52
53 vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
54
55 /*
56  * Threads subsystem
57  */
58
59 /* This cannot be used as is from plugins: */
60 void vlc_detach (vlc_thread_t);
61
62 /* Hopefully, no need to export this. There is a new thread API instead. */
63 void vlc_thread_cancel (vlc_object_t *);
64 int vlc_object_waitpipe (vlc_object_t *obj);
65
66 void vlc_threads_setup (libvlc_int_t *);
67
68 void vlc_trace (const char *fn, const char *file, unsigned line);
69 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
70
71 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
72 void vlc_assert_locked (vlc_mutex_t *);
73 #else
74 # define vlc_assert_locked( m ) (void)m
75 #endif
76
77 /*
78  * CPU capabilities
79  */
80 extern uint32_t cpu_flags;
81 uint32_t CPUCapabilities( void );
82
83 /*
84  * Message/logging stuff
85  */
86
87 /**
88  * Store all data required by messages interfaces.
89  */
90 typedef struct msg_bank_t
91 {
92     /** Message queue lock */
93     vlc_rwlock_t lock;
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  * Assign a name to an object for vlc_object_find_name().
145  */
146 extern int vlc_object_set_name(vlc_object_t *, const char *);
147 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
148
149 /*
150  * To be cleaned-up module stuff:
151  */
152 extern char *psz_vlcpath;
153
154 module_t *module_find_by_shortcut (const char *psz_shortcut);
155
156 /**
157  * Private LibVLC data for each object.
158  */
159 typedef struct vlc_object_internals_t
160 {
161     int             i_object_type; /* Object type, deprecated */
162     char           *psz_name; /* given name */
163
164     /* Object variables */
165     variable_t *    p_vars;
166     vlc_mutex_t     var_lock;
167     vlc_cond_t      var_wait;
168     int             i_vars;
169
170     /* Thread properties, if any */
171     vlc_thread_t    thread_id;
172     bool            b_thread;
173
174     /* Objects thread synchronization */
175     int             pipes[2];
176
177     /* Objects management */
178     vlc_spinlock_t   ref_spin;
179     unsigned         i_refcount;
180     vlc_destructor_t pf_destructor;
181
182     /* Objects tree structure */
183     vlc_object_t   **pp_children;
184     int              i_children;
185 } vlc_object_internals_t;
186
187 #define ZOOM_SECTION N_("Zoom")
188 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
189 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
190 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
191 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
192
193 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
194
195 typedef struct sap_handler_t sap_handler_t;
196
197 /**
198  * Private LibVLC instance data.
199  */
200 typedef struct libvlc_priv_t
201 {
202     libvlc_int_t       public_data;
203     vlc_cond_t         exiting; ///< signaled when VLC wants to exit
204
205     int                i_last_input_id ; ///< Last id of input item
206
207     /* Messages */
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?
213
214     /* Timer stats */
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
219
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     vlc_object_t      *p_dialog_provider; ///< dialog provider
225     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
226 #ifdef ENABLE_SOUT
227     sap_handler_t     *p_sap; ///< SAP SDP advertiser
228 #endif
229
230     /* Interfaces */
231     struct intf_thread_t *p_intf; ///< Interfaces linked-list
232
233     /* Objects tree */
234     vlc_mutex_t        structure_lock;
235 } libvlc_priv_t;
236
237 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
238 {
239     return (libvlc_priv_t *)libvlc;
240 }
241
242 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
243 void intf_DestroyAll( libvlc_int_t * );
244
245 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
246
247 /**
248  * LibVLC "main module" configuration settings array.
249  */
250 extern module_config_t libvlc_config[];
251 extern const size_t libvlc_config_count;
252
253 /*
254  * Variables stuff
255  */
256 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
257
258
259 /*
260  * Stats stuff
261  */
262 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
263 int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
264 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
265 counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
266 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
267 int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
268
269 void stats_CounterClean (counter_t * );
270
271 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
272 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
273                                       int *value )
274 {
275     int i_ret;
276     vlc_value_t val; val.i_int = 0;
277     if( !p_counter ) return VLC_EGENERIC;
278     i_ret = __stats_Get( p_obj, p_counter, &val );
279     *value = val.i_int;
280     return i_ret;
281 }
282
283 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
284 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
285                                     float *value )
286 {
287     int i_ret;
288     vlc_value_t val; val.f_float = 0.0;
289     if( !p_counter ) return VLC_EGENERIC;
290     i_ret = __stats_Get( p_obj, p_counter, &val );
291     *value = val.f_float;
292     return i_ret;
293 }
294 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
295 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
296                                          int i, int *pi_new )
297 {
298     int i_ret;
299     vlc_value_t val;
300     vlc_value_t new_val; new_val.i_int = 0;
301     if( !p_co ) return VLC_EGENERIC;
302     val.i_int = i;
303     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
304     if( pi_new )
305         *pi_new = new_val.i_int;
306     return i_ret;
307 }
308 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
309 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
310                                        float f, float *pf_new )
311 {
312     vlc_value_t val;
313     int i_ret;
314     vlc_value_t new_val;new_val.f_float = 0.0;
315     if( !p_co ) return VLC_EGENERIC;
316     val.f_float = f;
317     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
318     if( pf_new )
319         *pf_new = new_val.f_float;
320     return i_ret;
321 }
322
323 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
324 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
325 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
326
327 /*
328  * Replacement functions
329  */
330 # ifndef HAVE_DIRENT_H
331 typedef void DIR;
332 #  ifndef FILENAME_MAX
333 #      define FILENAME_MAX (260)
334 #  endif
335 struct dirent
336 {
337     long            d_ino;          /* Always zero. */
338     unsigned short  d_reclen;       /* Always zero. */
339     unsigned short  d_namlen;       /* Length of name in d_name. */
340     char            d_name[FILENAME_MAX]; /* File name. */
341 };
342 #  define opendir vlc_opendir
343 #  define readdir vlc_readdir
344 #  define closedir vlc_closedir
345 #  define rewinddir vlc_rewindir
346 void *vlc_opendir (const char *);
347 void *vlc_readdir (void *);
348 int   vlc_closedir(void *);
349 void  vlc_rewinddir(void *);
350 # endif
351
352 #if defined (WIN32)
353 #   include <dirent.h>
354 void *vlc_wopendir (const wchar_t *);
355 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
356 struct _wdirent *vlc_wreaddir (void *);
357 void vlc_rewinddir (void *);
358 #   define _wopendir vlc_wopendir
359 #   define _wreaddir vlc_wreaddir
360 #   define _wclosedir vlc_wclosedir
361 #   define rewinddir vlc_rewinddir
362 #endif
363
364 #endif