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 <stdint.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 libvlc_exception
  41  * \ingroup libvlc_core
  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  * Time
  57  *****************************************************************************/
  58 /** \defgroup libvlc_time libvlc_time
  59  * \ingroup libvlc_core
  60  * LibVLC Time support in libvlc
  61  * @{
  62  */
  63
  64 typedef int64_t libvlc_time_t;
  65
  66 /**@} */
  67
  68 /*****************************************************************************
  69  * Media Descriptor
  70  *****************************************************************************/
  71 /** \defgroup libvlc_media libvlc_media
  72  * \ingroup libvlc
  73  * LibVLC Media Descriptor handling
  74  * @{
  75  */
  76
  77 /* Meta Handling */
  78 /** defgroup libvlc_meta libvlc_meta
  79  * \ingroup libvlc_media
  80  * LibVLC Media Meta
  81  * @{
  82  */
  83
  84 typedef enum libvlc_meta_t {
  85     libvlc_meta_Title,
  86     libvlc_meta_Artist,
  87     libvlc_meta_Genre,
  88     libvlc_meta_Copyright,
  89     libvlc_meta_Album,
  90     libvlc_meta_TrackNumber,
  91     libvlc_meta_Description,
  92     libvlc_meta_Rating,
  93     libvlc_meta_Date,
  94     libvlc_meta_Setting,
  95     libvlc_meta_URL,
  96     libvlc_meta_Language,
  97     libvlc_meta_NowPlaying,
  98     libvlc_meta_Publisher,
  99     libvlc_meta_EncodedBy,
 100     libvlc_meta_ArtworkURL,
 101     libvlc_meta_TrackID
 102 } libvlc_meta_t;
 103
 104 /**@} */
 105
 106 typedef struct libvlc_media_t libvlc_media_t;
 107
 108 /**@} */
 109
 110
 111 /*****************************************************************************
 112  * Media Instance
 113  *****************************************************************************/
 114 /** \defgroup libvlc_media_player libvlc_media_player
 115  * \ingroup libvlc
 116  * LibVLC Media Instance handling
 117  * @{
 118  */
 119
 120 typedef struct libvlc_media_player_t libvlc_media_player_t;
 121
 122 typedef enum libvlc_state_t
 123 {
 124     libvlc_NothingSpecial,
 125     libvlc_Stopped,
 126     libvlc_Opening,
 127     libvlc_Buffering,
 128     libvlc_Ended,
 129     libvlc_Error,
 130     libvlc_Playing,
 131     libvlc_Paused
 132 } libvlc_state_t;
 133
 134 /**@} */
 135
 136 /*****************************************************************************
 137  * Media List
 138  *****************************************************************************/
 139 /** \defgroup libvlc_media_list libvlc_media_list
 140  * \ingroup libvlc
 141  * LibVLC Media List handling
 142  * @{
 143  */
 144
 145 typedef struct libvlc_media_list_t libvlc_media_list_t;
 146 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
 147
 148
 149 /*****************************************************************************
 150  * Media List Player
 151  *****************************************************************************/
 152 /** \defgroup libvlc_media_list_player libvlc_media_list_player
 153  * \ingroup libvlc_media_list
 154  * LibVLC Media List Player handling
 155  * @{
 156  */
 157
 158 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
 159
 160 /**@} libvlc_media_list_player */
 161
 162 /**@} libvlc_media_list */
 163
 164 /*****************************************************************************
 165  * Media Library
 166  *****************************************************************************/
 167 /** \defgroup libvlc_media_library libvlc_media_library
 168  * \ingroup libvlc
 169  * LibVLC Media Library
 170  * @{
 171  */
 172
 173 typedef struct libvlc_media_library_t libvlc_media_library_t;
 174
 175 /**@} */
 176
 177 /*****************************************************************************
 178  * Playlist
 179  *****************************************************************************/
 180 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
 181  * \ingroup libvlc
 182  * LibVLC Playlist handling (Deprecated)
 183  * @deprecated Use media_list
 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 libvlc_video
 202  * \ingroup libvlc_media_player
 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 libvlc_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 libvlc_log
 246  * \ingroup libvlc_core
 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 # ifdef __cplusplus
 270 }
 271 # endif
 272
 273 #endif