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