Fix misleading comments about ec_{enc|dec}_tell()
[opus.git] / libcelt / mfrngenc.c
1 /* Copyright (c) 2001-2008 Timothy B. Terriberry
2    Copyright (c) 2008 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 "entenc.h"
38 #include "mfrngcod.h"
39
40
41
42 /*A multiply-free range encoder.
43   See mfrngdec.c and the references for implementation details
44    \cite{Mar79,MNW98,SM98}.
45
46   @INPROCEEDINGS{Mar79,
47    author="Martin, G.N.N.",
48    title="Range encoding: an algorithm for removing redundancy from a digitised
49     message",
50    booktitle="Video \& Data Recording Conference",
51    year=1979,
52    address="Southampton",
53    month=Jul
54   }
55   @ARTICLE{MNW98,
56    author="Alistair Moffat and Radford Neal and Ian H. Witten",
57    title="Arithmetic Coding Revisited",
58    journal="{ACM} Transactions on Information Systems",
59    year=1998,
60    volume=16,
61    number=3,
62    pages="256--294",
63    month=Jul,
64    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
65   }
66   @INPROCEEDINGS{SM98,
67    author="Lang Stuiver and Alistair Moffat",
68    title="Piecewise Integer Mapping for Arithmetic Coding",
69    booktitle="Proceedings of the {IEEE} Data Compression Conference",
70    pages="1--10",
71    address="Snowbird, UT",
72    month="Mar./Apr.",
73    year=1998
74   }*/
75
76
77
78 /*Outputs a symbol, with a carry bit.
79   If there is a potential to propagate a carry over several symbols, they are
80    buffered until it can be determined whether or not an actual carry will
81    occur.
82   If the counter for the buffered symbols overflows, then the stream becomes
83    undecodable.
84   This gives a theoretical limit of a few billion symbols in a single packet on
85    32-bit systems.
86   The alternative is to truncate the range in order to force a carry, but
87    requires similar carry tracking in the decoder, needlessly slowing it down.*/
88 static void ec_enc_carry_out(ec_enc *_this,int _c){
89   if(_c!=EC_SYM_MAX){
90     /*No further carry propagation possible, flush buffer.*/
91     int carry;
92     carry=_c>>EC_SYM_BITS;
93     /*Don't output a byte on the first write.
94       This compare should be taken care of by branch-prediction thereafter.*/
95     if(_this->rem>=0)ec_byte_write1(_this->buf,_this->rem+carry);
96     if(_this->ext>0){
97       unsigned sym;
98       sym=EC_SYM_MAX+carry&EC_SYM_MAX;
99       do ec_byte_write1(_this->buf,sym);
100       while(--(_this->ext)>0);
101     }
102     _this->rem=_c&EC_SYM_MAX;
103   }
104   else _this->ext++;
105 }
106
107 static inline void ec_enc_normalize(ec_enc *_this){
108   /*If the range is too small, output some bits and rescale it.*/
109   while(_this->rng<=EC_CODE_BOT){
110     ec_enc_carry_out(_this,(int)(_this->low>>EC_CODE_SHIFT));
111     /*Move the next-to-high-order symbol into the high-order position.*/
112     _this->low=_this->low<<EC_SYM_BITS&EC_CODE_TOP-1;
113     _this->rng<<=EC_SYM_BITS;
114   }
115 }
116
117 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf){
118   _this->buf=_buf;
119   _this->rem=-1;
120   _this->ext=0;
121   _this->low=0;
122   _this->rng=EC_CODE_TOP;
123   _this->end_byte=0;
124   _this->end_bits_left=8;
125   _this->nb_end_bits=0;
126 }
127
128 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
129   ec_uint32 fl;
130   ec_uint32 fh;
131   ec_uint32 ft;
132   ec_uint32 r;
133   ec_uint32 s;
134   ec_uint32 d;
135   int       e;
136   int       nrm;
137   /*Step 1: we want ft in the range of [rng/2,rng).
138     The high-order bits of the rng and ft are computed via a logarithm.
139     This could also be done on some architectures with some custom assembly,
140      which would provide even more speed.*/
141   nrm=EC_ILOG(_this->rng)-EC_ILOG(_ft);
142   /*Having the same high order bit may be too much.
143     We may need to shift one less to ensure that ft is actually in the proper
144      range.*/
145   ft=(ec_uint32)_ft<<nrm;
146   e=ft>_this->rng;
147   ft>>=e;
148   nrm-=e;
149   /*We then scale everything by the computed power of 2.*/
150   fl=(ec_uint32)_fl<<nrm;
151   fh=(ec_uint32)_fh<<nrm;
152   /*Step 2: compute the two values of the partition function.
153     d is the splitting point of the interval [0,ft).*/
154   d=_this->rng-ft;
155   r=fh+EC_MINI(fh,d);
156   s=fl+EC_MINI(fl,d);
157   /*Step 3: Update the end-point and range of the interval.*/
158   _this->low+=s;
159   _this->rng=r-s;
160   /*Step 4: Normalize the interval.*/
161   ec_enc_normalize(_this);
162 }
163
164 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned bits){
165 #if 0
166   ec_encode(_this, _fl, _fh, 1U<<bits);
167 #else
168   _this->nb_end_bits += bits;
169   while (bits >= _this->end_bits_left)
170   {
171     _this->end_byte |= (_fl<<(8-_this->end_bits_left)) & 0xff;
172     _fl >>= _this->end_bits_left;
173     ec_byte_write_at_end(_this->buf, _this->end_byte);
174     _this->end_byte = 0;
175     bits -= _this->end_bits_left;
176     _this->end_bits_left = 8;
177   }
178   _this->end_byte |= (_fl<<(8-_this->end_bits_left)) & 0xff;
179   _this->end_bits_left -= bits;
180 #endif
181 }
182
183 long ec_enc_tell(ec_enc *_this,int _b){
184   ec_uint32 r;
185   int       l;
186   long      nbits;
187   nbits=(ec_byte_bytes(_this->buf)+(_this->rem>=0)+_this->ext)*EC_SYM_BITS;
188   /*To handle the non-integral number of bits still left in the encoder state,
189      we compute the number of bits of low that must be encoded to ensure that
190      the value is inside the range for any possible subsequent bits.*/
191   nbits+=EC_CODE_BITS+1+_this->nb_end_bits;
192   nbits<<=_b;
193   l=EC_ILOG(_this->rng);
194   r=_this->rng>>l-16;
195   while(_b-->0){
196     int b;
197     r=r*r>>15;
198     b=(int)(r>>16);
199     l=l<<1|b;
200     r>>=b;
201   }
202   return nbits-l;
203 }
204
205 void ec_enc_done(ec_enc *_this){
206   ec_uint32 end;
207   ec_uint32 msk;
208   int       l;
209   /*We output the minimum number of bits that ensures that the symbols encoded
210      thus far will be decoded correctly regardless of the bits that follow.*/
211   l=EC_CODE_BITS-EC_ILOG(_this->rng);
212   msk=EC_CODE_TOP-1>>l;
213   end=_this->low+msk&~msk;
214   if((end|msk)>=_this->low+_this->rng){
215     l++;
216     msk>>=1;
217     end=_this->low+msk&~msk;
218   }
219   while(l>0){
220     ec_enc_carry_out(_this,(int)(end>>EC_CODE_SHIFT));
221     end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
222     l-=EC_SYM_BITS;
223   }
224   /*If we have a buffered byte flush it into the output buffer.*/
225   if(_this->rem>=0||_this->ext>0){
226     ec_enc_carry_out(_this,0);
227     _this->rem=-1;
228   }
229   {
230     unsigned char *ptr = _this->buf->ptr;
231     while (ptr<= _this->buf->end_ptr)
232       *ptr++ = 0;
233     if (_this->end_bits_left != 8)
234       *_this->buf->end_ptr |= _this->end_byte;
235   }
236 }