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)
44 # define VLC_PUBLIC_API
48 /* Avoid unuseful warnings from libvlc with our deprecated APIs */
49 # define VLC_DEPRECATED_API VLC_PUBLIC_API
50 #elif defined(__GNUC__) && \
51 (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
52 # define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
54 # define VLC_DEPRECATED_API VLC_PUBLIC_API
62 #include <vlc/libvlc_structures.h>
64 /** \defgroup libvlc_core LibVLC core
66 * Before it can do anything useful, LibVLC must be initialized.
67 * You can create one (or more) instance(s) of LibVLC in a given process,
68 * with libvlc_new() and destroy them with libvlc_release().
70 * \version Unless otherwise stated, these functions are available
71 * from LibVLC versions numbered 1.1.0 or more.
72 * Earlier versions (0.9.x and 1.0.x) are <b>not</b> compatible.
76 /** \defgroup libvlc_error LibVLC error handling
81 * A human-readable error message for the last LibVLC error in the calling
82 * thread. The resulting string is valid until another error occurs (at least
83 * until the next LibVLC call).
86 * This will be NULL if there was no error.
88 VLC_PUBLIC_API const char *libvlc_errmsg (void);
91 * Clears the LibVLC error status for the current thread. This is optional.
92 * By default, the error status is automatically overridden when a new error
93 * occurs, and destroyed when the thread exits.
95 VLC_PUBLIC_API void libvlc_clearerr (void);
98 * Sets the LibVLC error status and message for the current thread.
99 * Any previous error is overridden.
100 * \return a nul terminated string in any case
102 const char *libvlc_vprinterr (const char *fmt, va_list ap);
105 * Sets the LibVLC error status and message for the current thread.
106 * Any previous error is overridden.
107 * \return a nul terminated string in any case
109 const char *libvlc_printerr (const char *fmt, ...);
114 * Create and initialize a libvlc instance.
115 * This functions accept a list of "command line" arguments similar to the
116 * main(). These arguments affect the LibVLC instance default configuration.
119 * Arguments are meant to be passed from the command line to LibVLC, just like
120 * VLC media player does. The list of valid arguments depends on the LibVLC
121 * version, the operating system and platform, and set of available LibVLC
122 * plugins. Invalid or unsupported arguments will cause the function to fail
123 * (i.e. return NULL). Also, some arguments may alter the behaviour or
124 * otherwise interfere with other LibVLC functions.
127 * There is absolutely no warranty or promise of forward, backward and
128 * cross-platform compatibility with regards to libvlc_new() arguments.
129 * We recommend that you do not use them, other than when debugging.
131 * \param argc the number of arguments (should be 0)
132 * \param argv list of arguments (should be NULL)
133 * \return the libvlc instance or NULL in case of error
135 VLC_PUBLIC_API libvlc_instance_t *
136 libvlc_new( int argc , const char *const *argv );
140 * \return a static entry point for a module, suitable for passing to
141 * libvlc_new_with_builtins. This is to be used when you want to statically
144 * Note, statically linking to a module will results in nearly zero speed gain
145 * and increased memory usage. Use with caution.
148 #define vlc_plugin(module) & vlc_plugin_entry(module)
150 #define vlc_plugin_entry(module) vlc_entry__ ## module
151 #define vlc_declare_plugin(module) extern void *vlc_plugin_entry(module);
154 * Create and initialize a libvlc instance.
156 * \param argc the number of arguments
157 * \param argv command-line-type arguments
158 * \param builtins a NULL terminated array of \see vlc_plugin.
159 * \return the libvlc instance or NULL in case of error
162 * vlc_declare_plugin(mp4);
163 * vlc_declare_plugin(dummy);
164 * const void **builtins = { vlc_plugin(mp4), vlc_plugin(dummy), NULL };
165 * libvlc_instance_t *vlc = libvlc_new_with_builtins(argc, argv, builtins);
169 VLC_PUBLIC_API libvlc_instance_t *
170 libvlc_new_with_builtins( int argc , const char *const *argv, const void **builtins);
174 * Decrement the reference count of a libvlc instance, and destroy it
175 * if it reaches zero.
177 * \param p_instance the instance to destroy
179 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
182 * Increments the reference count of a libvlc instance.
183 * The initial reference count is 1 after libvlc_new() returns.
185 * \param p_instance the instance to reference
187 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
190 * Try to start a user interface for the libvlc instance.
192 * \param p_instance the instance
193 * \param name interface name, or NULL for default
194 * \return 0 on success, -1 on error.
197 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
200 * Registers a callback for the LibVLC exit event. This is mostly useful if
201 * you have started at least one interface with libvlc_add_intf().
202 * Typically, this function will wake up your application main loop (from
205 * \param p_instance LibVLC instance
206 * \param cb callback to invoke when LibVLC wants to exit
207 * \param opaque data pointer for the callback
208 * \warning This function and libvlc_wait() cannot be used at the same time.
209 * Use either or none of them but not both.
212 void libvlc_set_exit_handler( libvlc_instance_t *p_instance,
213 void (*cb) (void *), void *opaque );
216 * Waits until an interface causes the instance to exit.
217 * You should start at least one interface first, using libvlc_add_intf().
219 * \param p_instance the instance
222 void libvlc_wait( libvlc_instance_t *p_instance );
225 * Sets the application name. LibVLC passes this as the user agent string
226 * when a protocol requires it.
228 * \param p_instance LibVLC instance
229 * \param name human-readable application name, e.g. "FooBar player 1.2.3"
230 * \param http HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0"
231 * \version LibVLC 1.1.1 or later
234 void libvlc_set_user_agent( libvlc_instance_t *p_instance,
235 const char *name, const char *http );
238 * Retrieve libvlc version.
240 * Example: "1.1.0-git The Luggage"
242 * \return a string containing the libvlc version
244 VLC_PUBLIC_API const char * libvlc_get_version(void);
247 * Retrieve libvlc compiler version.
249 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
251 * \return a string containing the libvlc compiler version
253 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
256 * Retrieve libvlc changeset.
258 * Example: "aa9bce0bc4"
260 * \return a string containing the libvlc changeset
262 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
265 * Frees an heap allocation returned by a LibVLC function.
266 * If you know you're using the same underlying C run-time as the LibVLC
267 * implementation, then you can call ANSI C free() directly instead.
269 * \param ptr the pointer
271 VLC_PUBLIC_API void libvlc_free( void *ptr );
273 /** \defgroup libvlc_event LibVLC asynchronous events
274 * LibVLC emits asynchronous events.
276 * Several LibVLC objects (such @ref libvlc_instance_t as
277 * @ref libvlc_media_player_t) generate events asynchronously. Each of them
278 * provides @ref libvlc_event_manager_t event manager. You can subscribe to
279 * events with libvlc_event_attach() and unsubscribe with
280 * libvlc_event_detach().
285 * Event manager that belongs to a libvlc object, and from whom events can
288 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
290 struct libvlc_event_t;
293 * Type of a LibVLC event.
295 typedef int libvlc_event_type_t;
298 * Callback function notification
299 * \param p_event the event triggering the callback
301 typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * );
304 * Register for an event notification.
306 * \param p_event_manager the event manager to which you want to attach to.
307 * Generally it is obtained by vlc_my_object_event_manager() where
308 * my_object is the object you want to listen to.
309 * \param i_event_type the desired event to which we want to listen
310 * \param f_callback the function to call when i_event_type occurs
311 * \param user_data user provided data to carry with the event
312 * \return 0 on success, ENOMEM on error
314 VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
315 libvlc_event_type_t i_event_type,
316 libvlc_callback_t f_callback,
320 * Unregister an event notification.
322 * \param p_event_manager the event manager
323 * \param i_event_type the desired event to which we want to unregister
324 * \param f_callback the function to call when i_event_type occurs
325 * \param p_user_data user provided data to carry with the event
327 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
328 libvlc_event_type_t i_event_type,
329 libvlc_callback_t f_callback,
333 * Get an event's type name.
335 * \param event_type the desired event
337 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
341 /** \defgroup libvlc_log LibVLC logging
342 * libvlc_log_* functions provide access to the LibVLC messages log.
343 * This is used for debugging or by advanced users.
348 * Return the VLC messaging verbosity level.
350 * \param p_instance libvlc instance
351 * \return verbosity level for messages
353 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
356 * Set the VLC messaging verbosity level.
358 * \param p_instance libvlc log instance
359 * \param level log level
361 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
364 * Open a VLC message log instance.
366 * \param p_instance libvlc instance
367 * \return log message instance or NULL on error
369 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
372 * Close a VLC message log instance.
374 * \param p_log libvlc log instance or NULL
376 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
379 * Returns the number of messages in a log instance.
381 * \param p_log libvlc log instance or NULL
382 * \return number of log messages, 0 if p_log is NULL
384 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
387 * Clear a log instance.
389 * All messages in the log are removed. The log should be cleared on a
390 * regular basis to avoid clogging.
392 * \param p_log libvlc log instance or NULL
394 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
397 * Allocate and returns a new iterator to messages in log.
399 * \param p_log libvlc log instance
400 * \return log iterator object or NULL on error
402 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
405 * Release a previoulsy allocated iterator.
407 * \param p_iter libvlc log iterator or NULL
409 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
412 * Return whether log iterator has more messages.
414 * \param p_iter libvlc log iterator or NULL
415 * \return true if iterator has more message objects, else false
417 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
420 * Return the next log message.
422 * The message contents must not be freed
424 * \param p_iter libvlc log iterator or NULL
425 * \param p_buffer log buffer
426 * \return log message object or NULL if none left
428 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
429 libvlc_log_message_t *p_buffer );
434 * Description of a module.
436 typedef struct libvlc_module_description_t
442 struct libvlc_module_description_t *p_next;
443 } libvlc_module_description_t;
445 libvlc_module_description_t *libvlc_module_description_list_get( libvlc_instance_t *p_instance, const char *capability );
448 * Release a list of module descriptions.
450 * \param p_list the list to be released
453 void libvlc_module_description_list_release( libvlc_module_description_t *p_list );
456 * Returns a list of audio filters that are available.
458 * \param p_instance libvlc instance
460 * \return a list of module descriptions. It should be freed with libvlc_module_description_list_release().
461 * In case of an error, NULL is returned.
463 * \see libvlc_module_description_t
464 * \see libvlc_module_description_list_release
467 libvlc_module_description_t *libvlc_audio_filter_list_get( libvlc_instance_t *p_instance );
470 * Returns a list of video filters that are available.
472 * \param p_instance libvlc instance
474 * \return a list of module descriptions. It should be freed with libvlc_module_description_list_release().
475 * In case of an error, NULL is returned.
477 * \see libvlc_module_description_t
478 * \see libvlc_module_description_list_release
481 libvlc_module_description_t *libvlc_video_filter_list_get( libvlc_instance_t *p_instance );
490 #endif /* <vlc/libvlc.h> */