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
30 #include "libavutil/common.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/log.h"
33 #include "libavutil/avassert.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 int size_in_bits_plus8;
60 #define VLC_TYPE int16_t
64 VLC_TYPE (*table)[2]; ///< code, bits
65 int table_size, table_allocated;
68 typedef struct RL_VLC_ELEM {
74 /* Bitstream reader API docs:
76 arbitrary name which is used as prefix for the internal variables
82 load gb into local variables
84 CLOSE_READER(name, gb)
85 store local vars in gb
87 UPDATE_CACHE(name, gb)
88 refill the internal cache from the bitstream
89 after this call at least MIN_CACHE_BITS will be available,
92 will output the contents of the internal cache, next bit is MSB of 32 or 64 bit (FIXME 64bit)
94 SHOW_UBITS(name, gb, num)
95 will return the next num bits
97 SHOW_SBITS(name, gb, num)
98 will return the next num bits and do sign extension
100 SKIP_BITS(name, gb, num)
101 will skip over the next num bits
102 note, this is equivalent to SKIP_CACHE; SKIP_COUNTER
104 SKIP_CACHE(name, gb, num)
105 will remove the next num bits from the cache (note SKIP_COUNTER MUST be called before UPDATE_CACHE / CLOSE_READER)
107 SKIP_COUNTER(name, gb, num)
108 will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS)
110 LAST_SKIP_BITS(name, gb, num)
111 like SKIP_BITS, to be used if next call is UPDATE_CACHE or CLOSE_READER
113 for examples see get_bits, show_bits, skip_bits, get_vlc
116 #ifdef LONG_BITSTREAM_READER
117 # define MIN_CACHE_BITS 32
119 # define MIN_CACHE_BITS 25
122 #if UNCHECKED_BITSTREAM_READER
123 #define OPEN_READER(name, gb) \
124 unsigned int name##_index = (gb)->index; \
125 av_unused unsigned int name##_cache
127 #define HAVE_BITS_REMAINING(name, gb) 1
129 #define OPEN_READER(name, gb) \
130 unsigned int name##_index = (gb)->index; \
131 unsigned int av_unused name##_cache = 0; \
132 unsigned int av_unused name##_size_plus8 = \
133 (gb)->size_in_bits_plus8
135 #define HAVE_BITS_REMAINING(name, gb) \
136 name##_index < name##_size_plus8
139 #define CLOSE_READER(name, gb) (gb)->index = name##_index
141 #ifdef BITSTREAM_READER_LE
143 # ifdef LONG_BITSTREAM_READER
144 # define UPDATE_CACHE(name, gb) name##_cache = \
145 AV_RL64((gb)->buffer + (name##_index >> 3)) >> (name##_index & 7)
147 # define UPDATE_CACHE(name, gb) name##_cache = \
148 AV_RL32((gb)->buffer + (name##_index >> 3)) >> (name##_index & 7)
151 # define SKIP_CACHE(name, gb, num) name##_cache >>= (num)
155 # ifdef LONG_BITSTREAM_READER
156 # define UPDATE_CACHE(name, gb) name##_cache = \
157 AV_RB64((gb)->buffer + (name##_index >> 3)) >> (32 - (name##_index & 7))
159 # define UPDATE_CACHE(name, gb) name##_cache = \
160 AV_RB32((gb)->buffer + (name##_index >> 3)) << (name##_index & 7)
163 # define SKIP_CACHE(name, gb, num) name##_cache <<= (num)
167 #if UNCHECKED_BITSTREAM_READER
168 # define SKIP_COUNTER(name, gb, num) name##_index += (num)
170 # define SKIP_COUNTER(name, gb, num) \
171 name##_index = FFMIN(name##_size_plus8, name##_index + (num))
174 #define SKIP_BITS(name, gb, num) do { \
175 SKIP_CACHE(name, gb, num); \
176 SKIP_COUNTER(name, gb, num); \
179 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
181 #ifdef BITSTREAM_READER_LE
182 # define SHOW_UBITS(name, gb, num) zero_extend(name##_cache, num)
183 # define SHOW_SBITS(name, gb, num) sign_extend(name##_cache, num)
185 # define SHOW_UBITS(name, gb, num) NEG_USR32(name##_cache, num)
186 # define SHOW_SBITS(name, gb, num) NEG_SSR32(name##_cache, num)
189 #define GET_CACHE(name, gb) ((uint32_t)name##_cache)
191 static inline int get_bits_count(const GetBitContext *s)
196 static inline void skip_bits_long(GetBitContext *s, int n){
197 #if UNCHECKED_BITSTREAM_READER
200 s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
205 * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
206 * if MSB not set it is negative
207 * @param n length in bits
209 static inline int get_xbits(GetBitContext *s, int n)
212 register int32_t cache;
215 cache = GET_CACHE(re, s);
217 LAST_SKIP_BITS(re, s, n);
219 return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
222 static inline int get_sbits(GetBitContext *s, int n)
226 av_assert2(n>0 && n<=25);
228 tmp = SHOW_SBITS(re, s, n);
229 LAST_SKIP_BITS(re, s, n);
237 static inline unsigned int get_bits(GetBitContext *s, int n)
241 av_assert2(n>0 && n<=25);
243 tmp = SHOW_UBITS(re, s, n);
244 LAST_SKIP_BITS(re, s, n);
252 static inline unsigned int show_bits(GetBitContext *s, int n)
256 av_assert2(n>0 && n<=25);
258 tmp = SHOW_UBITS(re, s, n);
262 static inline void skip_bits(GetBitContext *s, int n)
266 LAST_SKIP_BITS(re, s, n);
270 static inline unsigned int get_bits1(GetBitContext *s)
272 unsigned int index = s->index;
273 uint8_t result = s->buffer[index>>3];
274 #ifdef BITSTREAM_READER_LE
275 result >>= index & 7;
278 result <<= index & 7;
281 #if !UNCHECKED_BITSTREAM_READER
282 if (s->index < s->size_in_bits_plus8)
290 static inline unsigned int show_bits1(GetBitContext *s)
292 return show_bits(s, 1);
295 static inline void skip_bits1(GetBitContext *s)
303 static inline unsigned int get_bits_long(GetBitContext *s, int n)
307 } else if (n <= MIN_CACHE_BITS)
308 return get_bits(s, n);
310 #ifdef BITSTREAM_READER_LE
311 unsigned ret = get_bits(s, 16);
312 return ret | (get_bits(s, n-16) << 16);
314 unsigned ret = get_bits(s, 16) << (n-16);
315 return ret | get_bits(s, n-16);
323 static inline uint64_t get_bits64(GetBitContext *s, int n)
326 return get_bits_long(s, n);
328 #ifdef BITSTREAM_READER_LE
329 uint64_t ret = get_bits_long(s, 32);
330 return ret | (uint64_t)get_bits_long(s, n - 32) << 32;
332 uint64_t ret = (uint64_t)get_bits_long(s, n - 32) << 32;
333 return ret | get_bits_long(s, 32);
339 * Read 0-32 bits as a signed integer.
341 static inline int get_sbits_long(GetBitContext *s, int n)
343 return sign_extend(get_bits_long(s, n), n);
349 static inline unsigned int show_bits_long(GetBitContext *s, int n)
351 if (n <= MIN_CACHE_BITS)
352 return show_bits(s, n);
354 GetBitContext gb = *s;
355 return get_bits_long(&gb, n);
359 static inline int check_marker(GetBitContext *s, const char *msg)
361 int bit = get_bits1(s);
363 av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);
369 * Inititalize GetBitContext.
370 * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger than the actual read bits
371 * because some optimized bitstream 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
374 static inline void init_get_bits(GetBitContext *s, const uint8_t *buffer,
377 int buffer_size = (bit_size+7)>>3;
378 if (buffer_size < 0 || bit_size < 0) {
379 buffer_size = bit_size = 0;
384 s->size_in_bits = bit_size;
385 s->size_in_bits_plus8 = bit_size + 8;
386 s->buffer_end = buffer + buffer_size;
390 static inline void align_get_bits(GetBitContext *s)
392 int n = -get_bits_count(s) & 7;
393 if (n) skip_bits(s, n);
396 #define init_vlc(vlc, nb_bits, nb_codes, \
397 bits, bits_wrap, bits_size, \
398 codes, codes_wrap, codes_size, \
400 ff_init_vlc_sparse(vlc, nb_bits, nb_codes, \
401 bits, bits_wrap, bits_size, \
402 codes, codes_wrap, codes_size, \
405 int ff_init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
406 const void *bits, int bits_wrap, int bits_size,
407 const void *codes, int codes_wrap, int codes_size,
408 const void *symbols, int symbols_wrap, int symbols_size,
410 #define INIT_VLC_LE 2
411 #define INIT_VLC_USE_NEW_STATIC 4
412 void ff_free_vlc(VLC *vlc);
414 #define INIT_VLC_STATIC(vlc, bits, a,b,c,d,e,f,g, static_size) do { \
415 static VLC_TYPE table[static_size][2]; \
416 (vlc)->table = table; \
417 (vlc)->table_allocated = static_size; \
418 init_vlc(vlc, bits, a,b,c,d,e,f,g, INIT_VLC_USE_NEW_STATIC); \
423 * If the vlc code is invalid and max_depth=1, then no bits will be removed.
424 * If the vlc code is invalid and max_depth>1, then the number of bits removed
427 #define GET_VLC(code, name, gb, table, bits, max_depth) \
430 unsigned int index; \
432 index = SHOW_UBITS(name, gb, bits); \
433 code = table[index][0]; \
434 n = table[index][1]; \
436 if (max_depth > 1 && n < 0) { \
437 LAST_SKIP_BITS(name, gb, bits); \
438 UPDATE_CACHE(name, gb); \
442 index = SHOW_UBITS(name, gb, nb_bits) + code; \
443 code = table[index][0]; \
444 n = table[index][1]; \
445 if (max_depth > 2 && n < 0) { \
446 LAST_SKIP_BITS(name, gb, nb_bits); \
447 UPDATE_CACHE(name, gb); \
451 index = SHOW_UBITS(name, gb, nb_bits) + code; \
452 code = table[index][0]; \
453 n = table[index][1]; \
456 SKIP_BITS(name, gb, n); \
459 #define GET_RL_VLC(level, run, name, gb, table, bits, max_depth, need_update) \
462 unsigned int index; \
464 index = SHOW_UBITS(name, gb, bits); \
465 level = table[index].level; \
466 n = table[index].len; \
468 if (max_depth > 1 && n < 0) { \
469 SKIP_BITS(name, gb, bits); \
471 UPDATE_CACHE(name, gb); \
476 index = SHOW_UBITS(name, gb, nb_bits) + level; \
477 level = table[index].level; \
478 n = table[index].len; \
480 run = table[index].run; \
481 SKIP_BITS(name, gb, n); \
487 * @param bits is the number of bits which will be read at once, must be
488 * identical to nb_bits in init_vlc()
489 * @param max_depth is the number of times bits bits must be read to completely
490 * read the longest vlc code
491 * = (max_vlc_length + bits - 1) / bits
493 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
494 int bits, int max_depth)
501 GET_VLC(code, re, s, table, bits, max_depth);
507 static inline int decode012(GetBitContext *gb)
514 return get_bits1(gb) + 1;
517 static inline int decode210(GetBitContext *gb)
522 return 2 - get_bits1(gb);
525 static inline int get_bits_left(GetBitContext *gb)
527 return gb->size_in_bits - get_bits_count(gb);
533 static inline void print_bin(int bits, int n)
537 for (i = n-1; i >= 0; i--) {
538 av_log(NULL, AV_LOG_DEBUG, "%d", (bits>>i)&1);
540 for (i = n; i < 24; i++)
541 av_log(NULL, AV_LOG_DEBUG, " ");
544 static inline int get_bits_trace(GetBitContext *s, int n, const char *file,
545 const char *func, int line)
547 int r = get_bits(s, n);
550 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
551 r, n, r, get_bits_count(s)-n, file, func, line);
554 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
555 int bits, int max_depth, const char *file,
556 const char *func, int line)
558 int show = show_bits(s, 24);
559 int pos = get_bits_count(s);
560 int r = get_vlc2(s, table, bits, max_depth);
561 int len = get_bits_count(s) - pos;
562 int bits2 = show >> (24-len);
564 print_bin(bits2, len);
566 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
567 bits2, len, r, pos, file, func, line);
570 static inline int get_xbits_trace(GetBitContext *s, int n, const char *file,
571 const char *func, int line)
573 int show = show_bits(s, n);
574 int r = get_xbits(s, n);
577 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
578 show, n, r, get_bits_count(s)-n, file, func, line);
582 #define get_bits(s, n) get_bits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
583 #define get_bits1(s) get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
584 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
585 #define get_vlc(s, vlc) get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
586 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
588 #define tprintf(p, ...) av_log(p, AV_LOG_DEBUG, __VA_ARGS__)
591 #define tprintf(p, ...) {}
594 #endif /* AVCODEC_GET_BITS_H */