feb08a56a6848ad6eb1bb1130f4df789b6ad4172
[opus.git] / libentcode / entenc.h
1 #if !defined(_entenc_H)
2 # define _entenc_H (1)
3 # include <stddef.h>
4 # include "entcode.h"
5
6
7
8 typedef struct ec_enc ec_enc;
9
10
11
12 /*The entropy encoder.*/
13 struct ec_enc{
14    /*Buffered output.*/
15    ec_byte_buffer *buf;
16    /*A buffered output symbol, awaiting carry propagation.*/
17    int             rem;
18    /*Number of extra carry propogating symbols.*/
19    size_t          ext;
20    /*The number of values in the current range.*/
21    ec_uint32       rng;
22    /*The low end of the current range (inclusive).*/
23    ec_uint32       low;
24 };
25
26
27 /*Initializes the encoder.
28   _buf: The buffer to store output bytes in.
29         This must have already been initialized for writing and reset.*/
30 void ec_enc_init(ec_enc *_this,ec_byte_buffer *_buf);
31 /*Encodes a symbol given its frequency information.
32   The frequency information must be discernable by the decoder, assuming it
33    has read only the previous symbols from the stream.
34   It is allowable to change the frequency information, or even the entire
35    source alphabet, so long as the decoder can tell from the context of the
36    previously encoded information that it is supposed to do so as well.
37   _fl: The sum of the frequencies of symbols before the one to be encoded.
38   _fs: The frequency of the symbol to be encoded.
39   _ft: The sum of the frequencies of all the symbols*/
40 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fs,unsigned _ft);
41 /*Encodes a sequence of raw bits in the stream.
42   _fl:  The bits to encode.
43   _ftb: The number of bits to encode.
44         This must be at least one, and no more than 32.*/
45 void ec_enc_bits(ec_enc *_this,ec_uint32 _fl,int _ftb);
46 /*Encodes a raw unsigned integer in the stream.
47   _fl: The integer to encode.
48   _ft: The number of integers that can be encoded (one more than the max).
49        This must be at least one, and no more than 2**32-1.*/
50 void ec_enc_uint(ec_enc *_this,ec_uint32 _fl,ec_uint32 _ft);
51
52 /*Indicates that there are no more symbols to encode.
53   All reamining output bytes are flushed to the output buffer.
54   ec_enc_init() must be called before the encoder can be used again.*/
55 void ec_enc_done(ec_enc *_this);
56
57 #endif