git.sesse.net Git - ffmpeg/blob - 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 #include "vlc.h"
  37
  38 /*
  39  * Safe bitstream reading:
  40  * optionally, the get_bits API can check to ensure that we
  41  * don't read past input buffer boundaries. This is protected
  42  * with CONFIG_SAFE_BITSTREAM_READER at the global level, and
  43  * then below that with UNCHECKED_BITSTREAM_READER at the per-
  44  * decoder level. This means that decoders that check internally
  45  * can "#define UNCHECKED_BITSTREAM_READER 1" to disable
  46  * overread checks.
  47  * Boundary checking causes a minor performance penalty so for
  48  * applications that won't want/need this, it can be disabled
  49  * globally using "#define CONFIG_SAFE_BITSTREAM_READER 0".
  50  */
  51 #ifndef UNCHECKED_BITSTREAM_READER
  52 #define UNCHECKED_BITSTREAM_READER !CONFIG_SAFE_BITSTREAM_READER
  53 #endif
  54
  55 typedef struct GetBitContext {
  56     const uint8_t *buffer, *buffer_end;
  57     int index;
  58     int size_in_bits;
  59     int size_in_bits_plus8;
  60 } GetBitContext;
  61
  62 /* Bitstream reader API docs:
  63  * name
  64  *   arbitrary name which is used as prefix for the internal variables
  65  *
  66  * gb
  67  *   getbitcontext
  68  *
  69  * OPEN_READER(name, gb)
  70  *   load gb into local variables
  71  *
  72  * CLOSE_READER(name, gb)
  73  *   store local vars in gb
  74  *
  75  * UPDATE_CACHE(name, gb)
  76  *   Refill the internal cache from the bitstream.
  77  *   After this call at least MIN_CACHE_BITS will be available.
  78  *
  79  * GET_CACHE(name, gb)
  80  *   Will output the contents of the internal cache,
  81  *   next bit is MSB of 32 or 64 bits (FIXME 64 bits).
  82  *
  83  * SHOW_UBITS(name, gb, num)
  84  *   Will return the next num bits.
  85  *
  86  * SHOW_SBITS(name, gb, num)
  87  *   Will return the next num bits and do sign extension.
  88  *
  89  * SKIP_BITS(name, gb, num)
  90  *   Will skip over the next num bits.
  91  *   Note, this is equivalent to SKIP_CACHE; SKIP_COUNTER.
  92  *
  93  * SKIP_CACHE(name, gb, num)
  94  *   Will remove the next num bits from the cache (note SKIP_COUNTER
  95  *   MUST be called before UPDATE_CACHE / CLOSE_READER).
  96  *
  97  * SKIP_COUNTER(name, gb, num)
  98  *   Will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS).
  99  *
 100  * LAST_SKIP_BITS(name, gb, num)
 101  *   Like SKIP_BITS, to be used if next call is UPDATE_CACHE or CLOSE_READER.
 102  *
 103  * BITS_LEFT(name, gb)
 104  *   Return the number of bits left
 105  *
 106  * For examples see get_bits, show_bits, skip_bits, get_vlc.
 107  */
 108
 109 #ifdef LONG_BITSTREAM_READER
 110 #   define MIN_CACHE_BITS 32
 111 #else
 112 #   define MIN_CACHE_BITS 25
 113 #endif
 114
 115 #define OPEN_READER_NOSIZE(name, gb)            \
 116     unsigned int name ## _index = (gb)->index;  \
 117     unsigned int av_unused name ## _cache
 118
 119 #if UNCHECKED_BITSTREAM_READER
 120 #define OPEN_READER(name, gb) OPEN_READER_NOSIZE(name, gb)
 121
 122 #define BITS_AVAILABLE(name, gb) 1
 123 #else
 124 #define OPEN_READER(name, gb)                   \
 125     OPEN_READER_NOSIZE(name, gb);               \
 126     unsigned int name ## _size_plus8 = (gb)->size_in_bits_plus8
 127
 128 #define BITS_AVAILABLE(name, gb) name ## _index < name ## _size_plus8
 129 #endif
 130
 131 #define CLOSE_READER(name, gb) (gb)->index = name ## _index
 132
 133 # ifdef LONG_BITSTREAM_READER
 134
 135 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
 136       AV_RL64((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
 137
 138 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
 139       AV_RB64((gb)->buffer + (name ## _index >> 3)) >> (32 - (name ## _index & 7))
 140
 141 #else
 142
 143 # define UPDATE_CACHE_LE(name, gb) name ## _cache = \
 144       AV_RL32((gb)->buffer + (name ## _index >> 3)) >> (name ## _index & 7)
 145
 146 # define UPDATE_CACHE_BE(name, gb) name ## _cache = \
 147       AV_RB32((gb)->buffer + (name ## _index >> 3)) << (name ## _index & 7)
 148
 149 #endif
 150
 151
 152 #ifdef BITSTREAM_READER_LE
 153
 154 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_LE(name, gb)
 155
 156 # define SKIP_CACHE(name, gb, num) name ## _cache >>= (num)
 157
 158 #else
 159
 160 # define UPDATE_CACHE(name, gb) UPDATE_CACHE_BE(name, gb)
 161
 162 # define SKIP_CACHE(name, gb, num) name ## _cache <<= (num)
 163
 164 #endif
 165
 166 #if UNCHECKED_BITSTREAM_READER
 167 #   define SKIP_COUNTER(name, gb, num) name ## _index += (num)
 168 #else
 169 #   define SKIP_COUNTER(name, gb, num) \
 170     name ## _index = FFMIN(name ## _size_plus8, name ## _index + (num))
 171 #endif
 172
 173 #define BITS_LEFT(name, gb) ((int)((gb)->size_in_bits - name ## _index))
 174
 175 #define SKIP_BITS(name, gb, num)                \
 176     do {                                        \
 177         SKIP_CACHE(name, gb, num);              \
 178         SKIP_COUNTER(name, gb, num);            \
 179     } while (0)
 180
 181 #define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
 182
 183 #define SHOW_UBITS_LE(name, gb, num) zero_extend(name ## _cache, num)
 184 #define SHOW_SBITS_LE(name, gb, num) sign_extend(name ## _cache, num)
 185
 186 #define SHOW_UBITS_BE(name, gb, num) NEG_USR32(name ## _cache, num)
 187 #define SHOW_SBITS_BE(name, gb, num) NEG_SSR32(name ## _cache, num)
 188
 189 #ifdef BITSTREAM_READER_LE
 190 #   define SHOW_UBITS(name, gb, num) SHOW_UBITS_LE(name, gb, num)
 191 #   define SHOW_SBITS(name, gb, num) SHOW_SBITS_LE(name, gb, num)
 192 #else
 193 #   define SHOW_UBITS(name, gb, num) SHOW_UBITS_BE(name, gb, num)
 194 #   define SHOW_SBITS(name, gb, num) SHOW_SBITS_BE(name, gb, num)
 195 #endif
 196
 197 #define GET_CACHE(name, gb) ((uint32_t) name ## _cache)
 198
 199 static inline int get_bits_count(const GetBitContext *s)
 200 {
 201     return s->index;
 202 }
 203
 204 static inline void skip_bits_long(GetBitContext *s, int n)
 205 {
 206 #if UNCHECKED_BITSTREAM_READER
 207     s->index += n;
 208 #else
 209     s->index += av_clip(n, -s->index, s->size_in_bits_plus8 - s->index);
 210 #endif
 211 }
 212
 213 /**
 214  * Read MPEG-1 dc-style VLC (sign bit + mantissa with no MSB).
 215  * if MSB not set it is negative
 216  * @param n length in bits
 217  */
 218 static inline int get_xbits(GetBitContext *s, int n)
 219 {
 220     register int sign;
 221     register int32_t cache;
 222     OPEN_READER(re, s);
 223     av_assert2(n>0 && n<=25);
 224     UPDATE_CACHE(re, s);
 225     cache = GET_CACHE(re, s);
 226     sign  = ~cache >> 31;
 227     LAST_SKIP_BITS(re, s, n);
 228     CLOSE_READER(re, s);
 229     return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
 230 }
 231
 232 static inline int get_sbits(GetBitContext *s, int n)
 233 {
 234     register int tmp;
 235     OPEN_READER(re, s);
 236     av_assert2(n>0 && n<=25);
 237     UPDATE_CACHE(re, s);
 238     tmp = SHOW_SBITS(re, s, n);
 239     LAST_SKIP_BITS(re, s, n);
 240     CLOSE_READER(re, s);
 241     return tmp;
 242 }
 243
 244 /**
 245  * Read 1-25 bits.
 246  */
 247 static inline unsigned int get_bits(GetBitContext *s, int n)
 248 {
 249     register int tmp;
 250     OPEN_READER(re, s);
 251     av_assert2(n>0 && n<=25);
 252     UPDATE_CACHE(re, s);
 253     tmp = SHOW_UBITS(re, s, n);
 254     LAST_SKIP_BITS(re, s, n);
 255     CLOSE_READER(re, s);
 256     return tmp;
 257 }
 258
 259 /**
 260  * Read 0-25 bits.
 261  */
 262 static av_always_inline int get_bitsz(GetBitContext *s, int n)
 263 {
 264     return n ? get_bits(s, n) : 0;
 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_NOSIZE(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     LAST_SKIP_BITS(re, s, n);
 296     CLOSE_READER(re, s);
 297 }
 298
 299 static inline unsigned int get_bits1(GetBitContext *s)
 300 {
 301     unsigned int index = s->index;
 302     uint8_t result     = s->buffer[index >> 3];
 303 #ifdef BITSTREAM_READER_LE
 304     result >>= index & 7;
 305     result  &= 1;
 306 #else
 307     result <<= index & 7;
 308     result >>= 8 - 1;
 309 #endif
 310 #if !UNCHECKED_BITSTREAM_READER
 311     if (s->index < s->size_in_bits_plus8)
 312 #endif
 313         index++;
 314     s->index = index;
 315
 316     return result;
 317 }
 318
 319 static inline unsigned int show_bits1(GetBitContext *s)
 320 {
 321     return show_bits(s, 1);
 322 }
 323
 324 static inline void skip_bits1(GetBitContext *s)
 325 {
 326     skip_bits(s, 1);
 327 }
 328
 329 /**
 330  * Read 0-32 bits.
 331  */
 332 static inline unsigned int get_bits_long(GetBitContext *s, int n)
 333 {
 334     if (!n) {
 335         return 0;
 336     } else if (n <= MIN_CACHE_BITS) {
 337         return get_bits(s, n);
 338     } else {
 339 #ifdef BITSTREAM_READER_LE
 340         unsigned ret = get_bits(s, 16);
 341         return ret | (get_bits(s, n - 16) << 16);
 342 #else
 343         unsigned ret = get_bits(s, 16) << (n - 16);
 344         return ret | get_bits(s, n - 16);
 345 #endif
 346     }
 347 }
 348
 349 /**
 350  * Read 0-64 bits.
 351  */
 352 static inline uint64_t get_bits64(GetBitContext *s, int n)
 353 {
 354     if (n <= 32) {
 355         return get_bits_long(s, n);
 356     } else {
 357 #ifdef BITSTREAM_READER_LE
 358         uint64_t ret = get_bits_long(s, 32);
 359         return ret | (uint64_t) get_bits_long(s, n - 32) << 32;
 360 #else
 361         uint64_t ret = (uint64_t) get_bits_long(s, n - 32) << 32;
 362         return ret | get_bits_long(s, 32);
 363 #endif
 364     }
 365 }
 366
 367 /**
 368  * Read 0-32 bits as a signed integer.
 369  */
 370 static inline int get_sbits_long(GetBitContext *s, int n)
 371 {
 372     return sign_extend(get_bits_long(s, n), n);
 373 }
 374
 375 /**
 376  * Show 0-32 bits.
 377  */
 378 static inline unsigned int show_bits_long(GetBitContext *s, int n)
 379 {
 380     if (n <= MIN_CACHE_BITS) {
 381         return show_bits(s, n);
 382     } else {
 383         GetBitContext gb = *s;
 384         return get_bits_long(&gb, n);
 385     }
 386 }
 387
 388 static inline int check_marker(void *logctx, GetBitContext *s, const char *msg)
 389 {
 390     int bit = get_bits1(s);
 391     if (!bit)
 392         av_log(logctx, AV_LOG_INFO, "Marker bit missing at %d of %d %s\n",
 393                get_bits_count(s) - 1, s->size_in_bits, msg);
 394
 395     return bit;
 396 }
 397
 398 /**
 399  * Initialize GetBitContext.
 400  * @param buffer bitstream buffer, must be AV_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         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 AV_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 /**
 454  * If the vlc code is invalid and max_depth=1, then no bits will be removed.
 455  * If the vlc code is invalid and max_depth>1, then the number of bits removed
 456  * is undefined.
 457  */
 458 #define GET_VLC(code, name, gb, table, bits, max_depth)         \
 459     do {                                                        \
 460         int n, nb_bits;                                         \
 461         unsigned int index;                                     \
 462                                                                 \
 463         index = SHOW_UBITS(name, gb, bits);                     \
 464         code  = table[index][0];                                \
 465         n     = table[index][1];                                \
 466                                                                 \
 467         if (max_depth > 1 && n < 0) {                           \
 468             LAST_SKIP_BITS(name, gb, bits);                     \
 469             UPDATE_CACHE(name, gb);                             \
 470                                                                 \
 471             nb_bits = -n;                                       \
 472                                                                 \
 473             index = SHOW_UBITS(name, gb, nb_bits) + code;       \
 474             code  = table[index][0];                            \
 475             n     = table[index][1];                            \
 476             if (max_depth > 2 && n < 0) {                       \
 477                 LAST_SKIP_BITS(name, gb, nb_bits);              \
 478                 UPDATE_CACHE(name, gb);                         \
 479                                                                 \
 480                 nb_bits = -n;                                   \
 481                                                                 \
 482                 index = SHOW_UBITS(name, gb, nb_bits) + code;   \
 483                 code  = table[index][0];                        \
 484                 n     = table[index][1];                        \
 485             }                                                   \
 486         }                                                       \
 487         SKIP_BITS(name, gb, n);                                 \
 488     } while (0)
 489
 490 #define GET_RL_VLC_INTERNAL(level, run, name, gb, table, bits,  \
 491                    max_depth, need_update)                      \
 492     do {                                                        \
 493         int n, nb_bits;                                         \
 494         unsigned int index;                                     \
 495                                                                 \
 496         index = SHOW_UBITS(name, gb, bits);                     \
 497         level = table[index].level;                             \
 498         n     = table[index].len;                               \
 499                                                                 \
 500         if (max_depth > 1 && n < 0) {                           \
 501             SKIP_BITS(name, gb, bits);                          \
 502             if (need_update) {                                  \
 503                 UPDATE_CACHE(name, gb);                         \
 504             }                                                   \
 505                                                                 \
 506             nb_bits = -n;                                       \
 507                                                                 \
 508             index = SHOW_UBITS(name, gb, nb_bits) + level;      \
 509             level = table[index].level;                         \
 510             n     = table[index].len;                           \
 511             if (max_depth > 2 && n < 0) {                       \
 512                 LAST_SKIP_BITS(name, gb, nb_bits);              \
 513                 if (need_update) {                              \
 514                     UPDATE_CACHE(name, gb);                     \
 515                 }                                               \
 516                 nb_bits = -n;                                   \
 517                                                                 \
 518                 index = SHOW_UBITS(name, gb, nb_bits) + level;  \
 519                 level = table[index].level;                     \
 520                 n     = table[index].len;                       \
 521             }                                                   \
 522         }                                                       \
 523         run = table[index].run;                                 \
 524         SKIP_BITS(name, gb, n);                                 \
 525     } while (0)
 526
 527 /**
 528  * Parse a vlc code.
 529  * @param bits is the number of bits which will be read at once, must be
 530  *             identical to nb_bits in init_vlc()
 531  * @param max_depth is the number of times bits bits must be read to completely
 532  *                  read the longest vlc code
 533  *                  = (max_vlc_length + bits - 1) / bits
 534  */
 535 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
 536                                      int bits, int max_depth)
 537 {
 538     int code;
 539
 540     OPEN_READER(re, s);
 541     UPDATE_CACHE(re, s);
 542
 543     GET_VLC(code, re, s, table, bits, max_depth);
 544
 545     CLOSE_READER(re, s);
 546
 547     return code;
 548 }
 549
 550 static inline int decode012(GetBitContext *gb)
 551 {
 552     int n;
 553     n = get_bits1(gb);
 554     if (n == 0)
 555         return 0;
 556     else
 557         return get_bits1(gb) + 1;
 558 }
 559
 560 static inline int decode210(GetBitContext *gb)
 561 {
 562     if (get_bits1(gb))
 563         return 0;
 564     else
 565         return 2 - get_bits1(gb);
 566 }
 567
 568 static inline int get_bits_left(GetBitContext *gb)
 569 {
 570     return gb->size_in_bits - get_bits_count(gb);
 571 }
 572
 573 static inline int skip_1stop_8data_bits(GetBitContext *gb)
 574 {
 575     if (get_bits_left(gb) <= 0)
 576         return AVERROR_INVALIDDATA;
 577
 578     while (get_bits1(gb)) {
 579         skip_bits(gb, 8);
 580         if (get_bits_left(gb) <= 0)
 581             return AVERROR_INVALIDDATA;
 582     }
 583
 584     return 0;
 585 }
 586
 587 //#define TRACE
 588
 589 #ifdef TRACE
 590 static inline void print_bin(int bits, int n)
 591 {
 592     int i;
 593
 594     for (i = n - 1; i >= 0; i--)
 595         av_log(NULL, AV_LOG_DEBUG, "%d", (bits >> i) & 1);
 596     for (i = n; i < 24; i++)
 597         av_log(NULL, AV_LOG_DEBUG, " ");
 598 }
 599
 600 static inline int get_bits_trace(GetBitContext *s, int n, const char *file,
 601                                  const char *func, int line)
 602 {
 603     int r = get_bits(s, n);
 604
 605     print_bin(r, n);
 606     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n",
 607            r, n, r, get_bits_count(s) - n, file, func, line);
 608
 609     return r;
 610 }
 611
 612 static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2],
 613                                 int bits, int max_depth, const char *file,
 614                                 const char *func, int line)
 615 {
 616     int show  = show_bits(s, 24);
 617     int pos   = get_bits_count(s);
 618     int r     = get_vlc2(s, table, bits, max_depth);
 619     int len   = get_bits_count(s) - pos;
 620     int bits2 = show >> (24 - len);
 621
 622     print_bin(bits2, len);
 623
 624     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n",
 625            bits2, len, r, pos, file, func, line);
 626
 627     return r;
 628 }
 629
 630 #define GET_RL_VLC(level, run, name, gb, table, bits,           \
 631                    max_depth, need_update)                      \
 632     do {                                                        \
 633         int show  = SHOW_UBITS(name, gb, 24);                   \
 634         int len;                                                \
 635         int pos = name ## _index;                               \
 636                                                                 \
 637         GET_RL_VLC_INTERNAL(level, run, name, gb, table, bits,max_depth, need_update); \
 638                                                                 \
 639         len = name ## _index - pos + 1;                         \
 640         show = show >> (24 - len);                              \
 641                                                                 \
 642         print_bin(show, len);                                   \
 643                                                                 \
 644         av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d/%-3d rlv @%5d in %s %s:%d\n",\
 645                show, len, run-1, level, pos, __FILE__, __PRETTY_FUNCTION__, __LINE__);\
 646     } while (0)                                                 \
 647
 648
 649 static inline int get_xbits_trace(GetBitContext *s, int n, const char *file,
 650                                   const char *func, int line)
 651 {
 652     int show = show_bits(s, n);
 653     int r    = get_xbits(s, n);
 654
 655     print_bin(show, n);
 656     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n",
 657            show, n, r, get_bits_count(s) - n, file, func, line);
 658
 659     return r;
 660 }
 661
 662 #define get_bits(s, n)  get_bits_trace(s , n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 663 #define get_bits1(s)    get_bits_trace(s,  1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 664 #define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 665
 666 #define get_vlc(s, vlc)             get_vlc_trace(s, (vlc)->table, (vlc)->bits,   3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 667 #define get_vlc2(s, tab, bits, max) get_vlc_trace(s,          tab,        bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 668 #else //TRACE
 669 #define GET_RL_VLC GET_RL_VLC_INTERNAL
 670 #endif
 671
 672 #endif /* AVCODEC_GET_BITS_H */