More C89 fixes, making sure to include config.h from all source files.
[opus.git] / libcelt / rangedec.c
1 #ifdef HAVE_CONFIG_H
2 #include "config.h"
3 #endif
4
5 #include <stddef.h>
6 #include "entdec.h"
7 #include "mfrngcod.h"
8
9
10
11 /*A 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   This coder handles the end of the stream in a slightly more graceful fashion
34    than most arithmetic or range coders.
35   Once the final symbol has been encoded, the coder selects the code word with
36    the shortest number of bits that still falls within the final interval.
37   This method is not novel.
38   Here, by the length of the code word, we refer to the number of bits until
39    its final 1.
40   Any trailing zeros may be discarded, since the encoder, once it runs out of
41    input, will pad its buffer with zeros.
42
43   But this means that no encoded stream would ever have any zero bytes at the
44    end.
45   Since there are some coded representations we cannot produce, it implies that
46    there is still some redundancy in the stream.
47   In this case, we can pick a special byte value, RSV1, and should the stream
48    end in a sequence of zeros, followed by the RSV1 byte, we can code the
49    zeros, and discard the RSV1 byte.
50   The decoder, knowing that the encoder would never produce a sequence of zeros
51    at the end, would then know to add in the RSV1 byte if it observed it.
52
53   Now, the encoder would never produce a stream that ended in a sequence of
54    zeros followed by a RSV1 byte.
55   So, if the stream ends in a non-empty sequence of zeros, followed by any
56    positive number of RSV1 bytes, the last RSV1 byte is discarded.
57   The decoder, if it encounters a stream that ends in non-empty sequence of
58    zeros followed by any non-negative number of RSV1 bytes, adds an additional
59    RSV1 byte to the stream.
60   With this strategy, every possible sequence of input bytes is transformed to
61    one that could actually be produced by the encoder.
62
63   The only question is what non-zero value to use for RSV1.
64   We select 0x80, since it has the nice property of producing the shortest
65    possible byte streams when using our strategy for selecting a number within
66    the final interval to encode.
67   Clearly if the shortest possible code word that falls within the interval has
68    its last one bit as the most significant bit of the final byte, and the
69    previous bytes were a non-empty sequence of zeros followed by a non-negative
70    number of 0x80 bytes, then the last byte would be discarded.
71   If the shortest code word is not so formed, then no other code word in the
72    interval would result in any more bytes being discarded.
73   Any longer code word would have an additional one bit somewhere, and so would
74    require at a minimum that that byte would be coded.
75   If the shortest code word has a 1 before the final one that is preventing the
76    stream from ending in a non-empty sequence of zeros followed by a
77    non-negative number of 0x80's, then there is no code word of the same length
78    which contains that bit as a zero.
79   If there were, then we could simply leave that bit a 1, and drop all the bits
80    after it without leaving the interval, thus producing a shorter code word.
81
82   In this case, RSV1 can only drop 1 bit off the final stream.
83   Other choices could lead to savings of up to 8 bits for particular streams,
84    but this would produce the odd situation that a stream with more non-zero
85    bits is actually encoded in fewer bytes.
86
87   @PHDTHESIS{Pas76,
88     author="Richard Clark Pasco",
89     title="Source coding algorithms for fast data compression",
90     school="Dept. of Electrical Engineering, Stanford University",
91     address="Stanford, CA",
92     month=May,
93     year=1976
94   }
95   @INPROCEEDINGS{Mar79,
96    author="Martin, G.N.N.",
97    title="Range encoding: an algorithm for removing redundancy from a digitised
98     message",
99    booktitle="Video & Data Recording Conference",
100    year=1979,
101    address="Southampton",
102    month=Jul
103   }
104   @ARTICLE{MNW98,
105    author="Alistair Moffat and Radford Neal and Ian H. Witten",
106    title="Arithmetic Coding Revisited",
107    journal="{ACM} Transactions on Information Systems",
108    year=1998,
109    volume=16,
110    number=3,
111    pages="256--294",
112    month=Jul,
113    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
114   }*/
115
116
117 #include <stdio.h>
118
119 /*Gets the next byte of input.
120   After all the bytes in the current packet have been consumed, and the extra
121    end code returned if needed, this function will continue to return zero each
122    time it is called.
123   Return: The next byte of input.*/
124 static int ec_dec_in(ec_dec *_this){
125   int ret;
126   ret=ec_byte_read1(_this->buf);
127   if(ret<0){
128     ret=0;
129     /*Needed to make sure the above conditional only triggers once, and to keep
130        oc_dec_tell() operating correctly.*/
131     ec_byte_adv1(_this->buf);
132   }
133   return ret;
134 }
135
136 /*Normalizes the contents of dif and rng so that rng lies entirely in the
137    high-order symbol.*/
138 static void ec_dec_normalize(ec_dec *_this){
139   /*If the range is too small, rescale it and input some bits.*/
140   while(_this->rng<=EC_CODE_BOT){
141     int sym;
142     _this->rng<<=EC_SYM_BITS;
143     /*Use up the remaining bits from our last symbol.*/
144     sym=_this->rem<<EC_CODE_EXTRA&EC_SYM_MAX;
145     /*Read the next value from the input.*/
146     _this->rem=ec_dec_in(_this);
147     /*Take the rest of the bits we need from this new symbol.*/
148     sym|=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
149     _this->dif=(_this->dif<<EC_SYM_BITS)-sym&EC_CODE_MASK;
150     /*dif can never be larger than EC_CODE_TOP.
151       This is equivalent to the slightly more readable:
152       if(_this->dif>EC_CODE_TOP)_this->dif-=EC_CODE_TOP;*/
153     _this->dif^=_this->dif&_this->dif-1&EC_CODE_TOP;
154   }
155 }
156
157 void ec_dec_init(ec_dec *_this,ec_byte_buffer *_buf){
158   _this->buf=_buf;
159   _this->rem=ec_dec_in(_this);
160   _this->rng=1U<<EC_CODE_EXTRA;
161   _this->dif=_this->rng-(_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA);
162   /*Normalize the interval.*/
163   ec_dec_normalize(_this);
164 }
165
166
167 unsigned ec_decode(ec_dec *_this,unsigned _ft){
168   unsigned s;
169   _this->nrm=_this->rng/_ft;
170   s=(unsigned)((_this->dif-1)/_this->nrm);
171   return _ft-EC_MINI(s+1,_ft);
172 }
173
174 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
175   ec_uint32 s;
176   s=_this->nrm*(_ft-_fh);
177   _this->dif-=s;
178   _this->rng=_fl>0?_this->nrm*(_fh-_fl):_this->rng-s;
179   ec_dec_normalize(_this);
180 }
181
182 long ec_dec_tell(ec_dec *_this,int _b){
183   ec_uint32 r;
184   int       l;
185   long      nbits;
186   nbits=ec_byte_bytes(_this->buf)-(EC_CODE_BITS+EC_SYM_BITS-1)/EC_SYM_BITS<<3;
187   /*To handle the non-integral number of bits still left in the encoder state,
188      we compute the number of bits of low that must be encoded to ensure that
189      the value is inside the range for any possible subsequent bits.
190     Note that this is subtly different than the actual value we would end the
191      stream with, which tries to make as many of the trailing bits zeros as
192      possible.*/
193   nbits+=EC_CODE_BITS;
194   nbits<<=_b;
195   l=EC_ILOG(_this->rng);
196   r=_this->rng>>l-16;
197   while(_b-->0){
198     int b;
199     r=r*r>>15;
200     b=(int)(r>>16);
201     l=l<<1|b;
202     r>>=b;
203   }
204   return nbits-l;
205 }
206
207 #if 0
208 int ec_dec_done(ec_dec *_this){
209   unsigned low;
210   int      ret;
211   /*Check to make sure we've used all the input bytes.
212     This ensures that no more ones would ever be inserted into the decoder.*/
213   if(_this->buf->ptr-ec_byte_get_buffer(_this->buf)<=
214    ec_byte_bytes(_this->buf)){
215     return 0;
216   }
217   /*We compute the smallest finitely odd fraction that fits inside the current
218      range, and write that to the stream.
219     This is guaranteed to yield the smallest possible encoding.*/
220   /*TODO: Fix this line, as it is wrong.
221     It doesn't seem worth being able to make this check to do an extra
222      subtraction for every symbol decoded.*/
223   low=/*What we want: _this->top-_this->rng; What we have:*/_this->dif
224   if(low){
225     unsigned end;
226     end=EC_CODE_TOP;
227     /*Ensure that the next free end is in the range.*/
228     if(end-low>=_this->rng){
229       unsigned msk;
230       msk=EC_CODE_TOP-1;
231       do{
232         msk>>=1;
233         end=(low+msk)&~msk|msk+1;
234       }
235       while(end-low>=_this->rng);
236     }
237     /*The remaining input should have been the next free end.*/
238     return end-low!=_this->dif;
239   }
240   return 1;
241 }
242 #endif