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  * This is libvlc, the base library of the VLC program.
  34  *
  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 /*****************************************************************************
  65  * Exception handling
  66  *****************************************************************************/
  67 /** \defgroup libvlc_exception libvlc_exception
  68  * \ingroup libvlc_core
  69  * LibVLC Exceptions handling
  70  * @{
  71  */
  72
  73 /**
  74  * Initialize an exception structure. This can be called several times to
  75  * reuse an exception structure.
  76  *
  77  * \param p_exception the exception to initialize
  78  */
  79 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
  80
  81 /**
  82  * Has an exception been raised?
  83  *
  84  * \param p_exception the exception to query
  85  * \return 0 if the exception was raised, 1 otherwise
  86  */
  87 VLC_PUBLIC_API int
  88 libvlc_exception_raised( const libvlc_exception_t *p_exception );
  89
  90 /**
  91  * Raise an exception.
  92  *
  93  * \param p_exception the exception to raise
  94  */
  95 VLC_PUBLIC_API void
  96 libvlc_exception_raise( libvlc_exception_t *p_exception );
  97
  98 /**
  99  * Clear an exception object so it can be reused.
 100  * The exception object must have be initialized.
 101  *
 102  * \param p_exception the exception to clear
 103  */
 104 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
 105
 106 /**@} */
 107
 108 /*****************************************************************************
 109  * Error handling
 110  *****************************************************************************/
 111 /** \defgroup libvlc_error libvlc_error
 112  * \ingroup libvlc_core
 113  * LibVLC error handling
 114  * @{
 115  */
 116
 117 /**
 118  * A human-readable error message for the last LibVLC error in the calling
 119  * thread. The resulting string is valid until another error occurs (at least
 120  * until the next LibVLC call).
 121  *
 122  * @warning
 123  * This will be NULL if there was no error.
 124  */
 125 VLC_PUBLIC_API const char *libvlc_errmsg (void);
 126
 127 /**
 128  * Clears the LibVLC error status for the current thread. This is optional.
 129  * By default, the error status is automatically overriden when a new error
 130  * occurs, and destroyed when the thread exits.
 131  */
 132 VLC_PUBLIC_API void libvlc_clearerr (void);
 133
 134 /**
 135  * Sets the LibVLC error status and message for the current thread.
 136  * Any previous error is overriden.
 137  * @return a nul terminated string in any case
 138  */
 139 const char *libvlc_vprinterr (const char *fmt, va_list ap);
 140
 141 /**
 142  * Sets the LibVLC error status and message for the current thread.
 143  * Any previous error is overriden.
 144  * @return a nul terminated string in any case
 145  */
 146 const char *libvlc_printerr (const char *fmt, ...);
 147
 148 /**@} */
 149
 150
 151 /*****************************************************************************
 152  * Core handling
 153  *****************************************************************************/
 154
 155 /** \defgroup libvlc_core libvlc_core
 156  * \ingroup libvlc
 157  * LibVLC Core
 158  * @{
 159  */
 160
 161 /**
 162  * Create and initialize a libvlc instance.
 163  *
 164  * \param argc the number of arguments
 165  * \param argv command-line-type arguments. argv[0] must be the path of the
 166  *        calling program.
 167  * \param p_e an initialized exception pointer
 168  * \return the libvlc instance
 169  */
 170 VLC_PUBLIC_API libvlc_instance_t *
 171 libvlc_new( int , const char *const *, libvlc_exception_t *);
 172
 173 /**
 174  * Decrement the reference count of a libvlc instance, and destroy it
 175  * if it reaches zero.
 176  *
 177  * \param p_instance the instance to destroy
 178  */
 179 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
 180
 181 /**
 182  * Increments the reference count of a libvlc instance.
 183  * The initial reference count is 1 after libvlc_new() returns.
 184  *
 185  * \param p_instance the instance to reference
 186  */
 187 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
 188
 189 /**
 190  * Try to start a user interface for the libvlc instance.
 191  *
 192  * \param p_instance the instance
 193  * \param name interface name, or NULL for default
 194  * \param p_exception an initialized exception pointer
 195  * \return 0 on success, -1 on error.
 196  */
 197 VLC_PUBLIC_API
 198 int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
 199                      libvlc_exception_t *p_exception );
 200
 201 /**
 202  * Waits until an interface causes the instance to exit.
 203  * You should start at least one interface first, using libvlc_add_intf().
 204  *
 205  * \param p_instance the instance
 206  */
 207 VLC_PUBLIC_API
 208 void libvlc_wait( libvlc_instance_t *p_instance );
 209
 210 /**
 211  * Retrieve libvlc version.
 212  *
 213  * Example: "0.9.0-git Grishenko"
 214  *
 215  * \return a string containing the libvlc version
 216  */
 217 VLC_PUBLIC_API const char * libvlc_get_version(void);
 218
 219 /**
 220  * Retrieve libvlc compiler version.
 221  *
 222  * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
 223  *
 224  * \return a string containing the libvlc compiler version
 225  */
 226 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
 227
 228 /**
 229  * Retrieve libvlc changeset.
 230  *
 231  * Example: "aa9bce0bc4"
 232  *
 233  * \return a string containing the libvlc changeset
 234  */
 235 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 236
 237 struct vlc_object_t;
 238
 239 /**
 240  * Get the internal main VLC object.
 241  * Use of this function is usually a hack and should be avoided.
 242  * @note
 243  * You will need to link with libvlccore to make any use of the underlying VLC
 244  * object. The libvlccore programming and binary interfaces are not stable.
 245  * @warning
 246  * Remember to release the object with vlc_object_release().
 247  *
 248  * \param p_instance the libvlc instance
 249  * @return a VLC object of type "libvlc"
 250  */
 251 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
 252
 253 /**
 254  * Frees an heap allocation (char *) returned by a LibVLC API.
 255  * If you know you're using the same underlying C run-time as the LibVLC
 256  * implementation, then you can call ANSI C free() directly instead.
 257  *
 258  * \param ptr the pointer
 259  */
 260 VLC_PUBLIC_API void libvlc_free( void *ptr );
 261
 262 /** @}*/
 263
 264 /*****************************************************************************
 265  * Event handling
 266  *****************************************************************************/
 267
 268 /** \defgroup libvlc_event libvlc_event
 269  * \ingroup libvlc_core
 270  * LibVLC Events
 271  * @{
 272  */
 273
 274 /**
 275  * Event manager that belongs to a libvlc object, and from whom events can
 276  * be received.
 277  */
 278
 279 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
 280 typedef struct libvlc_event_t libvlc_event_t;
 281 typedef uint32_t libvlc_event_type_t;
 282
 283 /**
 284  * Callback function notification
 285  * \param p_event the event triggering the callback
 286  */
 287
 288 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
 289
 290 /**
 291  * Register for an event notification.
 292  *
 293  * \param p_event_manager the event manager to which you want to attach to.
 294  *        Generally it is obtained by vlc_my_object_event_manager() where
 295  *        my_object is the object you want to listen to.
 296  * \param i_event_type the desired event to which we want to listen
 297  * \param f_callback the function to call when i_event_type occurs
 298  * \param user_data user provided data to carry with the event
 299  * \param p_e an initialized exception pointer
 300  */
 301 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
 302                                          libvlc_event_type_t i_event_type,
 303                                          libvlc_callback_t f_callback,
 304                                          void *user_data,
 305                                          libvlc_exception_t *p_e );
 306
 307 /**
 308  * Unregister an event notification.
 309  *
 310  * \param p_event_manager the event manager
 311  * \param i_event_type the desired event to which we want to unregister
 312  * \param f_callback the function to call when i_event_type occurs
 313  * \param p_user_data user provided data to carry with the event
 314  * \param p_e an initialized exception pointer
 315  */
 316 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 317                                          libvlc_event_type_t i_event_type,
 318                                          libvlc_callback_t f_callback,
 319                                          void *p_user_data,
 320                                          libvlc_exception_t *p_e );
 321
 322 /**
 323  * Get an event's type name.
 324  *
 325  * \param i_event_type the desired event
 326  */
 327 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
 328
 329 /** @} */
 330
 331 /*****************************************************************************
 332  * Message log handling
 333  *****************************************************************************/
 334
 335 /** \defgroup libvlc_log libvlc_log
 336  * \ingroup libvlc_core
 337  * LibVLC Message Logging
 338  * @{
 339  */
 340
 341 /**
 342  * Return the VLC messaging verbosity level.
 343  *
 344  * \param p_instance libvlc instance
 345  * \return verbosity level for messages
 346  */
 347 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
 348
 349 /**
 350  * Set the VLC messaging verbosity level.
 351  *
 352  * \param p_instance libvlc log instance
 353  * \param level log level
 354  */
 355 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
 356
 357 /**
 358  * Open a VLC message log instance.
 359  *
 360  * \param p_instance libvlc instance
 361  * \param p_e an initialized exception pointer
 362  * \return log message instance
 363  */
 364 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
 365
 366 /**
 367  * Close a VLC message log instance.
 368  *
 369  * \param p_log libvlc log instance or NULL
 370  */
 371 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
 372
 373 /**
 374  * Returns the number of messages in a log instance.
 375  *
 376  * \param p_log libvlc log instance or NULL
 377  * \return number of log messages, 0 if p_log is NULL
 378  */
 379 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
 380
 381 /**
 382  * Clear a log instance.
 383  *
 384  * All messages in the log are removed. The log should be cleared on a
 385  * regular basis to avoid clogging.
 386  *
 387  * \param p_log libvlc log instance or NULL
 388  */
 389 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
 390
 391 /**
 392  * Allocate and returns a new iterator to messages in log.
 393  *
 394  * \param p_log libvlc log instance
 395  * \param p_e an initialized exception pointer
 396  * \return log iterator object
 397  */
 398 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
 399
 400 /**
 401  * Release a previoulsy allocated iterator.
 402  *
 403  * \param p_iter libvlc log iterator or NULL
 404  */
 405 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
 406
 407 /**
 408  * Return whether log iterator has more messages.
 409  *
 410  * \param p_iter libvlc log iterator or NULL
 411  * \return true if iterator has more message objects, else false
 412  */
 413 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
 414
 415 /**
 416  * Return the next log message.
 417  *
 418  * The message contents must not be freed
 419  *
 420  * \param p_iter libvlc log iterator or NULL
 421  * \param p_buffer log buffer
 422  * \param p_e an initialized exception pointer
 423  * \return log message object
 424  */
 425 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 426                                                                libvlc_log_message_t *p_buffer,
 427                                                                libvlc_exception_t *p_e );
 428
 429 /** @} */
 430
 431 # ifdef __cplusplus
 432 }
 433 # endif
 434
 435 #endif /* <vlc/libvlc.h> */
 436
 437 /** @} */