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_query Tag Query
60 * LibVLC Tag Query support in media descriptor
64 typedef struct libvlc_tag_query_t libvlc_tag_query_t;
68 /*****************************************************************************
70 *****************************************************************************/
71 /** defgroup libvlc_media_descriptor MediaDescriptor
73 * LibVLC Media Descriptor handling
78 /** defgroup libvlc_meta Meta
79 * \ingroup libvlc_media_descriptor
84 typedef enum libvlc_meta_t {
88 libvlc_meta_Copyright,
90 libvlc_meta_TrackNumber,
91 libvlc_meta_Description,
97 libvlc_meta_NowPlaying,
98 libvlc_meta_Publisher,
99 libvlc_meta_EncodedBy,
100 libvlc_meta_ArtworkURL,
106 typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
111 /*****************************************************************************
113 *****************************************************************************/
114 /** defgroup libvlc_media_instance MediaInstance
116 * LibVLC Media Instance handling
120 typedef struct libvlc_media_instance_t libvlc_media_instance_t;
124 /*****************************************************************************
126 *****************************************************************************/
127 /** defgroup libvlc_media_list MediaList
129 * LibVLC Media List handling
133 typedef struct libvlc_media_list_t libvlc_media_list_t;
137 /*****************************************************************************
139 *****************************************************************************/
140 /** defgroup libvlc_media_list_player MediaListPlayer
142 * LibVLC Media List Player handling
146 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
150 /*****************************************************************************
152 *****************************************************************************/
153 /** defgroup libvlc_media_library Media Library
155 * LibVLC Media Library
159 typedef struct libvlc_media_library_t libvlc_media_library_t;
163 /*****************************************************************************
165 *****************************************************************************/
166 /** defgroup libvlc_playlist Playlist
168 * LibVLC Playlist handling
172 typedef struct libvlc_playlist_item_t
178 } libvlc_playlist_item_t;
183 /*****************************************************************************
185 *****************************************************************************/
186 /** defgroup libvlc_video Video
188 * LibVLC Video handling
193 * Downcast to this general type as placeholder for a platform specific one, such as:
195 * CGrafPort on MacOSX,
198 typedef int libvlc_drawable_t;
201 * Rectangle type for video geometry
203 typedef struct libvlc_rectangle_t
213 /*****************************************************************************
214 * Services/Media Discovery
215 *****************************************************************************/
216 /** defgroup libvlc_media_discoverer Media Discoverer
218 * LibVLC Media Discoverer
222 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
226 /*****************************************************************************
227 * Message log handling
228 *****************************************************************************/
230 /** defgroup libvlc_log Log
232 * LibVLC Message Logging
236 /** This structure is opaque. It represents a libvlc log instance */
237 typedef struct libvlc_log_t libvlc_log_t;
239 /** This structure is opaque. It represents a libvlc log iterator */
240 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
242 typedef struct libvlc_log_message_t
244 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
245 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
246 const char *psz_type; /* module type */
247 const char *psz_name; /* module name */
248 const char *psz_header; /* optional header */
249 const char *psz_message; /* message */
250 } libvlc_log_message_t;
254 /*****************************************************************************
256 *****************************************************************************/
258 /** defgroup libvlc_callbacks Callbacks
260 * LibVLC Event Callbacks
265 * Available events: (XXX: being reworked)
266 * - libvlc_MediaInstanceReachedEnd
269 typedef enum libvlc_event_type_t {
270 libvlc_MediaDescriptorMetaChanged,
271 libvlc_MediaDescriptorSubItemAdded,
273 libvlc_MediaInstanceReachedEnd,
275 libvlc_MediaListItemAdded,
276 libvlc_MediaListItemDeleted,
277 libvlc_MediaListItemChanged,
279 } libvlc_event_type_t;
283 * \param type the even type
284 * \param p_obj the sender object
285 * \param u Event dependent content
288 typedef struct libvlc_event_t
290 libvlc_event_type_t type;
292 union event_type_specific
294 /* media descriptor */
297 libvlc_meta_t meta_type;
298 } media_descriptor_meta_changed;
301 libvlc_media_descriptor_t * new_child;
302 } media_descriptor_subitem_added;
307 libvlc_media_descriptor_t * item;
309 } media_list_item_added;
312 libvlc_media_descriptor_t * item;
314 } media_list_item_deleted;
317 libvlc_media_descriptor_t * item;
319 } media_list_item_changed;
324 * Event manager that belongs to a libvlc object, and from whom events can
328 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
331 * Callback function notification
332 * \param p_event the event triggering the callback
335 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );