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     av_assert2(n>=0 && n<=32);
 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     // sign_extend(x, 0) is undefined
 374     if (!n)
 375         return 0;
 376
 377     return sign_extend(get_bits_long(s, n), n);
 378 }
 379
 380 /**
 381  * Show 0-32 bits.
 382  */
 383 static inline unsigned int show_bits_long(GetBitContext *s, int n)
 384 {
 385     if (n <= MIN_CACHE_BITS) {
 386         return show_bits(s, n);
 387     } else {
 388         GetBitContext gb = *s;
 389         return get_bits_long(&gb, n);
 390     }
 391 }
 392
 393 static inline int check_marker(void *logctx, GetBitContext *s, const char *msg)
 394 {
 395     int bit = get_bits1(s);
 396     if (!bit)
 397         av_log(logctx, AV_LOG_INFO, "Marker bit missing at %d of %d %s\n",
 398                get_bits_count(s) - 1, s->size_in_bits, msg);
 399
 400     return bit;
 401 }
 402
 403 /**
 404  * Initialize GetBitContext.
 405  * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
 406  *        larger than the actual read bits because some optimized bitstream
 407  *        readers read 32 or 64 bit at once and could read over the end
 408  * @param bit_size the size of the buffer in bits
 409  * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
 410  */
 411 static inline int init_get_bits(GetBitContext *s, const uint8_t *buffer,
 412                                 int bit_size)
 413 {
 414     int buffer_size;
 415     int ret = 0;
 416
 417     if (bit_size >= INT_MAX - 7 || bit_size < 0 || !buffer) {
 418         bit_size    = 0;
 419         buffer      = NULL;
 420         ret         = AVERROR_INVALIDDATA;
 421     }
 422
 423     buffer_size = (bit_size + 7) >> 3;
 424
 425     s->buffer             = buffer;
 426     s->size_in_bits       = bit_size;
 427     s->size_in_bits_plus8 = bit_size + 8;
 428     s->buffer_end         = buffer + buffer_size;
 429     s->index              = 0;
 430
 431     return ret;
 432 }
 433
 434 /**
 435  * Initialize GetBitContext.
 436  * @param buffer bitstream buffer, must be AV_INPUT_BUFFER_PADDING_SIZE bytes
 437  *        larger than the actual read bits because some optimized bitstream
 438  *        readers read 32 or 64 bit at once and could read over the end
 439  * @param byte_size the size of the buffer in bytes
 440  * @return 0 on success, AVERROR_INVALIDDATA if the buffer_size would overflow.
 441  */
 442 static inline int init_get_bits8(GetBitContext *s, const uint8_t *buffer,
 443                                  int byte_size)
 444 {
 445     if (byte_size > INT_MAX / 8 || byte_size < 0)
 446         byte_size = -1;
 447     return init_get_bits(s, buffer, byte_size * 8);
 448 }
 449
 450 static inline const uint8_t *align_get_bits(GetBitContext *s)
 451 {
 452     int n = -get_bits_count(s) & 7;
 453     if (n)
 454         skip_bits(s, n);
 455     return s->buffer + (s->index >> 3);
 456 }
 457
 458 /**
 459  * If the vlc code is invalid and max_depth=1, then no bits will be removed.
 460  * If the vlc code is invalid and max_depth>1, then the number of bits removed
 461  * is undefined.
 462  */
 463 #define GET_VLC(code, name, gb, table, bits, max_depth)         \
 464     do {                                                        \
 465         int n, nb_bits;                                         \
 466         unsigned int index;                                     \
 467                                                                 \
 468         index = SHOW_UBITS(name, gb, bits);                     \
 469         code  = table[index][0];                                \
 470         n     = table[index][1];                                \
 471                                                                 \
 472         if (max_depth > 1 && n < 0) {                           \
 473             LAST_SKIP_BITS(name, gb, bits);                     \
 474             UPDATE_CACHE(name, gb);                             \
 475                                                                 \
 476             nb_bits = -n;                                       \
 477                                                                 \
 478             index = SHOW_UBITS(name, gb, nb_bits) + code;       \
 479             code  = table[index][0];                            \
 480             n     = table[index][1];                            \
 481             if (max_depth > 2 && n < 0) {                       \
 482                 LAST_SKIP_BITS(name, gb, nb_bits);              \
 483                 UPDATE_CACHE(name, gb);                         \
 484                                                                 \
 485                 nb_bits = -n;                                   \
 486                                                                 \
 487                 index = SHOW_UBITS(name, gb, nb_bits) + code;   \
 488                 code  = table[index][0];                        \
 489                 n     = table[index][1];                        \
 490             }                                                   \
 491         }                                                       \
 492         SKIP_BITS(name, gb, n);                                 \
 493     } while (0)
 494
 495 #define GET_RL_VLC(level, run, name, gb, table, bits,  \
 496                    max_depth, need_update)                      \
 497     do {                                                        \
 498         int n, nb_bits;                                         \
 499         unsigned int index;                                     \
 500                                                                 \
 501         index = SHOW_UBITS(name, gb, bits);                     \
 502         level = table[index].level;                             \
 503         n     = table[index].len;                               \
 504                                                                 \
 505         if (max_depth > 1 && n < 0) {                           \
 506             SKIP_BITS(name, gb, bits);                          \
 507             if (need_update) {                                  \
 508                 UPDATE_CACHE(name, gb);                         \
 509             }                                                   \
 510                                                                 \
 511             nb_bits = -n;                                       \
 512                                                                 \
 513             index = SHOW_UBITS(name, gb, nb_bits) + level;      \
 514             level = table[index].level;                         \
 515             n     = table[index].len;                           \
 516             if (max_depth > 2 && n < 0) {                       \
 517                 LAST_SKIP_BITS(name, gb, nb_bits);              \
 518                 if (need_update) {                              \
 519                     UPDATE_CACHE(name, gb);                     \
 520                 }                                               \
 521                 nb_bits = -n;                                   \
 522                                                                 \
 523                 index = SHOW_UBITS(name, gb, nb_bits) + level;  \
 524                 level = table[index].level;                     \
 525                 n     = table[index].len;                       \
 526             }                                                   \
 527         }                                                       \
 528         run = table[index].run;                                 \
 529         SKIP_BITS(name, gb, n);                                 \
 530     } while (0)
 531
 532 /**
 533  * Parse a vlc code.
 534  * @param bits is the number of bits which will be read at once, must be
 535  *             identical to nb_bits in init_vlc()
 536  * @param max_depth is the number of times bits bits must be read to completely
 537  *                  read the longest vlc code
 538  *                  = (max_vlc_length + bits - 1) / bits
 539  */
 540 static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
 541                                      int bits, int max_depth)
 542 {
 543     int code;
 544
 545     OPEN_READER(re, s);
 546     UPDATE_CACHE(re, s);
 547
 548     GET_VLC(code, re, s, table, bits, max_depth);
 549
 550     CLOSE_READER(re, s);
 551
 552     return code;
 553 }
 554
 555 static inline int decode012(GetBitContext *gb)
 556 {
 557     int n;
 558     n = get_bits1(gb);
 559     if (n == 0)
 560         return 0;
 561     else
 562         return get_bits1(gb) + 1;
 563 }
 564
 565 static inline int decode210(GetBitContext *gb)
 566 {
 567     if (get_bits1(gb))
 568         return 0;
 569     else
 570         return 2 - get_bits1(gb);
 571 }
 572
 573 static inline int get_bits_left(GetBitContext *gb)
 574 {
 575     return gb->size_in_bits - get_bits_count(gb);
 576 }
 577
 578 static inline int skip_1stop_8data_bits(GetBitContext *gb)
 579 {
 580     if (get_bits_left(gb) <= 0)
 581         return AVERROR_INVALIDDATA;
 582
 583     while (get_bits1(gb)) {
 584         skip_bits(gb, 8);
 585         if (get_bits_left(gb) <= 0)
 586             return AVERROR_INVALIDDATA;
 587     }
 588
 589     return 0;
 590 }
 591
 592 #endif /* AVCODEC_GET_BITS_H */