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.17 2001/01/20 13:08:33 sam Exp $
   6  *
   7  * Authors:
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /* Structures exported to the decoders */
  25
  26 /*****************************************************************************
  27  * data_packet_t
  28  *****************************************************************************
  29  * Describe a data packet.
  30  *****************************************************************************/
  31 typedef struct data_packet_s
  32 {
  33     /* Nothing before this line, the code relies on that */
  34     byte_t *                p_buffer;                     /* raw data packet */
  35
  36     /* Decoders information */
  37     byte_t *                p_payload_start;
  38                                   /* start of the PES payload in this packet */
  39     byte_t *                p_payload_end;                    /* guess ? :-) */
  40     boolean_t               b_discard_payload;  /* is the packet messed up ? */
  41
  42     /* Used to chain the TS packets that carry data for a same PES or PSI */
  43     struct data_packet_s *  p_next;
  44 } data_packet_t;
  45
  46 /*****************************************************************************
  47  * pes_packet_t
  48  *****************************************************************************
  49  * Describes an PES packet, with its properties, and pointers to the TS packets
  50  * containing it.
  51  *****************************************************************************/
  52 typedef struct pes_packet_s
  53 {
  54     /* PES properties */
  55     boolean_t               b_messed_up;  /* At least one of the data packets
  56                                            * has a questionable content      */
  57     boolean_t               b_data_alignment;  /* used to find the beginning of
  58                                                 * a video or audio unit      */
  59     boolean_t               b_discontinuity; /* This packet doesn't follow the
  60                                               * previous one                 */
  61
  62     mtime_t                 i_pts;/* the PTS for this packet (zero if unset) */
  63     mtime_t                 i_dts;/* the DTS for this packet (zero if unset) */
  64
  65     int                     i_pes_size;    /* size of the current PES packet */
  66
  67     /* Pointers to packets (packets are then linked by the p_prev and
  68        p_next fields of the data_packet_t struct) */
  69     data_packet_t *         p_first;      /* The first packet contained by this
  70                                            * PES (used by decoders). */
  71 } pes_packet_t;
  72
  73 /*****************************************************************************
  74  * decoder_fifo_t
  75  *****************************************************************************
  76  * This rotative FIFO contains PES packets that are to be decoded.
  77  *****************************************************************************/
  78 typedef struct decoder_fifo_s
  79 {
  80     /* Thread structures */
  81     vlc_mutex_t             data_lock;                     /* fifo data lock */
  82     vlc_cond_t              data_wait;     /* fifo data conditional variable */
  83
  84     /* Data */
  85     pes_packet_t *          buffer[FIFO_SIZE + 1];
  86     int                     i_start;
  87     int                     i_end;
  88
  89     /* Communication interface between input and decoders */
  90     boolean_t               b_die;          /* the decoder should return now */
  91     boolean_t               b_error;      /* the decoder is in an error loop */
  92     void *                  p_packets_mgt;   /* packets management services
  93                                               * data (netlist...)            */
  94     void                 (* pf_delete_pes)( void *, pes_packet_t * );
  95                                      /* function to use when releasing a PES */
  96 } decoder_fifo_t;
  97
  98 /* Macros to manage a decoder_fifo_t structure. Please remember to take
  99  * data_lock before using them. */
 100 #define DECODER_FIFO_ISEMPTY( fifo )  ( (fifo).i_start == (fifo).i_end )
 101 #define DECODER_FIFO_ISFULL( fifo )   ( ( ((fifo).i_end + 1 - (fifo).i_start)\
 102                                           & FIFO_SIZE ) == 0 )
 103 #define DECODER_FIFO_START( fifo )    ( (fifo).buffer[ (fifo).i_start ] )
 104 #define DECODER_FIFO_INCSTART( fifo ) ( (fifo).i_start = ((fifo).i_start + 1)\
 105                                                          & FIFO_SIZE )
 106 #define DECODER_FIFO_END( fifo )      ( (fifo).buffer[ (fifo).i_end ] )
 107 #define DECODER_FIFO_INCEND( fifo )   ( (fifo).i_end = ((fifo).i_end + 1) \
 108                                                        & FIFO_SIZE )
 109
 110 /*****************************************************************************
 111  * bit_fifo_t : bit fifo descriptor
 112  *****************************************************************************
 113  * This type describes a bit fifo used to store bits while working with the
 114  * input stream at the bit level.
 115  *****************************************************************************/
 116 typedef u32         WORD_TYPE;
 117
 118 typedef struct bit_fifo_s
 119 {
 120     /* This unsigned integer allows us to work at the bit level. This buffer
 121      * can contain 32 bits, and the used space can be found on the MSb's side
 122      * and the available space on the LSb's side. */
 123     WORD_TYPE           buffer;
 124
 125     /* Number of bits available in the bit buffer */
 126     int                 i_available;
 127
 128 } bit_fifo_t;
 129
 130 /*****************************************************************************
 131  * bit_stream_t : bit stream descriptor
 132  *****************************************************************************
 133  * This type, based on a PES stream, includes all the structures needed to
 134  * handle the input stream like a bit stream.
 135  *****************************************************************************/
 136 typedef struct bit_stream_s
 137 {
 138     /*
 139      * Input structures
 140      */
 141     /* The decoder fifo contains the data of the PES stream */
 142     decoder_fifo_t *        p_decoder_fifo;
 143
 144     /* Function to jump to the next data packet */
 145     void                 (* pf_next_data_packet)( struct bit_stream_s * );
 146
 147     /* Callback to the decoder used when changing data packets ; set
 148      * to NULL if your decoder doesn't need it. */
 149     void                 (* pf_bitstream_callback)( struct bit_stream_s *,
 150                                                     boolean_t b_new_pes );
 151     /* Optional argument to the callback */
 152     void *                  p_callback_arg;
 153
 154     /*
 155      * Byte structures
 156      */
 157     /* Current data packet (in the current PES packet of the PES stream) */
 158     data_packet_t *         p_data;
 159     /* Pointer to the next byte that is to be read (in the current TS packet) */
 160     byte_t *                p_byte;
 161     /* Pointer to the last byte that is to be read (in the current TS packet */
 162     byte_t *                p_end;
 163
 164     /*
 165      * Bit structures
 166      */
 167     bit_fifo_t              fifo;
 168 } bit_stream_t;
 169
 170 /*****************************************************************************
 171  * Inline functions used by the decoders to read bit_stream_t
 172  *****************************************************************************/
 173
 174 /*
 175  * DISCUSSION : How to use the bit_stream structures
 176  *
 177  * sizeof(WORD_TYPE) (usually 32) bits are read at the same time, thus
 178  * minimizing the number of p_byte changes.
 179  * Bits are read via GetBits() or ShowBits.
 180  *
 181  * XXX : Be aware that if, in the forthcoming functions, i_bits > 24,
 182  * the data have to be already aligned on an 8-bit boundary, or wrong
 183  * results will be returned. Use RealignBits() if unsure.
 184  */
 185
 186 #if (WORD_TYPE == u32)
 187 #   define WORD_AT      U32_AT
 188 #elif (WORD_TYPE == u64)
 189 #   define WORD_AT      U64_AT
 190 #else
 191 #   error Unsupported WORD_TYPE
 192 #endif
 193
 194 /*****************************************************************************
 195  * Protoypes from input_ext-dec.c
 196  *****************************************************************************/
 197 u32  UnalignedShowBits( struct bit_stream_s *, unsigned int );
 198 void UnalignedRemoveBits( struct bit_stream_s * );
 199 u32  UnalignedGetBits( struct bit_stream_s *, unsigned int );
 200
 201 /*****************************************************************************
 202  * AlignWord : fill in the bit buffer so that the byte pointer be aligned
 203  * on a word boundary (XXX: there must be at least sizeof(WORD_TYPE) - 1
 204  * empty bytes in the bit buffer)
 205  *****************************************************************************/
 206 static __inline__ void AlignWord( bit_stream_t * p_bit_stream )
 207 {
 208     while( (p_bit_stream->p_byte - p_bit_stream->p_data->p_buffer)
 209              & (sizeof(WORD_TYPE) - 1) )
 210     {
 211         if( p_bit_stream->p_byte < p_bit_stream->p_end )
 212         {
 213             p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
 214                 << (8 * sizeof(WORD_TYPE) - 8
 215                      - p_bit_stream->fifo.i_available);
 216             p_bit_stream->fifo.i_available += 8;
 217         }
 218         else
 219         {
 220             p_bit_stream->pf_next_data_packet( p_bit_stream );
 221             p_bit_stream->fifo.buffer |= *(p_bit_stream->p_byte++)
 222                 << (8 * sizeof(WORD_TYPE) - 8
 223                      - p_bit_stream->fifo.i_available);
 224             p_bit_stream->fifo.i_available += 8;
 225         }
 226     }
 227 }
 228
 229 /*****************************************************************************
 230  * ShowBits : return i_bits bits from the bit stream
 231  *****************************************************************************/
 232 static __inline__ u32 ShowBits( bit_stream_t * p_bit_stream,
 233                                 unsigned int i_bits )
 234 {
 235     if( p_bit_stream->fifo.i_available >= i_bits )
 236     {
 237         return( p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits) );
 238     }
 239
 240     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 241     {
 242         return( (p_bit_stream->fifo.buffer |
 243                     (WORD_AT( p_bit_stream->p_byte )
 244                         >> p_bit_stream->fifo.i_available))
 245                     >> (8 * sizeof(WORD_TYPE) - i_bits) );
 246     }
 247
 248     return UnalignedShowBits( p_bit_stream, i_bits );
 249 }
 250
 251 /*****************************************************************************
 252  * RemoveBits : removes i_bits bits from the bit buffer
 253  *              XXX: do not use for 32 bits, see RemoveBits32
 254  *****************************************************************************/
 255 static __inline__ void RemoveBits( bit_stream_t * p_bit_stream,
 256                                    unsigned int i_bits )
 257 {
 258     p_bit_stream->fifo.i_available -= i_bits;
 259
 260     if( p_bit_stream->fifo.i_available >= 0 )
 261     {
 262         p_bit_stream->fifo.buffer <<= i_bits;
 263         return;
 264     }
 265
 266     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 267     {
 268         p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
 269                                         << ( -p_bit_stream->fifo.i_available );
 270         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 271         p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
 272         return;
 273     }
 274
 275     UnalignedRemoveBits( p_bit_stream );
 276 }
 277
 278 /*****************************************************************************
 279  * RemoveBits32 : removes 32 bits from the bit buffer (and as a side effect,
 280  *                refill it)
 281  *****************************************************************************/
 282 #if (WORD_TYPE == u32)
 283 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
 284 {
 285     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 286     {
 287         if( p_bit_stream->fifo.i_available )
 288         {
 289             p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte )
 290                             << (32 - p_bit_stream->fifo.i_available);
 291             ((WORD_TYPE *)p_bit_stream->p_byte)++;
 292             return;
 293         }
 294
 295         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 296         return;
 297     }
 298
 299     p_bit_stream->fifo.i_available -= 32;
 300     UnalignedRemoveBits( p_bit_stream );
 301 }
 302 #else
 303 #   define RemoveBits32( p_bit_stream )     RemoveBits( p_bit_stream, 32 )
 304 #endif
 305
 306 /*****************************************************************************
 307  * GetBits : returns i_bits bits from the bit stream and removes them
 308  *           XXX: do not use for 32 bits, see GetBits32
 309  *****************************************************************************/
 310 static __inline__ u32 GetBits( bit_stream_t * p_bit_stream,
 311                                unsigned int i_bits )
 312 {
 313     u32             i_result;
 314
 315     if( p_bit_stream->fifo.i_available >= i_bits )
 316     {
 317         p_bit_stream->fifo.i_available -= i_bits;
 318         i_result = p_bit_stream->fifo.buffer
 319                         >> (8 * sizeof(WORD_TYPE) - i_bits);
 320         p_bit_stream->fifo.buffer <<= i_bits;
 321         return( i_result );
 322     }
 323
 324     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 325     {
 326         p_bit_stream->fifo.i_available -= i_bits;
 327         i_result = p_bit_stream->fifo.buffer
 328                         >> (8 * sizeof(WORD_TYPE) - i_bits);
 329         p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
 330         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 331         i_result |= p_bit_stream->fifo.buffer
 332                         >> (8 * sizeof(WORD_TYPE)
 333                                      + p_bit_stream->fifo.i_available);
 334         p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
 335         p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
 336         return( i_result );
 337     }
 338
 339     return UnalignedGetBits( p_bit_stream, i_bits );
 340 }
 341
 342 /*****************************************************************************
 343  * GetBits32 : returns 32 bits from the bit stream and removes them
 344  *****************************************************************************/
 345 #if (WORD_TYPE == u32)
 346 static __inline__ u32 GetBits32( bit_stream_t * p_bit_stream )
 347 {
 348     u32             i_result;
 349
 350     if( p_bit_stream->fifo.i_available == 32 )
 351     {
 352         p_bit_stream->fifo.i_available = 0;
 353         i_result = p_bit_stream->fifo.buffer;
 354         p_bit_stream->fifo.buffer = 0;
 355         return( i_result );
 356     }
 357
 358     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 359     {
 360         if( p_bit_stream->fifo.i_available )
 361         {
 362             i_result = p_bit_stream->fifo.buffer;
 363             p_bit_stream->fifo.buffer = WORD_AT( p_bit_stream->p_byte );
 364             ((WORD_TYPE *)p_bit_stream->p_byte)++;
 365             i_result |= p_bit_stream->fifo.buffer
 366                              >> (p_bit_stream->fifo.i_available);
 367             p_bit_stream->fifo.buffer <<= (32 - p_bit_stream->fifo.i_available);
 368             return( i_result );
 369         }
 370
 371         i_result = WORD_AT( p_bit_stream->p_byte );
 372         ((WORD_TYPE *)p_bit_stream->p_byte)++;
 373         return( i_result );
 374     }
 375
 376     return UnalignedGetBits( p_bit_stream, 32 );
 377 }
 378 #else
 379 #   define GetBits32( p_bit_stream )    GetBits( p_bit_stream, 32 )
 380 #endif
 381
 382 /*****************************************************************************
 383  * RealignBits : realigns the bit buffer on an 8-bit boundary
 384  *****************************************************************************/
 385 static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
 386 {
 387     p_bit_stream->fifo.buffer <<= (p_bit_stream->fifo.i_available & 0x7);
 388     p_bit_stream->fifo.i_available &= ~0x7;
 389 }
 390
 391
 392 /*****************************************************************************
 393  * GetChunk : reads a large chunk of data
 394  *****************************************************************************
 395  * The position in the stream must be byte-aligned, if unsure call
 396  * RealignBits(). p_buffer must to a buffer at least as big as i_buf_len
 397  * otherwise your code will crash.
 398  *****************************************************************************/
 399 static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
 400                                  byte_t * p_buffer, size_t i_buf_len )
 401 {
 402     ptrdiff_t           i_available;
 403
 404     if( p_bit_stream->fifo.i_available )
 405     {
 406         *((WORD_TYPE *)p_buffer) = WORD_AT( &p_bit_stream->fifo.buffer );
 407         p_buffer += p_bit_stream->fifo.i_available >> 3;
 408         i_buf_len -= p_bit_stream->fifo.i_available >> 3;
 409         p_bit_stream->fifo.buffer = 0;
 410         p_bit_stream->fifo.i_available = 0;
 411     }
 412
 413     if( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
 414             >= i_buf_len )
 415     {
 416         memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
 417         p_bit_stream->p_byte += i_buf_len;
 418     }
 419     else
 420     {
 421         do
 422         {
 423             memcpy( p_buffer, p_bit_stream->p_byte, i_available );
 424             p_bit_stream->p_byte = p_bit_stream->p_end;
 425             p_buffer += i_available;
 426             i_buf_len -= i_available;
 427             p_bit_stream->pf_next_data_packet( p_bit_stream );
 428         }
 429         while( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
 430                 <= i_buf_len && !p_bit_stream->p_decoder_fifo->b_die );
 431
 432         if( i_buf_len )
 433         {
 434             memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
 435             p_bit_stream->p_byte += i_buf_len;
 436         }
 437     }
 438
 439     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 440     {
 441         AlignWord( p_bit_stream );
 442     }
 443 }
 444
 445
 446 /*
 447  * The following functions are now deprecated.
 448  */
 449
 450 static __inline__ byte_t _GetByte( bit_stream_t * p_bit_stream )
 451 {
 452     if ( p_bit_stream->p_byte >= p_bit_stream->p_end )
 453     {
 454         p_bit_stream->pf_next_data_packet( p_bit_stream );
 455     }
 456
 457     return( *(p_bit_stream->p_byte++) );
 458 }
 459
 460 static __inline__ void NeedBits( bit_stream_t * p_bit_stream, int i_bits )
 461 {
 462     while ( p_bit_stream->fifo.i_available < i_bits )
 463     {
 464         p_bit_stream->fifo.buffer |= ((WORD_TYPE)_GetByte( p_bit_stream ))
 465                                      << (8 * sizeof(WORD_TYPE) - 8
 466                                             - p_bit_stream->fifo.i_available);
 467         p_bit_stream->fifo.i_available += 8;
 468     }
 469 }
 470
 471 static __inline__ void DumpBits( bit_stream_t * p_bit_stream, int i_bits )
 472 {
 473     p_bit_stream->fifo.buffer <<= i_bits;
 474     p_bit_stream->fifo.i_available -= i_bits;
 475 }
 476
 477
 478 /*
 479  * Communication interface between input and decoders
 480  */
 481
 482 /*****************************************************************************
 483  * decoder_config_t
 484  *****************************************************************************
 485  * Standard pointers given to the decoders as a toolbox.
 486  *****************************************************************************/
 487 typedef struct decoder_config_s
 488 {
 489     u16                     i_id;
 490     u8                      i_type;         /* type of the elementary stream */
 491
 492     struct stream_ctrl_s *  p_stream_ctrl;
 493     struct decoder_fifo_s * p_decoder_fifo;
 494     void                 (* pf_init_bit_stream)( struct bit_stream_s *,
 495                                                  struct decoder_fifo_s * );
 496 } decoder_config_t;
 497
 498 /*****************************************************************************
 499  * vdec_config_t
 500  *****************************************************************************
 501  * Pointers given to video decoders threads.
 502  *****************************************************************************/
 503 struct vout_thread_s;
 504
 505 typedef struct vdec_config_s
 506 {
 507     struct vout_thread_s *  p_vout;
 508
 509     struct picture_s *   (* pf_create_picture)( struct vout_thread_s *,
 510                                                 int i_type, int i_width,
 511                                                 int i_height );
 512     void                 (* pf_destroy_picture)( struct vout_thread_s *,
 513                                                  struct picture_s * );
 514     void                 (* pf_display_picture)( struct vout_thread_s *,
 515                                                  struct picture_s * );
 516     void                 (* pf_date_picture)( struct vout_thread_s *,
 517                                               struct picture_s *, mtime_t date );
 518     void                 (* pf_link_picture)( struct vout_thread_s *,
 519                                               struct picture_s *, mtime_t date );
 520     void                 (* pf_unlink_picture)( struct vout_thread_s *,
 521                                                 struct picture_s *, mtime_t date );
 522     struct subpicture_s *(* pf_create_subpicture)( struct vout_thread_s *,
 523                                                    int i_type, int i_size );
 524     void                 (* pf_destroy_subpicture)( struct vout_thread_s *,
 525                                                     struct subpicture_s * );
 526     void                 (* pf_display_subpicture)( struct vout_thread_s *,
 527                                                     struct subpicture_s * );
 528
 529     decoder_config_t        decoder_config;
 530 } vdec_config_t;
 531
 532 /*****************************************************************************
 533  * adec_config_t
 534  *****************************************************************************
 535  * Pointers given to audio decoders threads.
 536  *****************************************************************************/
 537 struct aout_thread_s;
 538
 539 typedef struct adec_config_s
 540 {
 541     struct aout_thread_s *  p_aout;
 542
 543     struct aout_fifo_s * (* pf_create_fifo)( struct aout_thread_s *,
 544                                             struct aout_fifo_s * );
 545     void                 (* pf_destroy_fifo)( struct aout_thread_s *);
 546
 547     decoder_config_t        decoder_config;
 548 } adec_config_t;
 549
 550
 551 /*
 552  * Communication interface between decoders and input
 553  */
 554
 555 /*****************************************************************************
 556  * decoder_capabilities_t
 557  *****************************************************************************
 558  * Structure returned by a call to GetCapabilities() of the decoder.
 559  *****************************************************************************/
 560 typedef struct decoder_capabilities_s
 561 {
 562     int                     i_dec_type;
 563     u8                      i_stream_type;   /* == i_type in es_descriptor_t */
 564     int                     i_weight; /* for a given stream type, the decoder
 565                                        * with higher weight will be spawned  */
 566
 567     vlc_thread_t         (* pf_create_thread)( void * );
 568 } decoder_capabilities_t;
 569
 570 /* Decoder types */
 571 #define NONE_D              0
 572 #define VIDEO_D             1
 573 #define AUDIO_D             2