bitstream.h 25.6 KB
Newer Older
1 2 3
/*
 * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21
/**
22
 * @file libavcodec/bitstream.h
23 24 25
 * bitstream api header.
 */

26 27
#ifndef AVCODEC_BITSTREAM_H
#define AVCODEC_BITSTREAM_H
28

29 30 31
#include <stdint.h>
#include <stdlib.h>
#include <assert.h>
32 33 34 35
#include "libavutil/bswap.h"
#include "libavutil/common.h"
#include "libavutil/intreadwrite.h"
#include "libavutil/log.h"
36
#include "mathops.h"
37

38
#if defined(ALT_BITSTREAM_READER_LE) && !defined(ALT_BITSTREAM_READER)
Michael Niedermayer's avatar
indent  
Michael Niedermayer committed
39
#   define ALT_BITSTREAM_READER
40 41
#endif

42 43
//#define ALT_BITSTREAM_WRITER
//#define ALIGNED_BITSTREAM_WRITER
44
#if !defined(LIBMPEG2_BITSTREAM_READER) && !defined(A32_BITSTREAM_READER) && !defined(ALT_BITSTREAM_READER)
45
#   if ARCH_ARM
46 47
#       define A32_BITSTREAM_READER
#   else
Michael Niedermayer's avatar
indent  
Michael Niedermayer committed
48
#       define ALT_BITSTREAM_READER
49 50
//#define LIBMPEG2_BITSTREAM_READER
//#define A32_BITSTREAM_READER
51
#   endif
52
#endif
53

54 55
extern const uint8_t ff_reverse[256];

56
#if ARCH_X86
57 58
// avoid +32 for shift optimization (gcc should do that ...)
static inline  int32_t NEG_SSR32( int32_t a, int8_t s){
59
    __asm__ ("sarl %1, %0\n\t"
60 61 62 63 64 65
         : "+r" (a)
         : "ic" ((uint8_t)(-s))
    );
    return a;
}
static inline uint32_t NEG_USR32(uint32_t a, int8_t s){
66
    __asm__ ("shrl %1, %0\n\t"
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
         : "+r" (a)
         : "ic" ((uint8_t)(-s))
    );
    return a;
}
#else
#    define NEG_SSR32(a,s) ((( int32_t)(a))>>(32-(s)))
#    define NEG_USR32(a,s) (((uint32_t)(a))>>(32-(s)))
#endif

/* bit output */

/* buf and buf_end must be present and used by every alternative writer. */
typedef struct PutBitContext {
#ifdef ALT_BITSTREAM_WRITER
    uint8_t *buf, *buf_end;
    int index;
#else
    uint32_t bit_buf;
    int bit_left;
    uint8_t *buf, *buf_ptr, *buf_end;
#endif
89
    int size_in_bits;
90 91
} PutBitContext;

Stefano Sabatini's avatar
Stefano Sabatini committed
92 93 94 95 96 97
/**
 * Initializes the PutBitContext \p s.
 *
 * @param buffer the buffer where to put bits
 * @param buffer_size the size in bytes of \p buffer
 */
98 99
static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
{
100 101 102 103
    if(buffer_size < 0) {
        buffer_size = 0;
        buffer = NULL;
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
104

105
    s->size_in_bits= 8*buffer_size;
106 107 108 109 110 111 112 113 114 115 116 117 118
    s->buf = buffer;
    s->buf_end = s->buf + buffer_size;
#ifdef ALT_BITSTREAM_WRITER
    s->index=0;
    ((uint32_t*)(s->buf))[0]=0;
//    memset(buffer, 0, buffer_size);
#else
    s->buf_ptr = s->buf;
    s->bit_left=32;
    s->bit_buf=0;
#endif
}

119 120 121
/**
 * Returns the number of bits output.
 */
122 123 124 125 126 127 128 129 130
static inline int put_bits_count(PutBitContext *s)
{
#ifdef ALT_BITSTREAM_WRITER
    return s->index;
#else
    return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
#endif
}

131 132 133
/**
 * Pads the end of the output stream with zeros.
 */
134 135 136 137 138
static inline void flush_put_bits(PutBitContext *s)
{
#ifdef ALT_BITSTREAM_WRITER
    align_put_bits(s);
#else
139
#ifndef BITSTREAM_WRITER_LE
140
    s->bit_buf<<= s->bit_left;
141
#endif
142 143
    while (s->bit_left < 32) {
        /* XXX: should test end of buffer */
144 145 146 147
#ifdef BITSTREAM_WRITER_LE
        *s->buf_ptr++=s->bit_buf;
        s->bit_buf>>=8;
#else
148 149
        *s->buf_ptr++=s->bit_buf >> 24;
        s->bit_buf<<=8;
150
#endif
151 152 153 154 155 156 157
        s->bit_left+=8;
    }
    s->bit_left=32;
    s->bit_buf=0;
#endif
}

Stefano Sabatini's avatar
Stefano Sabatini committed
158 159 160
/**
 * Pads the bitstream with zeros up to the next byte boundary.
 */
161
void align_put_bits(PutBitContext *s);
Michael Niedermayer's avatar
const  
Michael Niedermayer committed
162 163
void ff_put_string(PutBitContext * pbc, const char *s, int put_zero);
void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

/* bit input */
/* buffer, buffer_end and size_in_bits must be present and used by every reader */
typedef struct GetBitContext {
    const uint8_t *buffer, *buffer_end;
#ifdef ALT_BITSTREAM_READER
    int index;
#elif defined LIBMPEG2_BITSTREAM_READER
    uint8_t *buffer_ptr;
    uint32_t cache;
    int bit_count;
#elif defined A32_BITSTREAM_READER
    uint32_t *buffer_ptr;
    uint32_t cache0;
    uint32_t cache1;
    int bit_count;
#endif
    int size_in_bits;
} GetBitContext;

#define VLC_TYPE int16_t

typedef struct VLC {
    int bits;
    VLC_TYPE (*table)[2]; ///< code, bits
    int table_size, table_allocated;
} VLC;

typedef struct RL_VLC_ELEM {
    int16_t level;
    int8_t len;
    uint8_t run;
} RL_VLC_ELEM;

#ifndef ALT_BITSTREAM_WRITER
static inline void put_bits(PutBitContext *s, int n, unsigned int value)
{
    unsigned int bit_buf;
    int bit_left;

    //    printf("put_bits=%d %x\n", n, value);
    assert(n == 32 || value < (1U << n));
206

207 208 209 210 211
    bit_buf = s->bit_buf;
    bit_left = s->bit_left;

    //    printf("n=%d value=%x cnt=%d buf=%x\n", n, value, bit_cnt, bit_buf);
    /* XXX: optimize */
212 213 214
#ifdef BITSTREAM_WRITER_LE
    bit_buf |= value << (32 - bit_left);
    if (n >= bit_left) {
215
#if !HAVE_FAST_UNALIGNED
216
        if (3 & (intptr_t) s->buf_ptr) {
217
            AV_WL32(s->buf_ptr, bit_buf);
218 219 220 221 222 223 224 225 226
        } else
#endif
        *(uint32_t *)s->buf_ptr = le2me_32(bit_buf);
        s->buf_ptr+=4;
        bit_buf = (bit_left==32)?0:value >> bit_left;
        bit_left+=32;
    }
    bit_left-=n;
#else
227 228 229 230
    if (n < bit_left) {
        bit_buf = (bit_buf<<n) | value;
        bit_left-=n;
    } else {
231
        bit_buf<<=bit_left;
232
        bit_buf |= value >> (n - bit_left);
233
#if !HAVE_FAST_UNALIGNED
234
        if (3 & (intptr_t) s->buf_ptr) {
235
            AV_WB32(s->buf_ptr, bit_buf);
236 237 238 239 240
        } else
#endif
        *(uint32_t *)s->buf_ptr = be2me_32(bit_buf);
        //printf("bitbuf = %08x\n", bit_buf);
        s->buf_ptr+=4;
241
        bit_left+=32 - n;
242 243
        bit_buf = value;
    }
244
#endif
245 246 247 248 249 250 251 252 253 254 255

    s->bit_buf = bit_buf;
    s->bit_left = bit_left;
}
#endif


#ifdef ALT_BITSTREAM_WRITER
static inline void put_bits(PutBitContext *s, int n, unsigned int value)
{
#    ifdef ALIGNED_BITSTREAM_WRITER
256
#        if ARCH_X86
257
    __asm__ volatile(
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
        "movl %0, %%ecx                 \n\t"
        "xorl %%eax, %%eax              \n\t"
        "shrdl %%cl, %1, %%eax          \n\t"
        "shrl %%cl, %1                  \n\t"
        "movl %0, %%ecx                 \n\t"
        "shrl $3, %%ecx                 \n\t"
        "andl $0xFFFFFFFC, %%ecx        \n\t"
        "bswapl %1                      \n\t"
        "orl %1, (%2, %%ecx)            \n\t"
        "bswapl %%eax                   \n\t"
        "addl %3, %0                    \n\t"
        "movl %%eax, 4(%2, %%ecx)       \n\t"
        : "=&r" (s->index), "=&r" (value)
        : "r" (s->buf), "r" (n), "0" (s->index), "1" (value<<(-n))
        : "%eax", "%ecx"
273 274 275 276
    );
#        else
    int index= s->index;
    uint32_t *ptr= ((uint32_t *)s->buf)+(index>>5);
277 278 279

    value<<= 32-n;

280 281 282 283 284 285 286
    ptr[0] |= be2me_32(value>>(index&31));
    ptr[1]  = be2me_32(value<<(32-(index&31)));
//if(n>24) printf("%d %d\n", n, value);
    index+= n;
    s->index= index;
#        endif
#    else //ALIGNED_BITSTREAM_WRITER
287
#        if ARCH_X86
288
    __asm__ volatile(
289 290 291 292 293 294 295 296 297 298 299 300 301 302
        "movl $7, %%ecx                 \n\t"
        "andl %0, %%ecx                 \n\t"
        "addl %3, %%ecx                 \n\t"
        "negl %%ecx                     \n\t"
        "shll %%cl, %1                  \n\t"
        "bswapl %1                      \n\t"
        "movl %0, %%ecx                 \n\t"
        "shrl $3, %%ecx                 \n\t"
        "orl %1, (%%ecx, %2)            \n\t"
        "addl %3, %0                    \n\t"
        "movl $0, 4(%%ecx, %2)          \n\t"
        : "=&r" (s->index), "=&r" (value)
        : "r" (s->buf), "r" (n), "0" (s->index), "1" (value)
        : "%ecx"
303 304 305 306
    );
#        else
    int index= s->index;
    uint32_t *ptr= (uint32_t*)(((uint8_t *)s->buf)+(index>>3));
307

308 309 310 311 312 313 314 315 316 317
    ptr[0] |= be2me_32(value<<(32-n-(index&7) ));
    ptr[1] = 0;
//if(n>24) printf("%d %d\n", n, value);
    index+= n;
    s->index= index;
#        endif
#    endif //!ALIGNED_BITSTREAM_WRITER
}
#endif

318 319 320 321 322 323 324
static inline void put_sbits(PutBitContext *pb, int bits, int32_t val)
{
    assert(bits >= 0 && bits <= 31);

    put_bits(pb, bits, val & ((1<<bits)-1));
}

325 326 327 328

static inline uint8_t* pbBufPtr(PutBitContext *s)
{
#ifdef ALT_BITSTREAM_WRITER
329
        return s->buf + (s->index>>3);
330
#else
331
        return s->buf_ptr;
332 333 334 335 336 337 338 339 340 341 342
#endif
}

/**
 *
 * PutBitContext must be flushed & aligned to a byte boundary before calling this.
 */
static inline void skip_put_bytes(PutBitContext *s, int n){
        assert((put_bits_count(s)&7)==0);
#ifdef ALT_BITSTREAM_WRITER
        FIXME may need some cleaning of the buffer
343
        s->index += n<<3;
344 345
#else
        assert(s->bit_left==32);
346
        s->buf_ptr += n;
347
#endif
348 349
}

350
/**
Diego Biurrun's avatar
Diego Biurrun committed
351 352
 * Skips the given number of bits.
 * Must only be used if the actual values in the bitstream do not matter.
353
 * If \p n is 0 the behavior is undefined.
354 355 356 357 358 359 360 361
 */
static inline void skip_put_bits(PutBitContext *s, int n){
#ifdef ALT_BITSTREAM_WRITER
    s->index += n;
#else
    s->bit_left -= n;
    s->buf_ptr-= s->bit_left>>5;
    s->bit_left &= 31;
362
#endif
363 364
}

365 366 367 368 369 370 371 372 373
/**
 * Changes the end of the buffer.
 */
static inline void set_put_bits_buffer_size(PutBitContext *s, int size){
    s->buf_end= s->buf + size;
}

/* Bitstream reader API docs:
name
Stefano Sabatini's avatar
Stefano Sabatini committed
374
    arbitrary name which is used as prefix for the internal variables
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

gb
    getbitcontext

OPEN_READER(name, gb)
    loads gb into local variables

CLOSE_READER(name, gb)
    stores local vars in gb

UPDATE_CACHE(name, gb)
    refills the internal cache from the bitstream
    after this call at least MIN_CACHE_BITS will be available,

GET_CACHE(name, gb)
    will output the contents of the internal cache, next bit is MSB of 32 or 64 bit (FIXME 64bit)

SHOW_UBITS(name, gb, num)
Diego Biurrun's avatar
Diego Biurrun committed
393
    will return the next num bits
394 395

SHOW_SBITS(name, gb, num)
Diego Biurrun's avatar
Diego Biurrun committed
396
    will return the next num bits and do sign extension
397 398 399

SKIP_BITS(name, gb, num)
    will skip over the next num bits
Diego Biurrun's avatar
Diego Biurrun committed
400
    note, this is equivalent to SKIP_CACHE; SKIP_COUNTER
401 402 403 404 405 406 407 408 409 410 411

SKIP_CACHE(name, gb, num)
    will remove the next num bits from the cache (note SKIP_COUNTER MUST be called before UPDATE_CACHE / CLOSE_READER)

SKIP_COUNTER(name, gb, num)
    will increment the internal bit counter (see SKIP_CACHE & SKIP_BITS)

LAST_SKIP_CACHE(name, gb, num)
    will remove the next num bits from the cache if it is needed for UPDATE_CACHE otherwise it will do nothing

LAST_SKIP_BITS(name, gb, num)
Diego Biurrun's avatar
Diego Biurrun committed
412
    is equivalent to SKIP_LAST_CACHE; SKIP_COUNTER
413 414 415 416 417 418 419 420 421 422 423 424 425 426

for examples see get_bits, show_bits, skip_bits, get_vlc
*/

#ifdef ALT_BITSTREAM_READER
#   define MIN_CACHE_BITS 25

#   define OPEN_READER(name, gb)\
        int name##_index= (gb)->index;\
        int name##_cache= 0;\

#   define CLOSE_READER(name, gb)\
        (gb)->index= name##_index;\

427 428
# ifdef ALT_BITSTREAM_READER_LE
#   define UPDATE_CACHE(name, gb)\
429
        name##_cache= AV_RL32( ((const uint8_t *)(gb)->buffer)+(name##_index>>3) ) >> (name##_index&0x07);\
430 431 432 433

#   define SKIP_CACHE(name, gb, num)\
        name##_cache >>= (num);
# else
434
#   define UPDATE_CACHE(name, gb)\
435
        name##_cache= AV_RB32( ((const uint8_t *)(gb)->buffer)+(name##_index>>3) ) << (name##_index&0x07);\
436 437

#   define SKIP_CACHE(name, gb, num)\
438 439
        name##_cache <<= (num);
# endif
440 441 442 443 444 445 446 447 448 449 450 451 452 453

// FIXME name?
#   define SKIP_COUNTER(name, gb, num)\
        name##_index += (num);\

#   define SKIP_BITS(name, gb, num)\
        {\
            SKIP_CACHE(name, gb, num)\
            SKIP_COUNTER(name, gb, num)\
        }\

#   define LAST_SKIP_BITS(name, gb, num) SKIP_COUNTER(name, gb, num)
#   define LAST_SKIP_CACHE(name, gb, num) ;

454 455 456
# ifdef ALT_BITSTREAM_READER_LE
#   define SHOW_UBITS(name, gb, num)\
        ((name##_cache) & (NEG_USR32(0xffffffff,num)))
457 458 459

#   define SHOW_SBITS(name, gb, num)\
        NEG_SSR32((name##_cache)<<(32-(num)), num)
460
# else
461 462 463 464 465
#   define SHOW_UBITS(name, gb, num)\
        NEG_USR32(name##_cache, num)

#   define SHOW_SBITS(name, gb, num)\
        NEG_SSR32(name##_cache, num)
466
# endif
467 468 469 470 471 472 473

#   define GET_CACHE(name, gb)\
        ((uint32_t)name##_cache)

static inline int get_bits_count(GetBitContext *s){
    return s->index;
}
474 475

static inline void skip_bits_long(GetBitContext *s, int n){
476
    s->index += n;
477 478
}

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
#elif defined LIBMPEG2_BITSTREAM_READER
//libmpeg2 like reader

#   define MIN_CACHE_BITS 17

#   define OPEN_READER(name, gb)\
        int name##_bit_count=(gb)->bit_count;\
        int name##_cache= (gb)->cache;\
        uint8_t * name##_buffer_ptr=(gb)->buffer_ptr;\

#   define CLOSE_READER(name, gb)\
        (gb)->bit_count= name##_bit_count;\
        (gb)->cache= name##_cache;\
        (gb)->buffer_ptr= name##_buffer_ptr;\

#   define UPDATE_CACHE(name, gb)\
    if(name##_bit_count >= 0){\
496
        name##_cache+= AV_RB16(name##_buffer_ptr) << name##_bit_count; \
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
        name##_buffer_ptr+=2;\
        name##_bit_count-= 16;\
    }\

#   define SKIP_CACHE(name, gb, num)\
        name##_cache <<= (num);\

#   define SKIP_COUNTER(name, gb, num)\
        name##_bit_count += (num);\

#   define SKIP_BITS(name, gb, num)\
        {\
            SKIP_CACHE(name, gb, num)\
            SKIP_COUNTER(name, gb, num)\
        }\

#   define LAST_SKIP_BITS(name, gb, num) SKIP_BITS(name, gb, num)
#   define LAST_SKIP_CACHE(name, gb, num) SKIP_CACHE(name, gb, num)

#   define SHOW_UBITS(name, gb, num)\
        NEG_USR32(name##_cache, num)

#   define SHOW_SBITS(name, gb, num)\
        NEG_SSR32(name##_cache, num)

#   define GET_CACHE(name, gb)\
        ((uint32_t)name##_cache)

static inline int get_bits_count(GetBitContext *s){
    return (s->buffer_ptr - s->buffer)*8 - 16 + s->bit_count;
}

529 530 531 532 533 534 535 536 537 538
static inline void skip_bits_long(GetBitContext *s, int n){
    OPEN_READER(re, s)
    re_bit_count += n;
    re_buffer_ptr += 2*(re_bit_count>>4);
    re_bit_count &= 15;
    re_cache = ((re_buffer_ptr[-2]<<8) + re_buffer_ptr[-1]) << (16+re_bit_count);
    UPDATE_CACHE(re, s)
    CLOSE_READER(re, s)
}

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
#elif defined A32_BITSTREAM_READER

#   define MIN_CACHE_BITS 32

#   define OPEN_READER(name, gb)\
        int name##_bit_count=(gb)->bit_count;\
        uint32_t name##_cache0= (gb)->cache0;\
        uint32_t name##_cache1= (gb)->cache1;\
        uint32_t * name##_buffer_ptr=(gb)->buffer_ptr;\

#   define CLOSE_READER(name, gb)\
        (gb)->bit_count= name##_bit_count;\
        (gb)->cache0= name##_cache0;\
        (gb)->cache1= name##_cache1;\
        (gb)->buffer_ptr= name##_buffer_ptr;\

#   define UPDATE_CACHE(name, gb)\
    if(name##_bit_count > 0){\
        const uint32_t next= be2me_32( *name##_buffer_ptr );\
        name##_cache0 |= NEG_USR32(next,name##_bit_count);\
        name##_cache1 |= next<<name##_bit_count;\
        name##_buffer_ptr++;\
        name##_bit_count-= 32;\
    }\

564
#if ARCH_X86
565
#   define SKIP_CACHE(name, gb, num)\
566
        __asm__(\
567 568
            "shldl %2, %1, %0          \n\t"\
            "shll %2, %1               \n\t"\
569
            : "+r" (name##_cache0), "+r" (name##_cache1)\
570
            : "Ic" ((uint8_t)(num))\
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
           );
#else
#   define SKIP_CACHE(name, gb, num)\
        name##_cache0 <<= (num);\
        name##_cache0 |= NEG_USR32(name##_cache1,num);\
        name##_cache1 <<= (num);
#endif

#   define SKIP_COUNTER(name, gb, num)\
        name##_bit_count += (num);\

#   define SKIP_BITS(name, gb, num)\
        {\
            SKIP_CACHE(name, gb, num)\
            SKIP_COUNTER(name, gb, num)\
        }\

#   define LAST_SKIP_BITS(name, gb, num) SKIP_BITS(name, gb, num)
#   define LAST_SKIP_CACHE(name, gb, num) SKIP_CACHE(name, gb, num)

#   define SHOW_UBITS(name, gb, num)\
        NEG_USR32(name##_cache0, num)

#   define SHOW_SBITS(name, gb, num)\
        NEG_SSR32(name##_cache0, num)

#   define GET_CACHE(name, gb)\
        (name##_cache0)

static inline int get_bits_count(GetBitContext *s){
    return ((uint8_t*)s->buffer_ptr - s->buffer)*8 - 32 + s->bit_count;
}

604 605 606
static inline void skip_bits_long(GetBitContext *s, int n){
    OPEN_READER(re, s)
    re_bit_count += n;
Michael Niedermayer's avatar
Michael Niedermayer committed
607
    re_buffer_ptr += re_bit_count>>5;
608
    re_bit_count &= 31;
609 610
    re_cache0 = be2me_32( re_buffer_ptr[-1] ) << re_bit_count;
    re_cache1 = 0;
611 612 613 614
    UPDATE_CACHE(re, s)
    CLOSE_READER(re, s)
}

615 616 617 618
#endif

/**
 * read mpeg1 dc style vlc (sign bit + mantisse with no MSB).
619
 * if MSB not set it is negative
620
 * @param n length in bits
621
 * @author BERO
622 623
 */
static inline int get_xbits(GetBitContext *s, int n){
Michael Niedermayer's avatar
Michael Niedermayer committed
624
    register int sign;
625 626 627 628
    register int32_t cache;
    OPEN_READER(re, s)
    UPDATE_CACHE(re, s)
    cache = GET_CACHE(re,s);
Michael Niedermayer's avatar
Michael Niedermayer committed
629
    sign=(~cache)>>31;
630 631
    LAST_SKIP_BITS(re, s, n)
    CLOSE_READER(re, s)
Michael Niedermayer's avatar
Michael Niedermayer committed
632
    return (NEG_USR32(sign ^ cache, n) ^ sign) - sign;
633 634 635 636 637 638 639 640 641 642 643 644 645
}

static inline int get_sbits(GetBitContext *s, int n){
    register int tmp;
    OPEN_READER(re, s)
    UPDATE_CACHE(re, s)
    tmp= SHOW_SBITS(re, s, n);
    LAST_SKIP_BITS(re, s, n)
    CLOSE_READER(re, s)
    return tmp;
}

/**
646
 * reads 1-17 bits.
Diego Biurrun's avatar
Diego Biurrun committed
647
 * Note, the alt bitstream reader can read up to 25 bits, but the libmpeg2 reader can't
648 649 650 651 652 653 654 655 656 657 658 659
 */
static inline unsigned int get_bits(GetBitContext *s, int n){
    register int tmp;
    OPEN_READER(re, s)
    UPDATE_CACHE(re, s)
    tmp= SHOW_UBITS(re, s, n);
    LAST_SKIP_BITS(re, s, n)
    CLOSE_READER(re, s)
    return tmp;
}

/**
660
 * shows 1-17 bits.
Diego Biurrun's avatar
Diego Biurrun committed
661
 * Note, the alt bitstream reader can read up to 25 bits, but the libmpeg2 reader can't
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
 */
static inline unsigned int show_bits(GetBitContext *s, int n){
    register int tmp;
    OPEN_READER(re, s)
    UPDATE_CACHE(re, s)
    tmp= SHOW_UBITS(re, s, n);
//    CLOSE_READER(re, s)
    return tmp;
}

static inline void skip_bits(GetBitContext *s, int n){
 //Note gcc seems to optimize this to s->index+=n for the ALT_READER :))
    OPEN_READER(re, s)
    UPDATE_CACHE(re, s)
    LAST_SKIP_BITS(re, s, n)
    CLOSE_READER(re, s)
}

static inline unsigned int get_bits1(GetBitContext *s){
#ifdef ALT_BITSTREAM_READER
    int index= s->index;
    uint8_t result= s->buffer[ index>>3 ];
684 685 686 687
#ifdef ALT_BITSTREAM_READER_LE
    result>>= (index&0x07);
    result&= 1;
#else
688 689
    result<<= (index&0x07);
    result>>= 8 - 1;
690
#endif
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    index++;
    s->index= index;

    return result;
#else
    return get_bits(s, 1);
#endif
}

static inline unsigned int show_bits1(GetBitContext *s){
    return show_bits(s, 1);
}

static inline void skip_bits1(GetBitContext *s){
    skip_bits(s, 1);
}

708 709 710 711 712 713
/**
 * reads 0-32 bits.
 */
static inline unsigned int get_bits_long(GetBitContext *s, int n){
    if(n<=17) return get_bits(s, n);
    else{
714 715 716 717
#ifdef ALT_BITSTREAM_READER_LE
        int ret= get_bits(s, 16);
        return ret | (get_bits(s, n-16) << 16);
#else
718 719
        int ret= get_bits(s, 16) << (n-16);
        return ret | get_bits(s, n-16);
720
#endif
721 722 723
    }
}

724 725 726 727 728 729 730
/**
 * reads 0-32 bits as a signed integer.
 */
static inline int get_sbits_long(GetBitContext *s, int n) {
    return sign_extend(get_bits_long(s, n), n);
}

731 732 733 734 735 736 737
/**
 * shows 0-32 bits.
 */
static inline unsigned int show_bits_long(GetBitContext *s, int n){
    if(n<=17) return show_bits(s, n);
    else{
        GetBitContext gb= *s;
738
        return get_bits_long(&gb, n);
739 740 741 742 743 744 745 746 747 748 749 750
    }
}

static inline int check_marker(GetBitContext *s, const char *msg)
{
    int bit= get_bits1(s);
    if(!bit)
        av_log(NULL, AV_LOG_INFO, "Marker bit missing %s\n", msg);

    return bit;
}

751 752 753 754 755 756 757 758 759
/**
 * init GetBitContext.
 * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger then the actual read bits
 * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
 * @param bit_size the size of the buffer in bits
 */
static inline void init_get_bits(GetBitContext *s,
                   const uint8_t *buffer, int bit_size)
{
Michael Niedermayer's avatar
Michael Niedermayer committed
760
    int buffer_size= (bit_size+7)>>3;
761 762 763 764
    if(buffer_size < 0 || bit_size < 0) {
        buffer_size = bit_size = 0;
        buffer = NULL;
    }
765 766 767 768 769 770 771

    s->buffer= buffer;
    s->size_in_bits= bit_size;
    s->buffer_end= buffer + buffer_size;
#ifdef ALT_BITSTREAM_READER
    s->index=0;
#elif defined LIBMPEG2_BITSTREAM_READER
772 773 774
    s->buffer_ptr = (uint8_t*)((intptr_t)buffer&(~1));
    s->bit_count = 16 + 8*((intptr_t)buffer&1);
    skip_bits_long(s, 0);
775 776 777 778
#elif defined A32_BITSTREAM_READER
    s->buffer_ptr = (uint32_t*)((intptr_t)buffer&(~3));
    s->bit_count = 32 + 8*((intptr_t)buffer&3);
    skip_bits_long(s, 0);
779 780 781
#endif
}

Måns Rullgård's avatar
Måns Rullgård committed
782
static inline void align_get_bits(GetBitContext *s)
783 784 785 786 787
{
    int n= (-get_bits_count(s)) & 7;
    if(n) skip_bits(s, n);
}

788 789 790 791 792 793 794 795 796 797
#define init_vlc(vlc, nb_bits, nb_codes,\
                 bits, bits_wrap, bits_size,\
                 codes, codes_wrap, codes_size,\
                 flags)\
        init_vlc_sparse(vlc, nb_bits, nb_codes,\
                 bits, bits_wrap, bits_size,\
                 codes, codes_wrap, codes_size,\
                 NULL, 0, 0, flags)

int init_vlc_sparse(VLC *vlc, int nb_bits, int nb_codes,
798 799
             const void *bits, int bits_wrap, int bits_size,
             const void *codes, int codes_wrap, int codes_size,
800
             const void *symbols, int symbols_wrap, int symbols_size,
801
             int flags);
802
#define INIT_VLC_USE_STATIC 1 ///< VERY strongly deprecated and forbidden
803
#define INIT_VLC_LE         2
804
#define INIT_VLC_USE_NEW_STATIC 4
805 806
void free_vlc(VLC *vlc);

807 808 809 810 811 812 813 814 815
#define INIT_VLC_STATIC(vlc, bits, a,b,c,d,e,f,g, static_size)\
{\
    static VLC_TYPE table[static_size][2];\
    (vlc)->table= table;\
    (vlc)->table_allocated= static_size;\
    init_vlc(vlc, bits, a,b,c,d,e,f,g, INIT_VLC_USE_NEW_STATIC);\
}


816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
/**
 *
 * if the vlc code is invalid and max_depth=1 than no bits will be removed
 * if the vlc code is invalid and max_depth>1 than the number of bits removed
 * is undefined
 */
#define GET_VLC(code, name, gb, table, bits, max_depth)\
{\
    int n, index, nb_bits;\
\
    index= SHOW_UBITS(name, gb, bits);\
    code = table[index][0];\
    n    = table[index][1];\
\
    if(max_depth > 1 && n < 0){\
        LAST_SKIP_BITS(name, gb, bits)\
        UPDATE_CACHE(name, gb)\
\
        nb_bits = -n;\
\
        index= SHOW_UBITS(name, gb, nb_bits) + code;\
        code = table[index][0];\
        n    = table[index][1];\
        if(max_depth > 2 && n < 0){\
            LAST_SKIP_BITS(name, gb, nb_bits)\
            UPDATE_CACHE(name, gb)\
\
            nb_bits = -n;\
\
            index= SHOW_UBITS(name, gb, nb_bits) + code;\
            code = table[index][0];\
            n    = table[index][1];\
        }\
    }\
    SKIP_BITS(name, gb, n)\
}

853
#define GET_RL_VLC(level, run, name, gb, table, bits, max_depth, need_update)\
854 855 856 857 858 859 860 861
{\
    int n, index, nb_bits;\
\
    index= SHOW_UBITS(name, gb, bits);\
    level = table[index].level;\
    n     = table[index].len;\
\
    if(max_depth > 1 && n < 0){\
862 863 864 865
        SKIP_BITS(name, gb, bits)\
        if(need_update){\
            UPDATE_CACHE(name, gb)\
        }\
866 867 868 869 870 871 872 873 874 875 876 877 878 879
\
        nb_bits = -n;\
\
        index= SHOW_UBITS(name, gb, nb_bits) + level;\
        level = table[index].level;\
        n     = table[index].len;\
    }\
    run= table[index].run;\
    SKIP_BITS(name, gb, n)\
}


/**
 * parses a vlc code, faster then get_vlc()
880
 * @param bits is the number of bits which will be read at once, must be
881
 *             identical to nb_bits in init_vlc()
Diego Biurrun's avatar
Diego Biurrun committed
882
 * @param max_depth is the number of times bits bits must be read to completely
883
 *                  read the longest vlc code
884 885
 *                  = (max_vlc_length + bits - 1) / bits
 */
886
static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE (*table)[2],
887 888 889
                                  int bits, int max_depth)
{
    int code;
890

891 892 893 894 895 896 897 898 899 900 901 902 903 904
    OPEN_READER(re, s)
    UPDATE_CACHE(re, s)

    GET_VLC(code, re, s, table, bits, max_depth)

    CLOSE_READER(re, s)
    return code;
}

//#define TRACE

#ifdef TRACE
static inline void print_bin(int bits, int n){
    int i;
905

906
    for(i=n-1; i>=0; i--){
907
        av_log(NULL, AV_LOG_DEBUG, "%d", (bits>>i)&1);
908 909
    }
    for(i=n; i<24; i++)
910
        av_log(NULL, AV_LOG_DEBUG, " ");
911 912
}

913
static inline int get_bits_trace(GetBitContext *s, int n, char *file, const char *func, int line){
914
    int r= get_bits(s, n);
915

916
    print_bin(r, n);
917
    av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d bit @%5d in %s %s:%d\n", r, n, r, get_bits_count(s)-n, file, func, line);
918 919
    return r;
}
920
static inline int get_vlc_trace(GetBitContext *s, VLC_TYPE (*table)[2], int bits, int max_depth, char *file, const char *func, int line){
921 922 923 924 925
    int show= show_bits(s, 24);
    int pos= get_bits_count(s);
    int r= get_vlc2(s, table, bits, max_depth);
    int len= get_bits_count(s) - pos;
    int bits2= show>>(24-len);
926

927
    print_bin(bits2, len);
928

929
    av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d vlc @%5d in %s %s:%d\n", bits2, len, r, pos, file, func, line);
930 931
    return r;
}
932
static inline int get_xbits_trace(GetBitContext *s, int n, char *file, const char *func, int line){
933 934
    int show= show_bits(s, n);
    int r= get_xbits(s, n);
935

936
    print_bin(show, n);
937
    av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d xbt @%5d in %s %s:%d\n", show, n, r, get_bits_count(s)-n, file, func, line);
938 939 940 941 942 943 944 945 946
    return r;
}

#define get_bits(s, n)  get_bits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_bits1(s)    get_bits_trace(s, 1, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_xbits(s, n) get_xbits_trace(s, n, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_vlc(s, vlc)            get_vlc_trace(s, (vlc)->table, (vlc)->bits, 3, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_vlc2(s, tab, bits, max) get_vlc_trace(s, tab, bits, max, __FILE__, __PRETTY_FUNCTION__, __LINE__)

Michel Bardiaux's avatar
Michel Bardiaux committed
947
#define tprintf(p, ...) av_log(p, AV_LOG_DEBUG, __VA_ARGS__)
948 949

#else //TRACE
Michel Bardiaux's avatar
Michel Bardiaux committed
950
#define tprintf(p, ...) {}
951 952
#endif

953
static inline int decode012(GetBitContext *gb){
954 955 956 957 958 959 960 961
    int n;
    n = get_bits1(gb);
    if (n == 0)
        return 0;
    else
        return get_bits1(gb) + 1;
}

962 963 964 965 966 967 968
static inline int decode210(GetBitContext *gb){
    if (get_bits1(gb))
        return 0;
    else
        return 2 - get_bits1(gb);
}

969
#endif /* AVCODEC_BITSTREAM_H */