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