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 );
93 * \param p_exception the exception to raise
96 libvlc_exception_raise( libvlc_exception_t *p_exception );
99 * Clear an exception object so it can be reused.
100 * The exception object must have be initialized.
102 * \param p_exception the exception to clear
104 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
108 /*****************************************************************************
110 *****************************************************************************/
111 /** \defgroup libvlc_error libvlc_error
112 * \ingroup libvlc_core
113 * LibVLC error handling
118 * A human-readable error message for the last LibVLC error in the calling
119 * thread. The resulting string is valid until another error occurs (at least
120 * until the next LibVLC call).
123 * This will be NULL if there was no error.
125 VLC_PUBLIC_API const char *libvlc_errmsg (void);
128 * Clears the LibVLC error status for the current thread. This is optional.
129 * By default, the error status is automatically overriden when a new error
130 * occurs, and destroyed when the thread exits.
132 VLC_PUBLIC_API void libvlc_clearerr (void);
135 * Sets the LibVLC error status and message for the current thread.
136 * Any previous error is overriden.
137 * @return a nul terminated string in any case
139 const char *libvlc_vprinterr (const char *fmt, va_list ap);
142 * Sets the LibVLC error status and message for the current thread.
143 * Any previous error is overriden.
144 * @return a nul terminated string in any case
146 const char *libvlc_printerr (const char *fmt, ...);
151 /*****************************************************************************
153 *****************************************************************************/
155 /** \defgroup libvlc_core libvlc_core
162 * Create and initialize a libvlc instance.
164 * \param argc the number of arguments
165 * \param argv command-line-type arguments. argv[0] must be the path of the
167 * \param p_e an initialized exception pointer
168 * \return the libvlc instance
170 VLC_PUBLIC_API libvlc_instance_t *
171 libvlc_new( int , const char *const *, libvlc_exception_t *);
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 * );
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 * );
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 * \param p_exception an initialized exception pointer
195 * \return 0 on success, -1 on error.
198 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
199 libvlc_exception_t *p_exception );
202 * Waits until an interface causes the instance to exit.
203 * You should start at least one interface first, using libvlc_add_intf().
205 * \param p_instance the instance
208 void libvlc_wait( libvlc_instance_t *p_instance );
211 * Retrieve libvlc version.
213 * Example: "0.9.0-git Grishenko"
215 * \return a string containing the libvlc version
217 VLC_PUBLIC_API const char * libvlc_get_version(void);
220 * Retrieve libvlc compiler version.
222 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
224 * \return a string containing the libvlc compiler version
226 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
229 * Retrieve libvlc changeset.
231 * Example: "aa9bce0bc4"
233 * \return a string containing the libvlc changeset
235 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
240 * Get the internal main VLC object.
241 * Use of this function is usually a hack and should be avoided.
243 * You will need to link with libvlccore to make any use of the underlying VLC
244 * object. The libvlccore programming and binary interfaces are not stable.
246 * Remember to release the object with vlc_object_release().
248 * \param p_instance the libvlc instance
249 * @return a VLC object of type "libvlc"
251 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
254 * Frees an heap allocation (char *) returned by a LibVLC API.
255 * If you know you're using the same underlying C run-time as the LibVLC
256 * implementation, then you can call ANSI C free() directly instead.
258 * \param ptr the pointer
260 VLC_PUBLIC_API void libvlc_free( void *ptr );
264 /*****************************************************************************
266 *****************************************************************************/
268 /** \defgroup libvlc_event libvlc_event
269 * \ingroup libvlc_core
275 * Event manager that belongs to a libvlc object, and from whom events can
279 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
280 typedef struct libvlc_event_t libvlc_event_t;
281 typedef uint32_t libvlc_event_type_t;
284 * Callback function notification
285 * \param p_event the event triggering the callback
288 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
291 * Register for an event notification.
293 * \param p_event_manager the event manager to which you want to attach to.
294 * Generally it is obtained by vlc_my_object_event_manager() where
295 * my_object is the object you want to listen to.
296 * \param i_event_type the desired event to which we want to listen
297 * \param f_callback the function to call when i_event_type occurs
298 * \param user_data user provided data to carry with the event
299 * \param p_e an initialized exception pointer
301 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
302 libvlc_event_type_t i_event_type,
303 libvlc_callback_t f_callback,
305 libvlc_exception_t *p_e );
308 * Unregister an event notification.
310 * \param p_event_manager the event manager
311 * \param i_event_type the desired event to which we want to unregister
312 * \param f_callback the function to call when i_event_type occurs
313 * \param p_user_data user provided data to carry with the event
314 * \param p_e an initialized exception pointer
316 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
317 libvlc_event_type_t i_event_type,
318 libvlc_callback_t f_callback,
320 libvlc_exception_t *p_e );
323 * Get an event's type name.
325 * \param i_event_type the desired event
327 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
331 /*****************************************************************************
332 * Message log handling
333 *****************************************************************************/
335 /** \defgroup libvlc_log libvlc_log
336 * \ingroup libvlc_core
337 * LibVLC Message Logging
342 * Return the VLC messaging verbosity level.
344 * \param p_instance libvlc instance
345 * \return verbosity level for messages
347 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
350 * Set the VLC messaging verbosity level.
352 * \param p_instance libvlc log instance
353 * \param level log level
355 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
358 * Open a VLC message log instance.
360 * \param p_instance libvlc instance
361 * \param p_e an initialized exception pointer
362 * \return log message instance
364 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
367 * Close a VLC message log instance.
369 * \param p_log libvlc log instance or NULL
371 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
374 * Returns the number of messages in a log instance.
376 * \param p_log libvlc log instance or NULL
377 * \return number of log messages, 0 if p_log is NULL
379 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
382 * Clear a log instance.
384 * All messages in the log are removed. The log should be cleared on a
385 * regular basis to avoid clogging.
387 * \param p_log libvlc log instance or NULL
389 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
392 * Allocate and returns a new iterator to messages in log.
394 * \param p_log libvlc log instance
395 * \param p_e an initialized exception pointer
396 * \return log iterator object
398 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
401 * Release a previoulsy allocated iterator.
403 * \param p_iter libvlc log iterator or NULL
405 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
408 * Return whether log iterator has more messages.
410 * \param p_iter libvlc log iterator or NULL
411 * \return true if iterator has more message objects, else false
413 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
416 * Return the next log message.
418 * The message contents must not be freed
420 * \param p_iter libvlc log iterator or NULL
421 * \param p_buffer log buffer
422 * \param p_e an initialized exception pointer
423 * \return log message object
425 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
426 libvlc_log_message_t *p_buffer,
427 libvlc_exception_t *p_e );
435 #endif /* <vlc/libvlc.h> */