1 /*****************************************************************************
2 * libvlc.h: libvlc external API
3 *****************************************************************************
4 * Copyright (C) 1998-2009 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman@videolan.org>
9 * Pierre d'Herbemont <pdherbemont@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
28 * This file defines libvlc external API
32 * \defgroup libvlc LibVLC
33 * LibVLC is the external programming interface of the VLC media player.
34 * It is used to embed VLC into other applications or frameworks.
39 #define VLC_LIBVLC_H 1
41 #if defined (WIN32) && defined (DLL_EXPORT)
42 # define VLC_PUBLIC_API __declspec(dllexport)
43 #elif defined (__GNUC__) && (__GNUC__ >= 4)
44 # define VLC_PUBLIC_API __attribute__((visibility("default")))
46 # define VLC_PUBLIC_API
50 /* Avoid unuseful warnings from libvlc with our deprecated APIs */
51 # define VLC_DEPRECATED_API VLC_PUBLIC_API
52 #elif defined(__GNUC__) && \
53 (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
54 # define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
56 # define VLC_DEPRECATED_API VLC_PUBLIC_API
64 #include <vlc/libvlc_structures.h>
66 /** \defgroup libvlc_core LibVLC core
68 * Before it can do anything useful, LibVLC must be initialized.
69 * You can create one (or more) instance(s) of LibVLC in a given process,
70 * with libvlc_new() and destroy them with libvlc_release().
72 * \version Unless otherwise stated, these functions are available
73 * from LibVLC versions numbered 1.1.0 or more.
74 * Earlier versions (0.9.x and 1.0.x) are <b>not</b> compatible.
78 /** \defgroup libvlc_error LibVLC error handling
83 * A human-readable error message for the last LibVLC error in the calling
84 * thread. The resulting string is valid until another error occurs (at least
85 * until the next LibVLC call).
88 * This will be NULL if there was no error.
90 VLC_PUBLIC_API const char *libvlc_errmsg (void);
93 * Clears the LibVLC error status for the current thread. This is optional.
94 * By default, the error status is automatically overridden when a new error
95 * occurs, and destroyed when the thread exits.
97 VLC_PUBLIC_API void libvlc_clearerr (void);
100 * Sets the LibVLC error status and message for the current thread.
101 * Any previous error is overridden.
102 * \return a nul terminated string in any case
104 const char *libvlc_vprinterr (const char *fmt, va_list ap);
107 * Sets the LibVLC error status and message for the current thread.
108 * Any previous error is overridden.
109 * \return a nul terminated string in any case
111 const char *libvlc_printerr (const char *fmt, ...);
116 * Create and initialize a libvlc instance.
117 * This functions accept a list of "command line" arguments similar to the
118 * main(). These arguments affect the LibVLC instance default configuration.
121 * Arguments are meant to be passed from the command line to LibVLC, just like
122 * VLC media player does. The list of valid arguments depends on the LibVLC
123 * version, the operating system and platform, and set of available LibVLC
124 * plugins. Invalid or unsupported arguments will cause the function to fail
125 * (i.e. return NULL). Also, some arguments may alter the behaviour or
126 * otherwise interfere with other LibVLC functions.
129 * There is absolutely no warranty or promise of forward, backward and
130 * cross-platform compatibility with regards to libvlc_new() arguments.
131 * We recommend that you do not use them, other than when debugging.
133 * \param argc the number of arguments (should be 0)
134 * \param argv list of arguments (should be NULL)
135 * \return the libvlc instance or NULL in case of error
137 VLC_PUBLIC_API libvlc_instance_t *
138 libvlc_new( int argc , const char *const *argv );
141 * Decrement the reference count of a libvlc instance, and destroy it
142 * if it reaches zero.
144 * \param p_instance the instance to destroy
146 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
149 * Increments the reference count of a libvlc instance.
150 * The initial reference count is 1 after libvlc_new() returns.
152 * \param p_instance the instance to reference
154 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
157 * Try to start a user interface for the libvlc instance.
159 * \param p_instance the instance
160 * \param name interface name, or NULL for default
161 * \return 0 on success, -1 on error.
164 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
167 * Registers a callback for the LibVLC exit event. This is mostly useful if
168 * you have started at least one interface with libvlc_add_intf().
169 * Typically, this function will wake up your application main loop (from
172 * \param p_instance LibVLC instance
173 * \param cb callback to invoke when LibVLC wants to exit
174 * \param opaque data pointer for the callback
175 * \warning This function and libvlc_wait() cannot be used at the same time.
176 * Use either or none of them but not both.
179 void libvlc_set_exit_handler( libvlc_instance_t *p_instance,
180 void (*cb) (void *), void *opaque );
183 * Waits until an interface causes the instance to exit.
184 * You should start at least one interface first, using libvlc_add_intf().
186 * \param p_instance the instance
189 void libvlc_wait( libvlc_instance_t *p_instance );
192 * Sets the application name. LibVLC passes this as the user agent string
193 * when a protocol requires it.
195 * \param p_instance LibVLC instance
196 * \param name human-readable application name, e.g. "FooBar player 1.2.3"
197 * \param http HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0"
198 * \version LibVLC 1.1.1 or later
201 void libvlc_set_user_agent( libvlc_instance_t *p_instance,
202 const char *name, const char *http );
205 * Retrieve libvlc version.
207 * Example: "1.1.0-git The Luggage"
209 * \return a string containing the libvlc version
211 VLC_PUBLIC_API const char * libvlc_get_version(void);
214 * Retrieve libvlc compiler version.
216 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
218 * \return a string containing the libvlc compiler version
220 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
223 * Retrieve libvlc changeset.
225 * Example: "aa9bce0bc4"
227 * \return a string containing the libvlc changeset
229 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
232 * Frees an heap allocation returned by a LibVLC function.
233 * If you know you're using the same underlying C run-time as the LibVLC
234 * implementation, then you can call ANSI C free() directly instead.
236 * \param ptr the pointer
238 VLC_PUBLIC_API void libvlc_free( void *ptr );
240 /** \defgroup libvlc_event LibVLC asynchronous events
241 * LibVLC emits asynchronous events.
243 * Several LibVLC objects (such @ref libvlc_instance_t as
244 * @ref libvlc_media_player_t) generate events asynchronously. Each of them
245 * provides @ref libvlc_event_manager_t event manager. You can subscribe to
246 * events with libvlc_event_attach() and unsubscribe with
247 * libvlc_event_detach().
252 * Event manager that belongs to a libvlc object, and from whom events can
255 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
257 struct libvlc_event_t;
260 * Type of a LibVLC event.
262 typedef int libvlc_event_type_t;
265 * Callback function notification
266 * \param p_event the event triggering the callback
268 typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * );
271 * Register for an event notification.
273 * \param p_event_manager the event manager to which you want to attach to.
274 * Generally it is obtained by vlc_my_object_event_manager() where
275 * my_object is the object you want to listen to.
276 * \param i_event_type the desired event to which we want to listen
277 * \param f_callback the function to call when i_event_type occurs
278 * \param user_data user provided data to carry with the event
279 * \return 0 on success, ENOMEM on error
281 VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
282 libvlc_event_type_t i_event_type,
283 libvlc_callback_t f_callback,
287 * Unregister an event notification.
289 * \param p_event_manager the event manager
290 * \param i_event_type the desired event to which we want to unregister
291 * \param f_callback the function to call when i_event_type occurs
292 * \param p_user_data user provided data to carry with the event
294 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
295 libvlc_event_type_t i_event_type,
296 libvlc_callback_t f_callback,
300 * Get an event's type name.
302 * \param event_type the desired event
304 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
308 /** \defgroup libvlc_log LibVLC logging
309 * libvlc_log_* functions provide access to the LibVLC messages log.
310 * This is used for debugging or by advanced users.
315 * Return the VLC messaging verbosity level.
317 * \param p_instance libvlc instance
318 * \return verbosity level for messages
320 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
323 * Set the VLC messaging verbosity level.
325 * \param p_instance libvlc log instance
326 * \param level log level
328 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
331 * Open a VLC message log instance.
333 * \param p_instance libvlc instance
334 * \return log message instance or NULL on error
336 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
339 * Close a VLC message log instance.
341 * \param p_log libvlc log instance or NULL
343 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
346 * Returns the number of messages in a log instance.
348 * \param p_log libvlc log instance or NULL
349 * \return number of log messages, 0 if p_log is NULL
351 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
354 * Clear a log instance.
356 * All messages in the log are removed. The log should be cleared on a
357 * regular basis to avoid clogging.
359 * \param p_log libvlc log instance or NULL
361 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
364 * Allocate and returns a new iterator to messages in log.
366 * \param p_log libvlc log instance
367 * \return log iterator object or NULL on error
369 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
372 * Release a previoulsy allocated iterator.
374 * \param p_iter libvlc log iterator or NULL
376 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
379 * Return whether log iterator has more messages.
381 * \param p_iter libvlc log iterator or NULL
382 * \return true if iterator has more message objects, else false
384 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
387 * Return the next log message.
389 * The message contents must not be freed
391 * \param p_iter libvlc log iterator or NULL
392 * \param p_buffer log buffer
393 * \return log message object or NULL if none left
395 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
396 libvlc_log_message_t *p_buffer );
401 * Description of a module.
403 typedef struct libvlc_module_description_t
409 struct libvlc_module_description_t *p_next;
410 } libvlc_module_description_t;
412 libvlc_module_description_t *libvlc_module_description_list_get( libvlc_instance_t *p_instance, const char *capability );
415 * Release a list of module descriptions.
417 * \param p_list the list to be released
420 void libvlc_module_description_list_release( libvlc_module_description_t *p_list );
423 * Returns a list of audio filters that are available.
425 * \param p_instance libvlc instance
427 * \return a list of module descriptions. It should be freed with libvlc_module_description_list_release().
428 * In case of an error, NULL is returned.
430 * \see libvlc_module_description_t
431 * \see libvlc_module_description_list_release
434 libvlc_module_description_t *libvlc_audio_filter_list_get( libvlc_instance_t *p_instance );
437 * Returns a list of video filters that are available.
439 * \param p_instance libvlc instance
441 * \return a list of module descriptions. It should be freed with libvlc_module_description_list_release().
442 * In case of an error, NULL is returned.
444 * \see libvlc_module_description_t
445 * \see libvlc_module_description_list_release
448 libvlc_module_description_t *libvlc_video_filter_list_get( libvlc_instance_t *p_instance );
457 #endif /* <vlc/libvlc.h> */