1 /*****************************************************************************
2 * input_ext-intf.h: structures of the input exported to the interface
3 * This header provides structures to read the stream descriptors and
4 * control the pace of reading.
5 *****************************************************************************
6 * Copyright (C) 1999, 2000, 2003 VideoLAN
9 * Authors: Christophe Massiot <massiot@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 #ifndef _VLC_INPUT_EXT_INTF_H
27 #define _VLC_INPUT_EXT_INTF_H 1
29 #include "vlc_block.h"
33 * Communication input -> interface
36 #define REQUESTED_MPEG 1
37 #define REQUESTED_A52 2
38 #define REQUESTED_LPCM 3
39 #define REQUESTED_DTS 4
40 #define REQUESTED_NOAUDIO 255
42 /*****************************************************************************
43 * es_descriptor_t: elementary stream descriptor
44 *****************************************************************************
45 * Describes an elementary stream, and includes fields required to handle and
46 * demultiplex this elementary stream.
47 *****************************************************************************/
48 struct es_descriptor_t
50 uint16_t i_id; /* stream ID for PS, PID for TS */
51 uint8_t i_stream_id; /* stream ID defined in the PES */
52 vlc_fourcc_t i_fourcc; /* stream type */
53 uint8_t i_cat; /* stream category (audio, video, spu) */
54 int i_demux_fd; /* used to store demux device
56 char *psz_desc; /* description of ES: audio language
57 * for instance ; NULL if not
60 /* Demultiplexer information */
61 es_sys_t * p_demux_data;
62 pgrm_descriptor_t * p_pgrm; /* very convenient in the demultiplexer */
64 /* PES parser information */
65 pes_packet_t * p_pes; /* Current PES */
66 unsigned int i_pes_real_size; /* as indicated by the header */
68 /* Decoder information */
70 void * p_waveformatex;
71 void * p_bitmapinfoheader;
76 count_t c_packets; /* total packets read */
77 count_t c_invalid_packets; /* invalid packets read */
79 /* XXX hack: to force a decoder instead of mode based on sout */
80 vlc_bool_t b_force_decoder;
83 /* Special PID values - note that the PID is only on 13 bits, and that values
84 * greater than 0x1fff have no meaning in a stream */
85 #define PROGRAM_ASSOCIATION_TABLE_PID 0x0000
86 #define CONDITIONNAL_ACCESS_TABLE_PID 0x0001 /* not used */
87 #define EMPTY_ID 0xffff /* empty record in a table */
89 /*****************************************************************************
91 *****************************************************************************
92 * Describes a program and list associated elementary streams. It is build by
93 * the PSI decoder upon the informations carried in program map sections
94 *****************************************************************************/
95 struct pgrm_descriptor_t
97 /* Program characteristics */
98 uint16_t i_number; /* program number */
99 uint8_t i_version; /* version number */
100 vlc_bool_t b_is_ok; /* Is the description up to date ? */
102 /* Service Descriptor (program name) - DVB extension */
106 /* Synchronization information */
108 mtime_t cr_ref, sysdate_ref;
109 mtime_t last_cr; /* reference to detect unexpected stream
112 count_t c_average_count;
113 /* counter used to compute dynamic average values */
116 /* Demultiplexer data */
117 pgrm_sys_t * p_demux_data;
119 unsigned int i_es_number; /* size of the following array */
120 es_descriptor_t ** pp_es; /* array of pointers to ES */
125 #define SYNCHRO_START 1
126 #define SYNCHRO_REINIT 2
128 /*****************************************************************************
130 *****************************************************************************
131 * Attributes for current area (title for DVD)
132 *****************************************************************************/
135 /* selected area attributes */
136 unsigned int i_id; /* identificator for area */
137 off_t i_start; /* start offset of area */
138 off_t i_size; /* total size of the area
139 * (in arbitrary units) */
141 /* navigation parameters */
142 off_t i_tell; /* actual location in the area
143 * (in arbitrary units) */
144 off_t i_seek; /* next requested location
145 * (changed by the interface thread */
147 /* area subdivision */
148 unsigned int i_part_nb; /* number of parts (chapter for DVD)*/
149 unsigned int i_part; /* currently selected part */
152 /* offset to plugin related data */
156 /*****************************************************************************
157 * stream_descriptor_t
158 *****************************************************************************
159 * Describes a stream and list its associated programs. Build upon
160 * the information carried in program association sections (for instance)
161 *****************************************************************************/
162 struct stream_descriptor_t
164 uint16_t i_stream_id; /* stream id */
165 vlc_bool_t b_changed; /* if stream has been changed,
166 we have to inform the interface */
167 vlc_mutex_t stream_lock; /* to be taken every time you read
168 * or modify stream, pgrm or es */
170 /* Input method data */
171 unsigned int i_method; /* input method for stream: file,
173 vlc_bool_t b_pace_control; /* can we read when we want ? */
174 vlc_bool_t b_seekable; /* can we do lseek() ? */
176 /* if (b_seekable) : */
177 unsigned int i_area_nb;
178 input_area_t ** pp_areas; /* list of areas in stream == offset
179 * interval with own properties */
180 input_area_t * p_selected_area;
181 input_area_t * p_new_area; /* Newly selected area from
184 uint32_t i_mux_rate; /* the rate we read the stream (in
185 * units of 50 bytes/s) ; 0 if undef */
187 /* New status and rate requested by the interface */
188 unsigned int i_new_status, i_new_rate;
189 int b_new_mute; /* int because it can be -1 */
190 vlc_cond_t stream_wait; /* interface -> input in case of a
191 * status change request */
192 /* Demultiplexer data */
195 /* Programs descriptions */
196 unsigned int i_pgrm_number; /* size of the following array */
197 pgrm_descriptor_t ** pp_programs; /* array of pointers to pgrm */
198 pgrm_descriptor_t * p_selected_program; /* currently
200 pgrm_descriptor_t * p_new_program; /* Newly selected program */
201 /* ES descriptions */
202 unsigned int i_es_number;
203 es_descriptor_t ** pp_es; /* carried elementary streams */
204 unsigned int i_selected_es_number;
205 es_descriptor_t ** pp_selected_es; /* ES with a decoder */
206 es_descriptor_t * p_newly_selected_es; /* ES selected from
208 es_descriptor_t * p_removed_es; /* ES removed from the interface */
211 stream_ctrl_t control;
213 /* Optional stream output */
214 sout_instance_t * p_sout;
217 count_t c_packets_read; /* packets read */
218 count_t c_packets_trashed; /* trashed packets */
221 /*****************************************************************************
223 *****************************************************************************
224 * Describes the current position in the stream.
225 *****************************************************************************/
226 struct stream_position_t
228 off_t i_tell; /* actual location in the area (in arbitrary units) */
229 off_t i_size; /* total size of the area (in arbitrary units) */
231 uint32_t i_mux_rate; /* the rate we read the stream (in
232 * units of 50 bytes/s) ; 0 if undef */
235 #define MUTE_NO_CHANGE -1
237 /*****************************************************************************
239 *****************************************************************************/
247 char *psz_name; /**< Name of this info */
248 char *psz_value; /**< Value of the info */
255 struct info_category_t
257 char *psz_name; /**< Name of this category */
258 int i_infos; /**< Number of infos in the category */
259 struct info_t **pp_infos; /**< Pointer to an array of infos */
262 /*****************************************************************************
264 *****************************************************************************
265 * Describes an input and is used to spawn input_thread_t objects.
266 *****************************************************************************/
269 char *psz_name; /**< text describing this item */
270 char *psz_uri; /**< mrl of this item */
272 int i_options; /**< Number of input options */
273 char **ppsz_options; /**< Array of input options */
275 mtime_t i_duration; /**< A hint about the duration of this
276 * item, in milliseconds*/
278 int i_categories; /**< Number of info categories */
279 info_category_t **pp_categories; /**< Pointer to the first info category */
281 vlc_mutex_t lock; /**< Item cannot be changed without this lock */
284 /*****************************************************************************
286 *****************************************************************************
287 * This structure includes all the local static variables of an input thread
288 *****************************************************************************/
289 struct input_thread_t
293 /* Thread properties */
295 vlc_bool_t b_out_pace_control;
299 ssize_t (* pf_read ) ( input_thread_t *, byte_t *, size_t );
300 int (* pf_set_program )( input_thread_t *, pgrm_descriptor_t * );
301 int (* pf_set_area )( input_thread_t *, input_area_t * );
302 void (* pf_seek ) ( input_thread_t *, off_t );
303 access_sys_t * p_access_data;
305 int i_pts_delay; /* internal caching */
313 int (* pf_demux ) ( input_thread_t * );
314 int (* pf_rewind ) ( input_thread_t * );
315 /* NULL if we don't support going *
316 * backwards (it's gonna be fun) */
317 int (* pf_demux_control ) ( input_thread_t *, int, va_list );
318 demux_sys_t * p_demux_data; /* data of the demux */
324 input_buffers_t *p_method_data; /* data of the packet manager */
325 data_buffer_t * p_data_buffer;
326 byte_t * p_current_data;
327 byte_t * p_last_data;
330 /* General stream description */
331 stream_descriptor_t stream;
333 /* Input item description */
334 input_item_t *p_item;
338 char * psz_dupsource;
347 seekpoint_t **pp_bookmarks;
349 /* private, do not touch it */
350 input_thread_sys_t *p_sys;
354 /* The first figure is a general method that can be used in interface plugins ;
355 * The second figure is a detailed sub-method */
356 #define INPUT_METHOD_NONE 0x0 /* input thread is inactive */
357 #define INPUT_METHOD_FILE 0x10 /* stream is read from file p_source */
358 #define INPUT_METHOD_DISC 0x20 /* stream is read directly from disc */
359 #define INPUT_METHOD_DVD 0x21 /* stream is read from DVD */
360 #define INPUT_METHOD_VCD 0x22 /* stream is read from VCD */
361 #define INPUT_METHOD_CDDA 0x23 /* stream is read from CDDA */
362 #define INPUT_METHOD_NETWORK 0x30 /* stream is read from network */
363 #define INPUT_METHOD_UCAST 0x31 /* UDP unicast */
364 #define INPUT_METHOD_MCAST 0x32 /* UDP multicast */
365 #define INPUT_METHOD_BCAST 0x33 /* UDP broadcast */
366 #define INPUT_METHOD_VLAN_BCAST 0x34 /* UDP broadcast with VLANs */
367 #define INPUT_METHOD_SATELLITE 0x40 /* stream is read from a */
369 #define INPUT_METHOD_SLP 0x50 /* SLP stream */
371 /* Status changing methods */
372 #define INPUT_STATUS_END 0
373 #define INPUT_STATUS_PLAY 1
374 #define INPUT_STATUS_PAUSE 2
375 #define INPUT_STATUS_FASTER 3
376 #define INPUT_STATUS_SLOWER 4
379 #define INPUT_SEEK_SET 0x00
380 #define INPUT_SEEK_CUR 0x01
381 #define INPUT_SEEK_END 0x02
382 #define INPUT_SEEK_BYTES 0x00
383 #define INPUT_SEEK_SECONDS 0x10
384 #define INPUT_SEEK_PERCENT 0x20
386 /*****************************************************************************
388 *****************************************************************************/
389 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
390 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
391 VLC_EXPORT( void, input_StopThread, ( input_thread_t * ) );
392 VLC_EXPORT( void, input_DestroyThread, ( input_thread_t * ) );
394 #define input_SetStatus(a,b) __input_SetStatus(VLC_OBJECT(a),b)
395 VLC_EXPORT( void, __input_SetStatus, ( vlc_object_t *, int ) );
397 #define input_SetRate(a,b) __input_SetRate(VLC_OBJECT(a),b)
398 VLC_EXPORT( void, __input_SetRate, ( vlc_object_t *, int ) );
400 #define input_Seek(a,b,c) __input_Seek(VLC_OBJECT(a),b,c)
401 VLC_EXPORT( void, __input_Seek, ( vlc_object_t *, off_t, int ) );
403 #define input_Tell(a,b) __input_Tell(VLC_OBJECT(a),b)
404 VLC_EXPORT( void, __input_Tell, ( vlc_object_t *, stream_position_t * ) );
406 VLC_EXPORT( void, input_DumpStream, ( input_thread_t * ) );
407 VLC_EXPORT( char *, input_OffsetToTime, ( input_thread_t *, char *, off_t ) );
408 VLC_EXPORT( int, input_ToggleES, ( input_thread_t *, es_descriptor_t *, vlc_bool_t ) );
409 VLC_EXPORT( int, input_ChangeArea, ( input_thread_t *, input_area_t * ) );
410 VLC_EXPORT( int, input_ChangeProgram, ( input_thread_t *, uint16_t ) );
412 int input_ToggleGrayscale( input_thread_t * );
413 int input_ToggleMute ( input_thread_t * );
415 #endif /* "input_ext-intf.h" */