ce765119e7ee750911e0d6033643a4e76c410a35
[ffmpeg.git] / libavcodec / get_bits.h
1 /*
2  * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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
23  * bitstream reader API header.
24  */
25
26 #ifndef AVCODEC_GET_BITS_H
27 #define AVCODEC_GET_BITS_H
28
29 #include <stdint.h>
30
31 #include "libavutil/common.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/log.h"
34 #include "mathops.h"
35
36 /*
37  * Safe bitstream reading:
38  * optionally, the get_bits API can check to ensure that we
39  * don't read past input buffer boundaries. This is protected
40  * with CONFIG_SAFE_BITSTREAM_READER at the global level, and
41  * then below that with UNCHECKED_BITSTREAM_READER at the per-
42  * decoder level. This means that decoders that check internally
43  * can "#define UNCHECKED_BITSTREAM_READER 1" to disable
44  * overread checks.
45  * Boundary checking causes a minor performance penalty so for
46  * applications that won't want/need this, it can be disabled
47  * globally using "#define CONFIG_SAFE_BITSTREAM_READER 0".
48  */
49 #ifndef UNCHECKED_BITSTREAM_READER
50 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
51 #endif
52
53 typedef struct GetBitContext {
54     const uint8_t *buffer, *buffer_end;
55     int index;
56     int size_in_bits;
57 #if !UNCHECKED_BITSTREAM_READER
58     int size_in_bits_plus8;
59 #endif
60 } GetBitContext;
61
62 #define VLC_TYPE int16_t
63
64 typedef struct VLC {
65     int bits;
66     VLC_TYPE (*table)[2]; ///< code, bits
67     int table_size, table_allocated;
68 } VLC;
69
70 typedef struct RL_VLC_ELEM {
71     int16_t level;
72     int8_t len;
73     uint8_t run;
74 } RL_VLC_ELEM;
75
76 /* Bitstream reader API docs:
77  * name
78  *   arbitrary name which is used as prefix for the internal variables
79  *
80  * gb
81  *   getbitcontext
82  *
83  * OPEN_READER(name, gb)
84  *   load gb into local variables
85  *
86  * CLOSE_READER(name, gb)
87  *   store local vars in gb
88  *
89  * UPDATE_CACHE(name, gb)
90  *   Refill the internal cache from the bitstream.
91  *   After this call at least MIN_CACHE_BITS will be available.
92  *
93  * GET_CACHE(name, gb)
94  *   Will output the contents of the internal cache,
95  *   next bit is MSB of 32 or 64 bits (FIXME 64 bits).
96  *
97  * SHOW_UBITS(name, gb, num)
98  *   Will return the next num bits.
99  *
100  * SHOW_SBITS(name, gb, num)
101  *   Will return the next num bits and do sign extension.
102  *
103  * SKIP_BITS(name, gb, num)
104  *   Will skip over the next num bits.
105  *   Note, this is equivalent to SKIP_CACHE; SKIP_COUNTER.
106  *
107  * SKIP_CACHE(name, gb, num)
108  *   Will remove the next num bits from the cache (note SKIP_COUNTER
109  *   MUST be called before UPDATE_CACHE / CLOSE_READER).
110  *
111  * SKIP_COUNTER(name, gb, num)
112  *   Will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS).
113  *
114  * LAST_SKIP_BITS(name, gb, num)
115  *   Like SKIP_BITS, to be used if next call is UPDATE_CACHE or CLOSE_READER.
116  *
117  * For examples see get_bits, show_bits, skip_bits, get_vlc.
118  */
119
120 #ifdef LONG_BITSTREAM_READER
121 #   define MIN_CACHE_BITS 32
122 #else
123 #   define MIN_CACHE_BITS 25
124 #endif
125
126 #define OPEN_READER_NOSIZE(name, gb)            \
127     unsigned int name ## _index = (gb)->index;  \
128     unsigned int av_unused name ## _cache = 0
129
130 #if UNCHECKED_BITSTREAM_READER
131 #define OPEN_READER(name, gb) OPEN_READER_NOSIZE(name, gb)
132
133 #define BITS_AVAILABLE(name, gb) 1
134 #else
135 #define OPEN_READER(name, gb)                   \
136     OPEN_READER_NOSIZE(name, gb);               \
137     unsigned int name ## _size_plus8 = (gb)->size_in_bits_plus8
138
139 #define BITS_AVAILABLE(name, gb) name ## _index < name ## _size_plus8
140 #endif
141
142 #define CLOSE_READER(name, gb) (gb)->index = name ## _index
143
144 #ifdef BITSTREAM_READER_LE
145
146 # ifdef LONG_BITSTREAM_READER
147 #   define UPDATE_CACHE(name, gb) name ## _cache = \
148         AV_RL64((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
149 # else
150 #   define UPDATE_CACHE(name, gb) name ## _cache = \
151         AV_RL32((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
152 # endif
153
154 # define SKIP_CACHE(name, gb, num) name ## _cache >>= (num)
155
156 #else
157
158 # ifdef LONG_BITSTREAM_READER
159 #   define UPDATE_CACHE(name, gb) name ## _cache = \
160         AV_RB64((gb)->buffer + (name ## _index >> 3)) >> (32 - (name ## _index & 7))
161 # else
162 #   define UPDATE_CACHE(name, gb) name ## _cache = \
163         AV_RB32((gb)->buffer + (name ## _index >> 3)) << (name ## _index & 7)
164 # endif
165
166 # define SKIP_CACHE(name, gb, num) name ## _cache <<= (num)
167
168 #endif
169
170 #if UNCHECKED_BITSTREAM_READER
171 #   define SKIP_COUNTER(name, gb, num) name ## _index += (num)
172 #else
173 #   define SKIP_COUNTER(name, gb, num) \
174     name ## _index = FFMIN(name ## _size_plus8, name ## _index + (num))
175 #endif
176
177 #define SKIP_BITS(name, gb, num)                \
178     do {                                        \
179         SKIP_CACHE(name, gb, num);              \
180         SKIP_COUNTER(name, gb, num);            \
181     } while (0)
182
183 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
184
185 #ifdef BITSTREAM_READER_LE
186 #   define SHOW_UBITS(name, gb, num) zero_extend(name ## _cache, num)
187 #   define SHOW_SBITS(name, gb, num) sign_extend(name ## _cache, num)
188 #else
189 #   define SHOW_UBITS(name, gb, num) NEG_USR32(name ## _cache, num)
190 #   define SHOW_SBITS(name, gb, num) NEG_SSR32(name ## _cache, num)
191 #endif
192
193 #define GET_CACHE(name, gb) ((uint32_t) name ## _cache)
194
195 static inline int get_bits_count(const GetBitContext *s)
196 {
197     return s->index;
198 }
199
200 static inline void skip_bits_long(GetBitContext *s, int n)
201 {
202 #if UNCHECKED_BITSTREAM_READER
203     s->index += n;
204 #else
205     s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
206 #endif
207 }
208
209 /**
210  * Read MPEG-1 dc-style VLC (sign bit + mantisse with no MSB).
211  * if MSB not set it is negative
212  * @param n length in bits
213  */
214 static inline int get_xbits(GetBitContext *s, int n)
215 {
216     register int sign;
217     register int32_t cache;
218     OPEN_READER(re, s);
219     UPDATE_CACHE(re, s);
220     cache = GET_CACHE(re, s);
221     sign  = ~cache >> 31;
222     LAST_SKIP_BITS(re, s, n);
223     CLOSE_READER(re, s);
224     return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
225 }
226
227 static inline int get_sbits(GetBitContext *s, int n)
228 {
229     register int tmp;
230     OPEN_READER(re, s);
231     UPDATE_CACHE(re, s);
232     tmp = SHOW_SBITS(re, s, n);
233     LAST_SKIP_BITS(re, s, n);
234     CLOSE_READER(re, s);
235     return tmp;
236 }
237
238 /**
239  * Read 1-25 bits.
240  */
241 static inline unsigned int get_bits(GetBitContext *s, int n)
242 {
243     register int tmp;
244     OPEN_READER(re, s);
245     UPDATE_CACHE(re, s);
246     tmp = SHOW_UBITS(re, s, n);
247     LAST_SKIP_BITS(re, s, n);
248     CLOSE_READER(re, s);
249     return tmp;
250 }
251
252 /**
253  * Read 0-25 bits.
254  */
255 static av_always_inline int get_bitsz(GetBitContext *s, int n)
256 {
257     return n ? get_bits(s, n) : 0;
258 }
259
260 /**
261  * Show 1-25 bits.
262  */
263 static inline unsigned int show_bits(GetBitContext *s, int n)
264 {
265     register int tmp;
266     OPEN_READER_NOSIZE(re, s);
267     UPDATE_CACHE(re, s);
268     tmp = SHOW_UBITS(re, s, n);
269     return tmp;
270 }
271
272 static inline void skip_bits(GetBitContext *s, int n)
273 {
274     OPEN_READER(re, s);
275     UPDATE_CACHE(re, s);
276     LAST_SKIP_BITS(re, s, n);
277     CLOSE_READER(re, s);
278 }
279
280 static inline unsigned int get_bits1(GetBitContext *s)
281 {
282     unsigned int index = s->index;
283     uint8_t result     = s->buffer[index >> 3];
284 #ifdef BITSTREAM_READER_LE
285     result >>= index & 7;
286     result  &= 1;
287 #else
288     result <<= index & 7;
289     result >>= 8 - 1;
290 #endif
291 #if !UNCHECKED_BITSTREAM_READER
292     if (s->index < s->size_in_bits_plus8)
293 #endif
294         index++;
295     s->index = index;
296
297     return result;
298 }
299
300 static inline unsigned int show_bits1(GetBitContext *s)
301 {
302     return show_bits(s, 1);
303 }
304
305 static inline void skip_bits1(GetBitContext *s)
306 {
307     skip_bits(s, 1);
308 }
309
310 /**
311  * Read 0-32 bits.
312  */
313 static inline unsigned int get_bits_long(GetBitContext *s, int n)
314 {
315     if (n <= MIN_CACHE_BITS) {
316         return get_bits(s, n);
317     } else {
318 #ifdef BITSTREAM_READER_LE
319         int ret = get_bits(s, 16);
320         return ret | (get_bits(s, n - 16) << 16);
321 #else
322         int ret = get_bits(s, 16) << (n - 16);
323         return ret | get_bits(s, n - 16);
324 #endif
325     }
326 }
327
328 /*
329  * Read 0-64 bits.
330  */
331 static inline uint64_t get_bits64(GetBitContext *s, int n)
332 {
333     if (n <= 32) {
334         return get_bits_long(s, n);
335     } else {
336 #ifdef BITSTREAM_READER_LE
337         uint64_t ret = get_bits_long(s, 32);
338         return ret | (uint64_t) get_bits_long(s, n - 32) << 32;
339 #else
340         uint64_t ret = (uint64_t) get_bits_long(s, n - 32) << 32;
341         return ret | get_bits_long(s, 32);
342 #endif
343     }
344 }
345
346 /**
347  * Read 0-32 bits as a signed integer.
348  */
349 static inline int get_sbits_long(GetBitContext *s, int n)
350 {
351     return sign_extend(get_bits_long(s, n), n);
352 }
353
354 /**
355  * Show 0-32 bits.
356  */
357 static inline unsigned int show_bits_long(GetBitContext *s, int n)
358 {
359     if (n <= MIN_CACHE_BITS) {
360         return show_bits(s, n);
361     } else {
362         GetBitContext gb = *s;
363         return get_bits_long(&gb, n);
364     }
365 }
366
367 /**
368  * Initialize GetBitContext.
369  * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
370  *        larger than the actual read bits because some optimized bitstream
371  *        readers read 32 or 64 bit at once and could read over the end
372  * @param bit_size the size of the buffer in bits
373  * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
374  */
375 static inline int init_get_bits(GetBitContext *s, const uint8_t *buffer,
376                                 int bit_size)
377 {
378     int buffer_size;
379     int ret = 0;
380
381     if (bit_size > INT_MAX - 7 || bit_size < 0 || !buffer) {
382         bit_size    = 0;
383         buffer      = NULL;
384         ret         = AVERROR_INVALIDDATA;
385     }
386
387     buffer_size = (bit_size + 7) >> 3;
388
389     s->buffer             = buffer;
390     s->size_in_bits       = bit_size;
391 #if !UNCHECKED_BITSTREAM_READER
392     s->size_in_bits_plus8 = bit_size + 8;
393 #endif
394     s->buffer_end         = buffer + buffer_size;
395     s->index              = 0;
396
397     return ret;
398 }
399
400 /**
401  * Initialize GetBitContext.
402  * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
403  *        larger than the actual read bits because some optimized bitstream
404  *        readers read 32 or 64 bit at once and could read over the end
405  * @param byte_size the size of the buffer in bytes
406  * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
407  */
408 static inline int init_get_bits8(GetBitContext *s, const uint8_t *buffer,
409                                  int byte_size)
410 {
411     if (byte_size > INT_MAX / 8)
412         return AVERROR_INVALIDDATA;
413     return init_get_bits(s, buffer, byte_size * 8);
414 }
415
416 static inline const uint8_t *align_get_bits(GetBitContext *s)
417 {
418     int n = -get_bits_count(s) & 7;
419     if (n)
420         skip_bits(s, n);
421     return s->buffer + (s->index >> 3);
422 }
423
424 #define init_vlc(vlc, nb_bits, nb_codes,                \
425                  bits, bits_wrap, bits_size,            \
426                  codes, codes_wrap, codes_size,         \
427                  flags)                                 \
428     ff_init_vlc_sparse(vlc, nb_bits, nb_codes,          \
429                        bits, bits_wrap, bits_size,      \
430                        codes, codes_wrap, codes_size,   \
431                        NULL, 0, 0, flags)
432
433 int ff_init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
434                        const void *bits, int bits_wrap, int bits_size,
435                        const void *codes, int codes_wrap, int codes_size,
436                        const void *symbols, int symbols_wrap, int symbols_size,
437                        int flags);
438 void ff_free_vlc(VLC *vlc);
439
440 #define INIT_VLC_LE             2
441 #define INIT_VLC_USE_NEW_STATIC 4
442
443 #define INIT_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, static_size)       \
444     do {                                                                   \
445         static VLC_TYPE table[static_size][2];                             \
446         (vlc)->table           = table;                                    \
447         (vlc)->table_allocated = static_size;                              \
448         init_vlc(vlc, bits, a, b, c, d, e, f, g, INIT_VLC_USE_NEW_STATIC); \
449     } while (0)
450
451 /**
452  * If the vlc code is invalid and max_depth=1, then no bits will be removed.
453  * If the vlc code is invalid and max_depth>1, then the number of bits removed
454  * is undefined.
455  */
456 #define GET_VLC(code, name, gb, table, bits, max_depth)         \
457     do {                                                        \
458         int n, nb_bits;                                         \
459         unsigned int index;                                     \
460                                                                 \
461         index = SHOW_UBITS(name, gb, bits);                     \
462         code  = table[index][0];                                \
463         n     = table[index][1];                                \
464                                                                 \
465         if (max_depth > 1 && n < 0) {                           \
466             LAST_SKIP_BITS(name, gb, bits);                     \
467             UPDATE_CACHE(name, gb);                             \
468                                                                 \
469             nb_bits = -n;                                       \
470                                                                 \
471             index = SHOW_UBITS(name, gb, nb_bits) + code;       \
472             code  = table[index][0];                            \
473             n     = table[index][1];                            \
474             if (max_depth > 2 && n < 0) {                       \
475                 LAST_SKIP_BITS(name, gb, nb_bits);              \
476                 UPDATE_CACHE(name, gb);                         \
477                                                                 \
478                 nb_bits = -n;                                   \
479                                                                 \
480                 index = SHOW_UBITS(name, gb, nb_bits) + code;   \
481                 code  = table[index][0];                        \
482                 n     = table[index][1];                        \
483             }                                                   \
484         }                                                       \
485         SKIP_BITS(name, gb, n);                                 \
486     } while (0)
487
488 #define GET_RL_VLC(level, run, name, gb, table, bits,           \
489                    max_depth, need_update)                      \
490     do {                                                        \
491         int n, nb_bits;                                         \
492         unsigned int index;                                     \
493                                                                 \
494         index = SHOW_UBITS(name, gb, bits);                     \
495         level = table[index].level;                             \
496         n     = table[index].len;                               \
497                                                                 \
498         if (max_depth > 1 && n < 0) {                           \
499             SKIP_BITS(name, gb, bits);                          \
500             if (need_update) {                                  \
501                 UPDATE_CACHE(name, gb);                         \
502             }                                                   \
503                                                                 \
504             nb_bits = -n;                                       \
505                                                                 \
506             index = SHOW_UBITS(name, gb, nb_bits) + level;      \
507             level = table[index].level;                         \
508             n     = table[index].len;                           \
509             if (max_depth > 2 && n < 0) {                       \
510                 LAST_SKIP_BITS(name, gb, nb_bits);              \
511                 if (need_update) {                              \
512                     UPDATE_CACHE(name, gb);                     \
513                 }                                               \
514                 nb_bits = -n;                                   \
515                                                                 \
516                 index = SHOW_UBITS(name, gb, nb_bits) + level;  \
517                 level = table[index].level;                     \
518                 n     = table[index].len;                       \
519             }                                                   \
520         }                                                       \
521         run = table[index].run;                                 \
522         SKIP_BITS(name, gb, n);                                 \
523     } while (0)
524
525 /**
526  * Parse a vlc code.
527  * @param bits is the number of bits which will be read at once, must be
528  *             identical to nb_bits in init_vlc()
529  * @param max_depth is the number of times bits bits must be read to completely
530  *                  read the longest vlc code
531  *                  = (max_vlc_length + bits - 1) / bits
532  */
533 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
534                                      int bits, int max_depth)
535 {
536     int code;
537
538     OPEN_READER(re, s);
539     UPDATE_CACHE(re, s);
540
541     GET_VLC(code, re, s, table, bits, max_depth);
542
543     CLOSE_READER(re, s);
544
545     return code;
546 }
547
548 static inline int decode012(GetBitContext *gb)
549 {
550     int n;
551     n = get_bits1(gb);
552     if (n == 0)
553         return 0;
554     else
555         return get_bits1(gb) + 1;
556 }
557
558 static inline int decode210(GetBitContext *gb)
559 {
560     if (get_bits1(gb))
561         return 0;
562     else
563         return 2 - get_bits1(gb);
564 }
565
566 static inline int get_bits_left(GetBitContext *gb)
567 {
568     return gb->size_in_bits - get_bits_count(gb);
569 }
570
571 //#define TRACE
572
573 #ifdef TRACE
574 static inline void print_bin(int bits, int n)
575 {
576     int i;
577
578     for (i = n - 1; i >= 0; i--)
579         av_log(NULL, AV_LOG_DEBUG, "%d", (bits >> i) & 1);
580     for (i = n; i < 24; i++)
581         av_log(NULL, AV_LOG_DEBUG, " ");
582 }
583
584 static inline int get_bits_trace(GetBitContext *s, int n, const char *file,
585                                  const char *func, int line)
586 {
587     int r = get_bits(s, n);
588
589     print_bin(r, n);
590     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
591            r, n, r, get_bits_count(s) - n, file, func, line);
592
593     return r;
594 }
595
596 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
597                                 int bits, int max_depth, const char *file,
598                                 const char *func, int line)
599 {
600     int show  = show_bits(s, 24);
601     int pos   = get_bits_count(s);
602     int r     = get_vlc2(s, table, bits, max_depth);
603     int len   = get_bits_count(s) - pos;
604     int bits2 = show >> (24 - len);
605
606     print_bin(bits2, len);
607
608     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
609            bits2, len, r, pos, file, func, line);
610
611     return r;
612 }
613
614 static inline int get_xbits_trace(GetBitContext *s, int n, const char *file,
615                                   const char *func, int line)
616 {
617     int show = show_bits(s, n);
618     int r    = get_xbits(s, n);
619
620     print_bin(show, n);
621     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
622            show, n, r, get_bits_count(s) - n, file, func, line);
623
624     return r;
625 }
626
627 #define get_bits(s, n)  get_bits_trace(s , n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
628 #define get_bits1(s)    get_bits_trace(s,  1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
629 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
630
631 #define get_vlc(s, vlc)             get_vlc_trace(s, (vlc)->table, (vlc)->bits,   3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
632 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s,          tab,        bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
633 #endif
634
635 #endif /* AVCODEC_GET_BITS_H */