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
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
28 typedef struct variable_t variable_t
;
30 /* Actions (hot keys) */
32 struct vlc_actions
*vlc_InitActions (libvlc_int_t
*);
33 extern void vlc_DeinitActions (libvlc_int_t
*, struct vlc_actions
*);
35 size_t vlc_towc (const char *str
, uint32_t *restrict pwc
);
38 * OS-specific initialization
40 void system_Init ( void );
41 void system_Configure ( libvlc_int_t
*, int, const char *const [] );
42 void system_End ( libvlc_int_t
* );
48 /* This cannot be used as is from plugins yet: */
49 int vlc_clone_detach (vlc_thread_t
*, void *(*)(void *), void *, int);
51 int vlc_object_waitpipe (vlc_object_t
*obj
);
53 int vlc_set_priority( vlc_thread_t
, int );
55 void vlc_threads_setup (libvlc_int_t
*);
57 void vlc_trace (const char *fn
, const char *file
, unsigned line
);
58 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
60 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
61 void vlc_assert_locked (vlc_mutex_t
*);
63 # define vlc_assert_locked( m ) (void)m
69 extern uint32_t cpu_flags
;
70 uint32_t CPUCapabilities( void );
73 * Message/logging stuff
76 typedef struct msg_bank_t msg_bank_t
;
78 msg_bank_t
*msg_Create (void);
79 void msg_Destroy (msg_bank_t
*);
82 * LibVLC exit event handling
84 typedef struct vlc_exit
87 void (*handler
) (void *);
92 void vlc_ExitInit( vlc_exit_t
* );
93 void vlc_ExitDestroy( vlc_exit_t
* );
96 * LibVLC objects stuff
100 * Creates a VLC object.
102 * Note that because the object name pointer must remain valid, potentially
103 * even after the destruction of the object (through the message queues), this
104 * function CANNOT be exported to plugins as is. In this case, the old
105 * vlc_object_create() must be used instead.
107 * @param p_this an existing VLC object
108 * @param i_size byte size of the object structure
109 * @param i_type object type, usually VLC_OBJECT_CUSTOM
110 * @param psz_type object type name
111 * @return the created object, or NULL.
114 vlc_custom_create (vlc_object_t
*p_this
, size_t i_size
, int i_type
,
115 const char *psz_type
);
116 #define vlc_custom_create(o, s, t, n) \
117 vlc_custom_create(VLC_OBJECT(o), s, t, n)
120 * Assign a name to an object for vlc_object_find_name().
122 extern int vlc_object_set_name(vlc_object_t
*, const char *);
123 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
126 typedef void (*vlc_destructor_t
) (struct vlc_object_t
*);
127 void vlc_object_set_destructor (vlc_object_t
*, vlc_destructor_t
);
128 #define vlc_object_set_destructor(a,b) \
129 vlc_object_set_destructor (VLC_OBJECT(a), b)
132 * To be cleaned-up module stuff:
134 extern char *psz_vlcpath
;
136 module_t
*module_find_by_shortcut (const char *psz_shortcut
);
139 * Private LibVLC data for each object.
141 typedef struct vlc_object_internals vlc_object_internals_t
;
143 struct vlc_object_internals
145 int i_object_type
; /* Object type, deprecated */
146 char *psz_name
; /* given name */
148 /* Object variables */
150 vlc_mutex_t var_lock
;
153 /* Objects thread synchronization */
156 /* Objects management */
157 vlc_spinlock_t ref_spin
;
159 vlc_destructor_t pf_destructor
;
161 /* Objects tree structure */
162 vlc_object_internals_t
*next
; /* next sibling */
163 vlc_object_internals_t
*prev
; /* previous sibling */
164 vlc_object_internals_t
*first
; /* first child */
167 #define ZOOM_SECTION N_("Zoom")
168 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
169 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
170 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
171 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
173 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
174 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
176 typedef struct sap_handler_t sap_handler_t
;
179 * Private LibVLC instance data.
181 typedef struct libvlc_priv_t
183 libvlc_int_t public_data
;
185 int i_last_input_id
; ///< Last id of input item
186 bool playlist_active
;
189 msg_bank_t
*msg_bank
; ///< The message bank
190 int i_verbose
; ///< info messages
191 bool b_color
; ///< color messages?
194 bool b_stats
; ///< Whether to collect stats
195 vlc_mutex_t timer_lock
; ///< Lock to protect timers
196 counter_t
**pp_timers
; ///< Array of all timers
197 int i_timers
; ///< Number of timers
199 /* Singleton objects */
200 module_t
*p_memcpy_module
; ///< Fast memcpy plugin used
201 playlist_t
*p_playlist
; ///< the playlist singleton
202 struct media_library_t
*p_ml
; ///< the ML singleton
203 vlc_mutex_t ml_lock
; ///< Mutex for ML creation
204 vlm_t
*p_vlm
; ///< the VLM singleton (or NULL)
205 vlc_object_t
*p_dialog_provider
; ///< dialog provider
206 httpd_t
*p_httpd
; ///< HTTP daemon (src/network/httpd.c)
208 sap_handler_t
*p_sap
; ///< SAP SDP advertiser
210 struct vlc_actions
*actions
; ///< Hotkeys handler
213 struct intf_thread_t
*p_intf
; ///< Interfaces linked-list
216 vlc_mutex_t structure_lock
;
222 static inline libvlc_priv_t
*libvlc_priv (libvlc_int_t
*libvlc
)
224 return (libvlc_priv_t
*)libvlc
;
227 void playlist_ServicesDiscoveryKillAll( playlist_t
*p_playlist
);
228 void intf_DestroyAll( libvlc_int_t
* );
230 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
233 * LibVLC "main module" configuration settings array.
235 extern module_config_t libvlc_config
[];
236 extern const size_t libvlc_config_count
;
241 void var_OptionParse (vlc_object_t
*, const char *, bool trusted
);
247 int stats_Update (vlc_object_t
*, counter_t
*, vlc_value_t
, vlc_value_t
*);
248 counter_t
* stats_CounterCreate (vlc_object_t
*, int, int);
249 #define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c )
250 int stats_Get (vlc_object_t
*, counter_t
*, vlc_value_t
*);
251 #define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c)
253 void stats_CounterClean (counter_t
* );
255 static inline int stats_GetInteger( vlc_object_t
*p_obj
, counter_t
*p_counter
,
259 vlc_value_t val
; val
.i_int
= 0;
260 if( !p_counter
) return VLC_EGENERIC
;
261 i_ret
= stats_Get( p_obj
, p_counter
, &val
);
265 #define stats_GetInteger(a,b,c) stats_GetInteger( VLC_OBJECT(a), b, c )
267 static inline int stats_GetFloat( vlc_object_t
*p_obj
, counter_t
*p_counter
,
271 vlc_value_t val
; val
.f_float
= 0.0;
272 if( !p_counter
) return VLC_EGENERIC
;
273 i_ret
= stats_Get( p_obj
, p_counter
, &val
);
274 *value
= val
.f_float
;
277 #define stats_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c )
279 static inline int stats_UpdateInteger( vlc_object_t
*p_obj
,counter_t
*p_co
,
284 vlc_value_t new_val
; new_val
.i_int
= 0;
285 if( !p_co
) return VLC_EGENERIC
;
287 i_ret
= stats_Update( p_obj
, p_co
, val
, &new_val
);
289 *pi_new
= new_val
.i_int
;
292 #define stats_UpdateInteger(a,b,c,d) stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
294 static inline int stats_UpdateFloat( vlc_object_t
*p_obj
, counter_t
*p_co
,
295 float f
, float *pf_new
)
299 vlc_value_t new_val
;new_val
.f_float
= 0.0;
300 if( !p_co
) return VLC_EGENERIC
;
302 i_ret
= stats_Update( p_obj
, p_co
, val
, &new_val
);
304 *pf_new
= new_val
.f_float
;
307 #define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
309 void stats_ComputeInputStats(input_thread_t
*, input_stats_t
*);
310 void stats_ReinitInputStats(input_stats_t
*);
311 void stats_DumpInputStats(input_stats_t
*);