Adds 3rd clause to CELT license
[opus.git] / celt / entdec.c
1 /* Copyright (c) 2001-2011 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 Internet Society, IETF or IETF Trust, nor the
16    names of specific contributors, may be used to endorse or promote
17    products derived from this software without specific prior written
18    permission.
19
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
24    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifdef HAVE_CONFIG_H
34 #include "config.h"
35 #endif
36
37 #include <stddef.h>
38 #include "os_support.h"
39 #include "arch.h"
40 #include "entdec.h"
41 #include "mfrngcod.h"
42
43 /*A range decoder.
44   This is an entropy decoder based upon \cite{Mar79}, which is itself a
45    rediscovery of the FIFO arithmetic code introduced by \cite{Pas76}.
46   It is very similar to arithmetic encoding, except that encoding is done with
47    digits in any base, instead of with bits, and so it is faster when using
48    larger bases (i.e.: a byte).
49   The author claims an average waste of $\frac{1}{2}\log_b(2b)$ bits, where $b$
50    is the base, longer than the theoretical optimum, but to my knowledge there
51    is no published justification for this claim.
52   This only seems true when using near-infinite precision arithmetic so that
53    the process is carried out with no rounding errors.
54
55   An excellent description of implementation details is available at
56    http://www.arturocampos.com/ac_range.html
57   A recent work \cite{MNW98} which proposes several changes to arithmetic
58    encoding for efficiency actually re-discovers many of the principles
59    behind range encoding, and presents a good theoretical analysis of them.
60
61   End of stream is handled by writing out the smallest number of bits that
62    ensures that the stream will be correctly decoded regardless of the value of
63    any subsequent bits.
64   ec_tell() can be used to determine how many bits were needed to decode
65    all the symbols thus far; other data can be packed in the remaining bits of
66    the input buffer.
67   @PHDTHESIS{Pas76,
68     author="Richard Clark Pasco",
69     title="Source coding algorithms for fast data compression",
70     school="Dept. of Electrical Engineering, Stanford University",
71     address="Stanford, CA",
72     month=May,
73     year=1976
74   }
75   @INPROCEEDINGS{Mar79,
76    author="Martin, G.N.N.",
77    title="Range encoding: an algorithm for removing redundancy from a digitised
78     message",
79    booktitle="Video & Data Recording Conference",
80    year=1979,
81    address="Southampton",
82    month=Jul
83   }
84   @ARTICLE{MNW98,
85    author="Alistair Moffat and Radford Neal and Ian H. Witten",
86    title="Arithmetic Coding Revisited",
87    journal="{ACM} Transactions on Information Systems",
88    year=1998,
89    volume=16,
90    number=3,
91    pages="256--294",
92    month=Jul,
93    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
94   }*/
95
96 static int ec_read_byte(ec_dec *_this){
97   return _this->offs<_this->storage?_this->buf[_this->offs++]:0;
98 }
99
100 static int ec_read_byte_from_end(ec_dec *_this){
101   return _this->end_offs<_this->storage?
102    _this->buf[_this->storage-++(_this->end_offs)]:0;
103 }
104
105 /*Normalizes the contents of val and rng so that rng lies entirely in the
106    high-order symbol.*/
107 static void ec_dec_normalize(ec_dec *_this){
108   /*If the range is too small, rescale it and input some bits.*/
109   while(_this->rng<=EC_CODE_BOT){
110     int sym;
111     _this->nbits_total+=EC_SYM_BITS;
112     _this->rng<<=EC_SYM_BITS;
113     /*Use up the remaining bits from our last symbol.*/
114     sym=_this->rem;
115     /*Read the next value from the input.*/
116     _this->rem=ec_read_byte(_this);
117     /*Take the rest of the bits we need from this new symbol.*/
118     sym=(sym<<EC_SYM_BITS|_this->rem)>>(EC_SYM_BITS-EC_CODE_EXTRA);
119     /*And subtract them from val, capped to be less than EC_CODE_TOP.*/
120     _this->val=((_this->val<<EC_SYM_BITS)+(EC_SYM_MAX&~sym))&(EC_CODE_TOP-1);
121   }
122 }
123
124 void ec_dec_init(ec_dec *_this,unsigned char *_buf,opus_uint32 _storage){
125   _this->buf=_buf;
126   _this->storage=_storage;
127   _this->end_offs=0;
128   _this->end_window=0;
129   _this->nend_bits=0;
130   /*This is the offset from which ec_tell() will subtract partial bits.
131     The final value after the ec_dec_normalize() call will be the same as in
132      the encoder, but we have to compensate for the bits that are added there.*/
133   _this->nbits_total=EC_CODE_BITS+1
134    -((EC_CODE_BITS-EC_CODE_EXTRA)/EC_SYM_BITS)*EC_SYM_BITS;
135   _this->offs=0;
136   _this->rng=1U<<EC_CODE_EXTRA;
137   _this->rem=ec_read_byte(_this);
138   _this->val=_this->rng-1-(_this->rem>>(EC_SYM_BITS-EC_CODE_EXTRA));
139   _this->error=0;
140   /*Normalize the interval.*/
141   ec_dec_normalize(_this);
142 }
143
144 unsigned ec_decode(ec_dec *_this,unsigned _ft){
145   unsigned s;
146   _this->ext=_this->rng/_ft;
147   s=(unsigned)(_this->val/_this->ext);
148   return _ft-EC_MINI(s+1,_ft);
149 }
150
151 unsigned ec_decode_bin(ec_dec *_this,unsigned _bits){
152    unsigned s;
153    _this->ext=_this->rng>>_bits;
154    s=(unsigned)(_this->val/_this->ext);
155    return (1U<<_bits)-EC_MINI(s+1U,1U<<_bits);
156 }
157
158 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
159   opus_uint32 s;
160   s=IMUL32(_this->ext,_ft-_fh);
161   _this->val-=s;
162   _this->rng=_fl>0?IMUL32(_this->ext,_fh-_fl):_this->rng-s;
163   ec_dec_normalize(_this);
164 }
165
166 /*The probability of having a "one" is 1/(1<<_logp).*/
167 int ec_dec_bit_logp(ec_dec *_this,unsigned _logp){
168   opus_uint32 r;
169   opus_uint32 d;
170   opus_uint32 s;
171   int         ret;
172   r=_this->rng;
173   d=_this->val;
174   s=r>>_logp;
175   ret=d<s;
176   if(!ret)_this->val=d-s;
177   _this->rng=ret?s:r-s;
178   ec_dec_normalize(_this);
179   return ret;
180 }
181
182 int ec_dec_icdf(ec_dec *_this,const unsigned char *_icdf,unsigned _ftb){
183   opus_uint32 r;
184   opus_uint32 d;
185   opus_uint32 s;
186   opus_uint32 t;
187   int         ret;
188   s=_this->rng;
189   d=_this->val;
190   r=s>>_ftb;
191   ret=-1;
192   do{
193     t=s;
194     s=IMUL32(r,_icdf[++ret]);
195   }
196   while(d<s);
197   _this->val=d-s;
198   _this->rng=t-s;
199   ec_dec_normalize(_this);
200   return ret;
201 }
202
203 opus_uint32 ec_dec_uint(ec_dec *_this,opus_uint32 _ft){
204   unsigned ft;
205   unsigned s;
206   int      ftb;
207   /*In order to optimize EC_ILOG(), it is undefined for the value 0.*/
208   celt_assert(_ft>1);
209   _ft--;
210   ftb=EC_ILOG(_ft);
211   if(ftb>EC_UINT_BITS){
212     opus_uint32 t;
213     ftb-=EC_UINT_BITS;
214     ft=(unsigned)(_ft>>ftb)+1;
215     s=ec_decode(_this,ft);
216     ec_dec_update(_this,s,s+1,ft);
217     t=(opus_uint32)s<<ftb|ec_dec_bits(_this,ftb);
218     if(t<=_ft)return t;
219     _this->error=1;
220     return _ft;
221   }
222   else{
223     _ft++;
224     s=ec_decode(_this,(unsigned)_ft);
225     ec_dec_update(_this,s,s+1,(unsigned)_ft);
226     return s;
227   }
228 }
229
230 opus_uint32 ec_dec_bits(ec_dec *_this,unsigned _bits){
231   ec_window   window;
232   int         available;
233   opus_uint32 ret;
234   window=_this->end_window;
235   available=_this->nend_bits;
236   if((unsigned)available<_bits){
237     do{
238       window|=(ec_window)ec_read_byte_from_end(_this)<<available;
239       available+=EC_SYM_BITS;
240     }
241     while(available<=EC_WINDOW_SIZE-EC_SYM_BITS);
242   }
243   ret=(opus_uint32)window&(((opus_uint32)1<<_bits)-1U);
244   window>>=_bits;
245   available-=_bits;
246   _this->end_window=window;
247   _this->nend_bits=available;
248   _this->nbits_total+=_bits;
249   return ret;
250 }