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 an unsigned Exp-Golomb code in the range 0 to 8190.
  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 (log < 7) {
  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 get_interleaved_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 get_interleaved_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 = get_interleaved_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     av_assert2(k <= 31);
 318
 319     if (log - k >= 32 - MIN_CACHE_BITS + (MIN_CACHE_BITS == 32) &&
 320         32 - log < limit) {
 321         buf >>= log - k;
 322         buf  += (30U - log) << k;
 323         LAST_SKIP_BITS(re, gb, 32 + k - log);
 324         CLOSE_READER(re, gb);
 325
 326         return buf;
 327     } else {
 328         int i;
 329         for (i = 0; i < limit && SHOW_UBITS(re, gb, 1) == 0; i++) {
 330             if (gb->size_in_bits <= re_index) {
 331                 CLOSE_READER(re, gb);
 332                 return -1;
 333             }
 334             LAST_SKIP_BITS(re, gb, 1);
 335             UPDATE_CACHE(re, gb);
 336         }
 337         SKIP_BITS(re, gb, 1);
 338
 339         if (i < limit - 1) {
 340             if (k) {
 341                 if (k > MIN_CACHE_BITS - 1) {
 342                     buf = SHOW_UBITS(re, gb, 16) << (k-16);
 343                     LAST_SKIP_BITS(re, gb, 16);
 344                     UPDATE_CACHE(re, gb);
 345                     buf |= SHOW_UBITS(re, gb, k-16);
 346                     LAST_SKIP_BITS(re, gb, k-16);
 347                 } else {
 348                     buf = SHOW_UBITS(re, gb, k);
 349                     LAST_SKIP_BITS(re, gb, k);
 350                 }
 351             } else {
 352                 buf = 0;
 353             }
 354
 355             buf += ((SUINT)i << k);
 356         } else if (i == limit - 1) {
 357             buf = SHOW_UBITS(re, gb, esc_len);
 358             LAST_SKIP_BITS(re, gb, esc_len);
 359
 360             buf ++;
 361         } else {
 362             buf = -1;
 363         }
 364         CLOSE_READER(re, gb);
 365         return buf;
 366     }
 367 }
 368
 369 /**
 370  * read signed golomb rice code (ffv1).
 371  */
 372 static inline int get_sr_golomb(GetBitContext *gb, int k, int limit,
 373                                 int esc_len)
 374 {
 375     unsigned v = get_ur_golomb(gb, k, limit, esc_len);
 376     return (v >> 1) ^ -(v & 1);
 377 }
 378
 379 /**
 380  * read signed golomb rice code (flac).
 381  */
 382 static inline int get_sr_golomb_flac(GetBitContext *gb, int k, int limit,
 383                                      int esc_len)
 384 {
 385     unsigned v = get_ur_golomb_jpegls(gb, k, limit, esc_len);
 386     return (v >> 1) ^ -(v & 1);
 387 }
 388
 389 /**
 390  * read unsigned golomb rice code (shorten).
 391  */
 392 static inline unsigned int get_ur_golomb_shorten(GetBitContext *gb, int k)
 393 {
 394     return get_ur_golomb_jpegls(gb, k, INT_MAX, 0);
 395 }
 396
 397 /**
 398  * read signed golomb rice code (shorten).
 399  */
 400 static inline int get_sr_golomb_shorten(GetBitContext *gb, int k)
 401 {
 402     int uvar = get_ur_golomb_jpegls(gb, k + 1, INT_MAX, 0);
 403     return (uvar >> 1) ^ -(uvar & 1);
 404 }
 405
 406 #ifdef TRACE
 407
 408 static inline int get_ue(GetBitContext *s, const char *file, const char *func,
 409                          int line)
 410 {
 411     int show = show_bits(s, 24);
 412     int pos  = get_bits_count(s);
 413     int i    = get_ue_golomb(s);
 414     int len  = get_bits_count(s) - pos;
 415     int bits = show >> (24 - len);
 416
 417     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d ue  @%5d in %s %s:%d\n",
 418            bits, len, i, pos, file, func, line);
 419
 420     return i;
 421 }
 422
 423 static inline int get_se(GetBitContext *s, const char *file, const char *func,
 424                          int line)
 425 {
 426     int show = show_bits(s, 24);
 427     int pos  = get_bits_count(s);
 428     int i    = get_se_golomb(s);
 429     int len  = get_bits_count(s) - pos;
 430     int bits = show >> (24 - len);
 431
 432     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d se  @%5d in %s %s:%d\n",
 433            bits, len, i, pos, file, func, line);
 434
 435     return i;
 436 }
 437
 438 static inline int get_te(GetBitContext *s, int r, char *file, const char *func,
 439                          int line)
 440 {
 441     int show = show_bits(s, 24);
 442     int pos  = get_bits_count(s);
 443     int i    = get_te0_golomb(s, r);
 444     int len  = get_bits_count(s) - pos;
 445     int bits = show >> (24 - len);
 446
 447     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d te  @%5d in %s %s:%d\n",
 448            bits, len, i, pos, file, func, line);
 449
 450     return i;
 451 }
 452
 453 #define get_ue_golomb(a) get_ue(a, __FILE__, __func__, __LINE__)
 454 #define get_se_golomb(a) get_se(a, __FILE__, __func__, __LINE__)
 455 #define get_te_golomb(a, r)  get_te(a, r, __FILE__, __func__, __LINE__)
 456 #define get_te0_golomb(a, r) get_te(a, r, __FILE__, __func__, __LINE__)
 457
 458 #endif /* TRACE */
 459
 460 /**
 461  * write unsigned exp golomb code.
 462  */
 463 static inline void set_ue_golomb(PutBitContext *pb, int i)
 464 {
 465     av_assert2(i >= 0);
 466
 467     if (i < 256)
 468         put_bits(pb, ff_ue_golomb_len[i], i + 1);
 469     else {
 470         int e = av_log2(i + 1);
 471         put_bits(pb, 2 * e + 1, i + 1);
 472     }
 473 }
 474
 475 /**
 476  * write truncated unsigned exp golomb code.
 477  */
 478 static inline void set_te_golomb(PutBitContext *pb, int i, int range)
 479 {
 480     av_assert2(range >= 1);
 481     av_assert2(i <= range);
 482
 483     if (range == 2)
 484         put_bits(pb, 1, i ^ 1);
 485     else
 486         set_ue_golomb(pb, i);
 487 }
 488
 489 /**
 490  * write signed exp golomb code. 16 bits at most.
 491  */
 492 static inline void set_se_golomb(PutBitContext *pb, int i)
 493 {
 494     i = 2 * i - 1;
 495     if (i < 0)
 496         i ^= -1;    //FIXME check if gcc does the right thing
 497     set_ue_golomb(pb, i);
 498 }
 499
 500 /**
 501  * write unsigned golomb rice code (ffv1).
 502  */
 503 static inline void set_ur_golomb(PutBitContext *pb, int i, int k, int limit,
 504                                  int esc_len)
 505 {
 506     int e;
 507
 508     av_assert2(i >= 0);
 509
 510     e = i >> k;
 511     if (e < limit)
 512         put_bits(pb, e + k + 1, (1 << k) + av_mod_uintp2(i, k));
 513     else
 514         put_bits(pb, limit + esc_len, i - limit + 1);
 515 }
 516
 517 /**
 518  * write unsigned golomb rice code (jpegls).
 519  */
 520 static inline void set_ur_golomb_jpegls(PutBitContext *pb, int i, int k,
 521                                         int limit, int esc_len)
 522 {
 523     int e;
 524
 525     av_assert2(i >= 0);
 526
 527     e = (i >> k) + 1;
 528     if (e < limit) {
 529         while (e > 31) {
 530             put_bits(pb, 31, 0);
 531             e -= 31;
 532         }
 533         put_bits(pb, e, 1);
 534         if (k)
 535             put_sbits(pb, k, i);
 536     } else {
 537         while (limit > 31) {
 538             put_bits(pb, 31, 0);
 539             limit -= 31;
 540         }
 541         put_bits(pb, limit, 1);
 542         put_bits(pb, esc_len, i - 1);
 543     }
 544 }
 545
 546 /**
 547  * write signed golomb rice code (ffv1).
 548  */
 549 static inline void set_sr_golomb(PutBitContext *pb, int i, int k, int limit,
 550                                  int esc_len)
 551 {
 552     int v;
 553
 554     v  = -2 * i - 1;
 555     v ^= (v >> 31);
 556
 557     set_ur_golomb(pb, v, k, limit, esc_len);
 558 }
 559
 560 /**
 561  * write signed golomb rice code (flac).
 562  */
 563 static inline void set_sr_golomb_flac(PutBitContext *pb, int i, int k,
 564                                       int limit, int esc_len)
 565 {
 566     int v;
 567
 568     v  = -2 * i - 1;
 569     v ^= (v >> 31);
 570
 571     set_ur_golomb_jpegls(pb, v, k, limit, esc_len);
 572 }
 573
 574 #endif /* AVCODEC_GOLOMB_H */