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