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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright (C) 2000 the xine project
*
* This file is part of xine, a unix video player.
*
* xine 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.
*
* xine 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
*
* $Id: input_plugin.h,v 1.8 2001/07/01 23:37:04 guenter Exp $
*/
#ifndef HAVE_INPUT_PLUGIN_H
#define HAVE_INPUT_PLUGIN_H
#include <inttypes.h>
#include <sys/types.h>
#include "buffer.h"
#include "configfile.h"
#define INPUT_PLUGIN_IFACE_VERSION 2
#ifndef CLUT_T
#define CLUT_T
typedef struct { /* CLUT == Color LookUp Table */
uint8_t foo : 8; /* UNKNOWN: 0x00? */
uint8_t y : 8;
uint8_t cr : 8;
uint8_t cb : 8;
} __attribute__ ((packed)) clut_t;
#endif
#define MAX_MRL_ENTRIES 255
/* Types of mrls returned by get_dir() */
#define mrl_unknown 0x0
#define mrl_dvd 0x1
#define mrl_vcd 0x3
#define mrl_net 0x4
#define mrl_rtp 0x5
#define mrl_stdin 0x6
#define mrl_fifo 0x7
#define mrl_chardev 0x8
#define mrl_directory 0x9
#define mrl_blockdev 0xA
#define mrl_normal 0xB
#define mrl_symbolic_link 0xC
#define mrl_sock 0xD
/* bit for exec file, should be combinated with mrl_normal type*/
#define mrl_type_exec 0xFFFF8000
typedef struct {
char *mrl; /* <type>://<location */
int type; /* match to mrl_type enum */
off_t size; /* size of this source, may be 0 */
} mrl_t;
typedef struct input_plugin_s input_plugin_t;
struct input_plugin_s
{
/*
* plugin interface version, lower versions _may_ be supported
*/
int interface_version;
/*
* return capabilities of input source
*/
uint32_t (*get_capabilities) (input_plugin_t *this);
/*
* open input MRL - return 1 if succ
*/
int (*open) (input_plugin_t *this, char *mrl);
/*
* read nlen bytes, return number of bytes read
*/
off_t (*read) (input_plugin_t *this, char *buf, off_t nlen);
/*
* read one block, return newly allocated block (or NULL on failure)
* for blocked input sources len must be == blocksize
* the fifo parameter is only used to get access to the buffer_pool_alloc function
*/
buf_element_t *(*read_block)(input_plugin_t *this, fifo_buffer_t *fifo, off_t len);
/*
* seek position, return new position
*
* if seeking failed, -1 is returned
*/
off_t (*seek) (input_plugin_t *this, off_t offset, int origin);
/*
* get current position in stream.
*
*/
off_t (*get_current_pos) (input_plugin_t *this);
/*
* return length of input (-1 => unlimited, e.g. stream)
*/
off_t (*get_length) (input_plugin_t *this);
/*
* return block size of input source (if supported, 0 otherwise)
*/
uint32_t (*get_blocksize) (input_plugin_t *this);
/*
* ls function
* return value: NULL => filename is a file, **char=> filename is a dir
*/
mrl_t** (*get_dir) (input_plugin_t *this, char *filename, int *nFiles);
/*
* eject/load the media (if it's possible)
*
* returns 0 for temporary failures
*/
int (*eject_media) (input_plugin_t *this);
/*
* return current MRL
*/
char * (*get_mrl) (input_plugin_t *this);
/*
* close input source
*/
void (*close) (input_plugin_t *this);
/*
* return human readable (verbose = 1 line) description for this plugin
*/
char* (*get_description) (input_plugin_t *this);
/*
* return short, human readable identifier for this plugin
* this is used for GUI buttons, The identifier must have max. 4 characters
* characters (max. 5 including terminating \0)
*/
char* (*get_identifier) (input_plugin_t *this);
/*
* generate autoplay list
* return value: list of MRLs
*/
char** (*get_autoplay_list) (input_plugin_t *this, int *nFiles);
/*
* Request optional datas from input plugin.
*/
int (*get_optional_data) (input_plugin_t *this, void *data, int data_type);
/*
* deliver an input event (mouse press/move, keypress)
* optional: may be NULL
*/
void (*handle_input_event) (input_plugin_t *this, int event_type, int key,
int x, int y);
/*
* check if it is possible/valid to directly branch to this MRL
* optional: may be NULL
*/
int (*is_branch_possible) (input_plugin_t *this, char *next_mrl);
};
/*
* possible capabilites an input plugin can have:
*/
#define INPUT_CAP_NOCAP 0x00000000
#define INPUT_CAP_SEEKABLE 0x00000001
#define INPUT_CAP_BLOCK 0x00000002
#define INPUT_CAP_AUTOPLAY 0x00000004
#define INPUT_CAP_GET_DIR 0x00000008
#define INPUT_CAP_BROWSABLE 0x00000010
#define INPUT_CAP_CLUT 0x00000020
#define INPUT_CAP_AUDIOLANG 0x00000040
#define INPUT_OPTIONAL_UNSUPPORTED 0
#define INPUT_OPTIONAL_SUCCESS 1
#define INPUT_OPTIONAL_DATA_CLUT 1
#define INPUT_OPTIONAL_DATA_AUDIOLANG 2
#define INPUT_EVENT_MOUSEBUTTON 1
#define INPUT_EVENT_KEYPRESS 2
#define INPUT_EVENT_MOUSEMOVE 3
#endif
|
