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