01ade2fbaa20beccf33b4259b4dc5820e38499d2
[vlc.git] / 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  * Tree
57  *****************************************************************************/
58 /** defgroup libvlc_tree Tree
59  * \ingroup libvlc
60  * LibVLC Tree 
61  * @{
62  */
63
64 typedef void (*libvlc_retain_function)(void *);
65 typedef void (*libvlc_release_function)(void *);
66
67 typedef struct libvlc_tree_t libvlc_tree_t;
68
69 /**@} */
70
71 /*****************************************************************************
72  * Tag
73  *****************************************************************************/
74 /** defgroup libvlc_tag Tag
75  * \ingroup libvlc
76  * LibVLC Tag  support in media descriptor
77  * @{
78  */
79
80 typedef struct libvlc_tag_query_t libvlc_tag_query_t;
81 typedef char * libvlc_tag_t;
82
83 /**@} */
84
85 /*****************************************************************************
86  * Media Descriptor
87  *****************************************************************************/
88 /** defgroup libvlc_media_descriptor MediaDescriptor
89  * \ingroup libvlc
90  * LibVLC Media Descriptor handling
91  * @{
92  */
93
94 /* Meta Handling */
95 /** defgroup libvlc_meta Meta
96  * \ingroup libvlc_media_descriptor
97  * LibVLC Media Meta
98  * @{
99  */
100
101 typedef enum libvlc_meta_t {
102     libvlc_meta_Title,
103     libvlc_meta_Artist,
104     libvlc_meta_Genre,
105     libvlc_meta_Copyright,
106     libvlc_meta_Album,
107     libvlc_meta_TrackNumber,
108     libvlc_meta_Description,
109     libvlc_meta_Rating,
110     libvlc_meta_Date,
111     libvlc_meta_Setting,
112     libvlc_meta_URL,
113     libvlc_meta_Language,
114     libvlc_meta_NowPlaying,
115     libvlc_meta_Publisher,
116     libvlc_meta_EncodedBy,
117     libvlc_meta_ArtworkURL,
118     libvlc_meta_TrackID
119 } libvlc_meta_t;
120
121 /**@} */
122
123 typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
124
125 /**@} */
126
127
128 /*****************************************************************************
129  * Media Instance
130  *****************************************************************************/
131 /** defgroup libvlc_media_instance MediaInstance
132  * \ingroup libvlc
133  * LibVLC Media Instance handling
134  * @{
135  */
136
137 typedef struct libvlc_media_instance_t libvlc_media_instance_t;
138
139 /**@} */
140
141 /*****************************************************************************
142  * Media List
143  *****************************************************************************/
144 /** defgroup libvlc_media_list MediaList
145  * \ingroup libvlc
146  * LibVLC Media List handling
147  * @{
148  */
149
150 typedef struct libvlc_media_list_t libvlc_media_list_t;
151
152 /**@} */
153
154 /*****************************************************************************
155  * Media List Player
156  *****************************************************************************/
157 /** defgroup libvlc_media_list_player MediaListPlayer
158  * \ingroup libvlc
159  * LibVLC Media List Player handling
160  * @{
161  */
162
163 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
164
165 /**@} */
166
167 /*****************************************************************************
168  * Media Library
169  *****************************************************************************/
170 /** defgroup libvlc_media_library Media Library
171  * \ingroup libvlc
172  * LibVLC Media Library
173  * @{
174  */
175
176 typedef struct libvlc_media_library_t libvlc_media_library_t;
177
178 /**@} */
179
180 /*****************************************************************************
181  * Playlist
182  *****************************************************************************/
183 /** defgroup libvlc_playlist Playlist
184  * \ingroup libvlc
185  * LibVLC Playlist handling
186  * @{
187  */
188
189 typedef struct libvlc_playlist_item_t
190 {
191     int i_id;
192     char * psz_uri;
193     char * psz_name;
194
195 } libvlc_playlist_item_t;
196
197 /**@} */
198
199
200 /*****************************************************************************
201  * Video
202  *****************************************************************************/
203 /** defgroup libvlc_video Video
204  * \ingroup libvlc
205  * LibVLC Video handling
206  * @{
207  */
208     
209 /**
210 * Downcast to this general type as placeholder for a platform specific one, such as:
211 *  Drawable on X11,
212 *  CGrafPort on MacOSX,
213 *  HWND on win32
214 */
215 typedef int libvlc_drawable_t;
216
217 /**
218 * Rectangle type for video geometry
219 */
220 typedef struct libvlc_rectangle_t
221 {
222     int top, left;
223     int bottom, right;
224 }
225 libvlc_rectangle_t;
226
227 /**@} */
228
229
230 /*****************************************************************************
231  * Services/Media Discovery
232  *****************************************************************************/
233 /** defgroup libvlc_media_discoverer Media Discoverer
234  * \ingroup libvlc
235  * LibVLC Media Discoverer
236  * @{
237  */
238
239 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
240
241 /**@} */
242
243 /*****************************************************************************
244  * Message log handling
245  *****************************************************************************/
246
247 /** defgroup libvlc_log Log
248  * \ingroup libvlc
249  * LibVLC Message Logging
250  * @{
251  */
252
253 /** This structure is opaque. It represents a libvlc log instance */
254 typedef struct libvlc_log_t libvlc_log_t;
255
256 /** This structure is opaque. It represents a libvlc log iterator */
257 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
258
259 typedef struct libvlc_log_message_t
260 {
261     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
262     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
263     const char *psz_type;     /* module type */
264     const char *psz_name;     /* module name */
265     const char *psz_header;   /* optional header */
266     const char *psz_message;  /* message */
267 } libvlc_log_message_t;
268
269 /**@} */
270
271 /*****************************************************************************
272  * Callbacks handling
273  *****************************************************************************/
274
275 /** defgroup libvlc_callbacks Callbacks
276  * \ingroup libvlc
277  * LibVLC Event Callbacks
278  * @{
279  */
280     
281 /**
282  * Available events: (XXX: being reworked)
283  * - libvlc_MediaInstanceReachedEnd
284  */
285
286 typedef enum libvlc_event_type_t {
287     libvlc_MediaDescriptorMetaChanged,
288     libvlc_MediaDescriptorSubItemAdded,
289
290     libvlc_MediaInstanceReachedEnd,
291
292     libvlc_MediaListItemAdded,
293     libvlc_MediaListItemDeleted,
294     libvlc_MediaListItemChanged,
295
296 } libvlc_event_type_t;
297
298 /**
299  * An Event
300  * \param type the even type
301  * \param p_obj the sender object
302  * \param u Event dependent content
303  */
304
305 typedef struct libvlc_event_t
306 {
307     libvlc_event_type_t type;
308     void * p_obj;
309     union event_type_specific
310     {
311         /* media descriptor */
312         struct
313         {
314             libvlc_meta_t meta_type;
315         } media_descriptor_meta_changed;
316         struct
317         {
318             libvlc_media_descriptor_t * new_child;
319         } media_descriptor_subitem_added;
320
321         /* media list */
322         struct
323         {
324             libvlc_media_descriptor_t * item;
325             int index;
326         } media_list_item_added;
327         struct
328         {
329             libvlc_media_descriptor_t * item;
330             int index;
331         } media_list_item_deleted;
332         struct
333         {
334             libvlc_media_descriptor_t * item;
335             int index;
336         } media_list_item_changed;
337     } u;
338 } libvlc_event_t;
339
340 /**
341  * Event manager that belongs to a libvlc object, and from whom events can
342  * be received.
343  */
344
345 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
346
347 /**
348  * Callback function notification
349  * \param p_event the event triggering the callback
350  */
351
352 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
353
354 /**@} */
355
356 # ifdef __cplusplus
357 }
358 # endif
359
360 #endif