]> git.sesse.net Git - ffmpeg/blob - libavcodec/get_bits.h
Merge commit '97d35fa89f73468d64f663bfc0686aa6cddd8b6a'
[ffmpeg] / libavcodec / get_bits.h
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
31 #include "libavutil/common.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/log.h"
34 #include "libavutil/avassert.h"
35 #include "mathops.h"
36
37 /*
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
45  * overread checks.
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".
49  */
50 #ifndef UNCHECKED_BITSTREAM_READER
51 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
52 #endif
53
54 typedef struct GetBitContext {
55     const uint8_t *buffer, *buffer_end;
56     int index;
57     int size_in_bits;
58     int size_in_bits_plus8;
59 } GetBitContext;
60
61 #define VLC_TYPE int16_t
62
63 typedef struct VLC {
64     int bits;
65     VLC_TYPE (*table)[2]; ///< code, bits
66     int table_size, table_allocated;
67     void * volatile init_state;
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 bit (FIXME 64bit).
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 #if UNCHECKED_BITSTREAM_READER
127 #define OPEN_READER(name, gb)                   \
128     unsigned int name ## _index = (gb)->index;  \
129     unsigned int av_unused name ## _cache
130
131 #define HAVE_BITS_REMAINING(name, gb) 1
132 #else
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
137
138 #define HAVE_BITS_REMAINING(name, gb) name ## _index < name ## _size_plus8
139 #endif
140
141 #define CLOSE_READER(name, gb) (gb)->index = name ## _index
142
143 # ifdef LONG_BITSTREAM_READER
144
145 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
146       AV_RL64((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
147
148 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
149       AV_RB64((gb)->buffer + (name ## _index >> 3)) >> (32 - (name ## _index & 7))
150
151 #else
152
153 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
154       AV_RL32((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
155
156 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
157       AV_RB32((gb)->buffer + (name ## _index >> 3)) << (name ## _index & 7)
158
159 #endif
160
161
162 #ifdef BITSTREAM_READER_LE
163
164 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_LE(name, gb)
165
166 # define SKIP_CACHE(name, gb, num) name ## _cache >>= (num)
167
168 #else
169
170 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_BE(name, gb)
171
172 # define SKIP_CACHE(name, gb, num) name ## _cache <<= (num)
173
174 #endif
175
176 #if UNCHECKED_BITSTREAM_READER
177 #   define SKIP_COUNTER(name, gb, num) name ## _index += (num)
178 #else
179 #   define SKIP_COUNTER(name, gb, num) \
180     name ## _index = FFMIN(name ## _size_plus8, name ## _index + (num))
181 #endif
182
183 #define SKIP_BITS(name, gb, num)                \
184     do {                                        \
185         SKIP_CACHE(name, gb, num);              \
186         SKIP_COUNTER(name, gb, num);            \
187     } while (0)
188
189 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
190
191 #define SHOW_UBITS_LE(name, gb, num) zero_extend(name ## _cache, num)
192 #define SHOW_SBITS_LE(name, gb, num) sign_extend(name ## _cache, num)
193
194 #define SHOW_UBITS_BE(name, gb, num) NEG_USR32(name ## _cache, num)
195 #define SHOW_SBITS_BE(name, gb, num) NEG_SSR32(name ## _cache, num)
196
197 #ifdef BITSTREAM_READER_LE
198 #   define SHOW_UBITS(name, gb, num) SHOW_UBITS_LE(name, gb, num)
199 #   define SHOW_SBITS(name, gb, num) SHOW_SBITS_LE(name, gb, num)
200 #else
201 #   define SHOW_UBITS(name, gb, num) SHOW_UBITS_BE(name, gb, num)
202 #   define SHOW_SBITS(name, gb, num) SHOW_SBITS_BE(name, gb, num)
203 #endif
204
205 #define GET_CACHE(name, gb) ((uint32_t) name ## _cache)
206
207 static inline int get_bits_count(const GetBitContext *s)
208 {
209     return s->index;
210 }
211
212 static inline void skip_bits_long(GetBitContext *s, int n)
213 {
214 #if UNCHECKED_BITSTREAM_READER
215     s->index += n;
216 #else
217     s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
218 #endif
219 }
220
221 /**
222  * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
223  * if MSB not set it is negative
224  * @param n length in bits
225  */
226 static inline int get_xbits(GetBitContext *s, int n)
227 {
228     register int sign;
229     register int32_t cache;
230     OPEN_READER(re, s);
231     av_assert2(n>0 && n<=25);
232     UPDATE_CACHE(re, s);
233     cache = GET_CACHE(re, s);
234     sign  = ~cache >> 31;
235     LAST_SKIP_BITS(re, s, n);
236     CLOSE_READER(re, s);
237     return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
238 }
239
240 static inline int get_sbits(GetBitContext *s, int n)
241 {
242     register int tmp;
243     OPEN_READER(re, s);
244     av_assert2(n>0 && n<=25);
245     UPDATE_CACHE(re, s);
246     tmp = SHOW_SBITS(re, s, n);
247     LAST_SKIP_BITS(re, s, n);
248     CLOSE_READER(re, s);
249     return tmp;
250 }
251
252 /**
253  * Read 1-25 bits.
254  */
255 static inline unsigned int get_bits(GetBitContext *s, int n)
256 {
257     register int tmp;
258     OPEN_READER(re, s);
259     av_assert2(n>0 && n<=25);
260     UPDATE_CACHE(re, s);
261     tmp = SHOW_UBITS(re, s, n);
262     LAST_SKIP_BITS(re, s, n);
263     CLOSE_READER(re, s);
264     return tmp;
265 }
266
267 static inline unsigned int get_bits_le(GetBitContext *s, int n)
268 {
269     register int tmp;
270     OPEN_READER(re, s);
271     av_assert2(n>0 && n<=25);
272     UPDATE_CACHE_LE(re, s);
273     tmp = SHOW_UBITS_LE(re, s, n);
274     LAST_SKIP_BITS(re, s, n);
275     CLOSE_READER(re, s);
276     return tmp;
277 }
278
279 /**
280  * Show 1-25 bits.
281  */
282 static inline unsigned int show_bits(GetBitContext *s, int n)
283 {
284     register int tmp;
285     OPEN_READER(re, s);
286     av_assert2(n>0 && n<=25);
287     UPDATE_CACHE(re, s);
288     tmp = SHOW_UBITS(re, s, n);
289     return tmp;
290 }
291
292 static inline void skip_bits(GetBitContext *s, int n)
293 {
294     OPEN_READER(re, s);
295     UPDATE_CACHE(re, s);
296     LAST_SKIP_BITS(re, s, n);
297     CLOSE_READER(re, s);
298 }
299
300 static inline unsigned int get_bits1(GetBitContext *s)
301 {
302     unsigned int index = s->index;
303     uint8_t result     = s->buffer[index >> 3];
304 #ifdef BITSTREAM_READER_LE
305     result >>= index & 7;
306     result  &= 1;
307 #else
308     result <<= index & 7;
309     result >>= 8 - 1;
310 #endif
311 #if !UNCHECKED_BITSTREAM_READER
312     if (s->index < s->size_in_bits_plus8)
313 #endif
314         index++;
315     s->index = index;
316
317     return result;
318 }
319
320 static inline unsigned int show_bits1(GetBitContext *s)
321 {
322     return show_bits(s, 1);
323 }
324
325 static inline void skip_bits1(GetBitContext *s)
326 {
327     skip_bits(s, 1);
328 }
329
330 /**
331  * Read 0-32 bits.
332  */
333 static inline unsigned int get_bits_long(GetBitContext *s, int n)
334 {
335     if (!n) {
336         return 0;
337     } else if (n <= MIN_CACHE_BITS) {
338         return get_bits(s, n);
339     } else {
340 #ifdef BITSTREAM_READER_LE
341         unsigned ret = get_bits(s, 16);
342         return ret | (get_bits(s, n - 16) << 16);
343 #else
344         unsigned ret = get_bits(s, 16) << (n - 16);
345         return ret | get_bits(s, n - 16);
346 #endif
347     }
348 }
349
350 /**
351  * Read 0-64 bits.
352  */
353 static inline uint64_t get_bits64(GetBitContext *s, int n)
354 {
355     if (n <= 32) {
356         return get_bits_long(s, n);
357     } else {
358 #ifdef BITSTREAM_READER_LE
359         uint64_t ret = get_bits_long(s, 32);
360         return ret | (uint64_t) get_bits_long(s, n - 32) << 32;
361 #else
362         uint64_t ret = (uint64_t) get_bits_long(s, n - 32) << 32;
363         return ret | get_bits_long(s, 32);
364 #endif
365     }
366 }
367
368 /**
369  * Read 0-32 bits as a signed integer.
370  */
371 static inline int get_sbits_long(GetBitContext *s, int n)
372 {
373     return sign_extend(get_bits_long(s, n), n);
374 }
375
376 /**
377  * Show 0-32 bits.
378  */
379 static inline unsigned int show_bits_long(GetBitContext *s, int n)
380 {
381     if (n <= MIN_CACHE_BITS) {
382         return show_bits(s, n);
383     } else {
384         GetBitContext gb = *s;
385         return get_bits_long(&gb, n);
386     }
387 }
388
389 static inline int check_marker(GetBitContext *s, const char *msg)
390 {
391     int bit = get_bits1(s);
392     if (!bit)
393         av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);
394
395     return bit;
396 }
397
398 /**
399  * Initialize GetBitContext.
400  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes
401  *        larger than the actual read bits because some optimized bitstream
402  *        readers read 32 or 64 bit at once and could read over the end
403  * @param bit_size the size of the buffer in bits
404  * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
405  */
406 static inline int init_get_bits(GetBitContext *s, const uint8_t *buffer,
407                                 int bit_size)
408 {
409     int buffer_size;
410     int ret = 0;
411
412     if (bit_size >= INT_MAX - 7 || bit_size < 0 || !buffer) {
413         buffer_size = bit_size = 0;
414         buffer      = NULL;
415         ret         = AVERROR_INVALIDDATA;
416     }
417
418     buffer_size = (bit_size + 7) >> 3;
419
420     s->buffer             = buffer;
421     s->size_in_bits       = bit_size;
422     s->size_in_bits_plus8 = bit_size + 8;
423     s->buffer_end         = buffer + buffer_size;
424     s->index              = 0;
425
426     return ret;
427 }
428
429 /**
430  * Initialize GetBitContext.
431  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes
432  *        larger than the actual read bits because some optimized bitstream
433  *        readers read 32 or 64 bit at once and could read over the end
434  * @param byte_size the size of the buffer in bytes
435  * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
436  */
437 static inline int init_get_bits8(GetBitContext *s, const uint8_t *buffer,
438                                  int byte_size)
439 {
440     if (byte_size > INT_MAX / 8 || byte_size < 0)
441         byte_size = -1;
442     return init_get_bits(s, buffer, byte_size * 8);
443 }
444
445 static inline const uint8_t *align_get_bits(GetBitContext *s)
446 {
447     int n = -get_bits_count(s) & 7;
448     if (n)
449         skip_bits(s, n);
450     return s->buffer + (s->index >> 3);
451 }
452
453 #define init_vlc(vlc, nb_bits, nb_codes,                \
454                  bits, bits_wrap, bits_size,            \
455                  codes, codes_wrap, codes_size,         \
456                  flags)                                 \
457     ff_init_vlc_sparse(vlc, nb_bits, nb_codes,          \
458                        bits, bits_wrap, bits_size,      \
459                        codes, codes_wrap, codes_size,   \
460                        NULL, 0, 0, flags)
461
462 int ff_init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
463                        const void *bits, int bits_wrap, int bits_size,
464                        const void *codes, int codes_wrap, int codes_size,
465                        const void *symbols, int symbols_wrap, int symbols_size,
466                        int flags);
467 void ff_free_vlc(VLC *vlc);
468
469 #define INIT_VLC_LE             2
470 #define INIT_VLC_USE_NEW_STATIC 4
471
472 #define INIT_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, static_size)       \
473     do {                                                                   \
474         static VLC_TYPE table[static_size][2];                             \
475         (vlc)->table           = table;                                    \
476         (vlc)->table_allocated = static_size;                              \
477         init_vlc(vlc, bits, a, b, c, d, e, f, g, INIT_VLC_USE_NEW_STATIC); \
478     } while (0)
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         }                                                       \
539         run = table[index].run;                                 \
540         SKIP_BITS(name, gb, n);                                 \
541     } while (0)
542
543 /**
544  * Parse a vlc code.
545  * @param bits is the number of bits which will be read at once, must be
546  *             identical to nb_bits in init_vlc()
547  * @param max_depth is the number of times bits bits must be read to completely
548  *                  read the longest vlc code
549  *                  = (max_vlc_length + bits - 1) / bits
550  */
551 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
552                                      int bits, int max_depth)
553 {
554     int code;
555
556     OPEN_READER(re, s);
557     UPDATE_CACHE(re, s);
558
559     GET_VLC(code, re, s, table, bits, max_depth);
560
561     CLOSE_READER(re, s);
562
563     return code;
564 }
565
566 static inline int decode012(GetBitContext *gb)
567 {
568     int n;
569     n = get_bits1(gb);
570     if (n == 0)
571         return 0;
572     else
573         return get_bits1(gb) + 1;
574 }
575
576 static inline int decode210(GetBitContext *gb)
577 {
578     if (get_bits1(gb))
579         return 0;
580     else
581         return 2 - get_bits1(gb);
582 }
583
584 static inline int get_bits_left(GetBitContext *gb)
585 {
586     return gb->size_in_bits - get_bits_count(gb);
587 }
588
589 //#define TRACE
590
591 #ifdef TRACE
592 static inline void print_bin(int bits, int n)
593 {
594     int i;
595
596     for (i = n - 1; i >= 0; i--)
597         av_log(NULL, AV_LOG_DEBUG, "%d", (bits >> i) & 1);
598     for (i = n; i < 24; i++)
599         av_log(NULL, AV_LOG_DEBUG, " ");
600 }
601
602 static inline int get_bits_trace(GetBitContext *s, int n, const char *file,
603                                  const char *func, int line)
604 {
605     int r = get_bits(s, n);
606
607     print_bin(r, n);
608     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
609            r, n, r, get_bits_count(s) - n, file, func, line);
610
611     return r;
612 }
613
614 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
615                                 int bits, int max_depth, const char *file,
616                                 const char *func, int line)
617 {
618     int show  = show_bits(s, 24);
619     int pos   = get_bits_count(s);
620     int r     = get_vlc2(s, table, bits, max_depth);
621     int len   = get_bits_count(s) - pos;
622     int bits2 = show >> (24 - len);
623
624     print_bin(bits2, len);
625
626     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
627            bits2, len, r, pos, file, func, line);
628
629     return r;
630 }
631
632 static inline int get_xbits_trace(GetBitContext *s, int n, const char *file,
633                                   const char *func, int line)
634 {
635     int show = show_bits(s, n);
636     int r    = get_xbits(s, n);
637
638     print_bin(show, n);
639     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
640            show, n, r, get_bits_count(s) - n, file, func, line);
641
642     return r;
643 }
644
645 #define get_bits(s, n)  get_bits_trace(s , n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
646 #define get_bits1(s)    get_bits_trace(s,  1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
647 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
648
649 #define get_vlc(s, vlc)             get_vlc_trace(s, (vlc)->table, (vlc)->bits,   3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
650 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s,          tab,        bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
651
652 #define tprintf(p, ...) av_log(p, AV_LOG_DEBUG, __VA_ARGS__)
653
654 #else //TRACE
655 #define tprintf(p, ...) { }
656 #endif
657
658 #endif /* AVCODEC_GET_BITS_H */