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