9eb37d8f779c6dd25c9a8faee58b7d3724910a0a
[opus.git] / celt / 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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef ARCH_H
35 #define ARCH_H
36
37 #include "opus_types.h"
38 #include "opus_defines.h"
39
40 # if !defined(__GNUC_PREREQ)
41 #  if defined(__GNUC__)&&defined(__GNUC_MINOR__)
42 #   define __GNUC_PREREQ(_maj,_min) \
43  ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
44 #  else
45 #   define __GNUC_PREREQ(_maj,_min) 0
46 #  endif
47 # endif
48
49 #if OPUS_GNUC_PREREQ(3, 0)
50 #define opus_likely(x)       (__builtin_expect(!!(x), 1))
51 #define opus_unlikely(x)     (__builtin_expect(!!(x), 0))
52 #else
53 #define opus_likely(x)       (!!(x))
54 #define opus_unlikely(x)     (!!(x))
55 #endif
56
57 #define CELT_SIG_SCALE 32768.f
58
59 #define celt_fatal(str) _celt_fatal(str, __FILE__, __LINE__);
60 #ifdef ENABLE_ASSERTIONS
61 #include <stdio.h>
62 #include <stdlib.h>
63 #ifdef __GNUC__
64 __attribute__((noreturn))
65 #endif
66 static OPUS_INLINE void _celt_fatal(const char *str, const char *file, int line)
67 {
68    fprintf (stderr, "Fatal (internal) error in %s, line %d: %s\n", file, line, str);
69    abort();
70 }
71 #define celt_assert(cond) {if (!(cond)) {celt_fatal("assertion failed: " #cond);}}
72 #define celt_assert2(cond, message) {if (!(cond)) {celt_fatal("assertion failed: " #cond "\n" message);}}
73 #else
74 #define celt_assert(cond)
75 #define celt_assert2(cond, message)
76 #endif
77
78 #define IMUL32(a,b) ((a)*(b))
79
80 #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 16-bit value.   */
81 #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
82 #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 32-bit value.   */
83 #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
84 #define IMIN(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum int value.   */
85 #define IMAX(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum int value.   */
86 #define UADD32(a,b) ((a)+(b))
87 #define USUB32(a,b) ((a)-(b))
88
89 /* Set this if opus_int64 is a native type of the CPU. */
90 /* Assume that all LP64 architectures have fast 64-bit types; also x86_64
91    (which can be ILP32 for x32) and Win64 (which is LLP64). */
92 #if defined(__x86_64__) || defined(__LP64__) || defined(_WIN64)
93 #define OPUS_FAST_INT64 1
94 #else
95 #define OPUS_FAST_INT64 0
96 #endif
97
98 #define PRINT_MIPS(file)
99
100 #ifdef FIXED_POINT
101
102 typedef opus_int16 opus_val16;
103 typedef opus_int32 opus_val32;
104
105 typedef opus_val32 celt_sig;
106 typedef opus_val16 celt_norm;
107 typedef opus_val32 celt_ener;
108
109 #define Q15ONE 32767
110
111 #define SIG_SHIFT 12
112 /* Safe saturation value for 32-bit signals. Should be less than
113    2^31*(1-0.85) to avoid blowing up on DC at deemphasis.*/
114 #define SIG_SAT (300000000)
115
116 #define NORM_SCALING 16384
117
118 #define DB_SHIFT 10
119
120 #define EPSILON 1
121 #define VERY_SMALL 0
122 #define VERY_LARGE16 ((opus_val16)32767)
123 #define Q15_ONE ((opus_val16)32767)
124
125 #define SCALEIN(a)      (a)
126 #define SCALEOUT(a)     (a)
127
128 #define ABS16(x) ((x) < 0 ? (-(x)) : (x))
129 #define ABS32(x) ((x) < 0 ? (-(x)) : (x))
130
131 static OPUS_INLINE opus_int16 SAT16(opus_int32 x) {
132    return x > 32767 ? 32767 : x < -32768 ? -32768 : (opus_int16)x;
133 }
134
135 #ifdef FIXED_DEBUG
136 #include "fixed_debug.h"
137 #else
138
139 #include "fixed_generic.h"
140
141 #ifdef OPUS_ARM_PRESUME_AARCH64_NEON_INTR
142 #include "arm/fixed_arm64.h"
143 #elif OPUS_ARM_INLINE_EDSP
144 #include "arm/fixed_armv5e.h"
145 #elif defined (OPUS_ARM_INLINE_ASM)
146 #include "arm/fixed_armv4.h"
147 #elif defined (BFIN_ASM)
148 #include "fixed_bfin.h"
149 #elif defined (TI_C5X_ASM)
150 #include "fixed_c5x.h"
151 #elif defined (TI_C6X_ASM)
152 #include "fixed_c6x.h"
153 #endif
154
155 #endif
156
157 #else /* FIXED_POINT */
158
159 typedef float opus_val16;
160 typedef float opus_val32;
161
162 typedef float celt_sig;
163 typedef float celt_norm;
164 typedef float celt_ener;
165
166 #ifdef FLOAT_APPROX
167 /* This code should reliably detect NaN/inf even when -ffast-math is used.
168    Assumes IEEE 754 format. */
169 static OPUS_INLINE int celt_isnan(float x)
170 {
171    union {float f; opus_uint32 i;} in;
172    in.f = x;
173    return ((in.i>>23)&0xFF)==0xFF && (in.i&0x007FFFFF)!=0;
174 }
175 #else
176 #ifdef __FAST_MATH__
177 #error Cannot build libopus with -ffast-math unless FLOAT_APPROX is defined. This could result in crashes on extreme (e.g. NaN) input
178 #endif
179 #define celt_isnan(x) ((x)!=(x))
180 #endif
181
182 #define Q15ONE 1.0f
183
184 #define NORM_SCALING 1.f
185
186 #define EPSILON 1e-15f
187 #define VERY_SMALL 1e-30f
188 #define VERY_LARGE16 1e15f
189 #define Q15_ONE ((opus_val16)1.f)
190
191 /* This appears to be the same speed as C99's fabsf() but it's more portable. */
192 #define ABS16(x) ((float)fabs(x))
193 #define ABS32(x) ((float)fabs(x))
194
195 #define QCONST16(x,bits) (x)
196 #define QCONST32(x,bits) (x)
197
198 #define NEG16(x) (-(x))
199 #define NEG32(x) (-(x))
200 #define NEG32_ovflw(x) (-(x))
201 #define EXTRACT16(x) (x)
202 #define EXTEND32(x) (x)
203 #define SHR16(a,shift) (a)
204 #define SHL16(a,shift) (a)
205 #define SHR32(a,shift) (a)
206 #define SHL32(a,shift) (a)
207 #define PSHR32(a,shift) (a)
208 #define VSHR32(a,shift) (a)
209
210 #define PSHR(a,shift)   (a)
211 #define SHR(a,shift)    (a)
212 #define SHL(a,shift)    (a)
213 #define SATURATE(x,a)   (x)
214 #define SATURATE16(x)   (x)
215
216 #define ROUND16(a,shift)  (a)
217 #define SROUND16(a,shift) (a)
218 #define HALF16(x)       (.5f*(x))
219 #define HALF32(x)       (.5f*(x))
220
221 #define ADD16(a,b) ((a)+(b))
222 #define SUB16(a,b) ((a)-(b))
223 #define ADD32(a,b) ((a)+(b))
224 #define SUB32(a,b) ((a)-(b))
225 #define ADD32_ovflw(a,b) ((a)+(b))
226 #define SUB32_ovflw(a,b) ((a)-(b))
227 #define MULT16_16_16(a,b)     ((a)*(b))
228 #define MULT16_16(a,b)     ((opus_val32)(a)*(opus_val32)(b))
229 #define MAC16_16(c,a,b)     ((c)+(opus_val32)(a)*(opus_val32)(b))
230
231 #define MULT16_32_Q15(a,b)     ((a)*(b))
232 #define MULT16_32_Q16(a,b)     ((a)*(b))
233
234 #define MULT32_32_Q31(a,b)     ((a)*(b))
235
236 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
237 #define MAC16_32_Q16(c,a,b)     ((c)+(a)*(b))
238
239 #define MULT16_16_Q11_32(a,b)     ((a)*(b))
240 #define MULT16_16_Q11(a,b)     ((a)*(b))
241 #define MULT16_16_Q13(a,b)     ((a)*(b))
242 #define MULT16_16_Q14(a,b)     ((a)*(b))
243 #define MULT16_16_Q15(a,b)     ((a)*(b))
244 #define MULT16_16_P15(a,b)     ((a)*(b))
245 #define MULT16_16_P13(a,b)     ((a)*(b))
246 #define MULT16_16_P14(a,b)     ((a)*(b))
247 #define MULT16_32_P16(a,b)     ((a)*(b))
248
249 #define DIV32_16(a,b)     (((opus_val32)(a))/(opus_val16)(b))
250 #define DIV32(a,b)     (((opus_val32)(a))/(opus_val32)(b))
251
252 #define SCALEIN(a)      ((a)*CELT_SIG_SCALE)
253 #define SCALEOUT(a)     ((a)*(1/CELT_SIG_SCALE))
254
255 #define SIG2WORD16(x) (x)
256
257 #endif /* !FIXED_POINT */
258
259 #ifndef GLOBAL_STACK_SIZE
260 #ifdef FIXED_POINT
261 #define GLOBAL_STACK_SIZE 100000
262 #else
263 #define GLOBAL_STACK_SIZE 100000
264 #endif
265 #endif
266
267 #endif /* ARCH_H */