1 /*****************************************************************************
2 * libvlc.h: libvlc_* new external API structures
3 *****************************************************************************
4 * Copyright (C) 1998-2007 the VideoLAN team
7 * Authors: Filippo Carone <littlejohn@videolan.org>
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.
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.
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 *****************************************************************************/
24 #ifndef _LIBVLC_STRUCTURES_H
25 #define _LIBVLC_STRUCTURES_H 1
33 /** This structure is opaque. It represents a libvlc instance */
34 typedef struct libvlc_instance_t libvlc_instance_t;
36 /*****************************************************************************
38 *****************************************************************************/
40 /** defgroup libvlc_exception Exceptions
42 * LibVLC Exceptions handling
46 typedef struct libvlc_exception_t
55 /*****************************************************************************
57 *****************************************************************************/
58 /** defgroup libvlc_tag Tag
60 * LibVLC Tag support in media descriptor
64 typedef struct libvlc_tag_query_t libvlc_tag_query_t;
65 typedef char * libvlc_tag_t;
69 /*****************************************************************************
71 *****************************************************************************/
72 /** defgroup libvlc_media_descriptor MediaDescriptor
74 * LibVLC Media Descriptor handling
79 /** defgroup libvlc_meta Meta
80 * \ingroup libvlc_media_descriptor
85 typedef enum libvlc_meta_t {
89 libvlc_meta_Copyright,
91 libvlc_meta_TrackNumber,
92 libvlc_meta_Description,
98 libvlc_meta_NowPlaying,
99 libvlc_meta_Publisher,
100 libvlc_meta_EncodedBy,
101 libvlc_meta_ArtworkURL,
107 typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
112 /*****************************************************************************
114 *****************************************************************************/
115 /** defgroup libvlc_media_instance MediaInstance
117 * LibVLC Media Instance handling
121 typedef struct libvlc_media_instance_t libvlc_media_instance_t;
123 typedef enum libvlc_state_t
136 /*****************************************************************************
138 *****************************************************************************/
139 /** defgroup libvlc_media_list MediaList
141 * LibVLC Media List handling
145 typedef struct libvlc_media_list_t libvlc_media_list_t;
146 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
150 /*****************************************************************************
152 *****************************************************************************/
153 /** defgroup libvlc_media_list MediaList
155 * LibVLC Dynamic Media list: Media list with content synchronized with
160 typedef struct libvlc_dynamic_media_list_t libvlc_dynamic_media_list_t;
164 /*****************************************************************************
166 *****************************************************************************/
167 /** defgroup libvlc_media_list_player MediaListPlayer
169 * LibVLC Media List Player handling
173 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
177 /*****************************************************************************
179 *****************************************************************************/
180 /** defgroup libvlc_media_library Media Library
182 * LibVLC Media Library
186 typedef struct libvlc_media_library_t libvlc_media_library_t;
190 /*****************************************************************************
192 *****************************************************************************/
193 /** defgroup libvlc_playlist Playlist
195 * LibVLC Playlist handling
199 typedef struct libvlc_playlist_item_t
205 } libvlc_playlist_item_t;
210 /*****************************************************************************
212 *****************************************************************************/
213 /** defgroup libvlc_video Video
215 * LibVLC Video handling
220 * Downcast to this general type as placeholder for a platform specific one, such as:
222 * CGrafPort on MacOSX,
225 typedef int libvlc_drawable_t;
228 * Rectangle type for video geometry
230 typedef struct libvlc_rectangle_t
240 /*****************************************************************************
241 * Services/Media Discovery
242 *****************************************************************************/
243 /** defgroup libvlc_media_discoverer Media Discoverer
245 * LibVLC Media Discoverer
249 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
253 /*****************************************************************************
254 * Message log handling
255 *****************************************************************************/
257 /** defgroup libvlc_log Log
259 * LibVLC Message Logging
263 /** This structure is opaque. It represents a libvlc log instance */
264 typedef struct libvlc_log_t libvlc_log_t;
266 /** This structure is opaque. It represents a libvlc log iterator */
267 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
269 typedef struct libvlc_log_message_t
271 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
272 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
273 const char *psz_type; /* module type */
274 const char *psz_name; /* module name */
275 const char *psz_header; /* optional header */
276 const char *psz_message; /* message */
277 } libvlc_log_message_t;
281 /*****************************************************************************
283 *****************************************************************************/
285 /** defgroup libvlc_callbacks Callbacks
287 * LibVLC Event Callbacks
292 * Available events: (XXX: being reworked)
293 * - libvlc_MediaInstanceReachedEnd
296 typedef enum libvlc_event_type_t {
297 libvlc_MediaDescriptorMetaChanged,
298 libvlc_MediaDescriptorSubItemAdded,
299 libvlc_MediaDescriptorDurationChanged,
300 libvlc_MediaDescriptorPreparsedChanged,
301 libvlc_MediaDescriptorFreed,
303 libvlc_MediaInstancePlayed,
304 libvlc_MediaInstancePaused,
305 libvlc_MediaInstanceReachedEnd,
306 libvlc_MediaInstancePositionChanged,
308 libvlc_MediaListItemAdded,
309 libvlc_MediaListWillAddItem,
310 libvlc_MediaListItemDeleted,
311 libvlc_MediaListWillDeleteItem,
313 libvlc_MediaListViewItemAdded,
314 libvlc_MediaListViewWillAddItem,
315 libvlc_MediaListViewItemDeleted,
316 libvlc_MediaListViewWillDeleteItem,
318 libvlc_MediaListPlayerPlayed,
319 libvlc_MediaListPlayerNextItemSet,
320 libvlc_MediaListPlayerStopped,
322 } libvlc_event_type_t;
326 * \param type the even type
327 * \param p_obj the sender object
328 * \param u Event dependent content
331 typedef struct libvlc_event_t
333 libvlc_event_type_t type;
335 union event_type_specific
337 /* media descriptor */
340 libvlc_meta_t meta_type;
341 } media_descriptor_meta_changed;
344 libvlc_media_descriptor_t * new_child;
345 } media_descriptor_subitem_added;
348 vlc_int64_t new_duration;
349 } media_descriptor_duration_changed;
353 } media_descriptor_preparsed_changed;
356 libvlc_media_descriptor_t * md;
357 } media_descriptor_freed;
362 long int new_position;
363 } media_instance_position_changed;
368 libvlc_media_descriptor_t * item;
370 } media_list_item_added;
373 libvlc_media_descriptor_t * item;
375 } media_list_will_add_item;
378 libvlc_media_descriptor_t * item;
380 } media_list_item_deleted;
383 libvlc_media_descriptor_t * item;
385 } media_list_will_delete_item;
387 /* media list view */
390 libvlc_media_descriptor_t * item;
392 } media_list_view_item_added;
395 libvlc_media_descriptor_t * item;
397 } media_list_view_will_add_item;
400 libvlc_media_descriptor_t * item;
402 } media_list_view_item_deleted;
405 libvlc_media_descriptor_t * item;
407 } media_list_view_will_delete_item;
412 * Event manager that belongs to a libvlc object, and from whom events can
416 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
419 * Callback function notification
420 * \param p_event the event triggering the callback
423 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );