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 overriden 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 overriden.
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 overriden.
107 * \return a nul terminated string in any case
109 const char *libvlc_printerr (const char *fmt, ...);
114 * Create and initialize a libvlc instance.
116 * \param argc the number of arguments
117 * \param argv command-line-type arguments
118 * \return the libvlc instance or NULL in case of error
120 VLC_PUBLIC_API libvlc_instance_t *
121 libvlc_new( int argc , const char *const *argv );
124 * Decrement the reference count of a libvlc instance, and destroy it
125 * if it reaches zero.
127 * \param p_instance the instance to destroy
129 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
132 * Increments the reference count of a libvlc instance.
133 * The initial reference count is 1 after libvlc_new() returns.
135 * \param p_instance the instance to reference
137 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
140 * Try to start a user interface for the libvlc instance.
142 * \param p_instance the instance
143 * \param name interface name, or NULL for default
144 * \return 0 on success, -1 on error.
147 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
150 * Registers a callback for the LibVLC exit event. This is mostly useful if
151 * you have started at least one interface with libvlc_add_intf().
152 * Typically, this function will wake up your application main loop (from
155 * \param p_instance LibVLC instance
156 * \param cb callback to invoke when LibVLC wants to exit
157 * \param opaque data pointer for the callback
158 * \warning This function and libvlc_wait() cannot be used at the same time.
159 * Use either or none of them but not both.
162 void libvlc_set_exit_handler( libvlc_instance_t *p_instance,
163 void (*cb) (void *), void *opaque );
166 * Waits until an interface causes the instance to exit.
167 * You should start at least one interface first, using libvlc_add_intf().
169 * \param p_instance the instance
172 void libvlc_wait( libvlc_instance_t *p_instance );
175 * Sets the application name. LibVLC passes this as the user agent string
176 * when a protocol requires it.
178 * \param p_instance LibVLC instance
179 * \param name human-readable application name, e.g. "FooBar player 1.2.3"
180 * \param http HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0"
181 * \version LibVLC 1.1.1 or later
184 void libvlc_set_user_agent( libvlc_instance_t *p_instance,
185 const char *name, const char *http );
188 * Retrieve libvlc version.
190 * Example: "1.1.0-git The Luggage"
192 * \return a string containing the libvlc version
194 VLC_PUBLIC_API const char * libvlc_get_version(void);
197 * Retrieve libvlc compiler version.
199 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
201 * \return a string containing the libvlc compiler version
203 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
206 * Retrieve libvlc changeset.
208 * Example: "aa9bce0bc4"
210 * \return a string containing the libvlc changeset
212 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
215 /** \defgroup libvlc_event LibVLC asynchronous events
216 * LibVLC emits asynchronous events.
218 * Several LibVLC objects (such @ref libvlc_instance_t as
219 * @ref libvlc_media_player_t) generate events asynchronously. Each of them
220 * provides @ref libvlc_event_manager_t event manager. You can subscribe to
221 * events with libvlc_event_attach() and unsubscribe with
222 * libvlc_event_detach().
227 * Event manager that belongs to a libvlc object, and from whom events can
230 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
232 struct libvlc_event_t;
235 * Type of a LibVLC event.
237 typedef int libvlc_event_type_t;
240 * Callback function notification
241 * \param p_event the event triggering the callback
243 typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * );
246 * Register for an event notification.
248 * \param p_event_manager the event manager to which you want to attach to.
249 * Generally it is obtained by vlc_my_object_event_manager() where
250 * my_object is the object you want to listen to.
251 * \param i_event_type the desired event to which we want to listen
252 * \param f_callback the function to call when i_event_type occurs
253 * \param user_data user provided data to carry with the event
254 * \return 0 on success, ENOMEM on error
256 VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
257 libvlc_event_type_t i_event_type,
258 libvlc_callback_t f_callback,
262 * Unregister an event notification.
264 * \param p_event_manager the event manager
265 * \param i_event_type the desired event to which we want to unregister
266 * \param f_callback the function to call when i_event_type occurs
267 * \param p_user_data user provided data to carry with the event
269 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
270 libvlc_event_type_t i_event_type,
271 libvlc_callback_t f_callback,
275 * Get an event's type name.
277 * \param event_type the desired event
279 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
283 /** \defgroup libvlc_log LibVLC logging
284 * libvlc_log_* functions provide access to the LibVLC messages log.
285 * This is used for debugging or by advanced users.
290 * Return the VLC messaging verbosity level.
292 * \param p_instance libvlc instance
293 * \return verbosity level for messages
295 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
298 * Set the VLC messaging verbosity level.
300 * \param p_instance libvlc log instance
301 * \param level log level
303 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
306 * Open a VLC message log instance.
308 * \param p_instance libvlc instance
309 * \return log message instance or NULL on error
311 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
314 * Close a VLC message log instance.
316 * \param p_log libvlc log instance or NULL
318 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
321 * Returns the number of messages in a log instance.
323 * \param p_log libvlc log instance or NULL
324 * \return number of log messages, 0 if p_log is NULL
326 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
329 * Clear a log instance.
331 * All messages in the log are removed. The log should be cleared on a
332 * regular basis to avoid clogging.
334 * \param p_log libvlc log instance or NULL
336 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
339 * Allocate and returns a new iterator to messages in log.
341 * \param p_log libvlc log instance
342 * \return log iterator object or NULL on error
344 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
347 * Release a previoulsy allocated iterator.
349 * \param p_iter libvlc log iterator or NULL
351 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
354 * Return whether log iterator has more messages.
356 * \param p_iter libvlc log iterator or NULL
357 * \return true if iterator has more message objects, else false
359 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
362 * Return the next log message.
364 * The message contents must not be freed
366 * \param p_iter libvlc log iterator or NULL
367 * \param p_buffer log buffer
368 * \return log message object or NULL if none left
370 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
371 libvlc_log_message_t *p_buffer );
381 #endif /* <vlc/libvlc.h> */