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 /*****************************************************************************
  84  * Playlist
  85  *****************************************************************************/
  86 /** defgroup libvlc_playlist Playlist
  87  * \ingroup libvlc
  88  * LibVLC Playlist handling
  89  * @{
  90  */
  91
  92 typedef struct {
  93     int i_id;
  94     char * psz_uri;
  95     char * psz_name;
  96
  97 } libvlc_playlist_item_t;
  98
  99 /**@} */
 100
 101
 102 /*****************************************************************************
 103  * Video
 104  *****************************************************************************/
 105 /** defgroup libvlc_video Video
 106  * \ingroup libvlc
 107  * LibVLC Video handling
 108  * @{
 109  */
 110
 111 /**
 112 * Downcast to this general type as placeholder for a platform specific one, such as:
 113 *  Drawable on X11,
 114 *  CGrafPort on MacOSX,
 115 *  HWND on win32
 116 */
 117 typedef int libvlc_drawable_t;
 118
 119 /**
 120 * Rectangle type for video geometry
 121 */
 122 typedef struct
 123 {
 124     int top, left;
 125     int bottom, right;
 126 }
 127 libvlc_rectangle_t;
 128
 129 /**@} */
 130
 131
 132 /*****************************************************************************
 133  * Message log handling
 134  *****************************************************************************/
 135
 136 /** defgroup libvlc_log Log
 137  * \ingroup libvlc
 138  * LibVLC Message Logging
 139  * @{
 140  */
 141
 142 /** This structure is opaque. It represents a libvlc log instance */
 143 typedef struct libvlc_log_t libvlc_log_t;
 144
 145 /** This structure is opaque. It represents a libvlc log iterator */
 146 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
 147
 148 typedef struct libvlc_log_message_t
 149 {
 150     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
 151     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
 152     const char *psz_type;     /* module type */
 153     const char *psz_name;     /* module name */
 154     const char *psz_header;   /* optional header */
 155     const char *psz_message;  /* message */
 156 } libvlc_log_message_t;
 157
 158 /**@} */
 159
 160 /*****************************************************************************
 161  * Callbacks handling
 162  *****************************************************************************/
 163
 164 /** defgroup libvlc_callbacks Callbacks
 165  * \ingroup libvlc
 166  * LibVLC Event Callbacks
 167  * @{
 168  */
 169
 170 /**
 171  * Available events:
 172  * - libvlc_VolumeChanged
 173  * - libvlc_InputPositionChanged
 174  */
 175
 176 typedef enum {
 177     libvlc_VolumeChanged,
 178     libvlc_InputPositionChanged,
 179 } libvlc_event_type_t;
 180
 181 typedef struct
 182 {
 183     libvlc_event_type_t type;
 184     union
 185     {
 186         struct
 187         {
 188             int new_volume;
 189         } volume_changed;
 190         struct
 191         {
 192             vlc_int64_t new_position;
 193         } input_position_changed;
 194     } u;
 195 } libvlc_event_t;
 196
 197 /**
 198  * Callback function notification
 199  * \param p_instance the libvlc instance
 200  * \param p_event the event triggering the callback
 201  * \param p_user_data user provided data
 202  */
 203
 204 typedef void ( *libvlc_callback_t )( struct libvlc_instance_t *, libvlc_event_t *, void * );
 205
 206 /**@} */
 207
 208 # ifdef __cplusplus
 209 }
 210 # endif
 211
 212 #endif