Change end-of-stream handling in the range coder.
[opus.git] / libcelt / rangedec.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 "entdec.h"
38 #include "mfrngcod.h"
39
40
41
42 /*A range decoder.
43   This is an entropy decoder based upon \cite{Mar79}, which is itself a
44    rediscovery of the FIFO arithmetic code introduced by \cite{Pas76}.
45   It is very similar to arithmetic encoding, except that encoding is done with
46    digits in any base, instead of with bits, and so it is faster when using
47    larger bases (i.e.: a byte).
48   The author claims an average waste of $\frac{1}{2}\log_b(2b)$ bits, where $b$
49    is the base, longer than the theoretical optimum, but to my knowledge there
50    is no published justification for this claim.
51   This only seems true when using near-infinite precision arithmetic so that
52    the process is carried out with no rounding errors.
53
54   IBM (the author's employer) never sought to patent the idea, and to my
55    knowledge the algorithm is unencumbered by any patents, though its
56    performance is very competitive with proprietary arithmetic coding.
57   The two are based on very similar ideas, however.
58   An excellent description of implementation details is available at
59    http://www.arturocampos.com/ac_range.html
60   A recent work \cite{MNW98} which proposes several changes to arithmetic
61    encoding for efficiency actually re-discovers many of the principles
62    behind range encoding, and presents a good theoretical analysis of them.
63
64   End of stream is handled by writing out the smallest number of bits that
65    ensures that the stream will be correctly decoded regardless of the value of
66    any subsequent bits.
67   ec_dec_tell() can be used to determine how many bits were needed to decode
68    all the symbols thus far; other data can be packed in the remaining bits of
69    the input buffer.
70   @PHDTHESIS{Pas76,
71     author="Richard Clark Pasco",
72     title="Source coding algorithms for fast data compression",
73     school="Dept. of Electrical Engineering, Stanford University",
74     address="Stanford, CA",
75     month=May,
76     year=1976
77   }
78   @INPROCEEDINGS{Mar79,
79    author="Martin, G.N.N.",
80    title="Range encoding: an algorithm for removing redundancy from a digitised
81     message",
82    booktitle="Video & Data Recording Conference",
83    year=1979,
84    address="Southampton",
85    month=Jul
86   }
87   @ARTICLE{MNW98,
88    author="Alistair Moffat and Radford Neal and Ian H. Witten",
89    title="Arithmetic Coding Revisited",
90    journal="{ACM} Transactions on Information Systems",
91    year=1998,
92    volume=16,
93    number=3,
94    pages="256--294",
95    month=Jul,
96    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
97   }*/
98
99
100 /*Gets the next byte of input.
101   After all the bytes in the current packet have been consumed, and the extra
102    end code returned if needed, this function will continue to return zero each
103    time it is called.
104   Return: The next byte of input.*/
105 static int ec_dec_in(ec_dec *_this){
106   int ret;
107   ret=ec_byte_read1(_this->buf);
108   if(ret<0){
109     ret=0;
110     /*Needed to keep oc_dec_tell() operating correctly.*/
111     ec_byte_adv1(_this->buf);
112   }
113   return ret;
114 }
115
116 /*Normalizes the contents of dif and rng so that rng lies entirely in the
117    high-order symbol.*/
118 static inline void ec_dec_normalize(ec_dec *_this){
119   /*If the range is too small, rescale it and input some bits.*/
120   while(_this->rng<=EC_CODE_BOT){
121     int sym;
122     _this->rng<<=EC_SYM_BITS;
123     /*Use up the remaining bits from our last symbol.*/
124     sym=_this->rem<<EC_CODE_EXTRA&EC_SYM_MAX;
125     /*Read the next value from the input.*/
126     _this->rem=ec_dec_in(_this);
127     /*Take the rest of the bits we need from this new symbol.*/
128     sym|=_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA;
129     _this->dif=(_this->dif<<EC_SYM_BITS)-sym&EC_CODE_MASK;
130     /*dif can never be larger than EC_CODE_TOP.
131       This is equivalent to the slightly more readable:
132       if(_this->dif>EC_CODE_TOP)_this->dif-=EC_CODE_TOP;*/
133     _this->dif^=_this->dif&_this->dif-1&EC_CODE_TOP;
134   }
135 }
136
137 void ec_dec_init(ec_dec *_this,ec_byte_buffer *_buf){
138   _this->buf=_buf;
139   _this->rem=ec_dec_in(_this);
140   _this->rng=1U<<EC_CODE_EXTRA;
141   _this->dif=_this->rng-(_this->rem>>EC_SYM_BITS-EC_CODE_EXTRA);
142   /*Normalize the interval.*/
143   ec_dec_normalize(_this);
144 }
145
146
147 unsigned ec_decode(ec_dec *_this,unsigned _ft){
148   unsigned s;
149   _this->nrm=_this->rng/_ft;
150   s=(unsigned)((_this->dif-1)/_this->nrm);
151   return _ft-EC_MINI(s+1,_ft);
152 }
153
154 unsigned ec_decode_bin(ec_dec *_this,unsigned bits){
155    unsigned s;
156    ec_uint32 ft;
157    ft = (ec_uint32)1<<bits;
158    _this->nrm=_this->rng>>bits;
159    s=(unsigned)((_this->dif-1)/_this->nrm);
160    return ft-EC_MINI(s+1,ft);
161 }
162
163 void ec_dec_update(ec_dec *_this,unsigned _fl,unsigned _fh,unsigned _ft){
164   ec_uint32 s;
165   s=IMUL32(_this->nrm,(_ft-_fh));
166   _this->dif-=s;
167   _this->rng=_fl>0?IMUL32(_this->nrm,(_fh-_fl)):_this->rng-s;
168   ec_dec_normalize(_this);
169 }
170
171 long ec_dec_tell(ec_dec *_this,int _b){
172   ec_uint32 r;
173   int       l;
174   long      nbits;
175   nbits=(ec_byte_bytes(_this->buf)-(EC_CODE_BITS+EC_SYM_BITS-1)/EC_SYM_BITS)*
176    EC_SYM_BITS;
177   /*To handle the non-integral number of bits still left in the decoder state,
178      we compute the number of bits of low that must be encoded to ensure that
179      the value is inside the range for any possible subsequent bits.*/
180   nbits+=EC_CODE_BITS+1;
181   nbits<<=_b;
182   l=EC_ILOG(_this->rng);
183   r=_this->rng>>l-16;
184   while(_b-->0){
185     int b;
186     r=r*r>>15;
187     b=(int)(r>>16);
188     l=l<<1|b;
189     r>>=b;
190   }
191   return nbits-l;
192 }