Using reciprocal approximation instead of full 32-bit division in alg_quant()
[opus.git] / libcelt / arch.h
1 /* Copyright (C) 2003-2008 Jean-Marc Valin */
2 /**
3    @file arch.h
4    @brief Various architecture definitions Speex
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef ARCH_H
36 #define ARCH_H
37
38 #include "celt_types.h"
39 #include "stack_alloc.h"
40
41 #define ABS(x) ((x) < 0 ? (-(x)) : (x))      /**< Absolute integer value. */
42 #define ABS16(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 16-bit value.  */
43 #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
44 #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
45 #define ABS32(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 32-bit value.  */
46 #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
47 #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
48
49 #ifdef FIXED_POINT
50
51 typedef celt_int16_t celt_word16_t;
52 typedef celt_int32_t celt_word32_t;
53
54 typedef celt_word32_t celt_sig_t;
55 typedef celt_word16_t celt_norm_t;
56 typedef celt_word32_t celt_ener_t;
57 typedef celt_word16_t celt_pgain_t;
58 typedef celt_word32_t celt_mask_t;
59
60 #define Q15ONE 32767
61 #define Q30ONE 1073741823
62
63 #define SIG_SCALING 16384.f
64 #define SIG_SCALING_1 (1.f/16384.f)
65 #define SIG_SHIFT 14
66
67 #define NORM_SCALING 16384
68 #define NORM_SCALING_1 (1.f/16384.f)
69 #define NORM_SHIFT 14
70
71 #define ENER_SCALING 16384.f
72 #define ENER_SCALING_1 (1.f/16384.f)
73
74 #define PGAIN_SCALING 32768.f
75 #define PGAIN_SCALING_1 (1.f/32768.f)
76 #define PGAIN_SHIFT 15
77
78 #define DB_SCALING 256.f
79 #define DB_SCALING_1 (1.f/256.f)
80
81 #define EPSILON 1
82 #define VERY_SMALL 0
83 #define VERY_LARGE32 ((celt_word32_t)2147483647)
84 #define VERY_LARGE16 ((celt_word16_t)32767)
85 #define Q15_ONE ((celt_word16_t)32767)
86 #define Q15_ONE_1 (1.f/32768.f)
87
88
89 #ifdef FIXED_DEBUG
90 #include "fixed_debug.h"
91 #else
92
93 #include "fixed_generic.h"
94
95 #ifdef ARM5E_ASM
96 #include "fixed_arm5e.h"
97 #elif defined (ARM4_ASM)
98 #include "fixed_arm4.h"
99 #elif defined (BFIN_ASM)
100 #include "fixed_bfin.h"
101 #elif defined (TI_C5X_ASM)
102 #include "fixed_c5x.h"
103 #endif
104
105 #endif
106
107
108 #else /* FIXED_POINT */
109
110 typedef float celt_word16_t;
111 typedef float celt_word32_t;
112
113 typedef float celt_sig_t;
114 typedef float celt_norm_t;
115 typedef float celt_ener_t;
116 typedef float celt_pgain_t;
117 typedef float celt_mask_t;
118
119 #define Q15ONE 1.0f
120 #define Q30ONE 1.0f
121
122 #define SIG_SCALING  1.f
123 #define SIG_SCALING_1 1.f
124 #define NORM_SCALING 1.f
125 #define NORM_SCALING_1 1.f
126 #define ENER_SCALING 1.f
127 #define ENER_SCALING_1 1.f
128 #define PGAIN_SCALING 1.f
129 #define PGAIN_SCALING_1 1.f
130
131 #define DB_SCALING 1.f
132 #define DB_SCALING_1 1.f
133
134 #define EPSILON 1e-15
135 #define VERY_SMALL 1e-15f
136 #define VERY_LARGE32 1e15f
137 #define VERY_LARGE16 1e15f
138 #define Q15_ONE ((celt_word16_t)1.f)
139 #define Q15_ONE_1 ((celt_word16_t)1.f)
140
141 #define QCONST16(x,bits) (x)
142 #define QCONST32(x,bits) (x)
143
144 #define NEG16(x) (-(x))
145 #define NEG32(x) (-(x))
146 #define EXTRACT16(x) (x)
147 #define EXTEND32(x) (x)
148 #define SHR16(a,shift) (a)
149 #define SHL16(a,shift) (a)
150 #define SHR32(a,shift) (a)
151 #define SHL32(a,shift) (a)
152 #define PSHR16(a,shift) (a)
153 #define PSHR32(a,shift) (a)
154 #define VSHR32(a,shift) (a)
155 #define SATURATE16(x,a) (x)
156 #define SATURATE32(x,a) (x)
157
158 #define PSHR(a,shift)   (a)
159 #define SHR(a,shift)    (a)
160 #define SHL(a,shift)    (a)
161 #define SATURATE(x,a)   (x)
162
163 #define ROUND(a,shift)  (a)
164 #define HALF32(x)       (.5f*(x))
165
166 #define ADD16(a,b) ((a)+(b))
167 #define SUB16(a,b) ((a)-(b))
168 #define ADD32(a,b) ((a)+(b))
169 #define SUB32(a,b) ((a)-(b))
170 #define MULT16_16_16(a,b)     ((a)*(b))
171 #define MULT16_16(a,b)     ((celt_word32_t)(a)*(celt_word32_t)(b))
172 #define MAC16_16(c,a,b)     ((c)+(celt_word32_t)(a)*(celt_word32_t)(b))
173
174 #define MULT16_32_Q11(a,b)     ((a)*(b))
175 #define MULT16_32_Q13(a,b)     ((a)*(b))
176 #define MULT16_32_Q14(a,b)     ((a)*(b))
177 #define MULT16_32_Q15(a,b)     ((a)*(b))
178 #define MULT16_32_P15(a,b)     ((a)*(b))
179
180 #define MULT32_32_Q31(a,b)     ((a)*(b))
181
182 #define MAC16_32_Q11(c,a,b)     ((c)+(a)*(b))
183 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
184
185 #define MAC16_16_Q11(c,a,b)     ((c)+(a)*(b))
186 #define MAC16_16_Q13(c,a,b)     ((c)+(a)*(b))
187 #define MAC16_16_P13(c,a,b)     ((c)+(a)*(b))
188 #define MULT16_16_Q11_32(a,b)     ((a)*(b))
189 #define MULT16_16_Q13(a,b)     ((a)*(b))
190 #define MULT16_16_Q14(a,b)     ((a)*(b))
191 #define MULT16_16_Q15(a,b)     ((a)*(b))
192 #define MULT16_16_P15(a,b)     ((a)*(b))
193 #define MULT16_16_P13(a,b)     ((a)*(b))
194 #define MULT16_16_P14(a,b)     ((a)*(b))
195
196 #define DIV32_16(a,b)     (((celt_word32_t)(a))/(celt_word16_t)(b))
197 #define PDIV32_16(a,b)     (((celt_word32_t)(a))/(celt_word16_t)(b))
198 #define DIV32(a,b)     (((celt_word32_t)(a))/(celt_word32_t)(b))
199 #define PDIV32(a,b)     (((celt_word32_t)(a))/(celt_word32_t)(b))
200
201
202 #endif /* !FIXED_POINT */
203
204
205 #if defined (CONFIG_TI_C54X) || defined (CONFIG_TI_C55X)
206
207 /* 2 on TI C5x DSP */
208 #define BYTES_PER_CHAR 2 
209 #define BITS_PER_CHAR 16
210 #define LOG2_BITS_PER_CHAR 4
211
212 #else /* CONFIG_TI_C54X */
213
214 #define BYTES_PER_CHAR 1
215 #define BITS_PER_CHAR 8
216 #define LOG2_BITS_PER_CHAR 3
217
218 #endif /* !CONFIG_TI_C54X */
219
220
221
222 #endif /* ARCH_H */