libvlc_structures.h 7.11 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 24 25 26
/*****************************************************************************
 * 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.
 *****************************************************************************/

#ifndef _LIBVLC_STRUCTURES_H
#define _LIBVLC_STRUCTURES_H 1

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
typedef enum libvlc_state_t
{
124
    libvlc_NothingSpecial,
125 126 127 128 129 130 131 132 133
    libvlc_Stopped,
    libvlc_Opening,
    libvlc_Buffering,
    libvlc_Ended,
    libvlc_Error,
    libvlc_Playing,
    libvlc_Paused
} libvlc_state_t;

134 135
/**@} */

136 137 138
/*****************************************************************************
 * Media List
 *****************************************************************************/
139
/** \defgroup libvlc_media_list libvlc_media_list
140 141 142 143 144 145
 * \ingroup libvlc
 * LibVLC Media List handling
 * @{
 */

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 151


/*****************************************************************************
 * Media List Player
 *****************************************************************************/
152 153
/** \defgroup libvlc_media_list_player libvlc_media_list_player
 * \ingroup libvlc_media_list
154 155 156 157 158 159
 * LibVLC Media List Player handling
 * @{
 */

typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;

160 161 162
/**@} libvlc_media_list_player */

/**@} libvlc_media_list */
163

164 165 166
/*****************************************************************************
 * Media Library
 *****************************************************************************/
167
/** \defgroup libvlc_media_library libvlc_media_library
168 169 170 171 172 173 174 175 176
 * \ingroup libvlc
 * LibVLC Media Library
 * @{
 */

typedef struct libvlc_media_library_t libvlc_media_library_t;

/**@} */

177 178 179
/*****************************************************************************
 * Playlist
 *****************************************************************************/
180
/** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
181
 * \ingroup libvlc
182 183
 * LibVLC Playlist handling (Deprecated)
 * @deprecated Use media_list
184 185 186
 * @{
 */

187 188
typedef struct libvlc_playlist_item_t
{
189 190 191 192 193 194 195 196 197 198 199 200
    int i_id;
    char * psz_uri;
    char * psz_name;

} libvlc_playlist_item_t;

/**@} */


/*****************************************************************************
 * Video
 *****************************************************************************/
201
/** \defgroup libvlc_video libvlc_video
202
 * \ingroup libvlc_media_player
203 204 205
 * LibVLC Video handling
 * @{
 */
206
 
207 208 209 210 211 212 213 214 215 216 217
/**
* 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
*/
218
typedef struct libvlc_rectangle_t
219 220 221 222 223 224 225 226 227
{
    int top, left;
    int bottom, right;
}
libvlc_rectangle_t;

/**@} */


228 229 230
/*****************************************************************************
 * Services/Media Discovery
 *****************************************************************************/
231
/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
232 233 234 235 236 237 238 239 240
 * \ingroup libvlc
 * LibVLC Media Discoverer
 * @{
 */

typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;

/**@} */

241 242 243 244
/*****************************************************************************
 * Message log handling
 *****************************************************************************/

245
/** \defgroup libvlc_log libvlc_log
246
 * \ingroup libvlc_core
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
 * 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