golomb.h 13.1 KB
Newer Older
1 2 3
/*
 * exp golomb vlc stuff
 * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4
 * Copyright (c) 2004 Alex Beregszaszi
5
 *
6 7 8
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
11
 * version 2.1 of the License, or (at your option) any later version.
12
 *
13
 * FFmpeg is distributed in the hope that it will be useful,
14 15 16 17 18
 * 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
19
 * License along with FFmpeg; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21
 */
22

23
/**
24
 * @file
25
 * @brief
26
 *     exp golomb vlc stuff
27
 * @author Michael Niedermayer <michaelni@gmx.at> and Alex Beregszaszi
28 29
 */

30 31
#ifndef AVCODEC_GOLOMB_H
#define AVCODEC_GOLOMB_H
32

33
#include <stdint.h>
34
#include "get_bits.h"
35
#include "put_bits.h"
36

37 38
#define INVALID_VLC           0x80000000

39 40 41 42 43
extern const uint8_t ff_golomb_vlc_len[512];
extern const uint8_t ff_ue_golomb_vlc_code[512];
extern const  int8_t ff_se_golomb_vlc_code[512];
extern const uint8_t ff_ue_golomb_len[256];

Michael Niedermayer's avatar
Michael Niedermayer committed
44 45 46
extern const uint8_t ff_interleaved_golomb_vlc_len[256];
extern const uint8_t ff_interleaved_ue_golomb_vlc_code[256];
extern const  int8_t ff_interleaved_se_golomb_vlc_code[256];
47
extern const uint8_t ff_interleaved_dirac_golomb_vlc_code[256];
Michael Niedermayer's avatar
Michael Niedermayer committed
48

49

50 51 52 53 54 55
 /**
 * read unsigned exp golomb code.
 */
static inline int get_ue_golomb(GetBitContext *gb){
    unsigned int buf;
    int log;
56

57 58 59
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);
60

61 62 63 64
    if(buf >= (1<<27)){
        buf >>= 32 - 9;
        LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
65

66 67 68 69 70
        return ff_ue_golomb_vlc_code[buf];
    }else{
        log= 2*av_log2(buf) - 31;
        LAST_SKIP_BITS(re, gb, 32 - log);
        CLOSE_READER(re, gb);
71 72 73 74 75 76
        if (CONFIG_FTRAPV && log < 0) {
            av_log(0, AV_LOG_ERROR, "Invalid UE golomb code\n");
            return AVERROR_INVALIDDATA;
        }
        buf>>= log;
        buf--;
77

78 79 80 81
        return buf;
    }
}

82 83 84 85 86 87 88 89 90 91 92 93 94 95
/**
 * Read an unsigned Exp-Golomb code in the range 0 to UINT32_MAX-1.
 */
static inline unsigned get_ue_golomb_long(GetBitContext *gb)
{
    unsigned buf, log;

    buf = show_bits_long(gb, 32);
    log = 31 - av_log2(buf);
    skip_bits_long(gb, log);

    return get_bits_long(gb, log + 1) - 1;
}

96
 /**
97 98
 * read unsigned exp golomb code, constraint to a max of 31.
 * the return value is undefined if the stored value exceeds 31.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
 */
static inline int get_ue_golomb_31(GetBitContext *gb){
    unsigned int buf;

    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);

    buf >>= 32 - 9;
    LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
    CLOSE_READER(re, gb);

    return ff_ue_golomb_vlc_code[buf];
}

114 115
static inline unsigned svq3_get_ue_golomb(GetBitContext *gb)
{
Michael Niedermayer's avatar
Michael Niedermayer committed
116
    uint32_t buf;
117 118 119

    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
Michael Niedermayer's avatar
Michael Niedermayer committed
120
    buf=GET_CACHE(re, gb);
121

Michael Niedermayer's avatar
Michael Niedermayer committed
122 123 124 125
    if(buf&0xAA800000){
        buf >>= 32 - 8;
        LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
126

Michael Niedermayer's avatar
Michael Niedermayer committed
127 128
        return ff_interleaved_ue_golomb_vlc_code[buf];
    }else{
129
        unsigned ret = 1;
130

131
        do {
132 133 134 135 136 137 138 139 140 141 142
            buf >>= 32 - 8;
            LAST_SKIP_BITS(re, gb, FFMIN(ff_interleaved_golomb_vlc_len[buf], 8));

            if (ff_interleaved_golomb_vlc_len[buf] != 9){
                ret <<= (ff_interleaved_golomb_vlc_len[buf] - 1) >> 1;
                ret |= ff_interleaved_dirac_golomb_vlc_code[buf];
                break;
            }
            ret = (ret << 4) | ff_interleaved_dirac_golomb_vlc_code[buf];
            UPDATE_CACHE(re, gb);
            buf = GET_CACHE(re, gb);
143
        } while (ret<0x8000000U && HAVE_BITS_REMAINING(re, gb));
144

Michael Niedermayer's avatar
Michael Niedermayer committed
145
        CLOSE_READER(re, gb);
146
        return ret - 1;
Michael Niedermayer's avatar
Michael Niedermayer committed
147
    }
148 149
}

150 151 152 153
/**
 * read unsigned truncated exp golomb code.
 */
static inline int get_te0_golomb(GetBitContext *gb, int range){
154
    av_assert2(range >= 1);
155

156
    if(range==1)      return 0;
157
    else if(range==2) return get_bits1(gb)^1;
158 159 160 161 162 163 164
    else              return get_ue_golomb(gb);
}

/**
 * read unsigned truncated exp golomb code.
 */
static inline int get_te_golomb(GetBitContext *gb, int range){
165
    av_assert2(range >= 1);
166

167
    if(range==2) return get_bits1(gb)^1;
168 169 170 171 172 173 174 175 176 177
    else         return get_ue_golomb(gb);
}


/**
 * read signed exp golomb code.
 */
static inline int get_se_golomb(GetBitContext *gb){
    unsigned int buf;
    int log;
178

179 180 181
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);
182

183 184 185 186
    if(buf >= (1<<27)){
        buf >>= 32 - 9;
        LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
187

188 189
        return ff_se_golomb_vlc_code[buf];
    }else{
190 191 192 193 194
        log = av_log2(buf);
        LAST_SKIP_BITS(re, gb, 31 - log);
        UPDATE_CACHE(re, gb);
        buf = GET_CACHE(re, gb);

195
        buf>>= log;
196

197 198
        LAST_SKIP_BITS(re, gb, 32 - log);
        CLOSE_READER(re, gb);
199

200 201 202 203 204 205 206
        if(buf&1) buf= -(buf>>1);
        else      buf=  (buf>>1);

        return buf;
    }
}

207 208 209 210 211 212
static inline int svq3_get_se_golomb(GetBitContext *gb){
    unsigned int buf;
    int log;

    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
Michael Niedermayer's avatar
Michael Niedermayer committed
213
    buf=GET_CACHE(re, gb);
214

Michael Niedermayer's avatar
Michael Niedermayer committed
215 216 217 218
    if(buf&0xAA800000){
        buf >>= 32 - 8;
        LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
219

Michael Niedermayer's avatar
Michael Niedermayer committed
220 221
        return ff_interleaved_se_golomb_vlc_code[buf];
    }else{
222 223 224 225
        LAST_SKIP_BITS(re, gb, 8);
        UPDATE_CACHE(re, gb);
        buf |= 1 | (GET_CACHE(re, gb) >> 8);

Michael Niedermayer's avatar
Michael Niedermayer committed
226 227
        if((buf & 0xAAAAAAAA) == 0)
            return INVALID_VLC;
228

Michael Niedermayer's avatar
Michael Niedermayer committed
229 230 231
        for(log=31; (buf & 0x80000000) == 0; log--){
            buf = (buf << 2) - ((buf << log) >> (log - 1)) + (buf >> 30);
        }
232

233
        LAST_SKIP_BITS(re, gb, 63 - 2*log - 8);
Michael Niedermayer's avatar
Michael Niedermayer committed
234
        CLOSE_READER(re, gb);
235

Michael Niedermayer's avatar
Michael Niedermayer committed
236 237
        return (signed) (((((buf << log) >> log) - 1) ^ -(buf & 0x1)) + 1) >> 1;
    }
238 239
}

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
static inline int dirac_get_se_golomb(GetBitContext *gb){
    uint32_t buf;
    uint32_t ret;

    ret = svq3_get_ue_golomb(gb);

    if (ret) {
        OPEN_READER(re, gb);
        UPDATE_CACHE(re, gb);
        buf = SHOW_SBITS(re, gb, 1);
        LAST_SKIP_BITS(re, gb, 1);
        ret = (ret ^ buf) - buf;
        CLOSE_READER(re, gb);
    }

    return ret;
}

Michael Niedermayer's avatar
Michael Niedermayer committed
258
/**
259
 * read unsigned golomb rice code (ffv1).
Michael Niedermayer's avatar
Michael Niedermayer committed
260 261 262 263
 */
static inline int get_ur_golomb(GetBitContext *gb, int k, int limit, int esc_len){
    unsigned int buf;
    int log;
264

Michael Niedermayer's avatar
Michael Niedermayer committed
265 266 267 268 269
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);

    log= av_log2(buf);
270

Michael Niedermayer's avatar
Michael Niedermayer committed
271 272 273 274 275
    if(log > 31-limit){
        buf >>= log - k;
        buf += (30-log)<<k;
        LAST_SKIP_BITS(re, gb, 32 + k - log);
        CLOSE_READER(re, gb);
276

Michael Niedermayer's avatar
Michael Niedermayer committed
277
        return buf;
278
    }else{
279 280 281 282 283 284
        LAST_SKIP_BITS(re, gb, limit);
        UPDATE_CACHE(re, gb);

        buf = SHOW_UBITS(re, gb, esc_len);

        LAST_SKIP_BITS(re, gb, esc_len);
Michael Niedermayer's avatar
Michael Niedermayer committed
285
        CLOSE_READER(re, gb);
286

287 288 289 290 291 292 293 294 295 296
        return buf + limit - 1;
    }
}

/**
 * read unsigned golomb rice code (jpegls).
 */
static inline int get_ur_golomb_jpegls(GetBitContext *gb, int k, int limit, int esc_len){
    unsigned int buf;
    int log;
297

298 299 300 301 302
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);

    log= av_log2(buf);
303

304
    if(log - k >= 32-MIN_CACHE_BITS+(MIN_CACHE_BITS==32) && 32-log < limit){
305 306 307 308
        buf >>= log - k;
        buf += (30-log)<<k;
        LAST_SKIP_BITS(re, gb, 32 + k - log);
        CLOSE_READER(re, gb);
309

310 311 312
        return buf;
    }else{
        int i;
313
        for (i = 0; i < limit && SHOW_UBITS(re, gb, 1) == 0; i++) {
314
            if (gb->size_in_bits <= re_index)
315
                return -1;
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
            LAST_SKIP_BITS(re, gb, 1);
            UPDATE_CACHE(re, gb);
        }
        SKIP_BITS(re, gb, 1);

        if(i < limit - 1){
            if(k){
                buf = SHOW_UBITS(re, gb, k);
                LAST_SKIP_BITS(re, gb, k);
            }else{
                buf=0;
            }

            CLOSE_READER(re, gb);
            return buf + (i<<k);
        }else if(i == limit - 1){
            buf = SHOW_UBITS(re, gb, esc_len);
            LAST_SKIP_BITS(re, gb, esc_len);
            CLOSE_READER(re, gb);
335

336 337 338 339
            return buf + 1;
        }else
            return -1;
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
340 341
}

Michael Niedermayer's avatar
Michael Niedermayer committed
342
/**
343 344
 * read signed golomb rice code (ffv1).
 */
345
static inline int get_sr_golomb(GetBitContext *gb, int k, int limit, int esc_len){
346
    int v= get_ur_golomb(gb, k, limit, esc_len);
347

348 349 350
    v++;
    if (v&1) return v>>1;
    else return -(v>>1);
351

352 353 354
//    return (v>>1) ^ -(v&1);
}

355
/**
356
 * read signed golomb rice code (flac).
Michael Niedermayer's avatar
Michael Niedermayer committed
357 358 359 360 361 362
 */
static inline int get_sr_golomb_flac(GetBitContext *gb, int k, int limit, int esc_len){
    int v= get_ur_golomb_jpegls(gb, k, limit, esc_len);
    return (v>>1) ^ -(v&1);
}

363 364 365 366
/**
 * read unsigned golomb rice code (shorten).
 */
static inline unsigned int get_ur_golomb_shorten(GetBitContext *gb, int k){
367
        return get_ur_golomb_jpegls(gb, k, INT_MAX, 0);
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
}

/**
 * read signed golomb rice code (shorten).
 */
static inline int get_sr_golomb_shorten(GetBitContext* gb, int k)
{
    int uvar = get_ur_golomb_jpegls(gb, k + 1, INT_MAX, 0);
    if (uvar & 1)
        return ~(uvar >> 1);
    else
        return uvar >> 1;
}



384 385
#ifdef TRACE

386 387 388
static inline int get_ue(GetBitContext *s, const char *file, const char *func,
                         int line)
{
389 390 391 392 393
    int show= show_bits(s, 24);
    int pos= get_bits_count(s);
    int i= get_ue_golomb(s);
    int len= get_bits_count(s) - pos;
    int bits= show>>(24-len);
394

395
    print_bin(bits, len);
396

397
    av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d ue  @%5d in %s %s:%d\n", bits, len, i, pos, file, func, line);
398

399 400 401
    return i;
}

402 403 404
static inline int get_se(GetBitContext *s, const char *file, const char *func,
                         int line)
{
405 406 407 408 409
    int show= show_bits(s, 24);
    int pos= get_bits_count(s);
    int i= get_se_golomb(s);
    int len= get_bits_count(s) - pos;
    int bits= show>>(24-len);
410

411
    print_bin(bits, len);
412

413
    av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d se  @%5d in %s %s:%d\n", bits, len, i, pos, file, func, line);
414

415 416 417
    return i;
}

418
static inline int get_te(GetBitContext *s, int r, char *file, const char *func, int line){
419 420 421 422 423
    int show= show_bits(s, 24);
    int pos= get_bits_count(s);
    int i= get_te0_golomb(s, r);
    int len= get_bits_count(s) - pos;
    int bits= show>>(24-len);
424

425
    print_bin(bits, len);
426

427
    av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d te  @%5d in %s %s:%d\n", bits, len, i, pos, file, func, line);
428

429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    return i;
}

#define get_ue_golomb(a) get_ue(a, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_se_golomb(a) get_se(a, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_te_golomb(a, r) get_te(a, r, __FILE__, __PRETTY_FUNCTION__, __LINE__)
#define get_te0_golomb(a, r) get_te(a, r, __FILE__, __PRETTY_FUNCTION__, __LINE__)

#endif

/**
 * write unsigned exp golomb code.
 */
static inline void set_ue_golomb(PutBitContext *pb, int i){
    int e;
444

445
    av_assert2(i>=0);
446 447 448 449 450 451 452 453 454 455 456

#if 0
    if(i=0){
        put_bits(pb, 1, 1);
        return;
    }
#endif
    if(i<256)
        put_bits(pb, ff_ue_golomb_len[i], i+1);
    else{
        e= av_log2(i+1);
457

458 459 460 461 462 463 464 465
        put_bits(pb, 2*e+1, i+1);
    }
}

/**
 * write truncated unsigned exp golomb code.
 */
static inline void set_te_golomb(PutBitContext *pb, int i, int range){
466 467
    av_assert2(range >= 1);
    av_assert2(i<=range);
468

469
    if(range==2) put_bits(pb, 1, i^1);
470 471 472 473
    else         set_ue_golomb(pb, i);
}

/**
474
 * write signed exp golomb code. 16 bits at most.
475 476
 */
static inline void set_se_golomb(PutBitContext *pb, int i){
477
#if 0
478 479 480 481 482 483 484 485 486 487 488
    if(i<=0) i= -2*i;
    else     i=  2*i-1;
#elif 1
    i= 2*i-1;
    if(i<0) i^= -1; //FIXME check if gcc does the right thing
#else
    i= 2*i-1;
    i^= (i>>31);
#endif
    set_ue_golomb(pb, i);
}
Michael Niedermayer's avatar
Michael Niedermayer committed
489 490

/**
491
 * write unsigned golomb rice code (ffv1).
Michael Niedermayer's avatar
Michael Niedermayer committed
492 493 494
 */
static inline void set_ur_golomb(PutBitContext *pb, int i, int k, int limit, int esc_len){
    int e;
495

496
    av_assert2(i>=0);
497

Michael Niedermayer's avatar
Michael Niedermayer committed
498 499 500 501
    e= i>>k;
    if(e<limit){
        put_bits(pb, e + k + 1, (1<<k) + (i&((1<<k)-1)));
    }else{
502 503 504 505 506 507 508 509 510
        put_bits(pb, limit + esc_len, i - limit + 1);
    }
}

/**
 * write unsigned golomb rice code (jpegls).
 */
static inline void set_ur_golomb_jpegls(PutBitContext *pb, int i, int k, int limit, int esc_len){
    int e;
511

512
    av_assert2(i>=0);
513

514 515
    e= (i>>k) + 1;
    if(e<limit){
516 517 518 519
        while(e > 31) {
            put_bits(pb, 31, 0);
            e -= 31;
        }
520
        put_bits(pb, e, 1);
Michael Niedermayer's avatar
Michael Niedermayer committed
521
        if(k)
522
            put_sbits(pb, k, i);
523
    }else{
524 525 526 527
        while(limit > 31) {
            put_bits(pb, 31, 0);
            limit -= 31;
        }
528 529
        put_bits(pb, limit  , 1);
        put_bits(pb, esc_len, i - 1);
Michael Niedermayer's avatar
Michael Niedermayer committed
530 531
    }
}
532 533 534 535

/**
 * write signed golomb rice code (ffv1).
 */
536
static inline void set_sr_golomb(PutBitContext *pb, int i, int k, int limit, int esc_len){
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
    int v;

    v = -2*i-1;
    v ^= (v>>31);

    set_ur_golomb(pb, v, k, limit, esc_len);
}

/**
 * write signed golomb rice code (flac).
 */
static inline void set_sr_golomb_flac(PutBitContext *pb, int i, int k, int limit, int esc_len){
    int v;

    v = -2*i-1;
    v ^= (v>>31);

    set_ur_golomb_jpegls(pb, v, k, limit, esc_len);
}
556

557
#endif /* AVCODEC_GOLOMB_H */