git.sesse.net Git - vlc/blob - include/input_ext-dec.h

   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.42 2001/12/10 04:53:10 sam Exp $
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Michel Kaempf <maxx@via.ecp.fr>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  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
  35
  36 /* Structures exported to the decoders */
  37
  38 /*****************************************************************************
  39  * data_packet_t
  40  *****************************************************************************
  41  * Describe a data packet.
  42  *****************************************************************************/
  43 typedef struct data_packet_s
  44 {
  45     /* Nothing before this line, the code relies on that */
  46     byte_t *                p_buffer;                     /* raw data packet */
  47     long                    l_size;                           /* buffer size */
  48
  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 ? */
  54
  55     int *                   pi_refcount;
  56
  57     /* Used to chain the TS packets that carry data for a same PES or PSI */
  58     struct data_packet_s *  p_next;
  59 } data_packet_t;
  60
  61 /*****************************************************************************
  62  * pes_packet_t
  63  *****************************************************************************
  64  * Describes an PES packet, with its properties, and pointers to the TS packets
  65  * containing it.
  66  *****************************************************************************/
  67 typedef struct pes_packet_s
  68 {
  69     /* PES properties */
  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
  73                                               * previous one                 */
  74
  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) */
  79
  80     int                     i_pes_size;    /* size of the current PES packet */
  81
  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). */
  86 } pes_packet_t;
  87
  88 /*****************************************************************************
  89  * decoder_fifo_t
  90  *****************************************************************************
  91  * This rotative FIFO contains PES packets that are to be decoded.
  92  *****************************************************************************/
  93 typedef struct decoder_fifo_s
  94 {
  95     /* Thread structures */
  96     vlc_mutex_t             data_lock;                     /* fifo data lock */
  97     vlc_cond_t              data_wait;     /* fifo data conditional variable */
  98
  99     /* Data */
 100     pes_packet_t *          buffer[FIFO_SIZE + 1];
 101     int                     i_start;
 102     int                     i_end;
 103
 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 */
 111 } decoder_fifo_t;
 112
 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)\
 117                                           & FIFO_SIZE ) == 0 )
 118 #define DECODER_FIFO_START( fifo )    ( (fifo).buffer[ (fifo).i_start ] )
 119 #define DECODER_FIFO_INCSTART( fifo ) ( (fifo).i_start = ((fifo).i_start + 1)\
 120                                                          & FIFO_SIZE )
 121 #define DECODER_FIFO_END( fifo )      ( (fifo).buffer[ (fifo).i_end ] )
 122 #define DECODER_FIFO_INCEND( fifo )   ( (fifo).i_end = ((fifo).i_end + 1) \
 123                                                        & FIFO_SIZE )
 124
 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;
 132
 133 typedef struct bit_fifo_s
 134 {
 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. */
 138     WORD_TYPE           buffer;
 139
 140     /* Number of bits available in the bit buffer */
 141     int                 i_available;
 142
 143 } bit_fifo_t;
 144
 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
 152 {
 153     /*
 154      * Bit structures
 155      */
 156     bit_fifo_t              fifo;
 157
 158     /*
 159      * Input structures
 160      */
 161     /* The decoder fifo contains the data of the PES stream */
 162     decoder_fifo_t *        p_decoder_fifo;
 163
 164     /* Function to jump to the next data packet */
 165     void                 (* pf_next_data_packet)( struct bit_stream_s * );
 166
 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;
 173
 174     /*
 175      * Byte structures
 176      */
 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) */
 180     byte_t *                p_byte;
 181     /* Pointer to the last byte that is to be read (in the current packet */
 182     byte_t *                p_end;
 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;
 186 } bit_stream_t;
 187
 188 /*****************************************************************************
 189  * Inline functions used by the decoders to read bit_stream_t
 190  *****************************************************************************/
 191
 192 /*
 193  * DISCUSSION : How to use the bit_stream structures
 194  *
 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.
 198  *
 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.
 202  */
 203
 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
 210 #else
 211 #   error Unsupported WORD_TYPE
 212 #endif
 213
 214 /*****************************************************************************
 215  * Protoypes from input_ext-dec.c
 216  *****************************************************************************/
 217 #ifndef PLUGIN
 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 );
 221 #else
 222 #   define UnalignedShowBits p_symbols->UnalignedShowBits
 223 #   define UnalignedRemoveBits p_symbols->UnalignedRemoveBits
 224 #   define UnalignedGetBits p_symbols->UnalignedGetBits
 225 #endif
 226
 227 /*****************************************************************************
 228  * AlignWord : fill in the bit buffer so that the byte pointer be aligned
 229  * on a word boundary (XXX: there must be at least sizeof(WORD_TYPE) - 1
 230  * empty bytes in the bit buffer)
 231  *****************************************************************************/
 232 static __inline__ void AlignWord( bit_stream_t * p_bit_stream )
 233 {
 234     while( (ptrdiff_t)p_bit_stream->p_byte
 235              & (sizeof(WORD_TYPE) - 1) )
 236     {
 237         if( p_bit_stream->p_byte < p_bit_stream->p_end )
 238         {
 239             p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
 240                 << (8 * sizeof(WORD_TYPE) - 8
 241                      - p_bit_stream->fifo.i_available);
 242             p_bit_stream->fifo.i_available += 8;
 243         }
 244         else
 245         {
 246             p_bit_stream->pf_next_data_packet( p_bit_stream );
 247             p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
 248                 << (8 * sizeof(WORD_TYPE) - 8
 249                      - p_bit_stream->fifo.i_available);
 250             p_bit_stream->fifo.i_available += 8;
 251         }
 252     }
 253 }
 254
 255 /*****************************************************************************
 256  * ShowBits : return i_bits bits from the bit stream
 257  *****************************************************************************/
 258 static __inline__ u32 ShowBits( bit_stream_t * p_bit_stream,
 259                                 unsigned int i_bits )
 260 {
 261     if( p_bit_stream->fifo.i_available >= i_bits )
 262     {
 263         return( p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits) );
 264     }
 265
 266     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 267     {
 268         return( (p_bit_stream->fifo.buffer |
 269                     (WORD_AT( p_bit_stream->p_byte )
 270                         >> p_bit_stream->fifo.i_available))
 271                     >> (8 * sizeof(WORD_TYPE) - i_bits) );
 272     }
 273
 274     return( UnalignedShowBits( p_bit_stream, i_bits ) );
 275 }
 276
 277 /*****************************************************************************
 278  * ShowSignedBits : return i_bits bits from the bit stream, using signed
 279  *                  arithmetic
 280  *****************************************************************************/
 281 static __inline__ s32 ShowSignedBits( bit_stream_t * p_bit_stream,
 282                                       unsigned int i_bits )
 283 {
 284     if( p_bit_stream->fifo.i_available >= i_bits )
 285     {
 286         return( (WORD_SIGNED)p_bit_stream->fifo.buffer
 287                     >> (8 * sizeof(WORD_TYPE) - i_bits) );
 288     }
 289
 290     /* You can probably do something a little faster, but now I'm tired. */
 291     return( (WORD_SIGNED)(ShowBits( p_bit_stream, i_bits ) << (32 - i_bits))
 292              >> (32 - i_bits) );
 293 }
 294
 295 /*****************************************************************************
 296  * RemoveBits : removes i_bits bits from the bit buffer
 297  *              XXX: do not use for 32 bits, see RemoveBits32
 298  *****************************************************************************/
 299 static __inline__ void RemoveBits( bit_stream_t * p_bit_stream,
 300                                    unsigned int i_bits )
 301 {
 302     p_bit_stream->fifo.i_available -= i_bits;
 303
 304     if( p_bit_stream->fifo.i_available >= 0 )
 305     {
 306         p_bit_stream->fifo.buffer <<= i_bits;
 307         return;
 308     }
 309
 310     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 311     {
 312         p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
 313                                         << ( -p_bit_stream->fifo.i_available );
 314         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 315         p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
 316         return;
 317     }
 318
 319     UnalignedRemoveBits( p_bit_stream );
 320 }
 321
 322 /*****************************************************************************
 323  * RemoveBits32 : removes 32 bits from the bit buffer (and as a side effect,
 324  *                refill it)
 325  *****************************************************************************/
 326 #if (WORD_TYPE == u32)
 327 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
 328 {
 329     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 330     {
 331         if( p_bit_stream->fifo.i_available )
 332         {
 333             p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
 334                             << (32 - p_bit_stream->fifo.i_available);
 335             ((WORD_TYPE *)p_bit_stream->p_byte)++;
 336             return;
 337         }
 338
 339         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 340         return;
 341     }
 342
 343     p_bit_stream->fifo.i_available -= 32;
 344     UnalignedRemoveBits( p_bit_stream );
 345 }
 346 #else
 347 #   define RemoveBits32( p_bit_stream )     RemoveBits( p_bit_stream, 32 )
 348 #endif
 349
 350 /*****************************************************************************
 351  * GetBits : returns i_bits bits from the bit stream and removes them
 352  *           XXX: do not use for 32 bits, see GetBits32
 353  *****************************************************************************/
 354 static __inline__ u32 GetBits( bit_stream_t * p_bit_stream,
 355                                unsigned int i_bits )
 356 {
 357     u32             i_result;
 358
 359     p_bit_stream->fifo.i_available -= i_bits;
 360
 361     if( p_bit_stream->fifo.i_available >= 0 )
 362     {
 363         i_result = p_bit_stream->fifo.buffer
 364                         >> (8 * sizeof(WORD_TYPE) - i_bits);
 365         p_bit_stream->fifo.buffer <<= i_bits;
 366         return( i_result );
 367     }
 368
 369     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 370     {
 371         i_result = p_bit_stream->fifo.buffer
 372                         >> (8 * sizeof(WORD_TYPE) - i_bits);
 373         p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
 374         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 375         i_result |= p_bit_stream->fifo.buffer
 376                         >> (8 * sizeof(WORD_TYPE)
 377                                      + p_bit_stream->fifo.i_available);
 378         p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
 379         p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
 380         return( i_result );
 381     }
 382
 383     return UnalignedGetBits( p_bit_stream, i_bits );
 384 }
 385
 386 /*****************************************************************************
 387  * GetSignedBits : returns i_bits bits from the bit stream and removes them,
 388  *                 using signed arithmetic
 389  *                 XXX: do not use for 32 bits
 390  *****************************************************************************/
 391 static __inline__ s32 GetSignedBits( bit_stream_t * p_bit_stream,
 392                                      unsigned int i_bits )
 393 {
 394     if( p_bit_stream->fifo.i_available >= i_bits )
 395     {
 396         s32             i_result;
 397
 398         p_bit_stream->fifo.i_available -= i_bits;
 399         i_result = (WORD_SIGNED)p_bit_stream->fifo.buffer
 400                         >> (8 * sizeof(WORD_TYPE) - i_bits);
 401         p_bit_stream->fifo.buffer <<= i_bits;
 402         return( i_result );
 403     }
 404
 405     /* You can probably do something a little faster, but now I'm tired. */
 406     return( (WORD_SIGNED)(GetBits( p_bit_stream, i_bits ) << (32 - i_bits))
 407              >> (32 - i_bits) );
 408 }
 409
 410 /*****************************************************************************
 411  * GetBits32 : returns 32 bits from the bit stream and removes them
 412  *****************************************************************************/
 413 #if (WORD_TYPE == u32)
 414 static __inline__ u32 GetBits32( bit_stream_t * p_bit_stream )
 415 {
 416     u32             i_result;
 417
 418     if( p_bit_stream->fifo.i_available == 32 )
 419     {
 420         p_bit_stream->fifo.i_available = 0;
 421         i_result = p_bit_stream->fifo.buffer;
 422         p_bit_stream->fifo.buffer = 0;
 423         return( i_result );
 424     }
 425
 426     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 427     {
 428         if( p_bit_stream->fifo.i_available )
 429         {
 430             i_result = p_bit_stream->fifo.buffer;
 431             p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
 432             ((WORD_TYPE *)p_bit_stream->p_byte)++;
 433             i_result |= p_bit_stream->fifo.buffer
 434                              >> (p_bit_stream->fifo.i_available);
 435             p_bit_stream->fifo.buffer <<= (32 - p_bit_stream->fifo.i_available);
 436             return( i_result );
 437         }
 438
 439         i_result = WORD_AT( p_bit_stream->p_byte );
 440         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 441         return( i_result );
 442     }
 443
 444     p_bit_stream->fifo.i_available -= 32;
 445     return UnalignedGetBits( p_bit_stream, 32 );
 446 }
 447 #else
 448 #   define GetBits32( p_bit_stream )    GetBits( p_bit_stream, 32 )
 449 #endif
 450
 451 /*****************************************************************************
 452  * RealignBits : realigns the bit buffer on an 8-bit boundary
 453  *****************************************************************************/
 454 static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
 455 {
 456     p_bit_stream->fifo.buffer <<= (p_bit_stream->fifo.i_available & 0x7);
 457     p_bit_stream->fifo.i_available &= ~0x7;
 458 }
 459
 460
 461 /*****************************************************************************
 462  * GetChunk : reads a large chunk of data
 463  *****************************************************************************
 464  * The position in the stream must be byte-aligned, if unsure call
 465  * RealignBits(). p_buffer must point to a buffer at least as big as i_buf_len
 466  * otherwise your code will crash.
 467  *****************************************************************************/
 468 static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
 469                                  byte_t * p_buffer, size_t i_buf_len )
 470 {
 471     ptrdiff_t           i_available;
 472
 473     /* We need to take care because i_buf_len may be < 4. */
 474     while( p_bit_stream->fifo.i_available > 0 && i_buf_len )
 475     {
 476         *p_buffer = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - 8);
 477         p_buffer++;
 478         i_buf_len--;
 479         p_bit_stream->fifo.buffer <<= 8;
 480         p_bit_stream->fifo.i_available -= 8;
 481     }
 482
 483     if( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
 484             >= i_buf_len )
 485     {
 486         p_main->fast_memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
 487         p_bit_stream->p_byte += i_buf_len;
 488     }
 489     else
 490     {
 491         do
 492         {
 493             p_main->fast_memcpy( p_buffer, p_bit_stream->p_byte, i_available );
 494             p_bit_stream->p_byte = p_bit_stream->p_end;
 495             p_buffer += i_available;
 496             i_buf_len -= i_available;
 497             p_bit_stream->pf_next_data_packet( p_bit_stream );
 498         }
 499         while( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
 500                 <= i_buf_len && !p_bit_stream->p_decoder_fifo->b_die );
 501
 502         if( i_buf_len )
 503         {
 504             p_main->fast_memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
 505             p_bit_stream->p_byte += i_buf_len;
 506         }
 507     }
 508
 509     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 510     {
 511         AlignWord( p_bit_stream );
 512     }
 513 }
 514
 515
 516 /*
 517  * Communication interface between input and decoders
 518  */
 519
 520 /*****************************************************************************
 521  * decoder_config_t
 522  *****************************************************************************
 523  * Standard pointers given to the decoders as a toolbox.
 524  *****************************************************************************/
 525 typedef struct decoder_config_s
 526 {
 527     u16                     i_id;
 528     u8                      i_type;         /* type of the elementary stream */
 529
 530     struct stream_ctrl_s *  p_stream_ctrl;
 531     struct decoder_fifo_s * p_decoder_fifo;
 532     void                 (* pf_init_bit_stream)( struct bit_stream_s *,
 533                                                  struct decoder_fifo_s *,
 534                  void (* pf_bitstream_callback)( struct bit_stream_s *,
 535                                                  boolean_t ),
 536                                                  void * );
 537 } decoder_config_t;
 538