encoder pre-emphasis now in 16-bits
[opus.git] / libcelt / rangedec.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 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 /*Gets the next byte of input.
118   After all the bytes in the current packet have been consumed, and the extra
119    end code returned if needed, this function will continue to return zero each
120    time it is called.
121   Return: The next byte of input.*/
122 static int ec_dec_in(ec_dec *_this){
123   int ret;
124   ret=ec_byte_read1(_this->buf);
125   if(ret<0){
126     ret=0;
127     /*Needed to make sure the above conditional only triggers once, and to keep
128        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->rng-(_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA);
160   /*Normalize the interval.*/
161   ec_dec_normalize(_this);
162 }
163
164
165 unsigned ec_decode(ec_dec *_this,unsigned _ft){
166   unsigned s;
167   _this->nrm=_this->rng/_ft;
168   s=(unsigned)((_this->dif-1)/_this->nrm);
169   return _ft-EC_MINI(s+1,_ft);
170 }
171
172 unsigned ec_decode_bin(ec_dec *_this,unsigned bits){
173    unsigned s;
174    ec_uint32 ft;
175    ft = (ec_uint32)1<<bits;
176    _this->nrm=_this->rng>>bits;
177    s=(unsigned)((_this->dif-1)/_this->nrm);
178    return ft-EC_MINI(s+1,ft);
179 }
180
181 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
182   ec_uint32 s;
183   s=IMUL32(_this->nrm,(_ft-_fh));
184   _this->dif-=s;
185   _this->rng=_fl>0?IMUL32(_this->nrm,(_fh-_fl)):_this->rng-s;
186   ec_dec_normalize(_this);
187 }
188
189 long ec_dec_tell(ec_dec *_this,int _b){
190   ec_uint32 r;
191   int       l;
192   long      nbits;
193   nbits=ec_byte_bytes(_this->buf)-(EC_CODE_BITS+EC_SYM_BITS-1)/EC_SYM_BITS<<3;
194   /*To handle the non-integral number of bits still left in the encoder state,
195      we compute the number of bits of low that must be encoded to ensure that
196      the value is inside the range for any possible subsequent bits.
197     Note that this is subtly different than the actual value we would end the
198      stream with, which tries to make as many of the trailing bits zeros as
199      possible.*/
200   nbits+=EC_CODE_BITS;
201   nbits<<=_b;
202   l=EC_ILOG(_this->rng);
203   r=_this->rng>>l-16;
204   while(_b-->0){
205     int b;
206     r=r*r>>15;
207     b=(int)(r>>16);
208     l=l<<1|b;
209     r>>=b;
210   }
211   return nbits-l;
212 }
213
214 #if 0
215 int ec_dec_done(ec_dec *_this){
216   unsigned low;
217   int      ret;
218   /*Check to make sure we've used all the input bytes.
219     This ensures that no more ones would ever be inserted into the decoder.*/
220   if(_this->buf->ptr-ec_byte_get_buffer(_this->buf)<=
221    ec_byte_bytes(_this->buf)){
222     return 0;
223   }
224   /*We compute the smallest finitely odd fraction that fits inside the current
225      range, and write that to the stream.
226     This is guaranteed to yield the smallest possible encoding.*/
227   /*TODO: Fix this line, as it is wrong.
228     It doesn't seem worth being able to make this check to do an extra
229      subtraction for every symbol decoded.*/
230   low=/*What we want: _this->top-_this->rng; What we have:*/_this->dif
231   if(low){
232     unsigned end;
233     end=EC_CODE_TOP;
234     /*Ensure that the next free end is in the range.*/
235     if(end-low>=_this->rng){
236       unsigned msk;
237       msk=EC_CODE_TOP-1;
238       do{
239         msk>>=1;
240         end=(low+msk)&~msk|msk+1;
241       }
242       while(end-low>=_this->rng);
243     }
244     /*The remaining input should have been the next free end.*/
245     return end-low!=_this->dif;
246   }
247   return 1;
248 }
249 #endif