making codec draft more compliant with IETF submission rules
[opus.git] / libcelt / arch.h
1 /* Copyright (C) 2003-2008 Jean-Marc Valin */
2 /**
3    @file arch.h
4    @brief Various architecture definitions for CELT
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
40
41 #define celt_fatal(str) _celt_fatal(str, __FILE__, __LINE__);
42 #ifdef ENABLE_ASSERTIONS
43 #define celt_assert(cond) {if (!(cond)) {celt_fatal("assertion failed: " #cond);}}
44 #define celt_assert2(cond, message) {if (!(cond)) {celt_fatal("assertion failed: " #cond "\n" message);}}
45 #else
46 #define celt_assert(cond)
47 #define celt_assert2(cond, message)
48 #endif
49
50 #define IMUL32(a,b) ((a)*(b))
51
52 #define ABS(x) ((x) < 0 ? (-(x)) : (x))      /**< Absolute integer value. */
53 #define ABS16(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 16-bit value.  */
54 #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 16-bit value.   */
55 #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
56 #define ABS32(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 32-bit value.  */
57 #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 32-bit value.   */
58 #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
59 #define IMIN(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum int value.   */
60 #define IMAX(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum int value.   */
61 #define UADD32(a,b) ((a)+(b))
62 #define USUB32(a,b) ((a)-(b))
63
64 #define PRINT_MIPS(file)
65
66 #ifdef FIXED_POINT
67
68 typedef celt_int16_t celt_word16_t;
69 typedef celt_int32_t celt_word32_t;
70
71 typedef celt_word32_t celt_sig_t;
72 typedef celt_word16_t celt_norm_t;
73 typedef celt_word32_t celt_ener_t;
74 typedef celt_word16_t celt_pgain_t;
75 typedef celt_word32_t celt_mask_t;
76
77 #define Q15ONE 32767
78 #define Q30ONE 1073741823
79
80 #define SIG_SHIFT 12
81
82 #define NORM_SCALING 16384
83 #define NORM_SCALING_1 (1.f/16384.f)
84 #define NORM_SHIFT 14
85
86 #define ENER_SCALING 16384.f
87 #define ENER_SCALING_1 (1.f/16384.f)
88 #define ENER_SHIFT 14
89
90 #define PGAIN_SCALING 32768.f
91 #define PGAIN_SCALING_1 (1.f/32768.f)
92 #define PGAIN_SHIFT 15
93
94 #define DB_SCALING 256.f
95 #define DB_SCALING_1 (1.f/256.f)
96
97 #define EPSILON 1
98 #define VERY_SMALL 0
99 #define VERY_LARGE32 ((celt_word32_t)2147483647)
100 #define VERY_LARGE16 ((celt_word16_t)32767)
101 #define Q15_ONE ((celt_word16_t)32767)
102 #define Q15_ONE_1 (1.f/32768.f)
103
104 #define SCALEIN(a)      (a)
105 #define SCALEOUT(a)     (a)
106
107 #ifdef FIXED_DEBUG
108 #include "fixed_debug.h"
109 #else
110
111 #include "fixed_generic.h"
112
113 #ifdef ARM5E_ASM
114 #include "fixed_arm5e.h"
115 #elif defined (ARM4_ASM)
116 #include "fixed_arm4.h"
117 #elif defined (BFIN_ASM)
118 #include "fixed_bfin.h"
119 #elif defined (TI_C5X_ASM)
120 #include "fixed_c5x.h"
121 #elif defined (TI_C6X_ASM)
122 #include "fixed_c6x.h"
123 #endif
124
125 #endif
126
127
128 #else /* FIXED_POINT */
129
130 typedef float celt_word16_t;
131 typedef float celt_word32_t;
132
133 typedef float celt_sig_t;
134 typedef float celt_norm_t;
135 typedef float celt_ener_t;
136 typedef float celt_pgain_t;
137 typedef float celt_mask_t;
138
139 #define Q15ONE 1.0f
140 #define Q30ONE 1.0f
141
142 #define NORM_SCALING 1.f
143 #define NORM_SCALING_1 1.f
144 #define ENER_SCALING 1.f
145 #define ENER_SCALING_1 1.f
146 #define PGAIN_SCALING 1.f
147 #define PGAIN_SCALING_1 1.f
148
149 #define DB_SCALING 1.f
150 #define DB_SCALING_1 1.f
151
152 #define EPSILON 1e-15f
153 #define VERY_SMALL 1e-15f
154 #define VERY_LARGE32 1e15f
155 #define VERY_LARGE16 1e15f
156 #define Q15_ONE ((celt_word16_t)1.f)
157 #define Q15_ONE_1 ((celt_word16_t)1.f)
158
159 #define QCONST16(x,bits) (x)
160 #define QCONST32(x,bits) (x)
161
162 #define NEG16(x) (-(x))
163 #define NEG32(x) (-(x))
164 #define EXTRACT16(x) (x)
165 #define EXTEND32(x) (x)
166 #define SHR16(a,shift) (a)
167 #define SHL16(a,shift) (a)
168 #define SHR32(a,shift) (a)
169 #define SHL32(a,shift) (a)
170 #define PSHR16(a,shift) (a)
171 #define PSHR32(a,shift) (a)
172 #define VSHR32(a,shift) (a)
173 #define SATURATE16(x,a) (x)
174 #define SATURATE32(x,a) (x)
175
176 #define PSHR(a,shift)   (a)
177 #define SHR(a,shift)    (a)
178 #define SHL(a,shift)    (a)
179 #define SATURATE(x,a)   (x)
180
181 #define ROUND16(a,shift)  (a)
182 #define HALF32(x)       (.5f*(x))
183
184 #define ADD16(a,b) ((a)+(b))
185 #define SUB16(a,b) ((a)-(b))
186 #define ADD32(a,b) ((a)+(b))
187 #define SUB32(a,b) ((a)-(b))
188 #define MULT16_16_16(a,b)     ((a)*(b))
189 #define MULT16_16(a,b)     ((celt_word32_t)(a)*(celt_word32_t)(b))
190 #define MAC16_16(c,a,b)     ((c)+(celt_word32_t)(a)*(celt_word32_t)(b))
191
192 #define MULT16_32_Q11(a,b)     ((a)*(b))
193 #define MULT16_32_Q13(a,b)     ((a)*(b))
194 #define MULT16_32_Q14(a,b)     ((a)*(b))
195 #define MULT16_32_Q15(a,b)     ((a)*(b))
196 #define MULT16_32_Q16(a,b)     ((a)*(b))
197 #define MULT16_32_P15(a,b)     ((a)*(b))
198
199 #define MULT32_32_Q31(a,b)     ((a)*(b))
200
201 #define MAC16_32_Q11(c,a,b)     ((c)+(a)*(b))
202 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
203
204 #define MAC16_16_Q11(c,a,b)     ((c)+(a)*(b))
205 #define MAC16_16_Q13(c,a,b)     ((c)+(a)*(b))
206 #define MAC16_16_P13(c,a,b)     ((c)+(a)*(b))
207 #define MULT16_16_Q11_32(a,b)     ((a)*(b))
208 #define MULT16_16_Q13(a,b)     ((a)*(b))
209 #define MULT16_16_Q14(a,b)     ((a)*(b))
210 #define MULT16_16_Q15(a,b)     ((a)*(b))
211 #define MULT16_16_P15(a,b)     ((a)*(b))
212 #define MULT16_16_P13(a,b)     ((a)*(b))
213 #define MULT16_16_P14(a,b)     ((a)*(b))
214
215 #define DIV32_16(a,b)     (((celt_word32_t)(a))/(celt_word16_t)(b))
216 #define PDIV32_16(a,b)     (((celt_word32_t)(a))/(celt_word16_t)(b))
217 #define DIV32(a,b)     (((celt_word32_t)(a))/(celt_word32_t)(b))
218 #define PDIV32(a,b)     (((celt_word32_t)(a))/(celt_word32_t)(b))
219
220 #define SCALEIN(a)      ((a)*32768.)
221 #define SCALEOUT(a)     ((a)*(1/32768.))
222
223 #endif /* !FIXED_POINT */
224
225
226 #if defined (CONFIG_TI_C54X) || defined (CONFIG_TI_C55X)
227
228 /* 2 on TI C5x DSP */
229 #define BYTES_PER_CHAR 2 
230 #define BITS_PER_CHAR 16
231 #define LOG2_BITS_PER_CHAR 4
232
233 #else /* CONFIG_TI_C54X */
234
235 #define BYTES_PER_CHAR 1
236 #define BITS_PER_CHAR 8
237 #define LOG2_BITS_PER_CHAR 3
238
239 #endif /* !CONFIG_TI_C54X */
240
241 #ifndef GLOBAL_STACK_SIZE 
242 #ifdef FIXED_POINT
243 #define GLOBAL_STACK_SIZE 25000
244 #else
245 #define GLOBAL_STACK_SIZE 40000
246 #endif
247 #endif 
248
249 #endif /* ARCH_H */