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
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
38
39 /*
40 * Safe bitstream reading:
41 * optionally, the get_bits API can check to ensure that we
42 * don't read past input buffer boundaries. This is protected
43 * with CONFIG_SAFE_BITSTREAM_READER at the global level, and
44 * then below that with UNCHECKED_BITSTREAM_READER at the per-
45 * decoder level. This means that decoders that check internally
46 * can "#define UNCHECKED_BITSTREAM_READER 1" to disable
47 * overread checks.
48 * Boundary checking causes a minor performance penalty so for
49 * applications that won't want/need this, it can be disabled
50 * globally using "#define CONFIG_SAFE_BITSTREAM_READER 0".
51 */
52 #ifndef UNCHECKED_BITSTREAM_READER
53 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
54 #endif
55
62
63 /* Bitstream reader API docs:
64 * name
65 * arbitrary name which is used as prefix for the internal variables
66 *
67 * gb
68 * getbitcontext
69 *
70 * OPEN_READER(name, gb)
71 * load gb into local variables
72 *
73 * CLOSE_READER(name, gb)
74 * store local vars in gb
75 *
76 * UPDATE_CACHE(name, gb)
77 * Refill the internal cache from the bitstream.
78 * After this call at least MIN_CACHE_BITS will be available.
79 *
80 * GET_CACHE(name, gb)
81 * Will output the contents of the internal cache,
82 * next bit is MSB of 32 or 64 bits (FIXME 64 bits).
83 *
84 * SHOW_UBITS(name, gb, num)
85 * Will return the next num bits.
86 *
87 * SHOW_SBITS(name, gb, num)
88 * Will return the next num bits and do sign extension.
89 *
90 * SKIP_BITS(name, gb, num)
91 * Will skip over the next num bits.
92 * Note, this is equivalent to SKIP_CACHE; SKIP_COUNTER.
93 *
94 * SKIP_CACHE(name, gb, num)
95 * Will remove the next num bits from the cache (note SKIP_COUNTER
96 * MUST be called before UPDATE_CACHE / CLOSE_READER).
97 *
98 * SKIP_COUNTER(name, gb, num)
99 * Will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS).
100 *
101 * LAST_SKIP_BITS(name, gb, num)
102 * Like SKIP_BITS, to be used if next call is UPDATE_CACHE or CLOSE_READER.
103 *
104 * BITS_LEFT(name, gb)
105 * Return the number of bits left
106 *
107 * For examples see get_bits, show_bits, skip_bits, get_vlc.
108 */
109
110 #ifdef LONG_BITSTREAM_READER
111 # define MIN_CACHE_BITS 32
112 #else
113 # define MIN_CACHE_BITS 25
114 #endif
115
116 #define OPEN_READER_NOSIZE(name, gb) \
117 unsigned int name ## _index = (gb)->index; \
118 unsigned int av_unused name ## _cache
119
120 #if UNCHECKED_BITSTREAM_READER
121 #define OPEN_READER(name, gb) OPEN_READER_NOSIZE(name, gb)
122
123 #define BITS_AVAILABLE(name, gb) 1
124 #else
125 #define OPEN_READER(name, gb) \
126 OPEN_READER_NOSIZE(name, gb); \
127 unsigned int name ## _size_plus8 = (gb)->size_in_bits_plus8
128
129 #define BITS_AVAILABLE(name, gb) name ## _index < name ## _size_plus8
130 #endif
131
132 #define CLOSE_READER(name, gb) (gb)->index = name ## _index
133
134 # ifdef LONG_BITSTREAM_READER
135
136 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
137 AV_RL64((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
138
139 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
140 AV_RB64((gb)->buffer + (name ## _index >> 3)) >> (32 - (name ## _index & 7))
141
142 #else
143
144 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
145 AV_RL32((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
146
147 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
148 AV_RB32((gb)->buffer + (name ## _index >> 3)) << (name ## _index & 7)
149
150 #endif
151
152
153 #ifdef BITSTREAM_READER_LE
154
155 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_LE(name, gb)
156
157 # define SKIP_CACHE(name, gb, num) name ## _cache >>= (num)
158
159 #else
160
161 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_BE(name, gb)
162
163 # define SKIP_CACHE(name, gb, num) name ## _cache <<= (num)
164
165 #endif
166
167 #if UNCHECKED_BITSTREAM_READER
168 # define SKIP_COUNTER(name, gb, num) name ## _index += (num)
169 #else
170 # define SKIP_COUNTER(name, gb, num) \
171 name ## _index = FFMIN(name ## _size_plus8, name ## _index + (num))
172 #endif
173
174 #define BITS_LEFT(name, gb) ((int)((gb)->size_in_bits - name ## _index))
175
176 #define SKIP_BITS(name, gb, num) \
177 do { \
178 SKIP_CACHE(name, gb, num); \
179 SKIP_COUNTER(name, gb, num); \
180 } while (0)
181
182 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
183
184 #define SHOW_UBITS_LE(name, gb, num) zero_extend(name ## _cache, num)
185 #define SHOW_SBITS_LE(name, gb, num) sign_extend(name ## _cache, num)
186
187 #define SHOW_UBITS_BE(name, gb, num) NEG_USR32(name ## _cache, num)
188 #define SHOW_SBITS_BE(name, gb, num) NEG_SSR32(name ## _cache, num)
189
190 #ifdef BITSTREAM_READER_LE
191 # define SHOW_UBITS(name, gb, num) SHOW_UBITS_LE(name, gb, num)
192 # define SHOW_SBITS(name, gb, num) SHOW_SBITS_LE(name, gb, num)
193 #else
194 # define SHOW_UBITS(name, gb, num) SHOW_UBITS_BE(name, gb, num)
195 # define SHOW_SBITS(name, gb, num) SHOW_SBITS_BE(name, gb, num)
196 #endif
197
198 #define GET_CACHE(name, gb) ((uint32_t) name ## _cache)
199
201 {
203 }
204
205 /**
206 * Skips the specified number of bits.
207 * @param n the number of bits to skip,
208 * For the UNCHECKED_BITSTREAM_READER this must not cause the distance
209 * from the start to overflow int32_t. Staying within the bitstream + padding
210 * is sufficient, too.
211 */
213 {
214 #if UNCHECKED_BITSTREAM_READER
216 #else
218 #endif
219 }
220
221 /**
222 * Read MPEG-1 dc-style VLC (sign bit + mantissa with no MSB).
223 * if MSB not set it is negative
224 * @param n length in bits
225 */
227 {
228 register int sign;
234 sign = ~cache >> 31;
237 return (
NEG_USR32(sign ^ cache, n) ^ sign) - sign;
238 }
239
241 {
242 register int sign;
251 return (
zero_extend(sign ^ cache, n) ^ sign) - sign;
252 }
253
255 {
264 }
265
266 /**
267 * Read 1-25 bits.
268 */
270 {
279 }
280
281 /**
282 * Read 0-25 bits.
283 */
285 {
287 }
288
290 {
299 }
300
301 /**
302 * Show 1-25 bits.
303 */
305 {
312 }
313
315 {
319 }
320
322 {
325 #ifdef BITSTREAM_READER_LE
326 result >>= index & 7;
327 result &= 1;
328 #else
329 result <<= index & 7;
330 result >>= 8 - 1;
331 #endif
332 #if !UNCHECKED_BITSTREAM_READER
334 #endif
335 index++;
337
338 return result;
339 }
340
342 {
344 }
345
347 {
349 }
350
351 /**
352 * Read 0-32 bits.
353 */
355 {
357 if (!n) {
358 return 0;
361 } else {
362 #ifdef BITSTREAM_READER_LE
364 return ret | (
get_bits(s, n - 16) << 16);
365 #else
366 unsigned ret =
get_bits(s, 16) << (n - 16);
368 #endif
369 }
370 }
371
372 /**
373 * Read 0-64 bits.
374 */
376 {
377 if (n <= 32) {
379 } else {
380 #ifdef BITSTREAM_READER_LE
383 #else
386 #endif
387 }
388 }
389
390 /**
391 * Read 0-32 bits as a signed integer.
392 */
394 {
395 // sign_extend(x, 0) is undefined
396 if (!n)
397 return 0;
398
400 }
401
402 /**
403 * Show 0-32 bits.
404 */
406 {
409 } else {
412 }
413 }
414
416 {
418 if (!bit)
421
422 return bit;
423 }
424
425 /**
426 * Initialize GetBitContext.
427 * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
428 * larger than the actual read bits because some optimized bitstream
429 * readers read 32 or 64 bit at once and could read over the end
430 * @param bit_size the size of the buffer in bits
431 * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
432 */
434 int bit_size)
435 {
436 int buffer_size;
437 int ret = 0;
438
440 bit_size = 0;
443 }
444
445 buffer_size = (bit_size + 7) >> 3;
446
452
453 return ret;
454 }
455
456 /**
457 * Initialize GetBitContext.
458 * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
459 * larger than the actual read bits because some optimized bitstream
460 * readers read 32 or 64 bit at once and could read over the end
461 * @param byte_size the size of the buffer in bytes
462 * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
463 */
465 int byte_size)
466 {
467 if (byte_size > INT_MAX / 8 || byte_size < 0)
468 byte_size = -1;
470 }
471
473 {
475 if (n)
478 }
479
480 /**
481 * If the vlc code is invalid and max_depth=1, then no bits will be removed.
482 * If the vlc code is invalid and max_depth>1, then the number of bits removed
483 * is undefined.
484 */
485 #define GET_VLC(code, name, gb, table, bits, max_depth) \
486 do { \
487 int n, nb_bits; \
488 unsigned int index; \
489 \
490 index = SHOW_UBITS(name, gb, bits); \
491 code = table[index][0]; \
492 n = table[index][1]; \
493 \
494 if (max_depth > 1 && n < 0) { \
495 LAST_SKIP_BITS(name, gb, bits); \
496 UPDATE_CACHE(name, gb); \
497 \
498 nb_bits = -n; \
499 \
500 index = SHOW_UBITS(name, gb, nb_bits) + code; \
501 code = table[index][0]; \
502 n = table[index][1]; \
503 if (max_depth > 2 && n < 0) { \
504 LAST_SKIP_BITS(name, gb, nb_bits); \
505 UPDATE_CACHE(name, gb); \
506 \
507 nb_bits = -n; \
508 \
509 index = SHOW_UBITS(name, gb, nb_bits) + code; \
510 code = table[index][0]; \
511 n = table[index][1]; \
512 } \
513 } \
514 SKIP_BITS(name, gb, n); \
515 } while (0)
516
517 #define GET_RL_VLC(level, run, name, gb, table, bits, \
518 max_depth, need_update) \
519 do { \
520 int n, nb_bits; \
521 unsigned int index; \
522 \
523 index = SHOW_UBITS(name, gb, bits); \
524 level = table[index].level; \
525 n = table[index].len; \
526 \
527 if (max_depth > 1 && n < 0) { \
528 SKIP_BITS(name, gb, bits); \
529 if (need_update) { \
530 UPDATE_CACHE(name, gb); \
531 } \
532 \
533 nb_bits = -n; \
534 \
535 index = SHOW_UBITS(name, gb, nb_bits) + level; \
536 level = table[index].level; \
537 n = table[index].len; \
538 if (max_depth > 2 && n < 0) { \
539 LAST_SKIP_BITS(name, gb, nb_bits); \
540 if (need_update) { \
541 UPDATE_CACHE(name, gb); \
542 } \
543 nb_bits = -n; \
544 \
545 index = SHOW_UBITS(name, gb, nb_bits) + level; \
546 level = table[index].level; \
547 n = table[index].len; \
548 } \
549 } \
550 run = table[index].run; \
551 SKIP_BITS(name, gb, n); \
552 } while (0)
553
554 /**
555 * Parse a vlc code.
556 * @param bits is the number of bits which will be read at once, must be
557 * identical to nb_bits in init_vlc()
558 * @param max_depth is the number of times bits bits must be read to completely
559 * read the longest vlc code
560 * = (max_vlc_length + bits - 1) / bits
561 * @returns the code parsed or -1 if no vlc matches
562 */
564 int bits, int max_depth)
565 {
566 int code;
567
570
572
574
575 return code;
576 }
577
579 {
582 if (n == 0)
583 return 0;
584 else
586 }
587
589 {
591 return 0;
592 else
594 }
595
597 {
599 }
600
602 {
605
610 }
611
612 return 0;
613 }
614
615 #endif /* AVCODEC_GET_BITS_H */
static int get_xbits_le(GetBitContext *s, int n)
static unsigned int show_bits_long(GetBitContext *s, int n)
Show 0-32 bits.
static unsigned int show_bits1(GetBitContext *s)
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
static unsigned int get_bits(GetBitContext *s, int n)
Read 1-25 bits.
static void skip_bits_long(GetBitContext *s, int n)
Skips the specified number of bits.
static int check_marker(void *logctx, GetBitContext *s, const char *msg)
static av_const unsigned zero_extend(unsigned val, unsigned bits)
static int get_sbits(GetBitContext *s, int n)
static int get_sbits_long(GetBitContext *s, int n)
Read 0-32 bits as a signed integer.
#define av_assert2(cond)
assert() equivalent, that does lie in speed critical code.
static int get_bits_count(const GetBitContext *s)
#define SHOW_UBITS_LE(name, gb, num)
static int get_bits_left(GetBitContext *gb)
static uint64_t get_bits64(GetBitContext *s, int n)
Read 0-64 bits.
#define UPDATE_CACHE(name, gb)
static const struct endianess table[]
simple assert() macros that are a bit more flexible than ISO C assert().
#define CLOSE_READER(name, gb)
static unsigned int show_bits(GetBitContext *s, int n)
Show 1-25 bits.
#define LAST_SKIP_BITS(name, gb, num)
static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE(*table)[2], int bits, int max_depth)
Parse a vlc code.
#define GET_VLC(code, name, gb, table, bits, max_depth)
If the vlc code is invalid and max_depth=1, then no bits will be removed.
#define SHOW_UBITS(name, gb, num)
static int decode210(GetBitContext *gb)
#define AV_LOG_INFO
Standard information.
Libavcodec external API header.
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
static int get_xbits(GetBitContext *s, int n)
Read MPEG-1 dc-style VLC (sign bit + mantissa with no MSB).
#define OPEN_READER(name, gb)
static unsigned int get_bits1(GetBitContext *s)
static void skip_bits1(GetBitContext *s)
static void skip_bits(GetBitContext *s, int n)
#define UPDATE_CACHE_LE(name, gb)
static int init_get_bits(GetBitContext *s, const uint8_t *buffer, int bit_size)
Initialize GetBitContext.
#define GET_CACHE(name, gb)
static unsigned int get_bits_long(GetBitContext *s, int n)
Read 0-32 bits.
static av_const int sign_extend(int val, unsigned bits)
static unsigned int get_bits_le(GetBitContext *s, int n)
#define SHOW_SBITS(name, gb, num)
#define OPEN_READER_NOSIZE(name, gb)
common internal and external API header
const uint8_t * buffer_end
#define AV_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
static int decode012(GetBitContext *gb)
static const uint8_t * align_get_bits(GetBitContext *s)
static int skip_1stop_8data_bits(GetBitContext *gb)
static av_always_inline int get_bitsz(GetBitContext *s, int n)
Read 0-25 bits.