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 Libav.
   7  *
   8  * Libav 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  * Libav 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 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 #ifndef AVCODEC_GOLOMB_H
  31 #define AVCODEC_GOLOMB_H
  32
  33 #include <stdint.h>
  34
  35 #include "bitstream.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(BitstreamContext *bc)
  54 {
  55     unsigned int buf;
  56
  57     buf = bitstream_peek(bc, 32);
  58
  59     if (buf >= (1 << 27)) {
  60         buf >>= 32 - 9;
  61         bitstream_skip(bc, ff_golomb_vlc_len[buf]);
  62
  63         return ff_ue_golomb_vlc_code[buf];
  64     } else {
  65         int log = 2 * av_log2(buf) - 31;
  66         buf >>= log;
  67         buf--;
  68         bitstream_skip(bc, 32 - log);
  69
  70         return buf;
  71     }
  72 }
  73
  74 /**
  75  * Read an unsigned Exp-Golomb code in the range 0 to UINT32_MAX-1.
  76  */
  77 static inline unsigned get_ue_golomb_long(BitstreamContext *bc)
  78 {
  79     unsigned buf, log;
  80
  81     buf = bitstream_peek(bc, 32);
  82     log = 31 - av_log2(buf);
  83     bitstream_skip(bc, log);
  84
  85     return bitstream_read(bc, log + 1) - 1;
  86 }
  87
  88 /**
  89  * read unsigned exp golomb code, constraint to a max of 31.
  90  * the return value is undefined if the stored value exceeds 31.
  91  */
  92 static inline int get_ue_golomb_31(BitstreamContext *bc)
  93 {
  94     unsigned int buf;
  95
  96     buf = bitstream_peek(bc, 32);
  97
  98     buf >>= 32 - 9;
  99     bitstream_skip(bc, ff_golomb_vlc_len[buf]);
 100
 101     return ff_ue_golomb_vlc_code[buf];
 102 }
 103
 104 static inline unsigned get_interleaved_ue_golomb(BitstreamContext *bc)
 105 {
 106     uint32_t buf;
 107
 108     buf = bitstream_peek(bc, 32);
 109
 110     if (buf & 0xAA800000) {
 111         buf >>= 32 - 8;
 112         bitstream_skip(bc, ff_interleaved_golomb_vlc_len[buf]);
 113
 114         return ff_interleaved_ue_golomb_vlc_code[buf];
 115     } else {
 116         unsigned ret = 1;
 117
 118         do {
 119             buf >>= 32 - 8;
 120             bitstream_skip(bc, FFMIN(ff_interleaved_golomb_vlc_len[buf], 8));
 121
 122             if (ff_interleaved_golomb_vlc_len[buf] != 9) {
 123                 ret <<= (ff_interleaved_golomb_vlc_len[buf] - 1) >> 1;
 124                 ret  |= ff_interleaved_dirac_golomb_vlc_code[buf];
 125                 break;
 126             }
 127             ret = (ret << 4) | ff_interleaved_dirac_golomb_vlc_code[buf];
 128             buf = bitstream_peek(bc, 32);
 129         } while (bitstream_bits_left(bc) > 0);
 130
 131         return ret - 1;
 132     }
 133 }
 134
 135 /**
 136  * read unsigned truncated exp golomb code.
 137  */
 138 static inline int get_te0_golomb(BitstreamContext *bc, int range)
 139 {
 140     assert(range >= 1);
 141
 142     if (range == 1)
 143         return 0;
 144     else if (range == 2)
 145         return bitstream_read_bit(bc) ^ 1;
 146     else
 147         return get_ue_golomb(bc);
 148 }
 149
 150 /**
 151  * read unsigned truncated exp golomb code.
 152  */
 153 static inline int get_te_golomb(BitstreamContext *bc, int range)
 154 {
 155     assert(range >= 1);
 156
 157     if (range == 2)
 158         return bitstream_read_bit(bc) ^ 1;
 159     else
 160         return get_ue_golomb(bc);
 161 }
 162
 163 /**
 164  * read signed exp golomb code.
 165  */
 166 static inline int get_se_golomb(BitstreamContext *bc)
 167 {
 168     unsigned int buf;
 169
 170     buf = bitstream_peek(bc, 32);
 171
 172     if (buf >= (1 << 27)) {
 173         buf >>= 32 - 9;
 174         bitstream_skip(bc, ff_golomb_vlc_len[buf]);
 175
 176         return ff_se_golomb_vlc_code[buf];
 177     } else {
 178         int log = 2 * av_log2(buf) - 31;
 179         buf >>= log;
 180
 181         bitstream_skip(bc, 32 - log);
 182
 183         if (buf & 1)
 184             buf = -(buf >> 1);
 185         else
 186             buf = (buf >> 1);
 187
 188         return buf;
 189     }
 190 }
 191
 192 static inline int get_se_golomb_long(BitstreamContext *bc)
 193 {
 194     unsigned int buf = get_ue_golomb_long(bc);
 195
 196     if (buf & 1)
 197         buf = (buf + 1) >> 1;
 198     else
 199         buf = -(buf >> 1);
 200
 201     return buf;
 202 }
 203
 204 static inline int get_interleaved_se_golomb(BitstreamContext *bc)
 205 {
 206     unsigned int buf;
 207
 208     buf = bitstream_peek(bc, 32);
 209
 210     if (buf & 0xAA800000) {
 211         buf >>= 32 - 8;
 212         bitstream_skip(bc, ff_interleaved_golomb_vlc_len[buf]);
 213
 214         return ff_interleaved_se_golomb_vlc_code[buf];
 215     } else {
 216         int log;
 217         bitstream_skip(bc, 8);
 218         buf |= 1 | bitstream_peek(bc, 24);
 219
 220         if ((buf & 0xAAAAAAAA) == 0)
 221             return INVALID_VLC;
 222
 223         for (log = 31; (buf & 0x80000000) == 0; log--)
 224             buf = (buf << 2) - ((buf << log) >> (log - 1)) + (buf >> 30);
 225
 226         bitstream_skip(bc, 63 - 2 * log - 8);
 227
 228         return (signed) (((((buf << log) >> log) - 1) ^ -(buf & 0x1)) + 1) >> 1;
 229     }
 230 }
 231
 232 static inline int dirac_get_se_golomb(BitstreamContext *bc)
 233 {
 234     uint32_t ret = get_interleaved_ue_golomb(bc);
 235
 236     if (ret) {
 237         uint32_t buf;
 238         buf = bitstream_read_signed(bc, 1);
 239         ret = (ret ^ buf) - buf;
 240     }
 241
 242     return ret;
 243 }
 244
 245 /**
 246  * read unsigned golomb rice code (ffv1).
 247  */
 248 static inline int get_ur_golomb(BitstreamContext *bc, int k, int limit,
 249                                 int esc_len)
 250 {
 251     unsigned int buf;
 252     int log;
 253
 254     buf = bitstream_peek(bc, 32);
 255
 256     log = av_log2(buf);
 257
 258     if (log > 31 - limit) {
 259         buf >>= log - k;
 260         buf  += (30 - log) << k;
 261         bitstream_skip(bc, 32 + k - log);
 262
 263         return buf;
 264     } else {
 265         bitstream_skip(bc, limit);
 266         buf = bitstream_read(bc, esc_len);
 267
 268         return buf + limit - 1;
 269     }
 270 }
 271
 272 /**
 273  * read unsigned golomb rice code (jpegls).
 274  */
 275 static inline int get_ur_golomb_jpegls(BitstreamContext *bc, int k, int limit,
 276                                        int esc_len)
 277 {
 278     unsigned int buf;
 279     int log;
 280
 281     buf = bitstream_peek(bc, 32);
 282
 283     log = av_log2(buf);
 284
 285     if (log - k >= 1 && 32 - log < limit) {
 286         buf >>= log - k;
 287         buf  += (30 - log) << k;
 288         bitstream_skip(bc, 32 + k - log);
 289
 290         return buf;
 291     } else {
 292         int i;
 293         for (i = 0; i < limit && bitstream_peek(bc, 1) == 0 && bitstream_bits_left(bc) > 0; i++)
 294             bitstream_skip(bc, 1);
 295         bitstream_skip(bc, 1);
 296
 297         if (i < limit - 1) {
 298             if (k) {
 299                 buf = bitstream_read(bc, k);
 300             } else {
 301                 buf = 0;
 302             }
 303
 304             return buf + (i << k);
 305         } else if (i == limit - 1) {
 306             buf = bitstream_read(bc, esc_len);
 307
 308             return buf + 1;
 309         } else
 310             return -1;
 311     }
 312 }
 313
 314 /**
 315  * read signed golomb rice code (ffv1).
 316  */
 317 static inline int get_sr_golomb(BitstreamContext *bc, int k, int limit,
 318                                 int esc_len)
 319 {
 320     int v = get_ur_golomb(bc, k, limit, esc_len);
 321
 322     v++;
 323     if (v & 1)
 324         return v >> 1;
 325     else
 326         return -(v >> 1);
 327
 328 //    return (v>>1) ^ -(v&1);
 329 }
 330
 331 /**
 332  * read signed golomb rice code (flac).
 333  */
 334 static inline int get_sr_golomb_flac(BitstreamContext *bc, int k, int limit,
 335                                      int esc_len)
 336 {
 337     int v = get_ur_golomb_jpegls(bc, k, limit, esc_len);
 338     return (v >> 1) ^ -(v & 1);
 339 }
 340
 341 /**
 342  * read unsigned golomb rice code (shorten).
 343  */
 344 static inline unsigned int get_ur_golomb_shorten(BitstreamContext *bc, int k)
 345 {
 346     return get_ur_golomb_jpegls(bc, k, INT_MAX, 0);
 347 }
 348
 349 /**
 350  * read signed golomb rice code (shorten).
 351  */
 352 static inline int get_sr_golomb_shorten(BitstreamContext *bc, int k)
 353 {
 354     int uvar = get_ur_golomb_jpegls(bc, k + 1, INT_MAX, 0);
 355     if (uvar & 1)
 356         return ~(uvar >> 1);
 357     else
 358         return uvar >> 1;
 359 }
 360
 361 #ifdef TRACE
 362
 363 static inline int get_ue(BitstreamContext *s, const char *file, const char *func,
 364                          int line)
 365 {
 366     int show = bitstream_peek(s, 24);
 367     int pos  = bitstream_tell(s);
 368     int i    = get_ue_golomb(s);
 369     int len  = bitstream_tell(s) - pos;
 370     int bits = show >> (24 - len);
 371
 372     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d ue  @%5d in %s %s:%d\n",
 373            bits, len, i, pos, file, func, line);
 374
 375     return i;
 376 }
 377
 378 static inline int get_se(BitstreamContext *s, const char *file, const char *func,
 379                          int line)
 380 {
 381     int show = bitstream_peek(s, 24);
 382     int pos  = bitstream_tell(s);
 383     int i    = get_se_golomb(s);
 384     int len  = bitstream_tell(s) - pos;
 385     int bits = show >> (24 - len);
 386
 387     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d se  @%5d in %s %s:%d\n",
 388            bits, len, i, pos, file, func, line);
 389
 390     return i;
 391 }
 392
 393 static inline int get_te(BitstreamContext *s, int r, char *file, const char *func,
 394                          int line)
 395 {
 396     int show = bitstream_peek(s, 24);
 397     int pos  = bitstream_tell(s);
 398     int i    = get_te0_golomb(s, r);
 399     int len  = bitstream_tell(s) - pos;
 400     int bits = show >> (24 - len);
 401
 402     av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d te  @%5d in %s %s:%d\n",
 403            bits, len, i, pos, file, func, line);
 404
 405     return i;
 406 }
 407
 408 #define get_ue_golomb(a) get_ue(a, __FILE__, __func__, __LINE__)
 409 #define get_se_golomb(a) get_se(a, __FILE__, __func__, __LINE__)
 410 #define get_te_golomb(a, r)  get_te(a, r, __FILE__, __func__, __LINE__)
 411 #define get_te0_golomb(a, r) get_te(a, r, __FILE__, __func__, __LINE__)
 412
 413 #endif /* TRACE */
 414
 415 /**
 416  * write unsigned exp golomb code.
 417  */
 418 static inline void set_ue_golomb(PutBitContext *pb, int i)
 419 {
 420     assert(i >= 0);
 421
 422     if (i < 256)
 423         put_bits(pb, ff_ue_golomb_len[i], i + 1);
 424     else {
 425         int e = av_log2(i + 1);
 426         put_bits(pb, 2 * e + 1, i + 1);
 427     }
 428 }
 429
 430 /**
 431  * write truncated unsigned exp golomb code.
 432  */
 433 static inline void set_te_golomb(PutBitContext *pb, int i, int range)
 434 {
 435     assert(range >= 1);
 436     assert(i <= range);
 437
 438     if (range == 2)
 439         put_bits(pb, 1, i ^ 1);
 440     else
 441         set_ue_golomb(pb, i);
 442 }
 443
 444 /**
 445  * write signed exp golomb code. 16 bits at most.
 446  */
 447 static inline void set_se_golomb(PutBitContext *pb, int i)
 448 {
 449     i = 2 * i - 1;
 450     if (i < 0)
 451         i ^= -1;    //FIXME check if gcc does the right thing
 452     set_ue_golomb(pb, i);
 453 }
 454
 455 /**
 456  * write unsigned golomb rice code (ffv1).
 457  */
 458 static inline void set_ur_golomb(PutBitContext *pb, int i, int k, int limit,
 459                                  int esc_len)
 460 {
 461     int e;
 462
 463     assert(i >= 0);
 464
 465     e = i >> k;
 466     if (e < limit)
 467         put_bits(pb, e + k + 1, (1 << k) + (i & ((1 << k) - 1)));
 468     else
 469         put_bits(pb, limit + esc_len, i - limit + 1);
 470 }
 471
 472 /**
 473  * write unsigned golomb rice code (jpegls).
 474  */
 475 static inline void set_ur_golomb_jpegls(PutBitContext *pb, int i, int k,
 476                                         int limit, int esc_len)
 477 {
 478     int e;
 479
 480     assert(i >= 0);
 481
 482     e = (i >> k) + 1;
 483     if (e < limit) {
 484         while (e > 31) {
 485             put_bits(pb, 31, 0);
 486             e -= 31;
 487         }
 488         put_bits(pb, e, 1);
 489         if (k)
 490             put_sbits(pb, k, i);
 491     } else {
 492         while (limit > 31) {
 493             put_bits(pb, 31, 0);
 494             limit -= 31;
 495         }
 496         put_bits(pb, limit, 1);
 497         put_bits(pb, esc_len, i - 1);
 498     }
 499 }
 500
 501 /**
 502  * write signed golomb rice code (ffv1).
 503  */
 504 static inline void set_sr_golomb(PutBitContext *pb, int i, int k, int limit,
 505                                  int esc_len)
 506 {
 507     int v;
 508
 509     v  = -2 * i - 1;
 510     v ^= (v >> 31);
 511
 512     set_ur_golomb(pb, v, k, limit, esc_len);
 513 }
 514
 515 /**
 516  * write signed golomb rice code (flac).
 517  */
 518 static inline void set_sr_golomb_flac(PutBitContext *pb, int i, int k,
 519                                       int limit, int esc_len)
 520 {
 521     int v;
 522
 523     v  = -2 * i - 1;
 524     v ^= (v >> 31);
 525
 526     set_ur_golomb_jpegls(pb, v, k, limit, esc_len);
 527 }
 528
 529 #endif /* AVCODEC_GOLOMB_H */