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 * );
111 /*****************************************************************************
113 *****************************************************************************/
114 /** \defgroup libvlc_error libvlc_error
115 * \ingroup libvlc_core
116 * LibVLC error handling
121 * A human-readable error message for the last LibVLC error in the calling
122 * thread. The resulting string is valid until another error occurs (at least
123 * until the next LibVLC call).
126 * This will be NULL if there was no error.
128 VLC_PUBLIC_API const char *libvlc_errmsg (void);
131 * Clears the LibVLC error status for the current thread. This is optional.
132 * By default, the error status is automatically overriden when a new error
133 * occurs, and destroyed when the thread exits.
135 VLC_PUBLIC_API void libvlc_clearerr (void);
138 * Sets the LibVLC error status and message for the current thread.
139 * Any previous error is overriden.
140 * @return a nul terminated string in any case
142 const char *libvlc_vprinterr (const char *fmt, va_list ap);
145 * Sets the LibVLC error status and message for the current thread.
146 * Any previous error is overriden.
147 * @return a nul terminated string in any case
149 const char *libvlc_printerr (const char *fmt, ...);
154 /*****************************************************************************
156 *****************************************************************************/
158 /** \defgroup libvlc_core libvlc_core
165 * Create and initialize a libvlc instance.
167 * \param argc the number of arguments
168 * \param argv command-line-type arguments. argv[0] must be the path of the
170 * \param p_e an initialized exception pointer
171 * \return the libvlc instance
173 VLC_PUBLIC_API libvlc_instance_t *
174 libvlc_new( int , const char *const *, libvlc_exception_t *);
177 * Decrement the reference count of a libvlc instance, and destroy it
178 * if it reaches zero.
180 * \param p_instance the instance to destroy
182 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
185 * Increments the reference count of a libvlc instance.
186 * The initial reference count is 1 after libvlc_new() returns.
188 * \param p_instance the instance to reference
190 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
193 * Try to start a user interface for the libvlc instance.
195 * \param p_instance the instance
196 * \param name interface name, or NULL for default
197 * \param p_exception an initialized exception pointer
198 * \return 0 on success, -1 on error.
201 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
202 libvlc_exception_t *p_exception );
205 * Waits until an interface causes the instance to exit.
206 * You should start at least one interface first, using libvlc_add_intf().
208 * \param p_instance the instance
211 void libvlc_wait( libvlc_instance_t *p_instance );
214 * Retrieve libvlc version.
216 * Example: "0.9.0-git Grishenko"
218 * \return a string containing the libvlc version
220 VLC_PUBLIC_API const char * libvlc_get_version(void);
223 * Retrieve libvlc compiler version.
225 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
227 * \return a string containing the libvlc compiler version
229 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
232 * Retrieve libvlc changeset.
234 * Example: "aa9bce0bc4"
236 * \return a string containing the libvlc changeset
238 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
243 * Get the internal main VLC object.
244 * Use of this function is usually a hack and should be avoided.
246 * You will need to link with libvlccore to make any use of the underlying VLC
247 * object. The libvlccore programming and binary interfaces are not stable.
249 * Remember to release the object with vlc_object_release().
251 * \param p_instance the libvlc instance
252 * @return a VLC object of type "libvlc"
254 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
257 * Frees an heap allocation (char *) returned by a LibVLC API.
258 * If you know you're using the same underlying C run-time as the LibVLC
259 * implementation, then you can call ANSI C free() directly instead.
261 VLC_PUBLIC_API void libvlc_free( void *ptr );
265 /*****************************************************************************
267 *****************************************************************************/
269 /** \defgroup libvlc_event libvlc_event
270 * \ingroup libvlc_core
276 * Event manager that belongs to a libvlc object, and from whom events can
280 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
281 typedef struct libvlc_event_t libvlc_event_t;
282 typedef uint32_t libvlc_event_type_t;
285 * Callback function notification
286 * \param p_event the event triggering the callback
289 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
292 * Register for an event notification.
294 * \param p_event_manager the event manager to which you want to attach to.
295 * Generally it is obtained by vlc_my_object_event_manager() where
296 * my_object is the object you want to listen to.
297 * \param i_event_type the desired event to which we want to listen
298 * \param f_callback the function to call when i_event_type occurs
299 * \param user_data user provided data to carry with the event
300 * \param p_e an initialized exception pointer
302 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
303 libvlc_event_type_t i_event_type,
304 libvlc_callback_t f_callback,
306 libvlc_exception_t *p_e );
309 * Unregister an event notification.
311 * \param p_event_manager the event manager
312 * \param i_event_type the desired event to which we want to unregister
313 * \param f_callback the function to call when i_event_type occurs
314 * \param p_user_data user provided data to carry with the event
315 * \param p_e an initialized exception pointer
317 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
318 libvlc_event_type_t i_event_type,
319 libvlc_callback_t f_callback,
321 libvlc_exception_t *p_e );
324 * Get an event's type name.
326 * \param i_event_type the desired event
328 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
332 /*****************************************************************************
333 * Message log handling
334 *****************************************************************************/
336 /** \defgroup libvlc_log libvlc_log
337 * \ingroup libvlc_core
338 * LibVLC Message Logging
343 * Return the VLC messaging verbosity level.
345 * \param p_instance libvlc instance
346 * \return verbosity level for messages
348 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
351 * Set the VLC messaging verbosity level.
353 * \param p_instance libvlc log instance
354 * \param level log level
356 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
359 * Open a VLC message log instance.
361 * \param p_instance libvlc instance
362 * \param p_e an initialized exception pointer
363 * \return log message instance
365 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
368 * Close a VLC message log instance.
370 * \param p_log libvlc log instance or NULL
372 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
375 * Returns the number of messages in a log instance.
377 * \param p_log libvlc log instance or NULL
378 * \return number of log messages, 0 if p_log is NULL
380 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
383 * Clear a log instance.
385 * All messages in the log are removed. The log should be cleared on a
386 * regular basis to avoid clogging.
388 * \param p_log libvlc log instance or NULL
390 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
393 * Allocate and returns a new iterator to messages in log.
395 * \param p_log libvlc log instance
396 * \param p_e an initialized exception pointer
397 * \return log iterator object
399 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
402 * Release a previoulsy allocated iterator.
404 * \param p_iter libvlc log iterator or NULL
406 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
409 * Return whether log iterator has more messages.
411 * \param p_iter libvlc log iterator or NULL
412 * \return true if iterator has more message objects, else false
414 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
417 * Return the next log message.
419 * The message contents must not be freed
421 * \param p_iter libvlc log iterator or NULL
422 * \param p_buffer log buffer
423 * \param p_e an initialized exception pointer
424 * \return log message object
426 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
427 libvlc_log_message_t *p_buffer,
428 libvlc_exception_t *p_e );
436 #endif /* <vlc/libvlc.h> */