making codec draft more compliant with IETF submission rules
[opus.git] / libcelt / mfrngenc.c
1 /* (C) 2001-2008 Timothy B. Terriberry
2    (C) 2008 Jean-Marc Valin */
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 }
124
125 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
126   ec_uint32 fl;
127   ec_uint32 fh;
128   ec_uint32 ft;
129   ec_uint32 r;
130   ec_uint32 s;
131   ec_uint32 d;
132   int       e;
133   int       nrm;
134   /*Step 1: we want ft in the range of [rng/2,rng).
135     The high-order bits of the rng and ft are computed via a logarithm.
136     This could also be done on some architectures with some custom assembly,
137      which would provide even more speed.*/
138   nrm=EC_ILOG(_this->rng)-EC_ILOG(_ft);
139   /*Having the same high order bit may be too much.
140     We may need to shift one less to ensure that ft is actually in the proper
141      range.*/
142   ft=(ec_uint32)_ft<<nrm;
143   e=ft>_this->rng;
144   ft>>=e;
145   nrm-=e;
146   /*We then scale everything by the computed power of 2.*/
147   fl=(ec_uint32)_fl<<nrm;
148   fh=(ec_uint32)_fh<<nrm;
149   /*Step 2: compute the two values of the partition function.
150     d is the splitting point of the interval [0,ft).*/
151   d=_this->rng-ft;
152   r=fh+EC_MINI(fh,d);
153   s=fl+EC_MINI(fl,d);
154   /*Step 3: Update the end-point and range of the interval.*/
155   _this->low+=s;
156   _this->rng=r-s;
157   /*Step 4: Normalize the interval.*/
158   ec_enc_normalize(_this);
159 }
160
161 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned bits){
162   ec_encode(_this, _fl, _fh, 1U<<bits);
163 }
164
165 long ec_enc_tell(ec_enc *_this,int _b){
166   ec_uint32 r;
167   int       l;
168   long      nbits;
169   nbits=(ec_byte_bytes(_this->buf)+(_this->rem>=0)+_this->ext)*EC_SYM_BITS;
170   /*To handle the non-integral number of bits still left in the encoder state,
171      we compute the number of bits of low that must be encoded to ensure that
172      the value is inside the range for any possible subsequent bits.
173     Note that this is subtly different than the actual value we would end the
174      stream with, which tries to make as many of the trailing bits zeros as
175      possible.*/
176   nbits+=EC_CODE_BITS;
177   nbits<<=_b;
178   l=EC_ILOG(_this->rng);
179   r=_this->rng>>l-16;
180   while(_b-->0){
181     int b;
182     r=r*r>>15;
183     b=(int)(r>>16);
184     l=l<<1|b;
185     r>>=b;
186   }
187   return nbits-l;
188 }
189
190 void ec_enc_done(ec_enc *_this){
191   /*We compute the integer in the current interval that has the largest number
192      of trailing zeros, and write that to the stream.
193     This is guaranteed to yield the smallest possible encoding.*/
194   if(_this->low){
195     ec_uint32 end;
196     end=EC_CODE_TOP;
197     /*Ensure that the end value is in the range.*/
198     if(end-_this->low>=_this->rng){
199       ec_uint32 msk;
200       msk=EC_CODE_TOP-1;
201       do{
202         msk>>=1;
203         end=_this->low+msk&~msk|msk+1;
204       }
205       while(end-_this->low>=_this->rng);
206     }
207     /*The remaining output is the next free end.*/
208     while(end){
209       ec_enc_carry_out(_this,end>>EC_CODE_SHIFT);
210       end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
211     }
212   }
213   /*If we have a buffered byte flush it into the output buffer.*/
214   if(_this->rem>0||_this->ext>0){
215     ec_enc_carry_out(_this,0);
216     _this->rem=-1;
217   }
218 }