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  * Waits until an interface causes the instance to exit.
 150  * You should start at least one interface first, using libvlc_add_intf().
 151  *
 152  * \param p_instance the instance
 153  */
 154 VLC_PUBLIC_API
 155 void libvlc_wait( libvlc_instance_t *p_instance );
 156
 157 /**
 158  * Retrieve libvlc version.
 159  *
 160  * Example: "1.1.0-git The Luggage"
 161  *
 162  * \return a string containing the libvlc version
 163  */
 164 VLC_PUBLIC_API const char * libvlc_get_version(void);
 165
 166 /**
 167  * Retrieve libvlc compiler version.
 168  *
 169  * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
 170  *
 171  * \return a string containing the libvlc compiler version
 172  */
 173 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
 174
 175 /**
 176  * Retrieve libvlc changeset.
 177  *
 178  * Example: "aa9bce0bc4"
 179  *
 180  * \return a string containing the libvlc changeset
 181  */
 182 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 183
 184
 185 /** \defgroup libvlc_event LibVLC asynchronous events
 186  * LibVLC emits asynchronous events.
 187  *
 188  * Several LibVLC objects (such @ref libvlc_instance_t as
 189  * @ref libvlc_media_player_t) generate events asynchronously. Each of them
 190  * provides @ref libvlc_event_manager_t event manager. You can subscribe to
 191  * events with libvlc_event_attach() and unsubscribe with
 192  * libvlc_event_detach().
 193  * @{
 194  */
 195
 196 /**
 197  * Event manager that belongs to a libvlc object, and from whom events can
 198  * be received.
 199  */
 200 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
 201
 202 struct libvlc_event_t;
 203
 204 /**
 205  * Type of a LibVLC event.
 206  */
 207 typedef int libvlc_event_type_t;
 208
 209 /**
 210  * Callback function notification
 211  * \param p_event the event triggering the callback
 212  */
 213 typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * );
 214
 215 /**
 216  * Register for an event notification.
 217  *
 218  * \param p_event_manager the event manager to which you want to attach to.
 219  *        Generally it is obtained by vlc_my_object_event_manager() where
 220  *        my_object is the object you want to listen to.
 221  * \param i_event_type the desired event to which we want to listen
 222  * \param f_callback the function to call when i_event_type occurs
 223  * \param user_data user provided data to carry with the event
 224  * \return 0 on success, ENOMEM on error
 225  */
 226 VLC_PUBLIC_API int libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
 227                                         libvlc_event_type_t i_event_type,
 228                                         libvlc_callback_t f_callback,
 229                                         void *user_data );
 230
 231 /**
 232  * Unregister an event notification.
 233  *
 234  * \param p_event_manager the event manager
 235  * \param i_event_type the desired event to which we want to unregister
 236  * \param f_callback the function to call when i_event_type occurs
 237  * \param p_user_data user provided data to carry with the event
 238  */
 239 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 240                                          libvlc_event_type_t i_event_type,
 241                                          libvlc_callback_t f_callback,
 242                                          void *p_user_data );
 243
 244 /**
 245  * Get an event's type name.
 246  *
 247  * \param event_type the desired event
 248  */
 249 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
 250
 251 /** @} */
 252
 253 /** \defgroup libvlc_log LibVLC logging
 254  * libvlc_log_* functions provide access to the LibVLC messages log.
 255  * This is used for debugging or by advanced users.
 256  * @{
 257  */
 258
 259 /**
 260  * Return the VLC messaging verbosity level.
 261  *
 262  * \param p_instance libvlc instance
 263  * \return verbosity level for messages
 264  */
 265 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
 266
 267 /**
 268  * Set the VLC messaging verbosity level.
 269  *
 270  * \param p_instance libvlc log instance
 271  * \param level log level
 272  */
 273 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
 274
 275 /**
 276  * Open a VLC message log instance.
 277  *
 278  * \param p_instance libvlc instance
 279  * \return log message instance or NULL on error
 280  */
 281 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
 282
 283 /**
 284  * Close a VLC message log instance.
 285  *
 286  * \param p_log libvlc log instance or NULL
 287  */
 288 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
 289
 290 /**
 291  * Returns the number of messages in a log instance.
 292  *
 293  * \param p_log libvlc log instance or NULL
 294  * \return number of log messages, 0 if p_log is NULL
 295  */
 296 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
 297
 298 /**
 299  * Clear a log instance.
 300  *
 301  * All messages in the log are removed. The log should be cleared on a
 302  * regular basis to avoid clogging.
 303  *
 304  * \param p_log libvlc log instance or NULL
 305  */
 306 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
 307
 308 /**
 309  * Allocate and returns a new iterator to messages in log.
 310  *
 311  * \param p_log libvlc log instance
 312  * \return log iterator object or NULL on error
 313  */
 314 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
 315
 316 /**
 317  * Release a previoulsy allocated iterator.
 318  *
 319  * \param p_iter libvlc log iterator or NULL
 320  */
 321 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
 322
 323 /**
 324  * Return whether log iterator has more messages.
 325  *
 326  * \param p_iter libvlc log iterator or NULL
 327  * \return true if iterator has more message objects, else false
 328  */
 329 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
 330
 331 /**
 332  * Return the next log message.
 333  *
 334  * The message contents must not be freed
 335  *
 336  * \param p_iter libvlc log iterator or NULL
 337  * \param p_buffer log buffer
 338  * \return log message object or NULL if none left
 339  */
 340 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 341                                                                libvlc_log_message_t *p_buffer );
 342
 343 /** @} */
 344 /** @} */
 345 /** @} */
 346
 347 # ifdef __cplusplus
 348 }
 349 # endif
 350
 351 #endif /* <vlc/libvlc.h> */