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
27 #if defined (WIN32) && defined (DLL_EXPORT)
28 # define VLC_PUBLIC_API __declspec(dllexport)
30 # define VLC_PUBLIC_API
34 /* Avoid unuseful warnings from libvlc with our deprecated APIs */
35 # define VLC_DEPRECATED_API VLC_PUBLIC_API
36 #elif defined(__GNUC__) && \
37 (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
38 # define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
40 # define VLC_DEPRECATED_API VLC_PUBLIC_API
49 /** This structure is opaque. It represents a libvlc instance */
50 typedef struct libvlc_instance_t libvlc_instance_t;
52 /*****************************************************************************
54 *****************************************************************************/
56 /** \defgroup libvlc_exception libvlc_exception
57 * \ingroup libvlc_core
58 * LibVLC Exceptions handling
62 typedef struct libvlc_exception_t
71 /*****************************************************************************
73 *****************************************************************************/
74 /** \defgroup libvlc_time libvlc_time
75 * \ingroup libvlc_core
76 * LibVLC Time support in libvlc
80 typedef int64_t libvlc_time_t;
84 /*****************************************************************************
86 *****************************************************************************/
87 /** \defgroup libvlc_media libvlc_media
89 * LibVLC Media Descriptor handling
94 /** defgroup libvlc_meta libvlc_meta
95 * \ingroup libvlc_media
100 typedef enum libvlc_meta_t {
104 libvlc_meta_Copyright,
106 libvlc_meta_TrackNumber,
107 libvlc_meta_Description,
112 libvlc_meta_Language,
113 libvlc_meta_NowPlaying,
114 libvlc_meta_Publisher,
115 libvlc_meta_EncodedBy,
116 libvlc_meta_ArtworkURL,
122 typedef struct libvlc_media_t libvlc_media_t;
127 /*****************************************************************************
129 *****************************************************************************/
130 /** \defgroup libvlc_media_player libvlc_media_player
132 * LibVLC Media Instance handling
136 typedef struct libvlc_media_player_t libvlc_media_player_t;
138 typedef enum libvlc_state_t
140 libvlc_NothingSpecial,
152 /*****************************************************************************
154 *****************************************************************************/
155 /** \defgroup libvlc_media_list libvlc_media_list
157 * LibVLC Media List handling
161 typedef struct libvlc_media_list_t libvlc_media_list_t;
162 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
165 /*****************************************************************************
167 *****************************************************************************/
168 /** \defgroup libvlc_media_list_player libvlc_media_list_player
169 * \ingroup libvlc_media_list
170 * LibVLC Media List Player handling
174 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
176 /**@} libvlc_media_list_player */
178 /**@} libvlc_media_list */
180 /*****************************************************************************
182 *****************************************************************************/
183 /** \defgroup libvlc_media_library libvlc_media_library
185 * LibVLC Media Library
189 typedef struct libvlc_media_library_t libvlc_media_library_t;
193 /*****************************************************************************
195 *****************************************************************************/
196 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
198 * LibVLC Playlist handling (Deprecated)
199 * @deprecated Use media_list
203 typedef struct libvlc_playlist_item_t
209 } libvlc_playlist_item_t;
214 /*****************************************************************************
216 *****************************************************************************/
217 /** \defgroup libvlc_video libvlc_video
218 * \ingroup libvlc_media_player
219 * LibVLC Video handling
224 * Downcast to this general type as placeholder for a platform specific one, such as:
226 * CGrafPort on MacOSX,
229 typedef int libvlc_drawable_t;
232 * Rectangle type for video geometry
234 typedef struct libvlc_rectangle_t
244 /*****************************************************************************
245 * Services/Media Discovery
246 *****************************************************************************/
247 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
249 * LibVLC Media Discoverer
253 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
257 /*****************************************************************************
258 * Message log handling
259 *****************************************************************************/
261 /** \defgroup libvlc_log libvlc_log
262 * \ingroup libvlc_core
263 * LibVLC Message Logging
267 /** This structure is opaque. It represents a libvlc log instance */
268 typedef struct libvlc_log_t libvlc_log_t;
270 /** This structure is opaque. It represents a libvlc log iterator */
271 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
273 typedef struct libvlc_log_message_t
275 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
276 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
277 const char *psz_type; /* module type */
278 const char *psz_name; /* module name */
279 const char *psz_header; /* optional header */
280 const char *psz_message; /* message */
281 } libvlc_log_message_t;