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