making codec draft more compliant with IETF submission rules
[opus.git] / libcelt / rangeenc.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 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)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 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 }
115
116 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
117   ec_uint32 r;
118   r=_this->rng/_ft;
119   if(_fl>0){
120     _this->low+=_this->rng-IMUL32(r,(_ft-_fl));
121     _this->rng=IMUL32(r,(_fh-_fl));
122   }
123   else _this->rng-=IMUL32(r,(_ft-_fh));
124   ec_enc_normalize(_this);
125 }
126
127 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned bits){
128    ec_uint32 r, ft;
129    r=_this->rng>>bits;
130    ft = (ec_uint32)1<<bits;
131    if(_fl>0){
132      _this->low+=_this->rng-IMUL32(r,(ft-_fl));
133      _this->rng=IMUL32(r,(_fh-_fl));
134    }
135    else _this->rng-=IMUL32(r,(ft-_fh));
136    ec_enc_normalize(_this);
137 }
138
139 long ec_enc_tell(ec_enc *_this,int _b){
140   ec_uint32 r;
141   int       l;
142   long      nbits;
143   nbits=(ec_byte_bytes(_this->buf)+(_this->rem>=0)+_this->ext)*EC_SYM_BITS;
144   /*To handle the non-integral number of bits still left in the encoder state,
145      we compute the number of bits of low that must be encoded to ensure that
146      the value is inside the range for any possible subsequent bits.
147     Note that this is subtly different than the actual value we would end the
148      stream with, which tries to make as many of the trailing bits zeros as
149      possible.*/
150   nbits+=EC_CODE_BITS;
151   nbits<<=_b;
152   l=EC_ILOG(_this->rng);
153   r=_this->rng>>l-16;
154   while(_b-->0){
155     int b;
156     r=r*r>>15;
157     b=(int)(r>>16);
158     l=l<<1|b;
159     r>>=b;
160   }
161   return nbits-l;
162 }
163
164 void ec_enc_done(ec_enc *_this){
165   /*We compute the integer in the current interval that has the largest number
166      of trailing zeros, and write that to the stream.
167     This is guaranteed to yield the smallest possible encoding.*/
168   if(_this->low){
169     ec_uint32 end;
170     end=EC_CODE_TOP;
171     /*Ensure that the end value is in the range.*/
172     if(end-_this->low>=_this->rng){
173       ec_uint32 msk;
174       msk=EC_CODE_TOP-1;
175       do{
176         msk>>=1;
177         end=_this->low+msk&~msk|msk+1;
178       }
179       while(end-_this->low>=_this->rng);
180     }
181     /*The remaining output is the next free end.*/
182     while(end){
183       ec_enc_carry_out(_this,end>>EC_CODE_SHIFT);
184       end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
185     }
186   }
187   /*If we have a buffered byte flush it into the output buffer.*/
188   if(_this->rem>0||_this->ext>0){
189     ec_enc_carry_out(_this,0);
190     _this->rem=-1;
191   }
192 }