michael@0: /* Copyright (c) 2001-2011 Timothy B. Terriberry
michael@0:    Copyright (c) 2008-2009 Xiph.Org Foundation */
michael@0: /*
michael@0:    Redistribution and use in source and binary forms, with or without
michael@0:    modification, are permitted provided that the following conditions
michael@0:    are met:
michael@0: 
michael@0:    - Redistributions of source code must retain the above copyright
michael@0:    notice, this list of conditions and the following disclaimer.
michael@0: 
michael@0:    - Redistributions in binary form must reproduce the above copyright
michael@0:    notice, this list of conditions and the following disclaimer in the
michael@0:    documentation and/or other materials provided with the distribution.
michael@0: 
michael@0:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
michael@0:    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: */
michael@0: 
michael@0: #if defined(HAVE_CONFIG_H)
michael@0: # include "config.h"
michael@0: #endif
michael@0: #include "os_support.h"
michael@0: #include "arch.h"
michael@0: #include "entenc.h"
michael@0: #include "mfrngcod.h"
michael@0: 
michael@0: /*A range encoder.
michael@0:   See entdec.c and the references for implementation details \cite{Mar79,MNW98}.
michael@0: 
michael@0:   @INPROCEEDINGS{Mar79,
michael@0:    author="Martin, G.N.N.",
michael@0:    title="Range encoding: an algorithm for removing redundancy from a digitised
michael@0:     message",
michael@0:    booktitle="Video \& Data Recording Conference",
michael@0:    year=1979,
michael@0:    address="Southampton",
michael@0:    month=Jul
michael@0:   }
michael@0:   @ARTICLE{MNW98,
michael@0:    author="Alistair Moffat and Radford Neal and Ian H. Witten",
michael@0:    title="Arithmetic Coding Revisited",
michael@0:    journal="{ACM} Transactions on Information Systems",
michael@0:    year=1998,
michael@0:    volume=16,
michael@0:    number=3,
michael@0:    pages="256--294",
michael@0:    month=Jul,
michael@0:    URL="http://www.stanford.edu/class/ee398/handouts/papers/Moffat98ArithmCoding.pdf"
michael@0:   }*/
michael@0: 
michael@0: static int ec_write_byte(ec_enc *_this,unsigned _value){
michael@0:   if(_this->offs+_this->end_offs>=_this->storage)return -1;
michael@0:   _this->buf[_this->offs++]=(unsigned char)_value;
michael@0:   return 0;
michael@0: }
michael@0: 
michael@0: static int ec_write_byte_at_end(ec_enc *_this,unsigned _value){
michael@0:   if(_this->offs+_this->end_offs>=_this->storage)return -1;
michael@0:   _this->buf[_this->storage-++(_this->end_offs)]=(unsigned char)_value;
michael@0:   return 0;
michael@0: }
michael@0: 
michael@0: /*Outputs a symbol, with a carry bit.
michael@0:   If there is a potential to propagate a carry over several symbols, they are
michael@0:    buffered until it can be determined whether or not an actual carry will
michael@0:    occur.
michael@0:   If the counter for the buffered symbols overflows, then the stream becomes
michael@0:    undecodable.
michael@0:   This gives a theoretical limit of a few billion symbols in a single packet on
michael@0:    32-bit systems.
michael@0:   The alternative is to truncate the range in order to force a carry, but
michael@0:    requires similar carry tracking in the decoder, needlessly slowing it down.*/
michael@0: static void ec_enc_carry_out(ec_enc *_this,int _c){
michael@0:   if(_c!=EC_SYM_MAX){
michael@0:     /*No further carry propagation possible, flush buffer.*/
michael@0:     int carry;
michael@0:     carry=_c>>EC_SYM_BITS;
michael@0:     /*Don't output a byte on the first write.
michael@0:       This compare should be taken care of by branch-prediction thereafter.*/
michael@0:     if(_this->rem>=0)_this->error|=ec_write_byte(_this,_this->rem+carry);
michael@0:     if(_this->ext>0){
michael@0:       unsigned sym;
michael@0:       sym=(EC_SYM_MAX+carry)&EC_SYM_MAX;
michael@0:       do _this->error|=ec_write_byte(_this,sym);
michael@0:       while(--(_this->ext)>0);
michael@0:     }
michael@0:     _this->rem=_c&EC_SYM_MAX;
michael@0:   }
michael@0:   else _this->ext++;
michael@0: }
michael@0: 
michael@0: static void ec_enc_normalize(ec_enc *_this){
michael@0:   /*If the range is too small, output some bits and rescale it.*/
michael@0:   while(_this->rng<=EC_CODE_BOT){
michael@0:     ec_enc_carry_out(_this,(int)(_this->val>>EC_CODE_SHIFT));
michael@0:     /*Move the next-to-high-order symbol into the high-order position.*/
michael@0:     _this->val=(_this->val<<EC_SYM_BITS)&(EC_CODE_TOP-1);
michael@0:     _this->rng<<=EC_SYM_BITS;
michael@0:     _this->nbits_total+=EC_SYM_BITS;
michael@0:   }
michael@0: }
michael@0: 
michael@0: void ec_enc_init(ec_enc *_this,unsigned char *_buf,opus_uint32 _size){
michael@0:   _this->buf=_buf;
michael@0:   _this->end_offs=0;
michael@0:   _this->end_window=0;
michael@0:   _this->nend_bits=0;
michael@0:   /*This is the offset from which ec_tell() will subtract partial bits.*/
michael@0:   _this->nbits_total=EC_CODE_BITS+1;
michael@0:   _this->offs=0;
michael@0:   _this->rng=EC_CODE_TOP;
michael@0:   _this->rem=-1;
michael@0:   _this->val=0;
michael@0:   _this->ext=0;
michael@0:   _this->storage=_size;
michael@0:   _this->error=0;
michael@0: }
michael@0: 
michael@0: void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft){
michael@0:   opus_uint32 r;
michael@0:   r=_this->rng/_ft;
michael@0:   if(_fl>0){
michael@0:     _this->val+=_this->rng-IMUL32(r,(_ft-_fl));
michael@0:     _this->rng=IMUL32(r,(_fh-_fl));
michael@0:   }
michael@0:   else _this->rng-=IMUL32(r,(_ft-_fh));
michael@0:   ec_enc_normalize(_this);
michael@0: }
michael@0: 
michael@0: void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _bits){
michael@0:   opus_uint32 r;
michael@0:   r=_this->rng>>_bits;
michael@0:   if(_fl>0){
michael@0:     _this->val+=_this->rng-IMUL32(r,((1U<<_bits)-_fl));
michael@0:     _this->rng=IMUL32(r,(_fh-_fl));
michael@0:   }
michael@0:   else _this->rng-=IMUL32(r,((1U<<_bits)-_fh));
michael@0:   ec_enc_normalize(_this);
michael@0: }
michael@0: 
michael@0: /*The probability of having a "one" is 1/(1<<_logp).*/
michael@0: void ec_enc_bit_logp(ec_enc *_this,int _val,unsigned _logp){
michael@0:   opus_uint32 r;
michael@0:   opus_uint32 s;
michael@0:   opus_uint32 l;
michael@0:   r=_this->rng;
michael@0:   l=_this->val;
michael@0:   s=r>>_logp;
michael@0:   r-=s;
michael@0:   if(_val)_this->val=l+r;
michael@0:   _this->rng=_val?s:r;
michael@0:   ec_enc_normalize(_this);
michael@0: }
michael@0: 
michael@0: void ec_enc_icdf(ec_enc *_this,int _s,const unsigned char *_icdf,unsigned _ftb){
michael@0:   opus_uint32 r;
michael@0:   r=_this->rng>>_ftb;
michael@0:   if(_s>0){
michael@0:     _this->val+=_this->rng-IMUL32(r,_icdf[_s-1]);
michael@0:     _this->rng=IMUL32(r,_icdf[_s-1]-_icdf[_s]);
michael@0:   }
michael@0:   else _this->rng-=IMUL32(r,_icdf[_s]);
michael@0:   ec_enc_normalize(_this);
michael@0: }
michael@0: 
michael@0: void ec_enc_uint(ec_enc *_this,opus_uint32 _fl,opus_uint32 _ft){
michael@0:   unsigned  ft;
michael@0:   unsigned  fl;
michael@0:   int       ftb;
michael@0:   /*In order to optimize EC_ILOG(), it is undefined for the value 0.*/
michael@0:   celt_assert(_ft>1);
michael@0:   _ft--;
michael@0:   ftb=EC_ILOG(_ft);
michael@0:   if(ftb>EC_UINT_BITS){
michael@0:     ftb-=EC_UINT_BITS;
michael@0:     ft=(_ft>>ftb)+1;
michael@0:     fl=(unsigned)(_fl>>ftb);
michael@0:     ec_encode(_this,fl,fl+1,ft);
michael@0:     ec_enc_bits(_this,_fl&(((opus_uint32)1<<ftb)-1U),ftb);
michael@0:   }
michael@0:   else ec_encode(_this,_fl,_fl+1,_ft+1);
michael@0: }
michael@0: 
michael@0: void ec_enc_bits(ec_enc *_this,opus_uint32 _fl,unsigned _bits){
michael@0:   ec_window window;
michael@0:   int       used;
michael@0:   window=_this->end_window;
michael@0:   used=_this->nend_bits;
michael@0:   celt_assert(_bits>0);
michael@0:   if(used+_bits>EC_WINDOW_SIZE){
michael@0:     do{
michael@0:       _this->error|=ec_write_byte_at_end(_this,(unsigned)window&EC_SYM_MAX);
michael@0:       window>>=EC_SYM_BITS;
michael@0:       used-=EC_SYM_BITS;
michael@0:     }
michael@0:     while(used>=EC_SYM_BITS);
michael@0:   }
michael@0:   window|=(ec_window)_fl<<used;
michael@0:   used+=_bits;
michael@0:   _this->end_window=window;
michael@0:   _this->nend_bits=used;
michael@0:   _this->nbits_total+=_bits;
michael@0: }
michael@0: 
michael@0: void ec_enc_patch_initial_bits(ec_enc *_this,unsigned _val,unsigned _nbits){
michael@0:   int      shift;
michael@0:   unsigned mask;
michael@0:   celt_assert(_nbits<=EC_SYM_BITS);
michael@0:   shift=EC_SYM_BITS-_nbits;
michael@0:   mask=((1<<_nbits)-1)<<shift;
michael@0:   if(_this->offs>0){
michael@0:     /*The first byte has been finalized.*/
michael@0:     _this->buf[0]=(unsigned char)((_this->buf[0]&~mask)|_val<<shift);
michael@0:   }
michael@0:   else if(_this->rem>=0){
michael@0:     /*The first byte is still awaiting carry propagation.*/
michael@0:     _this->rem=(_this->rem&~mask)|_val<<shift;
michael@0:   }
michael@0:   else if(_this->rng<=(EC_CODE_TOP>>_nbits)){
michael@0:     /*The renormalization loop has never been run.*/
michael@0:     _this->val=(_this->val&~((opus_uint32)mask<<EC_CODE_SHIFT))|
michael@0:      (opus_uint32)_val<<(EC_CODE_SHIFT+shift);
michael@0:   }
michael@0:   /*The encoder hasn't even encoded _nbits of data yet.*/
michael@0:   else _this->error=-1;
michael@0: }
michael@0: 
michael@0: void ec_enc_shrink(ec_enc *_this,opus_uint32 _size){
michael@0:   celt_assert(_this->offs+_this->end_offs<=_size);
michael@0:   OPUS_MOVE(_this->buf+_size-_this->end_offs,
michael@0:    _this->buf+_this->storage-_this->end_offs,_this->end_offs);
michael@0:   _this->storage=_size;
michael@0: }
michael@0: 
michael@0: void ec_enc_done(ec_enc *_this){
michael@0:   ec_window   window;
michael@0:   int         used;
michael@0:   opus_uint32 msk;
michael@0:   opus_uint32 end;
michael@0:   int         l;
michael@0:   /*We output the minimum number of bits that ensures that the symbols encoded
michael@0:      thus far will be decoded correctly regardless of the bits that follow.*/
michael@0:   l=EC_CODE_BITS-EC_ILOG(_this->rng);
michael@0:   msk=(EC_CODE_TOP-1)>>l;
michael@0:   end=(_this->val+msk)&~msk;
michael@0:   if((end|msk)>=_this->val+_this->rng){
michael@0:     l++;
michael@0:     msk>>=1;
michael@0:     end=(_this->val+msk)&~msk;
michael@0:   }
michael@0:   while(l>0){
michael@0:     ec_enc_carry_out(_this,(int)(end>>EC_CODE_SHIFT));
michael@0:     end=(end<<EC_SYM_BITS)&(EC_CODE_TOP-1);
michael@0:     l-=EC_SYM_BITS;
michael@0:   }
michael@0:   /*If we have a buffered byte flush it into the output buffer.*/
michael@0:   if(_this->rem>=0||_this->ext>0)ec_enc_carry_out(_this,0);
michael@0:   /*If we have buffered extra bits, flush them as well.*/
michael@0:   window=_this->end_window;
michael@0:   used=_this->nend_bits;
michael@0:   while(used>=EC_SYM_BITS){
michael@0:     _this->error|=ec_write_byte_at_end(_this,(unsigned)window&EC_SYM_MAX);
michael@0:     window>>=EC_SYM_BITS;
michael@0:     used-=EC_SYM_BITS;
michael@0:   }
michael@0:   /*Clear any excess space and add any remaining extra bits to the last byte.*/
michael@0:   if(!_this->error){
michael@0:     OPUS_CLEAR(_this->buf+_this->offs,
michael@0:      _this->storage-_this->offs-_this->end_offs);
michael@0:     if(used>0){
michael@0:       /*If there's no range coder data at all, give up.*/
michael@0:       if(_this->end_offs>=_this->storage)_this->error=-1;
michael@0:       else{
michael@0:         l=-l;
michael@0:         /*If we've busted, don't add too many extra bits to the last byte; it
michael@0:            would corrupt the range coder data, and that's more important.*/
michael@0:         if(_this->offs+_this->end_offs>=_this->storage&&l<used){
michael@0:           window&=(1<<l)-1;
michael@0:           _this->error=-1;
michael@0:         }
michael@0:         _this->buf[_this->storage-_this->end_offs-1]|=(unsigned char)window;
michael@0:       }
michael@0:     }
michael@0:   }
michael@0: }