shift CABACContext.range right, this reduces the number of shifts needed in get_cabac...
[ffmpeg.git] / libavcodec / cabac.h
1 /*
2  * H.26L/H.264/AVC/JVT/14496-10/... encoder/decoder
3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  */
22
23 /**
24  * @file cabac.h
25  * Context Adaptive Binary Arithmetic Coder.
26  */
27
28
29 //#undef NDEBUG
30 #include <assert.h>
31
32 #define CABAC_BITS 16
33 #define CABAC_MASK ((1<<CABAC_BITS)-1)
34 #define BRANCHLESS_CABAC_DECODER 1
35 #define CMOV_IS_FAST 1
36
37 typedef struct CABACContext{
38     int low;
39     int range;
40     int outstanding_count;
41 #ifdef STRICT_LIMITS
42     int symCount;
43 #endif
44     const uint8_t *bytestream_start;
45     const uint8_t *bytestream;
46     const uint8_t *bytestream_end;
47     PutBitContext pb;
48 }CABACContext;
49
50 extern uint8_t ff_h264_mlps_state[4*64];
51 extern uint8_t ff_h264_lps_range[4][2*64];  ///< rangeTabLPS
52 extern uint8_t ff_h264_mps_state[2*64];     ///< transIdxMPS
53 extern uint8_t ff_h264_lps_state[2*64];     ///< transIdxLPS
54 extern const uint8_t ff_h264_norm_shift[512];
55
56
57 void ff_init_cabac_encoder(CABACContext *c, uint8_t *buf, int buf_size);
58 void ff_init_cabac_decoder(CABACContext *c, const uint8_t *buf, int buf_size);
59 void ff_init_cabac_states(CABACContext *c);
60
61
62 static inline void put_cabac_bit(CABACContext *c, int b){
63     put_bits(&c->pb, 1, b);
64     for(;c->outstanding_count; c->outstanding_count--){
65         put_bits(&c->pb, 1, 1-b);
66     }
67 }
68
69 static inline void renorm_cabac_encoder(CABACContext *c){
70     while(c->range < 0x100){
71         //FIXME optimize
72         if(c->low<0x100){
73             put_cabac_bit(c, 0);
74         }else if(c->low<0x200){
75             c->outstanding_count++;
76             c->low -= 0x100;
77         }else{
78             put_cabac_bit(c, 1);
79             c->low -= 0x200;
80         }
81
82         c->range+= c->range;
83         c->low += c->low;
84     }
85 }
86
87 static void put_cabac(CABACContext *c, uint8_t * const state, int bit){
88     int RangeLPS= ff_h264_lps_range[2*(c->range&0xC0) + *state];
89
90     if(bit == ((*state)&1)){
91         c->range -= RangeLPS;
92         *state= ff_h264_mps_state[*state];
93     }else{
94         c->low += c->range - RangeLPS;
95         c->range = RangeLPS;
96         *state= ff_h264_lps_state[*state];
97     }
98
99     renorm_cabac_encoder(c);
100
101 #ifdef STRICT_LIMITS
102     c->symCount++;
103 #endif
104 }
105
106 static void put_cabac_static(CABACContext *c, int RangeLPS, int bit){
107     assert(c->range > RangeLPS);
108
109     if(!bit){
110         c->range -= RangeLPS;
111     }else{
112         c->low += c->range - RangeLPS;
113         c->range = RangeLPS;
114     }
115
116     renorm_cabac_encoder(c);
117
118 #ifdef STRICT_LIMITS
119     c->symCount++;
120 #endif
121 }
122
123 /**
124  * @param bit 0 -> write zero bit, !=0 write one bit
125  */
126 static void put_cabac_bypass(CABACContext *c, int bit){
127     c->low += c->low;
128
129     if(bit){
130         c->low += c->range;
131     }
132 //FIXME optimize
133     if(c->low<0x200){
134         put_cabac_bit(c, 0);
135     }else if(c->low<0x400){
136         c->outstanding_count++;
137         c->low -= 0x200;
138     }else{
139         put_cabac_bit(c, 1);
140         c->low -= 0x400;
141     }
142
143 #ifdef STRICT_LIMITS
144     c->symCount++;
145 #endif
146 }
147
148 /**
149  *
150  * @return the number of bytes written
151  */
152 static int put_cabac_terminate(CABACContext *c, int bit){
153     c->range -= 2;
154
155     if(!bit){
156         renorm_cabac_encoder(c);
157     }else{
158         c->low += c->range;
159         c->range= 2;
160
161         renorm_cabac_encoder(c);
162
163         assert(c->low <= 0x1FF);
164         put_cabac_bit(c, c->low>>9);
165         put_bits(&c->pb, 2, ((c->low>>7)&3)|1);
166
167         flush_put_bits(&c->pb); //FIXME FIXME FIXME XXX wrong
168     }
169
170 #ifdef STRICT_LIMITS
171     c->symCount++;
172 #endif
173
174     return (put_bits_count(&c->pb)+7)>>3;
175 }
176
177 /**
178  * put (truncated) unary binarization.
179  */
180 static void put_cabac_u(CABACContext *c, uint8_t * state, int v, int max, int max_index, int truncated){
181     int i;
182
183     assert(v <= max);
184
185 #if 1
186     for(i=0; i<v; i++){
187         put_cabac(c, state, 1);
188         if(i < max_index) state++;
189     }
190     if(truncated==0 || v<max)
191         put_cabac(c, state, 0);
192 #else
193     if(v <= max_index){
194         for(i=0; i<v; i++){
195             put_cabac(c, state+i, 1);
196         }
197         if(truncated==0 || v<max)
198             put_cabac(c, state+i, 0);
199     }else{
200         for(i=0; i<=max_index; i++){
201             put_cabac(c, state+i, 1);
202         }
203         for(; i<v; i++){
204             put_cabac(c, state+max_index, 1);
205         }
206         if(truncated==0 || v<max)
207             put_cabac(c, state+max_index, 0);
208     }
209 #endif
210 }
211
212 /**
213  * put unary exp golomb k-th order binarization.
214  */
215 static void put_cabac_ueg(CABACContext *c, uint8_t * state, int v, int max, int is_signed, int k, int max_index){
216     int i;
217
218     if(v==0)
219         put_cabac(c, state, 0);
220     else{
221         const int sign= v < 0;
222
223         if(is_signed) v= FFABS(v);
224
225         if(v<max){
226             for(i=0; i<v; i++){
227                 put_cabac(c, state, 1);
228                 if(i < max_index) state++;
229             }
230
231             put_cabac(c, state, 0);
232         }else{
233             int m= 1<<k;
234
235             for(i=0; i<max; i++){
236                 put_cabac(c, state, 1);
237                 if(i < max_index) state++;
238             }
239
240             v -= max;
241             while(v >= m){ //FIXME optimize
242                 put_cabac_bypass(c, 1);
243                 v-= m;
244                 m+= m;
245             }
246             put_cabac_bypass(c, 0);
247             while(m>>=1){
248                 put_cabac_bypass(c, v&m);
249             }
250         }
251
252         if(is_signed)
253             put_cabac_bypass(c, sign);
254     }
255 }
256
257 static void refill(CABACContext *c){
258 #if CABAC_BITS == 16
259         c->low+= (c->bytestream[0]<<9) + (c->bytestream[1]<<1);
260 #else
261         c->low+= c->bytestream[0]<<1;
262 #endif
263     c->low -= CABAC_MASK;
264     c->bytestream+= CABAC_BITS/8;
265 }
266
267 static void refill2(CABACContext *c){
268     int i, x;
269
270     x= c->low ^ (c->low-1);
271     i= 7 - ff_h264_norm_shift[x>>(CABAC_BITS-1)];
272
273     x= -CABAC_MASK;
274
275 #if CABAC_BITS == 16
276         x+= (c->bytestream[0]<<9) + (c->bytestream[1]<<1);
277 #else
278         x+= c->bytestream[0]<<1;
279 #endif
280
281     c->low += x<<i;
282     c->bytestream+= CABAC_BITS/8;
283 }
284
285 static inline void renorm_cabac_decoder(CABACContext *c){
286     while(c->range < 0x100){
287         c->range+= c->range;
288         c->low+= c->low;
289         if(!(c->low & CABAC_MASK))
290             refill(c);
291     }
292 }
293
294 static inline void renorm_cabac_decoder_once(CABACContext *c){
295 #ifdef ARCH_X86_DISABLED
296     int temp;
297 #if 0
298     //P3:683    athlon:475
299     asm(
300         "lea -0x100(%0), %2         \n\t"
301         "shr $31, %2                \n\t"  //FIXME 31->63 for x86-64
302         "shl %%cl, %0               \n\t"
303         "shl %%cl, %1               \n\t"
304         : "+r"(c->range), "+r"(c->low), "+c"(temp)
305     );
306 #elif 0
307     //P3:680    athlon:474
308     asm(
309         "cmp $0x100, %0             \n\t"
310         "setb %%cl                  \n\t"  //FIXME 31->63 for x86-64
311         "shl %%cl, %0               \n\t"
312         "shl %%cl, %1               \n\t"
313         : "+r"(c->range), "+r"(c->low), "+c"(temp)
314     );
315 #elif 1
316     int temp2;
317     //P3:665    athlon:517
318     asm(
319         "lea -0x100(%0), %%eax      \n\t"
320         "cdq                        \n\t"
321         "mov %0, %%eax              \n\t"
322         "and %%edx, %0              \n\t"
323         "and %1, %%edx              \n\t"
324         "add %%eax, %0              \n\t"
325         "add %%edx, %1              \n\t"
326         : "+r"(c->range), "+r"(c->low), "+a"(temp), "+d"(temp2)
327     );
328 #elif 0
329     int temp2;
330     //P3:673    athlon:509
331     asm(
332         "cmp $0x100, %0             \n\t"
333         "sbb %%edx, %%edx           \n\t"
334         "mov %0, %%eax              \n\t"
335         "and %%edx, %0              \n\t"
336         "and %1, %%edx              \n\t"
337         "add %%eax, %0              \n\t"
338         "add %%edx, %1              \n\t"
339         : "+r"(c->range), "+r"(c->low), "+a"(temp), "+d"(temp2)
340     );
341 #else
342     int temp2;
343     //P3:677    athlon:511
344     asm(
345         "cmp $0x100, %0             \n\t"
346         "lea (%0, %0), %%eax        \n\t"
347         "lea (%1, %1), %%edx        \n\t"
348         "cmovb %%eax, %0            \n\t"
349         "cmovb %%edx, %1            \n\t"
350         : "+r"(c->range), "+r"(c->low), "+a"(temp), "+d"(temp2)
351     );
352 #endif
353 #else
354     //P3:675    athlon:476
355     int shift= (uint32_t)(c->range - 0x100)>>31;
356     c->range<<= shift;
357     c->low  <<= shift;
358 #endif
359     if(!(c->low & CABAC_MASK))
360         refill(c);
361 }
362
363 static int always_inline get_cabac_inline(CABACContext *c, uint8_t * const state){
364     //FIXME gcc generates duplicate load/stores for c->low and c->range
365 #ifdef ARCH_X86
366     int bit;
367
368 #define LOW          "0"
369 #define RANGE        "4"
370 #define BYTESTART   "12"
371 #define BYTE        "16"
372 #define BYTEEND     "20"
373 #ifndef BRANCHLESS_CABAC_DECODER
374     asm volatile(
375         "movzbl (%1), %%eax                     \n\t"
376         "movl "RANGE    "(%2), %%ebx            \n\t"
377         "movl "RANGE    "(%2), %%edx            \n\t"
378         "andl $0xC0, %%ebx                      \n\t"
379         "movzbl "MANGLE(ff_h264_lps_range)"(%%eax, %%ebx, 2), %%esi\n\t"
380         "movl "LOW      "(%2), %%ebx            \n\t"
381 //eax:state ebx:low, edx:range, esi:RangeLPS
382         "subl %%esi, %%edx                      \n\t"
383         "movl %%edx, %%ecx                      \n\t"
384         "shll $17, %%ecx                        \n\t"
385         "cmpl %%ecx, %%ebx                      \n\t"
386         " ja 1f                                 \n\t"
387
388 #if 1
389         //athlon:4067 P3:4110
390         "lea -0x100(%%edx), %%ecx               \n\t"
391         "shr $31, %%ecx                         \n\t"
392         "shl %%cl, %%edx                        \n\t"
393         "shl %%cl, %%ebx                        \n\t"
394 #else
395         //athlon:4057 P3:4130
396         "cmp $0x100, %%edx                      \n\t" //FIXME avoidable
397         "setb %%cl                              \n\t"
398         "shl %%cl, %%edx                        \n\t"
399         "shl %%cl, %%ebx                        \n\t"
400 #endif
401         "movzbl "MANGLE(ff_h264_mps_state)"(%%eax), %%ecx   \n\t"
402         "movb %%cl, (%1)                        \n\t"
403 //eax:state ebx:low, edx:range, esi:RangeLPS
404         "test %%bx, %%bx                        \n\t"
405         " jnz 2f                                \n\t"
406         "movl "BYTE     "(%2), %%esi            \n\t"
407         "subl $0xFFFF, %%ebx                    \n\t"
408         "movzwl (%%esi), %%ecx                  \n\t"
409         "bswap %%ecx                            \n\t"
410         "shrl $15, %%ecx                        \n\t"
411         "addl $2, %%esi                         \n\t"
412         "addl %%ecx, %%ebx                      \n\t"
413         "movl %%esi, "BYTE    "(%2)             \n\t"
414         "jmp 2f                                 \n\t"
415         "1:                                     \n\t"
416 //eax:state ebx:low, edx:range, esi:RangeLPS
417         "subl %%ecx, %%ebx                      \n\t"
418         "movl %%esi, %%edx                      \n\t"
419         "movzbl " MANGLE(ff_h264_norm_shift) "(%%esi), %%ecx   \n\t"
420         "shll %%cl, %%ebx                       \n\t"
421         "shll %%cl, %%edx                       \n\t"
422         "movzbl "MANGLE(ff_h264_lps_state)"(%%eax), %%ecx   \n\t"
423         "movb %%cl, (%1)                        \n\t"
424         "addl $1, %%eax                         \n\t"
425         "test %%bx, %%bx                        \n\t"
426         " jnz 2f                                \n\t"
427
428         "movl "BYTE     "(%2), %%ecx            \n\t"
429         "movzwl (%%ecx), %%esi                  \n\t"
430         "bswap %%esi                            \n\t"
431         "shrl $15, %%esi                        \n\t"
432         "subl $0xFFFF, %%esi                    \n\t"
433         "addl $2, %%ecx                         \n\t"
434         "movl %%ecx, "BYTE    "(%2)             \n\t"
435
436         "leal -1(%%ebx), %%ecx                  \n\t"
437         "xorl %%ebx, %%ecx                      \n\t"
438         "shrl $15, %%ecx                        \n\t"
439         "movzbl " MANGLE(ff_h264_norm_shift) "(%%ecx), %%ecx   \n\t"
440         "neg %%ecx                              \n\t"
441         "add $7, %%ecx                          \n\t"
442
443         "shll %%cl , %%esi                      \n\t"
444         "addl %%esi, %%ebx                      \n\t"
445         "2:                                     \n\t"
446         "movl %%edx, "RANGE    "(%2)            \n\t"
447         "movl %%ebx, "LOW      "(%2)            \n\t"
448         :"=&a"(bit) //FIXME this is fragile gcc either runs out of registers or misscompiles it (for example if "+a"(bit) or "+m"(*state) is used
449         :"r"(state), "r"(c)
450         : "%ecx", "%ebx", "%edx", "%esi", "memory"
451     );
452     bit&=1;
453 #else /* BRANCHLESS_CABAC_DECODER */
454     asm volatile(
455         "movzbl (%1), %%eax                     \n\t"
456         "movl "RANGE    "(%2), %%ebx            \n\t"
457         "movl "RANGE    "(%2), %%edx            \n\t"
458         "andl $0xC0, %%ebx                      \n\t"
459         "movzbl "MANGLE(ff_h264_lps_range)"(%%eax, %%ebx, 2), %%esi\n\t"
460         "movl "LOW      "(%2), %%ebx            \n\t"
461 //eax:state ebx:low, edx:range, esi:RangeLPS
462         "subl %%esi, %%edx                      \n\t"
463 #ifdef CMOV_IS_FAST
464         "movl %%edx, %%ecx                      \n\t"
465         "shl $17, %%edx                         \n\t"
466         "cmpl %%ebx, %%edx                      \n\t"
467         "cmova %%ecx, %%esi                     \n\t"
468         "sbbl %%ecx, %%ecx                      \n\t"
469         "andl %%ecx, %%edx                      \n\t"
470         "subl %%edx, %%ebx                      \n\t"
471         "xorl %%ecx, %%eax                      \n\t"
472 #else /* CMOV_IS_FAST */
473 FIXTHIS
474         "movl %%edx, %%ecx                      \n\t"
475         "subl %%ebx, %%edx                      \n\t"
476         "sarl $31, %%edx                        \n\t" //lps_mask
477         "subl %%ecx, %%esi                      \n\t" //RangeLPS - range
478         "andl %%edx, %%esi                      \n\t" //(RangeLPS - range)&lps_mask
479         "addl %%ecx, %%esi                      \n\t" //new range
480         "andl %%edx, %%ecx                      \n\t"
481         "subl %%ecx, %%ebx                      \n\t"
482         "xorl %%edx, %%eax                      \n\t"
483 #endif /* CMOV_IS_FAST */
484
485 //eax:state ebx:low edx:mask esi:range
486
487 //eax:bit ebx:low esi:range
488
489         "movzbl " MANGLE(ff_h264_norm_shift) "(%%esi), %%ecx   \n\t"
490         "shll %%cl, %%esi                       \n\t"
491         "movzbl "MANGLE(ff_h264_mlps_state)"+128(%%eax), %%edx   \n\t"
492         "movb %%dl, (%1)                        \n\t"
493         "movl %%esi, "RANGE    "(%2)            \n\t"
494         "shll %%cl, %%ebx                       \n\t"
495         "movl %%ebx, "LOW      "(%2)            \n\t"
496         "test %%bx, %%bx                        \n\t"
497         " jnz 1f                                \n\t"
498
499         "movl "BYTE     "(%2), %%ecx            \n\t"
500         "movzwl (%%ecx), %%esi                  \n\t"
501         "bswap %%esi                            \n\t"
502         "shrl $15, %%esi                        \n\t"
503         "subl $0xFFFF, %%esi                    \n\t"
504         "addl $2, %%ecx                         \n\t"
505         "movl %%ecx, "BYTE    "(%2)             \n\t"
506
507         "leal -1(%%ebx), %%ecx                  \n\t"
508         "xorl %%ebx, %%ecx                      \n\t"
509         "shrl $15, %%ecx                        \n\t"
510         "movzbl " MANGLE(ff_h264_norm_shift) "(%%ecx), %%ecx   \n\t"
511         "neg %%ecx                              \n\t"
512         "add $7, %%ecx                          \n\t"
513
514         "shll %%cl , %%esi                      \n\t"
515         "addl %%esi, %%ebx                      \n\t"
516         "movl %%ebx, "LOW      "(%2)            \n\t"
517         "1:                                     \n\t"
518         :"=&a"(bit)
519         :"r"(state), "r"(c)
520         : "%ecx", "%ebx", "%edx", "%esi", "memory"
521     );
522     bit&=1;
523 #endif /* BRANCHLESS_CABAC_DECODER */
524 #else /* ARCH_X86 */
525     int s = *state;
526     int RangeLPS= ff_h264_lps_range[0][2*(c->range&0xC0) + s];
527     int bit, lps_mask attribute_unused;
528
529     c->range -= RangeLPS;
530 #ifndef BRANCHLESS_CABAC_DECODER
531     if(c->low < (c->range<<17)){
532         bit= s&1;
533         *state= ff_h264_mps_state[s];
534         renorm_cabac_decoder_once(c);
535     }else{
536         bit= ff_h264_norm_shift[RangeLPS];
537         c->low -= (c->range<<17);
538         *state= ff_h264_lps_state[s];
539         c->range = RangeLPS<<bit;
540         c->low <<= bit;
541         bit= (s&1)^1;
542
543         if(!(c->low & 0xFFFF)){
544             refill2(c);
545         }
546     }
547 #else /* BRANCHLESS_CABAC_DECODER */
548     lps_mask= ((c->range<<17) - c->low)>>31;
549
550     c->low -= (c->range<<17) & lps_mask;
551     c->range += (RangeLPS - c->range) & lps_mask;
552
553     s^=lps_mask;
554     *state= (ff_h264_mlps_state+128)[s];
555     bit= s&1;
556
557     lps_mask= ff_h264_norm_shift[c->range];
558     c->range<<= lps_mask;
559     c->low  <<= lps_mask;
560     if(!(c->low & CABAC_MASK))
561         refill2(c);
562 #endif /* BRANCHLESS_CABAC_DECODER */
563 #endif /* ARCH_X86 */
564     return bit;
565 }
566
567 static int __attribute((noinline)) get_cabac_noinline(CABACContext *c, uint8_t * const state){
568     return get_cabac_inline(c,state);
569 }
570
571 static int get_cabac(CABACContext *c, uint8_t * const state){
572     return get_cabac_inline(c,state);
573 }
574
575 static int get_cabac_bypass(CABACContext *c){
576     int range;
577     c->low += c->low;
578
579     if(!(c->low & CABAC_MASK))
580         refill(c);
581
582     range= c->range<<17;
583     if(c->low < range){
584         return 0;
585     }else{
586         c->low -= range;
587         return 1;
588     }
589 }
590
591 /**
592  *
593  * @return the number of bytes read or 0 if no end
594  */
595 static int get_cabac_terminate(CABACContext *c){
596     c->range -= 2;
597     if(c->low < c->range<<17){
598         renorm_cabac_decoder_once(c);
599         return 0;
600     }else{
601         return c->bytestream - c->bytestream_start;
602     }
603 }
604
605 /**
606  * get (truncated) unnary binarization.
607  */
608 static int get_cabac_u(CABACContext *c, uint8_t * state, int max, int max_index, int truncated){
609     int i;
610
611     for(i=0; i<max; i++){
612         if(get_cabac(c, state)==0)
613             return i;
614
615         if(i< max_index) state++;
616     }
617
618     return truncated ? max : -1;
619 }
620
621 /**
622  * get unary exp golomb k-th order binarization.
623  */
624 static int get_cabac_ueg(CABACContext *c, uint8_t * state, int max, int is_signed, int k, int max_index){
625     int i, v;
626     int m= 1<<k;
627
628     if(get_cabac(c, state)==0)
629         return 0;
630
631     if(0 < max_index) state++;
632
633     for(i=1; i<max; i++){
634         if(get_cabac(c, state)==0){
635             if(is_signed && get_cabac_bypass(c)){
636                 return -i;
637             }else
638                 return i;
639         }
640
641         if(i < max_index) state++;
642     }
643
644     while(get_cabac_bypass(c)){
645         i+= m;
646         m+= m;
647     }
648
649     v=0;
650     while(m>>=1){
651         v+= v + get_cabac_bypass(c);
652     }
653     i += v;
654
655     if(is_signed && get_cabac_bypass(c)){
656         return -i;
657     }else
658         return i;
659 }