get_bits: remove strange/obsolete comments
[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 #include "libavutil/common.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/log.h"
33 #include "mathops.h"
34
35 /*
36  * Safe bitstream reading:
37  * optionally, the get_bits API can check to ensure that we
38  * don't read past input buffer boundaries. This is protected
39  * with CONFIG_SAFE_BITSTREAM_READER at the global level, and
40  * then below that with UNCHECKED_BITSTREAM_READER at the per-
41  * decoder level. This means that decoders that check internally
42  * can "#define UNCHECKED_BITSTREAM_READER 1" to disable
43  * overread checks.
44  * Boundary checking causes a minor performance penalty so for
45  * applications that won't want/need this, it can be disabled
46  * globally using "#define CONFIG_SAFE_BITSTREAM_READER 0".
47  */
48 #ifndef UNCHECKED_BITSTREAM_READER
49 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
50 #endif
51
52 typedef struct GetBitContext {
53     const uint8_t *buffer, *buffer_end;
54     int index;
55     int size_in_bits;
56 #if !UNCHECKED_BITSTREAM_READER
57     int size_in_bits_plus8;
58 #endif
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 } VLC;
68
69 typedef struct RL_VLC_ELEM {
70     int16_t level;
71     int8_t len;
72     uint8_t run;
73 } RL_VLC_ELEM;
74
75 /* Bitstream reader API docs:
76 name
77     arbitrary name which is used as prefix for the internal variables
78
79 gb
80     getbitcontext
81
82 OPEN_READER(name, gb)
83     load gb into local variables
84
85 CLOSE_READER(name, gb)
86     store local vars in gb
87
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,
91
92 GET_CACHE(name, gb)
93     will output the contents of the internal cache, next bit is MSB of 32 or 64 bit (FIXME 64bit)
94
95 SHOW_UBITS(name, gb, num)
96     will return the next num bits
97
98 SHOW_SBITS(name, gb, num)
99     will return the next num bits and do sign extension
100
101 SKIP_BITS(name, gb, num)
102     will skip over the next num bits
103     note, this is equivalent to SKIP_CACHE; SKIP_COUNTER
104
105 SKIP_CACHE(name, gb, num)
106     will remove the next num bits from the cache (note SKIP_COUNTER MUST be called before UPDATE_CACHE / CLOSE_READER)
107
108 SKIP_COUNTER(name, gb, num)
109     will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS)
110
111 LAST_SKIP_CACHE(name, gb, num)
112     will remove the next num bits from the cache if it is needed for UPDATE_CACHE otherwise it will do nothing
113
114 LAST_SKIP_BITS(name, gb, num)
115     is equivalent to LAST_SKIP_CACHE; SKIP_COUNTER
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(name, gb)                   \
127     unsigned int name##_index = (gb)->index;    \
128     unsigned int av_unused name##_cache = 0
129
130 #define CLOSE_READER(name, gb) (gb)->index = name##_index
131
132 #ifdef ALT_BITSTREAM_READER_LE
133
134 # ifdef LONG_BITSTREAM_READER
135 #   define UPDATE_CACHE(name, gb) name##_cache = \
136         AV_RL64((gb)->buffer + (name##_index >> 3)) >> (name##_index & 7)
137 # else
138 #   define UPDATE_CACHE(name, gb) name##_cache = \
139         AV_RL32((gb)->buffer + (name##_index >> 3)) >> (name##_index & 7)
140 # endif
141
142 # define SKIP_CACHE(name, gb, num) name##_cache >>= (num)
143
144 #else
145
146 # ifdef LONG_BITSTREAM_READER
147 #   define UPDATE_CACHE(name, gb) name##_cache = \
148         AV_RB64((gb)->buffer + (name##_index >> 3)) >> (32 - (name##_index & 7))
149 # else
150 #   define UPDATE_CACHE(name, gb) name##_cache = \
151         AV_RB32((gb)->buffer + (name##_index >> 3)) << (name##_index & 7)
152 # endif
153
154 # define SKIP_CACHE(name, gb, num) name##_cache <<= (num)
155
156 #endif
157
158 #if UNCHECKED_BITSTREAM_READER
159 #   define SKIP_COUNTER(name, gb, num) name##_index += (num)
160 #else
161 #   define SKIP_COUNTER(name, gb, num) \
162     name##_index = FFMIN((gb)->size_in_bits_plus8, name##_index + (num))
163 #endif
164
165 #define SKIP_BITS(name, gb, num) do {           \
166         SKIP_CACHE(name, gb, num);              \
167         SKIP_COUNTER(name, gb, num);            \
168     } while (0)
169
170 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
171 #define LAST_SKIP_CACHE(name, gb, num)
172
173 #ifdef ALT_BITSTREAM_READER_LE
174 #   define SHOW_UBITS(name, gb, num) zero_extend(name##_cache, num)
175 #   define SHOW_SBITS(name, gb, num) sign_extend(name##_cache, num)
176 #else
177 #   define SHOW_UBITS(name, gb, num) NEG_USR32(name##_cache, num)
178 #   define SHOW_SBITS(name, gb, num) NEG_SSR32(name##_cache, num)
179 #endif
180
181 #define GET_CACHE(name, gb) ((uint32_t)name##_cache)
182
183 static inline int get_bits_count(const GetBitContext *s)
184 {
185     return s->index;
186 }
187
188 static inline void skip_bits_long(GetBitContext *s, int n){
189 #if UNCHECKED_BITSTREAM_READER
190     s->index += n;
191 #else
192     s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
193 #endif
194 }
195
196 /**
197  * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
198  * if MSB not set it is negative
199  * @param n length in bits
200  */
201 static inline int get_xbits(GetBitContext *s, int n)
202 {
203     register int sign;
204     register int32_t cache;
205     OPEN_READER(re, s);
206     UPDATE_CACHE(re, s);
207     cache = GET_CACHE(re, s);
208     sign = ~cache >> 31;
209     LAST_SKIP_BITS(re, s, n);
210     CLOSE_READER(re, s);
211     return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
212 }
213
214 static inline int get_sbits(GetBitContext *s, int n)
215 {
216     register int tmp;
217     OPEN_READER(re, s);
218     UPDATE_CACHE(re, s);
219     tmp = SHOW_SBITS(re, s, n);
220     LAST_SKIP_BITS(re, s, n);
221     CLOSE_READER(re, s);
222     return tmp;
223 }
224
225 /**
226  * Read 1-25 bits.
227  */
228 static inline unsigned int get_bits(GetBitContext *s, int n)
229 {
230     register int tmp;
231     OPEN_READER(re, s);
232     UPDATE_CACHE(re, s);
233     tmp = SHOW_UBITS(re, s, n);
234     LAST_SKIP_BITS(re, s, n);
235     CLOSE_READER(re, s);
236     return tmp;
237 }
238
239 /**
240  * Show 1-25 bits.
241  */
242 static inline unsigned int show_bits(GetBitContext *s, int n)
243 {
244     register int tmp;
245     OPEN_READER(re, s);
246     UPDATE_CACHE(re, s);
247     tmp = SHOW_UBITS(re, s, n);
248     return tmp;
249 }
250
251 static inline void skip_bits(GetBitContext *s, int n)
252 {
253     OPEN_READER(re, s);
254     UPDATE_CACHE(re, s);
255     LAST_SKIP_BITS(re, s, n);
256     CLOSE_READER(re, s);
257 }
258
259 static inline unsigned int get_bits1(GetBitContext *s)
260 {
261     unsigned int index = s->index;
262     uint8_t result = s->buffer[index>>3];
263 #ifdef ALT_BITSTREAM_READER_LE
264     result >>= index & 7;
265     result &= 1;
266 #else
267     result <<= index & 7;
268     result >>= 8 - 1;
269 #endif
270 #if !UNCHECKED_BITSTREAM_READER
271     if (s->index < s->size_in_bits_plus8)
272 #endif
273         index++;
274     s->index = index;
275
276     return result;
277 }
278
279 static inline unsigned int show_bits1(GetBitContext *s)
280 {
281     return show_bits(s, 1);
282 }
283
284 static inline void skip_bits1(GetBitContext *s)
285 {
286     skip_bits(s, 1);
287 }
288
289 /**
290  * Read 0-32 bits.
291  */
292 static inline unsigned int get_bits_long(GetBitContext *s, int n)
293 {
294     if (n <= MIN_CACHE_BITS)
295         return get_bits(s, n);
296     else {
297 #ifdef ALT_BITSTREAM_READER_LE
298         int ret = get_bits(s, 16);
299         return ret | (get_bits(s, n-16) << 16);
300 #else
301         int ret = get_bits(s, 16) << (n-16);
302         return ret | get_bits(s, n-16);
303 #endif
304     }
305 }
306
307 /**
308  * Read 0-32 bits as a signed integer.
309  */
310 static inline int get_sbits_long(GetBitContext *s, int n)
311 {
312     return sign_extend(get_bits_long(s, n), n);
313 }
314
315 /**
316  * Show 0-32 bits.
317  */
318 static inline unsigned int show_bits_long(GetBitContext *s, int n)
319 {
320     if (n <= MIN_CACHE_BITS)
321         return show_bits(s, n);
322     else {
323         GetBitContext gb = *s;
324         return get_bits_long(&gb, n);
325     }
326 }
327
328 static inline int check_marker(GetBitContext *s, const char *msg)
329 {
330     int bit = get_bits1(s);
331     if (!bit)
332         av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);
333
334     return bit;
335 }
336
337 /**
338  * Inititalize GetBitContext.
339  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger than the actual read bits
340  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
341  * @param bit_size the size of the buffer in bits
342  */
343 static inline void init_get_bits(GetBitContext *s, const uint8_t *buffer,
344                                  int bit_size)
345 {
346     int buffer_size = (bit_size+7)>>3;
347     if (buffer_size < 0 || bit_size < 0) {
348         buffer_size = bit_size = 0;
349         buffer = NULL;
350     }
351
352     s->buffer       = buffer;
353     s->size_in_bits = bit_size;
354 #if !UNCHECKED_BITSTREAM_READER
355     s->size_in_bits_plus8 = bit_size + 8;
356 #endif
357     s->buffer_end   = buffer + buffer_size;
358     s->index        = 0;
359 }
360
361 static inline void align_get_bits(GetBitContext *s)
362 {
363     int n = -get_bits_count(s) & 7;
364     if (n) skip_bits(s, n);
365 }
366
367 #define init_vlc(vlc, nb_bits, nb_codes,                \
368                  bits, bits_wrap, bits_size,            \
369                  codes, codes_wrap, codes_size,         \
370                  flags)                                 \
371         init_vlc_sparse(vlc, nb_bits, nb_codes,         \
372                         bits, bits_wrap, bits_size,     \
373                         codes, codes_wrap, codes_size,  \
374                         NULL, 0, 0, flags)
375
376 int init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
377              const void *bits, int bits_wrap, int bits_size,
378              const void *codes, int codes_wrap, int codes_size,
379              const void *symbols, int symbols_wrap, int symbols_size,
380              int flags);
381 #define INIT_VLC_LE         2
382 #define INIT_VLC_USE_NEW_STATIC 4
383 void free_vlc(VLC *vlc);
384
385 #define INIT_VLC_STATIC(vlc, bits, a,b,c,d,e,f,g, static_size) do {     \
386         static VLC_TYPE table[static_size][2];                          \
387         (vlc)->table = table;                                           \
388         (vlc)->table_allocated = static_size;                           \
389         init_vlc(vlc, bits, a,b,c,d,e,f,g, INIT_VLC_USE_NEW_STATIC);    \
390     } while (0)
391
392
393 /**
394  * If the vlc code is invalid and max_depth=1, then no bits will be removed.
395  * If the vlc code is invalid and max_depth>1, then the number of bits removed
396  * is undefined.
397  */
398 #define GET_VLC(code, name, gb, table, bits, max_depth)         \
399     do {                                                        \
400         int n, nb_bits;                                         \
401         unsigned int index;                                     \
402                                                                 \
403         index = SHOW_UBITS(name, gb, bits);                     \
404         code  = table[index][0];                                \
405         n     = table[index][1];                                \
406                                                                 \
407         if (max_depth > 1 && n < 0) {                           \
408             LAST_SKIP_BITS(name, gb, bits);                     \
409             UPDATE_CACHE(name, gb);                             \
410                                                                 \
411             nb_bits = -n;                                       \
412                                                                 \
413             index = SHOW_UBITS(name, gb, nb_bits) + code;       \
414             code  = table[index][0];                            \
415             n     = table[index][1];                            \
416             if (max_depth > 2 && n < 0) {                       \
417                 LAST_SKIP_BITS(name, gb, nb_bits);              \
418                 UPDATE_CACHE(name, gb);                         \
419                                                                 \
420                 nb_bits = -n;                                   \
421                                                                 \
422                 index = SHOW_UBITS(name, gb, nb_bits) + code;   \
423                 code  = table[index][0];                        \
424                 n     = table[index][1];                        \
425             }                                                   \
426         }                                                       \
427         SKIP_BITS(name, gb, n);                                 \
428     } while (0)
429
430 #define GET_RL_VLC(level, run, name, gb, table, bits, max_depth, need_update) \
431     do {                                                                \
432         int n, nb_bits;                                                 \
433         unsigned int index;                                             \
434                                                                         \
435         index = SHOW_UBITS(name, gb, bits);                             \
436         level = table[index].level;                                     \
437         n     = table[index].len;                                       \
438                                                                         \
439         if (max_depth > 1 && n < 0) {                                   \
440             SKIP_BITS(name, gb, bits);                                  \
441             if (need_update) {                                          \
442                 UPDATE_CACHE(name, gb);                                 \
443             }                                                           \
444                                                                         \
445             nb_bits = -n;                                               \
446                                                                         \
447             index = SHOW_UBITS(name, gb, nb_bits) + level;              \
448             level = table[index].level;                                 \
449             n     = table[index].len;                                   \
450         }                                                               \
451         run = table[index].run;                                         \
452         SKIP_BITS(name, gb, n);                                         \
453     } while (0)
454
455
456 /**
457  * Parse a vlc code.
458  * @param bits is the number of bits which will be read at once, must be
459  *             identical to nb_bits in init_vlc()
460  * @param max_depth is the number of times bits bits must be read to completely
461  *                  read the longest vlc code
462  *                  = (max_vlc_length + bits - 1) / bits
463  */
464 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
465                                      int bits, int max_depth)
466 {
467     int code;
468
469     OPEN_READER(re, s);
470     UPDATE_CACHE(re, s);
471
472     GET_VLC(code, re, s, table, bits, max_depth);
473
474     CLOSE_READER(re, s);
475     return code;
476 }
477
478 static inline int decode012(GetBitContext *gb)
479 {
480     int n;
481     n = get_bits1(gb);
482     if (n == 0)
483         return 0;
484     else
485         return get_bits1(gb) + 1;
486 }
487
488 static inline int decode210(GetBitContext *gb)
489 {
490     if (get_bits1(gb))
491         return 0;
492     else
493         return 2 - get_bits1(gb);
494 }
495
496 static inline int get_bits_left(GetBitContext *gb)
497 {
498     return gb->size_in_bits - get_bits_count(gb);
499 }
500
501 //#define TRACE
502
503 #ifdef TRACE
504 static inline void print_bin(int bits, int n)
505 {
506     int i;
507
508     for (i = n-1; i >= 0; i--) {
509         av_log(NULL, AV_LOG_DEBUG, "%d", (bits>>i)&1);
510     }
511     for (i = n; i < 24; i++)
512         av_log(NULL, AV_LOG_DEBUG, " ");
513 }
514
515 static inline int get_bits_trace(GetBitContext *s, int n, char *file,
516                                  const char *func, int line)
517 {
518     int r = get_bits(s, n);
519
520     print_bin(r, n);
521     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
522            r, n, r, get_bits_count(s)-n, file, func, line);
523     return r;
524 }
525 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
526                                 int bits, int max_depth, char *file,
527                                 const char *func, int line)
528 {
529     int show  = show_bits(s, 24);
530     int pos   = get_bits_count(s);
531     int r     = get_vlc2(s, table, bits, max_depth);
532     int len   = get_bits_count(s) - pos;
533     int bits2 = show >> (24-len);
534
535     print_bin(bits2, len);
536
537     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
538            bits2, len, r, pos, file, func, line);
539     return r;
540 }
541 static inline int get_xbits_trace(GetBitContext *s, int n, char *file,
542                                   const char *func, int line)
543 {
544     int show = show_bits(s, n);
545     int r    = get_xbits(s, n);
546
547     print_bin(show, n);
548     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
549            show, n, r, get_bits_count(s)-n, file, func, line);
550     return r;
551 }
552
553 #define get_bits(s, n)  get_bits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
554 #define get_bits1(s)    get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
555 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
556 #define get_vlc(s, vlc)            get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
557 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
558
559 #define tprintf(p, ...) av_log(p, AV_LOG_DEBUG, __VA_ARGS__)
560
561 #else //TRACE
562 #define tprintf(p, ...) {}
563 #endif
564
565 #endif /* AVCODEC_GET_BITS_H */