git.sesse.net Git - vlc/blob - include/vlc/libvlc_structures.h

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc_* new external API structures
   3  *****************************************************************************
   4  * Copyright (C) 1998-2007 the VideoLAN team
   5  * $Id $
   6  *
   7  * Authors: Filippo Carone <littlejohn@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 #ifndef _LIBVLC_STRUCTURES_H
  25 #define _LIBVLC_STRUCTURES_H 1
  26
  27 #include <vlc/vlc.h>
  28
  29 # ifdef __cplusplus
  30 extern "C" {
  31 # endif
  32
  33 /** This structure is opaque. It represents a libvlc instance */
  34 typedef struct libvlc_instance_t libvlc_instance_t;
  35
  36 /*****************************************************************************
  37  * Exceptions
  38  *****************************************************************************/
  39
  40 /** defgroup libvlc_exception Exceptions
  41  * \ingroup libvlc
  42  * LibVLC Exceptions handling
  43  * @{
  44  */
  45
  46 typedef struct
  47 {
  48     int b_raised;
  49     int i_code;
  50     char *psz_message;
  51 } libvlc_exception_t;
  52
  53 /**@} */
  54
  55 /*****************************************************************************
  56  * Media Descriptor
  57  *****************************************************************************/
  58 /** defgroup libvlc_media_descriptor MediaDescriptor
  59  * \ingroup libvlc
  60  * LibVLC Media Descriptor handling
  61  * @{
  62  */
  63
  64 /* Meta Handling */
  65 /** defgroup libvlc_meta Meta
  66  * \ingroup libvlc_media_descriptor
  67  * LibVLC Media Meta
  68  * @{
  69  */
  70
  71 typedef enum {
  72     libvlc_meta_Title,
  73     libvlc_meta_Artist
  74 } libvlc_meta_t;
  75
  76 /**@} */
  77
  78 typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t;
  79
  80 /**@} */
  81
  82 /*****************************************************************************
  83  * Media Instance
  84  *****************************************************************************/
  85 /** defgroup libvlc_media_instance MediaInstance
  86  * \ingroup libvlc
  87  * LibVLC Media Instance handling
  88  * @{
  89  */
  90
  91 typedef struct libvlc_media_instance_t libvlc_media_instance_t;
  92
  93 /**@} */
  94
  95
  96 /*****************************************************************************
  97  * Playlist
  98  *****************************************************************************/
  99 /** defgroup libvlc_playlist Playlist
 100  * \ingroup libvlc
 101  * LibVLC Playlist handling
 102  * @{
 103  */
 104
 105 typedef struct {
 106     int i_id;
 107     char * psz_uri;
 108     char * psz_name;
 109
 110 } libvlc_playlist_item_t;
 111
 112 /**@} */
 113
 114
 115 /*****************************************************************************
 116  * Video
 117  *****************************************************************************/
 118 /** defgroup libvlc_video Video
 119  * \ingroup libvlc
 120  * LibVLC Video handling
 121  * @{
 122  */
 123
 124 /**
 125 * Downcast to this general type as placeholder for a platform specific one, such as:
 126 *  Drawable on X11,
 127 *  CGrafPort on MacOSX,
 128 *  HWND on win32
 129 */
 130 typedef int libvlc_drawable_t;
 131
 132 /**
 133 * Rectangle type for video geometry
 134 */
 135 typedef struct
 136 {
 137     int top, left;
 138     int bottom, right;
 139 }
 140 libvlc_rectangle_t;
 141
 142 /**@} */
 143
 144
 145 /*****************************************************************************
 146  * Message log handling
 147  *****************************************************************************/
 148
 149 /** defgroup libvlc_log Log
 150  * \ingroup libvlc
 151  * LibVLC Message Logging
 152  * @{
 153  */
 154
 155 /** This structure is opaque. It represents a libvlc log instance */
 156 typedef struct libvlc_log_t libvlc_log_t;
 157
 158 /** This structure is opaque. It represents a libvlc log iterator */
 159 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
 160
 161 typedef struct libvlc_log_message_t
 162 {
 163     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
 164     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
 165     const char *psz_type;     /* module type */
 166     const char *psz_name;     /* module name */
 167     const char *psz_header;   /* optional header */
 168     const char *psz_message;  /* message */
 169 } libvlc_log_message_t;
 170
 171 /**@} */
 172
 173 /*****************************************************************************
 174  * Callbacks handling
 175  *****************************************************************************/
 176
 177 /** defgroup libvlc_callbacks Callbacks
 178  * \ingroup libvlc
 179  * LibVLC Event Callbacks
 180  * @{
 181  */
 182
 183 /**
 184  * Available events:
 185  * - libvlc_VolumeChanged
 186  * - libvlc_InputPositionChanged
 187  */
 188
 189 typedef enum {
 190     libvlc_VolumeChanged,
 191     libvlc_InputPositionChanged,
 192 } libvlc_event_type_t;
 193
 194 typedef struct
 195 {
 196     libvlc_event_type_t type;
 197     union
 198     {
 199         struct
 200         {
 201             int new_volume;
 202         } volume_changed;
 203         struct
 204         {
 205             vlc_int64_t new_position;
 206         } input_position_changed;
 207     } u;
 208 } libvlc_event_t;
 209
 210 /**
 211  * Callback function notification
 212  * \param p_instance the libvlc instance
 213  * \param p_event the event triggering the callback
 214  * \param p_user_data user provided data
 215  */
 216
 217 typedef void ( *libvlc_callback_t )( struct libvlc_instance_t *, libvlc_event_t *, void * );
 218
 219 /**@} */
 220
 221 # ifdef __cplusplus
 222 }
 223 # endif
 224
 225 #endif