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.14 2001/01/13 12:57:19 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;        /* only u32 is supported at the moment */
 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  * Philosophy of the first implementation : the bit buffer is first filled by
 176  * NeedBits, then the buffer can be read via p_bit_stream->fifo.buffer, and
 177  * unnecessary bits are dumped with a DumpBits() call.
 178  */
 179
 180 /*****************************************************************************
 181  * GetByte : reads the next byte in the input stream (PRIVATE)
 182  *****************************************************************************/
 183 static __inline__ byte_t _GetByte( bit_stream_t * p_bit_stream )
 184 {
 185     /* Are there some bytes left in the current data packet ? */
 186     /* could change this test to have a if (! (bytes--)) instead */
 187     if ( p_bit_stream->p_byte >= p_bit_stream->p_end )
 188     {
 189         /* no, switch to next data packet */
 190         p_bit_stream->pf_next_data_packet( p_bit_stream );
 191     }
 192
 193     return( *(p_bit_stream->p_byte++) );
 194 }
 195
 196 /*****************************************************************************
 197  * NeedBits : reads i_bits new bits in the bit stream and stores them in the
 198  *            bit buffer
 199  *****************************************************************************
 200  * - i_bits must be less or equal 32 !
 201  * - There is something important to notice with that function : if the number
 202  * of bits available in the bit buffer when calling NeedBits() is greater than
 203  * 24 (i_available > 24) but less than the number of needed bits
 204  * (i_available < i_bits), the byte returned by GetByte() will be shifted with
 205  * a negative value and the number of bits available in the bit buffer will be
 206  * set to more than 32 !
 207  *****************************************************************************/
 208 static __inline__ void NeedBits( bit_stream_t * p_bit_stream, int i_bits )
 209 {
 210     while ( p_bit_stream->fifo.i_available < i_bits )
 211     {
 212         p_bit_stream->fifo.buffer |= ((WORD_TYPE)_GetByte( p_bit_stream ))
 213                                      << (sizeof(WORD_TYPE) - 8
 214                                             - p_bit_stream->fifo.i_available);
 215         p_bit_stream->fifo.i_available += 8;
 216     }
 217 }
 218
 219 /*****************************************************************************
 220  * DumpBits : removes i_bits bits from the bit buffer
 221  *****************************************************************************
 222  * - i_bits <= i_available
 223  * - i_bits < 32 (because (u32 << 32) <=> (u32 = u32))
 224  *****************************************************************************/
 225 static __inline__ void DumpBits( bit_stream_t * p_bit_stream, int i_bits )
 226 {
 227     p_bit_stream->fifo.buffer <<= i_bits;
 228     p_bit_stream->fifo.i_available -= i_bits;
 229 }
 230
 231
 232 /*
 233  * Philosophy of the second implementation : WORD_LENGTH (usually 32) bits
 234  * are read at the same time, thus minimizing the number of p_byte changes.
 235  * Bits are read via GetBits() or ShowBits. This is slightly faster. Be
 236  * aware that if, in the forthcoming functions, i_bits > 24, the data have to
 237  * be already aligned on an 8-bit boundary, or wrong results will be
 238  * returned.
 239  */
 240
 241 #if (WORD_TYPE != u32)
 242 #   error Not supported word
 243 #endif
 244
 245 /*****************************************************************************
 246  * ShowBits : return i_bits bits from the bit stream
 247  *****************************************************************************/
 248 static __inline__ WORD_TYPE _ShowWord( bit_stream_t * p_bit_stream )
 249 {
 250     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 251     {
 252         return( swab32( *((WORD_TYPE *)p_bit_stream->p_byte) ) );
 253     }
 254
 255     p_bit_stream->pf_next_data_packet( p_bit_stream );
 256     return( swab32( *((WORD_TYPE *)p_bit_stream->p_byte) ) );
 257 }
 258
 259 static __inline__ WORD_TYPE ShowBits( bit_stream_t * p_bit_stream, 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     return( (p_bit_stream->fifo.buffer |
 267             (_ShowWord( p_bit_stream ) >> p_bit_stream->fifo.i_available))
 268                     >> (8 * sizeof(WORD_TYPE) - i_bits) );
 269 }
 270
 271 /*****************************************************************************
 272  * GetWord : returns the next word to be read (PRIVATE)
 273  *****************************************************************************/
 274 static __inline__ WORD_TYPE _GetWord( bit_stream_t * p_bit_stream )
 275 {
 276     if( p_bit_stream->p_byte <= p_bit_stream->p_end - sizeof(WORD_TYPE) )
 277     {
 278         return( swab32( *(((WORD_TYPE *)p_bit_stream->p_byte)++) ) );
 279     }
 280     else
 281     {
 282         p_bit_stream->pf_next_data_packet( p_bit_stream );
 283         return( swab32( *(((WORD_TYPE *)p_bit_stream->p_byte)++) ) );
 284     }
 285 }
 286
 287 /*****************************************************************************
 288  * RemoveBits : removes i_bits bits from the bit buffer
 289  *              XXX: do not use for 32 bits, see RemoveBits32
 290  *****************************************************************************/
 291 static __inline__ void RemoveBits( bit_stream_t * p_bit_stream, int i_bits )
 292 {
 293     p_bit_stream->fifo.i_available -= i_bits;
 294
 295     if( p_bit_stream->fifo.i_available >= 0 )
 296     {
 297         p_bit_stream->fifo.buffer <<= i_bits;
 298         return;
 299     }
 300     p_bit_stream->fifo.buffer = _GetWord( p_bit_stream )
 301                             << ( -p_bit_stream->fifo.i_available );
 302     p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
 303 }
 304
 305 /*****************************************************************************
 306  * RemoveBits32 : removes 32 bits from the bit buffer (and as a side effect,
 307  *                refill it)
 308  *****************************************************************************/
 309 static __inline__ void RemoveBits32( bit_stream_t * p_bit_stream )
 310 {
 311     if( p_bit_stream->fifo.i_available )
 312     {
 313         p_bit_stream->fifo.buffer = _GetWord( p_bit_stream )
 314                             << (32 - p_bit_stream->fifo.i_available);
 315     }
 316     else
 317     {
 318         _GetWord( p_bit_stream );
 319     }
 320 }
 321
 322 /*****************************************************************************
 323  * GetBits : returns i_bits bits from the bit stream and removes them
 324  *           XXX: do not use for 32 bits, see GetBits32
 325  *****************************************************************************/
 326 static __inline__ WORD_TYPE GetBits( bit_stream_t * p_bit_stream, int i_bits )
 327 {
 328     u32             i_result;
 329
 330     p_bit_stream->fifo.i_available -= i_bits;
 331     if( p_bit_stream->fifo.i_available >= 0 )
 332     {
 333         i_result = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits);
 334         p_bit_stream->fifo.buffer <<= i_bits;
 335         return( i_result );
 336     }
 337
 338     i_result = p_bit_stream->fifo.buffer >> (8 * sizeof(WORD_TYPE) - i_bits);
 339     p_bit_stream->fifo.buffer = _GetWord( p_bit_stream );
 340     i_result |= p_bit_stream->fifo.buffer
 341                              >> (8 * sizeof(WORD_TYPE)
 342                                      + p_bit_stream->fifo.i_available);
 343     p_bit_stream->fifo.buffer <<= ( -p_bit_stream->fifo.i_available );
 344     p_bit_stream->fifo.i_available += sizeof(WORD_TYPE) * 8;
 345
 346     return( i_result );
 347 }
 348
 349 /*****************************************************************************
 350  * GetBits32 : returns 32 bits from the bit stream and removes them
 351  *****************************************************************************/
 352 static __inline__ WORD_TYPE GetBits32( bit_stream_t * p_bit_stream )
 353 {
 354     WORD_TYPE               i_result;
 355
 356     if( p_bit_stream->fifo.i_available )
 357     {
 358         i_result = p_bit_stream->fifo.buffer;
 359         p_bit_stream->fifo.buffer = _GetWord( p_bit_stream );
 360
 361         i_result |= p_bit_stream->fifo.buffer
 362                              >> (p_bit_stream->fifo.i_available);
 363         p_bit_stream->fifo.buffer <<= (8 * sizeof(WORD_TYPE)
 364                                     - p_bit_stream->fifo.i_available);
 365         return( i_result );
 366     }
 367     else
 368     {
 369         return( _GetWord( p_bit_stream ) );
 370     }
 371 }
 372
 373 /*****************************************************************************
 374  * RealignBits : realigns the bit buffer on an 8-bit boundary
 375  *****************************************************************************/
 376 static __inline__ void RealignBits( bit_stream_t * p_bit_stream )
 377 {
 378     p_bit_stream->fifo.buffer <<= (p_bit_stream->fifo.i_available & 0x7);
 379     p_bit_stream->fifo.i_available &= ~0x7;
 380 }
 381
 382
 383 /*
 384  * Philosophy of the third implementation : the decoder asks for n bytes,
 385  * and we will copy them in its buffer.
 386  */
 387
 388 /*****************************************************************************
 389  * GetChunk : reads a large chunk of data
 390  *****************************************************************************
 391  * The position in the stream must be byte-aligned, if unsure call
 392  * RealignBits(). p_buffer must to a buffer at least as big as i_buf_len
 393  * otherwise your code will crash.
 394  *****************************************************************************/
 395 static __inline__ void GetChunk( bit_stream_t * p_bit_stream,
 396                                  byte_t * p_buffer, size_t i_buf_len )
 397 {
 398     ptrdiff_t           i_available;
 399
 400     if( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
 401             >= i_buf_len )
 402     {
 403         memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
 404         p_bit_stream->p_byte += i_buf_len;
 405     }
 406     else
 407     {
 408         do
 409         {
 410             memcpy( p_buffer, p_bit_stream->p_byte, i_available );
 411             p_bit_stream->p_byte = p_bit_stream->p_end;
 412             p_buffer += i_available;
 413             i_buf_len -= i_available;
 414             p_bit_stream->pf_next_data_packet( p_bit_stream );
 415         }
 416         while( (i_available = p_bit_stream->p_end - p_bit_stream->p_byte)
 417                 <= i_buf_len && !p_bit_stream->p_decoder_fifo->b_die );
 418
 419         if( i_buf_len )
 420         {
 421             memcpy( p_buffer, p_bit_stream->p_byte, i_buf_len );
 422             p_bit_stream->p_byte += i_buf_len;
 423         }
 424     }
 425 }
 426
 427
 428 /*
 429  * Communication interface between input and decoders
 430  */
 431
 432 /*****************************************************************************
 433  * decoder_config_t
 434  *****************************************************************************
 435  * Standard pointers given to the decoders as a toolbox.
 436  *****************************************************************************/
 437 typedef struct decoder_config_s
 438 {
 439     u16                     i_id;
 440     u8                      i_type;         /* type of the elementary stream */
 441
 442     struct stream_ctrl_s *  p_stream_ctrl;
 443     struct decoder_fifo_s * p_decoder_fifo;
 444     void                 (* pf_init_bit_stream)( struct bit_stream_s *,
 445                                                  struct decoder_fifo_s * );
 446 } decoder_config_t;
 447
 448 /*****************************************************************************
 449  * vdec_config_t
 450  *****************************************************************************
 451  * Pointers given to video decoders threads.
 452  *****************************************************************************/
 453 struct vout_thread_s;
 454
 455 typedef struct vdec_config_s
 456 {
 457     struct vout_thread_s *  p_vout;
 458
 459     struct picture_s *   (* pf_create_picture)( struct vout_thread_s *,
 460                                                 int i_type, int i_width,
 461                                                 int i_height );
 462     void                 (* pf_destroy_picture)( struct vout_thread_s *,
 463                                                  struct picture_s * );
 464     void                 (* pf_display_picture)( struct vout_thread_s *,
 465                                                  struct picture_s * );
 466     void                 (* pf_date_picture)( struct vout_thread_s *,
 467                                               struct picture_s *, mtime_t date );
 468     void                 (* pf_link_picture)( struct vout_thread_s *,
 469                                               struct picture_s *, mtime_t date );
 470     void                 (* pf_unlink_picture)( struct vout_thread_s *,
 471                                                 struct picture_s *, mtime_t date );
 472     struct subpicture_s *(* pf_create_subpicture)( struct vout_thread_s *,
 473                                                    int i_type, int i_size );
 474     void                 (* pf_destroy_subpicture)( struct vout_thread_s *,
 475                                                     struct subpicture_s * );
 476     void                 (* pf_display_subpicture)( struct vout_thread_s *,
 477                                                     struct subpicture_s * );
 478
 479     decoder_config_t        decoder_config;
 480 } vdec_config_t;
 481
 482 /*****************************************************************************
 483  * adec_config_t
 484  *****************************************************************************
 485  * Pointers given to audio decoders threads.
 486  *****************************************************************************/
 487 struct aout_thread_s;
 488
 489 typedef struct adec_config_s
 490 {
 491     struct aout_thread_s *  p_aout;
 492
 493     struct aout_fifo_s * (* pf_create_fifo)( struct aout_thread_s *,
 494                                             struct aout_fifo_s * );
 495     void                 (* pf_destroy_fifo)( struct aout_thread_s *);
 496
 497     decoder_config_t        decoder_config;
 498 } adec_config_t;
 499
 500
 501 /*
 502  * Communication interface between decoders and input
 503  */
 504
 505 /*****************************************************************************
 506  * decoder_capabilities_t
 507  *****************************************************************************
 508  * Structure returned by a call to GetCapabilities() of the decoder.
 509  *****************************************************************************/
 510 typedef struct decoder_capabilities_s
 511 {
 512     int                     i_dec_type;
 513     u8                      i_stream_type;   /* == i_type in es_descriptor_t */
 514     int                     i_weight; /* for a given stream type, the decoder
 515                                        * with higher weight will be spawned  */
 516
 517     vlc_thread_t         (* pf_create_thread)( void * );
 518 } decoder_capabilities_t;
 519
 520 /* Decoder types */
 521 #define NONE_D              0
 522 #define VIDEO_D             1
 523 #define AUDIO_D             2