libvlc_structures.h 8.59 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
27
28
29
30
31
32
33
34
/*****************************************************************************
 * 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

#include <vlc/vlc.h>

# 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
41
42
43
44
45
/** defgroup libvlc_exception Exceptions
 * \ingroup libvlc
 * 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
58
59
60
61
62
63
64
65
66
67
/*****************************************************************************
 * Tag Query
 *****************************************************************************/
/** defgroup libvlc_tag_query Tag Query
 * \ingroup libvlc
 * LibVLC Tag Query support in media descriptor
 * @{
 */

typedef struct libvlc_tag_query_t libvlc_tag_query_t;

/**@} */

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*****************************************************************************
 * Media Descriptor
 *****************************************************************************/
/** defgroup libvlc_media_descriptor MediaDescriptor
 * \ingroup libvlc
 * LibVLC Media Descriptor handling
 * @{
 */

/* Meta Handling */
/** defgroup libvlc_meta Meta
 * \ingroup libvlc_media_descriptor
 * 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_descriptor_t libvlc_media_descriptor_t;
107
108
109

/**@} */

110

111
112
113
114
115
116
117
118
119
120
121
122
123
/*****************************************************************************
 * Media Instance
 *****************************************************************************/
/** defgroup libvlc_media_instance MediaInstance
 * \ingroup libvlc
 * LibVLC Media Instance handling
 * @{
 */

typedef struct libvlc_media_instance_t libvlc_media_instance_t;

/**@} */

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*****************************************************************************
 * Media List
 *****************************************************************************/
/** defgroup libvlc_media_list MediaList
 * \ingroup libvlc
 * LibVLC Media List handling
 * @{
 */

typedef struct libvlc_media_list_t libvlc_media_list_t;

/**@} */

/*****************************************************************************
 * Media List Player
 *****************************************************************************/
/** defgroup libvlc_media_list_player MediaListPlayer
 * \ingroup libvlc
 * LibVLC Media List Player handling
 * @{
 */

typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;

/**@} */
149

150
151
152
153
154
155
156
157
158
159
160
161
162
/*****************************************************************************
 * Media Library
 *****************************************************************************/
/** defgroup libvlc_media_library Media Library
 * \ingroup libvlc
 * LibVLC Media Library
 * @{
 */

typedef struct libvlc_media_library_t libvlc_media_library_t;

/**@} */

163
164
165
166
167
168
169
170
171
/*****************************************************************************
 * Playlist
 *****************************************************************************/
/** defgroup libvlc_playlist Playlist
 * \ingroup libvlc
 * LibVLC Playlist handling
 * @{
 */

172
173
typedef struct libvlc_playlist_item_t
{
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
    int i_id;
    char * psz_uri;
    char * psz_name;

} libvlc_playlist_item_t;

/**@} */


/*****************************************************************************
 * Video
 *****************************************************************************/
/** defgroup libvlc_video Video
 * \ingroup libvlc
 * LibVLC Video handling
 * @{
 */
    
/**
* 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
*/
203
typedef struct libvlc_rectangle_t
204
205
206
207
208
209
210
211
212
{
    int top, left;
    int bottom, right;
}
libvlc_rectangle_t;

/**@} */


213
214
215
216
217
218
219
220
221
222
223
224
225
/*****************************************************************************
 * Services/Media Discovery
 *****************************************************************************/
/** defgroup libvlc_media_discoverer Media Discoverer
 * \ingroup libvlc
 * LibVLC Media Discoverer
 * @{
 */

typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;

/**@} */

226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
/*****************************************************************************
 * Message log handling
 *****************************************************************************/

/** defgroup libvlc_log Log
 * \ingroup libvlc
 * 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;

/**@} */

/*****************************************************************************
 * Callbacks handling
 *****************************************************************************/

/** defgroup libvlc_callbacks Callbacks
 * \ingroup libvlc
 * LibVLC Event Callbacks
 * @{
 */
    
/**
265
 * Available events: (XXX: being reworked)
266
 * - libvlc_MediaInstanceReachedEnd
267
 */
268

269
typedef enum libvlc_event_type_t {
270
    libvlc_MediaDescriptorMetaChanged,
271
    libvlc_MediaDescriptorSubItemAdded,
272

273
    libvlc_MediaInstanceReachedEnd,
274

275
276
277
    libvlc_MediaListItemAdded,
    libvlc_MediaListItemDeleted,
    libvlc_MediaListItemChanged,
278

279
280
} libvlc_event_type_t;

281
282
283
284
285
286
287
/**
 * An Event
 * \param type the even type
 * \param p_obj the sender object
 * \param u Event dependent content
 */

288
typedef struct libvlc_event_t
289
290
{
    libvlc_event_type_t type;
291
292
    void * p_obj;
    union event_type_specific
293
    {
294
        /* media descriptor */
295
296
297
298
        struct
        {
            libvlc_meta_t meta_type;
        } media_descriptor_meta_changed;
299
        struct
300
301
302
        {
            libvlc_media_descriptor_t * new_child;
        } media_descriptor_subitem_added;
303
304

        /* media list */
305
        struct
306
        {
307
308
309
310
311
312
313
314
315
316
317
318
319
            libvlc_media_descriptor_t * item;
            int index;
        } media_list_item_added;
        struct
        {
            libvlc_media_descriptor_t * item;
            int index;
        } media_list_item_deleted;
        struct
        {
            libvlc_media_descriptor_t * item;
            int index;
        } media_list_item_changed;
320
    } u;
321
} libvlc_event_t;
322

323
324
325
326
327
328
329
/**
 * Event manager that belongs to a libvlc object, and from whom events can
 * be received.
 */

typedef struct libvlc_event_manager_t libvlc_event_manager_t;

330
331
332
333
334
/**
 * Callback function notification
 * \param p_event the event triggering the callback
 */

335
typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
336
337
338
339
340
341
342
343

/**@} */

# ifdef __cplusplus
}
# endif

#endif