making codec draft more compliant with IETF submission rules
[opus.git] / libcelt / mfrngcod.h
1 /* (C) 2001-2008 Timothy B. Terriberry
2    (C) 2008 Jean-Marc Valin */
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(_mfrngcode_H)
33 # define _mfrngcode_H (1)
34 # include "entcode.h"
35
36 /*Constants used by the entropy encoder/decoder.*/
37
38 /*The number of bits to output at a time.*/
39 # define EC_SYM_BITS   (8)
40 /*The total number of bits in each of the state registers.*/
41 # define EC_CODE_BITS  (32)
42 /*The maximum symbol value.*/
43 # define EC_SYM_MAX    ((1U<<EC_SYM_BITS)-1)
44 /*Bits to shift by to move a symbol into the high-order position.*/
45 # define EC_CODE_SHIFT (EC_CODE_BITS-EC_SYM_BITS-1)
46 /*Carry bit of the high-order range symbol.*/
47 # define EC_CODE_TOP   (((ec_uint32)1U)<<EC_CODE_BITS-1)
48 /*Low-order bit of the high-order range symbol.*/
49 # define EC_CODE_BOT   (EC_CODE_TOP>>EC_SYM_BITS)
50 /*Code for which propagating carries are possible.*/
51 # define EC_CODE_CARRY (((ec_uint32)EC_SYM_MAX)<<EC_CODE_SHIFT)
52 /*The number of bits available for the last, partial symbol in the code field.*/
53 # define EC_CODE_EXTRA ((EC_CODE_BITS-2)%EC_SYM_BITS+1)
54 /*A mask for the bits available in the coding buffer.
55   This allows different platforms to use a variable with more bits, if it is
56    convenient.
57   We will only use EC_CODE_BITS of it.*/
58 # define EC_CODE_MASK  ((((ec_uint32)1U)<<EC_CODE_BITS-1)-1<<1|1)
59
60
61 /*The non-zero symbol of the second possible reserved ending.
62   This must be the high-bit.*/
63 # define EC_FOF_RSV1      (1<<EC_SYM_BITS-1)
64 /*A mask for all the other bits.*/
65 # define EC_FOF_RSV1_MASK (EC_FOF_RSV1-1)
66
67 #endif