Apply band caps to the band allocation table.
[opus.git] / libcelt / entenc.h
1 /* Copyright (c) 2001-2008 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 typedef struct ec_enc ec_enc;
40
41
42
43 /*The entropy encoder.*/
44 struct ec_enc{
45    /*Buffered output.*/
46    ec_byte_buffer *buf;
47    /*A buffered output symbol, awaiting carry propagation.*/
48    int             rem;
49    /*Number of extra carry propagating symbols.*/
50    size_t          ext;
51    /*The number of values in the current range.*/
52    ec_uint32       rng;
53    /*The low end of the current range (inclusive).*/
54    ec_uint32       low;
55    /*Bits that will be written at the end.*/
56    ec_window       end_window;
57    /*Number of valid bits in end_window.*/
58    int             nend_bits;
59    /*The total number of whole bits written.*/
60    int             nbits_total;
61    /*Nonzero if an error occurred.*/
62    int             error;
63 };
64
65
66 /*Initializes the encoder.
67   _buf: The buffer to store output bytes in.
68         This must have already been initialized for writing and reset.*/
69 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf);
70 /*Encodes a symbol given its frequency information.
71   The frequency information must be discernable by the decoder, assuming it
72    has read only the previous symbols from the stream.
73   It is allowable to change the frequency information, or even the entire
74    source alphabet, so long as the decoder can tell from the context of the
75    previously encoded information that it is supposed to do so as well.
76   _fl: The cumulative frequency of all symbols that come before the one to be
77         encoded.
78   _fh: The cumulative frequency of all symbols up to and including the one to
79         be encoded.
80        Together with _fl, this defines the range [_fl,_fh) in which the
81         decoded value will fall.
82   _ft: The sum of the frequencies of all the symbols*/
83 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft);
84 void ec_encode_bin(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _bits);
85 /*Encodes a sequence of raw bits in the stream.
86   _fl:  The bits to encode.
87   _ftb: The number of bits to encode.
88         This must be between 0 and 25, inclusive.*/
89 void ec_enc_bits(ec_enc *_this,ec_uint32 _fl,unsigned _ftb);
90
91 /*Encodes a raw unsigned integer in the stream.
92   _fl: The integer to encode.
93   _ft: The number of integers that can be encoded (one more than the max).
94        This must be at least one, and no more than 2**32-1.*/
95 void ec_enc_uint(ec_enc *_this,ec_uint32 _fl,ec_uint32 _ft);
96
97 /* Encode a bit that has a _prob/65536 probability of being a one */
98 void ec_enc_bit_prob(ec_enc *_this,int val,unsigned _prob);
99
100 /* Encode a bit that has a 1/(1<<_logp) probability of being a one */
101 void ec_enc_bit_logp(ec_enc *_this,int _val,unsigned _logp);
102
103 /*Encodes a symbol given an "inverse" CDF table.
104   _s:    The index of the symbol to encode.
105   _icdf: The "inverse" CDF, such that symbol _s falls in the range
106           [_s>0?ft-_icdf[_s-1]:0,ft-_icdf[_s]), where ft=1<<_ftb.
107          The values must be monotonically non-increasing, and the last value
108           must be 0.
109   _ftb: The number of bits of precision in the cumulative distribution.*/
110 void ec_enc_icdf(ec_enc *_this,int _s,const unsigned char *_icdf,unsigned _ftb);
111
112 /*Returns the number of bits "used" by the encoded symbols so far.
113   This same number can be computed by the decoder, and is suitable for making
114    coding decisions.
115   _b: The number of extra bits of precision to include.
116       At most 16 will be accurate.
117   Return: The number of bits scaled by 2**_b.
118           This will always be slightly larger than the exact value (e.g., all
119            rounding error is in the positive direction).*/
120 ec_uint32 ec_enc_tell(ec_enc *_this,int _b);
121
122 /*Indicates that there are no more symbols to encode.
123   All reamining output bytes are flushed to the output buffer.
124   ec_enc_init() must be called before the encoder can be used again.*/
125 void ec_enc_done(ec_enc *_this);
126
127 /*Returns a nonzero value if any error has been detected during encoding*/
128 int ec_enc_get_error(ec_enc *_this);
129
130 #endif