Don't rebalance bits for itheta=0 or 16384
[opus.git] / libcelt / rangedec.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 "entdec.h"
38 #include "mfrngcod.h"
39
40
41
42 /*A range decoder.
43   This is an entropy decoder based upon \cite{Mar79}, which is itself a
44    rediscovery of the FIFO arithmetic code introduced by \cite{Pas76}.
45   It is very similar to arithmetic encoding, except that encoding is done with
46    digits in any base, instead of with bits, and so it is faster when using
47    larger bases (i.e.: a byte).
48   The author claims an average waste of $\frac{1}{2}\log_b(2b)$ bits, where $b$
49    is the base, longer than the theoretical optimum, but to my knowledge there
50    is no published justification for this claim.
51   This only seems true when using near-infinite precision arithmetic so that
52    the process is carried out with no rounding errors.
53
54   IBM (the author's employer) never sought to patent the idea, and to my
55    knowledge the algorithm is unencumbered by any patents, though its
56    performance is very competitive with proprietary arithmetic coding.
57   The two are based on very similar ideas, however.
58   An excellent description of implementation details is available at
59    http://www.arturocampos.com/ac_range.html
60   A recent work \cite{MNW98} which proposes several changes to arithmetic
61    encoding for efficiency actually re-discovers many of the principles
62    behind range encoding, and presents a good theoretical analysis of them.
63
64   End of stream is handled by writing out the smallest number of bits that
65    ensures that the stream will be correctly decoded regardless of the value of
66    any subsequent bits.
67   ec_dec_tell() can be used to determine how many bits were needed to decode
68    all the symbols thus far; other data can be packed in the remaining bits of
69    the input buffer.
70   @PHDTHESIS{Pas76,
71     author="Richard Clark Pasco",
72     title="Source coding algorithms for fast data compression",
73     school="Dept. of Electrical Engineering, Stanford University",
74     address="Stanford, CA",
75     month=May,
76     year=1976
77   }
78   @INPROCEEDINGS{Mar79,
79    author="Martin, G.N.N.",
80    title="Range encoding: an algorithm for removing redundancy from a digitised
81     message",
82    booktitle="Video & Data Recording Conference",
83    year=1979,
84    address="Southampton",
85    month=Jul
86   }
87   @ARTICLE{MNW98,
88    author="Alistair Moffat and Radford Neal and Ian H. Witten",
89    title="Arithmetic Coding Revisited",
90    journal="{ACM} Transactions on Information Systems",
91    year=1998,
92    volume=16,
93    number=3,
94    pages="256--294",
95    month=Jul,
96    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
97   }*/
98
99
100 /*Normalizes the contents of dif and rng so that rng lies entirely in the
101    high-order symbol.*/
102 static inline void ec_dec_normalize(ec_dec *_this){
103   /*If the range is too small, rescale it and input some bits.*/
104   while(_this->rng<=EC_CODE_BOT){
105     int sym;
106     _this->nbits_total+=EC_SYM_BITS;
107     _this->rng<<=EC_SYM_BITS;
108     /*Use up the remaining bits from our last symbol.*/
109     sym=_this->rem;
110     /*Read the next value from the input.*/
111     _this->rem=ec_byte_read(_this->buf);
112     /*Take the rest of the bits we need from this new symbol.*/
113     sym=(sym<<EC_SYM_BITS|_this->rem)>>EC_SYM_BITS-EC_CODE_EXTRA;
114     /*And subtract them from dif, capped to be less than EC_CODE_TOP.*/
115     _this->dif=(_this->dif<<EC_SYM_BITS)+(EC_SYM_MAX&~sym)&EC_CODE_TOP-1;
116   }
117 }
118
119 void ec_dec_init(ec_dec *_this,ec_byte_buffer *_buf){
120   _this->buf=_buf;
121   _this->rem=ec_byte_read(_buf);
122   _this->rng=1U<<EC_CODE_EXTRA;
123   _this->dif=_this->rng-1-(_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA);
124   /*Normalize the interval.*/
125   ec_dec_normalize(_this);
126   _this->end_window=0;
127   _this->nend_bits=0;
128   /*This is the offset from which ec_enc_tell() will subtract partial bits.
129     This must be after the initial ec_dec_normalize(), or you will have to
130      compensate for the bits that are read there.*/
131   _this->nbits_total=EC_CODE_BITS+1;
132   _this->error=0;
133 }
134
135
136 unsigned ec_decode(ec_dec *_this,unsigned _ft){
137   unsigned s;
138   _this->nrm=_this->rng/_ft;
139   s=(unsigned)(_this->dif/_this->nrm);
140   return _ft-EC_MINI(s+1,_ft);
141 }
142
143 unsigned ec_decode_bin(ec_dec *_this,unsigned _bits){
144    unsigned s;
145    _this->nrm=_this->rng>>_bits;
146    s=(unsigned)(_this->dif/_this->nrm);
147    return (1<<_bits)-EC_MINI(s+1,1<<_bits);
148 }
149
150 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
151   ec_uint32 s;
152   s=IMUL32(_this->nrm,_ft-_fh);
153   _this->dif-=s;
154   _this->rng=_fl>0?IMUL32(_this->nrm,_fh-_fl):_this->rng-s;
155   ec_dec_normalize(_this);
156 }
157
158 /*The probability of having a "one" is given in 1/65536.*/
159 int ec_dec_bit_prob(ec_dec *_this,unsigned _prob){
160   ec_uint32 r;
161   ec_uint32 d;
162   ec_uint32 s;
163   int       val;
164   r=_this->rng;
165   d=_this->dif;
166   s=(r>>16)*_prob;
167   val=d<s;
168   if(!val)_this->dif=d-s;
169   _this->rng=val?s:r-s;
170   ec_dec_normalize(_this);
171   return val;
172 }
173
174 /*The probability of having a "one" is 1/(1<<_logp).*/
175 int ec_dec_bit_logp(ec_dec *_this,unsigned _logp){
176   ec_uint32 r;
177   ec_uint32 d;
178   ec_uint32 s;
179   int       val;
180   r=_this->rng;
181   d=_this->dif;
182   s=r>>_logp;
183   val=d<s;
184   if(!val)_this->dif=d-s;
185   _this->rng=val?s:r-s;
186   ec_dec_normalize(_this);
187   return val;
188 }
189
190 int ec_dec_icdf(ec_dec *_this,const unsigned char *_icdf,unsigned _ftb){
191   ec_uint32 r;
192   ec_uint32 d;
193   ec_uint32 s;
194   ec_uint32 t;
195   int       val;
196   s=_this->rng;
197   d=_this->dif;
198   r=s>>_ftb;
199   val=0;
200   do{
201     t=s;
202     s=IMUL32(r,_icdf[val++]);
203   }
204   while(d<s);
205   _this->dif=d-s;
206   _this->rng=t-s;
207   ec_dec_normalize(_this);
208   return val-1;
209 }
210
211 ec_uint32 ec_dec_bits(ec_dec *_this,unsigned _bits){
212   ec_window window;
213   int       available;
214   ec_uint32 ret;
215   window=_this->end_window;
216   available=_this->nend_bits;
217   if(available<_bits){
218     do{
219       window|=(ec_window)ec_byte_read_from_end(_this->buf)<<available;
220       available+=EC_SYM_BITS;
221     }
222     while(available<=EC_WINDOW_SIZE-EC_SYM_BITS);
223   }
224   ret=(ec_uint32)window&((ec_uint32)1<<_bits)-1;
225   window>>=_bits;
226   available-=_bits;
227   _this->end_window=window;
228   _this->nend_bits=available;
229   _this->nbits_total+=_bits;
230   return ret;
231 }
232
233 ec_uint32 ec_dec_tell(ec_dec *_this,int _b){
234   ec_uint32 nbits;
235   ec_uint32 r;
236   int       l;
237   /*To handle the non-integral number of bits still left in the decoder state,
238      we compute the worst-case number of bits of low that must be encoded to
239      ensure that the value is inside the range for any possible subsequent
240      bits.
241     The computation here is independent of low itself (the decoder does not
242      even track that value), even though the real number of bits used after
243      ec_enc_done() may be 1 smaller if rng is a power of two and the
244      corresponding trailing bits of low are all zeros.
245     If we did try to track that special case, then coding a value with a
246      probability of 1/(1<<n) might sometimes appear to use more than n bits.
247     This may help explain the surprising result that a newly initialized
248      decoder claims to have used 1 bit.*/
249   nbits=_this->nbits_total<<_b;
250   l=EC_ILOG(_this->rng);
251   r=_this->rng>>l-16;
252   while(_b-->0){
253     int b;
254     r=r*r>>15;
255     b=(int)(r>>16);
256     l=l<<1|b;
257     r>>=b;
258   }
259   return nbits-l;
260 }