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 #if defined(_WIN32) || defined(__OS2__)
45 void system_End(void);
47 size_t EnumClockSource( vlc_object_t *, const char *, char ***, char *** );
50 void vlc_CPU_init(void);
51 void vlc_CPU_dump(vlc_object_t *);
57 /* This cannot be used as is from plugins yet: */
58 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
60 int vlc_object_waitpipe (vlc_object_t *obj);
61 void ObjectKillChildrens (vlc_object_t *);
63 int vlc_set_priority( vlc_thread_t, int );
65 void vlc_threads_setup (libvlc_int_t *);
67 void vlc_trace (const char *fn, const char *file, unsigned line);
68 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
70 #if (defined (LIBVLC_USE_PTHREAD) || defined(__ANDROID__)) && !defined (NDEBUG)
71 void vlc_assert_locked (vlc_mutex_t *);
73 # define vlc_assert_locked( m ) (void)m
79 typedef struct vlc_logger_t vlc_logger_t;
81 int vlc_LogPreinit(libvlc_int_t *);
82 int vlc_LogInit(libvlc_int_t *);
83 void vlc_LogDeinit(libvlc_int_t *);
86 * LibVLC exit event handling
88 typedef struct vlc_exit
91 void (*handler) (void *);
95 void vlc_ExitInit( vlc_exit_t * );
96 void vlc_ExitDestroy( vlc_exit_t * );
99 * LibVLC objects stuff
103 * Creates a VLC object.
105 * Note that because the object name pointer must remain valid, potentially
106 * even after the destruction of the object (through the message queues), this
107 * function CANNOT be exported to plugins as is. In this case, the old
108 * vlc_object_create() must be used instead.
110 * @param p_this an existing VLC object
111 * @param i_size byte size of the object structure
112 * @param psz_type object type name
113 * @return the created object, or NULL.
116 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
117 #define vlc_custom_create(o, s, n) \
118 vlc_custom_create(VLC_OBJECT(o), s, n)
121 * Assign a name to an object for vlc_object_find_name().
123 extern int vlc_object_set_name(vlc_object_t *, const char *);
124 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
127 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
128 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
129 #define vlc_object_set_destructor(a,b) \
130 vlc_object_set_destructor (VLC_OBJECT(a), b)
133 * To be cleaned-up module stuff:
135 module_t *module_find_by_shortcut (const char *psz_shortcut);
137 #define ZOOM_SECTION N_("Zoom")
138 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
139 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
140 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
141 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
144 * Private LibVLC instance data.
146 typedef struct libvlc_priv_t
148 libvlc_int_t public_data;
151 bool b_stats; ///< Whether to collect stats
153 /* Singleton objects */
154 vlc_logger_t *logger;
155 vlm_t *p_vlm; ///< the VLM singleton (or NULL)
156 vlc_object_t *p_dialog_provider; ///< dialog provider
157 struct playlist_t *playlist; ///< Playlist for interfaces
158 struct playlist_preparser_t *parser; ///< Input item meta data handler
159 struct vlc_actions *actions; ///< Hotkeys handler
162 vlc_mutex_t structure_lock;
168 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
170 return (libvlc_priv_t *)libvlc;
173 void intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
174 const char * const *optv, unsigned flags);
175 void intf_DestroyAll( libvlc_int_t * );
177 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
182 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
193 typedef struct counter_sample_t
199 typedef struct counter_t
203 counter_sample_t ** pp_samples;
215 STATS_DEMUX_CORRUPTED,
216 STATS_DEMUX_DISCONTINUITY,
217 STATS_PLAYED_ABUFFERS,
222 STATS_CLIENT_CONNECTIONS,
223 STATS_ACTIVE_CONNECTIONS,
224 STATS_SOUT_SENT_PACKETS,
225 STATS_SOUT_SENT_BYTES,
226 STATS_SOUT_SEND_BITRATE,
227 STATS_DISPLAYED_PICTURES,
231 counter_t * stats_CounterCreate (int);
232 void stats_Update (counter_t *, uint64_t, uint64_t *);
233 void stats_CounterClean (counter_t * );
235 void stats_ComputeInputStats(input_thread_t*, input_stats_t*);
236 void stats_ReinitInputStats(input_stats_t *);