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