git.sesse.net Git - ffmpeg/blob - libavcodec/golomb.h

   1 /*
   2  * exp golomb vlc stuff
   3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
   4  * Copyright (c) 2004 Alex Beregszaszi
   5  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * 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  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * 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 #ifndef AVCODEC_GOLOMB_H
  31 #define AVCODEC_GOLOMB_H
  32
  33 #include <stdint.h>
  34
  35 #include "get_bits.h"
  36 #include "put_bits.h"
  37
  38 #define INVALID_VLC           0x80000000
  39
  40 extern const uint8_t ff_golomb_vlc_len[512];
  41 extern const uint8_t ff_ue_golomb_vlc_code[512];
  42 extern const  int8_t ff_se_golomb_vlc_code[512];
  43 extern const uint8_t ff_ue_golomb_len[256];
  44
  45 extern const uint8_t ff_interleaved_golomb_vlc_len[256];
  46 extern const uint8_t ff_interleaved_ue_golomb_vlc_code[256];
  47 extern const  int8_t ff_interleaved_se_golomb_vlc_code[256];
  48 extern const uint8_t ff_interleaved_dirac_golomb_vlc_code[256];
  49
  50 /**
  51  * read unsigned exp golomb code.
  52  */
  53 static inline int get_ue_golomb(GetBitContext *gb)
  54 {
  55     unsigned int buf;
  56
  57     OPEN_READER(re, gb);
  58     UPDATE_CACHE(re, gb);
  59     buf = GET_CACHE(re, gb);
  60
  61     if (buf >= (1 << 27)) {
  62         buf >>= 32 - 9;
  63         LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
  64         CLOSE_READER(re, gb);
  65
  66         return ff_ue_golomb_vlc_code[buf];
  67     } else {
  68         int log = 2 * av_log2(buf) - 31;
  69         LAST_SKIP_BITS(re, gb, 32 - log);
  70         CLOSE_READER(re, gb);
  71         if (CONFIG_FTRAPV && log < 0) {
  72             av_log(NULL, AV_LOG_ERROR, "Invalid UE golomb code\n");
  73             return AVERROR_INVALIDDATA;
  74         }
  75         buf >>= log;
  76         buf--;
  77
  78         return buf;
  79     }
  80 }
  81
  82 /**
  83  * Read an unsigned Exp-Golomb code in the range 0 to UINT32_MAX-1.
  84  */
  85 static inline unsigned get_ue_golomb_long(GetBitContext *gb)
  86 {
  87     unsigned buf, log;
  88
  89     buf = show_bits_long(gb, 32);
  90     log = 31 - av_log2(buf);
  91     skip_bits_long(gb, log);
  92
  93     return get_bits_long(gb, log + 1) - 1;
  94 }
  95
  96 /**
  97  * read unsigned exp golomb code, constraint to a max of 31.
  98  * the return value is undefined if the stored value exceeds 31.
  99  */
 100 static inline int get_ue_golomb_31(GetBitContext *gb)
 101 {
 102     unsigned int buf;
 103
 104     OPEN_READER(re, gb);
 105     UPDATE_CACHE(re, gb);
 106     buf = GET_CACHE(re, gb);
 107
 108     buf >>= 32 - 9;
 109     LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
 110     CLOSE_READER(re, gb);
 111
 112     return ff_ue_golomb_vlc_code[buf];
 113 }
 114
 115 static inline unsigned svq3_get_ue_golomb(GetBitContext *gb)
 116 {
 117     uint32_t buf;
 118
 119     OPEN_READER(re, gb);
 120     UPDATE_CACHE(re, gb);
 121     buf = GET_CACHE(re, gb);
 122
 123     if (buf & 0xAA800000) {
 124         buf >>= 32 - 8;
 125         LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
 126         CLOSE_READER(re, gb);
 127
 128         return ff_interleaved_ue_golomb_vlc_code[buf];
 129     } else {
 130         unsigned ret = 1;
 131
 132         do {
 133             buf >>= 32 - 8;
 134             LAST_SKIP_BITS(re, gb,
 135                            FFMIN(ff_interleaved_golomb_vlc_len[buf], 8));
 136
 137             if (ff_interleaved_golomb_vlc_len[buf] != 9) {
 138                 ret <<= (ff_interleaved_golomb_vlc_len[buf] - 1) >> 1;
 139                 ret  |= ff_interleaved_dirac_golomb_vlc_code[buf];
 140                 break;
 141             }
 142             ret = (ret << 4) | ff_interleaved_dirac_golomb_vlc_code[buf];
 143             UPDATE_CACHE(re, gb);
 144             buf = GET_CACHE(re, gb);
 145         } while (ret<0x8000000U && BITS_AVAILABLE(re, gb));
 146
 147         CLOSE_READER(re, gb);
 148         return ret - 1;
 149     }
 150 }
 151
 152 /**
 153  * read unsigned truncated exp golomb code.
 154  */
 155 static inline int get_te0_golomb(GetBitContext *gb, int range)
 156 {
 157     av_assert2(range >= 1);
 158
 159     if (range == 1)
 160         return 0;
 161     else if (range == 2)
 162         return get_bits1(gb) ^ 1;
 163     else
 164         return get_ue_golomb(gb);
 165 }
 166
 167 /**
 168  * read unsigned truncated exp golomb code.
 169  */
 170 static inline int get_te_golomb(GetBitContext *gb, int range)
 171 {
 172     av_assert2(range >= 1);
 173
 174     if (range == 2)
 175         return get_bits1(gb) ^ 1;
 176     else
 177         return get_ue_golomb(gb);
 178 }
 179
 180 /**
 181  * read signed exp golomb code.
 182  */
 183 static inline int get_se_golomb(GetBitContext *gb)
 184 {
 185     unsigned int buf;
 186
 187     OPEN_READER(re, gb);
 188     UPDATE_CACHE(re, gb);
 189     buf = GET_CACHE(re, gb);
 190
 191     if (buf >= (1 << 27)) {
 192         buf >>= 32 - 9;
 193         LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
 194         CLOSE_READER(re, gb);
 195
 196         return ff_se_golomb_vlc_code[buf];
 197     } else {
 198         int log = av_log2(buf), sign;
 199         LAST_SKIP_BITS(re, gb, 31 - log);
 200         UPDATE_CACHE(re, gb);
 201         buf = GET_CACHE(re, gb);
 202
 203         buf >>= log;
 204
 205         LAST_SKIP_BITS(re, gb, 32 - log);
 206         CLOSE_READER(re, gb);
 207
 208         sign = -(buf & 1);
 209         buf  = ((buf >> 1) ^ sign) - sign;
 210
 211         return buf;
 212     }
 213 }
 214
 215 static inline int get_se_golomb_long(GetBitContext *gb)
 216 {
 217     unsigned int buf = get_ue_golomb_long(gb);
 218     int sign = (buf & 1) - 1;
 219     return ((buf >> 1) ^ sign) + 1;
 220 }
 221
 222 static inline int svq3_get_se_golomb(GetBitContext *gb)
 223 {
 224     unsigned int buf;
 225
 226     OPEN_READER(re, gb);
 227     UPDATE_CACHE(re, gb);
 228     buf = GET_CACHE(re, gb);
 229
 230     if (buf & 0xAA800000) {
 231         buf >>= 32 - 8;
 232         LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
 233         CLOSE_READER(re, gb);
 234
 235         return ff_interleaved_se_golomb_vlc_code[buf];
 236     } else {
 237         int log;
 238         LAST_SKIP_BITS(re, gb, 8);
 239         UPDATE_CACHE(re, gb);
 240         buf |= 1 | (GET_CACHE(re, gb) >> 8);
 241
 242         if ((buf & 0xAAAAAAAA) == 0)
 243             return INVALID_VLC;
 244
 245         for (log = 31; (buf & 0x80000000) == 0; log--)
 246             buf = (buf << 2) - ((buf << log) >> (log - 1)) + (buf >> 30);
 247
 248         LAST_SKIP_BITS(re, gb, 63 - 2 * log - 8);
 249         CLOSE_READER(re, gb);
 250
 251         return (signed) (((((buf << log) >> log) - 1) ^ -(buf & 0x1)) + 1) >> 1;
 252     }
 253 }
 254
 255 static inline int dirac_get_se_golomb(GetBitContext *gb)
 256 {
 257     uint32_t ret = svq3_get_ue_golomb(gb);
 258
 259     if (ret) {
 260         int sign = -get_bits1(gb);
 261         ret = (ret ^ sign) - sign;
 262     }
 263
 264     return ret;
 265 }
 266
 267 /**
 268  * read unsigned golomb rice code (ffv1).
 269  */
 270 static inline int get_ur_golomb(GetBitContext *gb, int k, int limit,
 271                                 int esc_len)
 272 {
 273     unsigned int buf;
 274     int log;
 275
 276     OPEN_READER(re, gb);
 277     UPDATE_CACHE(re, gb);
 278     buf = GET_CACHE(re, gb);
 279
 280     log = av_log2(buf);
 281
 282     if (log > 31 - limit) {
 283         buf >>= log - k;
 284         buf  += (30U - log) << k;
 285         LAST_SKIP_BITS(re, gb, 32 + k - log);
 286         CLOSE_READER(re, gb);
 287
 288         return buf;
 289     } else {
 290         LAST_SKIP_BITS(re, gb, limit);
 291         UPDATE_CACHE(re, gb);
 292
 293         buf = SHOW_UBITS(re, gb, esc_len);
 294
 295         LAST_SKIP_BITS(re, gb, esc_len);
 296         CLOSE_READER(re, gb);
 297
 298         return buf + limit - 1;
 299     }
 300 }
 301
 302 /**
 303  * read unsigned golomb rice code (jpegls).
 304  */
 305 static inline int get_ur_golomb_jpegls(GetBitContext *gb, int k, int limit,
 306                                        int esc_len)
 307 {
 308     unsigned int buf;
 309     int log;
 310
 311     OPEN_READER(re, gb);
 312     UPDATE_CACHE(re, gb);
 313     buf = GET_CACHE(re, gb);
 314
 315     log = av_log2(buf);
 316
 317     if (log - k >= 32 - MIN_CACHE_BITS + (MIN_CACHE_BITS == 32) &&
 318         32 - log < limit) {
 319         buf >>= log - k;
 320         buf  += (30U - log) << k;
 321         LAST_SKIP_BITS(re, gb, 32 + k - log);
 322         CLOSE_READER(re, gb);
 323
 324         return buf;
 325     } else {
 326         int i;
 327         for (i = 0; i < limit && SHOW_UBITS(re, gb, 1) == 0; i++) {
 328             if (gb->size_in_bits <= re_index)
 329                 return -1;
 330             LAST_SKIP_BITS(re, gb, 1);
 331             UPDATE_CACHE(re, gb);
 332         }
 333         SKIP_BITS(re, gb, 1);
 334
 335         if (i < limit - 1) {
 336             if (k) {
 337                 buf = SHOW_UBITS(re, gb, k);
 338                 LAST_SKIP_BITS(re, gb, k);
 339             } else {
 340                 buf = 0;
 341             }
 342
 343             CLOSE_READER(re, gb);
 344             return buf + (i << k);
 345         } else if (i == limit - 1) {
 346             buf = SHOW_UBITS(re, gb, esc_len);
 347             LAST_SKIP_BITS(re, gb, esc_len);
 348             CLOSE_READER(re, gb);
 349
 350             return buf + 1;
 351         } else
 352             return -1;
 353     }
 354 }
 355
 356 /**
 357  * read signed golomb rice code (ffv1).
 358  */
 359 static inline int get_sr_golomb(GetBitContext *gb, int k, int limit,
 360                                 int esc_len)
 361 {
 362     int v = get_ur_golomb(gb, k, limit, esc_len);
 363     return (v >> 1) ^ -(v & 1);
 364 }
 365
 366 /**
 367  * read signed golomb rice code (flac).
 368  */
 369 static inline int get_sr_golomb_flac(GetBitContext *gb, int k, int limit,
 370                                      int esc_len)
 371 {
 372     int v = get_ur_golomb_jpegls(gb, k, limit, esc_len);
 373     return (v >> 1) ^ -(v & 1);
 374 }
 375
 376 /**
 377  * read unsigned golomb rice code (shorten).
 378  */
 379 static inline unsigned int get_ur_golomb_shorten(GetBitContext *gb, int k)
 380 {
 381     return get_ur_golomb_jpegls(gb, k, INT_MAX, 0);
 382 }
 383
 384 /**
 385  * read signed golomb rice code (shorten).
 386  */
 387 static inline int get_sr_golomb_shorten(GetBitContext *gb, int k)
 388 {
 389     int uvar = get_ur_golomb_jpegls(gb, k + 1, INT_MAX, 0);
 390     return (uvar >> 1) ^ -(uvar & 1);
 391 }
 392
 393 #ifdef TRACE
 394
 395 static inline int get_ue(GetBitContext *s, const char *file, const char *func,
 396                          int line)
 397 {
 398     int show = show_bits(s, 24);
 399     int pos  = get_bits_count(s);
 400     int i    = get_ue_golomb(s);
 401     int len  = get_bits_count(s) - pos;
 402     int bits = show >> (24 - len);
 403
 404     print_bin(bits, len);
 405
 406     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d ue  @%5d in %s %s:%d\n",
 407            bits, len, i, pos, file, func, line);
 408
 409     return i;
 410 }
 411
 412 static inline int get_se(GetBitContext *s, const char *file, const char *func,
 413                          int line)
 414 {
 415     int show = show_bits(s, 24);
 416     int pos  = get_bits_count(s);
 417     int i    = get_se_golomb(s);
 418     int len  = get_bits_count(s) - pos;
 419     int bits = show >> (24 - len);
 420
 421     print_bin(bits, len);
 422
 423     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d se  @%5d in %s %s:%d\n",
 424            bits, len, i, pos, file, func, line);
 425
 426     return i;
 427 }
 428
 429 static inline int get_te(GetBitContext *s, int r, char *file, const char *func,
 430                          int line)
 431 {
 432     int show = show_bits(s, 24);
 433     int pos  = get_bits_count(s);
 434     int i    = get_te0_golomb(s, r);
 435     int len  = get_bits_count(s) - pos;
 436     int bits = show >> (24 - len);
 437
 438     print_bin(bits, len);
 439
 440     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d te  @%5d in %s %s:%d\n",
 441            bits, len, i, pos, file, func, line);
 442
 443     return i;
 444 }
 445
 446 #define get_ue_golomb(a) get_ue(a, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 447 #define get_se_golomb(a) get_se(a, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 448 #define get_te_golomb(a, r)  get_te(a, r, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 449 #define get_te0_golomb(a, r) get_te(a, r, __FILE__, __PRETTY_FUNCTION__, __LINE__)
 450
 451 #endif /* TRACE */
 452
 453 /**
 454  * write unsigned exp golomb code.
 455  */
 456 static inline void set_ue_golomb(PutBitContext *pb, int i)
 457 {
 458     av_assert2(i >= 0);
 459
 460 #if 0
 461     if (i = 0) {
 462         put_bits(pb, 1, 1);
 463         return;
 464     }
 465 #endif
 466     if (i < 256)
 467         put_bits(pb, ff_ue_golomb_len[i], i + 1);
 468     else {
 469         int e = av_log2(i + 1);
 470         put_bits(pb, 2 * e + 1, i + 1);
 471     }
 472 }
 473
 474 /**
 475  * write truncated unsigned exp golomb code.
 476  */
 477 static inline void set_te_golomb(PutBitContext *pb, int i, int range)
 478 {
 479     av_assert2(range >= 1);
 480     av_assert2(i <= range);
 481
 482     if (range == 2)
 483         put_bits(pb, 1, i ^ 1);
 484     else
 485         set_ue_golomb(pb, i);
 486 }
 487
 488 /**
 489  * write signed exp golomb code. 16 bits at most.
 490  */
 491 static inline void set_se_golomb(PutBitContext *pb, int i)
 492 {
 493 #if 0
 494     if (i <= 0)
 495         i = -2 * i;
 496     else
 497         i = 2 * i - 1;
 498 #elif 1
 499     i = 2 * i - 1;
 500     if (i < 0)
 501         i ^= -1;    //FIXME check if gcc does the right thing
 502 #else
 503     i  = 2 * i - 1;
 504     i ^= (i >> 31);
 505 #endif
 506     set_ue_golomb(pb, i);
 507 }
 508
 509 /**
 510  * write unsigned golomb rice code (ffv1).
 511  */
 512 static inline void set_ur_golomb(PutBitContext *pb, int i, int k, int limit,
 513                                  int esc_len)
 514 {
 515     int e;
 516
 517     av_assert2(i >= 0);
 518
 519     e = i >> k;
 520     if (e < limit)
 521         put_bits(pb, e + k + 1, (1 << k) + av_mod_uintp2(i, k));
 522     else
 523         put_bits(pb, limit + esc_len, i - limit + 1);
 524 }
 525
 526 /**
 527  * write unsigned golomb rice code (jpegls).
 528  */
 529 static inline void set_ur_golomb_jpegls(PutBitContext *pb, int i, int k,
 530                                         int limit, int esc_len)
 531 {
 532     int e;
 533
 534     av_assert2(i >= 0);
 535
 536     e = (i >> k) + 1;
 537     if (e < limit) {
 538         while (e > 31) {
 539             put_bits(pb, 31, 0);
 540             e -= 31;
 541         }
 542         put_bits(pb, e, 1);
 543         if (k)
 544             put_sbits(pb, k, i);
 545     } else {
 546         while (limit > 31) {
 547             put_bits(pb, 31, 0);
 548             limit -= 31;
 549         }
 550         put_bits(pb, limit, 1);
 551         put_bits(pb, esc_len, i - 1);
 552     }
 553 }
 554
 555 /**
 556  * write signed golomb rice code (ffv1).
 557  */
 558 static inline void set_sr_golomb(PutBitContext *pb, int i, int k, int limit,
 559                                  int esc_len)
 560 {
 561     int v;
 562
 563     v  = -2 * i - 1;
 564     v ^= (v >> 31);
 565
 566     set_ur_golomb(pb, v, k, limit, esc_len);
 567 }
 568
 569 /**
 570  * write signed golomb rice code (flac).
 571  */
 572 static inline void set_sr_golomb_flac(PutBitContext *pb, int i, int k,
 573                                       int limit, int esc_len)
 574 {
 575     int v;
 576
 577     v  = -2 * i - 1;
 578     v ^= (v >> 31);
 579
 580     set_ur_golomb_jpegls(pb, v, k, limit, esc_len);
 581 }
 582
 583 #endif /* AVCODEC_GOLOMB_H */