C89 compatibility fixes for pseudo-stack mode.
[opus.git] / libcelt / rangedec.c
1 /* (C) 2001-2008 Timothy B. Terriberry
2    (C) 2008 Jean-Marc Valin */
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   @PHDTHESIS{Pas76,
65     author="Richard Clark Pasco",
66     title="Source coding algorithms for fast data compression",
67     school="Dept. of Electrical Engineering, Stanford University",
68     address="Stanford, CA",
69     month=May,
70     year=1976
71   }
72   @INPROCEEDINGS{Mar79,
73    author="Martin, G.N.N.",
74    title="Range encoding: an algorithm for removing redundancy from a digitised
75     message",
76    booktitle="Video & Data Recording Conference",
77    year=1979,
78    address="Southampton",
79    month=Jul
80   }
81   @ARTICLE{MNW98,
82    author="Alistair Moffat and Radford Neal and Ian H. Witten",
83    title="Arithmetic Coding Revisited",
84    journal="{ACM} Transactions on Information Systems",
85    year=1998,
86    volume=16,
87    number=3,
88    pages="256--294",
89    month=Jul,
90    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
91   }*/
92
93
94 /*Gets the next byte of input.
95   After all the bytes in the current packet have been consumed, and the extra
96    end code returned if needed, this function will continue to return zero each
97    time it is called.
98   Return: The next byte of input.*/
99 static int ec_dec_in(ec_dec *_this){
100   int ret;
101   ret=ec_byte_read1(_this->buf);
102   if(ret<0){
103     ret=0;
104     /*Needed to keep oc_dec_tell() operating correctly.*/
105     ec_byte_adv1(_this->buf);
106   }
107   return ret;
108 }
109
110 /*Normalizes the contents of dif and rng so that rng lies entirely in the
111    high-order symbol.*/
112 static inline void ec_dec_normalize(ec_dec *_this){
113   /*If the range is too small, rescale it and input some bits.*/
114   while(_this->rng<=EC_CODE_BOT){
115     int sym;
116     _this->rng<<=EC_SYM_BITS;
117     /*Use up the remaining bits from our last symbol.*/
118     sym=_this->rem<<EC_CODE_EXTRA&EC_SYM_MAX;
119     /*Read the next value from the input.*/
120     _this->rem=ec_dec_in(_this);
121     /*Take the rest of the bits we need from this new symbol.*/
122     sym|=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
123     _this->dif=(_this->dif<<EC_SYM_BITS)-sym&EC_CODE_MASK;
124     /*dif can never be larger than EC_CODE_TOP.
125       This is equivalent to the slightly more readable:
126       if(_this->dif>EC_CODE_TOP)_this->dif-=EC_CODE_TOP;*/
127     _this->dif^=_this->dif&_this->dif-1&EC_CODE_TOP;
128   }
129 }
130
131 void ec_dec_init(ec_dec *_this,ec_byte_buffer *_buf){
132   _this->buf=_buf;
133   _this->rem=ec_dec_in(_this);
134   _this->rng=1U<<EC_CODE_EXTRA;
135   _this->dif=_this->rng-(_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA);
136   /*Normalize the interval.*/
137   ec_dec_normalize(_this);
138 }
139
140
141 unsigned ec_decode(ec_dec *_this,unsigned _ft){
142   unsigned s;
143   _this->nrm=_this->rng/_ft;
144   s=(unsigned)((_this->dif-1)/_this->nrm);
145   return _ft-EC_MINI(s+1,_ft);
146 }
147
148 unsigned ec_decode_bin(ec_dec *_this,unsigned bits){
149    unsigned s;
150    ec_uint32 ft;
151    ft = (ec_uint32)1<<bits;
152    _this->nrm=_this->rng>>bits;
153    s=(unsigned)((_this->dif-1)/_this->nrm);
154    return ft-EC_MINI(s+1,ft);
155 }
156
157 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
158   ec_uint32 s;
159   s=IMUL32(_this->nrm,(_ft-_fh));
160   _this->dif-=s;
161   _this->rng=_fl>0?IMUL32(_this->nrm,(_fh-_fl)):_this->rng-s;
162   ec_dec_normalize(_this);
163 }
164
165 long ec_dec_tell(ec_dec *_this,int _b){
166   ec_uint32 r;
167   int       l;
168   long      nbits;
169   nbits=(ec_byte_bytes(_this->buf)-(EC_CODE_BITS+EC_SYM_BITS-1)/EC_SYM_BITS)*
170    EC_SYM_BITS;
171   /*To handle the non-integral number of bits still left in the encoder state,
172      we compute the number of bits of low that must be encoded to ensure that
173      the value is inside the range for any possible subsequent bits.
174     Note that this is subtly different than the actual value we would end the
175      stream with, which tries to make as many of the trailing bits zeros as
176      possible.*/
177   nbits+=EC_CODE_BITS;
178   nbits<<=_b;
179   l=EC_ILOG(_this->rng);
180   r=_this->rng>>l-16;
181   while(_b-->0){
182     int b;
183     r=r*r>>15;
184     b=(int)(r>>16);
185     l=l<<1|b;
186     r>>=b;
187   }
188   return nbits-l;
189 }
190
191 #if 0
192 int ec_dec_done(ec_dec *_this){
193   unsigned low;
194   int      ret;
195   /*Check to make sure we've used all the input bytes.
196     This ensures that no more ones would ever be inserted into the decoder.*/
197   if(_this->buf->ptr-ec_byte_get_buffer(_this->buf)<=
198    ec_byte_bytes(_this->buf)){
199     return 0;
200   }
201   /*We compute the smallest finitely odd fraction that fits inside the current
202      range, and write that to the stream.
203     This is guaranteed to yield the smallest possible encoding.*/
204   /*TODO: Fix this line, as it is wrong.
205     It doesn't seem worth being able to make this check to do an extra
206      subtraction for every symbol decoded.*/
207   low=/*What we want: _this->top-_this->rng; What we have:*/_this->dif
208   if(low){
209     unsigned end;
210     end=EC_CODE_TOP;
211     /*Ensure that the next free end is in the range.*/
212     if(end-low>=_this->rng){
213       unsigned msk;
214       msk=EC_CODE_TOP-1;
215       do{
216         msk>>=1;
217         end=(low+msk)&~msk|msk+1;
218       }
219       while(end-low>=_this->rng);
220     }
221     /*The remaining input should have been the next free end.*/
222     return end-low!=_this->dif;
223   }
224   return 1;
225 }
226 #endif