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 VideoLAN
7 * $Id: input_ext-intf.h,v 1.77 2002/08/18 13:16:51 sigmunau Exp $
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
30 * Communication input -> interface
33 #define REQUESTED_MPEG 1
34 #define REQUESTED_A52 2
35 #define REQUESTED_LPCM 3
36 #define REQUESTED_NOAUDIO 255
38 #define OFFSETTOTIME_MAX_SIZE 10
40 /*****************************************************************************
41 * es_descriptor_t: elementary stream descriptor
42 *****************************************************************************
43 * Describes an elementary stream, and includes fields required to handle and
44 * demultiplex this elementary stream.
45 *****************************************************************************/
46 struct es_descriptor_t
48 u16 i_id; /* stream ID for PS, PID for TS */
49 u8 i_stream_id; /* stream ID defined in the PES */
50 vlc_fourcc_t i_fourcc; /* stream type */
51 u8 i_cat; /* stream category (audio, video, spu) */
52 int i_demux_fd; /* used to store demux device
54 char psz_desc[20]; /* description of ES: audio language
55 * for instance ; NULL if not
58 /* Demultiplexer information */
59 es_sys_t * p_demux_data;
60 pgrm_descriptor_t * p_pgrm; /* very convenient in the demultiplexer */
62 /* PES parser information */
63 pes_packet_t * p_pes; /* Current PES */
64 int i_pes_real_size; /* as indicated by the header */
66 /* Decoder information */
67 decoder_fifo_t * p_decoder_fifo;
69 count_t c_packets; /* total packets read */
70 count_t c_invalid_packets; /* invalid packets read */
73 /* Special PID values - note that the PID is only on 13 bits, and that values
74 * greater than 0x1fff have no meaning in a stream */
75 #define PROGRAM_ASSOCIATION_TABLE_PID 0x0000
76 #define CONDITIONNAL_ACCESS_TABLE_PID 0x0001 /* not used */
77 #define EMPTY_ID 0xffff /* empty record in a table */
80 /* ES Categories to be used by interface plugins */
81 #define UNKNOWN_ES 0x00
87 /*****************************************************************************
89 *****************************************************************************
90 * Describes a program and list associated elementary streams. It is build by
91 * the PSI decoder upon the informations carried in program map sections
92 *****************************************************************************/
93 struct pgrm_descriptor_t
95 /* Program characteristics */
96 u16 i_number; /* program number */
97 u8 i_version; /* version number */
98 vlc_bool_t b_is_ok; /* Is the description up to date ? */
100 /* Service Descriptor (program name) - DVB extension */
104 /* Synchronization information */
106 mtime_t cr_ref, sysdate_ref;
107 mtime_t last_cr; /* reference to detect unexpected stream
110 count_t c_average_count;
111 /* counter used to compute dynamic average values */
114 /* Demultiplexer data */
115 pgrm_sys_t * p_demux_data;
117 int i_es_number; /* size of the following array */
118 es_descriptor_t ** pp_es; /* array of pointers to ES */
123 #define SYNCHRO_START 1
124 #define SYNCHRO_REINIT 2
126 /*****************************************************************************
128 *****************************************************************************
129 * Attributes for current area (title for DVD)
130 *****************************************************************************/
133 /* selected area attributes */
134 int i_id; /* identificator for area */
135 off_t i_start; /* start offset of area */
136 off_t i_size; /* total size of the area
137 * (in arbitrary units) */
139 /* navigation parameters */
140 off_t i_tell; /* actual location in the area
141 * (in arbitrary units) */
142 off_t i_seek; /* next requested location
143 * (changed by the interface thread */
145 /* area subdivision */
146 int i_part_nb; /* number of parts (chapter for DVD)*/
147 int i_part; /* currently selected part */
150 /* offset to plugin related data */
155 * \brief A list of info items.
157 * Composes a linked list of name/value pairs intended to inform the
158 * user about the current stream
161 struct input_info_t {
173 * Pointer to next item in list, or NULL it at end of list
175 input_info_t * p_next;
179 * \brief A list of info categories.
181 * Composes a NULL terminated linked list of categories in which to
182 * place info about the stream.
184 * \see input_InfoCategory
186 struct input_info_category_t {
188 * The name of this category
193 * first element of a linked list containing info items
195 input_info_t * p_info;
198 * Pointer to next element in this list, or NULL if at end of list
200 input_info_category_t * p_next;
203 /*****************************************************************************
204 * stream_descriptor_t
205 *****************************************************************************
206 * Describes a stream and list its associated programs. Build upon
207 * the information carried in program association sections (for instance)
208 *****************************************************************************/
209 struct stream_descriptor_t
211 u16 i_stream_id; /* stream id */
212 vlc_bool_t b_changed; /* if stream has been changed,
213 we have to inform the interface */
214 vlc_mutex_t stream_lock; /* to be taken every time you read
215 * or modify stream, pgrm or es */
217 /* Input method data */
218 int i_method; /* input method for stream: file,
220 vlc_bool_t b_pace_control; /* can we read when we want ? */
221 vlc_bool_t b_seekable; /* can we do lseek() ? */
223 /* if (b_seekable) : */
225 input_area_t ** pp_areas; /* list of areas in stream == offset
226 * interval with own properties */
227 input_area_t * p_selected_area;
228 input_area_t * p_new_area; /* Newly selected area from
231 u32 i_mux_rate; /* the rate we read the stream (in
232 * units of 50 bytes/s) ; 0 if undef */
234 /* New status and rate requested by the interface */
235 int i_new_status, i_new_rate;
236 int b_new_mute; /* int because it can be -1 */
237 vlc_cond_t stream_wait; /* interface -> input in case of a
238 * status change request */
240 /* Demultiplexer data */
241 stream_sys_t * p_demux_data;
243 /* Programs descriptions */
244 int i_pgrm_number; /* size of the following array */
245 pgrm_descriptor_t ** pp_programs; /* array of pointers to pgrm */
246 pgrm_descriptor_t * p_selected_program; /* currently
248 pgrm_descriptor_t * p_new_program; /* Newly selected program */
249 /* ES descriptions */
251 es_descriptor_t ** pp_es; /* carried elementary streams */
252 int i_selected_es_number;
253 es_descriptor_t ** pp_selected_es; /* ES with a decoder */
254 es_descriptor_t * p_newly_selected_es; /* ES selected from
256 es_descriptor_t * p_removed_es; /* ES removed from the interface */
259 stream_ctrl_t control;
261 /* Optional stream output */
262 sout_instance_t * p_sout;
265 input_info_category_t * p_info;
268 count_t c_packets_read; /* packets read */
269 count_t c_packets_trashed; /* trashed packets */
272 /*****************************************************************************
274 *****************************************************************************
275 * Describes the current position in the stream.
276 *****************************************************************************/
277 struct stream_position_t
279 off_t i_tell; /* actual location in the area (in arbitrary units) */
280 off_t i_size; /* total size of the area (in arbitrary units) */
282 u32 i_mux_rate; /* the rate we read the stream (in
283 * units of 50 bytes/s) ; 0 if undef */
286 #define MUTE_NO_CHANGE -1
288 /*****************************************************************************
290 *****************************************************************************
291 * This structure includes all the local static variables of an input thread
292 *****************************************************************************/
293 struct input_thread_t
297 /* Thread properties */
302 ssize_t (* pf_read ) ( input_thread_t *, byte_t *, size_t );
303 int (* pf_set_program )( input_thread_t *, pgrm_descriptor_t * );
304 int (* pf_set_area )( input_thread_t *, input_area_t * );
305 void (* pf_seek ) ( input_thread_t *, off_t );
306 access_sys_t * p_access_data;
311 int (* pf_demux ) ( input_thread_t * );
312 int (* pf_rewind ) ( input_thread_t * );
313 /* NULL if we don't support going *
314 * backwards (it's gonna be fun) */
315 demux_sys_t * p_demux_data; /* data of the demux */
318 input_buffers_t *p_method_data; /* data of the packet manager */
319 data_buffer_t * p_data_buffer;
320 byte_t * p_current_data;
321 byte_t * p_last_data;
324 /* General stream description */
325 stream_descriptor_t stream;
337 /* The first figure is a general method that can be used in interface plugins ;
338 * The second figure is a detailed sub-method */
339 #define INPUT_METHOD_NONE 0x0 /* input thread is inactive */
340 #define INPUT_METHOD_FILE 0x10 /* stream is read from file p_source */
341 #define INPUT_METHOD_DISC 0x20 /* stream is read directly from disc */
342 #define INPUT_METHOD_DVD 0x21 /* stream is read from DVD */
343 #define INPUT_METHOD_VCD 0x22 /* stream is read from VCD */
344 #define INPUT_METHOD_NETWORK 0x30 /* stream is read from network */
345 #define INPUT_METHOD_UCAST 0x31 /* UDP unicast */
346 #define INPUT_METHOD_MCAST 0x32 /* UDP multicast */
347 #define INPUT_METHOD_BCAST 0x33 /* UDP broadcast */
348 #define INPUT_METHOD_VLAN_BCAST 0x34 /* UDP broadcast with VLANs */
349 #define INPUT_METHOD_SATELLITE 0x40 /* stream is read from a */
352 /* Status changing methods */
353 #define INPUT_STATUS_END 0
354 #define INPUT_STATUS_PLAY 1
355 #define INPUT_STATUS_PAUSE 2
356 #define INPUT_STATUS_FASTER 3
357 #define INPUT_STATUS_SLOWER 4
360 #define INPUT_SEEK_SET 0x00
361 #define INPUT_SEEK_CUR 0x01
362 #define INPUT_SEEK_END 0x02
363 #define INPUT_SEEK_BYTES 0x00
364 #define INPUT_SEEK_SECONDS 0x10
365 #define INPUT_SEEK_PERCENT 0x20
367 /*****************************************************************************
369 *****************************************************************************/
370 #define input_CreateThread(a,b,c) __input_CreateThread(VLC_OBJECT(a),b,c)
371 input_thread_t * __input_CreateThread ( vlc_object_t *,
372 playlist_item_t *, int * );
373 void input_StopThread ( input_thread_t * );
374 void input_DestroyThread ( input_thread_t * );
376 #define input_SetStatus(a,b) __input_SetStatus(VLC_OBJECT(a),b)
377 VLC_EXPORT( void, __input_SetStatus, ( vlc_object_t *, int ) );
379 #define input_Seek(a,b,c) __input_Seek(VLC_OBJECT(a),b,c)
380 VLC_EXPORT( void, __input_Seek, ( vlc_object_t *, off_t, int ) );
382 #define input_Tell(a,b) __input_Tell(VLC_OBJECT(a),b)
383 VLC_EXPORT( void, __input_Tell, ( vlc_object_t *, stream_position_t * ) );
385 VLC_EXPORT( void, input_DumpStream, ( input_thread_t * ) );
386 VLC_EXPORT( char *, input_OffsetToTime, ( input_thread_t *, char *, off_t ) );
387 VLC_EXPORT( int, input_ToggleES, ( input_thread_t *, es_descriptor_t *, vlc_bool_t ) );
388 VLC_EXPORT( int, input_ChangeArea, ( input_thread_t *, input_area_t * ) );
389 VLC_EXPORT( int, input_ChangeProgram, ( input_thread_t *, u16 ) );
391 int input_ToggleGrayscale( input_thread_t * );
392 int input_ToggleMute ( input_thread_t * );
394 #endif /* "input_ext-intf.h" */