]> git.sesse.net Git - vlc/blob - src/libvlc.h
macosx/configure.sh: Enable libsamplerate again
[vlc] / src / libvlc.h
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
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 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.
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 Lesser General Public License for more details.
19  *
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  *****************************************************************************/
24
25 #ifndef LIBVLC_LIBVLC_H
26 # define LIBVLC_LIBVLC_H 1
27
28 extern const char psz_vlc_changeset[];
29
30 typedef struct variable_t variable_t;
31
32 /* Actions (hot keys) */
33 struct vlc_actions;
34 struct vlc_actions *vlc_InitActions (libvlc_int_t *);
35 extern void vlc_DeinitActions (libvlc_int_t *, struct vlc_actions *);
36
37 size_t vlc_towc (const char *str, uint32_t *restrict pwc);
38
39 /*
40  * OS-specific initialization
41  */
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);
46 #ifndef __OS2__
47 size_t EnumClockSource( vlc_object_t *, const char *, char ***, char *** );
48 #endif
49 #endif
50 void vlc_CPU_init(void);
51 void vlc_CPU_dump(vlc_object_t *);
52
53 /*
54  * Threads subsystem
55  */
56
57 /* This cannot be used as is from plugins yet: */
58 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
59
60 int vlc_object_waitpipe (vlc_object_t *obj);
61 void ObjectKillChildrens (vlc_object_t *);
62
63 int vlc_set_priority( vlc_thread_t, int );
64
65 void vlc_threads_setup (libvlc_int_t *);
66
67 void vlc_trace (const char *fn, const char *file, unsigned line);
68 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
69
70 #if (defined (LIBVLC_USE_PTHREAD) || defined(__ANDROID__)) && !defined (NDEBUG)
71 void vlc_assert_locked (vlc_mutex_t *);
72 #else
73 # define vlc_assert_locked( m ) (void)m
74 #endif
75
76 /*
77  * Logging
78  */
79 void vlc_LogInit(libvlc_int_t *);
80 void vlc_LogDeinit(libvlc_int_t *);
81
82 /*
83  * LibVLC exit event handling
84  */
85 typedef struct vlc_exit
86 {
87     vlc_mutex_t lock;
88     void (*handler) (void *);
89     void *opaque;
90 } vlc_exit_t;
91
92 void vlc_ExitInit( vlc_exit_t * );
93 void vlc_ExitDestroy( vlc_exit_t * );
94
95 /*
96  * LibVLC objects stuff
97  */
98
99 /**
100  * Creates a VLC object.
101  *
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.
106  *
107  * @param p_this an existing VLC object
108  * @param i_size byte size of the object structure
109  * @param psz_type object type name
110  * @return the created object, or NULL.
111  */
112 extern void *
113 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
114 #define vlc_custom_create(o, s, n) \
115         vlc_custom_create(VLC_OBJECT(o), s, n)
116
117 /**
118  * Assign a name to an object for vlc_object_find_name().
119  */
120 extern int vlc_object_set_name(vlc_object_t *, const char *);
121 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
122
123 /* Types */
124 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
125 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
126 #define vlc_object_set_destructor(a,b) \
127         vlc_object_set_destructor (VLC_OBJECT(a), b)
128
129 /*
130  * To be cleaned-up module stuff:
131  */
132 module_t *module_find_by_shortcut (const char *psz_shortcut);
133
134 #define ZOOM_SECTION N_("Zoom")
135 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
136 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
137 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
138 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
139
140 /**
141  * Private LibVLC instance data.
142  */
143 typedef struct libvlc_priv_t
144 {
145     libvlc_int_t       public_data;
146
147     /* Logging */
148     struct
149     {
150         void (*cb) (void *, int, const vlc_log_t *, const char *, va_list);
151         void *opaque;
152         signed char verbose;
153         vlc_rwlock_t lock;
154     } log;
155     bool               b_stats;     ///< Whether to collect stats
156
157     /* Singleton objects */
158     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
159     vlc_object_t      *p_dialog_provider; ///< dialog provider
160     struct playlist_t *playlist; ///< Playlist for interfaces
161     struct playlist_preparser_t *parser; ///< Input item meta data handler
162     struct vlc_actions *actions; ///< Hotkeys handler
163
164     /* Objects tree */
165     vlc_mutex_t        structure_lock;
166
167     /* Exit callback */
168     vlc_exit_t       exit;
169 } libvlc_priv_t;
170
171 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
172 {
173     return (libvlc_priv_t *)libvlc;
174 }
175
176 void intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
177                      const char * const *optv, unsigned flags);
178 void intf_DestroyAll( libvlc_int_t * );
179
180 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
181
182 /*
183  * Variables stuff
184  */
185 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
186
187 /*
188  * Stats stuff
189  */
190 enum
191 {
192     STATS_COUNTER,
193     STATS_DERIVATIVE,
194 };
195
196 typedef struct counter_sample_t
197 {
198     uint64_t value;
199     mtime_t  date;
200 } counter_sample_t;
201
202 typedef struct counter_t
203 {
204     int                 i_compute_type;
205     int                 i_samples;
206     counter_sample_t ** pp_samples;
207
208     mtime_t             last_update;
209 } counter_t;
210
211 enum
212 {
213     STATS_INPUT_BITRATE,
214     STATS_READ_BYTES,
215     STATS_READ_PACKETS,
216     STATS_DEMUX_READ,
217     STATS_DEMUX_BITRATE,
218     STATS_DEMUX_CORRUPTED,
219     STATS_DEMUX_DISCONTINUITY,
220     STATS_PLAYED_ABUFFERS,
221     STATS_LOST_ABUFFERS,
222     STATS_DECODED_AUDIO,
223     STATS_DECODED_VIDEO,
224     STATS_DECODED_SUB,
225     STATS_CLIENT_CONNECTIONS,
226     STATS_ACTIVE_CONNECTIONS,
227     STATS_SOUT_SENT_PACKETS,
228     STATS_SOUT_SENT_BYTES,
229     STATS_SOUT_SEND_BITRATE,
230     STATS_DISPLAYED_PICTURES,
231     STATS_LOST_PICTURES,
232 };
233
234 counter_t * stats_CounterCreate (int);
235 void stats_Update (counter_t *, uint64_t, uint64_t *);
236 void stats_CounterClean (counter_t * );
237
238 void stats_ComputeInputStats(input_thread_t*, input_stats_t*);
239 void stats_ReinitInputStats(input_stats_t *);
240
241 #endif