Fix previous commit by still capping what the encoder will produce
[opus.git] / libcelt / entcode.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 #include "celt_types.h"
33
34 #if !defined(_entcode_H)
35 # define _entcode_H (1)
36 # include <limits.h>
37 # include <stddef.h>
38 # include "ecintrin.h"
39
40
41
42 typedef celt_int32            ec_int32;
43 typedef celt_uint32           ec_uint32;
44 typedef size_t                ec_window;
45 typedef struct ec_ctx         ec_ctx;
46 typedef struct ec_ctx         ec_enc;
47 typedef struct ec_ctx         ec_dec;
48
49
50
51 /*This must be at least 32 bits.*/
52 # define EC_WINDOW_SIZE ((int)sizeof(ec_window)*CHAR_BIT)
53
54 /*The number of bits to use for the range-coded part of unsigned integers.*/
55 # define EC_UINT_BITS   (8)
56
57 /*The resolution of fractional-precision bit usage measurements, i.e.,
58    3 => 1/8th bits.*/
59 # define BITRES 3
60
61
62
63 /*The entropy encoder/decoder context.
64   We use the same structure for both, so that common functions like ec_tell()
65    can be used on either one.*/
66 struct ec_ctx{
67    /*Buffered input/output.*/
68    unsigned char *buf;
69    /*The size of the buffer.*/
70    ec_uint32      storage;
71    /*The offset at which the last byte containing raw bits was read/written.*/
72    ec_uint32      end_offs;
73    /*Bits that will be read from/written at the end.*/
74    ec_window      end_window;
75    /*Number of valid bits in end_window.*/
76    int            nend_bits;
77    /*The total number of whole bits read/written.
78      This does not include partial bits currently in the range coder.*/
79    int            nbits_total;
80    /*The offset at which the next range coder byte will be read/written.*/
81    ec_uint32      offs;
82    /*The number of values in the current range.*/
83    ec_uint32      rng;
84    /*In the decoder: the difference between the top of the current range and
85       the input value, minus one.
86      In the encoder: the low end of the current range.*/
87    ec_uint32      val;
88    /*In the decoder: the saved normalization factor from ec_decode().
89      In the encoder: the number of oustanding carry propagating symbols.*/
90    ec_uint32      ext;
91    /*A buffered input/output symbol, awaiting carry propagation.*/
92    int            rem;
93    /*Nonzero if an error occurred.*/
94    int            error;
95 };
96
97
98 /*Shared functions.*/
99 static inline void ec_reset(ec_ctx *_this){
100   _this->offs=_this->end_offs=0;
101 }
102
103 static inline ec_uint32 ec_range_bytes(ec_ctx *_this){
104   return _this->offs;
105 }
106
107 static inline unsigned char *ec_get_buffer(ec_ctx *_this){
108   return _this->buf;
109 }
110
111 static inline int ec_get_error(ec_ctx *_this){
112   return _this->error;
113 }
114
115 /*Returns the number of bits "used" by the encoded or decoded symbols so far.
116   This same number can be computed in either the encoder or the decoder, and is
117    suitable for making coding decisions.
118   Return: The number of bits.
119           This will always be slightly larger than the exact value (e.g., all
120            rounding error is in the positive direction).*/
121 static inline int ec_tell(ec_ctx *_this){
122   return _this->nbits_total-EC_ILOG(_this->rng);
123 }
124
125 /*Returns the number of bits "used" by the encoded or decoded symbols so far.
126   This same number can be computed in either the encoder or the decoder, and is
127    suitable for making coding decisions.
128   Return: The number of bits scaled by 2**BITRES.
129           This will always be slightly larger than the exact value (e.g., all
130            rounding error is in the positive direction).*/
131 ec_uint32 ec_tell_frac(ec_ctx *_this);
132
133 int ec_ilog(ec_uint32 _v);
134
135 #endif