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