3 * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4 * Copyright (c) 2004 Alex Beregszaszi
6 * This file is part of FFmpeg.
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.
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.
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
26 * exp golomb vlc stuff
27 * @author Michael Niedermayer <michaelni@gmx.at> and Alex Beregszaszi
30 #ifndef AVCODEC_GOLOMB_H
31 #define AVCODEC_GOLOMB_H
38 #define INVALID_VLC 0x80000000
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];
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];
51 * Read an unsigned Exp-Golomb code in the range 0 to 8190.
53 * @returns the read value or a negative error code.
55 static inline int get_ue_golomb(GetBitContext *gb)
59 #if CACHED_BITSTREAM_READER
60 buf = show_bits_long(gb, 32);
62 if (buf >= (1 << 27)) {
64 skip_bits_long(gb, ff_golomb_vlc_len[buf]);
66 return ff_ue_golomb_vlc_code[buf];
68 int log = 2 * av_log2(buf) - 31;
71 skip_bits_long(gb, 32 - log);
78 buf = GET_CACHE(re, gb);
80 if (buf >= (1 << 27)) {
82 LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
85 return ff_ue_golomb_vlc_code[buf];
87 int log = 2 * av_log2(buf) - 31;
88 LAST_SKIP_BITS(re, gb, 32 - log);
91 av_log(NULL, AV_LOG_ERROR, "Invalid UE golomb code\n");
92 return AVERROR_INVALIDDATA;
103 * Read an unsigned Exp-Golomb code in the range 0 to UINT32_MAX-1.
105 static inline unsigned get_ue_golomb_long(GetBitContext *gb)
109 buf = show_bits_long(gb, 32);
110 log = 31 - av_log2(buf);
111 skip_bits_long(gb, log);
113 return get_bits_long(gb, log + 1) - 1;
117 * read unsigned exp golomb code, constraint to a max of 31.
118 * the return value is undefined if the stored value exceeds 31.
120 static inline int get_ue_golomb_31(GetBitContext *gb)
124 #if CACHED_BITSTREAM_READER
125 buf = show_bits_long(gb, 32);
128 skip_bits_long(gb, ff_golomb_vlc_len[buf]);
132 UPDATE_CACHE(re, gb);
133 buf = GET_CACHE(re, gb);
136 LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
137 CLOSE_READER(re, gb);
140 return ff_ue_golomb_vlc_code[buf];
143 static inline unsigned get_interleaved_ue_golomb(GetBitContext *gb)
147 #if CACHED_BITSTREAM_READER
148 buf = show_bits_long(gb, 32);
150 if (buf & 0xAA800000) {
152 skip_bits_long(gb, ff_interleaved_golomb_vlc_len[buf]);
154 return ff_interleaved_ue_golomb_vlc_code[buf];
160 skip_bits_long(gb, FFMIN(ff_interleaved_golomb_vlc_len[buf], 8));
162 if (ff_interleaved_golomb_vlc_len[buf] != 9) {
163 ret <<= (ff_interleaved_golomb_vlc_len[buf] - 1) >> 1;
164 ret |= ff_interleaved_dirac_golomb_vlc_code[buf];
167 ret = (ret << 4) | ff_interleaved_dirac_golomb_vlc_code[buf];
168 buf = show_bits_long(gb, 32);
169 } while (get_bits_left(gb) > 0);
175 UPDATE_CACHE(re, gb);
176 buf = GET_CACHE(re, gb);
178 if (buf & 0xAA800000) {
180 LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
181 CLOSE_READER(re, gb);
183 return ff_interleaved_ue_golomb_vlc_code[buf];
189 LAST_SKIP_BITS(re, gb,
190 FFMIN(ff_interleaved_golomb_vlc_len[buf], 8));
192 if (ff_interleaved_golomb_vlc_len[buf] != 9) {
193 ret <<= (ff_interleaved_golomb_vlc_len[buf] - 1) >> 1;
194 ret |= ff_interleaved_dirac_golomb_vlc_code[buf];
197 ret = (ret << 4) | ff_interleaved_dirac_golomb_vlc_code[buf];
198 UPDATE_CACHE(re, gb);
199 buf = GET_CACHE(re, gb);
200 } while (ret<0x8000000U && BITS_AVAILABLE(re, gb));
202 CLOSE_READER(re, gb);
209 * read unsigned truncated exp golomb code.
211 static inline int get_te0_golomb(GetBitContext *gb, int range)
213 av_assert2(range >= 1);
218 return get_bits1(gb) ^ 1;
220 return get_ue_golomb(gb);
224 * read unsigned truncated exp golomb code.
226 static inline int get_te_golomb(GetBitContext *gb, int range)
228 av_assert2(range >= 1);
231 return get_bits1(gb) ^ 1;
233 return get_ue_golomb(gb);
237 * read signed exp golomb code.
239 static inline int get_se_golomb(GetBitContext *gb)
243 #if CACHED_BITSTREAM_READER
244 buf = show_bits_long(gb, 32);
246 if (buf >= (1 << 27)) {
248 skip_bits_long(gb, ff_golomb_vlc_len[buf]);
250 return ff_se_golomb_vlc_code[buf];
252 int log = 2 * av_log2(buf) - 31;
255 skip_bits_long(gb, 32 - log);
266 UPDATE_CACHE(re, gb);
267 buf = GET_CACHE(re, gb);
269 if (buf >= (1 << 27)) {
271 LAST_SKIP_BITS(re, gb, ff_golomb_vlc_len[buf]);
272 CLOSE_READER(re, gb);
274 return ff_se_golomb_vlc_code[buf];
276 int log = av_log2(buf), sign;
277 LAST_SKIP_BITS(re, gb, 31 - log);
278 UPDATE_CACHE(re, gb);
279 buf = GET_CACHE(re, gb);
283 LAST_SKIP_BITS(re, gb, 32 - log);
284 CLOSE_READER(re, gb);
287 buf = ((buf >> 1) ^ sign) - sign;
294 static inline int get_se_golomb_long(GetBitContext *gb)
296 unsigned int buf = get_ue_golomb_long(gb);
297 int sign = (buf & 1) - 1;
298 return ((buf >> 1) ^ sign) + 1;
301 static inline int get_interleaved_se_golomb(GetBitContext *gb)
305 #if CACHED_BITSTREAM_READER
306 buf = show_bits_long(gb, 32);
308 if (buf & 0xAA800000) {
310 skip_bits_long(gb, ff_interleaved_golomb_vlc_len[buf]);
312 return ff_interleaved_se_golomb_vlc_code[buf];
316 buf |= 1 | show_bits(gb, 24);
318 if ((buf & 0xAAAAAAAA) == 0)
321 for (log = 31; (buf & 0x80000000) == 0; log--)
322 buf = (buf << 2) - ((buf << log) >> (log - 1)) + (buf >> 30);
324 skip_bits_long(gb, 63 - 2 * log - 8);
326 return (signed) (((((buf << log) >> log) - 1) ^ -(buf & 0x1)) + 1) >> 1;
330 UPDATE_CACHE(re, gb);
331 buf = GET_CACHE(re, gb);
333 if (buf & 0xAA800000) {
335 LAST_SKIP_BITS(re, gb, ff_interleaved_golomb_vlc_len[buf]);
336 CLOSE_READER(re, gb);
338 return ff_interleaved_se_golomb_vlc_code[buf];
341 LAST_SKIP_BITS(re, gb, 8);
342 UPDATE_CACHE(re, gb);
343 buf |= 1 | (GET_CACHE(re, gb) >> 8);
345 if ((buf & 0xAAAAAAAA) == 0)
348 for (log = 31; (buf & 0x80000000) == 0; log--)
349 buf = (buf << 2) - ((buf << log) >> (log - 1)) + (buf >> 30);
351 LAST_SKIP_BITS(re, gb, 63 - 2 * log - 8);
352 CLOSE_READER(re, gb);
354 return (signed) (((((buf << log) >> log) - 1) ^ -(buf & 0x1)) + 1) >> 1;
359 static inline int dirac_get_se_golomb(GetBitContext *gb)
361 uint32_t ret = get_interleaved_ue_golomb(gb);
364 int sign = -get_bits1(gb);
365 ret = (ret ^ sign) - sign;
372 * read unsigned golomb rice code (ffv1).
374 static inline int get_ur_golomb(GetBitContext *gb, int k, int limit,
380 #if CACHED_BITSTREAM_READER
381 buf = show_bits_long(gb, 32);
385 if (log > 31 - limit) {
387 buf += (30 - log) << k;
388 skip_bits_long(gb, 32 + k - log);
392 skip_bits_long(gb, limit);
393 buf = get_bits_long(gb, esc_len);
395 return buf + limit - 1;
399 UPDATE_CACHE(re, gb);
400 buf = GET_CACHE(re, gb);
404 if (log > 31 - limit) {
406 buf += (30U - log) << k;
407 LAST_SKIP_BITS(re, gb, 32 + k - log);
408 CLOSE_READER(re, gb);
412 LAST_SKIP_BITS(re, gb, limit);
413 UPDATE_CACHE(re, gb);
415 buf = SHOW_UBITS(re, gb, esc_len);
417 LAST_SKIP_BITS(re, gb, esc_len);
418 CLOSE_READER(re, gb);
420 return buf + limit - 1;
426 * read unsigned golomb rice code (jpegls).
428 static inline int get_ur_golomb_jpegls(GetBitContext *gb, int k, int limit,
434 #if CACHED_BITSTREAM_READER
435 buf = show_bits_long(gb, 32);
439 if (log - k >= 1 && 32 - log < limit) {
441 buf += (30 - log) << k;
442 skip_bits_long(gb, 32 + k - log);
448 i < limit && get_bits1(gb) == 0 && get_bits_left(gb) > 0;
452 buf = get_bits_long(gb, k);
454 return buf + (i << k);
455 } else if (i == limit - 1) {
456 buf = get_bits_long(gb, esc_len);
464 UPDATE_CACHE(re, gb);
465 buf = GET_CACHE(re, gb);
471 if (log - k >= 32 - MIN_CACHE_BITS + (MIN_CACHE_BITS == 32) &&
474 buf += (30U - log) << k;
475 LAST_SKIP_BITS(re, gb, 32 + k - log);
476 CLOSE_READER(re, gb);
481 for (i = 0; i + MIN_CACHE_BITS <= limit && SHOW_UBITS(re, gb, MIN_CACHE_BITS) == 0; i += MIN_CACHE_BITS) {
482 if (gb->size_in_bits <= re_index) {
483 CLOSE_READER(re, gb);
486 LAST_SKIP_BITS(re, gb, MIN_CACHE_BITS);
487 UPDATE_CACHE(re, gb);
489 for (; i < limit && SHOW_UBITS(re, gb, 1) == 0; i++) {
490 SKIP_BITS(re, gb, 1);
492 LAST_SKIP_BITS(re, gb, 1);
493 UPDATE_CACHE(re, gb);
497 if (k > MIN_CACHE_BITS - 1) {
498 buf = SHOW_UBITS(re, gb, 16) << (k-16);
499 LAST_SKIP_BITS(re, gb, 16);
500 UPDATE_CACHE(re, gb);
501 buf |= SHOW_UBITS(re, gb, k-16);
502 LAST_SKIP_BITS(re, gb, k-16);
504 buf = SHOW_UBITS(re, gb, k);
505 LAST_SKIP_BITS(re, gb, k);
511 buf += ((SUINT)i << k);
512 } else if (i == limit - 1) {
513 buf = SHOW_UBITS(re, gb, esc_len);
514 LAST_SKIP_BITS(re, gb, esc_len);
520 CLOSE_READER(re, gb);
527 * read signed golomb rice code (ffv1).
529 static inline int get_sr_golomb(GetBitContext *gb, int k, int limit,
532 unsigned v = get_ur_golomb(gb, k, limit, esc_len);
533 return (v >> 1) ^ -(v & 1);
537 * read signed golomb rice code (flac).
539 static inline int get_sr_golomb_flac(GetBitContext *gb, int k, int limit,
542 unsigned v = get_ur_golomb_jpegls(gb, k, limit, esc_len);
543 return (v >> 1) ^ -(v & 1);
547 * read unsigned golomb rice code (shorten).
549 static inline unsigned int get_ur_golomb_shorten(GetBitContext *gb, int k)
551 return get_ur_golomb_jpegls(gb, k, INT_MAX, 0);
555 * read signed golomb rice code (shorten).
557 static inline int get_sr_golomb_shorten(GetBitContext *gb, int k)
559 int uvar = get_ur_golomb_jpegls(gb, k + 1, INT_MAX, 0);
560 return (uvar >> 1) ^ -(uvar & 1);
565 static inline int get_ue(GetBitContext *s, const char *file, const char *func,
568 int show = show_bits(s, 24);
569 int pos = get_bits_count(s);
570 int i = get_ue_golomb(s);
571 int len = get_bits_count(s) - pos;
572 int bits = show >> (24 - len);
574 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d ue @%5d in %s %s:%d\n",
575 bits, len, i, pos, file, func, line);
580 static inline int get_se(GetBitContext *s, const char *file, const char *func,
583 int show = show_bits(s, 24);
584 int pos = get_bits_count(s);
585 int i = get_se_golomb(s);
586 int len = get_bits_count(s) - pos;
587 int bits = show >> (24 - len);
589 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d se @%5d in %s %s:%d\n",
590 bits, len, i, pos, file, func, line);
595 static inline int get_te(GetBitContext *s, int r, char *file, const char *func,
598 int show = show_bits(s, 24);
599 int pos = get_bits_count(s);
600 int i = get_te0_golomb(s, r);
601 int len = get_bits_count(s) - pos;
602 int bits = show >> (24 - len);
604 av_log(NULL, AV_LOG_DEBUG, "%5d %2d %3d te @%5d in %s %s:%d\n",
605 bits, len, i, pos, file, func, line);
610 #define get_ue_golomb(a) get_ue(a, __FILE__, __func__, __LINE__)
611 #define get_se_golomb(a) get_se(a, __FILE__, __func__, __LINE__)
612 #define get_te_golomb(a, r) get_te(a, r, __FILE__, __func__, __LINE__)
613 #define get_te0_golomb(a, r) get_te(a, r, __FILE__, __func__, __LINE__)
618 * write unsigned exp golomb code. 2^16 - 2 at most
620 static inline void set_ue_golomb(PutBitContext *pb, int i)
623 av_assert2(i <= 0xFFFE);
626 put_bits(pb, ff_ue_golomb_len[i], i + 1);
628 int e = av_log2(i + 1);
629 put_bits(pb, 2 * e + 1, i + 1);
634 * write unsigned exp golomb code. 2^32-2 at most.
636 static inline void set_ue_golomb_long(PutBitContext *pb, uint32_t i)
638 av_assert2(i <= (UINT32_MAX - 1));
641 put_bits(pb, ff_ue_golomb_len[i], i + 1);
643 int e = av_log2(i + 1);
644 put_bits64(pb, 2 * e + 1, i + 1);
649 * write truncated unsigned exp golomb code.
651 static inline void set_te_golomb(PutBitContext *pb, int i, int range)
653 av_assert2(range >= 1);
654 av_assert2(i <= range);
657 put_bits(pb, 1, i ^ 1);
659 set_ue_golomb(pb, i);
663 * write signed exp golomb code. 16 bits at most.
665 static inline void set_se_golomb(PutBitContext *pb, int i)
669 i ^= -1; //FIXME check if gcc does the right thing
670 set_ue_golomb(pb, i);
674 * write unsigned golomb rice code (ffv1).
676 static inline void set_ur_golomb(PutBitContext *pb, int i, int k, int limit,
685 put_bits(pb, e + k + 1, (1 << k) + av_mod_uintp2(i, k));
687 put_bits(pb, limit + esc_len, i - limit + 1);
691 * write unsigned golomb rice code (jpegls).
693 static inline void set_ur_golomb_jpegls(PutBitContext *pb, int i, int k,
694 int limit, int esc_len)
714 put_bits(pb, limit, 1);
715 put_bits(pb, esc_len, i - 1);
720 * write signed golomb rice code (ffv1).
722 static inline void set_sr_golomb(PutBitContext *pb, int i, int k, int limit,
730 set_ur_golomb(pb, v, k, limit, esc_len);
734 * write signed golomb rice code (flac).
736 static inline void set_sr_golomb_flac(PutBitContext *pb, int i, int k,
737 int limit, int esc_len)
744 set_ur_golomb_jpegls(pb, v, k, limit, esc_len);
747 #endif /* AVCODEC_GOLOMB_H */