]> git.sesse.net Git - vlc/blobdiff - include/input_ext-dec.h
* Mandatory step for video output IV and the audio output quality
[vlc] / include / input_ext-dec.h
index 3f6efdb076eb4eecfd17fae618f6f611b38580d0..688669190b93ef3fa53627742ad33118ff04df41 100644 (file)
@@ -2,9 +2,10 @@
  * input_ext-dec.h: structures exported to the VideoLAN decoders
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
- * $Id: input_ext-dec.h,v 1.10 2001/01/10 19:22:10 massiot Exp $
+ * $Id: input_ext-dec.h,v 1.31 2001/05/01 04:18:17 sam Exp $
  *
- * Authors:
+ * Authors: Christophe Massiot <massiot@via.ecp.fr>
+ *          Michel Kaempf <maxx@via.ecp.fr>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -32,6 +33,7 @@ typedef struct data_packet_s
 {
     /* Nothing before this line, the code relies on that */
     byte_t *                p_buffer;                     /* raw data packet */
+    long                    l_size;                           /* buffer size */
 
     /* Decoders information */
     byte_t *                p_payload_start;
@@ -39,6 +41,8 @@ typedef struct data_packet_s
     byte_t *                p_payload_end;                    /* guess ? :-) */
     boolean_t               b_discard_payload;  /* is the packet messed up ? */
 
+    int *                   pi_refcount;
+
     /* Used to chain the TS packets that carry data for a same PES or PSI */
     struct data_packet_s *  p_next;
 } data_packet_t;
@@ -52,21 +56,21 @@ typedef struct data_packet_s
 typedef struct pes_packet_s
 {
     /* PES properties */
-    boolean_t               b_messed_up;  /* At least one of the data packets
-                                           * has a questionable content      */
     boolean_t               b_data_alignment;  /* used to find the beginning of
                                                 * a video or audio unit      */
     boolean_t               b_discontinuity; /* This packet doesn't follow the
                                               * previous one                 */
 
-    mtime_t                 i_pts;/* the PTS for this packet (zero if unset) */
-    mtime_t                 i_dts;/* the DTS for this packet (zero if unset) */
+    mtime_t                 i_pts;    /* PTS for this packet (zero if unset) */
+    mtime_t                 i_dts;    /* DTS for this packet (zero if unset) */
+    int                     i_rate;                /* current pace of reading
+                                                    * (see stream_control.h) */
 
     int                     i_pes_size;    /* size of the current PES packet */
 
     /* Pointers to packets (packets are then linked by the p_prev and
        p_next fields of the data_packet_t struct) */
-    data_packet_t *         p_first;      /* The first packet containing this
+    data_packet_t *         p_first;      /* The first packet contained by this
                                            * PES (used by decoders). */
 } pes_packet_t;
 
@@ -113,7 +117,7 @@ typedef struct decoder_fifo_s
  * This type describes a bit fifo used to store bits while working with the
  * input stream at the bit level.
  *****************************************************************************/
-typedef u32         WORD_TYPE;        /* only u32 is supported at the moment */
+typedef u32         WORD_TYPE;
 
 typedef struct bit_fifo_s
 {
@@ -135,6 +139,11 @@ typedef struct bit_fifo_s
  *****************************************************************************/
 typedef struct bit_stream_s
 {
+    /*
+     * Bit structures
+     */
+    bit_fifo_t              fifo;
+
     /*
      * Input structures
      */
@@ -156,15 +165,13 @@ typedef struct bit_stream_s
      */
     /* Current data packet (in the current PES packet of the PES stream) */
     data_packet_t *         p_data;
-    /* Pointer to the next byte that is to be read (in the current TS packet) */
+    /* Pointer to the next byte that is to be read (in the current packet) */
     byte_t *                p_byte;
-    /* Pointer to the last byte that is to be read (in the current TS packet */
+    /* Pointer to the last byte that is to be read (in the current packet */
     byte_t *                p_end;
-
-    /*
-     * Bit structures
-     */
-    bit_fifo_t              fifo;
+    /* Temporary buffer in case we're not aligned when changing data packets */
+    WORD_TYPE               i_showbits_buffer;
+    data_packet_t           showbits_data;
 } bit_stream_t;
 
 /*****************************************************************************
@@ -172,149 +179,88 @@ typedef struct bit_stream_s
  *****************************************************************************/
 
 /*
- * Philosophy of the first implementation : the bit buffer is first filled by
- * NeedBits, then the buffer can be read via p_bit_stream->fifo.buffer, and
- * unnecessary bits are dumped with a DumpBits() call.
+ * DISCUSSION : How to use the bit_stream structures
+ *
+ * sizeof(WORD_TYPE) (usually 32) bits are read at the same time, thus
+ * minimizing the number of p_byte changes.
+ * Bits are read via GetBits() or ShowBits.
+ *
+ * XXX : Be aware that if, in the forthcoming functions, i_bits > 24,
+ * the data have to be already aligned on an 8-bit boundary, or wrong
+ * results will be returned. Use RealignBits() if unsure.
  */
 
+#if (WORD_TYPE == u32)
+#   define WORD_AT      U32_AT
+#elif (WORD_TYPE == u64)
+#   define WORD_AT      U64_AT
+#else
+#   error Unsupported WORD_TYPE
+#endif
+
 /*****************************************************************************
- * GetByte : reads the next byte in the input stream
+ * Protoypes from input_ext-dec.c
  *****************************************************************************/
-static __inline__ byte_t GetByte( bit_stream_t * p_bit_stream )
-{
-    /* Are there some bytes left in the current data packet ? */
-    /* could change this test to have a if (! (bytes--)) instead */
-    if ( p_bit_stream->p_byte >= p_bit_stream->p_end )
-    {
-        /* no, switch to next data packet */
-        p_bit_stream->pf_next_data_packet( p_bit_stream );
-    }
-
-    return( *(p_bit_stream->p_byte++) );
-}
+u32  UnalignedShowBits( struct bit_stream_s *, unsigned int );
+void UnalignedRemoveBits( struct bit_stream_s * );
+u32  UnalignedGetBits( struct bit_stream_s *, unsigned int );
 
 /*****************************************************************************
- * NeedBits : reads i_bits new bits in the bit stream and stores them in the
- *            bit buffer
- *****************************************************************************
- * - i_bits must be less or equal 32 !
- * - There is something important to notice with that function : if the number
- * of bits available in the bit buffer when calling NeedBits() is greater than
- * 24 (i_available > 24) but less than the number of needed bits
- * (i_available < i_bits), the byte returned by GetByte() will be shifted with
- * a negative value and the number of bits available in the bit buffer will be
- * set to more than 32 !
+ * AlignWord : fill in the bit buffer so that the byte pointer be aligned
+ * on a word boundary (XXX: there must be at least sizeof(WORD_TYPE) - 1
+ * empty bytes in the bit buffer)
  *****************************************************************************/
-static __inline__ void NeedBits( bit_stream_t * p_bit_stream, int i_bits )
+static __inline__ void AlignWord( bit_stream_t * p_bit_stream )
 {
-    while ( p_bit_stream->fifo.i_available < i_bits )
+    while( (ptrdiff_t)p_bit_stream->p_byte
+             & (sizeof(WORD_TYPE) - 1) )
     {
-        p_bit_stream->fifo.buffer |= ((WORD_TYPE)GetByte( p_bit_stream ))
-                                     << (sizeof(WORD_TYPE) - 8
-                                            - p_bit_stream->fifo.i_available);
-        p_bit_stream->fifo.i_available += 8;
+        if( p_bit_stream->p_byte < p_bit_stream->p_end )
+        {
+            p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
+                << (8 * sizeof(WORD_TYPE) - 8
+                     - p_bit_stream->fifo.i_available);
+            p_bit_stream->fifo.i_available += 8;
+        }
+        else
+        {
+            p_bit_stream->pf_next_data_packet( p_bit_stream );
+            p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
+                << (8 * sizeof(WORD_TYPE) - 8
+                     - p_bit_stream->fifo.i_available);
+            p_bit_stream->fifo.i_available += 8;
+        }
     }
 }
 
-/*****************************************************************************
- * DumpBits : removes i_bits bits from the bit buffer
- *****************************************************************************
- * - i_bits <= i_available
- * - i_bits < 32 (because (u32 << 32) <=> (u32 = u32))
- *****************************************************************************/
-static __inline__ void DumpBits( bit_stream_t * p_bit_stream, int i_bits )
-{
-    p_bit_stream->fifo.buffer <<= i_bits;
-    p_bit_stream->fifo.i_available -= i_bits;
-}
-
-
-/*
- * Philosophy of the second implementation : WORD_LENGTH (usually 32) bits
- * are read at the same time, thus minimizing the number of p_byte changes.
- * Bits are read via GetBits() or ShowBits. This is slightly faster. Be
- * aware that if, in the forthcoming functions, i_bits > 24, the data have to
- * be already aligned on an 8-bit boundary, or wrong results will be
- * returned.
- */
-
-#if (WORD_TYPE != u32)
-#   error Not supported word
-#endif
-
-/*
- * This is stolen from the livid source who stole it from the kernel
- * FIXME: The macro swab32 for little endian machines does
- *        not seem to work correctly
- */
-
-#if defined(SYS_BEOS)
-#   define swab32(x) B_BENDIAN_TO_HOST_INT32(x)
-#else
-#   ifdef WORDS_BIG_ENDIAN
-#       define swab32(x) (x)
-#   else
-#       if defined (HAVE_X86_BSWAP)
-static __inline__ const u32 __i386_swab32( u32 x )
-{
-    __asm__("bswap %0" : "=r" (x) : "0" (x));
-    return x;
-}
-#           define swab32(x) __i386_swab32(x)
-#       else
-#           define swab32(x)                                                 \
-            ( ( (u32)(((u8*)&x)[0]) << 24 ) | ( (u32)(((u8*)&x)[1]) << 16 ) |\
-              ( (u32)(((u8*)&x)[2]) << 8 )  | ( (u32)(((u8*)&x)[3])) )
-#       endif
-#   endif
-#endif
-
 /*****************************************************************************
  * ShowBits : return i_bits bits from the bit stream
  *****************************************************************************/
-static __inline__ WORD_TYPE ShowWord( bit_stream_t * p_bit_stream )
-{
-    if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
-    {
-        return( swab32( *((WORD_TYPE *)p_bit_stream->p_byte) ) );
-    }
-
-    p_bit_stream->pf_next_data_packet( p_bit_stream );
-    return( swab32( *((WORD_TYPE *)p_bit_stream->p_byte) ) );
-}
-
-static __inline__ WORD_TYPE ShowBits( bit_stream_t * p_bit_stream, int i_bits )
+static __inline__ u32 ShowBits( bit_stream_t * p_bit_stream,
+                                unsigned int i_bits )
 {
     if( p_bit_stream->fifo.i_available >= i_bits )
     {
         return( p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits) );
     }
 
-    return( (p_bit_stream->fifo.buffer |
-            (ShowWord( p_bit_stream ) >> p_bit_stream->fifo.i_available))
-                    >> (8 * sizeof(WORD_TYPE) - i_bits) );
-}
-
-/*****************************************************************************
- * GetWord : returns the next word to be read
- *****************************************************************************/
-static __inline__ WORD_TYPE GetWord( bit_stream_t * p_bit_stream )
-{
     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
     {
-        return( swab32( *(((WORD_TYPE *)p_bit_stream->p_byte)++) ) );
-    }
-    else
-    {
-        p_bit_stream->pf_next_data_packet( p_bit_stream );
-        return( swab32( *(((WORD_TYPE *)p_bit_stream->p_byte)++) ) );
+        return( (p_bit_stream->fifo.buffer |
+                    (WORD_AT( p_bit_stream->p_byte )
+                        >> p_bit_stream->fifo.i_available))
+                    >> (8 * sizeof(WORD_TYPE) - i_bits) );
     }
+
+    return UnalignedShowBits( p_bit_stream, i_bits );
 }
 
 /*****************************************************************************
  * RemoveBits : removes i_bits bits from the bit buffer
+ *              XXX: do not use for 32 bits, see RemoveBits32
  *****************************************************************************/
-static __inline__ void RemoveBits( bit_stream_t * p_bit_stream, int i_bits )
+static __inline__ void RemoveBits( bit_stream_t * p_bit_stream,
+                                   unsigned int i_bits )
 {
     p_bit_stream->fifo.i_available -= i_bits;
 
@@ -323,64 +269,123 @@ static __inline__ void RemoveBits( bit_stream_t * p_bit_stream, int i_bits )
         p_bit_stream->fifo.buffer <<= i_bits;
         return;
     }
-    p_bit_stream->fifo.buffer = GetWord( p_bit_stream )
-                            << ( -p_bit_stream->fifo.i_available );
-    p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
+
+    if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
+    {
+        p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
+                                        << ( -p_bit_stream->fifo.i_available );
+        ((WORD_TYPE *)p_bit_stream->p_byte)++;
+        p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
+        return;
+    }
+
+    UnalignedRemoveBits( p_bit_stream );
 }
 
 /*****************************************************************************
  * RemoveBits32 : removes 32 bits from the bit buffer (and as a side effect,
- *                refill it). This should be faster than RemoveBits, though
- *                RemoveBits will work, too.
+ *                refill it)
  *****************************************************************************/
+#if (WORD_TYPE == u32)
 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
 {
-    p_bit_stream->fifo.buffer = GetWord( p_bit_stream )
-                        << (32 - p_bit_stream->fifo.i_available);
+    if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
+    {
+        if( p_bit_stream->fifo.i_available )
+        {
+            p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
+                            << (32 - p_bit_stream->fifo.i_available);
+            ((WORD_TYPE *)p_bit_stream->p_byte)++;
+            return;
+        }
+
+        ((WORD_TYPE *)p_bit_stream->p_byte)++;
+        return;
+    }
+
+    p_bit_stream->fifo.i_available -= 32;
+    UnalignedRemoveBits( p_bit_stream );
 }
+#else
+#   define RemoveBits32( p_bit_stream )     RemoveBits( p_bit_stream, 32 )
+#endif
 
 /*****************************************************************************
  * GetBits : returns i_bits bits from the bit stream and removes them
+ *           XXX: do not use for 32 bits, see GetBits32
  *****************************************************************************/
-static __inline__ WORD_TYPE GetBits( bit_stream_t * p_bit_stream, int i_bits )
+static __inline__ u32 GetBits( bit_stream_t * p_bit_stream,
+                               unsigned int i_bits )
 {
     u32             i_result;
 
     p_bit_stream->fifo.i_available -= i_bits;
+
     if( p_bit_stream->fifo.i_available >= 0 )
     {
-        i_result = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits);
+        i_result = p_bit_stream->fifo.buffer
+                        >> (8 * sizeof(WORD_TYPE) - i_bits);
         p_bit_stream->fifo.buffer <<= i_bits;
         return( i_result );
     }
 
-    i_result = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits);
-    p_bit_stream->fifo.buffer = GetWord( p_bit_stream );
-    i_result |= p_bit_stream->fifo.buffer
-                             >> (8 * sizeof(WORD_TYPE)
+    if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
+    {
+        i_result = p_bit_stream->fifo.buffer
+                        >> (8 * sizeof(WORD_TYPE) - i_bits);
+        p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
+        ((WORD_TYPE *)p_bit_stream->p_byte)++;
+        i_result |= p_bit_stream->fifo.buffer
+                        >> (8 * sizeof(WORD_TYPE)
                                      + p_bit_stream->fifo.i_available);
-    p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
-    p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
+        p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
+        p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
+        return( i_result );
+    }
 
-    return( i_result );
+    return UnalignedGetBits( p_bit_stream, i_bits );
 }
 
 /*****************************************************************************
  * GetBits32 : returns 32 bits from the bit stream and removes them
  *****************************************************************************/
-static __inline__ WORD_TYPE GetBits32( bit_stream_t * p_bit_stream )
+#if (WORD_TYPE == u32)
+static __inline__ u32 GetBits32( bit_stream_t * p_bit_stream )
 {
-    WORD_TYPE               i_result;
+    u32             i_result;
+
+    if( p_bit_stream->fifo.i_available == 32 )
+    {
+        p_bit_stream->fifo.i_available = 0;
+        i_result = p_bit_stream->fifo.buffer;
+        p_bit_stream->fifo.buffer = 0;
+        return( i_result );
+    }
 
-    i_result = p_bit_stream->fifo.buffer;
-    p_bit_stream->fifo.buffer = GetWord( p_bit_stream );
-    i_result |= p_bit_stream->fifo.buffer
+    if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
+    {
+        if( p_bit_stream->fifo.i_available )
+        {
+            i_result = p_bit_stream->fifo.buffer;
+            p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
+            ((WORD_TYPE *)p_bit_stream->p_byte)++;
+            i_result |= p_bit_stream->fifo.buffer
                              >> (p_bit_stream->fifo.i_available);
-    p_bit_stream->fifo.buffer <<= (8 * sizeof(WORD_TYPE)
-                                    - p_bit_stream->fifo.i_available);
-    
-    return( i_result );
+            p_bit_stream->fifo.buffer <<= (32 - p_bit_stream->fifo.i_available);
+            return( i_result );
+        }
+
+        i_result = WORD_AT( p_bit_stream->p_byte );
+        ((WORD_TYPE *)p_bit_stream->p_byte)++;
+        return( i_result );
+    }
+
+    p_bit_stream->fifo.i_available -= 32;
+    return UnalignedGetBits( p_bit_stream, 32 );
 }
+#else
+#   define GetBits32( p_bit_stream )    GetBits( p_bit_stream, 32 )
+#endif
 
 /*****************************************************************************
  * RealignBits : realigns the bit buffer on an 8-bit boundary
@@ -392,11 +397,6 @@ static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
 }
 
 
-/*
- * Philosophy of the third implementation : the decoder asks for n bytes,
- * and we will copy them in its buffer.
- */
-
 /*****************************************************************************
  * GetChunk : reads a large chunk of data
  *****************************************************************************
@@ -409,6 +409,15 @@ static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
 {
     ptrdiff_t           i_available;
 
+    if( p_bit_stream->fifo.i_available )
+    {
+        *((WORD_TYPE *)p_buffer) = WORD_AT( &p_bit_stream->fifo.buffer );
+        p_buffer += p_bit_stream->fifo.i_available >> 3;
+        i_buf_len -= p_bit_stream->fifo.i_available >> 3;
+        p_bit_stream->fifo.buffer = 0;
+        p_bit_stream->fifo.i_available = 0;
+    }
+
     if( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
             >= i_buf_len )
     {
@@ -426,7 +435,7 @@ static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
             p_bit_stream->pf_next_data_packet( p_bit_stream );
         }
         while( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
-                <= i_buf_len );
+                <= i_buf_len && !p_bit_stream->p_decoder_fifo->b_die );
 
         if( i_buf_len )
         {
@@ -434,6 +443,43 @@ static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
             p_bit_stream->p_byte += i_buf_len;
         }
     }
+
+    if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
+    {
+        AlignWord( p_bit_stream );
+    }
+}
+
+
+/*
+ * The following functions are now deprecated.
+ */
+
+static __inline__ byte_t _GetByte( bit_stream_t * p_bit_stream )
+{
+    if ( p_bit_stream->p_byte >= p_bit_stream->p_end )
+    {
+        p_bit_stream->pf_next_data_packet( p_bit_stream );
+    }
+
+    return( *(p_bit_stream->p_byte++) );
+}
+
+static __inline__ void NeedBits( bit_stream_t * p_bit_stream, int i_bits )
+{
+    while ( p_bit_stream->fifo.i_available < i_bits )
+    {
+        p_bit_stream->fifo.buffer |= ((WORD_TYPE)_GetByte( p_bit_stream ))
+                                     << (8 * sizeof(WORD_TYPE) - 8
+                                            - p_bit_stream->fifo.i_available);
+        p_bit_stream->fifo.i_available += 8;
+    }
+}
+
+static __inline__ void DumpBits( bit_stream_t * p_bit_stream, int i_bits )
+{
+    p_bit_stream->fifo.buffer <<= i_bits;
+    p_bit_stream->fifo.i_available -= i_bits;
 }
 
 
@@ -454,7 +500,10 @@ typedef struct decoder_config_s
     struct stream_ctrl_s *  p_stream_ctrl;
     struct decoder_fifo_s * p_decoder_fifo;
     void                 (* pf_init_bit_stream)( struct bit_stream_s *,
-                                                 struct decoder_fifo_s * );
+                                                 struct decoder_fifo_s *,
+                 void (* pf_bitstream_callback)( struct bit_stream_s *,
+                                                 boolean_t ),
+                                                 void * );
 } decoder_config_t;
 
 /*****************************************************************************
@@ -496,15 +545,10 @@ typedef struct vdec_config_s
  *****************************************************************************
  * Pointers given to audio decoders threads.
  *****************************************************************************/
-struct aout_thread_s;
-
 typedef struct adec_config_s
 {
-    struct aout_thread_s *  p_aout;
-
-    struct aout_fifo_s * (* pf_create_fifo)( struct aout_thread_s *,
-                                            struct aout_fifo_s * );
-    void                 (* pf_destroy_fifo)( struct aout_thread_s *);
+    struct aout_fifo_s * (* pf_create_fifo)( struct aout_fifo_s * );
+    void                 (* pf_destroy_fifo)( void );
 
     decoder_config_t        decoder_config;
 } adec_config_t;