git.sesse.net Git - vlc/blob - include/decoder_fifo.h

   1 /*****************************************************************************
   2  * decoder_fifo.h: interface for decoders PES fifo
   3  * (c)1999 VideoLAN
   4  *****************************************************************************
   5  * Required headers:
   6  * - "config.h"
   7  * - "common.h"
   8  * - "vlc_thread.h"
   9  * - "input.h"
  10  *****************************************************************************/
  11
  12 /*****************************************************************************
  13  * Macros
  14  *****************************************************************************/
  15
  16 /* ?? move to inline functions */
  17 #define DECODER_FIFO_ISEMPTY( fifo )    ( (fifo).i_start == (fifo).i_end )
  18 #define DECODER_FIFO_ISFULL( fifo )     ( ( ( (fifo).i_end + 1 - (fifo).i_start ) \
  19                                           & FIFO_SIZE ) == 0 )
  20 #define DECODER_FIFO_START( fifo )      ( (fifo).buffer[ (fifo).i_start ] )
  21 #define DECODER_FIFO_INCSTART( fifo )   ( (fifo).i_start = ((fifo).i_start + 1)\
  22                                                            & FIFO_SIZE )
  23 #define DECODER_FIFO_END( fifo )        ( (fifo).buffer[ (fifo).i_end ] )
  24 #define DECODER_FIFO_INCEND( fifo )     ( (fifo).i_end = ((fifo).i_end + 1) \
  25                                                          & FIFO_SIZE )
  26
  27 /*****************************************************************************
  28  * decoder_fifo_t
  29  *****************************************************************************
  30  * This rotative FIFO contains PES packets that are to be decoded...
  31  *****************************************************************************/
  32 typedef struct
  33 {
  34     vlc_mutex_t         data_lock;                         /* fifo data lock */
  35     vlc_cond_t          data_wait;         /* fifo data conditional variable */
  36
  37     /* buffer is an array of PES packets pointers */
  38     pes_packet_t *      buffer[FIFO_SIZE + 1];
  39     int                 i_start;
  40     int                 i_end;
  41
  42 } decoder_fifo_t;
  43
  44 /*****************************************************************************
  45  * bit_fifo_t : bit fifo descriptor
  46  *****************************************************************************
  47  * This type describes a bit fifo used to store bits while working with the
  48  * input stream at the bit level.
  49  *****************************************************************************/
  50 typedef struct bit_fifo_s
  51 {
  52     /* This unsigned integer allows us to work at the bit level. This buffer
  53      * can contain 32 bits, and the used space can be found on the MSb's side
  54      * and the available space on the LSb's side. */
  55     u32                 buffer;
  56
  57     /* Number of bits available in the bit buffer */
  58     int                 i_available;
  59
  60 } bit_fifo_t;
  61
  62 /*****************************************************************************
  63  * bit_stream_t : bit stream descriptor
  64  *****************************************************************************
  65  * This type, based on a PES stream, includes all the structures needed to
  66  * handle the input stream like a bit stream.
  67  *****************************************************************************/
  68 typedef struct bit_stream_s
  69 {
  70     /*
  71      * Input structures
  72      */
  73     /* The input thread feeds the stream with fresh PES packets */
  74     input_thread_t *    p_input;
  75     /* The decoder fifo contains the data of the PES stream */
  76     decoder_fifo_t *    p_decoder_fifo;
  77
  78     /*
  79      * Byte structures
  80      */
  81     /* Current TS packet (in the current PES packet of the PES stream) */
  82     ts_packet_t *       p_ts;
  83     /* Pointer to the next byte that is to be read (in the current TS packet) */
  84     byte_t *            p_byte;
  85     /* Pointer to the last byte that is to be read (in the current TS packet */
  86     byte_t *            p_end;
  87
  88     /*
  89      * Bit structures
  90      */
  91     bit_fifo_t          fifo;
  92
  93 } bit_stream_t;
  94
  95
  96 void decoder_fifo_next( bit_stream_t * p_bit_stream );
  97 /*****************************************************************************
  98  * GetByte : reads the next byte in the input stream
  99  *****************************************************************************/
 100 static __inline__ byte_t GetByte( bit_stream_t * p_bit_stream )
 101 {
 102     /* Are there some bytes left in the current TS packet ? */
 103     /* could change this test to have a if (! (bytes--)) instead */
 104     if ( p_bit_stream->p_byte >= p_bit_stream->p_end )
 105     {
 106         /* no, switch to next TS packet */
 107         decoder_fifo_next( p_bit_stream );
 108     }
 109
 110     return( *(p_bit_stream->p_byte++));
 111 }
 112
 113 /*****************************************************************************
 114  * NeedBits : reads i_bits new bits in the bit stream and stores them in the
 115  *            bit buffer
 116  *****************************************************************************
 117  * - i_bits must be less or equal 32 !
 118  * - There is something important to notice with that function : if the number
 119  * of bits available in the bit buffer when calling NeedBits() is greater than
 120  * 24 (i_available > 24) but less than the number of needed bits
 121  * (i_available < i_bits), the byte returned by GetByte() will be shifted with
 122  * a negative value and the number of bits available in the bit buffer will be
 123  * set to more than 32 !
 124  *****************************************************************************/
 125 static __inline__ void NeedBits( bit_stream_t * p_bit_stream, int i_bits )
 126 {
 127     while ( p_bit_stream->fifo.i_available < i_bits )
 128     {
 129         p_bit_stream->fifo.buffer |= ((u32)GetByte( p_bit_stream )) << (24 - p_bit_stream->fifo.i_available);
 130         p_bit_stream->fifo.i_available += 8;
 131     }
 132 }
 133
 134 /*****************************************************************************
 135  * DumpBits : removes i_bits bits from the bit buffer
 136  *****************************************************************************
 137  * - i_bits <= i_available
 138  * - i_bits < 32 (because (u32 << 32) <=> (u32 = u32))
 139  *****************************************************************************/
 140 static __inline__ void DumpBits( bit_stream_t * p_bit_stream, int i_bits )
 141 {
 142     p_bit_stream->fifo.buffer <<= i_bits;
 143     p_bit_stream->fifo.i_available -= i_bits;
 144 }
 145
 146 /*****************************************************************************
 147  * DumpBits32 : removes 32 bits from the bit buffer
 148  *****************************************************************************
 149  * This function actually believes that you have already put 32 bits in the
 150  * bit buffer, so you can't you use it anytime.
 151  *****************************************************************************/
 152 static __inline__ void DumpBits32( bit_stream_t * p_bit_stream )
 153 {
 154     p_bit_stream->fifo.buffer = 0;
 155     p_bit_stream->fifo.i_available = 0;
 156 }
 157
 158 /*
 159  * For the following functions, please read VERY CAREFULLY the warning in
 160  * NeedBits(). If i_bits > 24, the stream parser must be already aligned
 161  * on an 8-bit boundary, or you will get curious results (that is, you
 162  * need to call RealignBits() before).
 163  */
 164
 165 /*****************************************************************************
 166  * RemoveBits : removes i_bits bits from the bit buffer
 167  *****************************************************************************/
 168 static __inline__ void RemoveBits( bit_stream_t * p_bit_stream, int i_bits )
 169 {
 170     NeedBits( p_bit_stream, i_bits );
 171     DumpBits( p_bit_stream, i_bits );
 172 }
 173
 174 /*****************************************************************************
 175  * RemoveBits32 : removes 32 bits from the bit buffer
 176  *****************************************************************************/
 177 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
 178 {
 179     NeedBits( p_bit_stream, 32 );
 180     DumpBits32( p_bit_stream );
 181 }
 182
 183 /*****************************************************************************
 184  * ShowBits : return i_bits bits from the bit stream
 185  *****************************************************************************/
 186 static __inline__ u32 ShowBits( bit_stream_t * p_bit_stream, int i_bits )
 187 {
 188     NeedBits( p_bit_stream, i_bits );
 189     return( p_bit_stream->fifo.buffer >> (32 - i_bits) );
 190 }
 191
 192 /*****************************************************************************
 193  * GetBits : returns i_bits bits from the bit stream and removes them
 194  *****************************************************************************/
 195 static __inline__ u32 GetBits( bit_stream_t * p_bit_stream, int i_bits )
 196 {
 197     u32 i_buffer;
 198
 199     NeedBits( p_bit_stream, i_bits );
 200     i_buffer = p_bit_stream->fifo.buffer >> (32 - i_bits);
 201     DumpBits( p_bit_stream, i_bits );
 202     return( i_buffer );
 203 }
 204
 205 /*****************************************************************************
 206  * GetBits32 : returns 32 bits from the bit stream and removes them
 207  *****************************************************************************/
 208 static __inline__ u32 GetBits32( bit_stream_t * p_bit_stream )
 209 {
 210     u32 i_buffer;
 211
 212     NeedBits( p_bit_stream, 32 );
 213     i_buffer = p_bit_stream->fifo.buffer;
 214     DumpBits32( p_bit_stream );
 215     return( i_buffer );
 216 }
 217
 218 /*****************************************************************************
 219  * RealignBits : realigns the bit buffer on an 8-bit boundary
 220  *****************************************************************************/
 221 static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
 222 {
 223     DumpBits( p_bit_stream, p_bit_stream->fifo.i_available & 7 );
 224 }