2 * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of Libav.
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.
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.
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
23 * bitstream reader API header.
26 #ifndef AVCODEC_GET_BITS_H
27 #define AVCODEC_GET_BITS_H
31 #include "libavutil/common.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/log.h"
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
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".
49 #ifndef UNCHECKED_BITSTREAM_READER
50 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
53 typedef struct GetBitContext {
54 const uint8_t *buffer, *buffer_end;
57 #if !UNCHECKED_BITSTREAM_READER
58 int size_in_bits_plus8;
62 #define VLC_TYPE int16_t
66 VLC_TYPE (*table)[2]; ///< code, bits
67 int table_size, table_allocated;
70 typedef struct RL_VLC_ELEM {
76 /* Bitstream reader API docs:
78 * arbitrary name which is used as prefix for the internal variables
83 * OPEN_READER(name, gb)
84 * load gb into local variables
86 * CLOSE_READER(name, gb)
87 * store local vars in gb
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.
94 * Will output the contents of the internal cache,
95 * next bit is MSB of 32 or 64 bit (FIXME 64bit).
97 * SHOW_UBITS(name, gb, num)
98 * Will return the next num bits.
100 * SHOW_SBITS(name, gb, num)
101 * Will return the next num bits and do sign extension.
103 * SKIP_BITS(name, gb, num)
104 * Will skip over the next num bits.
105 * Note, this is equivalent to SKIP_CACHE; SKIP_COUNTER.
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).
111 * SKIP_COUNTER(name, gb, num)
112 * Will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS).
114 * LAST_SKIP_BITS(name, gb, num)
115 * Like SKIP_BITS, to be used if next call is UPDATE_CACHE or CLOSE_READER.
117 * For examples see get_bits, show_bits, skip_bits, get_vlc.
120 #ifdef LONG_BITSTREAM_READER
121 # define MIN_CACHE_BITS 32
123 # define MIN_CACHE_BITS 25
126 #if UNCHECKED_BITSTREAM_READER
127 #define OPEN_READER(name, gb) \
128 unsigned int name ## _index = (gb)->index; \
129 unsigned int av_unused name ## _cache = 0
131 #define HAVE_BITS_REMAINING(name, gb) 1
133 #define OPEN_READER(name, gb) \
134 unsigned int name ## _index = (gb)->index; \
135 unsigned int av_unused name ## _cache = 0; \
136 unsigned int av_unused name ## _size_plus8 = (gb)->size_in_bits_plus8
138 #define HAVE_BITS_REMAINING(name, gb) name ## _index < name ## _size_plus8
141 #define CLOSE_READER(name, gb) (gb)->index = name ## _index
143 #ifdef BITSTREAM_READER_LE
145 # ifdef LONG_BITSTREAM_READER
146 # define UPDATE_CACHE(name, gb) name ## _cache = \
147 AV_RL64((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
149 # define UPDATE_CACHE(name, gb) name ## _cache = \
150 AV_RL32((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
153 # define SKIP_CACHE(name, gb, num) name ## _cache >>= (num)
157 # ifdef LONG_BITSTREAM_READER
158 # define UPDATE_CACHE(name, gb) name ## _cache = \
159 AV_RB64((gb)->buffer + (name ## _index >> 3)) >> (32 - (name ## _index & 7))
161 # define UPDATE_CACHE(name, gb) name ## _cache = \
162 AV_RB32((gb)->buffer + (name ## _index >> 3)) << (name ## _index & 7)
165 # define SKIP_CACHE(name, gb, num) name ## _cache <<= (num)
169 #if UNCHECKED_BITSTREAM_READER
170 # define SKIP_COUNTER(name, gb, num) name ## _index += (num)
172 # define SKIP_COUNTER(name, gb, num) \
173 name ## _index = FFMIN(name ## _size_plus8, name ## _index + (num))
176 #define SKIP_BITS(name, gb, num) \
178 SKIP_CACHE(name, gb, num); \
179 SKIP_COUNTER(name, gb, num); \
182 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
184 #ifdef BITSTREAM_READER_LE
185 # define SHOW_UBITS(name, gb, num) zero_extend(name ## _cache, num)
186 # define SHOW_SBITS(name, gb, num) sign_extend(name ## _cache, num)
188 # define SHOW_UBITS(name, gb, num) NEG_USR32(name ## _cache, num)
189 # define SHOW_SBITS(name, gb, num) NEG_SSR32(name ## _cache, num)
192 #define GET_CACHE(name, gb) ((uint32_t) name ## _cache)
194 static inline int get_bits_count(const GetBitContext *s)
199 static inline void skip_bits_long(GetBitContext *s, int n)
201 #if UNCHECKED_BITSTREAM_READER
204 s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
209 * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
210 * if MSB not set it is negative
211 * @param n length in bits
213 static inline int get_xbits(GetBitContext *s, int n)
216 register int32_t cache;
219 cache = GET_CACHE(re, s);
221 LAST_SKIP_BITS(re, s, n);
223 return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
226 static inline int get_sbits(GetBitContext *s, int n)
231 tmp = SHOW_SBITS(re, s, n);
232 LAST_SKIP_BITS(re, s, n);
240 static inline unsigned int get_bits(GetBitContext *s, int n)
245 tmp = SHOW_UBITS(re, s, n);
246 LAST_SKIP_BITS(re, s, n);
254 static inline unsigned int show_bits(GetBitContext *s, int n)
259 tmp = SHOW_UBITS(re, s, n);
263 static inline void skip_bits(GetBitContext *s, int n)
267 LAST_SKIP_BITS(re, s, n);
271 static inline unsigned int get_bits1(GetBitContext *s)
273 unsigned int index = s->index;
274 uint8_t result = s->buffer[index >> 3];
275 #ifdef BITSTREAM_READER_LE
276 result >>= index & 7;
279 result <<= index & 7;
282 #if !UNCHECKED_BITSTREAM_READER
283 if (s->index < s->size_in_bits_plus8)
291 static inline unsigned int show_bits1(GetBitContext *s)
293 return show_bits(s, 1);
296 static inline void skip_bits1(GetBitContext *s)
304 static inline unsigned int get_bits_long(GetBitContext *s, int n)
306 if (n <= MIN_CACHE_BITS) {
307 return get_bits(s, n);
309 #ifdef BITSTREAM_READER_LE
310 int ret = get_bits(s, 16);
311 return ret | (get_bits(s, n - 16) << 16);
313 int ret = get_bits(s, 16) << (n - 16);
314 return ret | get_bits(s, n - 16);
322 static inline uint64_t get_bits64(GetBitContext *s, int n)
325 return get_bits_long(s, n);
327 #ifdef BITSTREAM_READER_LE
328 uint64_t ret = get_bits_long(s, 32);
329 return ret | (uint64_t) get_bits_long(s, n - 32) << 32;
331 uint64_t ret = (uint64_t) get_bits_long(s, n - 32) << 32;
332 return ret | get_bits_long(s, 32);
338 * Read 0-32 bits as a signed integer.
340 static inline int get_sbits_long(GetBitContext *s, int n)
342 return sign_extend(get_bits_long(s, n), n);
348 static inline unsigned int show_bits_long(GetBitContext *s, int n)
350 if (n <= MIN_CACHE_BITS) {
351 return show_bits(s, n);
353 GetBitContext gb = *s;
354 return get_bits_long(&gb, n);
358 static inline int check_marker(GetBitContext *s, const char *msg)
360 int bit = get_bits1(s);
362 av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);
368 * Initialize GetBitContext.
369 * @param buffer bitstream buffer, must be FF_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.
375 static inline int init_get_bits(GetBitContext *s, const uint8_t *buffer,
381 if (bit_size > INT_MAX - 7 || bit_size < 0 || !buffer) {
382 buffer_size = bit_size = 0;
384 ret = AVERROR_INVALIDDATA;
387 buffer_size = (bit_size + 7) >> 3;
390 s->size_in_bits = bit_size;
391 #if !UNCHECKED_BITSTREAM_READER
392 s->size_in_bits_plus8 = bit_size + 8;
394 s->buffer_end = buffer + buffer_size;
401 * Initialize GetBitContext.
402 * @param buffer bitstream buffer, must be FF_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.
408 static inline int init_get_bits8(GetBitContext *s, const uint8_t *buffer,
411 if (byte_size > INT_MAX / 8)
412 return AVERROR_INVALIDDATA;
413 return init_get_bits(s, buffer, byte_size * 8);
416 static inline const uint8_t *align_get_bits(GetBitContext *s)
418 int n = -get_bits_count(s) & 7;
421 return s->buffer + (s->index >> 3);
424 #define init_vlc(vlc, nb_bits, nb_codes, \
425 bits, bits_wrap, bits_size, \
426 codes, codes_wrap, codes_size, \
428 ff_init_vlc_sparse(vlc, nb_bits, nb_codes, \
429 bits, bits_wrap, bits_size, \
430 codes, codes_wrap, codes_size, \
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,
438 void ff_free_vlc(VLC *vlc);
440 #define INIT_VLC_LE 2
441 #define INIT_VLC_USE_NEW_STATIC 4
443 #define INIT_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, static_size) \
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); \
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
456 #define GET_VLC(code, name, gb, table, bits, max_depth) \
459 unsigned int index; \
461 index = SHOW_UBITS(name, gb, bits); \
462 code = table[index][0]; \
463 n = table[index][1]; \
465 if (max_depth > 1 && n < 0) { \
466 LAST_SKIP_BITS(name, gb, bits); \
467 UPDATE_CACHE(name, gb); \
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); \
480 index = SHOW_UBITS(name, gb, nb_bits) + code; \
481 code = table[index][0]; \
482 n = table[index][1]; \
485 SKIP_BITS(name, gb, n); \
488 #define GET_RL_VLC(level, run, name, gb, table, bits, \
489 max_depth, need_update) \
492 unsigned int index; \
494 index = SHOW_UBITS(name, gb, bits); \
495 level = table[index].level; \
496 n = table[index].len; \
498 if (max_depth > 1 && n < 0) { \
499 SKIP_BITS(name, gb, bits); \
501 UPDATE_CACHE(name, gb); \
506 index = SHOW_UBITS(name, gb, nb_bits) + level; \
507 level = table[index].level; \
508 n = table[index].len; \
510 run = table[index].run; \
511 SKIP_BITS(name, gb, n); \
516 * @param bits is the number of bits which will be read at once, must be
517 * identical to nb_bits in init_vlc()
518 * @param max_depth is the number of times bits bits must be read to completely
519 * read the longest vlc code
520 * = (max_vlc_length + bits - 1) / bits
522 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
523 int bits, int max_depth)
530 GET_VLC(code, re, s, table, bits, max_depth);
537 static inline int decode012(GetBitContext *gb)
544 return get_bits1(gb) + 1;
547 static inline int decode210(GetBitContext *gb)
552 return 2 - get_bits1(gb);
555 static inline int get_bits_left(GetBitContext *gb)
557 return gb->size_in_bits - get_bits_count(gb);
563 static inline void print_bin(int bits, int n)
567 for (i = n - 1; i >= 0; i--)
568 av_log(NULL, AV_LOG_DEBUG, "%d", (bits >> i) & 1);
569 for (i = n; i < 24; i++)
570 av_log(NULL, AV_LOG_DEBUG, " ");
573 static inline int get_bits_trace(GetBitContext *s, int n, const char *file,
574 const char *func, int line)
576 int r = get_bits(s, n);
579 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
580 r, n, r, get_bits_count(s) - n, file, func, line);
585 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
586 int bits, int max_depth, const char *file,
587 const char *func, int line)
589 int show = show_bits(s, 24);
590 int pos = get_bits_count(s);
591 int r = get_vlc2(s, table, bits, max_depth);
592 int len = get_bits_count(s) - pos;
593 int bits2 = show >> (24 - len);
595 print_bin(bits2, len);
597 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
598 bits2, len, r, pos, file, func, line);
603 static inline int get_xbits_trace(GetBitContext *s, int n, const char *file,
604 const char *func, int line)
606 int show = show_bits(s, n);
607 int r = get_xbits(s, n);
610 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
611 show, n, r, get_bits_count(s) - n, file, func, line);
616 #define get_bits(s, n) get_bits_trace(s , n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
617 #define get_bits1(s) get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
618 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
620 #define get_vlc(s, vlc) get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
621 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
623 #define tprintf(p, ...) av_log(p, AV_LOG_DEBUG, __VA_ARGS__)
626 #define tprintf(p, ...) { }
629 #endif /* AVCODEC_GET_BITS_H */