Removing more unused function params
[opus.git] / libcelt / rangeenc.c
1 /* Copyright (c) 2001-2008 Timothy B. Terriberry
2    Copyright (c) 2008-2009 Xiph.Org Foundation */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include "arch.h"
37 #include "entenc.h"
38 #include "mfrngcod.h"
39
40
41
42 /*A range encoder.
43   See rangedec.c and the references for implementation details
44    \cite{Mar79,MNW98}.
45
46   @INPROCEEDINGS{Mar79,
47    author="Martin, G.N.N.",
48    title="Range encoding: an algorithm for removing redundancy from a digitised
49     message",
50    booktitle="Video \& Data Recording Conference",
51    year=1979,
52    address="Southampton",
53    month=Jul
54   }
55   @ARTICLE{MNW98,
56    author="Alistair Moffat and Radford Neal and Ian H. Witten",
57    title="Arithmetic Coding Revisited",
58    journal="{ACM} Transactions on Information Systems",
59    year=1998,
60    volume=16,
61    number=3,
62    pages="256--294",
63    month=Jul,
64    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
65   }*/
66
67
68
69 /*Outputs a symbol, with a carry bit.
70   If there is a potential to propagate a carry over several symbols, they are
71    buffered until it can be determined whether or not an actual carry will
72    occur.
73   If the counter for the buffered symbols overflows, then the stream becomes
74    undecodable.
75   This gives a theoretical limit of a few billion symbols in a single packet on
76    32-bit systems.
77   The alternative is to truncate the range in order to force a carry, but
78    requires similar carry tracking in the decoder, needlessly slowing it down.*/
79 static void ec_enc_carry_out(ec_enc *_this,int _c){
80   if(_c!=EC_SYM_MAX){
81     /*No further carry propagation possible, flush buffer.*/
82     int carry;
83     carry=_c>>EC_SYM_BITS;
84     /*Don't output a byte on the first write.
85       This compare should be taken care of by branch-prediction thereafter.*/
86     if(_this->rem>=0)_this->error|=ec_byte_write(_this->buf,_this->rem+carry);
87     if(_this->ext>0){
88       unsigned sym;
89       sym=EC_SYM_MAX+carry&EC_SYM_MAX;
90       do _this->error|=ec_byte_write(_this->buf,sym);
91       while(--(_this->ext)>0);
92     }
93     _this->rem=_c&EC_SYM_MAX;
94   }
95   else _this->ext++;
96 }
97
98 static inline void ec_enc_normalize(ec_enc *_this){
99   /*If the range is too small, output some bits and rescale it.*/
100   while(_this->rng<=EC_CODE_BOT){
101     ec_enc_carry_out(_this,(int)(_this->low>>EC_CODE_SHIFT));
102     /*Move the next-to-high-order symbol into the high-order position.*/
103     _this->low=_this->low<<EC_SYM_BITS&EC_CODE_TOP-1;
104     _this->rng<<=EC_SYM_BITS;
105     _this->nbits_total+=EC_SYM_BITS;
106   }
107 }
108
109 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf){
110   _this->buf=_buf;
111   _this->rem=-1;
112   _this->ext=0;
113   _this->low=0;
114   _this->rng=EC_CODE_TOP;
115   _this->end_window=0;
116   _this->nend_bits=0;
117   /*This is the offset from which ec_enc_tell() will subtract partial bits.*/
118   _this->nbits_total=EC_CODE_BITS+1;
119   _this->error=0;
120 }
121
122 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
123   ec_uint32 r;
124   r=_this->rng/_ft;
125   if(_fl>0){
126     _this->low+=_this->rng-IMUL32(r,(_ft-_fl));
127     _this->rng=IMUL32(r,(_fh-_fl));
128   }
129   else _this->rng-=IMUL32(r,(_ft-_fh));
130   ec_enc_normalize(_this);
131 }
132
133 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _bits){
134   ec_uint32 r;
135   r=_this->rng>>_bits;
136   if(_fl>0){
137     _this->low+=_this->rng-IMUL32(r,((1<<_bits)-_fl));
138     _this->rng=IMUL32(r,(_fh-_fl));
139   }
140   else _this->rng-=IMUL32(r,((1<<_bits)-_fh));
141   ec_enc_normalize(_this);
142 }
143
144 /*The probability of having a "one" is given in 1/65536.*/
145 void ec_enc_bit_prob(ec_enc *_this,int _val,unsigned _prob){
146   ec_uint32 r;
147   ec_uint32 s;
148   ec_uint32 l;
149   r=_this->rng;
150   l=_this->low;
151   s=(r>>16)*_prob;
152   r-=s;
153   if(_val)_this->low=l+r;
154   _this->rng=_val?s:r;
155   ec_enc_normalize(_this);
156 }
157
158 /*The probability of having a "one" is 1/(1<<_logp).*/
159 void ec_enc_bit_logp(ec_enc *_this,int _val,unsigned _logp){
160   ec_uint32 r;
161   ec_uint32 s;
162   ec_uint32 l;
163   r=_this->rng;
164   l=_this->low;
165   s=r>>_logp;
166   r-=s;
167   if(_val)_this->low=l+r;
168   _this->rng=_val?s:r;
169   ec_enc_normalize(_this);
170 }
171
172 void ec_enc_icdf(ec_enc *_this,int _s,const unsigned char *_icdf,unsigned _ftb){
173   ec_uint32 r;
174   r=_this->rng>>_ftb;
175   if(_s>0){
176     _this->low+=_this->rng-IMUL32(r,_icdf[_s-1]);
177     _this->rng=IMUL32(r,_icdf[_s-1]-_icdf[_s]);
178   }
179   else _this->rng-=IMUL32(r,_icdf[_s]);
180   ec_enc_normalize(_this);
181 }
182
183 void ec_enc_bits(ec_enc *_this,ec_uint32 _fl,unsigned _bits){
184   ec_window window;
185   int       used;
186   window=_this->end_window;
187   used=_this->nend_bits;
188   if(used+_bits>EC_WINDOW_SIZE){
189     do{
190       _this->error|=
191        ec_byte_write_at_end(_this->buf,(unsigned)window&EC_SYM_MAX);
192       window>>=EC_SYM_BITS;
193       used-=EC_SYM_BITS;
194     }
195     while(used>=EC_SYM_BITS);
196   }
197   window|=(ec_window)_fl<<used;
198   used+=_bits;
199   _this->end_window=window;
200   _this->nend_bits=used;
201   _this->nbits_total+=_bits;
202 }
203
204 ec_uint32 ec_enc_tell(ec_enc *_this,int _b){
205   ec_uint32 nbits;
206   ec_uint32 r;
207   int       l;
208   /*To handle the non-integral number of bits still left in the decoder state,
209      we compute the worst-case number of bits of low that must be encoded to
210      ensure that the value is inside the range for any possible subsequent
211      bits.
212     The computation here is independent of low itself (the decoder does not
213      even track that value), even though the real number of bits used after
214      ec_enc_done() may be 1 smaller if rng is a power of two and the
215      corresponding trailing bits of low are all zeros.
216     If we did try to track that special case, then coding a value with a
217      probability of 1/(1<<n) might sometimes appear to use more than n bits.
218     This may help explain the surprising result that a newly initialized
219      encoder claims to have used 1 bit.*/
220   nbits=_this->nbits_total<<_b;
221   l=EC_ILOG(_this->rng);
222   r=_this->rng>>l-16;
223   while(_b-->0){
224     int b;
225     r=r*r>>15;
226     b=(int)(r>>16);
227     l=l<<1|b;
228     r>>=b;
229   }
230   return nbits-l;
231 }
232
233 void ec_enc_done(ec_enc *_this){
234   ec_window window;
235   int       used;
236   ec_uint32 msk;
237   ec_uint32 end;
238   int       l;
239   /*We output the minimum number of bits that ensures that the symbols encoded
240      thus far will be decoded correctly regardless of the bits that follow.*/
241   l=EC_CODE_BITS-EC_ILOG(_this->rng);
242   msk=EC_CODE_TOP-1>>l;
243   end=_this->low+msk&~msk;
244   if((end|msk)>=_this->low+_this->rng){
245     l++;
246     msk>>=1;
247     end=_this->low+msk&~msk;
248   }
249   while(l>0){
250     ec_enc_carry_out(_this,(int)(end>>EC_CODE_SHIFT));
251     end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
252     l-=EC_SYM_BITS;
253   }
254   /*If we have a buffered byte flush it into the output buffer.*/
255   if(_this->rem>=0||_this->ext>0)ec_enc_carry_out(_this,0);
256   /*If we have buffered extra bits, flush them as well.*/
257   window=_this->end_window;
258   used=_this->nend_bits;
259   while(used>=EC_SYM_BITS){
260     _this->error|=
261      ec_byte_write_at_end(_this->buf,(unsigned)window&EC_SYM_MAX);
262     window>>=EC_SYM_BITS;
263     used-=EC_SYM_BITS;
264   }
265   /*Clear any excess space and add any remaining extra bits to the last byte.*/
266   if(!_this->error)_this->error=ec_byte_write_done(_this->buf,-l,window,used);
267 }