1 /*****************************************************************************
2 * input_ext-dec.h: structures exported to the VideoLAN decoders
3 *****************************************************************************
4 * Copyright (C) 1999, 2000 VideoLAN
5 * $Id: input_ext-dec.h,v 1.40 2001/12/03 16:18:37 sam Exp $
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Michel Kaempf <maxx@via.ecp.fr>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /* ES streams types - see ISO/IEC 13818-1 table 2-29 numbers */
26 #define MPEG1_VIDEO_ES 0x01
27 #define MPEG2_VIDEO_ES 0x02
28 #define MPEG1_AUDIO_ES 0x03
29 #define MPEG2_AUDIO_ES 0x04
30 #define AC3_AUDIO_ES 0x81
31 /* These ones might violate the norm : */
32 #define DVD_SPU_ES 0x82
33 #define LPCM_AUDIO_ES 0x83
34 #define UNKNOWN_ES 0xFF
36 /* Structures exported to the decoders */
38 /*****************************************************************************
40 *****************************************************************************
41 * Describe a data packet.
42 *****************************************************************************/
43 typedef struct data_packet_s
45 /* Nothing before this line, the code relies on that */
46 byte_t * p_buffer; /* raw data packet */
47 long l_size; /* buffer size */
49 /* Decoders information */
50 byte_t * p_payload_start;
51 /* start of the PES payload in this packet */
52 byte_t * p_payload_end; /* guess ? :-) */
53 boolean_t b_discard_payload; /* is the packet messed up ? */
57 /* Used to chain the TS packets that carry data for a same PES or PSI */
58 struct data_packet_s * p_next;
61 /*****************************************************************************
63 *****************************************************************************
64 * Describes an PES packet, with its properties, and pointers to the TS packets
66 *****************************************************************************/
67 typedef struct pes_packet_s
70 boolean_t b_data_alignment; /* used to find the beginning of
71 * a video or audio unit */
72 boolean_t b_discontinuity; /* This packet doesn't follow the
75 mtime_t i_pts; /* PTS for this packet (zero if unset) */
76 mtime_t i_dts; /* DTS for this packet (zero if unset) */
77 int i_rate; /* current pace of reading
78 * (see stream_control.h) */
80 int i_pes_size; /* size of the current PES packet */
82 /* Pointers to packets (packets are then linked by the p_prev and
83 p_next fields of the data_packet_t struct) */
84 data_packet_t * p_first; /* The first packet contained by this
85 * PES (used by decoders). */
88 /*****************************************************************************
90 *****************************************************************************
91 * This rotative FIFO contains PES packets that are to be decoded.
92 *****************************************************************************/
93 typedef struct decoder_fifo_s
95 /* Thread structures */
96 vlc_mutex_t data_lock; /* fifo data lock */
97 vlc_cond_t data_wait; /* fifo data conditional variable */
100 pes_packet_t * buffer[FIFO_SIZE + 1];
104 /* Communication interface between input and decoders */
105 boolean_t b_die; /* the decoder should return now */
106 boolean_t b_error; /* the decoder is in an error loop */
107 void * p_packets_mgt; /* packets management services
108 * data (netlist...) */
109 void (* pf_delete_pes)( void *, pes_packet_t * );
110 /* function to use when releasing a PES */
113 /* Macros to manage a decoder_fifo_t structure. Please remember to take
114 * data_lock before using them. */
115 #define DECODER_FIFO_ISEMPTY( fifo ) ( (fifo).i_start == (fifo).i_end )
116 #define DECODER_FIFO_ISFULL( fifo ) ( ( ((fifo).i_end + 1 - (fifo).i_start)\
118 #define DECODER_FIFO_START( fifo ) ( (fifo).buffer[ (fifo).i_start ] )
119 #define DECODER_FIFO_INCSTART( fifo ) ( (fifo).i_start = ((fifo).i_start + 1)\
121 #define DECODER_FIFO_END( fifo ) ( (fifo).buffer[ (fifo).i_end ] )
122 #define DECODER_FIFO_INCEND( fifo ) ( (fifo).i_end = ((fifo).i_end + 1) \
125 /*****************************************************************************
126 * bit_fifo_t : bit fifo descriptor
127 *****************************************************************************
128 * This type describes a bit fifo used to store bits while working with the
129 * input stream at the bit level.
130 *****************************************************************************/
131 typedef u32 WORD_TYPE;
133 typedef struct bit_fifo_s
135 /* This unsigned integer allows us to work at the bit level. This buffer
136 * can contain 32 bits, and the used space can be found on the MSb's side
137 * and the available space on the LSb's side. */
140 /* Number of bits available in the bit buffer */
145 /*****************************************************************************
146 * bit_stream_t : bit stream descriptor
147 *****************************************************************************
148 * This type, based on a PES stream, includes all the structures needed to
149 * handle the input stream like a bit stream.
150 *****************************************************************************/
151 typedef struct bit_stream_s
161 /* The decoder fifo contains the data of the PES stream */
162 decoder_fifo_t * p_decoder_fifo;
164 /* Function to jump to the next data packet */
165 void (* pf_next_data_packet)( struct bit_stream_s * );
167 /* Callback to the decoder used when changing data packets ; set
168 * to NULL if your decoder doesn't need it. */
169 void (* pf_bitstream_callback)( struct bit_stream_s *,
170 boolean_t b_new_pes );
171 /* Optional argument to the callback */
172 void * p_callback_arg;
177 /* Current data packet (in the current PES packet of the PES stream) */
178 data_packet_t * p_data;
179 /* Pointer to the next byte that is to be read (in the current packet) */
181 /* Pointer to the last byte that is to be read (in the current packet */
183 /* Temporary buffer in case we're not aligned when changing data packets */
184 WORD_TYPE i_showbits_buffer;
185 data_packet_t showbits_data;
188 /*****************************************************************************
189 * Inline functions used by the decoders to read bit_stream_t
190 *****************************************************************************/
193 * DISCUSSION : How to use the bit_stream structures
195 * sizeof(WORD_TYPE) (usually 32) bits are read at the same time, thus
196 * minimizing the number of p_byte changes.
197 * Bits are read via GetBits() or ShowBits.
199 * XXX : Be aware that if, in the forthcoming functions, i_bits > 24,
200 * the data have to be already aligned on an 8-bit boundary, or wrong
201 * results will be returned. Use RealignBits() if unsure.
204 #if (WORD_TYPE == u32)
205 # define WORD_AT U32_AT
206 # define WORD_SIGNED s32
207 #elif (WORD_TYPE == u64)
208 # define WORD_AT U64_AT
209 # define WORD_SIGNED s64
211 # error Unsupported WORD_TYPE
214 /*****************************************************************************
215 * Protoypes from input_ext-dec.c
216 *****************************************************************************/
218 u32 UnalignedShowBits( struct bit_stream_s *, unsigned int );
219 void UnalignedRemoveBits( struct bit_stream_s * );
220 u32 UnalignedGetBits( struct bit_stream_s *, unsigned int );
223 /*****************************************************************************
224 * AlignWord : fill in the bit buffer so that the byte pointer be aligned
225 * on a word boundary (XXX: there must be at least sizeof(WORD_TYPE) - 1
226 * empty bytes in the bit buffer)
227 *****************************************************************************/
228 static __inline__ void AlignWord( bit_stream_t * p_bit_stream )
230 while( (ptrdiff_t)p_bit_stream->p_byte
231 & (sizeof(WORD_TYPE) - 1) )
233 if( p_bit_stream->p_byte < p_bit_stream->p_end )
235 p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
236 << (8 * sizeof(WORD_TYPE) - 8
237 - p_bit_stream->fifo.i_available);
238 p_bit_stream->fifo.i_available += 8;
242 p_bit_stream->pf_next_data_packet( p_bit_stream );
243 p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
244 << (8 * sizeof(WORD_TYPE) - 8
245 - p_bit_stream->fifo.i_available);
246 p_bit_stream->fifo.i_available += 8;
251 /*****************************************************************************
252 * ShowBits : return i_bits bits from the bit stream
253 *****************************************************************************/
254 static __inline__ u32 ShowBits( bit_stream_t * p_bit_stream,
255 unsigned int i_bits )
257 if( p_bit_stream->fifo.i_available >= i_bits )
259 return( p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits) );
262 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
264 return( (p_bit_stream->fifo.buffer |
265 (WORD_AT( p_bit_stream->p_byte )
266 >> p_bit_stream->fifo.i_available))
267 >> (8 * sizeof(WORD_TYPE) - i_bits) );
270 return( UnalignedShowBits( p_bit_stream, i_bits ) );
273 /*****************************************************************************
274 * ShowSignedBits : return i_bits bits from the bit stream, using signed
276 *****************************************************************************/
277 static __inline__ s32 ShowSignedBits( bit_stream_t * p_bit_stream,
278 unsigned int i_bits )
280 if( p_bit_stream->fifo.i_available >= i_bits )
282 return( (WORD_SIGNED)p_bit_stream->fifo.buffer
283 >> (8 * sizeof(WORD_TYPE) - i_bits) );
286 /* You can probably do something a little faster, but now I'm tired. */
287 return( (WORD_SIGNED)(ShowBits( p_bit_stream, i_bits ) << (32 - i_bits))
291 /*****************************************************************************
292 * RemoveBits : removes i_bits bits from the bit buffer
293 * XXX: do not use for 32 bits, see RemoveBits32
294 *****************************************************************************/
295 static __inline__ void RemoveBits( bit_stream_t * p_bit_stream,
296 unsigned int i_bits )
298 p_bit_stream->fifo.i_available -= i_bits;
300 if( p_bit_stream->fifo.i_available >= 0 )
302 p_bit_stream->fifo.buffer <<= i_bits;
306 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
308 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
309 << ( -p_bit_stream->fifo.i_available );
310 ((WORD_TYPE *)p_bit_stream->p_byte)++;
311 p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
315 UnalignedRemoveBits( p_bit_stream );
318 /*****************************************************************************
319 * RemoveBits32 : removes 32 bits from the bit buffer (and as a side effect,
321 *****************************************************************************/
322 #if (WORD_TYPE == u32)
323 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
325 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
327 if( p_bit_stream->fifo.i_available )
329 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
330 << (32 - p_bit_stream->fifo.i_available);
331 ((WORD_TYPE *)p_bit_stream->p_byte)++;
335 ((WORD_TYPE *)p_bit_stream->p_byte)++;
339 p_bit_stream->fifo.i_available -= 32;
340 UnalignedRemoveBits( p_bit_stream );
343 # define RemoveBits32( p_bit_stream ) RemoveBits( p_bit_stream, 32 )
346 /*****************************************************************************
347 * GetBits : returns i_bits bits from the bit stream and removes them
348 * XXX: do not use for 32 bits, see GetBits32
349 *****************************************************************************/
350 static __inline__ u32 GetBits( bit_stream_t * p_bit_stream,
351 unsigned int i_bits )
355 p_bit_stream->fifo.i_available -= i_bits;
357 if( p_bit_stream->fifo.i_available >= 0 )
359 i_result = p_bit_stream->fifo.buffer
360 >> (8 * sizeof(WORD_TYPE) - i_bits);
361 p_bit_stream->fifo.buffer <<= i_bits;
365 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
367 i_result = p_bit_stream->fifo.buffer
368 >> (8 * sizeof(WORD_TYPE) - i_bits);
369 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
370 ((WORD_TYPE *)p_bit_stream->p_byte)++;
371 i_result |= p_bit_stream->fifo.buffer
372 >> (8 * sizeof(WORD_TYPE)
373 + p_bit_stream->fifo.i_available);
374 p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
375 p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
379 return UnalignedGetBits( p_bit_stream, i_bits );
382 /*****************************************************************************
383 * GetSignedBits : returns i_bits bits from the bit stream and removes them,
384 * using signed arithmetic
385 * XXX: do not use for 32 bits
386 *****************************************************************************/
387 static __inline__ s32 GetSignedBits( bit_stream_t * p_bit_stream,
388 unsigned int i_bits )
390 if( p_bit_stream->fifo.i_available >= i_bits )
394 p_bit_stream->fifo.i_available -= i_bits;
395 i_result = (WORD_SIGNED)p_bit_stream->fifo.buffer
396 >> (8 * sizeof(WORD_TYPE) - i_bits);
397 p_bit_stream->fifo.buffer <<= i_bits;
401 /* You can probably do something a little faster, but now I'm tired. */
402 return( (WORD_SIGNED)(GetBits( p_bit_stream, i_bits ) << (32 - i_bits))
406 /*****************************************************************************
407 * GetBits32 : returns 32 bits from the bit stream and removes them
408 *****************************************************************************/
409 #if (WORD_TYPE == u32)
410 static __inline__ u32 GetBits32( bit_stream_t * p_bit_stream )
414 if( p_bit_stream->fifo.i_available == 32 )
416 p_bit_stream->fifo.i_available = 0;
417 i_result = p_bit_stream->fifo.buffer;
418 p_bit_stream->fifo.buffer = 0;
422 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
424 if( p_bit_stream->fifo.i_available )
426 i_result = p_bit_stream->fifo.buffer;
427 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
428 ((WORD_TYPE *)p_bit_stream->p_byte)++;
429 i_result |= p_bit_stream->fifo.buffer
430 >> (p_bit_stream->fifo.i_available);
431 p_bit_stream->fifo.buffer <<= (32 - p_bit_stream->fifo.i_available);
435 i_result = WORD_AT( p_bit_stream->p_byte );
436 ((WORD_TYPE *)p_bit_stream->p_byte)++;
440 p_bit_stream->fifo.i_available -= 32;
441 return UnalignedGetBits( p_bit_stream, 32 );
444 # define GetBits32( p_bit_stream ) GetBits( p_bit_stream, 32 )
447 /*****************************************************************************
448 * RealignBits : realigns the bit buffer on an 8-bit boundary
449 *****************************************************************************/
450 static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
452 p_bit_stream->fifo.buffer <<= (p_bit_stream->fifo.i_available & 0x7);
453 p_bit_stream->fifo.i_available &= ~0x7;
457 /*****************************************************************************
458 * GetChunk : reads a large chunk of data
459 *****************************************************************************
460 * The position in the stream must be byte-aligned, if unsure call
461 * RealignBits(). p_buffer must point to a buffer at least as big as i_buf_len
462 * otherwise your code will crash.
463 *****************************************************************************/
464 static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
465 byte_t * p_buffer, size_t i_buf_len )
467 ptrdiff_t i_available;
469 /* We need to take care because i_buf_len may be < 4. */
470 while( p_bit_stream->fifo.i_available > 0 && i_buf_len )
472 *p_buffer = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - 8);
475 p_bit_stream->fifo.buffer <<= 8;
476 p_bit_stream->fifo.i_available -= 8;
479 if( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
482 pf_fast_memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
483 p_bit_stream->p_byte += i_buf_len;
489 pf_fast_memcpy( p_buffer, p_bit_stream->p_byte, i_available );
490 p_bit_stream->p_byte = p_bit_stream->p_end;
491 p_buffer += i_available;
492 i_buf_len -= i_available;
493 p_bit_stream->pf_next_data_packet( p_bit_stream );
495 while( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
496 <= i_buf_len && !p_bit_stream->p_decoder_fifo->b_die );
500 pf_fast_memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
501 p_bit_stream->p_byte += i_buf_len;
505 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
507 AlignWord( p_bit_stream );
513 * Communication interface between input and decoders
516 /*****************************************************************************
518 *****************************************************************************
519 * Standard pointers given to the decoders as a toolbox.
520 *****************************************************************************/
521 typedef struct decoder_config_s
524 u8 i_type; /* type of the elementary stream */
526 struct stream_ctrl_s * p_stream_ctrl;
527 struct decoder_fifo_s * p_decoder_fifo;
528 void (* pf_init_bit_stream)( struct bit_stream_s *,
529 struct decoder_fifo_s *,
530 void (* pf_bitstream_callback)( struct bit_stream_s *,