Fixed rsqrt testcase for float
[opus.git] / libcelt / rangeenc.c
1 #ifdef HAVE_CONFIG_H
2 #include "config.h"
3 #endif
4
5 #include "entenc.h"
6 #include "mfrngcod.h"
7
8
9
10 /*A range encoder.
11   See rangedec.c and the references for implementation details
12    \cite{Mar79,MNW98}.
13
14   @INPROCEEDINGS{Mar79,
15    author="Martin, G.N.N.",
16    title="Range encoding: an algorithm for removing redundancy from a digitised
17     message",
18    booktitle="Video \& Data Recording Conference",
19    year=1979,
20    address="Southampton",
21    month=Jul
22   }
23   @ARTICLE{MNW98,
24    author="Alistair Moffat and Radford Neal and Ian H. Witten",
25    title="Arithmetic Coding Revisited",
26    journal="{ACM} Transactions on Information Systems",
27    year=1998,
28    volume=16,
29    number=3,
30    pages="256--294",
31    month=Jul,
32    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
33   }*/
34
35
36
37 /*Outputs a symbol, with a carry bit.
38   If there is a potential to propagate a carry over several symbols, they are
39    buffered until it can be determined whether or not an actual carry will
40    occur.
41   If the counter for the buffered symbols overflows, then the stream becomes
42    undecodable.
43   This gives a theoretical limit of a few billion symbols in a single packet on
44    32-bit systems.
45   The alternative is to truncate the range in order to force a carry, but
46    requires similar carry tracking in the decoder, needlessly slowing it down.*/
47 static void ec_enc_carry_out(ec_enc *_this,int _c){
48   if(_c!=EC_SYM_MAX){
49     /*No further carry propagation possible, flush buffer.*/
50     int carry;
51     carry=_c>>EC_SYM_BITS;
52     /*Don't output a byte on the first write.
53       This compare should be taken care of by branch-prediction thereafter.*/
54     if(_this->rem>=0)ec_byte_write1(_this->buf,_this->rem+carry);
55     if(_this->ext>0){
56       unsigned sym;
57       sym=EC_SYM_MAX+carry&EC_SYM_MAX;
58       do ec_byte_write1(_this->buf,sym);
59       while(--(_this->ext)>0);
60     }
61     _this->rem=_c&EC_SYM_MAX;
62   }
63   else _this->ext++;
64 }
65
66 static inline void ec_enc_normalize(ec_enc *_this){
67   /*If the range is too small, output some bits and rescale it.*/
68   while(_this->rng<=EC_CODE_BOT){
69     ec_enc_carry_out(_this,(int)(_this->low>>EC_CODE_SHIFT));
70     /*Move the next-to-high-order symbol into the high-order position.*/
71     _this->low=_this->low<<EC_SYM_BITS&EC_CODE_TOP-1;
72     _this->rng<<=EC_SYM_BITS;
73   }
74 }
75
76 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf){
77   _this->buf=_buf;
78   _this->rem=-1;
79   _this->ext=0;
80   _this->low=0;
81   _this->rng=EC_CODE_TOP;
82 }
83
84 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
85   ec_uint32 r;
86   r=_this->rng/_ft;
87   if(_fl>0){
88     _this->low+=_this->rng-r*(_ft-_fl);
89     _this->rng=r*(_fh-_fl);
90   }
91   else _this->rng-=r*(_ft-_fh);
92   ec_enc_normalize(_this);
93 }
94
95 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned bits){
96    ec_uint32 r, ft;
97    r=_this->rng>>bits;
98    ft = (ec_uint32)1<<bits;
99    if(_fl>0){
100       _this->low+=_this->rng-r*(ft-_fl);
101       _this->rng=r*(_fh-_fl);
102    }
103    else _this->rng-=r*(ft-_fh);
104    ec_enc_normalize(_this);
105 }
106
107 long ec_enc_tell(ec_enc *_this,int _b){
108   ec_uint32 r;
109   int       l;
110   long      nbits;
111   nbits=ec_byte_bytes(_this->buf)+(_this->rem>=0)+_this->ext<<3;
112   /*To handle the non-integral number of bits still left in the encoder state,
113      we compute the number of bits of low that must be encoded to ensure that
114      the value is inside the range for any possible subsequent bits.
115     Note that this is subtly different than the actual value we would end the
116      stream with, which tries to make as many of the trailing bits zeros as
117      possible.*/
118   nbits+=EC_CODE_BITS;
119   nbits<<=_b;
120   l=EC_ILOG(_this->rng);
121   r=_this->rng>>l-16;
122   while(_b-->0){
123     int b;
124     r=r*r>>15;
125     b=(int)(r>>16);
126     l=l<<1|b;
127     r>>=b;
128   }
129   return nbits-l;
130 }
131
132 void ec_enc_done(ec_enc *_this){
133   /*We compute the integer in the current interval that has the largest number
134      of trailing zeros, and write that to the stream.
135     This is guaranteed to yield the smallest possible encoding.*/
136   if(_this->low){
137     ec_uint32 end;
138     end=EC_CODE_TOP;
139     /*Ensure that the end value is in the range.*/
140     if(end-_this->low>=_this->rng){
141       ec_uint32 msk;
142       msk=EC_CODE_TOP-1;
143       do{
144         msk>>=1;
145         end=_this->low+msk&~msk|msk+1;
146       }
147       while(end-_this->low>=_this->rng);
148     }
149     /*The remaining output is the next free end.*/
150     while(end){
151       ec_enc_carry_out(_this,end>>EC_CODE_SHIFT);
152       end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
153     }
154   }
155   /*If we have a buffered byte flush it into the output buffer.*/
156   if(_this->rem>0||_this->ext>0){
157     ec_enc_carry_out(_this,0);
158     _this->rem=-1;
159   }
160 }