optimize branchless C CABAC decoder
[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
35 typedef struct CABACContext{
36     int low;
37     int range;
38     int outstanding_count;
39 #ifdef STRICT_LIMITS
40     int symCount;
41 #endif
42     uint8_t lps_range[2*66][4];   ///< rangeTabLPS
43     uint8_t lps_state[2*65];      ///< transIdxLPS
44     uint8_t mps_state[2*65];      ///< transIdxMPS
45     const uint8_t *bytestream_start;
46     const uint8_t *bytestream;
47     const uint8_t *bytestream_end;
48     PutBitContext pb;
49 }CABACContext;
50
51 extern const uint8_t ff_h264_lps_range[64][4];
52 extern const uint8_t ff_h264_mps_state[64];
53 extern const uint8_t ff_h264_lps_state[64];
54 extern const uint8_t ff_h264_norm_shift[128];
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, uint8_t const (*lps_range)[4],
60                           uint8_t const *mps_state, uint8_t const *lps_state, int state_count);
61
62
63 static inline void put_cabac_bit(CABACContext *c, int b){
64     put_bits(&c->pb, 1, b);
65     for(;c->outstanding_count; c->outstanding_count--){
66         put_bits(&c->pb, 1, 1-b);
67     }
68 }
69
70 static inline void renorm_cabac_encoder(CABACContext *c){
71     while(c->range < 0x100){
72         //FIXME optimize
73         if(c->low<0x100){
74             put_cabac_bit(c, 0);
75         }else if(c->low<0x200){
76             c->outstanding_count++;
77             c->low -= 0x100;
78         }else{
79             put_cabac_bit(c, 1);
80             c->low -= 0x200;
81         }
82
83         c->range+= c->range;
84         c->low += c->low;
85     }
86 }
87
88 static void put_cabac(CABACContext *c, uint8_t * const state, int bit){
89     int RangeLPS= c->lps_range[*state][c->range>>6];
90
91     if(bit == ((*state)&1)){
92         c->range -= RangeLPS;
93         *state= c->mps_state[*state];
94     }else{
95         c->low += c->range - RangeLPS;
96         c->range = RangeLPS;
97         *state= c->lps_state[*state];
98     }
99
100     renorm_cabac_encoder(c);
101
102 #ifdef STRICT_LIMITS
103     c->symCount++;
104 #endif
105 }
106
107 static void put_cabac_static(CABACContext *c, int RangeLPS, int bit){
108     assert(c->range > RangeLPS);
109
110     if(!bit){
111         c->range -= RangeLPS;
112     }else{
113         c->low += c->range - RangeLPS;
114         c->range = RangeLPS;
115     }
116
117     renorm_cabac_encoder(c);
118
119 #ifdef STRICT_LIMITS
120     c->symCount++;
121 #endif
122 }
123
124 /**
125  * @param bit 0 -> write zero bit, !=0 write one bit
126  */
127 static void put_cabac_bypass(CABACContext *c, int bit){
128     c->low += c->low;
129
130     if(bit){
131         c->low += c->range;
132     }
133 //FIXME optimize
134     if(c->low<0x200){
135         put_cabac_bit(c, 0);
136     }else if(c->low<0x400){
137         c->outstanding_count++;
138         c->low -= 0x200;
139     }else{
140         put_cabac_bit(c, 1);
141         c->low -= 0x400;
142     }
143
144 #ifdef STRICT_LIMITS
145     c->symCount++;
146 #endif
147 }
148
149 /**
150  *
151  * @return the number of bytes written
152  */
153 static int put_cabac_terminate(CABACContext *c, int bit){
154     c->range -= 2;
155
156     if(!bit){
157         renorm_cabac_encoder(c);
158     }else{
159         c->low += c->range;
160         c->range= 2;
161
162         renorm_cabac_encoder(c);
163
164         assert(c->low <= 0x1FF);
165         put_cabac_bit(c, c->low>>9);
166         put_bits(&c->pb, 2, ((c->low>>7)&3)|1);
167
168         flush_put_bits(&c->pb); //FIXME FIXME FIXME XXX wrong
169     }
170
171 #ifdef STRICT_LIMITS
172     c->symCount++;
173 #endif
174
175     return (put_bits_count(&c->pb)+7)>>3;
176 }
177
178 /**
179  * put (truncated) unary binarization.
180  */
181 static void put_cabac_u(CABACContext *c, uint8_t * state, int v, int max, int max_index, int truncated){
182     int i;
183
184     assert(v <= max);
185
186 #if 1
187     for(i=0; i<v; i++){
188         put_cabac(c, state, 1);
189         if(i < max_index) state++;
190     }
191     if(truncated==0 || v<max)
192         put_cabac(c, state, 0);
193 #else
194     if(v <= max_index){
195         for(i=0; i<v; i++){
196             put_cabac(c, state+i, 1);
197         }
198         if(truncated==0 || v<max)
199             put_cabac(c, state+i, 0);
200     }else{
201         for(i=0; i<=max_index; i++){
202             put_cabac(c, state+i, 1);
203         }
204         for(; i<v; i++){
205             put_cabac(c, state+max_index, 1);
206         }
207         if(truncated==0 || v<max)
208             put_cabac(c, state+max_index, 0);
209     }
210 #endif
211 }
212
213 /**
214  * put unary exp golomb k-th order binarization.
215  */
216 static void put_cabac_ueg(CABACContext *c, uint8_t * state, int v, int max, int is_signed, int k, int max_index){
217     int i;
218
219     if(v==0)
220         put_cabac(c, state, 0);
221     else{
222         const int sign= v < 0;
223
224         if(is_signed) v= ABS(v);
225
226         if(v<max){
227             for(i=0; i<v; i++){
228                 put_cabac(c, state, 1);
229                 if(i < max_index) state++;
230             }
231
232             put_cabac(c, state, 0);
233         }else{
234             int m= 1<<k;
235
236             for(i=0; i<max; i++){
237                 put_cabac(c, state, 1);
238                 if(i < max_index) state++;
239             }
240
241             v -= max;
242             while(v >= m){ //FIXME optimize
243                 put_cabac_bypass(c, 1);
244                 v-= m;
245                 m+= m;
246             }
247             put_cabac_bypass(c, 0);
248             while(m>>=1){
249                 put_cabac_bypass(c, v&m);
250             }
251         }
252
253         if(is_signed)
254             put_cabac_bypass(c, sign);
255     }
256 }
257
258 static void refill(CABACContext *c){
259 #if CABAC_BITS == 16
260         c->low+= (c->bytestream[0]<<9) + (c->bytestream[1]<<1);
261 #else
262         c->low+= c->bytestream[0]<<1;
263 #endif
264     c->low -= CABAC_MASK;
265     c->bytestream+= CABAC_BITS/8;
266 }
267
268 static void refill2(CABACContext *c){
269     int i, x;
270
271     x= c->low ^ (c->low-1);
272     i= 7 - ff_h264_norm_shift[x>>(CABAC_BITS+1)];
273
274     x= -CABAC_MASK;
275
276 #if CABAC_BITS == 16
277         x+= (c->bytestream[0]<<9) + (c->bytestream[1]<<1);
278 #else
279         x+= c->bytestream[0]<<1;
280 #endif
281
282     c->low += x<<i;
283     c->bytestream+= CABAC_BITS/8;
284 }
285
286 static inline void renorm_cabac_decoder(CABACContext *c){
287     while(c->range < (0x200 << CABAC_BITS)){
288         c->range+= c->range;
289         c->low+= c->low;
290         if(!(c->low & CABAC_MASK))
291             refill(c);
292     }
293 }
294
295 static inline void renorm_cabac_decoder_once(CABACContext *c){
296 #ifdef ARCH_X86_DISABLED
297     int temp;
298 #if 0
299     //P3:683    athlon:475
300     asm(
301         "lea -0x2000000(%0), %2     \n\t"
302         "shr $31, %2                \n\t"  //FIXME 31->63 for x86-64
303         "shl %%cl, %0               \n\t"
304         "shl %%cl, %1               \n\t"
305         : "+r"(c->range), "+r"(c->low), "+c"(temp)
306     );
307 #elif 0
308     //P3:680    athlon:474
309     asm(
310         "cmp $0x2000000, %0         \n\t"
311         "setb %%cl                  \n\t"  //FIXME 31->63 for x86-64
312         "shl %%cl, %0               \n\t"
313         "shl %%cl, %1               \n\t"
314         : "+r"(c->range), "+r"(c->low), "+c"(temp)
315     );
316 #elif 1
317     int temp2;
318     //P3:665    athlon:517
319     asm(
320         "lea -0x2000000(%0), %%eax  \n\t"
321         "cdq                        \n\t"
322         "mov %0, %%eax              \n\t"
323         "and %%edx, %0              \n\t"
324         "and %1, %%edx              \n\t"
325         "add %%eax, %0              \n\t"
326         "add %%edx, %1              \n\t"
327         : "+r"(c->range), "+r"(c->low), "+a"(temp), "+d"(temp2)
328     );
329 #elif 0
330     int temp2;
331     //P3:673    athlon:509
332     asm(
333         "cmp $0x2000000, %0         \n\t"
334         "sbb %%edx, %%edx           \n\t"
335         "mov %0, %%eax              \n\t"
336         "and %%edx, %0              \n\t"
337         "and %1, %%edx              \n\t"
338         "add %%eax, %0              \n\t"
339         "add %%edx, %1              \n\t"
340         : "+r"(c->range), "+r"(c->low), "+a"(temp), "+d"(temp2)
341     );
342 #else
343     int temp2;
344     //P3:677    athlon:511
345     asm(
346         "cmp $0x2000000, %0         \n\t"
347         "lea (%0, %0), %%eax        \n\t"
348         "lea (%1, %1), %%edx        \n\t"
349         "cmovb %%eax, %0            \n\t"
350         "cmovb %%edx, %1            \n\t"
351         : "+r"(c->range), "+r"(c->low), "+a"(temp), "+d"(temp2)
352     );
353 #endif
354 #else
355     //P3:675    athlon:476
356     int shift= (uint32_t)(c->range - (0x200 << CABAC_BITS))>>31;
357     c->range<<= shift;
358     c->low  <<= shift;
359 #endif
360     if(!(c->low & CABAC_MASK))
361         refill(c);
362 }
363
364 static int get_cabac(CABACContext *c, uint8_t * const state){
365     //FIXME gcc generates duplicate load/stores for c->low and c->range
366 #ifdef ARCH_X86
367     int bit;
368
369 #define LOW          "0"
370 #define RANGE        "4"
371 #define LPS_RANGE   "12"
372 #define LPS_STATE   "12+2*66*4"
373 #define MPS_STATE   "12+2*66*4+2*65"
374 #define BYTESTART   "12+2*66*4+4*65"
375 #define BYTE        "16+2*66*4+4*65"
376 #define BYTEEND     "20+2*66*4+4*65"
377
378     asm volatile(
379         "movzbl (%1), %%eax                     \n\t"
380         "movl "RANGE    "(%2), %%ebx            \n\t"
381         "movl "RANGE    "(%2), %%edx            \n\t"
382         "shrl $23, %%ebx                        \n\t"
383         "leal "LPS_RANGE"(%2, %%eax, 4), %%esi  \n\t"
384         "movzbl (%%ebx, %%esi), %%esi           \n\t"
385         "shll $17, %%esi                        \n\t"
386         "movl "LOW      "(%2), %%ebx            \n\t"
387 //eax:state ebx:low, edx:range, esi:RangeLPS
388         "subl %%esi, %%edx                      \n\t"
389         "cmpl %%edx, %%ebx                      \n\t"
390         " ja 1f                                 \n\t"
391         "cmp $0x2000000, %%edx                  \n\t" //FIXME avoidable
392         "setb %%cl                              \n\t"
393         "shl %%cl, %%edx                        \n\t"
394         "shl %%cl, %%ebx                        \n\t"
395         "movb "MPS_STATE"(%2, %%eax), %%cl      \n\t"
396         "movb %%cl, (%1)                        \n\t"
397 //eax:state ebx:low, edx:range, esi:RangeLPS
398         "test %%bx, %%bx                        \n\t"
399         " jnz 2f                                \n\t"
400         "movl "BYTE     "(%2), %%esi            \n\t"
401         "subl $0xFFFF, %%ebx                    \n\t"
402         "movzwl (%%esi), %%ecx                  \n\t"
403         "bswap %%ecx                            \n\t"
404         "shrl $15, %%ecx                        \n\t"
405         "addl $2, %%esi                         \n\t"
406         "addl %%ecx, %%ebx                      \n\t"
407         "movl %%esi, "BYTE    "(%2)             \n\t"
408         "jmp 2f                                 \n\t"
409         "1:                                     \n\t"
410 //eax:state ebx:low, edx:range, esi:RangeLPS
411         "subl %%edx, %%ebx                      \n\t"
412         "movl %%esi, %%edx                      \n\t"
413         "shr $19, %%esi                         \n\t"
414         "movb " MANGLE(ff_h264_norm_shift) "(%%esi), %%cl   \n\t"
415         "shll %%cl, %%ebx                       \n\t"
416         "shll %%cl, %%edx                       \n\t"
417         "movb "LPS_STATE"(%2, %%eax), %%cl      \n\t"
418         "movb %%cl, (%1)                        \n\t"
419         "incl %%eax                             \n\t"
420         "test %%bx, %%bx                        \n\t"
421         " jnz 2f                                \n\t"
422
423         "movl "BYTE     "(%2), %%ecx            \n\t"
424         "movzwl (%%ecx), %%esi                  \n\t"
425         "bswap %%esi                            \n\t"
426         "shrl $15, %%esi                        \n\t"
427         "subl $0xFFFF, %%esi                    \n\t"
428         "addl $2, %%ecx                         \n\t"
429         "movl %%ecx, "BYTE    "(%2)             \n\t"
430
431         "leal -1(%%ebx), %%ecx                  \n\t"
432         "xorl %%ebx, %%ecx                      \n\t"
433         "shrl $17, %%ecx                        \n\t"
434         "movb " MANGLE(ff_h264_norm_shift) "(%%ecx), %%cl   \n\t"
435         "neg %%cl                               \n\t"
436         "add $7, %%cl                           \n\t"
437
438         "shll %%cl , %%esi                      \n\t"
439         "addl %%esi, %%ebx                      \n\t"
440         "2:                                     \n\t"
441         "movl %%edx, "RANGE    "(%2)            \n\t"
442         "movl %%ebx, "LOW      "(%2)            \n\t"
443         "andl $1, %%eax                         \n\t"
444
445         :"=&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
446         :"r"(state), "r"(c)
447         : "%ecx", "%ebx", "%edx", "%esi"
448     );
449 #else
450     int s = *state;
451     int RangeLPS= c->lps_range[s][c->range>>(CABAC_BITS+7)]<<(CABAC_BITS+1);
452     int bit, lps_mask attribute_unused;
453
454     c->range -= RangeLPS;
455 #ifndef BRANCHLESS_CABAD
456     if(c->low < c->range){
457         bit= s&1;
458         *state= c->mps_state[s];
459         renorm_cabac_decoder_once(c);
460     }else{
461         bit= ff_h264_norm_shift[RangeLPS>>19];
462         c->low -= c->range;
463         *state= c->lps_state[s];
464         c->range = RangeLPS<<bit;
465         c->low <<= bit;
466         bit= (s&1)^1;
467
468         if(!(c->low & 0xFFFF)){
469             refill2(c);
470         }
471     }
472 #else
473     lps_mask= (c->range - c->low)>>31;
474
475     c->low -= c->range & lps_mask;
476     c->range += (RangeLPS - c->range) & lps_mask;
477
478     s^=lps_mask;
479     *state= c->mps_state[s];
480     bit= s&1;
481
482     lps_mask= ff_h264_norm_shift[c->range>>(CABAC_BITS+3)];
483     c->range<<= lps_mask;
484     c->low  <<= lps_mask;
485     if(!(c->low & CABAC_MASK))
486         refill2(c);
487 #endif
488 #endif
489     return bit;
490 }
491
492 static int get_cabac_bypass(CABACContext *c){
493     c->low += c->low;
494
495     if(!(c->low & CABAC_MASK))
496         refill(c);
497
498     if(c->low < c->range){
499         return 0;
500     }else{
501         c->low -= c->range;
502         return 1;
503     }
504 }
505
506 /**
507  *
508  * @return the number of bytes read or 0 if no end
509  */
510 static int get_cabac_terminate(CABACContext *c){
511     c->range -= 4<<CABAC_BITS;
512     if(c->low < c->range){
513         renorm_cabac_decoder_once(c);
514         return 0;
515     }else{
516         return c->bytestream - c->bytestream_start;
517     }
518 }
519
520 /**
521  * get (truncated) unnary binarization.
522  */
523 static int get_cabac_u(CABACContext *c, uint8_t * state, int max, int max_index, int truncated){
524     int i;
525
526     for(i=0; i<max; i++){
527         if(get_cabac(c, state)==0)
528             return i;
529
530         if(i< max_index) state++;
531     }
532
533     return truncated ? max : -1;
534 }
535
536 /**
537  * get unary exp golomb k-th order binarization.
538  */
539 static int get_cabac_ueg(CABACContext *c, uint8_t * state, int max, int is_signed, int k, int max_index){
540     int i, v;
541     int m= 1<<k;
542
543     if(get_cabac(c, state)==0)
544         return 0;
545
546     if(0 < max_index) state++;
547
548     for(i=1; i<max; i++){
549         if(get_cabac(c, state)==0){
550             if(is_signed && get_cabac_bypass(c)){
551                 return -i;
552             }else
553                 return i;
554         }
555
556         if(i < max_index) state++;
557     }
558
559     while(get_cabac_bypass(c)){
560         i+= m;
561         m+= m;
562     }
563
564     v=0;
565     while(m>>=1){
566         v+= v + get_cabac_bypass(c);
567     }
568     i += v;
569
570     if(is_signed && get_cabac_bypass(c)){
571         return -i;
572     }else
573         return i;
574 }