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

   1 /*****************************************************************************
   2  * control_structures.h: global header for mediacontrol
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
   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  * \defgroup mediacontrol_structures MediaControl Structures
  25  * Data structures used in the MediaControl API.
  26  *
  27  * @{
  28  */
  29
  30 #ifndef _VLC_CONTROL_STRUCTURES_H
  31 #define _VLC_CONTROL_STRUCTURES_H 1
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 #include <stdint.h>
  38
  39 /**
  40  * A position may have different origins:
  41  *  - absolute counts from the movie start
  42  *  - relative counts from the current position
  43  *  - modulo counts from the current position and wraps at the end of the movie
  44  */
  45 typedef enum  {
  46     mediacontrol_AbsolutePosition,
  47     mediacontrol_RelativePosition,
  48     mediacontrol_ModuloPosition
  49 } mediacontrol_PositionOrigin;
  50
  51 /**
  52  * Units available in mediacontrol Positions
  53  *  - ByteCount number of bytes
  54  *  - SampleCount number of frames
  55  *  - MediaTime time in milliseconds
  56  */
  57 typedef enum {
  58     mediacontrol_ByteCount,
  59     mediacontrol_SampleCount,
  60     mediacontrol_MediaTime
  61 } mediacontrol_PositionKey;
  62
  63 /**
  64  * Possible player status
  65  */
  66 typedef enum {
  67     mediacontrol_PlayingStatus, mediacontrol_PauseStatus,
  68     mediacontrol_ForwardStatus, mediacontrol_BackwardStatus,
  69     mediacontrol_InitStatus,    mediacontrol_EndStatus,
  70     mediacontrol_UndefinedStatus
  71 } mediacontrol_PlayerStatus;
  72
  73 /**
  74  * MediaControl Position
  75  */
  76 typedef struct {
  77     mediacontrol_PositionOrigin origin;
  78     mediacontrol_PositionKey key;
  79     vlc_int64_t value;
  80 } mediacontrol_Position;
  81
  82 /**
  83  * RGBPicture structure
  84  * This generic structure holds a picture in an encoding specified by type.
  85  */
  86 typedef struct {
  87     int  width;
  88     int  height;
  89     uint32_t type;
  90     vlc_int64_t date;
  91     int  size;
  92     char *data;
  93 } mediacontrol_RGBPicture;
  94
  95 /**
  96  * Playlist sequence
  97  * A simple list of strings.
  98  */
  99 typedef struct {
 100     int size;
 101     char **data;
 102 } mediacontrol_PlaylistSeq;
 103
 104 typedef struct {
 105     int code;
 106     char *message;
 107 } mediacontrol_Exception;
 108
 109 /**
 110  * Exception codes
 111  */
 112 #define mediacontrol_PositionKeyNotSupported    1
 113 #define mediacontrol_PositionOriginNotSupported 2
 114 #define mediacontrol_InvalidPosition            3
 115 #define mediacontrol_PlaylistException          4
 116 #define mediacontrol_InternalException          5
 117
 118 /**
 119  * Stream information
 120  * This structure allows to quickly get various informations about the stream.
 121  */
 122 typedef struct {
 123     mediacontrol_PlayerStatus streamstatus;
 124     char *url;         /* The URL of the current media stream */
 125     vlc_int64_t position;  /* actual location in the stream (in ms) */
 126     vlc_int64_t length;    /* total length of the stream (in ms) */
 127 } mediacontrol_StreamInformation;
 128
 129
 130 # ifdef __cplusplus
 131 }
 132 # endif
 133
 134 #endif
 135
 136 /** @} */