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.12 2001/02/07 15:32:25 massiot Exp $
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 *****************************************************************************/
27 * Communication input -> interface
29 #define INPUT_MAX_PLUGINS 1
31 #define REQUESTED_MPEG 1
32 #define REQUESTED_AC3 2
33 #define REQUESTED_LPCM 3
34 #define REQUESTED_NOAUDIO 255
36 /*****************************************************************************
37 * es_descriptor_t: elementary stream descriptor
38 *****************************************************************************
39 * Describes an elementary stream, and includes fields required to handle and
40 * demultiplex this elementary stream.
41 *****************************************************************************/
42 struct decoder_fifo_s; /* defined in input_ext-dec.h */
43 struct pgrm_descriptor_s;
45 typedef struct es_descriptor_s
47 u16 i_id; /* stream ID for PS, PID for TS */
48 u8 i_stream_id; /* stream ID defined in the PES */
49 u8 i_type; /* stream type */
50 boolean_t b_audio; /* is the stream an audio stream that
51 * will need to be discarded with
52 * fast forward and slow motion ? */
54 /* Demultiplexer information */
56 struct pgrm_descriptor_s *
57 p_pgrm; /* very convenient in the demultiplexer */
59 /* PES parser information */
60 struct pes_packet_s * p_pes; /* Current PES */
61 struct data_packet_s * p_last; /* The last packet gathered at present */
62 int i_pes_real_size; /* as indicated by the header */
63 boolean_t b_discontinuity; /* Stream changed */
65 /* Decoder information */
66 struct decoder_fifo_s * p_decoder_fifo;
67 vlc_thread_t thread_id; /* ID of the decoder */
70 count_t c_payload_bytes;/* total of payload useful bytes */
71 count_t c_packets; /* total packets read */
72 count_t c_invalid_packets; /* invalid packets read */
76 /* Special PID values - note that the PID is only on 13 bits, and that values
77 * greater than 0x1fff have no meaning in a stream */
78 #define PROGRAM_ASSOCIATION_TABLE_PID 0x0000
79 #define CONDITIONNAL_ACCESS_TABLE_PID 0x0001 /* not used */
80 #define EMPTY_ID 0xffff /* empty record in a table */
82 /* ES streams types - see ISO/IEC 13818-1 table 2-29 numbers */
83 #define MPEG1_VIDEO_ES 0x01
84 #define MPEG2_VIDEO_ES 0x02
85 #define MPEG1_AUDIO_ES 0x03
86 #define MPEG2_AUDIO_ES 0x04
87 #define AC3_AUDIO_ES 0x81
88 /* These ones might violate the norm : */
89 #define DVD_SPU_ES 0x82
90 #define LPCM_AUDIO_ES 0x83
91 #define UNKNOWN_ES 0xFF
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 typedef struct pgrm_descriptor_s
101 /* Program characteristics */
102 u16 i_number; /* program number */
103 u8 i_version; /* version number */
104 boolean_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
115 count_t c_average_count;
116 /* counter used to compute dynamic average values */
118 boolean_t b_discontinuity;
120 /* Demultiplexer data */
123 /* Decoders control */
124 struct vout_thread_s * p_vout;
125 struct aout_thread_s * p_aout;
127 int i_es_number; /* size of the following array */
128 es_descriptor_t ** pp_es; /* array of pointers to ES */
133 #define SYNCHRO_START 1
134 #define SYNCHRO_REINIT 2
136 /*****************************************************************************
137 * stream_descriptor_t
138 *****************************************************************************
139 * Describes a stream and list its associated programs. Build upon
140 * the information carried in program association sections (for instance)
141 *****************************************************************************/
142 typedef struct stream_descriptor_s
144 u16 i_stream_id; /* stream id */
145 vlc_mutex_t stream_lock; /* to be taken every time you read
146 * or modify stream, pgrm or es */
148 /* Input method data */
149 boolean_t b_pace_control; /* can we read when we want ? */
150 boolean_t b_seekable; /* can we do lseek() ? */
151 /* if (b_seekable) : */
152 off_t i_size; /* total size of the file
153 * (in arbitrary units) */
154 off_t i_tell; /* actual location in the file
155 * (in arbitrary units) */
156 off_t i_seek; /* next requested location (changed
157 * by the interface thread */
159 /* New status and rate requested by the interface */
160 int i_new_status, i_new_rate;
162 /* Demultiplexer data */
165 /* Programs descriptions */
166 int i_pgrm_number; /* size of the following array */
167 pgrm_descriptor_t ** pp_programs; /* array of pointers to pgrm */
169 /* ES descriptions */
171 es_descriptor_t ** pp_es; /* carried elementary streams */
172 int i_selected_es_number;
173 es_descriptor_t ** pp_selected_es; /* ES with a decoder */
176 stream_ctrl_t control;
177 } stream_descriptor_t;
179 /*****************************************************************************
181 *****************************************************************************
182 * This structure gives plugins pointers to the useful functions of input
183 *****************************************************************************/
184 struct input_thread_s;
185 struct data_packet_s;
186 struct es_descriptor_s;
188 typedef struct i_p_config_s
190 int (* pf_peek_stream)( struct input_thread_s *,
191 byte_t * buffer, size_t );
192 void (* pf_demux_pes)( struct input_thread_s *,
193 struct data_packet_s *,
194 struct es_descriptor_s *,
195 boolean_t b_unit_start,
196 boolean_t b_packet_lost );
199 /*****************************************************************************
201 *****************************************************************************
202 * This structure includes all the local static variables of an input thread
203 *****************************************************************************/
204 struct aout_thread_s;
205 struct vout_thread_s;
207 typedef struct input_thread_s
209 /* Thread properties and locks */
210 boolean_t b_die; /* 'die' flag */
212 vlc_thread_t thread_id; /* id for thread functions */
213 int * pi_status; /* temporary status flag */
215 struct input_config_s * p_config;
217 struct input_capabilities_s *
218 pp_plugins[INPUT_MAX_PLUGINS];/* list of plugins */
219 struct input_capabilities_s *
220 p_plugin; /* selected plugin */
221 i_p_config_t i_p_config; /* plugin configuration */
223 int i_handle; /* socket or file descriptor */
224 void * p_method_data; /* data of the packet manager */
225 void * p_plugin_data; /* data of the plugin */
227 /* General stream description */
228 stream_descriptor_t stream; /* PAT tables */
230 /* For auto-launch of decoders */
231 struct aout_thread_s * p_default_aout;
232 struct vout_thread_s * p_default_vout;
236 count_t c_bytes; /* bytes read */
237 count_t c_payload_bytes; /* payload useful bytes */
238 count_t c_packets_read; /* packets read */
239 count_t c_packets_trashed; /* trashed packets */
245 * Communication interface -> input
248 /*****************************************************************************
250 *****************************************************************************
251 * This structure is given by the interface to an input thread
252 *****************************************************************************/
253 typedef struct input_config_s
255 /* Input method description */
256 int i_method; /* input method */
257 char * p_source; /* source */
259 /* For auto-launch of decoders */
260 struct aout_thread_s * p_default_aout;
261 struct vout_thread_s * p_default_vout;
265 #define INPUT_METHOD_NONE 0 /* input thread is inactive */
266 #define INPUT_METHOD_FILE 10 /* stream is read from file p_source */
267 #define INPUT_METHOD_DVD 11 /* stream is read from dvd device */
268 #define INPUT_METHOD_UCAST 20 /* UDP unicast */
269 #define INPUT_METHOD_MCAST 21 /* UDP multicast */
270 #define INPUT_METHOD_BCAST 22 /* UDP broadcast */
271 #define INPUT_METHOD_VLAN_BCAST 32 /* UDP broadcast with VLANs */
273 /*****************************************************************************
275 *****************************************************************************/
276 struct input_thread_s * input_CreateThread( struct input_config_s *,
278 void input_DestroyThread( struct input_thread_s *,
280 void input_PauseProgram( struct input_thread_s *,
281 struct pgrm_descriptor_s * );
282 void input_PlayProgram( struct input_thread_s *,
283 struct pgrm_descriptor_s * );
284 void input_FFProgram( struct input_thread_s *,
285 struct pgrm_descriptor_s * );
286 void input_SMProgram( struct input_thread_s *,
287 struct pgrm_descriptor_s * );
288 void input_RewindProgram( struct input_thread_s *,
289 struct pgrm_descriptor_s * );