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.20 2001/02/16 06:37:09 sam 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 /*****************************************************************************
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 */
64 /* Decoder information */
65 struct decoder_fifo_s * p_decoder_fifo;
66 vlc_thread_t thread_id; /* ID of the decoder */
69 count_t c_payload_bytes;/* total of payload useful bytes */
70 count_t c_packets; /* total packets read */
71 count_t c_invalid_packets; /* invalid packets read */
75 /* Special PID values - note that the PID is only on 13 bits, and that values
76 * greater than 0x1fff have no meaning in a stream */
77 #define PROGRAM_ASSOCIATION_TABLE_PID 0x0000
78 #define CONDITIONNAL_ACCESS_TABLE_PID 0x0001 /* not used */
79 #define EMPTY_ID 0xffff /* empty record in a table */
81 /* ES streams types - see ISO/IEC 13818-1 table 2-29 numbers */
82 #define MPEG1_VIDEO_ES 0x01
83 #define MPEG2_VIDEO_ES 0x02
84 #define MPEG1_AUDIO_ES 0x03
85 #define MPEG2_AUDIO_ES 0x04
86 #define AC3_AUDIO_ES 0x81
87 /* These ones might violate the norm : */
88 #define DVD_SPU_ES 0x82
89 #define LPCM_AUDIO_ES 0x83
90 #define UNKNOWN_ES 0xFF
92 /*****************************************************************************
94 *****************************************************************************
95 * Describes a program and list associated elementary streams. It is build by
96 * the PSI decoder upon the informations carried in program map sections
97 *****************************************************************************/
98 typedef struct pgrm_descriptor_s
100 /* Program characteristics */
101 u16 i_number; /* program number */
102 u8 i_version; /* version number */
103 boolean_t b_is_ok; /* Is the description up to date ? */
105 /* Service Descriptor (program name) - DVB extension */
109 /* Synchronization information */
111 mtime_t cr_ref, sysdate_ref;
112 mtime_t last_cr; /* reference to detect unexpected stream
114 count_t c_average_count;
115 /* counter used to compute dynamic average values */
118 /* Demultiplexer data */
121 /* Decoders control */
122 struct vout_thread_s * p_vout;
123 struct aout_thread_s * p_aout;
125 int i_es_number; /* size of the following array */
126 es_descriptor_t ** pp_es; /* array of pointers to ES */
131 #define SYNCHRO_START 1
132 #define SYNCHRO_REINIT 2
134 /*****************************************************************************
135 * stream_descriptor_t
136 *****************************************************************************
137 * Describes a stream and list its associated programs. Build upon
138 * the information carried in program association sections (for instance)
139 *****************************************************************************/
140 typedef struct stream_descriptor_s
142 u16 i_stream_id; /* stream id */
143 vlc_mutex_t stream_lock; /* to be taken every time you read
144 * or modify stream, pgrm or es */
146 /* Input method data */
147 boolean_t b_pace_control; /* can we read when we want ? */
148 boolean_t b_seekable; /* can we do lseek() ? */
149 /* if (b_seekable) : */
150 off_t i_size; /* total size of the file
151 * (in arbitrary units) */
152 off_t i_tell; /* actual location in the file
153 * (in arbitrary units) */
154 off_t i_seek; /* next requested location (changed
155 * by the interface thread */
157 /* New status and rate requested by the interface */
158 int i_new_status, i_new_rate;
159 vlc_cond_t stream_wait; /* interface -> input in case of a
160 * status change request */
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 */
213 vlc_thread_t thread_id; /* id for thread functions */
214 int * pi_status; /* temporary status flag */
217 struct module_s * p_input_module;
220 void (* pf_init)( struct input_thread_s * );
221 void (* pf_open)( struct input_thread_s * );
222 void (* pf_close)( struct input_thread_s * );
223 void (* pf_end)( struct input_thread_s * );
225 /* Read & Demultiplex */
226 int (* pf_read)( struct input_thread_s *,
227 struct data_packet_s * pp_packets[] );
228 void (* pf_demux)( struct input_thread_s *,
229 struct data_packet_s * );
231 /* Packet management facilities */
232 struct data_packet_s *(*pf_new_packet)( void *, size_t );
233 struct pes_packet_s *(* pf_new_pes)( void * );
234 void (* pf_delete_packet)( void *,
235 struct data_packet_s * );
236 void (* pf_delete_pes)( void *, struct pes_packet_s * );
238 /* Stream control capabilities */
239 int (* pf_rewind)( struct input_thread_s * );
240 /* NULL if we don't support going *
241 * backwards (it's gonna be fun) */
242 void (* pf_seek)( struct input_thread_s *, off_t );
244 i_p_config_t i_p_config; /* plugin configuration */
247 int i_handle; /* socket or file descriptor */
248 void * p_method_data; /* data of the packet manager */
249 void * p_plugin_data; /* data of the plugin */
251 /* General stream description */
252 stream_descriptor_t stream; /* PAT tables */
254 /* For auto-launch of decoders */
255 struct aout_thread_s * p_default_aout;
256 struct vout_thread_s * p_default_vout;
260 count_t c_bytes; /* bytes read */
261 count_t c_payload_bytes; /* payload useful bytes */
262 count_t c_packets_read; /* packets read */
263 count_t c_packets_trashed; /* trashed packets */
269 * Communication interface -> input
272 /*****************************************************************************
274 *****************************************************************************
275 * This structure is given by the interface to an input thread
276 *****************************************************************************/
277 typedef struct input_config_s
279 /* Input method description */
280 int i_method; /* input method */
281 char * p_source; /* source */
283 /* For auto-launch of decoders */
284 struct aout_thread_s * p_default_aout;
285 struct vout_thread_s * p_default_vout;
289 #define INPUT_METHOD_NONE 0 /* input thread is inactive */
290 #define INPUT_METHOD_FILE 10 /* stream is read from file p_source */
291 #define INPUT_METHOD_DVD 11 /* stream is read from dvd device */
292 #define INPUT_METHOD_UCAST 20 /* UDP unicast */
293 #define INPUT_METHOD_MCAST 21 /* UDP multicast */
294 #define INPUT_METHOD_BCAST 22 /* UDP broadcast */
295 #define INPUT_METHOD_VLAN_BCAST 32 /* UDP broadcast with VLANs */
297 /* Status changing methods */
298 #define INPUT_STATUS_END 0
299 #define INPUT_STATUS_PLAY 1
300 #define INPUT_STATUS_PAUSE 2
301 #define INPUT_STATUS_FASTER 3
302 #define INPUT_STATUS_SLOWER 4
304 /*****************************************************************************
306 *****************************************************************************/
307 struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
309 void input_DestroyThread( struct input_thread_s *, int *pi_status );
311 void input_SetStatus( struct input_thread_s *, int );
312 void input_SetRate ( struct input_thread_s *, int );
313 void input_Seek ( struct input_thread_s *, off_t );