CELT_SET_END_BAND_REQUEST in the decoder was performing the wrong bounds check and...
[opus.git] / libcelt / entenc.h
1 /* Copyright (c) 2001-2011 Timothy B. Terriberry
2    Copyright (c) 2008-2009 Xiph.Org Foundation */
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 #if !defined(_entenc_H)
33 # define _entenc_H (1)
34 # include <stddef.h>
35 # include "entcode.h"
36
37
38
39 /*Initializes the encoder.
40   _buf:  The buffer to store output bytes in.
41   _size: The size of the buffer, in chars.*/
42 void ec_enc_init(ec_enc *_this,unsigned char *_buf,ec_uint32 _size);
43 /*Encodes a symbol given its frequency information.
44   The frequency information must be discernable by the decoder, assuming it
45    has read only the previous symbols from the stream.
46   It is allowable to change the frequency information, or even the entire
47    source alphabet, so long as the decoder can tell from the context of the
48    previously encoded information that it is supposed to do so as well.
49   _fl: The cumulative frequency of all symbols that come before the one to be
50         encoded.
51   _fh: The cumulative frequency of all symbols up to and including the one to
52         be encoded.
53        Together with _fl, this defines the range [_fl,_fh) in which the
54         decoded value will fall.
55   _ft: The sum of the frequencies of all the symbols*/
56 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft);
57
58 /*Equivalent to ec_encode() with _ft==1<<_bits.*/
59 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _bits);
60
61 /* Encode a bit that has a 1/(1<<_logp) probability of being a one */
62 void ec_enc_bit_logp(ec_enc *_this,int _val,unsigned _logp);
63
64 /*Encodes a symbol given an "inverse" CDF table.
65   _s:    The index of the symbol to encode.
66   _icdf: The "inverse" CDF, such that symbol _s falls in the range
67           [_s>0?ft-_icdf[_s-1]:0,ft-_icdf[_s]), where ft=1<<_ftb.
68          The values must be monotonically non-increasing, and the last value
69           must be 0.
70   _ftb: The number of bits of precision in the cumulative distribution.*/
71 void ec_enc_icdf(ec_enc *_this,int _s,const unsigned char *_icdf,unsigned _ftb);
72
73 /*Encodes a raw unsigned integer in the stream.
74   _fl: The integer to encode.
75   _ft: The number of integers that can be encoded (one more than the max).
76        This must be at least one, and no more than 2**32-1.*/
77 void ec_enc_uint(ec_enc *_this,ec_uint32 _fl,ec_uint32 _ft);
78
79 /*Encodes a sequence of raw bits in the stream.
80   _fl:  The bits to encode.
81   _ftb: The number of bits to encode.
82         This must be between 0 and 25, inclusive.*/
83 void ec_enc_bits(ec_enc *_this,ec_uint32 _fl,unsigned _ftb);
84
85 /*Compacts the data to fit in the target size.
86   This moves up the raw bits at the end of the current buffer so they are at
87    the end of the new buffer size.
88   The caller must ensure that the amount of data that's already been written
89    will fit in the new size.
90   _size: The number of bytes in the new buffer.
91          This must be large enough to contain the bits already written, and
92           must be no larger than the existing size.*/
93 void ec_enc_shrink(ec_enc *_this,ec_uint32 _size);
94
95 /*Indicates that there are no more symbols to encode.
96   All reamining output bytes are flushed to the output buffer.
97   ec_enc_init() must be called before the encoder can be used again.*/
98 void ec_enc_done(ec_enc *_this);
99
100 #endif