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.27 2001/03/02 03:32:46 stef 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 *****************************************************************************/
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 #define OFFSETTOTIME_MAX_SIZE 10
38 /*****************************************************************************
39 * es_descriptor_t: elementary stream descriptor
40 *****************************************************************************
41 * Describes an elementary stream, and includes fields required to handle and
42 * demultiplex this elementary stream.
43 *****************************************************************************/
44 struct decoder_fifo_s; /* defined in input_ext-dec.h */
45 struct pgrm_descriptor_s;
47 typedef struct es_descriptor_s
49 u16 i_id; /* stream ID for PS, PID for TS */
50 u8 i_stream_id; /* stream ID defined in the PES */
51 u8 i_type; /* stream type */
52 boolean_t b_audio; /* is the stream an audio stream that
53 * will need to be discarded with
54 * fast forward and slow motion ? */
55 char psz_desc[20]; /* description of ES: audio language
56 * for instance ; NULL if not
59 /* Demultiplexer information */
61 struct pgrm_descriptor_s *
62 p_pgrm; /* very convenient in the demultiplexer */
64 /* PES parser information */
65 struct pes_packet_s * p_pes; /* Current PES */
66 struct data_packet_s * p_last; /* The last packet gathered at present */
67 int i_pes_real_size; /* as indicated by the header */
69 /* Decoder information */
70 struct decoder_fifo_s * p_decoder_fifo;
71 vlc_thread_t thread_id; /* ID of the decoder */
74 count_t c_payload_bytes;/* total of payload useful bytes */
75 count_t c_packets; /* total packets read */
76 count_t c_invalid_packets; /* invalid packets read */
80 /* Special PID values - note that the PID is only on 13 bits, and that values
81 * greater than 0x1fff have no meaning in a stream */
82 #define PROGRAM_ASSOCIATION_TABLE_PID 0x0000
83 #define CONDITIONNAL_ACCESS_TABLE_PID 0x0001 /* not used */
84 #define EMPTY_ID 0xffff /* empty record in a table */
86 /* ES streams types - see ISO/IEC 13818-1 table 2-29 numbers */
87 #define MPEG1_VIDEO_ES 0x01
88 #define MPEG2_VIDEO_ES 0x02
89 #define MPEG1_AUDIO_ES 0x03
90 #define MPEG2_AUDIO_ES 0x04
91 #define AC3_AUDIO_ES 0x81
92 /* These ones might violate the norm : */
93 #define DVD_SPU_ES 0x82
94 #define LPCM_AUDIO_ES 0x83
95 #define UNKNOWN_ES 0xFF
97 /*****************************************************************************
99 *****************************************************************************
100 * Describes a program and list associated elementary streams. It is build by
101 * the PSI decoder upon the informations carried in program map sections
102 *****************************************************************************/
103 typedef struct pgrm_descriptor_s
105 /* Program characteristics */
106 u16 i_number; /* program number */
107 u8 i_version; /* version number */
108 boolean_t b_is_ok; /* Is the description up to date ? */
110 /* Service Descriptor (program name) - DVB extension */
114 /* Synchronization information */
116 mtime_t cr_ref, sysdate_ref;
117 mtime_t last_cr; /* reference to detect unexpected stream
119 count_t c_average_count;
120 /* counter used to compute dynamic average values */
123 /* Demultiplexer data */
126 /* Decoders control */
127 struct vout_thread_s * p_vout;
128 struct aout_thread_s * p_aout;
130 int i_es_number; /* size of the following array */
131 es_descriptor_t ** pp_es; /* array of pointers to ES */
136 #define SYNCHRO_START 1
137 #define SYNCHRO_REINIT 2
139 /*****************************************************************************
141 *****************************************************************************
142 * Attributes for current area (title for DVD)
143 *****************************************************************************/
144 typedef struct input_area_s
146 /* selected area attributes */
147 int i_id; /* identificator for area */
148 off_t i_start; /* start offset of area */
149 off_t i_size; /* total size of the area
150 * (in arbitrary units) */
152 /* navigation parameters */
153 off_t i_tell; /* actual location in the area
154 * (in arbitrary units) */
155 off_t i_seek; /* next requested location
156 * (changed by the interface thread */
158 /* area subdivision */
159 int i_part_nb; /* number of parts (chapter for DVD)*/
160 int i_part; /* currently selected part */
162 /* offset to plugin related data */
166 /*****************************************************************************
167 * stream_descriptor_t
168 *****************************************************************************
169 * Describes a stream and list its associated programs. Build upon
170 * the information carried in program association sections (for instance)
171 *****************************************************************************/
172 typedef struct stream_descriptor_s
174 u16 i_stream_id; /* stream id */
175 vlc_mutex_t stream_lock; /* to be taken every time you read
176 * or modify stream, pgrm or es */
178 /* Input method data */
179 boolean_t b_pace_control; /* can we read when we want ? */
180 boolean_t b_seekable; /* can we do lseek() ? */
182 /* if (b_seekable) : */
184 input_area_t ** pp_areas; /* list of areas in stream == offset
185 * interval with own properties */
186 input_area_t * p_selected_area;
187 u32 i_mux_rate; /* the rate we read the stream (in
188 * units of 50 bytes/s) ; 0 if undef */
190 /* New status and rate requested by the interface */
191 int i_new_status, i_new_rate;
192 vlc_cond_t stream_wait; /* interface -> input in case of a
193 * status change request */
195 /* Demultiplexer data */
198 /* Programs descriptions */
199 int i_pgrm_number; /* size of the following array */
200 pgrm_descriptor_t ** pp_programs; /* array of pointers to pgrm */
202 /* ES descriptions */
204 es_descriptor_t ** pp_es; /* carried elementary streams */
205 int i_selected_es_number;
206 es_descriptor_t ** pp_selected_es; /* ES with a decoder */
209 stream_ctrl_t control;
210 } stream_descriptor_t;
212 /*****************************************************************************
214 *****************************************************************************
215 * This structure gives plugins pointers to the useful functions of input
216 *****************************************************************************/
217 struct input_thread_s;
218 struct data_packet_s;
219 struct es_descriptor_s;
221 typedef struct i_p_config_s
223 int (* pf_peek_stream)( struct input_thread_s *,
224 byte_t * buffer, size_t );
225 void (* pf_demux_pes)( struct input_thread_s *,
226 struct data_packet_s *,
227 struct es_descriptor_s *,
228 boolean_t b_unit_start,
229 boolean_t b_packet_lost );
232 /*****************************************************************************
234 *****************************************************************************
235 * This structure includes all the local static variables of an input thread
236 *****************************************************************************/
237 struct aout_thread_s;
238 struct vout_thread_s;
240 typedef struct input_thread_s
242 /* Thread properties and locks */
243 boolean_t b_die; /* 'die' flag */
246 vlc_thread_t thread_id; /* id for thread functions */
247 int * pi_status; /* temporary status flag */
250 struct module_s * p_input_module;
253 void (* pf_init)( struct input_thread_s * );
254 void (* pf_open)( struct input_thread_s * );
255 void (* pf_close)( struct input_thread_s * );
256 void (* pf_end)( struct input_thread_s * );
258 /* Read & Demultiplex */
259 int (* pf_read)( struct input_thread_s *,
260 struct data_packet_s * pp_packets[] );
261 void (* pf_demux)( struct input_thread_s *,
262 struct data_packet_s * );
264 /* Packet management facilities */
265 struct data_packet_s *(*pf_new_packet)( void *, size_t );
266 struct pes_packet_s *(* pf_new_pes)( void * );
267 void (* pf_delete_packet)( void *,
268 struct data_packet_s * );
269 void (* pf_delete_pes)( void *, struct pes_packet_s * );
271 /* Stream control capabilities */
272 int (* pf_rewind)( struct input_thread_s * );
273 /* NULL if we don't support going *
274 * backwards (it's gonna be fun) */
275 void (* pf_seek)( struct input_thread_s *, off_t );
277 i_p_config_t i_p_config; /* plugin configuration */
280 int i_handle; /* socket or file descriptor */
281 int i_read_once; /* number of packet read by
283 void * p_method_data; /* data of the packet manager */
284 void * p_plugin_data; /* data of the plugin */
286 /* General stream description */
287 stream_descriptor_t stream; /* PAT tables */
289 /* For auto-launch of decoders */
290 struct aout_thread_s * p_default_aout;
291 struct vout_thread_s * p_default_vout;
295 count_t c_bytes; /* bytes read */
296 count_t c_payload_bytes; /* payload useful bytes */
297 count_t c_packets_read; /* packets read */
298 count_t c_packets_trashed; /* trashed packets */
304 * Communication interface -> input
307 /*****************************************************************************
309 *****************************************************************************
310 * This structure is given by the interface to an input thread
311 *****************************************************************************/
312 typedef struct input_config_s
314 /* Input method description */
315 int i_method; /* input method */
316 char * p_source; /* source */
318 /* For auto-launch of decoders */
319 struct aout_thread_s * p_default_aout;
320 struct vout_thread_s * p_default_vout;
324 #define INPUT_METHOD_NONE 0 /* input thread is inactive */
325 #define INPUT_METHOD_FILE 10 /* stream is read from file p_source */
326 #define INPUT_METHOD_DVD 11 /* stream is read from dvd device */
327 #define INPUT_METHOD_UCAST 20 /* UDP unicast */
328 #define INPUT_METHOD_MCAST 21 /* UDP multicast */
329 #define INPUT_METHOD_BCAST 22 /* UDP broadcast */
330 #define INPUT_METHOD_VLAN_BCAST 32 /* UDP broadcast with VLANs */
332 /* Status changing methods */
333 #define INPUT_STATUS_END 0
334 #define INPUT_STATUS_PLAY 1
335 #define INPUT_STATUS_PAUSE 2
336 #define INPUT_STATUS_FASTER 3
337 #define INPUT_STATUS_SLOWER 4
339 /*****************************************************************************
341 *****************************************************************************/
342 struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
344 void input_DestroyThread( struct input_thread_s *, int *pi_status );
346 void input_SetStatus( struct input_thread_s *, int );
347 void input_SetRate ( struct input_thread_s *, int );
348 void input_Seek ( struct input_thread_s *, off_t );
349 void input_DumpStream( struct input_thread_s * );
350 char * input_OffsetToTime( struct input_thread_s *, char * psz_buffer, off_t );