Factorize declaration for the two variants of put_bits().
[ffmpeg.git] / libavcodec / bitstream.h
1 /*
2  * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file libavcodec/bitstream.h
23  * bitstream api header.
24  */
25
26 #ifndef AVCODEC_BITSTREAM_H
27 #define AVCODEC_BITSTREAM_H
28
29 #include <stdint.h>
30 #include <stdlib.h>
31 #include <assert.h>
32 #include "libavutil/bswap.h"
33 #include "libavutil/common.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/log.h"
36 #include "mathops.h"
37
38 #if defined(ALT_BITSTREAM_READER_LE) && !defined(ALT_BITSTREAM_READER)
39 #   define ALT_BITSTREAM_READER
40 #endif
41
42 //#define ALT_BITSTREAM_WRITER
43 //#define ALIGNED_BITSTREAM_WRITER
44 #if !defined(LIBMPEG2_BITSTREAM_READER) && !defined(A32_BITSTREAM_READER) && !defined(ALT_BITSTREAM_READER)
45 #   if ARCH_ARM
46 #       define A32_BITSTREAM_READER
47 #   else
48 #       define ALT_BITSTREAM_READER
49 //#define LIBMPEG2_BITSTREAM_READER
50 //#define A32_BITSTREAM_READER
51 #   endif
52 #endif
53
54 extern const uint8_t ff_reverse[256];
55
56 #if ARCH_X86
57 // avoid +32 for shift optimization (gcc should do that ...)
58 static inline  int32_t NEG_SSR32( int32_t a, int8_t s){
59     __asm__ ("sarl %1, %0\n\t"
60          : "+r" (a)
61          : "ic" ((uint8_t)(-s))
62     );
63     return a;
64 }
65 static inline uint32_t NEG_USR32(uint32_t a, int8_t s){
66     __asm__ ("shrl %1, %0\n\t"
67          : "+r" (a)
68          : "ic" ((uint8_t)(-s))
69     );
70     return a;
71 }
72 #else
73 #    define NEG_SSR32(a,s) ((( int32_t)(a))>>(32-(s)))
74 #    define NEG_USR32(a,s) (((uint32_t)(a))>>(32-(s)))
75 #endif
76
77 /* bit output */
78
79 /* buf and buf_end must be present and used by every alternative writer. */
80 typedef struct PutBitContext {
81 #ifdef ALT_BITSTREAM_WRITER
82     uint8_t *buf, *buf_end;
83     int index;
84 #else
85     uint32_t bit_buf;
86     int bit_left;
87     uint8_t *buf, *buf_ptr, *buf_end;
88 #endif
89     int size_in_bits;
90 } PutBitContext;
91
92 /**
93  * Initializes the PutBitContext \p s.
94  *
95  * @param buffer the buffer where to put bits
96  * @param buffer_size the size in bytes of \p buffer
97  */
98 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
99 {
100     if(buffer_size < 0) {
101         buffer_size = 0;
102         buffer = NULL;
103     }
104
105     s->size_in_bits= 8*buffer_size;
106     s->buf = buffer;
107     s->buf_end = s->buf + buffer_size;
108 #ifdef ALT_BITSTREAM_WRITER
109     s->index=0;
110     ((uint32_t*)(s->buf))[0]=0;
111 //    memset(buffer, 0, buffer_size);
112 #else
113     s->buf_ptr = s->buf;
114     s->bit_left=32;
115     s->bit_buf=0;
116 #endif
117 }
118
119 /**
120  * Returns the total number of bits written to the bitstream.
121  */
122 static inline int put_bits_count(PutBitContext *s)
123 {
124 #ifdef ALT_BITSTREAM_WRITER
125     return s->index;
126 #else
127     return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
128 #endif
129 }
130
131 /**
132  * Pads the end of the output stream with zeros.
133  */
134 static inline void flush_put_bits(PutBitContext *s)
135 {
136 #ifdef ALT_BITSTREAM_WRITER
137     align_put_bits(s);
138 #else
139 #ifndef BITSTREAM_WRITER_LE
140     s->bit_buf<<= s->bit_left;
141 #endif
142     while (s->bit_left < 32) {
143         /* XXX: should test end of buffer */
144 #ifdef BITSTREAM_WRITER_LE
145         *s->buf_ptr++=s->bit_buf;
146         s->bit_buf>>=8;
147 #else
148         *s->buf_ptr++=s->bit_buf >> 24;
149         s->bit_buf<<=8;
150 #endif
151         s->bit_left+=8;
152     }
153     s->bit_left=32;
154     s->bit_buf=0;
155 #endif
156 }
157
158 /**
159  * Pads the bitstream with zeros up to the next byte boundary.
160  */
161 void align_put_bits(PutBitContext *s);
162 void ff_put_string(PutBitContext * pbc, const char *s, int put_zero);
163 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
164
165 /* bit input */
166 /* buffer, buffer_end and size_in_bits must be present and used by every reader */
167 typedef struct GetBitContext {
168     const uint8_t *buffer, *buffer_end;
169 #ifdef ALT_BITSTREAM_READER
170     int index;
171 #elif defined LIBMPEG2_BITSTREAM_READER
172     uint8_t *buffer_ptr;
173     uint32_t cache;
174     int bit_count;
175 #elif defined A32_BITSTREAM_READER
176     uint32_t *buffer_ptr;
177     uint32_t cache0;
178     uint32_t cache1;
179     int bit_count;
180 #endif
181     int size_in_bits;
182 } GetBitContext;
183
184 #define VLC_TYPE int16_t
185
186 typedef struct VLC {
187     int bits;
188     VLC_TYPE (*table)[2]; ///< code, bits
189     int table_size, table_allocated;
190 } VLC;
191
192 typedef struct RL_VLC_ELEM {
193     int16_t level;
194     int8_t len;
195     uint8_t run;
196 } RL_VLC_ELEM;
197
198 static inline void put_bits(PutBitContext *s, int n, unsigned int value)
199 #ifndef ALT_BITSTREAM_WRITER
200 {
201     unsigned int bit_buf;
202     int bit_left;
203
204     //    printf("put_bits=%d %x\n", n, value);
205     assert(n == 32 || value < (1U << n));
206
207     bit_buf = s->bit_buf;
208     bit_left = s->bit_left;
209
210     //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
211     /* XXX: optimize */
212 #ifdef BITSTREAM_WRITER_LE
213     bit_buf |= value << (32 - bit_left);
214     if (n >= bit_left) {
215 #if !HAVE_FAST_UNALIGNED
216         if (3 & (intptr_t) s->buf_ptr) {
217             AV_WL32(s->buf_ptr, bit_buf);
218         } else
219 #endif
220         *(uint32_t *)s->buf_ptr = le2me_32(bit_buf);
221         s->buf_ptr+=4;
222         bit_buf = (bit_left==32)?0:value >> bit_left;
223         bit_left+=32;
224     }
225     bit_left-=n;
226 #else
227     if (n < bit_left) {
228         bit_buf = (bit_buf<<n) | value;
229         bit_left-=n;
230     } else {
231         bit_buf<<=bit_left;
232         bit_buf |= value >> (n - bit_left);
233 #if !HAVE_FAST_UNALIGNED
234         if (3 & (intptr_t) s->buf_ptr) {
235             AV_WB32(s->buf_ptr, bit_buf);
236         } else
237 #endif
238         *(uint32_t *)s->buf_ptr = be2me_32(bit_buf);
239         //printf("bitbuf = %08x\n", bit_buf);
240         s->buf_ptr+=4;
241         bit_left+=32 - n;
242         bit_buf = value;
243     }
244 #endif
245
246     s->bit_buf = bit_buf;
247     s->bit_left = bit_left;
248 }
249 #else  /* ALT_BITSTREAM_WRITER defined */
250 {
251 #    ifdef ALIGNED_BITSTREAM_WRITER
252 #        if ARCH_X86
253     __asm__ volatile(
254         "movl %0, %%ecx                 \n\t"
255         "xorl %%eax, %%eax              \n\t"
256         "shrdl %%cl, %1, %%eax          \n\t"
257         "shrl %%cl, %1                  \n\t"
258         "movl %0, %%ecx                 \n\t"
259         "shrl $3, %%ecx                 \n\t"
260         "andl $0xFFFFFFFC, %%ecx        \n\t"
261         "bswapl %1                      \n\t"
262         "orl %1, (%2, %%ecx)            \n\t"
263         "bswapl %%eax                   \n\t"
264         "addl %3, %0                    \n\t"
265         "movl %%eax, 4(%2, %%ecx)       \n\t"
266         : "=&r" (s->index), "=&r" (value)
267         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value<<(-n))
268         : "%eax", "%ecx"
269     );
270 #        else
271     int index= s->index;
272     uint32_t *ptr= ((uint32_t *)s->buf)+(index>>5);
273
274     value<<= 32-n;
275
276     ptr[0] |= be2me_32(value>>(index&31));
277     ptr[1]  = be2me_32(value<<(32-(index&31)));
278 //if(n>24) printf("%d %d\n", n, value);
279     index+= n;
280     s->index= index;
281 #        endif
282 #    else //ALIGNED_BITSTREAM_WRITER
283 #        if ARCH_X86
284     __asm__ volatile(
285         "movl $7, %%ecx                 \n\t"
286         "andl %0, %%ecx                 \n\t"
287         "addl %3, %%ecx                 \n\t"
288         "negl %%ecx                     \n\t"
289         "shll %%cl, %1                  \n\t"
290         "bswapl %1                      \n\t"
291         "movl %0, %%ecx                 \n\t"
292         "shrl $3, %%ecx                 \n\t"
293         "orl %1, (%%ecx, %2)            \n\t"
294         "addl %3, %0                    \n\t"
295         "movl $0, 4(%%ecx, %2)          \n\t"
296         : "=&r" (s->index), "=&r" (value)
297         : "r" (s->buf), "r" (n), "0" (s->index), "1" (value)
298         : "%ecx"
299     );
300 #        else
301     int index= s->index;
302     uint32_t *ptr= (uint32_t*)(((uint8_t *)s->buf)+(index>>3));
303
304     ptr[0] |= be2me_32(value<<(32-n-(index&7) ));
305     ptr[1] = 0;
306 //if(n>24) printf("%d %d\n", n, value);
307     index+= n;
308     s->index= index;
309 #        endif
310 #    endif //!ALIGNED_BITSTREAM_WRITER
311 }
312 #endif
313
314 static inline void put_sbits(PutBitContext *pb, int bits, int32_t val)
315 {
316     assert(bits >= 0 && bits <= 31);
317
318     put_bits(pb, bits, val & ((1<<bits)-1));
319 }
320
321
322 static inline uint8_t* pbBufPtr(PutBitContext *s)
323 {
324 #ifdef ALT_BITSTREAM_WRITER
325         return s->buf + (s->index>>3);
326 #else
327         return s->buf_ptr;
328 #endif
329 }
330
331 /**
332  *
333  * PutBitContext must be flushed & aligned to a byte boundary before calling this.
334  */
335 static inline void skip_put_bytes(PutBitContext *s, int n){
336         assert((put_bits_count(s)&7)==0);
337 #ifdef ALT_BITSTREAM_WRITER
338         FIXME may need some cleaning of the buffer
339         s->index += n<<3;
340 #else
341         assert(s->bit_left==32);
342         s->buf_ptr += n;
343 #endif
344 }
345
346 /**
347  * Skips the given number of bits.
348  * Must only be used if the actual values in the bitstream do not matter.
349  * If \p n is 0 the behavior is undefined.
350  */
351 static inline void skip_put_bits(PutBitContext *s, int n){
352 #ifdef ALT_BITSTREAM_WRITER
353     s->index += n;
354 #else
355     s->bit_left -= n;
356     s->buf_ptr-= s->bit_left>>5;
357     s->bit_left &= 31;
358 #endif
359 }
360
361 /**
362  * Changes the end of the buffer.
363  */
364 static inline void set_put_bits_buffer_size(PutBitContext *s, int size){
365     s->buf_end= s->buf + size;
366 }
367
368 /* Bitstream reader API docs:
369 name
370     arbitrary name which is used as prefix for the internal variables
371
372 gb
373     getbitcontext
374
375 OPEN_READER(name, gb)
376     loads gb into local variables
377
378 CLOSE_READER(name, gb)
379     stores local vars in gb
380
381 UPDATE_CACHE(name, gb)
382     refills the internal cache from the bitstream
383     after this call at least MIN_CACHE_BITS will be available,
384
385 GET_CACHE(name, gb)
386     will output the contents of the internal cache, next bit is MSB of 32 or 64 bit (FIXME 64bit)
387
388 SHOW_UBITS(name, gb, num)
389     will return the next num bits
390
391 SHOW_SBITS(name, gb, num)
392     will return the next num bits and do sign extension
393
394 SKIP_BITS(name, gb, num)
395     will skip over the next num bits
396     note, this is equivalent to SKIP_CACHE; SKIP_COUNTER
397
398 SKIP_CACHE(name, gb, num)
399     will remove the next num bits from the cache (note SKIP_COUNTER MUST be called before UPDATE_CACHE / CLOSE_READER)
400
401 SKIP_COUNTER(name, gb, num)
402     will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS)
403
404 LAST_SKIP_CACHE(name, gb, num)
405     will remove the next num bits from the cache if it is needed for UPDATE_CACHE otherwise it will do nothing
406
407 LAST_SKIP_BITS(name, gb, num)
408     is equivalent to SKIP_LAST_CACHE; SKIP_COUNTER
409
410 for examples see get_bits, show_bits, skip_bits, get_vlc
411 */
412
413 #ifdef ALT_BITSTREAM_READER
414 #   define MIN_CACHE_BITS 25
415
416 #   define OPEN_READER(name, gb)\
417         int name##_index= (gb)->index;\
418         int name##_cache= 0;\
419
420 #   define CLOSE_READER(name, gb)\
421         (gb)->index= name##_index;\
422
423 # ifdef ALT_BITSTREAM_READER_LE
424 #   define UPDATE_CACHE(name, gb)\
425         name##_cache= AV_RL32( ((const uint8_t *)(gb)->buffer)+(name##_index>>3) ) >> (name##_index&0x07);\
426
427 #   define SKIP_CACHE(name, gb, num)\
428         name##_cache >>= (num);
429 # else
430 #   define UPDATE_CACHE(name, gb)\
431         name##_cache= AV_RB32( ((const uint8_t *)(gb)->buffer)+(name##_index>>3) ) << (name##_index&0x07);\
432
433 #   define SKIP_CACHE(name, gb, num)\
434         name##_cache <<= (num);
435 # endif
436
437 // FIXME name?
438 #   define SKIP_COUNTER(name, gb, num)\
439         name##_index += (num);\
440
441 #   define SKIP_BITS(name, gb, num)\
442         {\
443             SKIP_CACHE(name, gb, num)\
444             SKIP_COUNTER(name, gb, num)\
445         }\
446
447 #   define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
448 #   define LAST_SKIP_CACHE(name, gb, num) ;
449
450 # ifdef ALT_BITSTREAM_READER_LE
451 #   define SHOW_UBITS(name, gb, num)\
452         ((name##_cache) & (NEG_USR32(0xffffffff,num)))
453
454 #   define SHOW_SBITS(name, gb, num)\
455         NEG_SSR32((name##_cache)<<(32-(num)), num)
456 # else
457 #   define SHOW_UBITS(name, gb, num)\
458         NEG_USR32(name##_cache, num)
459
460 #   define SHOW_SBITS(name, gb, num)\
461         NEG_SSR32(name##_cache, num)
462 # endif
463
464 #   define GET_CACHE(name, gb)\
465         ((uint32_t)name##_cache)
466
467 static inline int get_bits_count(GetBitContext *s){
468     return s->index;
469 }
470
471 static inline void skip_bits_long(GetBitContext *s, int n){
472     s->index += n;
473 }
474
475 #elif defined LIBMPEG2_BITSTREAM_READER
476 //libmpeg2 like reader
477
478 #   define MIN_CACHE_BITS 17
479
480 #   define OPEN_READER(name, gb)\
481         int name##_bit_count=(gb)->bit_count;\
482         int name##_cache= (gb)->cache;\
483         uint8_t * name##_buffer_ptr=(gb)->buffer_ptr;\
484
485 #   define CLOSE_READER(name, gb)\
486         (gb)->bit_count= name##_bit_count;\
487         (gb)->cache= name##_cache;\
488         (gb)->buffer_ptr= name##_buffer_ptr;\
489
490 #   define UPDATE_CACHE(name, gb)\
491     if(name##_bit_count >= 0){\
492         name##_cache+= AV_RB16(name##_buffer_ptr) << name##_bit_count; \
493         name##_buffer_ptr+=2;\
494         name##_bit_count-= 16;\
495     }\
496
497 #   define SKIP_CACHE(name, gb, num)\
498         name##_cache <<= (num);\
499
500 #   define SKIP_COUNTER(name, gb, num)\
501         name##_bit_count += (num);\
502
503 #   define SKIP_BITS(name, gb, num)\
504         {\
505             SKIP_CACHE(name, gb, num)\
506             SKIP_COUNTER(name, gb, num)\
507         }\
508
509 #   define LAST_SKIP_BITS(name, gb, num) SKIP_BITS(name, gb, num)
510 #   define LAST_SKIP_CACHE(name, gb, num) SKIP_CACHE(name, gb, num)
511
512 #   define SHOW_UBITS(name, gb, num)\
513         NEG_USR32(name##_cache, num)
514
515 #   define SHOW_SBITS(name, gb, num)\
516         NEG_SSR32(name##_cache, num)
517
518 #   define GET_CACHE(name, gb)\
519         ((uint32_t)name##_cache)
520
521 static inline int get_bits_count(GetBitContext *s){
522     return (s->buffer_ptr - s->buffer)*8 - 16 + s->bit_count;
523 }
524
525 static inline void skip_bits_long(GetBitContext *s, int n){
526     OPEN_READER(re, s)
527     re_bit_count += n;
528     re_buffer_ptr += 2*(re_bit_count>>4);
529     re_bit_count &= 15;
530     re_cache = ((re_buffer_ptr[-2]<<8) + re_buffer_ptr[-1]) << (16+re_bit_count);
531     UPDATE_CACHE(re, s)
532     CLOSE_READER(re, s)
533 }
534
535 #elif defined A32_BITSTREAM_READER
536
537 #   define MIN_CACHE_BITS 32
538
539 #   define OPEN_READER(name, gb)\
540         int name##_bit_count=(gb)->bit_count;\
541         uint32_t name##_cache0= (gb)->cache0;\
542         uint32_t name##_cache1= (gb)->cache1;\
543         uint32_t * name##_buffer_ptr=(gb)->buffer_ptr;\
544
545 #   define CLOSE_READER(name, gb)\
546         (gb)->bit_count= name##_bit_count;\
547         (gb)->cache0= name##_cache0;\
548         (gb)->cache1= name##_cache1;\
549         (gb)->buffer_ptr= name##_buffer_ptr;\
550
551 #   define UPDATE_CACHE(name, gb)\
552     if(name##_bit_count > 0){\
553         const uint32_t next= be2me_32( *name##_buffer_ptr );\
554         name##_cache0 |= NEG_USR32(next,name##_bit_count);\
555         name##_cache1 |= next<<name##_bit_count;\
556         name##_buffer_ptr++;\
557         name##_bit_count-= 32;\
558     }\
559
560 #if ARCH_X86
561 #   define SKIP_CACHE(name, gb, num)\
562         __asm__(\
563             "shldl %2, %1, %0          \n\t"\
564             "shll %2, %1               \n\t"\
565             : "+r" (name##_cache0), "+r" (name##_cache1)\
566             : "Ic" ((uint8_t)(num))\
567            );
568 #else
569 #   define SKIP_CACHE(name, gb, num)\
570         name##_cache0 <<= (num);\
571         name##_cache0 |= NEG_USR32(name##_cache1,num);\
572         name##_cache1 <<= (num);
573 #endif
574
575 #   define SKIP_COUNTER(name, gb, num)\
576         name##_bit_count += (num);\
577
578 #   define SKIP_BITS(name, gb, num)\
579         {\
580             SKIP_CACHE(name, gb, num)\
581             SKIP_COUNTER(name, gb, num)\
582         }\
583
584 #   define LAST_SKIP_BITS(name, gb, num) SKIP_BITS(name, gb, num)
585 #   define LAST_SKIP_CACHE(name, gb, num) SKIP_CACHE(name, gb, num)
586
587 #   define SHOW_UBITS(name, gb, num)\
588         NEG_USR32(name##_cache0, num)
589
590 #   define SHOW_SBITS(name, gb, num)\
591         NEG_SSR32(name##_cache0, num)
592
593 #   define GET_CACHE(name, gb)\
594         (name##_cache0)
595
596 static inline int get_bits_count(GetBitContext *s){
597     return ((uint8_t*)s->buffer_ptr - s->buffer)*8 - 32 + s->bit_count;
598 }
599
600 static inline void skip_bits_long(GetBitContext *s, int n){
601     OPEN_READER(re, s)
602     re_bit_count += n;
603     re_buffer_ptr += re_bit_count>>5;
604     re_bit_count &= 31;
605     re_cache0 = be2me_32( re_buffer_ptr[-1] ) << re_bit_count;
606     re_cache1 = 0;
607     UPDATE_CACHE(re, s)
608     CLOSE_READER(re, s)
609 }
610
611 #endif
612
613 /**
614  * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
615  * if MSB not set it is negative
616  * @param n length in bits
617  * @author BERO
618  */
619 static inline int get_xbits(GetBitContext *s, int n){
620     register int sign;
621     register int32_t cache;
622     OPEN_READER(re, s)
623     UPDATE_CACHE(re, s)
624     cache = GET_CACHE(re,s);
625     sign=(~cache)>>31;
626     LAST_SKIP_BITS(re, s, n)
627     CLOSE_READER(re, s)
628     return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
629 }
630
631 static inline int get_sbits(GetBitContext *s, int n){
632     register int tmp;
633     OPEN_READER(re, s)
634     UPDATE_CACHE(re, s)
635     tmp= SHOW_SBITS(re, s, n);
636     LAST_SKIP_BITS(re, s, n)
637     CLOSE_READER(re, s)
638     return tmp;
639 }
640
641 /**
642  * reads 1-17 bits.
643  * Note, the alt bitstream reader can read up to 25 bits, but the libmpeg2 reader can't
644  */
645 static inline unsigned int get_bits(GetBitContext *s, int n){
646     register int tmp;
647     OPEN_READER(re, s)
648     UPDATE_CACHE(re, s)
649     tmp= SHOW_UBITS(re, s, n);
650     LAST_SKIP_BITS(re, s, n)
651     CLOSE_READER(re, s)
652     return tmp;
653 }
654
655 /**
656  * shows 1-17 bits.
657  * Note, the alt bitstream reader can read up to 25 bits, but the libmpeg2 reader can't
658  */
659 static inline unsigned int show_bits(GetBitContext *s, int n){
660     register int tmp;
661     OPEN_READER(re, s)
662     UPDATE_CACHE(re, s)
663     tmp= SHOW_UBITS(re, s, n);
664 //    CLOSE_READER(re, s)
665     return tmp;
666 }
667
668 static inline void skip_bits(GetBitContext *s, int n){
669  //Note gcc seems to optimize this to s->index+=n for the ALT_READER :))
670     OPEN_READER(re, s)
671     UPDATE_CACHE(re, s)
672     LAST_SKIP_BITS(re, s, n)
673     CLOSE_READER(re, s)
674 }
675
676 static inline unsigned int get_bits1(GetBitContext *s){
677 #ifdef ALT_BITSTREAM_READER
678     int index= s->index;
679     uint8_t result= s->buffer[ index>>3 ];
680 #ifdef ALT_BITSTREAM_READER_LE
681     result>>= (index&0x07);
682     result&= 1;
683 #else
684     result<<= (index&0x07);
685     result>>= 8 - 1;
686 #endif
687     index++;
688     s->index= index;
689
690     return result;
691 #else
692     return get_bits(s, 1);
693 #endif
694 }
695
696 static inline unsigned int show_bits1(GetBitContext *s){
697     return show_bits(s, 1);
698 }
699
700 static inline void skip_bits1(GetBitContext *s){
701     skip_bits(s, 1);
702 }
703
704 /**
705  * reads 0-32 bits.
706  */
707 static inline unsigned int get_bits_long(GetBitContext *s, int n){
708     if(n<=17) return get_bits(s, n);
709     else{
710 #ifdef ALT_BITSTREAM_READER_LE
711         int ret= get_bits(s, 16);
712         return ret | (get_bits(s, n-16) << 16);
713 #else
714         int ret= get_bits(s, 16) << (n-16);
715         return ret | get_bits(s, n-16);
716 #endif
717     }
718 }
719
720 /**
721  * reads 0-32 bits as a signed integer.
722  */
723 static inline int get_sbits_long(GetBitContext *s, int n) {
724     return sign_extend(get_bits_long(s, n), n);
725 }
726
727 /**
728  * shows 0-32 bits.
729  */
730 static inline unsigned int show_bits_long(GetBitContext *s, int n){
731     if(n<=17) return show_bits(s, n);
732     else{
733         GetBitContext gb= *s;
734         return get_bits_long(&gb, n);
735     }
736 }
737
738 static inline int check_marker(GetBitContext *s, const char *msg)
739 {
740     int bit= get_bits1(s);
741     if(!bit)
742         av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);
743
744     return bit;
745 }
746
747 /**
748  * init GetBitContext.
749  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger then the actual read bits
750  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
751  * @param bit_size the size of the buffer in bits
752  */
753 static inline void init_get_bits(GetBitContext *s,
754                    const uint8_t *buffer, int bit_size)
755 {
756     int buffer_size= (bit_size+7)>>3;
757     if(buffer_size < 0 || bit_size < 0) {
758         buffer_size = bit_size = 0;
759         buffer = NULL;
760     }
761
762     s->buffer= buffer;
763     s->size_in_bits= bit_size;
764     s->buffer_end= buffer + buffer_size;
765 #ifdef ALT_BITSTREAM_READER
766     s->index=0;
767 #elif defined LIBMPEG2_BITSTREAM_READER
768     s->buffer_ptr = (uint8_t*)((intptr_t)buffer&(~1));
769     s->bit_count = 16 + 8*((intptr_t)buffer&1);
770     skip_bits_long(s, 0);
771 #elif defined A32_BITSTREAM_READER
772     s->buffer_ptr = (uint32_t*)((intptr_t)buffer&(~3));
773     s->bit_count = 32 + 8*((intptr_t)buffer&3);
774     skip_bits_long(s, 0);
775 #endif
776 }
777
778 static inline void align_get_bits(GetBitContext *s)
779 {
780     int n= (-get_bits_count(s)) & 7;
781     if(n) skip_bits(s, n);
782 }
783
784 #define init_vlc(vlc, nb_bits, nb_codes,\
785                  bits, bits_wrap, bits_size,\
786                  codes, codes_wrap, codes_size,\
787                  flags)\
788         init_vlc_sparse(vlc, nb_bits, nb_codes,\
789                  bits, bits_wrap, bits_size,\
790                  codes, codes_wrap, codes_size,\
791                  NULL, 0, 0, flags)
792
793 int init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
794              const void *bits, int bits_wrap, int bits_size,
795              const void *codes, int codes_wrap, int codes_size,
796              const void *symbols, int symbols_wrap, int symbols_size,
797              int flags);
798 #define INIT_VLC_USE_STATIC 1 ///< VERY strongly deprecated and forbidden
799 #define INIT_VLC_LE         2
800 #define INIT_VLC_USE_NEW_STATIC 4
801 void free_vlc(VLC *vlc);
802
803 #define INIT_VLC_STATIC(vlc, bits, a,b,c,d,e,f,g, static_size)\
804 {\
805     static VLC_TYPE table[static_size][2];\
806     (vlc)->table= table;\
807     (vlc)->table_allocated= static_size;\
808     init_vlc(vlc, bits, a,b,c,d,e,f,g, INIT_VLC_USE_NEW_STATIC);\
809 }
810
811
812 /**
813  *
814  * if the vlc code is invalid and max_depth=1 than no bits will be removed
815  * if the vlc code is invalid and max_depth>1 than the number of bits removed
816  * is undefined
817  */
818 #define GET_VLC(code, name, gb, table, bits, max_depth)\
819 {\
820     int n, index, nb_bits;\
821 \
822     index= SHOW_UBITS(name, gb, bits);\
823     code = table[index][0];\
824     n    = table[index][1];\
825 \
826     if(max_depth > 1 && n < 0){\
827         LAST_SKIP_BITS(name, gb, bits)\
828         UPDATE_CACHE(name, gb)\
829 \
830         nb_bits = -n;\
831 \
832         index= SHOW_UBITS(name, gb, nb_bits) + code;\
833         code = table[index][0];\
834         n    = table[index][1];\
835         if(max_depth > 2 && n < 0){\
836             LAST_SKIP_BITS(name, gb, nb_bits)\
837             UPDATE_CACHE(name, gb)\
838 \
839             nb_bits = -n;\
840 \
841             index= SHOW_UBITS(name, gb, nb_bits) + code;\
842             code = table[index][0];\
843             n    = table[index][1];\
844         }\
845     }\
846     SKIP_BITS(name, gb, n)\
847 }
848
849 #define GET_RL_VLC(level, run, name, gb, table, bits, max_depth, need_update)\
850 {\
851     int n, index, nb_bits;\
852 \
853     index= SHOW_UBITS(name, gb, bits);\
854     level = table[index].level;\
855     n     = table[index].len;\
856 \
857     if(max_depth > 1 && n < 0){\
858         SKIP_BITS(name, gb, bits)\
859         if(need_update){\
860             UPDATE_CACHE(name, gb)\
861         }\
862 \
863         nb_bits = -n;\
864 \
865         index= SHOW_UBITS(name, gb, nb_bits) + level;\
866         level = table[index].level;\
867         n     = table[index].len;\
868     }\
869     run= table[index].run;\
870     SKIP_BITS(name, gb, n)\
871 }
872
873
874 /**
875  * parses a vlc code, faster then get_vlc()
876  * @param bits is the number of bits which will be read at once, must be
877  *             identical to nb_bits in init_vlc()
878  * @param max_depth is the number of times bits bits must be read to completely
879  *                  read the longest vlc code
880  *                  = (max_vlc_length + bits - 1) / bits
881  */
882 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
883                                   int bits, int max_depth)
884 {
885     int code;
886
887     OPEN_READER(re, s)
888     UPDATE_CACHE(re, s)
889
890     GET_VLC(code, re, s, table, bits, max_depth)
891
892     CLOSE_READER(re, s)
893     return code;
894 }
895
896 //#define TRACE
897
898 #ifdef TRACE
899 static inline void print_bin(int bits, int n){
900     int i;
901
902     for(i=n-1; i>=0; i--){
903         av_log(NULL, AV_LOG_DEBUG, "%d", (bits>>i)&1);
904     }
905     for(i=n; i<24; i++)
906         av_log(NULL, AV_LOG_DEBUG, " ");
907 }
908
909 static inline int get_bits_trace(GetBitContext *s, int n, char *file, const char *func, int line){
910     int r= get_bits(s, n);
911
912     print_bin(r, n);
913     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n", r, n, r, get_bits_count(s)-n, file, func, line);
914     return r;
915 }
916 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2], int bits, int max_depth, char *file, const char *func, int line){
917     int show= show_bits(s, 24);
918     int pos= get_bits_count(s);
919     int r= get_vlc2(s, table, bits, max_depth);
920     int len= get_bits_count(s) - pos;
921     int bits2= show>>(24-len);
922
923     print_bin(bits2, len);
924
925     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n", bits2, len, r, pos, file, func, line);
926     return r;
927 }
928 static inline int get_xbits_trace(GetBitContext *s, int n, char *file, const char *func, int line){
929     int show= show_bits(s, n);
930     int r= get_xbits(s, n);
931
932     print_bin(show, n);
933     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n", show, n, r, get_bits_count(s)-n, file, func, line);
934     return r;
935 }
936
937 #define get_bits(s, n)  get_bits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
938 #define get_bits1(s)    get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
939 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
940 #define get_vlc(s, vlc)            get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
941 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
942
943 #define tprintf(p, ...) av_log(p, AV_LOG_DEBUG, __VA_ARGS__)
944
945 #else //TRACE
946 #define tprintf(p, ...) {}
947 #endif
948
949 static inline int decode012(GetBitContext *gb){
950     int n;
951     n = get_bits1(gb);
952     if (n == 0)
953         return 0;
954     else
955         return get_bits1(gb) + 1;
956 }
957
958 static inline int decode210(GetBitContext *gb){
959     if (get_bits1(gb))
960         return 0;
961     else
962         return 2 - get_bits1(gb);
963 }
964
965 #endif /* AVCODEC_BITSTREAM_H */