git.sesse.net Git - vlc/blob - include/vlc/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 /**
  27  * \file
  28  * This file defines libvlc external API
  29  */
  30
  31 /**
  32  * \defgroup libvlc LibVLC
  33  * LibVLC is the external programming interface of the VLC media player.
  34  * It is used to embed VLC into other applications or frameworks.
  35  * @{
  36  */
  37
  38 #ifndef VLC_LIBVLC_H
  39 #define VLC_LIBVLC_H 1
  40
  41 #if defined (WIN32) && defined (DLL_EXPORT)
  42 # define VLC_PUBLIC_API __declspec(dllexport)
  43 #else
  44 # define VLC_PUBLIC_API
  45 #endif
  46
  47 #ifdef __LIBVLC__
  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))
  53 #else
  54 # define VLC_DEPRECATED_API VLC_PUBLIC_API
  55 #endif
  56
  57 # ifdef __cplusplus
  58 extern "C" {
  59 # endif
  60
  61 #include <stdarg.h>
  62 #include <vlc/libvlc_structures.h>
  63
  64 /** \defgroup libvlc_core LibVLC core
  65  * \ingroup libvlc
  66  * Before it can do anything useful, LibVLC must be initialized.
  67  * You can create one (or more) instance(s) of LibVLC in a given process,
  68  * with libvlc_new() and destroy them with libvlc_release().
  69  *
  70  * \version This documents LibVLC version 1.1.
  71  * Earlier versions (0.9 and 1.0) are <b>not</b> compatible.
  72  * @{
  73  */
  74
  75 /** \defgroup libvlc_error LibVLC error handling
  76  * @{
  77  */
  78
  79 /**
  80  * A human-readable error message for the last LibVLC error in the calling
  81  * thread. The resulting string is valid until another error occurs (at least
  82  * until the next LibVLC call).
  83  *
  84  * @warning
  85  * This will be NULL if there was no error.
  86  */
  87 VLC_PUBLIC_API const char *libvlc_errmsg (void);
  88
  89 /**
  90  * Clears the LibVLC error status for the current thread. This is optional.
  91  * By default, the error status is automatically overriden when a new error
  92  * occurs, and destroyed when the thread exits.
  93  */
  94 VLC_PUBLIC_API void libvlc_clearerr (void);
  95
  96 /**
  97  * Sets the LibVLC error status and message for the current thread.
  98  * Any previous error is overriden.
  99  * \return a nul terminated string in any case
 100  */
 101 const char *libvlc_vprinterr (const char *fmt, va_list ap);
 102
 103 /**
 104  * Sets the LibVLC error status and message for the current thread.
 105  * Any previous error is overriden.
 106  * \return a nul terminated string in any case
 107  */
 108 const char *libvlc_printerr (const char *fmt, ...);
 109
 110 /**@} */
 111
 112 /**
 113  * Create and initialize a libvlc instance.
 114  *
 115  * \param argc the number of arguments
 116  * \param argv command-line-type arguments
 117  * \return the libvlc instance or NULL in case of error
 118  */
 119 VLC_PUBLIC_API libvlc_instance_t *
 120 libvlc_new( int argc , const char *const *argv );
 121
 122 /**
 123  * Decrement the reference count of a libvlc instance, and destroy it
 124  * if it reaches zero.
 125  *
 126  * \param p_instance the instance to destroy
 127  */
 128 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
 129
 130 /**
 131  * Increments the reference count of a libvlc instance.
 132  * The initial reference count is 1 after libvlc_new() returns.
 133  *
 134  * \param p_instance the instance to reference
 135  */
 136 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
 137
 138 /**
 139  * Try to start a user interface for the libvlc instance.
 140  *
 141  * \param p_instance the instance
 142  * \param name interface name, or NULL for default
 143  * \return 0 on success, -1 on error.
 144  */
 145 VLC_PUBLIC_API
 146 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
 147
 148 /**
 149  * Registers a callback for the LibVLC exit event. This is mostly useful if
 150  * you have started at least one interface with libvlc_add_intf().
 151  * Typically, this function will wake up your application main loop (from
 152  * another thread).
 153  *
 154  * \param p_instance LibVLC instance
 155  * \param cb callback to invoke when LibVLC wants to exit
 156  * \param opaque data pointer for the callback
 157  * \warning This function and libvlc_wait() cannot be used at the same time.
 158  * Use either or none of them but not both.
 159  */
 160 VLC_PUBLIC_API
 161 void libvlc_set_exit_handler( libvlc_instance_t *p_instance,
 162                               void (*cb) (void *), void *opaque );
 163
 164 /**
 165  * Waits until an interface causes the instance to exit.
 166  * You should start at least one interface first, using libvlc_add_intf().
 167  *
 168  * \param p_instance the instance
 169  */
 170 VLC_PUBLIC_API
 171 void libvlc_wait( libvlc_instance_t *p_instance );
 172
 173 /**
 174  * Retrieve libvlc version.
 175  *
 176  * Example: "1.1.0-git The Luggage"
 177  *
 178  * \return a string containing the libvlc version
 179  */
 180 VLC_PUBLIC_API const char * libvlc_get_version(void);
 181
 182 /**
 183  * Retrieve libvlc compiler version.
 184  *
 185  * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
 186  *
 187  * \return a string containing the libvlc compiler version
 188  */
 189 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
 190
 191 /**
 192  * Retrieve libvlc changeset.
 193  *
 194  * Example: "aa9bce0bc4"
 195  *
 196  * \return a string containing the libvlc changeset
 197  */
 198 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 199
 200
 201 /** \defgroup libvlc_event LibVLC asynchronous events
 202  * LibVLC emits asynchronous events.
 203  *
 204  * Several LibVLC objects (such @ref libvlc_instance_t as
 205  * @ref libvlc_media_player_t) generate events asynchronously. Each of them
 206  * provides @ref libvlc_event_manager_t event manager. You can subscribe to
 207  * events with libvlc_event_attach() and unsubscribe with
 208  * libvlc_event_detach().
 209  * @{
 210  */
 211
 212 /**
 213  * Event manager that belongs to a libvlc object, and from whom events can
 214  * be received.
 215  */
 216 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
 217
 218 struct libvlc_event_t;
 219
 220 /**
 221  * Type of a LibVLC event.
 222  */
 223 typedef int libvlc_event_type_t;
 224
 225 /**
 226  * Callback function notification
 227  * \param p_event the event triggering the callback
 228  */
 229 typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * );
 230
 231 /**
 232  * Register for an event notification.
 233  *
 234  * \param p_event_manager the event manager to which you want to attach to.
 235  *        Generally it is obtained by vlc_my_object_event_manager() where
 236  *        my_object is the object you want to listen to.
 237  * \param i_event_type the desired event to which we want to listen
 238  * \param f_callback the function to call when i_event_type occurs
 239  * \param user_data user provided data to carry with the event
 240  * \return 0 on success, ENOMEM on error
 241  */
 242 VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
 243                                         libvlc_event_type_t i_event_type,
 244                                         libvlc_callback_t f_callback,
 245                                         void *user_data );
 246
 247 /**
 248  * Unregister an event notification.
 249  *
 250  * \param p_event_manager the event manager
 251  * \param i_event_type the desired event to which we want to unregister
 252  * \param f_callback the function to call when i_event_type occurs
 253  * \param p_user_data user provided data to carry with the event
 254  */
 255 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 256                                          libvlc_event_type_t i_event_type,
 257                                          libvlc_callback_t f_callback,
 258                                          void *p_user_data );
 259
 260 /**
 261  * Get an event's type name.
 262  *
 263  * \param event_type the desired event
 264  */
 265 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
 266
 267 /** @} */
 268
 269 /** \defgroup libvlc_log LibVLC logging
 270  * libvlc_log_* functions provide access to the LibVLC messages log.
 271  * This is used for debugging or by advanced users.
 272  * @{
 273  */
 274
 275 /**
 276  * Return the VLC messaging verbosity level.
 277  *
 278  * \param p_instance libvlc instance
 279  * \return verbosity level for messages
 280  */
 281 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
 282
 283 /**
 284  * Set the VLC messaging verbosity level.
 285  *
 286  * \param p_instance libvlc log instance
 287  * \param level log level
 288  */
 289 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
 290
 291 /**
 292  * Open a VLC message log instance.
 293  *
 294  * \param p_instance libvlc instance
 295  * \return log message instance or NULL on error
 296  */
 297 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
 298
 299 /**
 300  * Close a VLC message log instance.
 301  *
 302  * \param p_log libvlc log instance or NULL
 303  */
 304 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
 305
 306 /**
 307  * Returns the number of messages in a log instance.
 308  *
 309  * \param p_log libvlc log instance or NULL
 310  * \return number of log messages, 0 if p_log is NULL
 311  */
 312 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
 313
 314 /**
 315  * Clear a log instance.
 316  *
 317  * All messages in the log are removed. The log should be cleared on a
 318  * regular basis to avoid clogging.
 319  *
 320  * \param p_log libvlc log instance or NULL
 321  */
 322 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
 323
 324 /**
 325  * Allocate and returns a new iterator to messages in log.
 326  *
 327  * \param p_log libvlc log instance
 328  * \return log iterator object or NULL on error
 329  */
 330 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
 331
 332 /**
 333  * Release a previoulsy allocated iterator.
 334  *
 335  * \param p_iter libvlc log iterator or NULL
 336  */
 337 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
 338
 339 /**
 340  * Return whether log iterator has more messages.
 341  *
 342  * \param p_iter libvlc log iterator or NULL
 343  * \return true if iterator has more message objects, else false
 344  */
 345 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
 346
 347 /**
 348  * Return the next log message.
 349  *
 350  * The message contents must not be freed
 351  *
 352  * \param p_iter libvlc log iterator or NULL
 353  * \param p_buffer log buffer
 354  * \return log message object or NULL if none left
 355  */
 356 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 357                                                                libvlc_log_message_t *p_buffer );
 358
 359 /** @} */
 360 /** @} */
 361 /** @} */
 362
 363 # ifdef __cplusplus
 364 }
 365 # endif
 366
 367 #endif /* <vlc/libvlc.h> */