libvlc_structures.h 7.72 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*****************************************************************************
 * libvlc.h:  libvlc_* new external API structures
 *****************************************************************************
 * Copyright (C) 1998-2007 the VideoLAN team
 * $Id $
 *
 * Authors: Filippo Carone <littlejohn@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#ifndef _LIBVLC_STRUCTURES_H
#define _LIBVLC_STRUCTURES_H 1

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
#if defined (WIN32) && defined (DLL_EXPORT)
# define VLC_PUBLIC_API __declspec(dllexport)
#else
# define VLC_PUBLIC_API
#endif

#ifdef __LIBVLC__
/* Avoid unuseful warnings from libvlc with our deprecated APIs */
#   define VLC_DEPRECATED_API VLC_PUBLIC_API
#elif defined(__GNUC__) && \
      (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
# define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
#else
# define VLC_DEPRECATED_API VLC_PUBLIC_API
#endif

#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
typedef signed __int64 vlc_int64_t;
# else
typedef signed long long vlc_int64_t;
#endif

49 50 51 52 53 54
# ifdef __cplusplus
extern "C" {
# endif

/** This structure is opaque. It represents a libvlc instance */
typedef struct libvlc_instance_t libvlc_instance_t;
55 56 57 58 59

/*****************************************************************************
 * Exceptions
 *****************************************************************************/

60
/** \defgroup libvlc_exception libvlc_exception
61
 * \ingroup libvlc_core
62 63 64 65
 * LibVLC Exceptions handling
 * @{
 */

66
typedef struct libvlc_exception_t
67 68 69 70 71 72 73 74
{
    int b_raised;
    int i_code;
    char *psz_message;
} libvlc_exception_t;

/**@} */

75 76 77
/*****************************************************************************
 * Time
 *****************************************************************************/
78
/** \defgroup libvlc_time libvlc_time
79
 * \ingroup libvlc_core
80 81 82 83 84 85 86 87
 * LibVLC Time support in libvlc
 * @{
 */

typedef vlc_int64_t libvlc_time_t;

/**@} */

88 89 90
/*****************************************************************************
 * Media Descriptor
 *****************************************************************************/
91
/** \defgroup libvlc_media libvlc_media
92 93 94 95 96 97
 * \ingroup libvlc
 * LibVLC Media Descriptor handling
 * @{
 */

/* Meta Handling */
98
/** defgroup libvlc_meta libvlc_meta
99
 * \ingroup libvlc_media
100 101 102 103
 * LibVLC Media Meta
 * @{
 */

104
typedef enum libvlc_meta_t {
105
    libvlc_meta_Title,
106 107 108 109 110 111 112 113
    libvlc_meta_Artist,
    libvlc_meta_Genre,
    libvlc_meta_Copyright,
    libvlc_meta_Album,
    libvlc_meta_TrackNumber,
    libvlc_meta_Description,
    libvlc_meta_Rating,
    libvlc_meta_Date,
114
    libvlc_meta_Setting,
115 116 117 118 119 120 121
    libvlc_meta_URL,
    libvlc_meta_Language,
    libvlc_meta_NowPlaying,
    libvlc_meta_Publisher,
    libvlc_meta_EncodedBy,
    libvlc_meta_ArtworkURL,
    libvlc_meta_TrackID
122 123 124 125
} libvlc_meta_t;

/**@} */

126
typedef struct libvlc_media_t libvlc_media_t;
127 128 129

/**@} */

130

131 132 133
/*****************************************************************************
 * Media Instance
 *****************************************************************************/
134
/** \defgroup libvlc_media_player libvlc_media_player
135 136 137 138 139
 * \ingroup libvlc
 * LibVLC Media Instance handling
 * @{
 */

140
typedef struct libvlc_media_player_t libvlc_media_player_t;
141

142 143
typedef enum libvlc_state_t
{
144
    libvlc_NothingSpecial,
145 146 147 148 149 150 151 152 153
    libvlc_Stopped,
    libvlc_Opening,
    libvlc_Buffering,
    libvlc_Ended,
    libvlc_Error,
    libvlc_Playing,
    libvlc_Paused
} libvlc_state_t;

154 155
/**@} */

156 157 158
/*****************************************************************************
 * Media List
 *****************************************************************************/
159
/** \defgroup libvlc_media_list libvlc_media_list
160 161 162 163 164 165
 * \ingroup libvlc
 * LibVLC Media List handling
 * @{
 */

typedef struct libvlc_media_list_t libvlc_media_list_t;
166
typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
167 168 169 170 171


/*****************************************************************************
 * Media List Player
 *****************************************************************************/
172 173
/** \defgroup libvlc_media_list_player libvlc_media_list_player
 * \ingroup libvlc_media_list
174 175 176 177 178 179
 * LibVLC Media List Player handling
 * @{
 */

typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;

180 181 182
/**@} libvlc_media_list_player */

/**@} libvlc_media_list */
183

184 185 186
/*****************************************************************************
 * Media Library
 *****************************************************************************/
187
/** \defgroup libvlc_media_library libvlc_media_library
188 189 190 191 192 193 194 195 196
 * \ingroup libvlc
 * LibVLC Media Library
 * @{
 */

typedef struct libvlc_media_library_t libvlc_media_library_t;

/**@} */

197 198 199
/*****************************************************************************
 * Playlist
 *****************************************************************************/
200
/** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
201
 * \ingroup libvlc
202 203
 * LibVLC Playlist handling (Deprecated)
 * @deprecated Use media_list
204 205 206
 * @{
 */

207 208
typedef struct libvlc_playlist_item_t
{
209 210 211 212 213 214 215 216 217 218 219 220
    int i_id;
    char * psz_uri;
    char * psz_name;

} libvlc_playlist_item_t;

/**@} */


/*****************************************************************************
 * Video
 *****************************************************************************/
221
/** \defgroup libvlc_video libvlc_video
222
 * \ingroup libvlc_media_player
223 224 225
 * LibVLC Video handling
 * @{
 */
226
 
227 228 229 230 231 232 233 234 235 236 237
/**
* Downcast to this general type as placeholder for a platform specific one, such as:
*  Drawable on X11,
*  CGrafPort on MacOSX,
*  HWND on win32
*/
typedef int libvlc_drawable_t;

/**
* Rectangle type for video geometry
*/
238
typedef struct libvlc_rectangle_t
239 240 241 242 243 244 245 246 247
{
    int top, left;
    int bottom, right;
}
libvlc_rectangle_t;

/**@} */


248 249 250
/*****************************************************************************
 * Services/Media Discovery
 *****************************************************************************/
251
/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
252 253 254 255 256 257 258 259 260
 * \ingroup libvlc
 * LibVLC Media Discoverer
 * @{
 */

typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;

/**@} */

261 262 263 264
/*****************************************************************************
 * Message log handling
 *****************************************************************************/

265
/** \defgroup libvlc_log libvlc_log
266
 * \ingroup libvlc_core
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
 * LibVLC Message Logging
 * @{
 */

/** This structure is opaque. It represents a libvlc log instance */
typedef struct libvlc_log_t libvlc_log_t;

/** This structure is opaque. It represents a libvlc log iterator */
typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;

typedef struct libvlc_log_message_t
{
    unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
    int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
    const char *psz_type;     /* module type */
    const char *psz_name;     /* module name */
    const char *psz_header;   /* optional header */
    const char *psz_message;  /* message */
} libvlc_log_message_t;

/**@} */

# ifdef __cplusplus
}
# endif

#endif