Simplifies convoluted raw bits calls.
[opus.git] / libcelt / rangeenc.c
1 /* Copyright (c) 2001-2008 Timothy B. Terriberry
2    Copyright (c) 2008-2009 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 range encoder.
43   See rangedec.c and the references for implementation details
44    \cite{Mar79,MNW98}.
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
67
68
69 /*Outputs a symbol, with a carry bit.
70   If there is a potential to propagate a carry over several symbols, they are
71    buffered until it can be determined whether or not an actual carry will
72    occur.
73   If the counter for the buffered symbols overflows, then the stream becomes
74    undecodable.
75   This gives a theoretical limit of a few billion symbols in a single packet on
76    32-bit systems.
77   The alternative is to truncate the range in order to force a carry, but
78    requires similar carry tracking in the decoder, needlessly slowing it down.*/
79 static void ec_enc_carry_out(ec_enc *_this,int _c){
80   if(_c!=EC_SYM_MAX){
81     /*No further carry propagation possible, flush buffer.*/
82     int carry;
83     carry=_c>>EC_SYM_BITS;
84     /*Don't output a byte on the first write.
85       This compare should be taken care of by branch-prediction thereafter.*/
86     if(_this->rem>=0)_this->error|=ec_byte_write1(_this->buf,_this->rem+carry);
87     if(_this->ext>0){
88       unsigned sym;
89       sym=EC_SYM_MAX+carry&EC_SYM_MAX;
90       do _this->error|=ec_byte_write1(_this->buf,sym);
91       while(--(_this->ext)>0);
92     }
93     _this->rem=_c&EC_SYM_MAX;
94   }
95   else _this->ext++;
96 }
97
98 static inline void ec_enc_normalize(ec_enc *_this){
99   /*If the range is too small, output some bits and rescale it.*/
100   while(_this->rng<=EC_CODE_BOT){
101     ec_enc_carry_out(_this,(int)(_this->low>>EC_CODE_SHIFT));
102     /*Move the next-to-high-order symbol into the high-order position.*/
103     _this->low=_this->low<<EC_SYM_BITS&EC_CODE_TOP-1;
104     _this->rng<<=EC_SYM_BITS;
105   }
106 }
107
108 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf){
109   _this->buf=_buf;
110   _this->rem=-1;
111   _this->ext=0;
112   _this->low=0;
113   _this->rng=EC_CODE_TOP;
114   _this->end_byte=0;
115   _this->end_bits_left=8;
116   _this->nb_end_bits=0;
117   _this->error=0;
118 }
119
120 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
121   ec_uint32 r;
122   r=_this->rng/_ft;
123   if(_fl>0){
124     _this->low+=_this->rng-IMUL32(r,(_ft-_fl));
125     _this->rng=IMUL32(r,(_fh-_fl));
126   }
127   else _this->rng-=IMUL32(r,(_ft-_fh));
128   ec_enc_normalize(_this);
129 }
130
131 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _bits){
132    ec_uint32 r;
133    r=_this->rng>>_bits;
134    if(_fl>0){
135       _this->low+=_this->rng-IMUL32(r,((1<<_bits)-_fl));
136       _this->rng=IMUL32(r,(_fh-_fl));
137    }
138    else _this->rng-=IMUL32(r,((1<<_bits)-_fh));
139    ec_enc_normalize(_this);
140 }
141
142 /*The probability of having a "one" is given in 1/65536.*/
143 void ec_enc_bit_prob(ec_enc *_this,int _val,unsigned _prob){
144    ec_uint32 r;
145    ec_uint32 s;
146    ec_uint32 l;
147    r=_this->rng;
148    l=_this->low;
149    s=(r>>16)*_prob;
150    r-=s;
151    if(_val)_this->low=l+r;
152    _this->rng=_val?s:r;
153    ec_enc_normalize(_this);
154 }
155
156 void ec_enc_bits(ec_enc *_this,unsigned _fl,unsigned bits){
157   _this->nb_end_bits += bits;
158   while (bits >= _this->end_bits_left)
159   {
160     _this->end_byte |= (_fl<<(8-_this->end_bits_left)) & 0xff;
161     _fl >>= _this->end_bits_left;
162     _this->error|=ec_byte_write_at_end(_this->buf, _this->end_byte);
163     _this->end_byte = 0;
164     bits -= _this->end_bits_left;
165     _this->end_bits_left = 8;
166   }
167   _this->end_byte |= (_fl<<(8-_this->end_bits_left)) & 0xff;
168   _this->end_bits_left -= bits;
169 }
170
171 ec_uint32 ec_enc_tell(ec_enc *_this,int _b){
172   ec_uint32 r;
173   int       l;
174   ec_uint32      nbits;
175   nbits=(ec_byte_bytes(_this->buf)+(_this->rem>=0)+_this->ext)*EC_SYM_BITS;
176   /*To handle the non-integral number of bits still left in the encoder state,
177      we compute the number of bits of low that must be encoded to ensure that
178      the value is inside the range for any possible subsequent bits.*/
179   nbits+=EC_CODE_BITS+1+_this->nb_end_bits;
180   nbits<<=_b;
181   l=EC_ILOG(_this->rng);
182   r=_this->rng>>l-16;
183   while(_b-->0){
184     int b;
185     r=r*r>>15;
186     b=(int)(r>>16);
187     l=l<<1|b;
188     r>>=b;
189   }
190   return nbits-l;
191 }
192
193 void ec_enc_done(ec_enc *_this){
194   ec_uint32 msk;
195   ec_uint32 end;
196   int       l;
197   /*We output the minimum number of bits that ensures that the symbols encoded
198      thus far will be decoded correctly regardless of the bits that follow.*/
199   l=EC_CODE_BITS-EC_ILOG(_this->rng);
200   msk=EC_CODE_TOP-1>>l;
201   end=_this->low+msk&~msk;
202   if((end|msk)>=_this->low+_this->rng){
203     l++;
204     msk>>=1;
205     end=_this->low+msk&~msk;
206   }
207   while(l>0){
208     ec_enc_carry_out(_this,(int)(end>>EC_CODE_SHIFT));
209     end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
210     l-=EC_SYM_BITS;
211   }
212   /*If we have a buffered byte flush it into the output buffer.*/
213   if(_this->rem>=0||_this->ext>0){
214     ec_enc_carry_out(_this,0);
215     _this->rem=-1;
216   }
217   {
218     unsigned char *ptr = _this->buf->ptr;
219     while (ptr<= _this->buf->end_ptr)
220       *ptr++ = 0;
221     if (_this->end_bits_left != 8)
222       *_this->buf->end_ptr |= _this->end_byte;
223   }
224 }