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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
|
/*
* 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.12 2001/08/17 16:15:36 f1rmb Exp $
*/
#ifndef HAVE_INPUT_PLUGIN_H
#define HAVE_INPUT_PLUGIN_H
#ifdef __cplusplus
extern "C" {
#endif
#include <inttypes.h>
#include <sys/types.h>
#include <assert.h>
#include "buffer.h"
#include "configfile.h"
#define INPUT_PLUGIN_IFACE_VERSION 3
/*
* Return pointer of allocate/cleaned memory size *size*.
*/
extern void *xmalloc(size_t);
#define MAX_MRL_ENTRIES 255
/* Types of mrls returned by get_dir() */
#define mrl_unknown (0 << 0)
#define mrl_dvd (1 << 0)
#define mrl_vcd (1 << 1)
#define mrl_net (1 << 2)
#define mrl_rtp (1 << 3)
#define mrl_stdin (1 << 4)
#define mrl_file (1 << 5)
#define mrl_file_fifo (1 << 6)
#define mrl_file_chardev (1 << 7)
#define mrl_file_directory (1 << 8)
#define mrl_file_blockdev (1 << 9)
#define mrl_file_normal (1 << 10)
#define mrl_file_symlink (1 << 11)
#define mrl_file_sock (1 << 12)
#define mrl_file_exec (1 << 13)
#define mrl_file_backup (1 << 14)
#define mrl_file_hidden (1 << 15)
/*
* Freeing/zeroing all of entries of given mrl.
*/
#define MRL_ZERO(m) { \
if((m)) { \
if((m)->origin) \
free((m)->origin); \
if((m)->mrl) \
free((m)->mrl); \
if((m)->link) \
free((m)->link); \
(m)->origin = NULL; \
(m)->mrl = NULL; \
(m)->link = NULL; \
(m)->type = 0; \
(m)->size = (off_t) 0; \
} \
}
/*
* Duplicate two mrls entries (s = source, d = destination).
*/
#define MRL_DUPLICATE(s, d) { \
assert((s) != NULL); \
assert((d) != NULL); \
\
if((s)->origin) { \
if((d)->origin) { \
(d)->origin = (char *) realloc((d)->origin, strlen((s)->origin) + 1); \
sprintf((d)->origin, "%s", (s)->origin); \
} \
else \
(d)->origin = strdup((s)->origin); \
} \
else \
(d)->origin = NULL; \
\
if((s)->mrl) { \
if((d)->mrl) { \
(d)->mrl = (char *) realloc((d)->mrl, strlen((s)->mrl) + 1); \
sprintf((d)->mrl, "%s", (s)->mrl); \
} \
else \
(d)->mrl = strdup((s)->mrl); \
} \
else \
(d)->mrl = NULL; \
\
if((s)->link) { \
if((d)->link) { \
(d)->link = (char *) realloc((d)->link, strlen((s)->link) + 1); \
sprintf((d)->link, "%s", (s)->link); \
} \
else \
(d)->link = strdup((s)->link); \
} \
else \
(d)->link = NULL; \
\
(d)->type = (s)->type; \
(d)->size = (s)->size; \
}
/*
* Duplicate two arrays of mrls (s = source, d = destination).
*/
#define MRLS_DUPLICATE(s, d) { \
int i = 0; \
\
assert((s) != NULL); \
assert((d) != NULL); \
\
while((s) != NULL) { \
d[i] = (mrl_t *) malloc(sizeof(mrl_t)); \
MRL_DUPLICATE(s[i], d[i]); \
i++; \
} \
}
typedef struct {
char *origin; /* Origin of grabbed mrls (eg: path for file plugin */
char *mrl; /* <type>://<location> */
char *link; /* name of link, if exist, otherwise NULL */
uint32_t 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);
/*
* stop input source
*/
void (*stop) (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
#ifdef __cplusplus
}
#endif
#endif
|
