libvlc_structures.h 7.45 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*****************************************************************************
 * libvlc.h:  libvlc_* new external API structures
 *****************************************************************************
 * Copyright (C) 1998-2007 the VideoLAN team
 * $Id $
 *
 * Authors: Filippo Carone <littlejohn@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

24 25
#ifndef LIBVLC_STRUCTURES_H
#define LIBVLC_STRUCTURES_H 1
26

27
#include <stdint.h>
28

29 30 31 32 33 34
# ifdef __cplusplus
extern "C" {
# endif

/** This structure is opaque. It represents a libvlc instance */
typedef struct libvlc_instance_t libvlc_instance_t;
35 36 37 38 39

/*****************************************************************************
 * Exceptions
 *****************************************************************************/

40
/** \defgroup libvlc_exception libvlc_exception
41
 * \ingroup libvlc_core
42 43 44 45
 * LibVLC Exceptions handling
 * @{
 */

46
typedef struct libvlc_exception_t
47 48 49 50 51 52 53 54
{
    int b_raised;
    int i_code;
    char *psz_message;
} libvlc_exception_t;

/**@} */

55 56 57
/*****************************************************************************
 * Time
 *****************************************************************************/
58
/** \defgroup libvlc_time libvlc_time
59
 * \ingroup libvlc_core
60 61 62 63
 * LibVLC Time support in libvlc
 * @{
 */

64
typedef int64_t libvlc_time_t;
65 66 67

/**@} */

68 69 70
/*****************************************************************************
 * Media Descriptor
 *****************************************************************************/
71
/** \defgroup libvlc_media libvlc_media
72 73 74 75 76 77
 * \ingroup libvlc
 * LibVLC Media Descriptor handling
 * @{
 */

/* Meta Handling */
78
/** defgroup libvlc_meta libvlc_meta
79
 * \ingroup libvlc_media
80 81 82 83
 * LibVLC Media Meta
 * @{
 */

84
typedef enum libvlc_meta_t {
85
    libvlc_meta_Title,
86 87 88 89 90 91 92 93
    libvlc_meta_Artist,
    libvlc_meta_Genre,
    libvlc_meta_Copyright,
    libvlc_meta_Album,
    libvlc_meta_TrackNumber,
    libvlc_meta_Description,
    libvlc_meta_Rating,
    libvlc_meta_Date,
94
    libvlc_meta_Setting,
95 96 97 98 99 100 101
    libvlc_meta_URL,
    libvlc_meta_Language,
    libvlc_meta_NowPlaying,
    libvlc_meta_Publisher,
    libvlc_meta_EncodedBy,
    libvlc_meta_ArtworkURL,
    libvlc_meta_TrackID
102 103 104 105
} libvlc_meta_t;

/**@} */

106
typedef struct libvlc_media_t libvlc_media_t;
107 108 109

/**@} */

110

111 112 113
/*****************************************************************************
 * Media Instance
 *****************************************************************************/
114
/** \defgroup libvlc_media_player libvlc_media_player
115 116 117 118 119
 * \ingroup libvlc
 * LibVLC Media Instance handling
 * @{
 */

120
typedef struct libvlc_media_player_t libvlc_media_player_t;
121

122 123 124 125 126 127
/**
 * Note the order of libvlc_state_t enum must match exactly the order of
 * @see mediacontrol_PlayerStatus and @see input_state_e enums.
 *
 * Expected states by web plugins are:
 * IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4,
128
 * STOPPING=5, FORWARD=6, BACKWARD=7, ENDED=8, ERROR=9
129
 */
130 131
typedef enum libvlc_state_t
{
132
    libvlc_NothingSpecial=0,
133 134 135
    libvlc_Opening,
    libvlc_Buffering,
    libvlc_Playing,
136
    libvlc_Paused,
137
    libvlc_Stopped,
138 139
    libvlc_Forward,
    libvlc_Backward,
140
    libvlc_Ended,
141
    libvlc_Error
142 143
} libvlc_state_t;

144 145
/**@} */

146 147 148
/*****************************************************************************
 * Media List
 *****************************************************************************/
149
/** \defgroup libvlc_media_list libvlc_media_list
150 151 152 153 154 155
 * \ingroup libvlc
 * LibVLC Media List handling
 * @{
 */

typedef struct libvlc_media_list_t libvlc_media_list_t;
156
typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
157 158 159 160 161


/*****************************************************************************
 * Media List Player
 *****************************************************************************/
162 163
/** \defgroup libvlc_media_list_player libvlc_media_list_player
 * \ingroup libvlc_media_list
164 165 166 167 168 169
 * LibVLC Media List Player handling
 * @{
 */

typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;

170 171 172
/**@} libvlc_media_list_player */

/**@} libvlc_media_list */
173

174 175 176
/*****************************************************************************
 * Media Library
 *****************************************************************************/
177
/** \defgroup libvlc_media_library libvlc_media_library
178 179 180 181 182 183 184 185 186
 * \ingroup libvlc
 * LibVLC Media Library
 * @{
 */

typedef struct libvlc_media_library_t libvlc_media_library_t;

/**@} */

187 188 189
/*****************************************************************************
 * Playlist
 *****************************************************************************/
190
/** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
191
 * \ingroup libvlc
192 193
 * LibVLC Playlist handling (Deprecated)
 * @deprecated Use media_list
194 195 196
 * @{
 */

197 198
typedef struct libvlc_playlist_item_t
{
199 200 201 202 203 204 205 206 207 208 209 210
    int i_id;
    char * psz_uri;
    char * psz_name;

} libvlc_playlist_item_t;

/**@} */


/*****************************************************************************
 * Video
 *****************************************************************************/
211
/** \defgroup libvlc_video libvlc_video
212
 * \ingroup libvlc_media_player
213 214 215
 * LibVLC Video handling
 * @{
 */
216
 
217 218 219 220 221 222 223 224 225 226 227
/**
* Downcast to this general type as placeholder for a platform specific one, such as:
*  Drawable on X11,
*  CGrafPort on MacOSX,
*  HWND on win32
*/
typedef int libvlc_drawable_t;

/**
* Rectangle type for video geometry
*/
228
typedef struct libvlc_rectangle_t
229 230 231 232 233 234 235 236 237
{
    int top, left;
    int bottom, right;
}
libvlc_rectangle_t;

/**@} */


238 239 240
/*****************************************************************************
 * Services/Media Discovery
 *****************************************************************************/
241
/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
242 243 244 245 246 247 248 249 250
 * \ingroup libvlc
 * LibVLC Media Discoverer
 * @{
 */

typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;

/**@} */

251 252 253 254
/*****************************************************************************
 * Message log handling
 *****************************************************************************/

255
/** \defgroup libvlc_log libvlc_log
256
 * \ingroup libvlc_core
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
 * LibVLC Message Logging
 * @{
 */

/** This structure is opaque. It represents a libvlc log instance */
typedef struct libvlc_log_t libvlc_log_t;

/** This structure is opaque. It represents a libvlc log iterator */
typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;

typedef struct libvlc_log_message_t
{
    unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
    int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
    const char *psz_type;     /* module type */
    const char *psz_name;     /* module name */
    const char *psz_header;   /* optional header */
    const char *psz_message;  /* message */
} libvlc_log_message_t;

/**@} */

# ifdef __cplusplus
}
# endif

#endif