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.34 2001/08/22 17:21:45 massiot 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 /* Structures exported to the decoders */
27 /*****************************************************************************
29 *****************************************************************************
30 * Describe a data packet.
31 *****************************************************************************/
32 typedef struct data_packet_s
34 /* Nothing before this line, the code relies on that */
35 byte_t * p_buffer; /* raw data packet */
36 long l_size; /* buffer size */
38 /* Decoders information */
39 byte_t * p_payload_start;
40 /* start of the PES payload in this packet */
41 byte_t * p_payload_end; /* guess ? :-) */
42 boolean_t b_discard_payload; /* is the packet messed up ? */
46 /* Used to chain the TS packets that carry data for a same PES or PSI */
47 struct data_packet_s * p_next;
50 /*****************************************************************************
52 *****************************************************************************
53 * Describes an PES packet, with its properties, and pointers to the TS packets
55 *****************************************************************************/
56 typedef struct pes_packet_s
59 boolean_t b_data_alignment; /* used to find the beginning of
60 * a video or audio unit */
61 boolean_t b_discontinuity; /* This packet doesn't follow the
64 mtime_t i_pts; /* PTS for this packet (zero if unset) */
65 mtime_t i_dts; /* DTS for this packet (zero if unset) */
66 int i_rate; /* current pace of reading
67 * (see stream_control.h) */
69 int i_pes_size; /* size of the current PES packet */
71 /* Pointers to packets (packets are then linked by the p_prev and
72 p_next fields of the data_packet_t struct) */
73 data_packet_t * p_first; /* The first packet contained by this
74 * PES (used by decoders). */
77 /*****************************************************************************
79 *****************************************************************************
80 * This rotative FIFO contains PES packets that are to be decoded.
81 *****************************************************************************/
82 typedef struct decoder_fifo_s
84 /* Thread structures */
85 vlc_mutex_t data_lock; /* fifo data lock */
86 vlc_cond_t data_wait; /* fifo data conditional variable */
89 pes_packet_t * buffer[FIFO_SIZE + 1];
93 /* Communication interface between input and decoders */
94 boolean_t b_die; /* the decoder should return now */
95 boolean_t b_error; /* the decoder is in an error loop */
96 void * p_packets_mgt; /* packets management services
97 * data (netlist...) */
98 void (* pf_delete_pes)( void *, pes_packet_t * );
99 /* function to use when releasing a PES */
102 /* Macros to manage a decoder_fifo_t structure. Please remember to take
103 * data_lock before using them. */
104 #define DECODER_FIFO_ISEMPTY( fifo ) ( (fifo).i_start == (fifo).i_end )
105 #define DECODER_FIFO_ISFULL( fifo ) ( ( ((fifo).i_end + 1 - (fifo).i_start)\
107 #define DECODER_FIFO_START( fifo ) ( (fifo).buffer[ (fifo).i_start ] )
108 #define DECODER_FIFO_INCSTART( fifo ) ( (fifo).i_start = ((fifo).i_start + 1)\
110 #define DECODER_FIFO_END( fifo ) ( (fifo).buffer[ (fifo).i_end ] )
111 #define DECODER_FIFO_INCEND( fifo ) ( (fifo).i_end = ((fifo).i_end + 1) \
114 /*****************************************************************************
115 * bit_fifo_t : bit fifo descriptor
116 *****************************************************************************
117 * This type describes a bit fifo used to store bits while working with the
118 * input stream at the bit level.
119 *****************************************************************************/
120 typedef u32 WORD_TYPE;
122 typedef struct bit_fifo_s
124 /* This unsigned integer allows us to work at the bit level. This buffer
125 * can contain 32 bits, and the used space can be found on the MSb's side
126 * and the available space on the LSb's side. */
129 /* Number of bits available in the bit buffer */
134 /*****************************************************************************
135 * bit_stream_t : bit stream descriptor
136 *****************************************************************************
137 * This type, based on a PES stream, includes all the structures needed to
138 * handle the input stream like a bit stream.
139 *****************************************************************************/
140 typedef struct bit_stream_s
150 /* The decoder fifo contains the data of the PES stream */
151 decoder_fifo_t * p_decoder_fifo;
153 /* Function to jump to the next data packet */
154 void (* pf_next_data_packet)( struct bit_stream_s * );
156 /* Callback to the decoder used when changing data packets ; set
157 * to NULL if your decoder doesn't need it. */
158 void (* pf_bitstream_callback)( struct bit_stream_s *,
159 boolean_t b_new_pes );
160 /* Optional argument to the callback */
161 void * p_callback_arg;
166 /* Current data packet (in the current PES packet of the PES stream) */
167 data_packet_t * p_data;
168 /* Pointer to the next byte that is to be read (in the current packet) */
170 /* Pointer to the last byte that is to be read (in the current packet */
172 /* Temporary buffer in case we're not aligned when changing data packets */
173 WORD_TYPE i_showbits_buffer;
174 data_packet_t showbits_data;
177 /*****************************************************************************
178 * Inline functions used by the decoders to read bit_stream_t
179 *****************************************************************************/
182 * DISCUSSION : How to use the bit_stream structures
184 * sizeof(WORD_TYPE) (usually 32) bits are read at the same time, thus
185 * minimizing the number of p_byte changes.
186 * Bits are read via GetBits() or ShowBits.
188 * XXX : Be aware that if, in the forthcoming functions, i_bits > 24,
189 * the data have to be already aligned on an 8-bit boundary, or wrong
190 * results will be returned. Use RealignBits() if unsure.
193 #if (WORD_TYPE == u32)
194 # define WORD_AT U32_AT
195 # define WORD_SIGNED s32
196 #elif (WORD_TYPE == u64)
197 # define WORD_AT U64_AT
198 # define WORD_SIGNED s64
200 # error Unsupported WORD_TYPE
203 /*****************************************************************************
204 * Protoypes from input_ext-dec.c
205 *****************************************************************************/
206 void UnalignedShowBits( struct bit_stream_s *, unsigned int );
207 void UnalignedRemoveBits( struct bit_stream_s * );
208 u32 UnalignedGetBits( struct bit_stream_s *, unsigned int );
210 /*****************************************************************************
211 * AlignWord : fill in the bit buffer so that the byte pointer be aligned
212 * on a word boundary (XXX: there must be at least sizeof(WORD_TYPE) - 1
213 * empty bytes in the bit buffer)
214 *****************************************************************************/
215 static __inline__ void AlignWord( bit_stream_t * p_bit_stream )
217 while( (ptrdiff_t)p_bit_stream->p_byte
218 & (sizeof(WORD_TYPE) - 1) )
220 if( p_bit_stream->p_byte < p_bit_stream->p_end )
222 p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
223 << (8 * sizeof(WORD_TYPE) - 8
224 - p_bit_stream->fifo.i_available);
225 p_bit_stream->fifo.i_available += 8;
229 p_bit_stream->pf_next_data_packet( p_bit_stream );
230 p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
231 << (8 * sizeof(WORD_TYPE) - 8
232 - p_bit_stream->fifo.i_available);
233 p_bit_stream->fifo.i_available += 8;
238 /*****************************************************************************
239 * ShowBits : return i_bits bits from the bit stream
240 *****************************************************************************/
241 static __inline__ u32 ShowBits( bit_stream_t * p_bit_stream,
242 unsigned int i_bits )
244 if( p_bit_stream->fifo.i_available >= i_bits )
246 return( p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits) );
249 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
251 return( (p_bit_stream->fifo.buffer |
252 (WORD_AT( p_bit_stream->p_byte )
253 >> p_bit_stream->fifo.i_available))
254 >> (8 * sizeof(WORD_TYPE) - i_bits) );
257 UnalignedShowBits( p_bit_stream, i_bits );
258 return( p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits) );
261 /*****************************************************************************
262 * ShowSignedBits : return i_bits bits from the bit stream, using signed
264 *****************************************************************************/
265 static __inline__ s32 ShowSignedBits( bit_stream_t * p_bit_stream,
266 unsigned int i_bits )
268 if( p_bit_stream->fifo.i_available >= i_bits )
270 return( (WORD_SIGNED)p_bit_stream->fifo.buffer
271 >> (8 * sizeof(WORD_TYPE) - i_bits) );
274 /* You can probably do something a little faster, but now I'm tired. */
275 return( (WORD_SIGNED)(ShowBits( p_bit_stream, i_bits ) << (32 - i_bits))
279 /*****************************************************************************
280 * RemoveBits : removes i_bits bits from the bit buffer
281 * XXX: do not use for 32 bits, see RemoveBits32
282 *****************************************************************************/
283 static __inline__ void RemoveBits( bit_stream_t * p_bit_stream,
284 unsigned int i_bits )
286 p_bit_stream->fifo.i_available -= i_bits;
288 if( p_bit_stream->fifo.i_available >= 0 )
290 p_bit_stream->fifo.buffer <<= i_bits;
294 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
296 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
297 << ( -p_bit_stream->fifo.i_available );
298 ((WORD_TYPE *)p_bit_stream->p_byte)++;
299 p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
303 UnalignedRemoveBits( p_bit_stream );
306 /*****************************************************************************
307 * RemoveBits32 : removes 32 bits from the bit buffer (and as a side effect,
309 *****************************************************************************/
310 #if (WORD_TYPE == u32)
311 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
313 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
315 if( p_bit_stream->fifo.i_available )
317 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
318 << (32 - p_bit_stream->fifo.i_available);
319 ((WORD_TYPE *)p_bit_stream->p_byte)++;
323 ((WORD_TYPE *)p_bit_stream->p_byte)++;
327 p_bit_stream->fifo.i_available -= 32;
328 UnalignedRemoveBits( p_bit_stream );
331 # define RemoveBits32( p_bit_stream ) RemoveBits( p_bit_stream, 32 )
334 /*****************************************************************************
335 * GetBits : returns i_bits bits from the bit stream and removes them
336 * XXX: do not use for 32 bits, see GetBits32
337 *****************************************************************************/
338 static __inline__ u32 GetBits( bit_stream_t * p_bit_stream,
339 unsigned int i_bits )
343 p_bit_stream->fifo.i_available -= i_bits;
345 if( p_bit_stream->fifo.i_available >= 0 )
347 i_result = p_bit_stream->fifo.buffer
348 >> (8 * sizeof(WORD_TYPE) - i_bits);
349 p_bit_stream->fifo.buffer <<= i_bits;
353 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
355 i_result = p_bit_stream->fifo.buffer
356 >> (8 * sizeof(WORD_TYPE) - i_bits);
357 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
358 ((WORD_TYPE *)p_bit_stream->p_byte)++;
359 i_result |= p_bit_stream->fifo.buffer
360 >> (8 * sizeof(WORD_TYPE)
361 + p_bit_stream->fifo.i_available);
362 p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
363 p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
367 return UnalignedGetBits( p_bit_stream, i_bits );
370 /*****************************************************************************
371 * GetSignedBits : returns i_bits bits from the bit stream and removes them,
372 * using signed arithmetic
373 * XXX: do not use for 32 bits
374 *****************************************************************************/
375 static __inline__ s32 GetSignedBits( bit_stream_t * p_bit_stream,
376 unsigned int i_bits )
378 if( p_bit_stream->fifo.i_available >= i_bits )
382 p_bit_stream->fifo.i_available -= i_bits;
383 i_result = (WORD_SIGNED)p_bit_stream->fifo.buffer
384 >> (8 * sizeof(WORD_TYPE) - i_bits);
385 p_bit_stream->fifo.buffer <<= i_bits;
389 /* You can probably do something a little faster, but now I'm tired. */
390 return( (WORD_SIGNED)(GetBits( p_bit_stream, i_bits ) << (32 - i_bits))
394 /*****************************************************************************
395 * GetBits32 : returns 32 bits from the bit stream and removes them
396 *****************************************************************************/
397 #if (WORD_TYPE == u32)
398 static __inline__ u32 GetBits32( bit_stream_t * p_bit_stream )
402 if( p_bit_stream->fifo.i_available == 32 )
404 p_bit_stream->fifo.i_available = 0;
405 i_result = p_bit_stream->fifo.buffer;
406 p_bit_stream->fifo.buffer = 0;
410 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
412 if( p_bit_stream->fifo.i_available )
414 i_result = p_bit_stream->fifo.buffer;
415 p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
416 ((WORD_TYPE *)p_bit_stream->p_byte)++;
417 i_result |= p_bit_stream->fifo.buffer
418 >> (p_bit_stream->fifo.i_available);
419 p_bit_stream->fifo.buffer <<= (32 - p_bit_stream->fifo.i_available);
423 i_result = WORD_AT( p_bit_stream->p_byte );
424 ((WORD_TYPE *)p_bit_stream->p_byte)++;
428 p_bit_stream->fifo.i_available -= 32;
429 return UnalignedGetBits( p_bit_stream, 32 );
432 # define GetBits32( p_bit_stream ) GetBits( p_bit_stream, 32 )
435 /*****************************************************************************
436 * RealignBits : realigns the bit buffer on an 8-bit boundary
437 *****************************************************************************/
438 static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
440 p_bit_stream->fifo.buffer <<= (p_bit_stream->fifo.i_available & 0x7);
441 p_bit_stream->fifo.i_available &= ~0x7;
445 /*****************************************************************************
446 * GetChunk : reads a large chunk of data
447 *****************************************************************************
448 * The position in the stream must be byte-aligned, if unsure call
449 * RealignBits(). p_buffer must point to a buffer at least as big as i_buf_len
450 * otherwise your code will crash.
451 *****************************************************************************/
452 static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
453 byte_t * p_buffer, size_t i_buf_len )
455 ptrdiff_t i_available;
457 /* We need to take care because i_buf_len may be < 4. */
458 while( p_bit_stream->fifo.i_available > 0 && i_buf_len )
460 *p_buffer = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - 8);
463 p_bit_stream->fifo.buffer <<= 8;
464 p_bit_stream->fifo.i_available -= 8;
467 if( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
470 memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
471 p_bit_stream->p_byte += i_buf_len;
477 memcpy( p_buffer, p_bit_stream->p_byte, i_available );
478 p_bit_stream->p_byte = p_bit_stream->p_end;
479 p_buffer += i_available;
480 i_buf_len -= i_available;
481 p_bit_stream->pf_next_data_packet( p_bit_stream );
483 while( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
484 <= i_buf_len && !p_bit_stream->p_decoder_fifo->b_die );
488 memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
489 p_bit_stream->p_byte += i_buf_len;
493 if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
495 AlignWord( p_bit_stream );
501 * The following functions are now deprecated.
504 static __inline__ byte_t _GetByte( bit_stream_t * p_bit_stream )
506 if ( p_bit_stream->p_byte >= p_bit_stream->p_end )
508 p_bit_stream->pf_next_data_packet( p_bit_stream );
511 return( *(p_bit_stream->p_byte++) );
514 static __inline__ void NeedBits( bit_stream_t * p_bit_stream, int i_bits )
516 while ( p_bit_stream->fifo.i_available < i_bits )
518 p_bit_stream->fifo.buffer |= ((WORD_TYPE)_GetByte( p_bit_stream ))
519 << (8 * sizeof(WORD_TYPE) - 8
520 - p_bit_stream->fifo.i_available);
521 p_bit_stream->fifo.i_available += 8;
525 static __inline__ void DumpBits( bit_stream_t * p_bit_stream, int i_bits )
527 p_bit_stream->fifo.buffer <<= i_bits;
528 p_bit_stream->fifo.i_available -= i_bits;
533 * Communication interface between input and decoders
536 /*****************************************************************************
538 *****************************************************************************
539 * Standard pointers given to the decoders as a toolbox.
540 *****************************************************************************/
541 typedef struct decoder_config_s
544 u8 i_type; /* type of the elementary stream */
546 struct stream_ctrl_s * p_stream_ctrl;
547 struct decoder_fifo_s * p_decoder_fifo;
548 void (* pf_init_bit_stream)( struct bit_stream_s *,
549 struct decoder_fifo_s *,
550 void (* pf_bitstream_callback)( struct bit_stream_s *,
555 /*****************************************************************************
557 *****************************************************************************
558 * Pointers given to video decoders threads.
559 *****************************************************************************/
560 struct vout_thread_s;
562 typedef struct vdec_config_s
564 struct picture_s * (* pf_create_picture)( struct vout_thread_s *,
565 int i_type, int i_width,
567 void (* pf_destroy_picture)( struct vout_thread_s *,
568 struct picture_s * );
569 void (* pf_display_picture)( struct vout_thread_s *,
570 struct picture_s * );
571 void (* pf_date_picture)( struct vout_thread_s *,
572 struct picture_s *, mtime_t date );
573 void (* pf_link_picture)( struct vout_thread_s *,
574 struct picture_s *, mtime_t date );
575 void (* pf_unlink_picture)( struct vout_thread_s *,
576 struct picture_s *, mtime_t date );
577 struct subpicture_s *(* pf_create_subpicture)( struct vout_thread_s *,
578 int i_type, int i_size );
579 void (* pf_destroy_subpicture)( struct vout_thread_s *,
580 struct subpicture_s * );
581 void (* pf_display_subpicture)( struct vout_thread_s *,
582 struct subpicture_s * );
584 decoder_config_t decoder_config;
587 /*****************************************************************************
589 *****************************************************************************
590 * Pointers given to audio decoders threads.
591 *****************************************************************************/
592 typedef struct adec_config_s
594 struct aout_fifo_s * (* pf_create_fifo)( struct aout_fifo_s * );
595 void (* pf_destroy_fifo)( void );
597 decoder_config_t decoder_config;
602 * Communication interface between decoders and input
605 /*****************************************************************************
606 * decoder_capabilities_t
607 *****************************************************************************
608 * Structure returned by a call to GetCapabilities() of the decoder.
609 *****************************************************************************/
610 typedef struct decoder_capabilities_s
613 u8 i_stream_type; /* == i_type in es_descriptor_t */
614 int i_weight; /* for a given stream type, the decoder
615 * with higher weight will be spawned */
617 vlc_thread_t (* pf_create_thread)( void * );
618 } decoder_capabilities_t;