29ea29199e3018da13420f01d5528df37d45f2f9
[opus.git] / libentcode / rangeenc.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://dev.acm.org/pubs/citations/journals/tois/1998-16-3/p256-moffat/"
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 propogate 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 range is
48    truncated to force a carry to occur, towards whichever side maximizes the
49    remaining range.*/
50 static void ec_enc_carry_out(ec_enc *_this,int _c){
51   if(_c!=EC_SYM_MAX){
52     /*No further carry propogation possible, flush buffer.*/
53     int carry;
54     carry=_c>>EC_SYM_BITS;
55     /*Don't output a byte on the first write.
56       This compare should be taken care of by branch-prediction thereafter.*/
57     if(_this->rem>=0)ec_byte_write1(_this->buf,_this->rem+carry);
58     if(_this->ext>0){
59       unsigned sym;
60       sym=EC_SYM_MAX+carry&EC_SYM_MAX;
61       do ec_byte_write1(_this->buf,sym);
62       while(--(_this->ext)>0);
63     }
64     _this->rem=_c&EC_SYM_MAX;
65   }
66   else _this->ext++;
67 }
68
69 static void ec_enc_normalize(ec_enc *_this){
70   /*If the range is too small, output some bits and rescale it.*/
71   while(_this->rng<=EC_CODE_BOT){
72     ec_enc_carry_out(_this,(int)(_this->low>>EC_CODE_SHIFT));
73     /*Move the next-to-high-order symbol into the high-order position.*/
74     _this->low=_this->low<<EC_SYM_BITS&EC_CODE_TOP-1;
75     _this->rng<<=EC_SYM_BITS;
76   }
77 }
78
79 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf){
80   _this->buf=_buf;
81   _this->rem=-1;
82   _this->ext=0;
83   _this->low=0;
84   _this->rng=EC_CODE_TOP;
85 }
86
87 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
88   unsigned r;
89   unsigned s;
90   r=_this->rng/_ft;
91   if(_fl>0){
92     s=r*(_ft-_fl);
93     _this->low+=_this->rng-s;
94     _this->rng=r*(_fh-_fl);
95   }
96   else _this->rng-=r*(_ft-_fh);
97   ec_enc_normalize(_this);
98 }
99
100 void ec_enc_done(ec_enc *_this){
101   /*We compute the integer in the current interval that has the largest number
102      of trailing zeros, and write that to the stream.
103     This is guaranteed to yield the smallest possible encoding.*/
104   if(_this->low){
105     unsigned end;
106     end=EC_CODE_TOP;
107     /*Ensure that the end value is in the range.*/
108     if(end-_this->low>=_this->rng){
109       unsigned msk;
110       msk=EC_CODE_TOP-1;
111       do{
112         msk>>=1;
113         end=(_this->low+msk)&~msk|msk+1;
114       }
115       while(end-_this->low>=_this->rng);
116     }
117     /*The remaining output is the next free end.*/
118     while(end){
119       ec_enc_carry_out(_this,end>>EC_CODE_SHIFT);
120       end=end<<EC_SYM_BITS&EC_CODE_TOP-1;
121     }
122   }
123   /*If we have a buffered byte...*/
124   if(_this->rem>=0){
125     unsigned char *p;
126     unsigned char *buf;
127     /*Flush it into the output buffer.*/
128     ec_enc_carry_out(_this,0);
129     /*We may be able to drop some redundant bytes from the end.*/
130     buf=ec_byte_get_buffer(_this->buf);
131     p=buf+ec_byte_bytes(_this->buf)-1;
132     /*Strip trailing zeros.*/
133     while(p>=buf&&!p[0])p--;
134     /*Strip one trailing EC_FOF_RSV1 byte if the buffer ends in a string of
135        consecutive EC_FOF_RSV1 bytes preceded by one (or more) zeros.*/
136     if(p>buf&&p[0]==EC_FOF_RSV1){
137       unsigned char *q;
138       q=p;
139       do q--;
140       while(q>buf&&q[0]==EC_FOF_RSV1);
141       if(!q[0])p--;
142     }
143     ec_byte_writetrunc(_this->buf,p+1-buf);
144   }
145 }