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.89 2003/05/05 22:23:31 gbazin 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_DTS 4
37 #define REQUESTED_NOAUDIO 255
39 #define OFFSETTOTIME_MAX_SIZE 10
41 /*****************************************************************************
42 * es_descriptor_t: elementary stream descriptor
43 *****************************************************************************
44 * Describes an elementary stream, and includes fields required to handle and
45 * demultiplex this elementary stream.
46 *****************************************************************************/
47 struct es_descriptor_t
49 uint16_t i_id; /* stream ID for PS, PID for TS */
50 uint8_t i_stream_id; /* stream ID defined in the PES */
51 vlc_fourcc_t i_fourcc; /* stream type */
52 uint8_t i_cat; /* stream category (audio, video, spu) */
53 int i_demux_fd; /* used to store demux device
55 char *psz_desc; /* description of ES: audio language
56 * for instance ; NULL if not
59 /* Demultiplexer information */
60 es_sys_t * p_demux_data;
61 pgrm_descriptor_t * p_pgrm; /* very convenient in the demultiplexer */
63 /* PES parser information */
64 pes_packet_t * p_pes; /* Current PES */
65 unsigned int i_pes_real_size; /* as indicated by the header */
67 /* Decoder information */
68 decoder_fifo_t * p_decoder_fifo;
69 void * p_waveformatex;
70 void * p_bitmapinfoheader;
72 count_t c_packets; /* total packets read */
73 count_t c_invalid_packets; /* invalid packets read */
75 /* XXX hack: to force a decoder instead of mode based on sout */
76 vlc_bool_t b_force_decoder;
79 /* Special PID values - note that the PID is only on 13 bits, and that values
80 * greater than 0x1fff have no meaning in a stream */
81 #define PROGRAM_ASSOCIATION_TABLE_PID 0x0000
82 #define CONDITIONNAL_ACCESS_TABLE_PID 0x0001 /* not used */
83 #define EMPTY_ID 0xffff /* empty record in a table */
86 /* ES Categories to be used by interface plugins */
87 #define UNKNOWN_ES 0x00
93 /*****************************************************************************
95 *****************************************************************************
96 * Describes a program and list associated elementary streams. It is build by
97 * the PSI decoder upon the informations carried in program map sections
98 *****************************************************************************/
99 struct pgrm_descriptor_t
101 /* Program characteristics */
102 uint16_t i_number; /* program number */
103 uint8_t i_version; /* version number */
104 vlc_bool_t b_is_ok; /* Is the description up to date ? */
106 /* Service Descriptor (program name) - DVB extension */
110 /* Synchronization information */
112 mtime_t cr_ref, sysdate_ref;
113 mtime_t last_cr; /* reference to detect unexpected stream
116 count_t c_average_count;
117 /* counter used to compute dynamic average values */
120 /* Demultiplexer data */
121 pgrm_sys_t * p_demux_data;
123 unsigned int i_es_number; /* size of the following array */
124 es_descriptor_t ** pp_es; /* array of pointers to ES */
129 #define SYNCHRO_START 1
130 #define SYNCHRO_REINIT 2
132 /*****************************************************************************
134 *****************************************************************************
135 * Attributes for current area (title for DVD)
136 *****************************************************************************/
139 /* selected area attributes */
140 unsigned int i_id; /* identificator for area */
141 off_t i_start; /* start offset of area */
142 off_t i_size; /* total size of the area
143 * (in arbitrary units) */
145 /* navigation parameters */
146 off_t i_tell; /* actual location in the area
147 * (in arbitrary units) */
148 off_t i_seek; /* next requested location
149 * (changed by the interface thread */
151 /* area subdivision */
152 unsigned int i_part_nb; /* number of parts (chapter for DVD)*/
153 unsigned int i_part; /* currently selected part */
156 /* offset to plugin related data */
161 * \brief A list of info items.
163 * Composes a linked list of name/value pairs intended to inform the
164 * user about the current stream
167 struct input_info_t {
179 * Pointer to next item in list, or NULL it at end of list
181 input_info_t * p_next;
185 * \brief A list of info categories.
187 * Composes a NULL terminated linked list of categories in which to
188 * place info about the stream.
190 * \see input_InfoCategory
192 struct input_info_category_t {
194 * The name of this category
199 * first element of a linked list containing info items
201 input_info_t * p_info;
204 * Pointer to next element in this list, or NULL if at end of list
206 input_info_category_t * p_next;
209 /*****************************************************************************
210 * stream_descriptor_t
211 *****************************************************************************
212 * Describes a stream and list its associated programs. Build upon
213 * the information carried in program association sections (for instance)
214 *****************************************************************************/
215 struct stream_descriptor_t
217 uint16_t i_stream_id; /* stream id */
218 vlc_bool_t b_changed; /* if stream has been changed,
219 we have to inform the interface */
220 vlc_mutex_t stream_lock; /* to be taken every time you read
221 * or modify stream, pgrm or es */
223 /* Input method data */
224 unsigned int i_method; /* input method for stream: file,
226 vlc_bool_t b_pace_control; /* can we read when we want ? */
227 vlc_bool_t b_seekable; /* can we do lseek() ? */
229 /* if (b_seekable) : */
230 unsigned int i_area_nb;
231 input_area_t ** pp_areas; /* list of areas in stream == offset
232 * interval with own properties */
233 input_area_t * p_selected_area;
234 input_area_t * p_new_area; /* Newly selected area from
237 uint32_t i_mux_rate; /* the rate we read the stream (in
238 * units of 50 bytes/s) ; 0 if undef */
240 /* New status and rate requested by the interface */
241 unsigned int i_new_status, i_new_rate;
242 int b_new_mute; /* int because it can be -1 */
243 vlc_cond_t stream_wait; /* interface -> input in case of a
244 * status change request */
246 /* Demultiplexer data */
247 stream_sys_t * p_demux_data;
249 /* Programs descriptions */
250 unsigned int i_pgrm_number; /* size of the following array */
251 pgrm_descriptor_t ** pp_programs; /* array of pointers to pgrm */
252 pgrm_descriptor_t * p_selected_program; /* currently
254 pgrm_descriptor_t * p_new_program; /* Newly selected program */
255 /* ES descriptions */
256 unsigned int i_es_number;
257 es_descriptor_t ** pp_es; /* carried elementary streams */
258 unsigned int i_selected_es_number;
259 es_descriptor_t ** pp_selected_es; /* ES with a decoder */
260 es_descriptor_t * p_newly_selected_es; /* ES selected from
262 es_descriptor_t * p_removed_es; /* ES removed from the interface */
265 stream_ctrl_t control;
267 /* Optional stream output */
268 sout_instance_t * p_sout;
271 input_info_category_t * p_info;
274 count_t c_packets_read; /* packets read */
275 count_t c_packets_trashed; /* trashed packets */
278 /*****************************************************************************
280 *****************************************************************************
281 * Describes the current position in the stream.
282 *****************************************************************************/
283 struct stream_position_t
285 off_t i_tell; /* actual location in the area (in arbitrary units) */
286 off_t i_size; /* total size of the area (in arbitrary units) */
288 uint32_t i_mux_rate; /* the rate we read the stream (in
289 * units of 50 bytes/s) ; 0 if undef */
292 #define MUTE_NO_CHANGE -1
294 /*****************************************************************************
296 *****************************************************************************
297 * This structure includes all the local static variables of an input thread
298 *****************************************************************************/
299 struct input_thread_t
303 /* Thread properties */
308 ssize_t (* pf_read ) ( input_thread_t *, byte_t *, size_t );
309 int (* pf_set_program )( input_thread_t *, pgrm_descriptor_t * );
310 int (* pf_set_area )( input_thread_t *, input_area_t * );
311 void (* pf_seek ) ( input_thread_t *, off_t );
312 access_sys_t * p_access_data;
314 int i_pts_delay; /* internal caching */
318 int (* pf_demux ) ( input_thread_t * );
319 int (* pf_rewind ) ( input_thread_t * );
320 /* NULL if we don't support going *
321 * backwards (it's gonna be fun) */
322 demux_sys_t * p_demux_data; /* data of the demux */
325 input_buffers_t *p_method_data; /* data of the packet manager */
326 data_buffer_t * p_data_buffer;
327 byte_t * p_current_data;
328 byte_t * p_last_data;
331 /* General stream description */
332 stream_descriptor_t stream;
336 char * psz_dupsource;
345 /* The first figure is a general method that can be used in interface plugins ;
346 * The second figure is a detailed sub-method */
347 #define INPUT_METHOD_NONE 0x0 /* input thread is inactive */
348 #define INPUT_METHOD_FILE 0x10 /* stream is read from file p_source */
349 #define INPUT_METHOD_DISC 0x20 /* stream is read directly from disc */
350 #define INPUT_METHOD_DVD 0x21 /* stream is read from DVD */
351 #define INPUT_METHOD_VCD 0x22 /* stream is read from VCD */
352 #define INPUT_METHOD_NETWORK 0x30 /* stream is read from network */
353 #define INPUT_METHOD_UCAST 0x31 /* UDP unicast */
354 #define INPUT_METHOD_MCAST 0x32 /* UDP multicast */
355 #define INPUT_METHOD_BCAST 0x33 /* UDP broadcast */
356 #define INPUT_METHOD_VLAN_BCAST 0x34 /* UDP broadcast with VLANs */
357 #define INPUT_METHOD_SATELLITE 0x40 /* stream is read from a */
359 #define INPUT_METHOD_SLP 0x50 /* SLP stream */
361 /* Status changing methods */
362 #define INPUT_STATUS_END 0
363 #define INPUT_STATUS_PLAY 1
364 #define INPUT_STATUS_PAUSE 2
365 #define INPUT_STATUS_FASTER 3
366 #define INPUT_STATUS_SLOWER 4
369 #define INPUT_SEEK_SET 0x00
370 #define INPUT_SEEK_CUR 0x01
371 #define INPUT_SEEK_END 0x02
372 #define INPUT_SEEK_BYTES 0x00
373 #define INPUT_SEEK_SECONDS 0x10
374 #define INPUT_SEEK_PERCENT 0x20
376 /*****************************************************************************
378 *****************************************************************************/
379 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
380 input_thread_t * __input_CreateThread ( vlc_object_t *, playlist_item_t * );
381 void input_StopThread ( input_thread_t * );
382 void input_DestroyThread ( input_thread_t * );
384 #define input_SetStatus(a,b) __input_SetStatus(VLC_OBJECT(a),b)
385 VLC_EXPORT( void, __input_SetStatus, ( vlc_object_t *, int ) );
387 #define input_Seek(a,b,c) __input_Seek(VLC_OBJECT(a),b,c)
388 VLC_EXPORT( void, __input_Seek, ( vlc_object_t *, off_t, int ) );
390 #define input_Tell(a,b) __input_Tell(VLC_OBJECT(a),b)
391 VLC_EXPORT( void, __input_Tell, ( vlc_object_t *, stream_position_t * ) );
393 VLC_EXPORT( void, input_DumpStream, ( input_thread_t * ) );
394 VLC_EXPORT( char *, input_OffsetToTime, ( input_thread_t *, char *, off_t ) );
395 VLC_EXPORT( int, input_ToggleES, ( input_thread_t *, es_descriptor_t *, vlc_bool_t ) );
396 VLC_EXPORT( int, input_ChangeArea, ( input_thread_t *, input_area_t * ) );
397 VLC_EXPORT( int, input_ChangeProgram, ( input_thread_t *, uint16_t ) );
399 int input_ToggleGrayscale( input_thread_t * );
400 int input_ToggleMute ( input_thread_t * );
402 #endif /* "input_ext-intf.h" */