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 * This is libvlc, the base library of the VLC program.
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 /*****************************************************************************
66 *****************************************************************************/
67 /** \defgroup libvlc_exception libvlc_exception
68 * \ingroup libvlc_core
69 * LibVLC Exceptions handling
74 * Initialize an exception structure. This can be called several times to
75 * reuse an exception structure.
77 * \param p_exception the exception to initialize
79 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
82 * Has an exception been raised?
84 * \param p_exception the exception to query
85 * \return 0 if the exception was raised, 1 otherwise
88 libvlc_exception_raised( const libvlc_exception_t *p_exception );
91 * Raise an exception using a user-provided message.
93 * \param p_exception the exception to raise
94 * \param psz_format the exception message format string
95 * \param ... the format string arguments
98 libvlc_exception_raise( libvlc_exception_t *p_exception,
99 const char *psz_format, ... );
102 * Clear an exception object so it can be reused.
103 * The exception object must have be initialized.
105 * \param p_exception the exception to clear
107 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
110 * Get an exception's message.
112 * \param p_exception the exception to query
113 * \return the exception message or NULL if not applicable (exception not
114 * raised, for example)
116 VLC_PUBLIC_API const char *
117 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
121 /*****************************************************************************
123 *****************************************************************************/
124 /** \defgroup libvlc_error libvlc_error
125 * \ingroup libvlc_core
126 * LibVLC error handling
131 * A human-readable error message for the last LibVLC error in the calling
132 * thread. The resulting string is valid until another error occurs (at least
133 * until the next LibVLC call).
136 * This will be NULL if there was no error.
138 const char *libvlc_errmsg (void);
141 * Clears the LibVLC error status for the current thread. This is optional.
142 * By default, the error status is automatically overriden when a new error
143 * occurs, and destroyed when the thread exits.
145 void libvlc_clearerr (void);
148 * Sets the LibVLC error status and message for the current thread.
149 * Any previous error is overriden.
150 * @return a nul terminated string in any case
152 const char *libvlc_vprinterr (const char *fmt, va_list ap);
155 * Sets the LibVLC error status and message for the current thread.
156 * Any previous error is overriden.
157 * @return a nul terminated string in any case
159 const char *libvlc_printerr (const char *fmt, ...);
164 /*****************************************************************************
166 *****************************************************************************/
168 /** \defgroup libvlc_core libvlc_core
175 * Create and initialize a libvlc instance.
177 * \param argc the number of arguments
178 * \param argv command-line-type arguments. argv[0] must be the path of the
180 * \param p_e an initialized exception pointer
181 * \return the libvlc instance
183 VLC_PUBLIC_API libvlc_instance_t *
184 libvlc_new( int , const char *const *, libvlc_exception_t *);
187 * Decrement the reference count of a libvlc instance, and destroy it
188 * if it reaches zero.
190 * \param p_instance the instance to destroy
192 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
195 * Increments the reference count of a libvlc instance.
196 * The initial reference count is 1 after libvlc_new() returns.
198 * \param p_instance the instance to reference
200 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
203 * Try to start a user interface for the libvlc instance.
205 * \param p_instance the instance
206 * \param name interface name, or NULL for default
207 * \param p_exception an initialized exception pointer
208 * \return 0 on success, -1 on error.
211 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
212 libvlc_exception_t *p_exception );
215 * Waits until an interface causes the instance to exit.
216 * You should start at least one interface first, using libvlc_add_intf().
218 * \param p_instance the instance
221 void libvlc_wait( libvlc_instance_t *p_instance );
224 * Retrieve libvlc version.
226 * Example: "0.9.0-git Grishenko"
228 * \return a string containing the libvlc version
230 VLC_PUBLIC_API const char * libvlc_get_version(void);
233 * Retrieve libvlc compiler version.
235 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
237 * \return a string containing the libvlc compiler version
239 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
242 * Retrieve libvlc changeset.
244 * Example: "aa9bce0bc4"
246 * \return a string containing the libvlc changeset
248 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
253 * Get the internal main VLC object.
254 * Use of this function is usually a hack and should be avoided.
256 * You will need to link with libvlccore to make any use of the underlying VLC
257 * object. The libvlccore programming and binary interfaces are not stable.
259 * Remember to release the object with vlc_object_release().
261 * \param p_instance the libvlc instance
262 * @return a VLC object of type "libvlc"
264 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
267 * Frees an heap allocation (char *) returned by a LibVLC API.
268 * If you know you're using the same underlying C run-time as the LibVLC
269 * implementation, then you can call ANSI C free() directly instead.
271 VLC_PUBLIC_API void libvlc_free( void *ptr );
275 /*****************************************************************************
277 *****************************************************************************/
279 /** \defgroup libvlc_event libvlc_event
280 * \ingroup libvlc_core
286 * Event manager that belongs to a libvlc object, and from whom events can
290 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
291 typedef struct libvlc_event_t libvlc_event_t;
292 typedef uint32_t libvlc_event_type_t;
295 * Callback function notification
296 * \param p_event the event triggering the callback
299 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
302 * Register for an event notification.
304 * \param p_event_manager the event manager to which you want to attach to.
305 * Generally it is obtained by vlc_my_object_event_manager() where
306 * my_object is the object you want to listen to.
307 * \param i_event_type the desired event to which we want to listen
308 * \param f_callback the function to call when i_event_type occurs
309 * \param user_data user provided data to carry with the event
310 * \param p_e an initialized exception pointer
312 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
313 libvlc_event_type_t i_event_type,
314 libvlc_callback_t f_callback,
316 libvlc_exception_t *p_e );
319 * Unregister an event notification.
321 * \param p_event_manager the event manager
322 * \param i_event_type the desired event to which we want to unregister
323 * \param f_callback the function to call when i_event_type occurs
324 * \param p_user_data user provided data to carry with the event
325 * \param p_e an initialized exception pointer
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,
331 libvlc_exception_t *p_e );
334 * Get an event's type name.
336 * \param i_event_type the desired event
338 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
342 /*****************************************************************************
343 * Message log handling
344 *****************************************************************************/
346 /** \defgroup libvlc_log libvlc_log
347 * \ingroup libvlc_core
348 * LibVLC Message Logging
353 * Return the VLC messaging verbosity level.
355 * \param p_instance libvlc instance
356 * \return verbosity level for messages
358 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
361 * Set the VLC messaging verbosity level.
363 * \param p_instance libvlc log instance
364 * \param level log level
366 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
369 * Open a VLC message log instance.
371 * \param p_instance libvlc instance
372 * \param p_e an initialized exception pointer
373 * \return log message instance
375 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
378 * Close a VLC message log instance.
380 * \param p_log libvlc log instance or NULL
382 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
385 * Returns the number of messages in a log instance.
387 * \param p_log libvlc log instance or NULL
388 * \param p_e an initialized exception pointer
389 * \return number of log messages, 0 if p_log is NULL
391 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
394 * Clear a log instance.
396 * All messages in the log are removed. The log should be cleared on a
397 * regular basis to avoid clogging.
399 * \param p_log libvlc log instance or NULL
401 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
404 * Allocate and returns a new iterator to messages in log.
406 * \param p_log libvlc log instance
407 * \param p_e an initialized exception pointer
408 * \return log iterator object
410 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
413 * Release a previoulsy allocated iterator.
415 * \param p_iter libvlc log iterator or NULL
417 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
420 * Return whether log iterator has more messages.
422 * \param p_iter libvlc log iterator or NULL
423 * \return true if iterator has more message objects, else false
425 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
428 * Return the next log message.
430 * The message contents must not be freed
432 * \param p_iter libvlc log iterator or NULL
433 * \param p_buffer log buffer
434 * \param p_e an initialized exception pointer
435 * \return log message object
437 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
438 libvlc_log_message_t *p_buffer,
439 libvlc_exception_t *p_e );
447 #endif /* <vlc/libvlc.h> */