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
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
28 extern const char psz_vlc_changeset
[];
30 typedef struct variable_t variable_t
;
32 /* Actions (hot keys) */
34 struct vlc_actions
*vlc_InitActions (libvlc_int_t
*);
35 extern void vlc_DeinitActions (libvlc_int_t
*, struct vlc_actions
*);
37 size_t vlc_towc (const char *str
, uint32_t *restrict pwc
);
40 * OS-specific initialization
42 void system_Init ( void );
43 void system_Configure ( libvlc_int_t
*, int, const char *const [] );
44 void system_End ( void );
46 void vlc_CPU_init(void);
47 void vlc_CPU_dump(vlc_object_t
*);
53 /* This cannot be used as is from plugins yet: */
54 int vlc_clone_detach (vlc_thread_t
*, void *(*)(void *), void *, int);
56 int vlc_object_waitpipe (vlc_object_t
*obj
);
58 int vlc_set_priority( vlc_thread_t
, int );
60 void vlc_threads_setup (libvlc_int_t
*);
62 void vlc_trace (const char *fn
, const char *file
, unsigned line
);
63 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
65 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
66 void vlc_assert_locked (vlc_mutex_t
*);
68 # define vlc_assert_locked( m ) (void)m
72 * LibVLC exit event handling
74 typedef struct vlc_exit
77 void (*handler
) (void *);
82 void vlc_ExitInit( vlc_exit_t
* );
83 void vlc_ExitDestroy( vlc_exit_t
* );
86 * LibVLC objects stuff
90 * Creates a VLC object.
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.
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.
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)
108 * Assign a name to an object for vlc_object_find_name().
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)
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)
120 * To be cleaned-up module stuff:
122 module_t
*module_find_by_shortcut (const char *psz_shortcut
);
125 * Private LibVLC data for each object.
127 typedef struct vlc_object_internals vlc_object_internals_t
;
129 struct vlc_object_internals
131 char *psz_name
; /* given name */
133 /* Object variables */
135 vlc_mutex_t var_lock
;
138 /* Objects thread synchronization */
141 /* Objects management */
142 vlc_spinlock_t ref_spin
;
144 vlc_destructor_t pf_destructor
;
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 */
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")
158 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
159 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
161 typedef struct sap_handler_t sap_handler_t
;
164 * Private LibVLC instance data.
166 typedef struct libvlc_priv_t
168 libvlc_int_t public_data
;
170 bool playlist_active
;
173 signed char i_verbose
; ///< info messages
174 bool b_color
; ///< color messages?
175 bool b_stats
; ///< Whether to collect stats
177 /* Singleton objects */
178 module_t
*p_memcpy_module
; ///< Fast memcpy plugin used
179 playlist_t
*p_playlist
; ///< the playlist singleton
180 struct media_library_t
*p_ml
; ///< the ML singleton
181 vlc_mutex_t ml_lock
; ///< Mutex for ML creation
182 vlm_t
*p_vlm
; ///< the VLM singleton (or NULL)
183 vlc_object_t
*p_dialog_provider
; ///< dialog provider
185 sap_handler_t
*p_sap
; ///< SAP SDP advertiser
187 struct vlc_actions
*actions
; ///< Hotkeys handler
190 struct intf_thread_t
*p_intf
; ///< Interfaces linked-list
193 vlc_mutex_t structure_lock
;
199 static inline libvlc_priv_t
*libvlc_priv (libvlc_int_t
*libvlc
)
201 return (libvlc_priv_t
*)libvlc
;
204 void playlist_ServicesDiscoveryKillAll( playlist_t
*p_playlist
);
205 void intf_DestroyAll( libvlc_int_t
* );
207 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
212 void var_OptionParse (vlc_object_t
*, const char *, bool trusted
);
223 typedef struct counter_sample_t
229 typedef struct counter_t
233 counter_sample_t
** pp_samples
;
245 STATS_DEMUX_CORRUPTED
,
246 STATS_DEMUX_DISCONTINUITY
,
247 STATS_PLAYED_ABUFFERS
,
252 STATS_CLIENT_CONNECTIONS
,
253 STATS_ACTIVE_CONNECTIONS
,
254 STATS_SOUT_SENT_PACKETS
,
255 STATS_SOUT_SENT_BYTES
,
256 STATS_SOUT_SEND_BITRATE
,
257 STATS_DISPLAYED_PICTURES
,
261 counter_t
* stats_CounterCreate (int);
262 void stats_Update (counter_t
*, uint64_t, uint64_t *);
263 void stats_CounterClean (counter_t
* );
265 void stats_ComputeInputStats(input_thread_t
*, input_stats_t
*);
266 void stats_ReinitInputStats(input_stats_t
*);