Bit of cleaning up in the byte dumping part. Making use of any remaining bit(s)
[opus.git] / libentcode / mfrngenc.c
1 #include <stddef.h>
2 #include "entenc.h"
3 #include "mfrngcod.h"
4
5
6
7 /*A multiply-free range encoder.
8   See mfrngdec.c and the references for implementation details
9    \cite{Mar79,MNW98,SM98}.
10
11   @INPROCEEDINGS{Mar79,
12    author="Martin, G.N.N.",
13    title="Range encoding: an algorithm for removing redundancy from a digitised
14     message",
15    booktitle="Video \& Data Recording Conference",
16    year=1979,
17    address="Southampton",
18    month=Jul
19   }
20   @ARTICLE{MNW98,
21    author="Alistair Moffat and Radford Neal and Ian H. Witten",
22    title="Arithmetic Coding Revisited",
23    journal="{ACM} Transactions on Information Systems",
24    year=1998,
25    volume=16,
26    number=3,
27    pages="256--294",
28    month=Jul,
29    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
30   }
31   @INPROCEEDINGS{SM98,
32    author="Lang Stuiver and Alistair Moffat",
33    title="Piecewise Integer Mapping for Arithmetic Coding",
34    booktitle="Proceedings of the {IEEE} Data Compression Conference",
35    pages="1--10",
36    address="Snowbird, UT",
37    month="Mar./Apr.",
38    year=1998
39   }*/
40
41
42
43 /*Outputs a symbol, with a carry bit.
44   If there is a potential to propagate a carry over several symbols, they are
45    buffered until it can be determined whether or not an actual carry will
46    occur.
47   If the counter for the buffered symbols overflows, then the stream becomes
48    undecodable.
49   This gives a theoretical limit of a few billion symbols in a single packet on
50    32-bit systems.
51   The alternative is to truncate the range in order to force a carry, but
52    requires similar carry tracking in the decoder, needlessly slowing it down.*/
53 static void ec_enc_carry_out(ec_enc *_this,int _c){
54   if(_c!=EC_SYM_MAX){
55     /*No further carry propagation possible, flush buffer.*/
56     int carry;
57     carry=_c>>EC_SYM_BITS;
58     /*Don't output a byte on the first write.
59       This compare should be taken care of by branch-prediction thereafter.*/
60     if(_this->rem>=0)ec_byte_write1(_this->buf,_this->rem+carry);
61     if(_this->ext>0){
62       unsigned sym;
63       sym=EC_SYM_MAX+carry&EC_SYM_MAX;
64       do ec_byte_write1(_this->buf,sym);
65       while(--(_this->ext)>0);
66     }
67     _this->rem=_c&EC_SYM_MAX;
68   }
69   else _this->ext++;
70 }
71
72 static void ec_enc_normalize(ec_enc *_this){
73   /*If the range is too small, output some bits and rescale it.*/
74   while(_this->rng<=EC_CODE_BOT){
75     ec_enc_carry_out(_this,(int)(_this->low>>EC_CODE_SHIFT));
76     /*Move the next-to-high-order symbol into the high-order position.*/
77     _this->low=_this->low<<EC_SYM_BITS&EC_CODE_TOP-1;
78     _this->rng<<=EC_SYM_BITS;
79   }
80 }
81
82 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf){
83   _this->buf=_buf;
84   _this->rem=-1;
85   _this->ext=0;
86   _this->low=0;
87   _this->rng=EC_CODE_TOP;
88 }
89
90 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
91   unsigned r;
92   unsigned s;
93   unsigned d;
94   int      nrm;
95   /*Step 1: we want ft in the range of [rng/2,rng).
96     The high-order bits of the rng and ft are computed via a logarithm.
97     This could also be done on some architectures with some custom assembly,
98      which would provide even more speed.*/
99   nrm=EC_ILOG(_this->rng)-EC_ILOG(_ft);
100   /*Having the same high order bit may be too much.
101     We may need to shift one less to ensure that ft is actually in the proper
102      range.*/
103   _ft<<=nrm;
104   d=_ft>_this->rng;
105   _ft>>=d;
106   nrm-=d;
107   /*We then scale everything by the computed power of 2.*/
108   _fl<<=nrm;
109   _fh<<=nrm;
110   /*Step 2: compute the two values of the partition function.
111     d is the splitting point of the interval [0,ft).*/
112   d=_this->rng-_ft;
113   r=_fh+EC_MINI(_fh,d);
114   s=_fl+EC_MINI(_fl,d);
115   /*Step 3: Update the end-point and range of the interval.*/
116   _this->low+=s;
117   _this->rng=r-s;
118   /*Step 4: Normalize the interval.*/
119   ec_enc_normalize(_this);
120 }
121
122 long ec_enc_tell(ec_enc *_this,int _b){
123   ec_uint32 r;
124   int       l;
125   long      nbits;
126   nbits=ec_byte_bytes(_this->buf)+(_this->rem>=0)+_this->ext<<3;
127   /*To handle the non-integral number of bits still left in the encoder state,
128      we compute the number of bits of low that must be encoded to ensure that
129      the value is inside the range for any possible subsequent bits.
130     Note that this is subtly different than the actual value we would end the
131      stream with, which tries to make as many of the trailing bits zeros as
132      possible.*/
133   nbits+=EC_CODE_BITS;
134   nbits<<=_b;
135   l=EC_ILOG(_this->rng);
136   r=_this->rng>>l-16;
137   while(_b-->0){
138     int b;
139     r=r*r>>15;
140     b=(int)(r>>16);
141     l=l<<1|b;
142     r>>=b;
143   }
144   return nbits-l;
145 }
146
147 void ec_enc_done(ec_enc *_this){
148   /*We compute the integer in the current interval that has the largest number
149      of trailing zeros, and write that to the stream.
150     This is guaranteed to yield the smallest possible encoding.*/
151   if(_this->low){
152     unsigned end;
153     end=EC_CODE_TOP;
154     /*Ensure that the end value is in the range.*/
155     if(end-_this->low>=_this->rng){
156       unsigned msk;
157       msk=EC_CODE_TOP-1;
158       do{
159         msk>>=1;
160         end=_this->low+msk&~msk|msk+1;
161       }
162       while(end-_this->low>=_this->rng);
163     }
164     /*The remaining output is the next free end.*/
165     while(end){
166       ec_enc_carry_out(_this,end>>EC_CODE_SHIFT);
167       end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
168     }
169   }
170   /*If we have a buffered byte flush it into the output buffer.*/
171   if(_this->rem>=0){
172     ec_enc_carry_out(_this,0);
173     _this->rem=-1;
174   }
175 }