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