Revert "vlc_clone_detach: remove thread handle parameter"
[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 #include<vlc_media_library.h>
29
30 typedef struct variable_t variable_t;
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_InitActions (libvlc_int_t *);
41 extern void vlc_DeinitActions (libvlc_int_t *);
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 *const [] );
48 void system_End       ( libvlc_int_t * );
49
50 /*
51  * Threads subsystem
52  */
53
54 /* This cannot be used as is from plugins yet: */
55 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
56
57 /* Hopefully, no need to export this. There is a new thread API instead. */
58 void vlc_thread_cancel (vlc_object_t *);
59 int vlc_object_waitpipe (vlc_object_t *obj);
60
61 void vlc_threads_setup (libvlc_int_t *);
62
63 void vlc_trace (const char *fn, const char *file, unsigned line);
64 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
65
66 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
67 void vlc_assert_locked (vlc_mutex_t *);
68 #else
69 # define vlc_assert_locked( m ) (void)m
70 #endif
71
72 /*
73  * CPU capabilities
74  */
75 extern uint32_t cpu_flags;
76 uint32_t CPUCapabilities( void );
77 bool vlc_CPU_CheckPluginDir (const char *name);
78
79 /*
80  * Message/logging stuff
81  */
82
83 typedef struct msg_bank_t msg_bank_t;
84
85 msg_bank_t *msg_Create (void);
86 void msg_Destroy (msg_bank_t *);
87
88 /*
89  * LibVLC exit event handling
90  */
91 typedef struct vlc_exit
92 {
93     vlc_mutex_t lock;
94     void (*handler) (void *);
95     void *opaque;
96     bool killed;
97 } vlc_exit_t;
98
99 void vlc_ExitInit( vlc_exit_t * );
100 void vlc_ExitDestroy( vlc_exit_t * );
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 };
171
172 #define ZOOM_SECTION N_("Zoom")
173 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
174 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
175 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
176 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
177
178 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
179 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
180
181 typedef struct sap_handler_t sap_handler_t;
182
183 /**
184  * Private LibVLC instance data.
185  */
186 typedef struct libvlc_priv_t
187 {
188     libvlc_int_t       public_data;
189
190     int                i_last_input_id ; ///< Last id of input item
191     bool               playlist_active;
192
193     /* Messages */
194     msg_bank_t        *msg_bank;    ///< The message bank
195     int                i_verbose;   ///< info messages
196     bool               b_color;     ///< color messages?
197
198     /* Timer stats */
199     bool               b_stats;     ///< Whether to collect stats
200     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
201     counter_t        **pp_timers;   ///< Array of all timers
202     int                i_timers;    ///< Number of timers
203
204     /* Singleton objects */
205     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
206     playlist_t        *p_playlist; ///< the playlist singleton
207     media_library_t   *p_ml;    ///< the ML singleton
208     vlc_mutex_t       ml_lock; ///< Mutex for ML creation
209     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
210     vlc_object_t      *p_dialog_provider; ///< dialog provider
211     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
212 #ifdef ENABLE_SOUT
213     sap_handler_t     *p_sap; ///< SAP SDP advertiser
214 #endif
215
216     /* Interfaces */
217     struct intf_thread_t *p_intf; ///< Interfaces linked-list
218
219     /* Objects tree */
220     vlc_mutex_t        structure_lock;
221
222     /* Exit callback */
223     vlc_exit_t       exit;
224 } libvlc_priv_t;
225
226 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
227 {
228     return (libvlc_priv_t *)libvlc;
229 }
230
231 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
232 void intf_DestroyAll( libvlc_int_t * );
233
234 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
235
236 /**
237  * LibVLC "main module" configuration settings array.
238  */
239 extern module_config_t libvlc_config[];
240 extern const size_t libvlc_config_count;
241
242 /*
243  * Variables stuff
244  */
245 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
246
247
248 /*
249  * Stats stuff
250  */
251 int stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
252 counter_t * stats_CounterCreate (vlc_object_t*, int, int);
253 #define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c )
254 int stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
255 #define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c)
256
257 void stats_CounterClean (counter_t * );
258
259 static inline int stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
260                                     int64_t *value )
261 {
262     int i_ret;
263     vlc_value_t val; val.i_int = 0;
264     if( !p_counter ) return VLC_EGENERIC;
265     i_ret = stats_Get( p_obj, p_counter, &val );
266     *value = val.i_int;
267     return i_ret;
268 }
269 #define stats_GetInteger(a,b,c) stats_GetInteger( VLC_OBJECT(a), b, c )
270
271 static inline int stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
272                                     float *value )
273 {
274     int i_ret;
275     vlc_value_t val; val.f_float = 0.0;
276     if( !p_counter ) return VLC_EGENERIC;
277     i_ret = stats_Get( p_obj, p_counter, &val );
278     *value = val.f_float;
279     return i_ret;
280 }
281 #define stats_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c )
282
283 static inline int stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
284                                          int i, int *pi_new )
285 {
286     int i_ret;
287     vlc_value_t val;
288     vlc_value_t new_val; new_val.i_int = 0;
289     if( !p_co ) return VLC_EGENERIC;
290     val.i_int = i;
291     i_ret = stats_Update( p_obj, p_co, val, &new_val );
292     if( pi_new )
293         *pi_new = new_val.i_int;
294     return i_ret;
295 }
296 #define stats_UpdateInteger(a,b,c,d) stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
297
298 static inline int stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
299                                        float f, float *pf_new )
300 {
301     vlc_value_t val;
302     int i_ret;
303     vlc_value_t new_val;new_val.f_float = 0.0;
304     if( !p_co ) return VLC_EGENERIC;
305     val.f_float = f;
306     i_ret =  stats_Update( p_obj, p_co, val, &new_val );
307     if( pf_new )
308         *pf_new = new_val.f_float;
309     return i_ret;
310 }
311 #define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
312
313 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
314 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
315 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
316
317 #endif