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
43 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
44 typedef signed __int64 vlc_int64_t;
46 typedef signed long long vlc_int64_t;
53 /** This structure is opaque. It represents a libvlc instance */
54 typedef struct libvlc_instance_t libvlc_instance_t;
56 /*****************************************************************************
58 *****************************************************************************/
60 /** \defgroup libvlc_exception libvlc_exception
61 * \ingroup libvlc_core
62 * LibVLC Exceptions handling
66 typedef struct libvlc_exception_t
75 /*****************************************************************************
77 *****************************************************************************/
78 /** \defgroup libvlc_time libvlc_time
79 * \ingroup libvlc_core
80 * LibVLC Time support in libvlc
84 typedef vlc_int64_t libvlc_time_t;
88 /*****************************************************************************
90 *****************************************************************************/
91 /** \defgroup libvlc_media libvlc_media
93 * LibVLC Media Descriptor handling
98 /** defgroup libvlc_meta libvlc_meta
99 * \ingroup libvlc_media
104 typedef enum libvlc_meta_t {
108 libvlc_meta_Copyright,
110 libvlc_meta_TrackNumber,
111 libvlc_meta_Description,
116 libvlc_meta_Language,
117 libvlc_meta_NowPlaying,
118 libvlc_meta_Publisher,
119 libvlc_meta_EncodedBy,
120 libvlc_meta_ArtworkURL,
126 typedef struct libvlc_media_t libvlc_media_t;
131 /*****************************************************************************
133 *****************************************************************************/
134 /** \defgroup libvlc_media_player libvlc_media_player
136 * LibVLC Media Instance handling
140 typedef struct libvlc_media_player_t libvlc_media_player_t;
142 typedef enum libvlc_state_t
144 libvlc_NothingSpecial,
156 /*****************************************************************************
158 *****************************************************************************/
159 /** \defgroup libvlc_media_list libvlc_media_list
161 * LibVLC Media List handling
165 typedef struct libvlc_media_list_t libvlc_media_list_t;
166 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
169 /*****************************************************************************
171 *****************************************************************************/
172 /** \defgroup libvlc_media_list_player libvlc_media_list_player
173 * \ingroup libvlc_media_list
174 * LibVLC Media List Player handling
178 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
180 /**@} libvlc_media_list_player */
182 /**@} libvlc_media_list */
184 /*****************************************************************************
186 *****************************************************************************/
187 /** \defgroup libvlc_media_library libvlc_media_library
189 * LibVLC Media Library
193 typedef struct libvlc_media_library_t libvlc_media_library_t;
197 /*****************************************************************************
199 *****************************************************************************/
200 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
202 * LibVLC Playlist handling (Deprecated)
203 * @deprecated Use media_list
207 typedef struct libvlc_playlist_item_t
213 } libvlc_playlist_item_t;
218 /*****************************************************************************
220 *****************************************************************************/
221 /** \defgroup libvlc_video libvlc_video
222 * \ingroup libvlc_media_player
223 * LibVLC Video handling
228 * Downcast to this general type as placeholder for a platform specific one, such as:
230 * CGrafPort on MacOSX,
233 typedef int libvlc_drawable_t;
236 * Rectangle type for video geometry
238 typedef struct libvlc_rectangle_t
248 /*****************************************************************************
249 * Services/Media Discovery
250 *****************************************************************************/
251 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
253 * LibVLC Media Discoverer
257 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
261 /*****************************************************************************
262 * Message log handling
263 *****************************************************************************/
265 /** \defgroup libvlc_log libvlc_log
266 * \ingroup libvlc_core
267 * LibVLC Message Logging
271 /** This structure is opaque. It represents a libvlc log instance */
272 typedef struct libvlc_log_t libvlc_log_t;
274 /** This structure is opaque. It represents a libvlc log iterator */
275 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
277 typedef struct libvlc_log_message_t
279 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
280 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
281 const char *psz_type; /* module type */
282 const char *psz_name; /* module name */
283 const char *psz_header; /* optional header */
284 const char *psz_message; /* message */
285 } libvlc_log_message_t;