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 [] );
45 void system_End(void);
46 size_t EnumClockSource( vlc_object_t *, const char *, char ***, char *** );
48 void vlc_CPU_init(void);
49 void vlc_CPU_dump(vlc_object_t *);
55 /* This cannot be used as is from plugins yet: */
56 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
58 int vlc_object_waitpipe (vlc_object_t *obj);
59 void vlc_object_kill (vlc_object_t *) VLC_DEPRECATED;
60 #define vlc_object_kill(o) vlc_object_kill(VLC_OBJECT(o))
62 int vlc_set_priority( vlc_thread_t, int );
64 void vlc_threads_setup (libvlc_int_t *);
66 void vlc_trace (const char *fn, const char *file, unsigned line);
67 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
69 #if (defined (LIBVLC_USE_PTHREAD) || defined(__ANDROID__)) && !defined (NDEBUG)
70 void vlc_assert_locked (vlc_mutex_t *);
72 # define vlc_assert_locked( m ) (void)m
76 * LibVLC exit event handling
78 typedef struct vlc_exit
81 void (*handler) (void *);
85 void vlc_ExitInit( vlc_exit_t * );
86 void vlc_ExitDestroy( vlc_exit_t * );
89 * LibVLC objects stuff
93 * Creates a VLC object.
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.
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.
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)
111 * Assign a name to an object for vlc_object_find_name().
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)
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)
123 * To be cleaned-up module stuff:
125 module_t *module_find_by_shortcut (const char *psz_shortcut);
128 * Private LibVLC data for each object.
130 typedef struct vlc_object_internals vlc_object_internals_t;
132 struct vlc_object_internals
134 char *psz_name; /* given name */
136 /* Object variables */
138 vlc_mutex_t var_lock;
141 /* Objects thread synchronization */
144 /* Objects management */
145 vlc_spinlock_t ref_spin;
147 vlc_destructor_t pf_destructor;
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 */
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")
161 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
162 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
164 typedef struct sap_handler_t sap_handler_t;
167 * Private LibVLC instance data.
169 typedef struct libvlc_priv_t
171 libvlc_int_t public_data;
173 bool playlist_active;
176 signed char i_verbose; ///< info messages
177 bool b_color; ///< color messages?
178 bool b_stats; ///< Whether to collect stats
180 /* Singleton objects */
181 playlist_t *p_playlist; ///< the playlist singleton
182 struct media_library_t *p_ml; ///< the ML singleton
183 vlc_mutex_t ml_lock; ///< Mutex for ML creation
184 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
185 vlc_object_t *p_dialog_provider; ///< dialog provider
187 sap_handler_t *p_sap; ///< SAP SDP advertiser
189 struct vlc_actions *actions; ///< Hotkeys handler
192 struct intf_thread_t *p_intf; ///< Interfaces linked-list
195 vlc_mutex_t structure_lock;
201 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
203 return (libvlc_priv_t *)libvlc;
206 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
207 void intf_DestroyAll( libvlc_int_t * );
209 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
214 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
225 typedef struct counter_sample_t
231 typedef struct counter_t
235 counter_sample_t ** pp_samples;
247 STATS_DEMUX_CORRUPTED,
248 STATS_DEMUX_DISCONTINUITY,
249 STATS_PLAYED_ABUFFERS,
254 STATS_CLIENT_CONNECTIONS,
255 STATS_ACTIVE_CONNECTIONS,
256 STATS_SOUT_SENT_PACKETS,
257 STATS_SOUT_SENT_BYTES,
258 STATS_SOUT_SEND_BITRATE,
259 STATS_DISPLAYED_PICTURES,
263 counter_t * stats_CounterCreate (int);
264 void stats_Update (counter_t *, uint64_t, uint64_t *);
265 void stats_CounterClean (counter_t * );
267 void stats_ComputeInputStats(input_thread_t*, input_stats_t*);
268 void stats_ReinitInputStats(input_stats_t *);