ebaed88737d2c68d8bab6175445258fc58f6df6f
[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 propagating 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 cumulative frequency of all symbols that come before the one to be
38         encoded.
39   _fh: The cumulative frequency of all symbols up to and including the one to
40         be encoded.
41        Together with _fl, this defines the range [_fl,_fh) in which the
42         decoded value will fall.
43   _ft: The sum of the frequencies of all the symbols*/
44 void ec_encode(ec_enc *_this,unsigned _fl,unsigned _fh,unsigned _ft);
45 /*Encodes a sequence of raw bits in the stream.
46   _fl:  The bits to encode.
47   _ftb: The number of bits to encode.
48         This must be at least one, and no more than 32.*/
49 void ec_enc_bits(ec_enc *_this,ec_uint32 _fl,int _ftb);
50 /*Encodes a sequence of raw bits in the stream.
51   _fl:  The bits to encode.
52   _ftb: The number of bits to encode.
53         This must be at least one, and no more than 64.*/
54 void ec_enc_bits64(ec_enc *_this,ec_uint64 _fl,int _ftb);
55 /*Encodes a raw unsigned integer in the stream.
56   _fl: The integer to encode.
57   _ft: The number of integers that can be encoded (one more than the max).
58        This must be at least one, and no more than 2**32-1.*/
59 void ec_enc_uint(ec_enc *_this,ec_uint32 _fl,ec_uint32 _ft);
60 /*Encodes a raw unsigned integer in the stream.
61   _fl: The integer to encode.
62   _ft: The number of integers that can be encoded (one more than the max).
63        This must be at least one, and no more than 2**64-1.*/
64 void ec_enc_uint64(ec_enc *_this,ec_uint64 _fl,ec_uint64 _ft);
65
66 /*Returns the number of bits "used" by the encoded symbols so far.
67   The actual number of bits may be larger, due to rounding to whole bytes, or
68    smaller, due to trailing zeros that can be stripped, so this is not an
69    estimate of the true packet size.
70   This same number can be computed by the decoder, and is suitable for making
71    coding decisions.
72   _b: The number of extra bits of precision to include.
73       At most 16 will be accurate.
74   Return: The number of bits scaled by 2**_b.
75           This will always be slightly larger than the exact value (e.g., all
76            rounding error is in the positive direction).*/
77 long ec_enc_tell(ec_enc *_this,int _b);
78
79 /*Indicates that there are no more symbols to encode.
80   All reamining output bytes are flushed to the output buffer.
81   ec_enc_init() must be called before the encoder can be used again.*/
82 void ec_enc_done(ec_enc *_this);
83
84 #endif