golomb.h 12.8 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
 * This file is part of Libav.
7
 *
8
 * Libav 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
 * Libav 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 Libav; 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 71 72
        return ff_ue_golomb_vlc_code[buf];
    }else{
        log= 2*av_log2(buf) - 31;
        buf>>= log;
        buf--;
        LAST_SKIP_BITS(re, gb, 32 - log);
        CLOSE_READER(re, gb);
73

74 75 76 77
        return buf;
    }
}

78 79 80 81 82 83 84 85 86 87 88 89 90 91
/**
 * 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;
}

92
 /**
93 94
 * read unsigned exp golomb code, constraint to a max of 31.
 * the return value is undefined if the stored value exceeds 31.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
 */
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];
}

110
static inline int svq3_get_ue_golomb(GetBitContext *gb){
Michael Niedermayer's avatar
Michael Niedermayer committed
111
    uint32_t buf;
112 113 114

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

Michael Niedermayer's avatar
Michael Niedermayer committed
117 118 119 120
    if(buf&0xAA800000){
        buf >>= 32 - 8;
        LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
121

Michael Niedermayer's avatar
Michael Niedermayer committed
122 123
        return ff_interleaved_ue_golomb_vlc_code[buf];
    }else{
124 125
        int ret = 1;

126
        do {
127 128 129 130 131 132 133 134 135 136 137
            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);
138
        } while (HAVE_BITS_REMAINING(re, gb));
139

Michael Niedermayer's avatar
Michael Niedermayer committed
140
        CLOSE_READER(re, gb);
141
        return ret - 1;
Michael Niedermayer's avatar
Michael Niedermayer committed
142
    }
143 144
}

145 146 147 148 149
/**
 * read unsigned truncated exp golomb code.
 */
static inline int get_te0_golomb(GetBitContext *gb, int range){
    assert(range >= 1);
150

151
    if(range==1)      return 0;
152
    else if(range==2) return get_bits1(gb)^1;
153 154 155 156 157 158 159 160
    else              return get_ue_golomb(gb);
}

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

162
    if(range==2) return get_bits1(gb)^1;
163 164 165 166 167 168 169 170 171 172
    else         return get_ue_golomb(gb);
}


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

174 175 176
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);
177

178 179 180 181
    if(buf >= (1<<27)){
        buf >>= 32 - 9;
        LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
182

183 184 185 186
        return ff_se_golomb_vlc_code[buf];
    }else{
        log= 2*av_log2(buf) - 31;
        buf>>= log;
187

188 189
        LAST_SKIP_BITS(re, gb, 32 - log);
        CLOSE_READER(re, gb);
190

191 192 193 194 195 196 197
        if(buf&1) buf= -(buf>>1);
        else      buf=  (buf>>1);

        return buf;
    }
}

198 199 200 201 202 203
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
204
    buf=GET_CACHE(re, gb);
205

Michael Niedermayer's avatar
Michael Niedermayer committed
206 207 208 209
    if(buf&0xAA800000){
        buf >>= 32 - 8;
        LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
        CLOSE_READER(re, gb);
210

Michael Niedermayer's avatar
Michael Niedermayer committed
211 212
        return ff_interleaved_se_golomb_vlc_code[buf];
    }else{
213 214 215 216
        LAST_SKIP_BITS(re, gb, 8);
        UPDATE_CACHE(re, gb);
        buf |= 1 | (GET_CACHE(re, gb) >> 8);

Michael Niedermayer's avatar
Michael Niedermayer committed
217 218
        if((buf & 0xAAAAAAAA) == 0)
            return INVALID_VLC;
219

Michael Niedermayer's avatar
Michael Niedermayer committed
220 221 222
        for(log=31; (buf & 0x80000000) == 0; log--){
            buf = (buf << 2) - ((buf << log) >> (log - 1)) + (buf >> 30);
        }
223

224
        LAST_SKIP_BITS(re, gb, 63 - 2*log - 8);
Michael Niedermayer's avatar
Michael Niedermayer committed
225
        CLOSE_READER(re, gb);
226

Michael Niedermayer's avatar
Michael Niedermayer committed
227 228
        return (signed) (((((buf << log) >> log) - 1) ^ -(buf & 0x1)) + 1) >> 1;
    }
229 230
}

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
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
249
/**
250
 * read unsigned golomb rice code (ffv1).
Michael Niedermayer's avatar
Michael Niedermayer committed
251 252 253 254
 */
static inline int get_ur_golomb(GetBitContext *gb, int k, int limit, int esc_len){
    unsigned int buf;
    int log;
255

Michael Niedermayer's avatar
Michael Niedermayer committed
256 257 258 259 260
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);

    log= av_log2(buf);
261

Michael Niedermayer's avatar
Michael Niedermayer committed
262 263 264 265 266
    if(log > 31-limit){
        buf >>= log - k;
        buf += (30-log)<<k;
        LAST_SKIP_BITS(re, gb, 32 + k - log);
        CLOSE_READER(re, gb);
267

Michael Niedermayer's avatar
Michael Niedermayer committed
268
        return buf;
269
    }else{
270 271 272 273 274 275
        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
276
        CLOSE_READER(re, gb);
277

278 279 280 281 282 283 284 285 286 287
        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;
288

289 290 291 292 293
    OPEN_READER(re, gb);
    UPDATE_CACHE(re, gb);
    buf=GET_CACHE(re, gb);

    log= av_log2(buf);
294

295
    if(log - k >= 32-MIN_CACHE_BITS+(MIN_CACHE_BITS==32) && 32-log < limit){
296 297 298 299
        buf >>= log - k;
        buf += (30-log)<<k;
        LAST_SKIP_BITS(re, gb, 32 + k - log);
        CLOSE_READER(re, gb);
300

301 302 303
        return buf;
    }else{
        int i;
304
        for (i = 0; i < limit && SHOW_UBITS(re, gb, 1) == 0 && HAVE_BITS_REMAINING(re, gb); i++) {
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
            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);
324

325 326 327 328
            return buf + 1;
        }else
            return -1;
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
329 330
}

Michael Niedermayer's avatar
Michael Niedermayer committed
331
/**
332 333
 * read signed golomb rice code (ffv1).
 */
334
static inline int get_sr_golomb(GetBitContext *gb, int k, int limit, int esc_len){
335
    int v= get_ur_golomb(gb, k, limit, esc_len);
336

337 338 339
    v++;
    if (v&1) return v>>1;
    else return -(v>>1);
340

341 342 343
//    return (v>>1) ^ -(v&1);
}

344
/**
345
 * read signed golomb rice code (flac).
Michael Niedermayer's avatar
Michael Niedermayer committed
346 347 348 349 350 351
 */
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);
}

352 353 354 355
/**
 * read unsigned golomb rice code (shorten).
 */
static inline unsigned int get_ur_golomb_shorten(GetBitContext *gb, int k){
356
        return get_ur_golomb_jpegls(gb, k, INT_MAX, 0);
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
}

/**
 * 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;
}



373 374
#ifdef TRACE

375 376 377
static inline int get_ue(GetBitContext *s, const char *file, const char *func,
                         int line)
{
378 379 380 381 382
    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);
383

384
    print_bin(bits, len);
385

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

388 389 390
    return i;
}

391 392 393
static inline int get_se(GetBitContext *s, const char *file, const char *func,
                         int line)
{
394 395 396 397 398
    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);
399

400
    print_bin(bits, len);
401

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

404 405 406
    return i;
}

407
static inline int get_te(GetBitContext *s, int r, char *file, const char *func, int line){
408 409 410 411 412
    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);
413

414
    print_bin(bits, len);
415

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

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    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;
433

434 435 436 437 438 439 440 441 442 443 444 445
    assert(i>=0);

#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);
446

447 448 449 450 451 452 453 454 455 456 457
        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){
    assert(range >= 1);
    assert(i<=range);

458
    if(range==2) put_bits(pb, 1, i^1);
459 460 461 462
    else         set_ue_golomb(pb, i);
}

/**
463
 * write signed exp golomb code. 16 bits at most.
464 465
 */
static inline void set_se_golomb(PutBitContext *pb, int i){
466
#if 0
467 468 469 470 471 472 473 474 475 476 477
    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
478 479

/**
480
 * write unsigned golomb rice code (ffv1).
Michael Niedermayer's avatar
Michael Niedermayer committed
481 482 483
 */
static inline void set_ur_golomb(PutBitContext *pb, int i, int k, int limit, int esc_len){
    int e;
484

Michael Niedermayer's avatar
Michael Niedermayer committed
485
    assert(i>=0);
486

Michael Niedermayer's avatar
Michael Niedermayer committed
487 488 489 490
    e= i>>k;
    if(e<limit){
        put_bits(pb, e + k + 1, (1<<k) + (i&((1<<k)-1)));
    }else{
491 492 493 494 495 496 497 498 499
        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;
500

501
    assert(i>=0);
502

503 504
    e= (i>>k) + 1;
    if(e<limit){
505 506 507 508
        while(e > 31) {
            put_bits(pb, 31, 0);
            e -= 31;
        }
509
        put_bits(pb, e, 1);
Michael Niedermayer's avatar
Michael Niedermayer committed
510
        if(k)
511
            put_sbits(pb, k, i);
512
    }else{
513 514 515 516
        while(limit > 31) {
            put_bits(pb, 31, 0);
            limit -= 31;
        }
517 518
        put_bits(pb, limit  , 1);
        put_bits(pb, esc_len, i - 1);
Michael Niedermayer's avatar
Michael Niedermayer committed
519 520
    }
}
521 522 523 524

/**
 * write signed golomb rice code (ffv1).
 */
525
static inline void set_sr_golomb(PutBitContext *pb, int i, int k, int limit, int esc_len){
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
    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);
}
545

546
#endif /* AVCODEC_GOLOMB_H */