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

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc_* new external API structures
   3  *****************************************************************************
   4  * Copyright (C) 1998-2007 the VideoLAN team
   5  * $Id $
   6  *
   7  * Authors: Filippo Carone <littlejohn@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _LIBVLC_STRUCTURES_H
  25 #define _LIBVLC_STRUCTURES_H 1
  26
  27 #include <vlc/vlc.h>
  28
  29 # ifdef __cplusplus
  30 extern "C" {
  31 # endif
  32
  33 /** This structure is opaque. It represents a libvlc instance */
  34 typedef struct libvlc_instance_t libvlc_instance_t;
  35
  36 /*****************************************************************************
  37  * Exceptions
  38  *****************************************************************************/
  39
  40 /** defgroup libvlc_exception Exceptions
  41  * \ingroup libvlc
  42  * LibVLC Exceptions handling
  43  * @{
  44  */
  45
  46 typedef struct libvlc_exception_t
  47 {
  48     int b_raised;
  49     int i_code;
  50     char *psz_message;
  51 } libvlc_exception_t;
  52
  53 /**@} */
  54
  55 /*****************************************************************************
  56  * Tag
  57  *****************************************************************************/
  58 /** defgroup libvlc_tag Tag
  59  * \ingroup libvlc
  60  * LibVLC Tag  support in media descriptor
  61  * @{
  62  */
  63
  64 typedef struct libvlc_tag_query_t libvlc_tag_query_t;
  65 typedef char * libvlc_tag_t;
  66
  67 /**@} */
  68
  69 /*****************************************************************************
  70  * Media Descriptor
  71  *****************************************************************************/
  72 /** defgroup libvlc_media_descriptor MediaDescriptor
  73  * \ingroup libvlc
  74  * LibVLC Media Descriptor handling
  75  * @{
  76  */
  77
  78 /* Meta Handling */
  79 /** defgroup libvlc_meta Meta
  80  * \ingroup libvlc_media_descriptor
  81  * LibVLC Media Meta
  82  * @{
  83  */
  84
  85 typedef enum libvlc_meta_t {
  86     libvlc_meta_Title,
  87     libvlc_meta_Artist,
  88     libvlc_meta_Genre,
  89     libvlc_meta_Copyright,
  90     libvlc_meta_Album,
  91     libvlc_meta_TrackNumber,
  92     libvlc_meta_Description,
  93     libvlc_meta_Rating,
  94     libvlc_meta_Date,
  95     libvlc_meta_Setting,
  96     libvlc_meta_URL,
  97     libvlc_meta_Language,
  98     libvlc_meta_NowPlaying,
  99     libvlc_meta_Publisher,
 100     libvlc_meta_EncodedBy,
 101     libvlc_meta_ArtworkURL,
 102     libvlc_meta_TrackID
 103 } libvlc_meta_t;
 104
 105 /**@} */
 106
 107 typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
 108
 109 /**@} */
 110
 111
 112 /*****************************************************************************
 113  * Media Instance
 114  *****************************************************************************/
 115 /** defgroup libvlc_media_instance MediaInstance
 116  * \ingroup libvlc
 117  * LibVLC Media Instance handling
 118  * @{
 119  */
 120
 121 typedef struct libvlc_media_instance_t libvlc_media_instance_t;
 122
 123 /**@} */
 124
 125 /*****************************************************************************
 126  * Media List
 127  *****************************************************************************/
 128 /** defgroup libvlc_media_list MediaList
 129  * \ingroup libvlc
 130  * LibVLC Media List handling
 131  * @{
 132  */
 133
 134 typedef struct libvlc_media_list_t libvlc_media_list_t;
 135
 136 /**@} */
 137
 138 /*****************************************************************************
 139  * Dynamic Media List
 140  *****************************************************************************/
 141 /** defgroup libvlc_media_list MediaList
 142  * \ingroup libvlc
 143  * LibVLC Dynamic Media list: Media list with content synchronized with
 144  * an other playlist
 145  * @{
 146  */
 147
 148 typedef struct libvlc_dynamic_media_list_t libvlc_dynamic_media_list_t;
 149
 150 /**@} */
 151
 152 /*****************************************************************************
 153  * Media List Player
 154  *****************************************************************************/
 155 /** defgroup libvlc_media_list_player MediaListPlayer
 156  * \ingroup libvlc
 157  * LibVLC Media List Player handling
 158  * @{
 159  */
 160
 161 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
 162
 163 /**@} */
 164
 165 /*****************************************************************************
 166  * Media Library
 167  *****************************************************************************/
 168 /** defgroup libvlc_media_library Media Library
 169  * \ingroup libvlc
 170  * LibVLC Media Library
 171  * @{
 172  */
 173
 174 typedef struct libvlc_media_library_t libvlc_media_library_t;
 175
 176 /**@} */
 177
 178 /*****************************************************************************
 179  * Playlist
 180  *****************************************************************************/
 181 /** defgroup libvlc_playlist Playlist
 182  * \ingroup libvlc
 183  * LibVLC Playlist handling
 184  * @{
 185  */
 186
 187 typedef struct libvlc_playlist_item_t
 188 {
 189     int i_id;
 190     char * psz_uri;
 191     char * psz_name;
 192
 193 } libvlc_playlist_item_t;
 194
 195 /**@} */
 196
 197
 198 /*****************************************************************************
 199  * Video
 200  *****************************************************************************/
 201 /** defgroup libvlc_video Video
 202  * \ingroup libvlc
 203  * LibVLC Video handling
 204  * @{
 205  */
 206
 207 /**
 208 * Downcast to this general type as placeholder for a platform specific one, such as:
 209 *  Drawable on X11,
 210 *  CGrafPort on MacOSX,
 211 *  HWND on win32
 212 */
 213 typedef int libvlc_drawable_t;
 214
 215 /**
 216 * Rectangle type for video geometry
 217 */
 218 typedef struct libvlc_rectangle_t
 219 {
 220     int top, left;
 221     int bottom, right;
 222 }
 223 libvlc_rectangle_t;
 224
 225 /**@} */
 226
 227
 228 /*****************************************************************************
 229  * Services/Media Discovery
 230  *****************************************************************************/
 231 /** defgroup libvlc_media_discoverer Media Discoverer
 232  * \ingroup libvlc
 233  * LibVLC Media Discoverer
 234  * @{
 235  */
 236
 237 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
 238
 239 /**@} */
 240
 241 /*****************************************************************************
 242  * Message log handling
 243  *****************************************************************************/
 244
 245 /** defgroup libvlc_log Log
 246  * \ingroup libvlc
 247  * LibVLC Message Logging
 248  * @{
 249  */
 250
 251 /** This structure is opaque. It represents a libvlc log instance */
 252 typedef struct libvlc_log_t libvlc_log_t;
 253
 254 /** This structure is opaque. It represents a libvlc log iterator */
 255 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
 256
 257 typedef struct libvlc_log_message_t
 258 {
 259     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
 260     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
 261     const char *psz_type;     /* module type */
 262     const char *psz_name;     /* module name */
 263     const char *psz_header;   /* optional header */
 264     const char *psz_message;  /* message */
 265 } libvlc_log_message_t;
 266
 267 /**@} */
 268
 269 /*****************************************************************************
 270  * Callbacks handling
 271  *****************************************************************************/
 272
 273 /** defgroup libvlc_callbacks Callbacks
 274  * \ingroup libvlc
 275  * LibVLC Event Callbacks
 276  * @{
 277  */
 278
 279 /**
 280  * Available events: (XXX: being reworked)
 281  * - libvlc_MediaInstanceReachedEnd
 282  */
 283
 284 typedef enum libvlc_event_type_t {
 285     libvlc_MediaDescriptorMetaChanged,
 286     libvlc_MediaDescriptorSubItemAdded,
 287
 288     libvlc_MediaInstancePlayed,
 289     libvlc_MediaInstancePaused,
 290     libvlc_MediaInstanceReachedEnd,
 291     libvlc_MediaInstancePositionChanged,
 292
 293     libvlc_MediaListItemAdded,
 294     libvlc_MediaListItemDeleted,
 295
 296     libvlc_MediaListPlayerPlayed,
 297     libvlc_MediaListPlayerNextItemSet,
 298     libvlc_MediaListPlayerStopped,
 299
 300 } libvlc_event_type_t;
 301
 302 /**
 303  * An Event
 304  * \param type the even type
 305  * \param p_obj the sender object
 306  * \param u Event dependent content
 307  */
 308
 309 typedef struct libvlc_event_t
 310 {
 311     libvlc_event_type_t type;
 312     void * p_obj;
 313     union event_type_specific
 314     {
 315         /* media descriptor */
 316         struct
 317         {
 318             libvlc_meta_t meta_type;
 319         } media_descriptor_meta_changed;
 320         struct
 321         {
 322             libvlc_media_descriptor_t * new_child;
 323         } media_descriptor_subitem_added;
 324
 325         /* media instance */
 326         struct
 327         {
 328             long int new_position;
 329         } media_instance_position_changed;
 330
 331         /* media list */
 332         struct
 333         {
 334             libvlc_media_descriptor_t * item;
 335             int index;
 336         } media_list_item_added;
 337         struct
 338         {
 339             libvlc_media_descriptor_t * item;
 340             int index;
 341         } media_list_item_deleted;
 342     } u;
 343 } libvlc_event_t;
 344
 345 /**
 346  * Event manager that belongs to a libvlc object, and from whom events can
 347  * be received.
 348  */
 349
 350 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
 351
 352 /**
 353  * Callback function notification
 354  * \param p_event the event triggering the callback
 355  */
 356
 357 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
 358
 359 /**@} */
 360
 361 # ifdef __cplusplus
 362 }
 363 # endif
 364
 365 #endif