Use vlc_atomic_t for input item ID
[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 struct vlc_actions;
32 struct vlc_actions *vlc_InitActions (libvlc_int_t *);
33 extern void vlc_DeinitActions (libvlc_int_t *, struct vlc_actions *);
34
35 size_t vlc_towc (const char *str, uint32_t *restrict pwc);
36
37 /*
38  * OS-specific initialization
39  */
40 void system_Init      ( void );
41 void system_Configure ( libvlc_int_t *, int, const char *const [] );
42 void system_End       ( libvlc_int_t * );
43
44 /*
45  * Threads subsystem
46  */
47
48 /* This cannot be used as is from plugins yet: */
49 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
50
51 int vlc_object_waitpipe (vlc_object_t *obj);
52
53 int vlc_set_priority( vlc_thread_t, int );
54
55 void vlc_threads_setup (libvlc_int_t *);
56
57 void vlc_trace (const char *fn, const char *file, unsigned line);
58 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
59
60 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
61 void vlc_assert_locked (vlc_mutex_t *);
62 #else
63 # define vlc_assert_locked( m ) (void)m
64 #endif
65
66 /*
67  * CPU capabilities
68  */
69 extern uint32_t cpu_flags;
70 uint32_t CPUCapabilities( void );
71
72 /*
73  * Message/logging stuff
74  */
75
76 typedef struct msg_bank_t msg_bank_t;
77
78 msg_bank_t *msg_Create (void);
79 void msg_Destroy (msg_bank_t *);
80
81 /*
82  * LibVLC exit event handling
83  */
84 typedef struct vlc_exit
85 {
86     vlc_mutex_t lock;
87     void (*handler) (void *);
88     void *opaque;
89     bool killed;
90 } vlc_exit_t;
91
92 void vlc_ExitInit( vlc_exit_t * );
93 void vlc_ExitDestroy( vlc_exit_t * );
94
95 /*
96  * LibVLC objects stuff
97  */
98
99 /**
100  * Creates a VLC object.
101  *
102  * Note that because the object name pointer must remain valid, potentially
103  * even after the destruction of the object (through the message queues), this
104  * function CANNOT be exported to plugins as is. In this case, the old
105  * vlc_object_create() must be used instead.
106  *
107  * @param p_this an existing VLC object
108  * @param i_size byte size of the object structure
109  * @param i_type object type, usually VLC_OBJECT_CUSTOM
110  * @param psz_type object type name
111  * @return the created object, or NULL.
112  */
113 extern void *
114 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
115                      const char *psz_type);
116 #define vlc_custom_create(o, s, t, n) \
117         vlc_custom_create(VLC_OBJECT(o), s, t, n)
118
119 /**
120  * Assign a name to an object for vlc_object_find_name().
121  */
122 extern int vlc_object_set_name(vlc_object_t *, const char *);
123 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
124
125 /* Types */
126 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
127 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
128 #define vlc_object_set_destructor(a,b) \
129         vlc_object_set_destructor (VLC_OBJECT(a), b)
130
131 /*
132  * To be cleaned-up module stuff:
133  */
134 extern char *psz_vlcpath;
135
136 module_t *module_find_by_shortcut (const char *psz_shortcut);
137
138 /**
139  * Private LibVLC data for each object.
140  */
141 typedef struct vlc_object_internals vlc_object_internals_t;
142
143 struct vlc_object_internals
144 {
145     int             i_object_type; /* Object type, deprecated */
146     char           *psz_name; /* given name */
147
148     /* Object variables */
149     void           *var_root;
150     vlc_mutex_t     var_lock;
151     vlc_cond_t      var_wait;
152
153     /* Objects thread synchronization */
154     int             pipes[2];
155
156     /* Objects management */
157     vlc_spinlock_t   ref_spin;
158     unsigned         i_refcount;
159     vlc_destructor_t pf_destructor;
160
161     /* Objects tree structure */
162     vlc_object_internals_t *next;  /* next sibling */
163     vlc_object_internals_t *prev;  /* previous sibling */
164     vlc_object_internals_t *first; /* first child */
165 };
166
167 #define ZOOM_SECTION N_("Zoom")
168 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
169 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
170 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
171 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
172
173 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
174 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
175
176 typedef struct sap_handler_t sap_handler_t;
177
178 /**
179  * Private LibVLC instance data.
180  */
181 typedef struct libvlc_priv_t
182 {
183     libvlc_int_t       public_data;
184
185     bool               playlist_active;
186
187     /* Messages */
188     msg_bank_t        *msg_bank;    ///< The message bank
189     int                i_verbose;   ///< info messages
190     bool               b_color;     ///< color messages?
191
192     /* Timer stats */
193     bool               b_stats;     ///< Whether to collect stats
194     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
195     counter_t        **pp_timers;   ///< Array of all timers
196     int                i_timers;    ///< Number of timers
197
198     /* Singleton objects */
199     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
200     playlist_t        *p_playlist; ///< the playlist singleton
201     struct media_library_t *p_ml;    ///< the ML singleton
202     vlc_mutex_t       ml_lock; ///< Mutex for ML creation
203     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
204     vlc_object_t      *p_dialog_provider; ///< dialog provider
205     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
206 #ifdef ENABLE_SOUT
207     sap_handler_t     *p_sap; ///< SAP SDP advertiser
208 #endif
209     struct vlc_actions *actions; ///< Hotkeys handler
210
211     /* Interfaces */
212     struct intf_thread_t *p_intf; ///< Interfaces linked-list
213
214     /* Objects tree */
215     vlc_mutex_t        structure_lock;
216
217     /* Exit callback */
218     vlc_exit_t       exit;
219 } libvlc_priv_t;
220
221 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
222 {
223     return (libvlc_priv_t *)libvlc;
224 }
225
226 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
227 void intf_DestroyAll( libvlc_int_t * );
228
229 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
230
231 /**
232  * LibVLC "main module" configuration settings array.
233  */
234 extern module_config_t libvlc_config[];
235 extern const size_t libvlc_config_count;
236
237 /*
238  * Variables stuff
239  */
240 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
241
242
243 /*
244  * Stats stuff
245  */
246 int stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
247 counter_t * stats_CounterCreate (vlc_object_t*, int, int);
248 #define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c )
249 int stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
250 #define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c)
251
252 void stats_CounterClean (counter_t * );
253
254 static inline int stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
255                                     int64_t *value )
256 {
257     int i_ret;
258     vlc_value_t val; val.i_int = 0;
259     if( !p_counter ) return VLC_EGENERIC;
260     i_ret = stats_Get( p_obj, p_counter, &val );
261     *value = val.i_int;
262     return i_ret;
263 }
264 #define stats_GetInteger(a,b,c) stats_GetInteger( VLC_OBJECT(a), b, c )
265
266 static inline int stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
267                                     float *value )
268 {
269     int i_ret;
270     vlc_value_t val; val.f_float = 0.0;
271     if( !p_counter ) return VLC_EGENERIC;
272     i_ret = stats_Get( p_obj, p_counter, &val );
273     *value = val.f_float;
274     return i_ret;
275 }
276 #define stats_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c )
277
278 static inline int stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
279                                          int i, int *pi_new )
280 {
281     int i_ret;
282     vlc_value_t val;
283     vlc_value_t new_val; new_val.i_int = 0;
284     if( !p_co ) return VLC_EGENERIC;
285     val.i_int = i;
286     i_ret = stats_Update( p_obj, p_co, val, &new_val );
287     if( pi_new )
288         *pi_new = new_val.i_int;
289     return i_ret;
290 }
291 #define stats_UpdateInteger(a,b,c,d) stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
292
293 static inline int stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
294                                        float f, float *pf_new )
295 {
296     vlc_value_t val;
297     int i_ret;
298     vlc_value_t new_val;new_val.f_float = 0.0;
299     if( !p_co ) return VLC_EGENERIC;
300     val.f_float = f;
301     i_ret =  stats_Update( p_obj, p_co, val, &new_val );
302     if( pf_new )
303         *pf_new = new_val.f_float;
304     return i_ret;
305 }
306 #define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
307
308 void stats_ComputeInputStats(input_thread_t*, input_stats_t*);
309 void stats_ReinitInputStats(input_stats_t *);
310 void stats_DumpInputStats(input_stats_t *);
311
312 #endif