Fixes some issues in the MF range coder on systems were ints are 16 bits.
[opus.git] / libcelt / mfrngdec.c
1 #ifdef HAVE_CONFIG_H
2 #include "config.h"
3 #endif
4
5 #include "arch.h"
6 #include "entdec.h"
7 #include "mfrngcod.h"
8
9
10
11 /*A multiply-free range decoder.
12   This is an entropy decoder based upon \cite{Mar79}, which is itself a
13    rediscovery of the FIFO arithmetic code introduced by \cite{Pas76}.
14   It is very similar to arithmetic encoding, except that encoding is done with
15    digits in any base, instead of with bits, and so it is faster when using
16    larger bases (i.e.: a byte).
17   The author claims an average waste of $\frac{1}{2}\log_b(2b)$ bits, where $b$
18    is the base, longer than the theoretical optimum, but to my knowledge there
19    is no published justification for this claim.
20   This only seems true when using near-infinite precision arithmetic so that
21    the process is carried out with no rounding errors.
22
23   IBM (the author's employer) never sought to patent the idea, and to my
24    knowledge the algorithm is unencumbered by any patents, though its
25    performance is very competitive with proprietary arithmetic coding.
26   The two are based on very similar ideas, however.
27   An excellent description of implementation details is available at
28    http://www.arturocampos.com/ac_range.html
29   A recent work \cite{MNW98} which proposes several changes to arithmetic
30    encoding for efficiency actually re-discovers many of the principles
31    behind range encoding, and presents a good theoretical analysis of them.
32
33   The coder is made multiply-free by replacing the standard multiply/divide
34    used to partition the current interval according to the total frequency
35    count.
36   The new partition function scales the count so that it differs from the size
37    of the interval by no more than a factor of two and then assigns each symbol
38    one or two code words in the interval.
39   For details see \cite{SM98}.
40
41   This coder also handles the end of the stream in a slightly more graceful
42    fashion than most arithmetic or range coders.
43   Once the final symbol has been encoded, the coder selects the code word with
44    the shortest number of bits that still falls within the final interval.
45   This method is not novel.
46   Here, by the length of the code word, we refer to the number of bits until
47    its final 1.
48   Any trailing zeros may be discarded, since the encoder, once it runs out of
49    input, will pad its buffer with zeros.
50
51   But this means that no encoded stream would ever have any zero bytes at the
52    end.
53   Since there are some coded representations we cannot produce, it implies that
54    there is still some redundancy in the stream.
55   In this case, we can pick a special byte value, RSV1, and should the stream
56    end in a sequence of zeros, followed by the RSV1 byte, we can code the
57    zeros, and discard the RSV1 byte.
58   The decoder, knowing that the encoder would never produce a sequence of zeros
59    at the end, would then know to add in the RSV1 byte if it observed it.
60
61   Now, the encoder would never produce a stream that ended in a sequence of
62    zeros followed by a RSV1 byte.
63   So, if the stream ends in a non-empty sequence of zeros, followed by any
64    positive number of RSV1 bytes, the last RSV1 byte is discarded.
65   The decoder, if it encounters a stream that ends in non-empty sequence of
66    zeros followed by any non-negative number of RSV1 bytes, adds an additional
67    RSV1 byte to the stream.
68   With this strategy, every possible sequence of input bytes is transformed to
69    one that could actually be produced by the encoder.
70
71   The only question is what non-zero value to use for RSV1.
72   We select 0x80, since it has the nice property of producing the shortest
73    possible byte streams when using our strategy for selecting a number within
74    the final interval to encode.
75   Clearly if the shortest possible code word that falls within the interval has
76    its last one bit as the most significant bit of the final byte, and the
77    previous bytes were a non-empty sequence of zeros followed by a non-negative
78    number of 0x80 bytes, then the last byte would be discarded.
79   If the shortest code word is not so formed, then no other code word in the
80    interval would result in any more bytes being discarded.
81   Any longer code word would have an additional one bit somewhere, and so would
82    require at a minimum that that byte would be coded.
83   If the shortest code word has a 1 before the final one that is preventing the
84    stream from ending in a non-empty sequence of zeros followed by a
85    non-negative number of 0x80's, then there is no code word of the same length
86    which contains that bit as a zero.
87   If there were, then we could simply leave that bit a 1, and drop all the bits
88    after it without leaving the interval, thus producing a shorter code word.
89
90   In this case, RSV1 can only drop 1 bit off the final stream.
91   Other choices could lead to savings of up to 8 bits for particular streams,
92    but this would produce the odd situation that a stream with more non-zero
93    bits is actually encoded in fewer bytes.
94
95   @PHDTHESIS{Pas76,
96     author="Richard Clark Pasco",
97     title="Source coding algorithms for fast data compression",
98     school="Dept. of Electrical Engineering, Stanford University",
99     address="Stanford, CA",
100     month=May,
101     year=1976
102   }
103   @INPROCEEDINGS{Mar79,
104    author="Martin, G.N.N.",
105    title="Range encoding: an algorithm for removing redundancy from a digitised
106     message",
107    booktitle="Video & Data Recording Conference",
108    year=1979,
109    address="Southampton",
110    month=Jul
111   }
112   @ARTICLE{MNW98,
113    author="Alistair Moffat and Radford Neal and Ian H. Witten",
114    title="Arithmetic Coding Revisited",
115    journal="{ACM} Transactions on Information Systems",
116    year=1998,
117    volume=16,
118    number=3,
119    pages="256--294",
120    month=Jul,
121    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
122   }
123   @INPROCEEDINGS{SM98,
124    author="Lang Stuiver and Alistair Moffat",
125    title="Piecewise Integer Mapping for Arithmetic Coding",
126    booktitle="Proceedings of the {IEEE} Data Compression Conference",
127    pages="1--10",
128    address="Snowbird, UT",
129    month="Mar./Apr.",
130    year=1998
131   }*/
132
133
134 /*Gets the next byte of input.
135   After all the bytes in the current packet have been consumed, and the extra
136    end code returned if needed, this function will continue to return zero each
137    time it is called.
138   Return: The next byte of input.*/
139 static int ec_dec_in(ec_dec *_this){
140   int ret;
141   ret=ec_byte_read1(_this->buf);
142   if(ret<0){
143     ret=0;
144     /*Needed to keep oc_dec_tell() operating correctly.*/
145     ec_byte_adv1(_this->buf);
146   }
147   return ret;
148 }
149
150 /*Normalizes the contents of dif and rng so that rng lies entirely in the
151    high-order symbol.*/
152 static inline void ec_dec_normalize(ec_dec *_this){
153   /*If the range is too small, rescale it and input some bits.*/
154   while(_this->rng<=EC_CODE_BOT){
155     int sym;
156     _this->rng<<=EC_SYM_BITS;
157     /*Use up the remaining bits from our last symbol.*/
158     sym=_this->rem<<EC_CODE_EXTRA&EC_SYM_MAX;
159     /*Read the next value from the input.*/
160     _this->rem=ec_dec_in(_this);
161     /*Take the rest of the bits we need from this new symbol.*/
162     sym|=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
163     _this->dif=(_this->dif<<EC_SYM_BITS)+sym&EC_CODE_MASK;
164     /*dif can never be larger than EC_CODE_TOP.
165       This is equivalent to the slightly more readable:
166       if(_this->dif>EC_CODE_TOP)_this->dif-=EC_CODE_TOP;*/
167     _this->dif^=_this->dif&_this->dif-1&EC_CODE_TOP;
168   }
169 }
170
171 void ec_dec_init(ec_dec *_this,ec_byte_buffer *_buf){
172   _this->buf=_buf;
173   _this->rem=ec_dec_in(_this);
174   _this->rng=1U<<EC_CODE_EXTRA;
175   _this->dif=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
176   /*Normalize the interval.*/
177   ec_dec_normalize(_this);
178 }
179
180 unsigned ec_decode(ec_dec *_this,unsigned _ft){
181   ec_uint32 ft;
182   ec_uint32 d;
183   unsigned  e;
184   /*Step 1: Compute the normalization factor for the frequency counts.*/
185   _this->nrm=EC_ILOG(_this->rng)-EC_ILOG(_ft);
186   ft=(ec_uint32)_ft<<_this->nrm;
187   e=ft>_this->rng;
188   ft>>=e;
189   _this->nrm-=e;
190   /*Step 2: invert the partition function.*/
191   d=_this->rng-ft;
192   return EC_MAXI((ec_int32)(_this->dif>>1),(ec_int32)(_this->dif-d))>>
193    _this->nrm;
194   /*Step 3: The caller locates the range [fl,fh) containing the return value
195      and calls ec_dec_update().*/
196 }
197
198 unsigned ec_decode_bin(ec_dec *_this,unsigned bits){
199   return ec_decode(_this, 1U<<bits);
200 }
201
202 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
203   ec_uint32 fl;
204   ec_uint32 fh;
205   ec_uint32 ft;
206   ec_uint32 r;
207   ec_uint32 s;
208   ec_uint32 d;
209   /*Step 4: Evaluate the two partition function values.*/
210   fl=(ec_uint32)_fl<<_this->nrm;
211   fh=(ec_uint32)_fh<<_this->nrm;
212   ft=(ec_uint32)_ft<<_this->nrm;
213   d=_this->rng-ft;
214   r=fh+EC_MINI(fh,d);
215   s=fl+EC_MINI(fl,d);
216   /*Step 5: Update the interval.*/
217   _this->rng=r-s;
218   _this->dif-=s;
219   /*Step 6: Normalize the interval.*/
220   ec_dec_normalize(_this);
221 }
222
223 long ec_dec_tell(ec_dec *_this,int _b){
224   ec_uint32 r;
225   int       l;
226   long      nbits;
227   nbits=(ec_byte_bytes(_this->buf)-(EC_CODE_BITS+EC_SYM_BITS-1)/EC_SYM_BITS)*
228    EC_SYM_BITS;
229   /*To handle the non-integral number of bits still left in the encoder state,
230      we compute the number of bits of low that must be encoded to ensure that
231      the value is inside the range for any possible subsequent bits.
232     Note that this is subtly different than the actual value we would end the
233      stream with, which tries to make as many of the trailing bits zeros as
234      possible.*/
235   nbits+=EC_CODE_BITS;
236   nbits<<=_b;
237   l=EC_ILOG(_this->rng);
238   r=_this->rng>>l-16;
239   while(_b-->0){
240     int b;
241     r=r*r>>15;
242     b=(int)(r>>16);
243     l=l<<1|b;
244     r>>=b;
245   }
246   return nbits-l;
247 }
248
249 #if 0
250 int ec_dec_done(ec_dec *_this){
251   unsigned low;
252   int      ret;
253   /*Check to make sure we've used all the input bytes.
254     This ensures that no more ones would ever be inserted into the decoder.*/
255   if(_this->buf->ptr-ec_byte_get_buffer(_this->buf)<=
256    ec_byte_bytes(_this->buf)){
257     return 0;
258   }
259   /*We compute the smallest finitely odd fraction that fits inside the current
260      range, and write that to the stream.
261     This is guaranteed to yield the smallest possible encoding.*/
262   /*TODO: Fix this line, as it is wrong.
263     It doesn't seem worth being able to make this check to do an extra
264      subtraction for every symbol decoded.*/
265   low=/*What we want: _this->top-_this->rng; What we have:*/_this->dif
266   if(low){
267     unsigned end;
268     end=EC_CODE_TOP;
269     /*Ensure that the next free end is in the range.*/
270     if(end-low>=_this->rng){
271       unsigned msk;
272       msk=EC_CODE_TOP-1;
273       do{
274         msk>>=1;
275         end=low+msk&~msk|msk+1;
276       }
277       while(end-low>=_this->rng);
278     }
279     /*The remaining input should have been the next free end.*/
280     return end-low!=_this->dif;
281   }
282   return 1;
283 }
284 #endif