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