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_error libvlc_error
68 * \ingroup libvlc_core
69 * LibVLC error handling
74 * A human-readable error message for the last LibVLC error in the calling
75 * thread. The resulting string is valid until another error occurs (at least
76 * until the next LibVLC call).
79 * This will be NULL if there was no error.
81 VLC_PUBLIC_API const char *libvlc_errmsg (void);
84 * Clears the LibVLC error status for the current thread. This is optional.
85 * By default, the error status is automatically overriden when a new error
86 * occurs, and destroyed when the thread exits.
88 VLC_PUBLIC_API void libvlc_clearerr (void);
91 * Sets the LibVLC error status and message for the current thread.
92 * Any previous error is overriden.
93 * @return a nul terminated string in any case
95 const char *libvlc_vprinterr (const char *fmt, va_list ap);
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_printerr (const char *fmt, ...);
107 /*****************************************************************************
109 *****************************************************************************/
111 /** \defgroup libvlc_core libvlc_core
118 * Create and initialize a libvlc instance.
120 * \param argc the number of arguments
121 * \param argv command-line-type arguments
122 * \return the libvlc instance or NULL in case of error
124 VLC_PUBLIC_API libvlc_instance_t *
125 libvlc_new( int argc , const char *const *argv );
128 * Decrement the reference count of a libvlc instance, and destroy it
129 * if it reaches zero.
131 * \param p_instance the instance to destroy
133 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
136 * Increments the reference count of a libvlc instance.
137 * The initial reference count is 1 after libvlc_new() returns.
139 * \param p_instance the instance to reference
141 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
144 * Try to start a user interface for the libvlc instance.
146 * \param p_instance the instance
147 * \param name interface name, or NULL for default
148 * \return 0 on success, -1 on error.
151 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
154 * Waits until an interface causes the instance to exit.
155 * You should start at least one interface first, using libvlc_add_intf().
157 * \param p_instance the instance
160 void libvlc_wait( libvlc_instance_t *p_instance );
163 * Retrieve libvlc version.
165 * Example: "0.9.0-git Grishenko"
167 * \return a string containing the libvlc version
169 VLC_PUBLIC_API const char * libvlc_get_version(void);
172 * Retrieve libvlc compiler version.
174 * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
176 * \return a string containing the libvlc compiler version
178 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
181 * Retrieve libvlc changeset.
183 * Example: "aa9bce0bc4"
185 * \return a string containing the libvlc changeset
187 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
193 /*****************************************************************************
195 *****************************************************************************/
197 /** \defgroup libvlc_event libvlc_event
198 * \ingroup libvlc_core
204 * Event manager that belongs to a libvlc object, and from whom events can
208 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
209 typedef struct libvlc_event_t libvlc_event_t;
210 typedef uint32_t libvlc_event_type_t;
213 * Callback function notification
214 * \param p_event the event triggering the callback
217 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
220 * Register for an event notification.
222 * \param p_event_manager the event manager to which you want to attach to.
223 * Generally it is obtained by vlc_my_object_event_manager() where
224 * my_object is the object you want to listen to.
225 * \param i_event_type the desired event to which we want to listen
226 * \param f_callback the function to call when i_event_type occurs
227 * \param user_data user provided data to carry with the event
228 * \return 0 on success, ENOMEM on error
230 VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
231 libvlc_event_type_t i_event_type,
232 libvlc_callback_t f_callback,
236 * Unregister an event notification.
238 * \param p_event_manager the event manager
239 * \param i_event_type the desired event to which we want to unregister
240 * \param f_callback the function to call when i_event_type occurs
241 * \param p_user_data user provided data to carry with the event
243 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
244 libvlc_event_type_t i_event_type,
245 libvlc_callback_t f_callback,
249 * Get an event's type name.
251 * \param event_type the desired event
253 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
257 /*****************************************************************************
258 * Message log handling
259 *****************************************************************************/
261 /** \defgroup libvlc_log libvlc_log
262 * \ingroup libvlc_core
263 * LibVLC Message Logging
268 * Return the VLC messaging verbosity level.
270 * \param p_instance libvlc instance
271 * \return verbosity level for messages
273 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
276 * Set the VLC messaging verbosity level.
278 * \param p_instance libvlc log instance
279 * \param level log level
281 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
284 * Open a VLC message log instance.
286 * \param p_instance libvlc instance
287 * \return log message instance or NULL on error
289 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
292 * Close a VLC message log instance.
294 * \param p_log libvlc log instance or NULL
296 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
299 * Returns the number of messages in a log instance.
301 * \param p_log libvlc log instance or NULL
302 * \return number of log messages, 0 if p_log is NULL
304 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
307 * Clear a log instance.
309 * All messages in the log are removed. The log should be cleared on a
310 * regular basis to avoid clogging.
312 * \param p_log libvlc log instance or NULL
314 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
317 * Allocate and returns a new iterator to messages in log.
319 * \param p_log libvlc log instance
320 * \return log iterator object or NULL on error
322 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
325 * Release a previoulsy allocated iterator.
327 * \param p_iter libvlc log iterator or NULL
329 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
332 * Return whether log iterator has more messages.
334 * \param p_iter libvlc log iterator or NULL
335 * \return true if iterator has more message objects, else false
337 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
340 * Return the next log message.
342 * The message contents must not be freed
344 * \param p_iter libvlc log iterator or NULL
345 * \param p_buffer log buffer
346 * \return log message object or NULL if none left
348 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
349 libvlc_log_message_t *p_buffer );
357 #endif /* <vlc/libvlc.h> */