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