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