Eliminate the ec_int32 and ec_uint32 typedefs.
[opus.git] / libcelt / mfrngcod.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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #if !defined(_mfrngcode_H)
29 # define _mfrngcode_H (1)
30 # include "entcode.h"
31
32 /*Constants used by the entropy encoder/decoder.*/
33
34 /*The number of bits to output at a time.*/
35 # define EC_SYM_BITS   (8)
36 /*The total number of bits in each of the state registers.*/
37 # define EC_CODE_BITS  (32)
38 /*The maximum symbol value.*/
39 # define EC_SYM_MAX    ((1U<<EC_SYM_BITS)-1)
40 /*Bits to shift by to move a symbol into the high-order position.*/
41 # define EC_CODE_SHIFT (EC_CODE_BITS-EC_SYM_BITS-1)
42 /*Carry bit of the high-order range symbol.*/
43 # define EC_CODE_TOP   (((celt_uint32)1U)<<EC_CODE_BITS-1)
44 /*Low-order bit of the high-order range symbol.*/
45 # define EC_CODE_BOT   (EC_CODE_TOP>>EC_SYM_BITS)
46 /*Code for which propagating carries are possible.*/
47 # define EC_CODE_CARRY (((celt_uint32)EC_SYM_MAX)<<EC_CODE_SHIFT)
48 /*The number of bits available for the last, partial symbol in the code field.*/
49 # define EC_CODE_EXTRA ((EC_CODE_BITS-2)%EC_SYM_BITS+1)
50 /*A mask for the bits available in the coding buffer.
51   This allows different platforms to use a variable with more bits, if it is
52    convenient.
53   We will only use EC_CODE_BITS of it.*/
54 # define EC_CODE_MASK  ((((celt_uint32)1U)<<EC_CODE_BITS-1)-1<<1|1)
55
56 #endif