Some work on the pitch search weighting filter (still disabled)
[opus.git] / libcelt / mfrngdec.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 multiply-free 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   The coder is made multiply-free by replacing the standard multiply/divide
65    used to partition the current interval according to the total frequency
66    count.
67   The new partition function scales the count so that it differs from the size
68    of the interval by no more than a factor of two and then assigns each symbol
69    one or two code words in the interval.
70   For details see \cite{SM98}.
71
72   End of stream is handled by writing out the smallest number of bits that
73    ensures that the stream will be correctly decoded regardless of the value of
74    any subsequent bits.
75   ec_dec_tell() can be used to determine how many bits were needed to decode
76    all the symbols thus far; other data can be packed in the remaining bits of
77    the input buffer.
78
79   @PHDTHESIS{Pas76,
80     author="Richard Clark Pasco",
81     title="Source coding algorithms for fast data compression",
82     school="Dept. of Electrical Engineering, Stanford University",
83     address="Stanford, CA",
84     month=May,
85     year=1976
86   }
87   @INPROCEEDINGS{Mar79,
88    author="Martin, G.N.N.",
89    title="Range encoding: an algorithm for removing redundancy from a digitised
90     message",
91    booktitle="Video & Data Recording Conference",
92    year=1979,
93    address="Southampton",
94    month=Jul
95   }
96   @ARTICLE{MNW98,
97    author="Alistair Moffat and Radford Neal and Ian H. Witten",
98    title="Arithmetic Coding Revisited",
99    journal="{ACM} Transactions on Information Systems",
100    year=1998,
101    volume=16,
102    number=3,
103    pages="256--294",
104    month=Jul,
105    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
106   }
107   @INPROCEEDINGS{SM98,
108    author="Lang Stuiver and Alistair Moffat",
109    title="Piecewise Integer Mapping for Arithmetic Coding",
110    booktitle="Proceedings of the {IEEE} Data Compression Conference",
111    pages="1--10",
112    address="Snowbird, UT",
113    month="Mar./Apr.",
114    year=1998
115   }*/
116
117
118 /*Gets the next byte of input.
119   After all the bytes in the current packet have been consumed, and the extra
120    end code returned if needed, this function will continue to return zero each
121    time it is called.
122   Return: The next byte of input.*/
123 static int ec_dec_in(ec_dec *_this){
124   int ret;
125   ret=ec_byte_read1(_this->buf);
126   if(ret<0){
127     ret=0;
128     /*Needed to keep oc_dec_tell() operating correctly.*/
129     ec_byte_adv1(_this->buf);
130   }
131   return ret;
132 }
133
134 /*Normalizes the contents of dif and rng so that rng lies entirely in the
135    high-order symbol.*/
136 static inline void ec_dec_normalize(ec_dec *_this){
137   /*If the range is too small, rescale it and input some bits.*/
138   while(_this->rng<=EC_CODE_BOT){
139     int sym;
140     _this->rng<<=EC_SYM_BITS;
141     /*Use up the remaining bits from our last symbol.*/
142     sym=_this->rem<<EC_CODE_EXTRA&EC_SYM_MAX;
143     /*Read the next value from the input.*/
144     _this->rem=ec_dec_in(_this);
145     /*Take the rest of the bits we need from this new symbol.*/
146     sym|=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
147     _this->dif=(_this->dif<<EC_SYM_BITS)+sym&EC_CODE_MASK;
148     /*dif can never be larger than EC_CODE_TOP.
149       This is equivalent to the slightly more readable:
150       if(_this->dif>EC_CODE_TOP)_this->dif-=EC_CODE_TOP;*/
151     _this->dif^=_this->dif&_this->dif-1&EC_CODE_TOP;
152   }
153 }
154
155 void ec_dec_init(ec_dec *_this,ec_byte_buffer *_buf){
156   _this->buf=_buf;
157   _this->rem=ec_dec_in(_this);
158   _this->rng=1U<<EC_CODE_EXTRA;
159   _this->dif=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
160   /*Normalize the interval.*/
161   ec_dec_normalize(_this);
162   _this->end_bits_left=0;
163   _this->nb_end_bits=0;
164
165 }
166
167 unsigned ec_decode(ec_dec *_this,unsigned _ft){
168   ec_uint32 ft;
169   ec_uint32 d;
170   unsigned  e;
171   /*Step 1: Compute the normalization factor for the frequency counts.*/
172   _this->nrm=EC_ILOG(_this->rng)-EC_ILOG(_ft);
173   ft=(ec_uint32)_ft<<_this->nrm;
174   e=ft>_this->rng;
175   ft>>=e;
176   _this->nrm-=e;
177   /*Step 2: invert the partition function.*/
178   d=_this->rng-ft;
179   return EC_MAXI((ec_int32)(_this->dif>>1),(ec_int32)(_this->dif-d))>>
180    _this->nrm;
181   /*Step 3: The caller locates the range [fl,fh) containing the return value
182      and calls ec_dec_update().*/
183 }
184
185 unsigned ec_decode_bin(ec_dec *_this,unsigned bits){
186 #if 0
187   return ec_decode(_this, 1U<<bits);
188 #else
189   unsigned value=0;
190   int count=0;
191   _this->nb_end_bits += bits;
192   while (bits>=_this->end_bits_left)
193   {
194     value |= _this->end_byte>>(8-_this->end_bits_left)<<count;
195     count += _this->end_bits_left;
196     bits -= _this->end_bits_left;
197     _this->end_byte=ec_byte_look_at_end(_this->buf);
198     _this->end_bits_left = 8;
199   }
200   value |= ((_this->end_byte>>(8-_this->end_bits_left))&((1<<bits)-1))<<count;
201   _this->end_bits_left -= bits;
202   return value;
203 #endif
204 }
205
206 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
207   ec_uint32 fl;
208   ec_uint32 fh;
209   ec_uint32 ft;
210   ec_uint32 r;
211   ec_uint32 s;
212   ec_uint32 d;
213   /*Step 4: Evaluate the two partition function values.*/
214   fl=(ec_uint32)_fl<<_this->nrm;
215   fh=(ec_uint32)_fh<<_this->nrm;
216   ft=(ec_uint32)_ft<<_this->nrm;
217   d=_this->rng-ft;
218   r=fh+EC_MINI(fh,d);
219   s=fl+EC_MINI(fl,d);
220   /*Step 5: Update the interval.*/
221   _this->rng=r-s;
222   _this->dif-=s;
223   /*Step 6: Normalize the interval.*/
224   ec_dec_normalize(_this);
225 }
226
227 long ec_dec_tell(ec_dec *_this,int _b){
228   ec_uint32 r;
229   int       l;
230   long      nbits;
231   nbits=(ec_byte_bytes(_this->buf)-(EC_CODE_BITS+EC_SYM_BITS-1)/EC_SYM_BITS)*
232    EC_SYM_BITS;
233   /*To handle the non-integral number of bits still left in the decoder state,
234      we compute the number of bits of low that must be encoded to ensure that
235      the value is inside the range for any possible subsequent bits.*/
236   nbits+=EC_CODE_BITS+1+_this->nb_end_bits;
237   nbits<<=_b;
238   l=EC_ILOG(_this->rng);
239   r=_this->rng>>l-16;
240   while(_b-->0){
241     int b;
242     r=r*r>>15;
243     b=(int)(r>>16);
244     l=l<<1|b;
245     r>>=b;
246   }
247   return nbits-l;
248 }