2 * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
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"
34 #include "libavutil/avassert.h"
38 * Safe bitstream reading:
39 * optionally, the get_bits API can check to ensure that we
40 * don't read past input buffer boundaries. This is protected
41 * with CONFIG_SAFE_BITSTREAM_READER at the global level, and
42 * then below that with UNCHECKED_BITSTREAM_READER at the per-
43 * decoder level. This means that decoders that check internally
44 * can "#define UNCHECKED_BITSTREAM_READER 1" to disable
46 * Boundary checking causes a minor performance penalty so for
47 * applications that won't want/need this, it can be disabled
48 * globally using "#define CONFIG_SAFE_BITSTREAM_READER 0".
50 #ifndef UNCHECKED_BITSTREAM_READER
51 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
54 typedef struct GetBitContext {
55 const uint8_t *buffer, *buffer_end;
58 int size_in_bits_plus8;
61 #define VLC_TYPE int16_t
65 VLC_TYPE (*table)[2]; ///< code, bits
66 int table_size, table_allocated;
69 typedef struct RL_VLC_ELEM {
75 /* Bitstream reader API docs:
77 * arbitrary name which is used as prefix for the internal variables
82 * OPEN_READER(name, gb)
83 * load gb into local variables
85 * CLOSE_READER(name, gb)
86 * store local vars in gb
88 * UPDATE_CACHE(name, gb)
89 * Refill the internal cache from the bitstream.
90 * After this call at least MIN_CACHE_BITS will be available.
93 * Will output the contents of the internal cache,
94 * next bit is MSB of 32 or 64 bit (FIXME 64bit).
96 * SHOW_UBITS(name, gb, num)
97 * Will return the next num bits.
99 * SHOW_SBITS(name, gb, num)
100 * Will return the next num bits and do sign extension.
102 * SKIP_BITS(name, gb, num)
103 * Will skip over the next num bits.
104 * Note, this is equivalent to SKIP_CACHE; SKIP_COUNTER.
106 * SKIP_CACHE(name, gb, num)
107 * Will remove the next num bits from the cache (note SKIP_COUNTER
108 * MUST be called before UPDATE_CACHE / CLOSE_READER).
110 * SKIP_COUNTER(name, gb, num)
111 * Will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS).
113 * LAST_SKIP_BITS(name, gb, num)
114 * Like SKIP_BITS, to be used if next call is UPDATE_CACHE or CLOSE_READER.
116 * BITS_LEFT(name, gb)
117 * Return the number of bits left
119 * For examples see get_bits, show_bits, skip_bits, get_vlc.
122 #ifdef LONG_BITSTREAM_READER
123 # define MIN_CACHE_BITS 32
125 # define MIN_CACHE_BITS 25
128 #define OPEN_READER_NOSIZE(name, gb) \
129 unsigned int name ## _index = (gb)->index; \
130 unsigned int av_unused name ## _cache
132 #if UNCHECKED_BITSTREAM_READER
133 #define OPEN_READER(name, gb) OPEN_READER_NOSIZE(name, gb)
135 #define BITS_AVAILABLE(name, gb) 1
137 #define OPEN_READER(name, gb) \
138 OPEN_READER_NOSIZE(name, gb); \
139 unsigned int name ## _size_plus8 = (gb)->size_in_bits_plus8
141 #define BITS_AVAILABLE(name, gb) name ## _index < name ## _size_plus8
144 #define CLOSE_READER(name, gb) (gb)->index = name ## _index
146 # ifdef LONG_BITSTREAM_READER
148 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
149 AV_RL64((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
151 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
152 AV_RB64((gb)->buffer + (name ## _index >> 3)) >> (32 - (name ## _index & 7))
156 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
157 AV_RL32((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
159 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
160 AV_RB32((gb)->buffer + (name ## _index >> 3)) << (name ## _index & 7)
165 #ifdef BITSTREAM_READER_LE
167 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_LE(name, gb)
169 # define SKIP_CACHE(name, gb, num) name ## _cache >>= (num)
173 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_BE(name, gb)
175 # define SKIP_CACHE(name, gb, num) name ## _cache <<= (num)
179 #if UNCHECKED_BITSTREAM_READER
180 # define SKIP_COUNTER(name, gb, num) name ## _index += (num)
182 # define SKIP_COUNTER(name, gb, num) \
183 name ## _index = FFMIN(name ## _size_plus8, name ## _index + (num))
186 #define BITS_LEFT(name, gb) ((int)((gb)->size_in_bits - name ## _index))
188 #define SKIP_BITS(name, gb, num) \
190 SKIP_CACHE(name, gb, num); \
191 SKIP_COUNTER(name, gb, num); \
194 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
196 #define SHOW_UBITS_LE(name, gb, num) zero_extend(name ## _cache, num)
197 #define SHOW_SBITS_LE(name, gb, num) sign_extend(name ## _cache, num)
199 #define SHOW_UBITS_BE(name, gb, num) NEG_USR32(name ## _cache, num)
200 #define SHOW_SBITS_BE(name, gb, num) NEG_SSR32(name ## _cache, num)
202 #ifdef BITSTREAM_READER_LE
203 # define SHOW_UBITS(name, gb, num) SHOW_UBITS_LE(name, gb, num)
204 # define SHOW_SBITS(name, gb, num) SHOW_SBITS_LE(name, gb, num)
206 # define SHOW_UBITS(name, gb, num) SHOW_UBITS_BE(name, gb, num)
207 # define SHOW_SBITS(name, gb, num) SHOW_SBITS_BE(name, gb, num)
210 #define GET_CACHE(name, gb) ((uint32_t) name ## _cache)
212 static inline int get_bits_count(const GetBitContext *s)
217 static inline void skip_bits_long(GetBitContext *s, int n)
219 #if UNCHECKED_BITSTREAM_READER
222 s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
227 * read mpeg1 dc style vlc (sign bit + mantissa with no MSB).
228 * if MSB not set it is negative
229 * @param n length in bits
231 static inline int get_xbits(GetBitContext *s, int n)
234 register int32_t cache;
236 av_assert2(n>0 && n<=25);
238 cache = GET_CACHE(re, s);
240 LAST_SKIP_BITS(re, s, n);
242 return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
245 static inline int get_sbits(GetBitContext *s, int n)
249 av_assert2(n>0 && n<=25);
251 tmp = SHOW_SBITS(re, s, n);
252 LAST_SKIP_BITS(re, s, n);
260 static inline unsigned int get_bits(GetBitContext *s, int n)
264 av_assert2(n>0 && n<=25);
266 tmp = SHOW_UBITS(re, s, n);
267 LAST_SKIP_BITS(re, s, n);
275 static av_always_inline int get_bitsz(GetBitContext *s, int n)
277 return n ? get_bits(s, n) : 0;
280 static inline unsigned int get_bits_le(GetBitContext *s, int n)
284 av_assert2(n>0 && n<=25);
285 UPDATE_CACHE_LE(re, s);
286 tmp = SHOW_UBITS_LE(re, s, n);
287 LAST_SKIP_BITS(re, s, n);
295 static inline unsigned int show_bits(GetBitContext *s, int n)
298 OPEN_READER_NOSIZE(re, s);
299 av_assert2(n>0 && n<=25);
301 tmp = SHOW_UBITS(re, s, n);
305 static inline void skip_bits(GetBitContext *s, int n)
308 LAST_SKIP_BITS(re, s, n);
312 static inline unsigned int get_bits1(GetBitContext *s)
314 unsigned int index = s->index;
315 uint8_t result = s->buffer[index >> 3];
316 #ifdef BITSTREAM_READER_LE
317 result >>= index & 7;
320 result <<= index & 7;
323 #if !UNCHECKED_BITSTREAM_READER
324 if (s->index < s->size_in_bits_plus8)
332 static inline unsigned int show_bits1(GetBitContext *s)
334 return show_bits(s, 1);
337 static inline void skip_bits1(GetBitContext *s)
345 static inline unsigned int get_bits_long(GetBitContext *s, int n)
349 } else if (n <= MIN_CACHE_BITS) {
350 return get_bits(s, n);
352 #ifdef BITSTREAM_READER_LE
353 unsigned ret = get_bits(s, 16);
354 return ret | (get_bits(s, n - 16) << 16);
356 unsigned ret = get_bits(s, 16) << (n - 16);
357 return ret | get_bits(s, n - 16);
365 static inline uint64_t get_bits64(GetBitContext *s, int n)
368 return get_bits_long(s, n);
370 #ifdef BITSTREAM_READER_LE
371 uint64_t ret = get_bits_long(s, 32);
372 return ret | (uint64_t) get_bits_long(s, n - 32) << 32;
374 uint64_t ret = (uint64_t) get_bits_long(s, n - 32) << 32;
375 return ret | get_bits_long(s, 32);
381 * Read 0-32 bits as a signed integer.
383 static inline int get_sbits_long(GetBitContext *s, int n)
385 return sign_extend(get_bits_long(s, n), n);
391 static inline unsigned int show_bits_long(GetBitContext *s, int n)
393 if (n <= MIN_CACHE_BITS) {
394 return show_bits(s, n);
396 GetBitContext gb = *s;
397 return get_bits_long(&gb, n);
401 static inline int check_marker(GetBitContext *s, const char *msg)
403 int bit = get_bits1(s);
405 av_log(NULL, AV_LOG_INFO, "Marker bit missing at %d of %d %s\n", get_bits_count(s) - 1, s->size_in_bits, msg);
411 * Initialize GetBitContext.
412 * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
413 * larger than the actual read bits because some optimized bitstream
414 * readers read 32 or 64 bit at once and could read over the end
415 * @param bit_size the size of the buffer in bits
416 * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
418 static inline int init_get_bits(GetBitContext *s, const uint8_t *buffer,
424 if (bit_size >= INT_MAX - 7 || bit_size < 0 || !buffer) {
427 ret = AVERROR_INVALIDDATA;
430 buffer_size = (bit_size + 7) >> 3;
433 s->size_in_bits = bit_size;
434 s->size_in_bits_plus8 = bit_size + 8;
435 s->buffer_end = buffer + buffer_size;
442 * Initialize GetBitContext.
443 * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
444 * larger than the actual read bits because some optimized bitstream
445 * readers read 32 or 64 bit at once and could read over the end
446 * @param byte_size the size of the buffer in bytes
447 * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
449 static inline int init_get_bits8(GetBitContext *s, const uint8_t *buffer,
452 if (byte_size > INT_MAX / 8 || byte_size < 0)
454 return init_get_bits(s, buffer, byte_size * 8);
457 static inline const uint8_t *align_get_bits(GetBitContext *s)
459 int n = -get_bits_count(s) & 7;
462 return s->buffer + (s->index >> 3);
465 #define init_vlc(vlc, nb_bits, nb_codes, \
466 bits, bits_wrap, bits_size, \
467 codes, codes_wrap, codes_size, \
469 ff_init_vlc_sparse(vlc, nb_bits, nb_codes, \
470 bits, bits_wrap, bits_size, \
471 codes, codes_wrap, codes_size, \
474 int ff_init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
475 const void *bits, int bits_wrap, int bits_size,
476 const void *codes, int codes_wrap, int codes_size,
477 const void *symbols, int symbols_wrap, int symbols_size,
479 void ff_free_vlc(VLC *vlc);
481 #define INIT_VLC_LE 2
482 #define INIT_VLC_USE_NEW_STATIC 4
484 #define INIT_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, static_size) \
486 static VLC_TYPE table[static_size][2]; \
487 (vlc)->table = table; \
488 (vlc)->table_allocated = static_size; \
489 init_vlc(vlc, bits, a, b, c, d, e, f, g, INIT_VLC_USE_NEW_STATIC); \
493 * If the vlc code is invalid and max_depth=1, then no bits will be removed.
494 * If the vlc code is invalid and max_depth>1, then the number of bits removed
497 #define GET_VLC(code, name, gb, table, bits, max_depth) \
500 unsigned int index; \
502 index = SHOW_UBITS(name, gb, bits); \
503 code = table[index][0]; \
504 n = table[index][1]; \
506 if (max_depth > 1 && n < 0) { \
507 LAST_SKIP_BITS(name, gb, bits); \
508 UPDATE_CACHE(name, gb); \
512 index = SHOW_UBITS(name, gb, nb_bits) + code; \
513 code = table[index][0]; \
514 n = table[index][1]; \
515 if (max_depth > 2 && n < 0) { \
516 LAST_SKIP_BITS(name, gb, nb_bits); \
517 UPDATE_CACHE(name, gb); \
521 index = SHOW_UBITS(name, gb, nb_bits) + code; \
522 code = table[index][0]; \
523 n = table[index][1]; \
526 SKIP_BITS(name, gb, n); \
529 #define GET_RL_VLC_INTERNAL(level, run, name, gb, table, bits, \
530 max_depth, need_update) \
533 unsigned int index; \
535 index = SHOW_UBITS(name, gb, bits); \
536 level = table[index].level; \
537 n = table[index].len; \
539 if (max_depth > 1 && n < 0) { \
540 SKIP_BITS(name, gb, bits); \
542 UPDATE_CACHE(name, gb); \
547 index = SHOW_UBITS(name, gb, nb_bits) + level; \
548 level = table[index].level; \
549 n = table[index].len; \
550 if (max_depth > 2 && n < 0) { \
551 LAST_SKIP_BITS(name, gb, nb_bits); \
553 UPDATE_CACHE(name, gb); \
557 index = SHOW_UBITS(name, gb, nb_bits) + level; \
558 level = table[index].level; \
559 n = table[index].len; \
562 run = table[index].run; \
563 SKIP_BITS(name, gb, n); \
568 * @param bits is the number of bits which will be read at once, must be
569 * identical to nb_bits in init_vlc()
570 * @param max_depth is the number of times bits bits must be read to completely
571 * read the longest vlc code
572 * = (max_vlc_length + bits - 1) / bits
574 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
575 int bits, int max_depth)
582 GET_VLC(code, re, s, table, bits, max_depth);
589 static inline int decode012(GetBitContext *gb)
596 return get_bits1(gb) + 1;
599 static inline int decode210(GetBitContext *gb)
604 return 2 - get_bits1(gb);
607 static inline int get_bits_left(GetBitContext *gb)
609 return gb->size_in_bits - get_bits_count(gb);
612 static inline int skip_1stop_8data_bits(GetBitContext *gb)
614 if (get_bits_left(gb) <= 0)
615 return AVERROR_INVALIDDATA;
617 while (get_bits1(gb)) {
619 if (get_bits_left(gb) <= 0)
620 return AVERROR_INVALIDDATA;
629 static inline void print_bin(int bits, int n)
633 for (i = n - 1; i >= 0; i--)
634 av_log(NULL, AV_LOG_DEBUG, "%d", (bits >> i) & 1);
635 for (i = n; i < 24; i++)
636 av_log(NULL, AV_LOG_DEBUG, " ");
639 static inline int get_bits_trace(GetBitContext *s, int n, const char *file,
640 const char *func, int line)
642 int r = get_bits(s, n);
645 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
646 r, n, r, get_bits_count(s) - n, file, func, line);
651 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
652 int bits, int max_depth, const char *file,
653 const char *func, int line)
655 int show = show_bits(s, 24);
656 int pos = get_bits_count(s);
657 int r = get_vlc2(s, table, bits, max_depth);
658 int len = get_bits_count(s) - pos;
659 int bits2 = show >> (24 - len);
661 print_bin(bits2, len);
663 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
664 bits2, len, r, pos, file, func, line);
669 #define GET_RL_VLC(level, run, name, gb, table, bits, \
670 max_depth, need_update) \
672 int show = SHOW_UBITS(name, gb, 24); \
674 int pos = name ## _index; \
676 GET_RL_VLC_INTERNAL(level, run, name, gb, table, bits,max_depth, need_update); \
678 len = name ## _index - pos + 1; \
679 show = show >> (24 - len); \
681 print_bin(show, len); \
683 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d/%-3d rlv @%5d in %s %s:%d\n",\
684 show, len, run-1, level, pos, __FILE__, __PRETTY_FUNCTION__, __LINE__);\
688 static inline int get_xbits_trace(GetBitContext *s, int n, const char *file,
689 const char *func, int line)
691 int show = show_bits(s, n);
692 int r = get_xbits(s, n);
695 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
696 show, n, r, get_bits_count(s) - n, file, func, line);
701 #define get_bits(s, n) get_bits_trace(s , n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
702 #define get_bits1(s) get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
703 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
705 #define get_vlc(s, vlc) get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
706 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
708 #define GET_RL_VLC GET_RL_VLC_INTERNAL
711 #endif /* AVCODEC_GET_BITS_H */