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
61 #include <vlc/libvlc_structures.h>
63 /*****************************************************************************
65 *****************************************************************************/
66 /** \defgroup libvlc_exception libvlc_exception
67 * \ingroup libvlc_core
68 * LibVLC Exceptions handling
73 * Initialize an exception structure. This can be called several times to
74 * reuse an exception structure.
76 * \param p_exception the exception to initialize
78 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
81 * Has an exception been raised?
83 * \param p_exception the exception to query
84 * \return 0 if the exception was raised, 1 otherwise
87 libvlc_exception_raised( const libvlc_exception_t *p_exception );
90 * Raise an exception using a user-provided message.
92 * \param p_exception the exception to raise
93 * \param psz_format the exception message format string
94 * \param ... the format string arguments
97 libvlc_exception_raise( libvlc_exception_t *p_exception,
98 const char *psz_format, ... );
101 * Clear an exception object so it can be reused.
102 * The exception object must have be initialized.
104 * \param p_exception the exception to clear
106 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
109 * Get an exception's message.
111 * \param p_exception the exception to query
112 * \return the exception message or NULL if not applicable (exception not
113 * raised, for example)
115 VLC_PUBLIC_API const char *
116 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
120 /*****************************************************************************
122 *****************************************************************************/
124 /** \defgroup libvlc_core libvlc_core
131 * Create and initialize a libvlc instance.
133 * \param argc the number of arguments
134 * \param argv command-line-type arguments. argv[0] must be the path of the
136 * \param p_e an initialized exception pointer
137 * \return the libvlc instance
139 VLC_PUBLIC_API libvlc_instance_t *
140 libvlc_new( int , const char *const *, libvlc_exception_t *);
143 * Decrement the reference count of a libvlc instance, and destroy it
144 * if it reaches zero.
146 * \param p_instance the instance to destroy
148 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
151 * Increments the reference count of a libvlc instance.
152 * The initial reference count is 1 after libvlc_new() returns.
154 * \param p_instance the instance to reference
156 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
159 * Try to start a user interface for the libvlc instance.
161 * \param p_instance the instance
162 * \param name interface name, or NULL for default
163 * \param p_exception an initialized exception pointer
164 * \return 0 on success, -1 on error.
167 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
168 libvlc_exception_t *p_exception );
171 * Waits until an interface causes the instance to exit.
172 * You should start at least one interface first, using libvlc_add_intf().
174 * \param p_instance the instance
177 void libvlc_wait( libvlc_instance_t *p_instance );
180 * Retrieve libvlc version.
182 * Example: "0.9.0-git Grishenko"
184 * \return a string containing the libvlc version
186 VLC_PUBLIC_API const char * libvlc_get_version(void);
189 * Retrieve libvlc compiler version.
191 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
193 * \return a string containing the libvlc compiler version
195 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
198 * Retrieve libvlc changeset.
200 * Example: "aa9bce0bc4"
202 * \return a string containing the libvlc changeset
204 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
209 * Get the internal main VLC object.
210 * Use of this function is usually a hack and should be avoided.
212 * You will need to link with libvlccore to make any use of the underlying VLC
213 * object. The libvlccore programming and binary interfaces are not stable.
215 * Remember to release the object with vlc_object_release().
217 * \param p_instance the libvlc instance
218 * @return a VLC object of type "libvlc"
220 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
223 * Frees an heap allocation (char *) returned by a LibVLC API.
224 * If you know you're using the same underlying C run-time as the LibVLC
225 * implementation, then you can call ANSI C free() directly instead.
227 VLC_PUBLIC_API void libvlc_free( void *ptr );
231 /*****************************************************************************
233 *****************************************************************************/
235 /** \defgroup libvlc_event libvlc_event
236 * \ingroup libvlc_core
242 * Event manager that belongs to a libvlc object, and from whom events can
246 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
247 typedef struct libvlc_event_t libvlc_event_t;
248 typedef uint32_t libvlc_event_type_t;
251 * Callback function notification
252 * \param p_event the event triggering the callback
255 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
258 * Register for an event notification.
260 * \param p_event_manager the event manager to which you want to attach to.
261 * Generally it is obtained by vlc_my_object_event_manager() where
262 * my_object is the object you want to listen to.
263 * \param i_event_type the desired event to which we want to listen
264 * \param f_callback the function to call when i_event_type occurs
265 * \param user_data user provided data to carry with the event
266 * \param p_e an initialized exception pointer
268 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
269 libvlc_event_type_t i_event_type,
270 libvlc_callback_t f_callback,
272 libvlc_exception_t *p_e );
275 * Unregister an event notification.
277 * \param p_event_manager the event manager
278 * \param i_event_type the desired event to which we want to unregister
279 * \param f_callback the function to call when i_event_type occurs
280 * \param p_user_data user provided data to carry with the event
281 * \param p_e an initialized exception pointer
283 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
284 libvlc_event_type_t i_event_type,
285 libvlc_callback_t f_callback,
287 libvlc_exception_t *p_e );
290 * Get an event's type name.
292 * \param i_event_type the desired event
294 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
298 /*****************************************************************************
299 * Message log handling
300 *****************************************************************************/
302 /** \defgroup libvlc_log libvlc_log
303 * \ingroup libvlc_core
304 * LibVLC Message Logging
309 * Return the VLC messaging verbosity level.
311 * \param p_instance libvlc instance
312 * \param p_e an initialized exception pointer
313 * \return verbosity level for messages
315 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
316 libvlc_exception_t *p_e );
319 * Set the VLC messaging verbosity level.
321 * \param p_instance libvlc log instance
322 * \param level log level
323 * \param p_e an initialized exception pointer
325 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
326 libvlc_exception_t *p_e );
329 * Open a VLC message log instance.
331 * \param p_instance libvlc instance
332 * \param p_e an initialized exception pointer
333 * \return log message instance
335 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
338 * Close a VLC message log instance.
340 * \param p_log libvlc log instance
341 * \param p_e an initialized exception pointer
343 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
346 * Returns the number of messages in a log instance.
348 * \param p_log libvlc log instance
349 * \param p_e an initialized exception pointer
350 * \return number of log messages
352 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
355 * Clear a log instance.
357 * All messages in the log are removed. The log should be cleared on a
358 * regular basis to avoid clogging.
360 * \param p_log libvlc log instance
361 * \param p_e an initialized exception pointer
363 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
366 * Allocate and returns a new iterator to messages in log.
368 * \param p_log libvlc log instance
369 * \param p_e an initialized exception pointer
370 * \return log iterator object
372 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
375 * Release a previoulsy allocated iterator.
377 * \param p_iter libvlc log iterator
378 * \param p_e an initialized exception pointer
380 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
383 * Return whether log iterator has more messages.
385 * \param p_iter libvlc log iterator
386 * \param p_e an initialized exception pointer
387 * \return true if iterator has more message objects, else false
389 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
392 * Return the next log message.
394 * The message contents must not be freed
396 * \param p_iter libvlc log iterator
397 * \param p_buffer log buffer
398 * \param p_e an initialized exception pointer
399 * \return log message object
401 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
402 libvlc_log_message_t *p_buffer,
403 libvlc_exception_t *p_e );
411 #endif /* <vlc/libvlc.h> */