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 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
 136
 137 /**@} */
 138
 139 /*****************************************************************************
 140  * Dynamic Media List
 141  *****************************************************************************/
 142 /** defgroup libvlc_media_list MediaList
 143  * \ingroup libvlc
 144  * LibVLC Dynamic Media list: Media list with content synchronized with
 145  * an other playlist
 146  * @{
 147  */
 148
 149 typedef struct libvlc_dynamic_media_list_t libvlc_dynamic_media_list_t;
 150
 151 /**@} */
 152
 153 /*****************************************************************************
 154  * Media List Player
 155  *****************************************************************************/
 156 /** defgroup libvlc_media_list_player MediaListPlayer
 157  * \ingroup libvlc
 158  * LibVLC Media List Player handling
 159  * @{
 160  */
 161
 162 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
 163
 164 /**@} */
 165
 166 /*****************************************************************************
 167  * Media Library
 168  *****************************************************************************/
 169 /** defgroup libvlc_media_library Media Library
 170  * \ingroup libvlc
 171  * LibVLC Media Library
 172  * @{
 173  */
 174
 175 typedef struct libvlc_media_library_t libvlc_media_library_t;
 176
 177 /**@} */
 178
 179 /*****************************************************************************
 180  * Playlist
 181  *****************************************************************************/
 182 /** defgroup libvlc_playlist Playlist
 183  * \ingroup libvlc
 184  * LibVLC Playlist handling
 185  * @{
 186  */
 187
 188 typedef struct libvlc_playlist_item_t
 189 {
 190     int i_id;
 191     char * psz_uri;
 192     char * psz_name;
 193
 194 } libvlc_playlist_item_t;
 195
 196 /**@} */
 197
 198
 199 /*****************************************************************************
 200  * Video
 201  *****************************************************************************/
 202 /** defgroup libvlc_video Video
 203  * \ingroup libvlc
 204  * LibVLC Video handling
 205  * @{
 206  */
 207
 208 /**
 209 * Downcast to this general type as placeholder for a platform specific one, such as:
 210 *  Drawable on X11,
 211 *  CGrafPort on MacOSX,
 212 *  HWND on win32
 213 */
 214 typedef int libvlc_drawable_t;
 215
 216 /**
 217 * Rectangle type for video geometry
 218 */
 219 typedef struct libvlc_rectangle_t
 220 {
 221     int top, left;
 222     int bottom, right;
 223 }
 224 libvlc_rectangle_t;
 225
 226 /**@} */
 227
 228
 229 /*****************************************************************************
 230  * Services/Media Discovery
 231  *****************************************************************************/
 232 /** defgroup libvlc_media_discoverer Media Discoverer
 233  * \ingroup libvlc
 234  * LibVLC Media Discoverer
 235  * @{
 236  */
 237
 238 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
 239
 240 /**@} */
 241
 242 /*****************************************************************************
 243  * Message log handling
 244  *****************************************************************************/
 245
 246 /** defgroup libvlc_log Log
 247  * \ingroup libvlc
 248  * LibVLC Message Logging
 249  * @{
 250  */
 251
 252 /** This structure is opaque. It represents a libvlc log instance */
 253 typedef struct libvlc_log_t libvlc_log_t;
 254
 255 /** This structure is opaque. It represents a libvlc log iterator */
 256 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
 257
 258 typedef struct libvlc_log_message_t
 259 {
 260     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
 261     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
 262     const char *psz_type;     /* module type */
 263     const char *psz_name;     /* module name */
 264     const char *psz_header;   /* optional header */
 265     const char *psz_message;  /* message */
 266 } libvlc_log_message_t;
 267
 268 /**@} */
 269
 270 /*****************************************************************************
 271  * Callbacks handling
 272  *****************************************************************************/
 273
 274 /** defgroup libvlc_callbacks Callbacks
 275  * \ingroup libvlc
 276  * LibVLC Event Callbacks
 277  * @{
 278  */
 279
 280 /**
 281  * Available events: (XXX: being reworked)
 282  * - libvlc_MediaInstanceReachedEnd
 283  */
 284
 285 typedef enum libvlc_event_type_t {
 286     libvlc_MediaDescriptorMetaChanged,
 287     libvlc_MediaDescriptorSubItemAdded,
 288
 289     libvlc_MediaInstancePlayed,
 290     libvlc_MediaInstancePaused,
 291     libvlc_MediaInstanceReachedEnd,
 292     libvlc_MediaInstancePositionChanged,
 293
 294     libvlc_MediaListItemAdded,
 295     libvlc_MediaListItemDeleted,
 296
 297     libvlc_MediaListPlayerPlayed,
 298     libvlc_MediaListPlayerNextItemSet,
 299     libvlc_MediaListPlayerStopped,
 300
 301 } libvlc_event_type_t;
 302
 303 /**
 304  * An Event
 305  * \param type the even type
 306  * \param p_obj the sender object
 307  * \param u Event dependent content
 308  */
 309
 310 typedef struct libvlc_event_t
 311 {
 312     libvlc_event_type_t type;
 313     void * p_obj;
 314     union event_type_specific
 315     {
 316         /* media descriptor */
 317         struct
 318         {
 319             libvlc_meta_t meta_type;
 320         } media_descriptor_meta_changed;
 321         struct
 322         {
 323             libvlc_media_descriptor_t * new_child;
 324         } media_descriptor_subitem_added;
 325
 326         /* media instance */
 327         struct
 328         {
 329             long int new_position;
 330         } media_instance_position_changed;
 331
 332         /* media list */
 333         struct
 334         {
 335             libvlc_media_descriptor_t * item;
 336             int index;
 337         } media_list_item_added;
 338         struct
 339         {
 340             libvlc_media_descriptor_t * item;
 341             int index;
 342         } media_list_item_deleted;
 343     } u;
 344 } libvlc_event_t;
 345
 346 /**
 347  * Event manager that belongs to a libvlc object, and from whom events can
 348  * be received.
 349  */
 350
 351 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
 352
 353 /**
 354  * Callback function notification
 355  * \param p_event the event triggering the callback
 356  */
 357
 358 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
 359
 360 /**@} */
 361
 362 # ifdef __cplusplus
 363 }
 364 # endif
 365
 366 #endif