Adding ENABLE_HARDENING
[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
61 #if defined(ENABLE_ASSERTIONS) || defined(ENABLE_HARDENING)
62 #ifdef __GNUC__
63 __attribute__((noreturn))
64 #endif
65 void celt_fatal(const char *str, const char *file, int line);
66
67 #if defined(CELT_C) && !defined(OVERRIDE_celt_fatal)
68 #include <stdio.h>
69 #include <stdlib.h>
70 #ifdef __GNUC__
71 __attribute__((noreturn))
72 #endif
73 void celt_fatal(const char *str, const char *file, int line)
74 {
75    fprintf (stderr, "Fatal (internal) error in %s, line %d: %s\n", file, line, str);
76    abort();
77 }
78 #endif
79
80 #define celt_assert(cond) {if (!(cond)) {CELT_FATAL("assertion failed: " #cond);}}
81 #define celt_assert2(cond, message) {if (!(cond)) {CELT_FATAL("assertion failed: " #cond "\n" message);}}
82 #else
83 #define celt_assert(cond)
84 #define celt_assert2(cond, message)
85 #endif
86
87 #if defined(ENABLE_ASSERTIONS)
88 #define celt_sig_assert(cond) {if (!(cond)) {CELT_FATAL("signal assertion failed: " #cond);}}
89 #else
90 #define celt_sig_assert(cond)
91 #endif
92
93 #define IMUL32(a,b) ((a)*(b))
94
95 #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 16-bit value.   */
96 #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
97 #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 32-bit value.   */
98 #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
99 #define IMIN(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum int value.   */
100 #define IMAX(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum int value.   */
101 #define UADD32(a,b) ((a)+(b))
102 #define USUB32(a,b) ((a)-(b))
103
104 /* Set this if opus_int64 is a native type of the CPU. */
105 /* Assume that all LP64 architectures have fast 64-bit types; also x86_64
106    (which can be ILP32 for x32) and Win64 (which is LLP64). */
107 #if defined(__x86_64__) || defined(__LP64__) || defined(_WIN64)
108 #define OPUS_FAST_INT64 1
109 #else
110 #define OPUS_FAST_INT64 0
111 #endif
112
113 #define PRINT_MIPS(file)
114
115 #ifdef FIXED_POINT
116
117 typedef opus_int16 opus_val16;
118 typedef opus_int32 opus_val32;
119 typedef opus_int64 opus_val64;
120
121 typedef opus_val32 celt_sig;
122 typedef opus_val16 celt_norm;
123 typedef opus_val32 celt_ener;
124
125 #define Q15ONE 32767
126
127 #define SIG_SHIFT 12
128 /* Safe saturation value for 32-bit signals. Should be less than
129    2^31*(1-0.85) to avoid blowing up on DC at deemphasis.*/
130 #define SIG_SAT (300000000)
131
132 #define NORM_SCALING 16384
133
134 #define DB_SHIFT 10
135
136 #define EPSILON 1
137 #define VERY_SMALL 0
138 #define VERY_LARGE16 ((opus_val16)32767)
139 #define Q15_ONE ((opus_val16)32767)
140
141 #define SCALEIN(a)      (a)
142 #define SCALEOUT(a)     (a)
143
144 #define ABS16(x) ((x) < 0 ? (-(x)) : (x))
145 #define ABS32(x) ((x) < 0 ? (-(x)) : (x))
146
147 static OPUS_INLINE opus_int16 SAT16(opus_int32 x) {
148    return x > 32767 ? 32767 : x < -32768 ? -32768 : (opus_int16)x;
149 }
150
151 #ifdef FIXED_DEBUG
152 #include "fixed_debug.h"
153 #else
154
155 #include "fixed_generic.h"
156
157 #ifdef OPUS_ARM_PRESUME_AARCH64_NEON_INTR
158 #include "arm/fixed_arm64.h"
159 #elif OPUS_ARM_INLINE_EDSP
160 #include "arm/fixed_armv5e.h"
161 #elif defined (OPUS_ARM_INLINE_ASM)
162 #include "arm/fixed_armv4.h"
163 #elif defined (BFIN_ASM)
164 #include "fixed_bfin.h"
165 #elif defined (TI_C5X_ASM)
166 #include "fixed_c5x.h"
167 #elif defined (TI_C6X_ASM)
168 #include "fixed_c6x.h"
169 #endif
170
171 #endif
172
173 #else /* FIXED_POINT */
174
175 typedef float opus_val16;
176 typedef float opus_val32;
177 typedef float opus_val64;
178
179 typedef float celt_sig;
180 typedef float celt_norm;
181 typedef float celt_ener;
182
183 #ifdef FLOAT_APPROX
184 /* This code should reliably detect NaN/inf even when -ffast-math is used.
185    Assumes IEEE 754 format. */
186 static OPUS_INLINE int celt_isnan(float x)
187 {
188    union {float f; opus_uint32 i;} in;
189    in.f = x;
190    return ((in.i>>23)&0xFF)==0xFF && (in.i&0x007FFFFF)!=0;
191 }
192 #else
193 #ifdef __FAST_MATH__
194 #error Cannot build libopus with -ffast-math unless FLOAT_APPROX is defined. This could result in crashes on extreme (e.g. NaN) input
195 #endif
196 #define celt_isnan(x) ((x)!=(x))
197 #endif
198
199 #define Q15ONE 1.0f
200
201 #define NORM_SCALING 1.f
202
203 #define EPSILON 1e-15f
204 #define VERY_SMALL 1e-30f
205 #define VERY_LARGE16 1e15f
206 #define Q15_ONE ((opus_val16)1.f)
207
208 /* This appears to be the same speed as C99's fabsf() but it's more portable. */
209 #define ABS16(x) ((float)fabs(x))
210 #define ABS32(x) ((float)fabs(x))
211
212 #define QCONST16(x,bits) (x)
213 #define QCONST32(x,bits) (x)
214
215 #define NEG16(x) (-(x))
216 #define NEG32(x) (-(x))
217 #define NEG32_ovflw(x) (-(x))
218 #define EXTRACT16(x) (x)
219 #define EXTEND32(x) (x)
220 #define SHR16(a,shift) (a)
221 #define SHL16(a,shift) (a)
222 #define SHR32(a,shift) (a)
223 #define SHL32(a,shift) (a)
224 #define PSHR32(a,shift) (a)
225 #define VSHR32(a,shift) (a)
226
227 #define PSHR(a,shift)   (a)
228 #define SHR(a,shift)    (a)
229 #define SHL(a,shift)    (a)
230 #define SATURATE(x,a)   (x)
231 #define SATURATE16(x)   (x)
232
233 #define ROUND16(a,shift)  (a)
234 #define SROUND16(a,shift) (a)
235 #define HALF16(x)       (.5f*(x))
236 #define HALF32(x)       (.5f*(x))
237
238 #define ADD16(a,b) ((a)+(b))
239 #define SUB16(a,b) ((a)-(b))
240 #define ADD32(a,b) ((a)+(b))
241 #define SUB32(a,b) ((a)-(b))
242 #define ADD32_ovflw(a,b) ((a)+(b))
243 #define SUB32_ovflw(a,b) ((a)-(b))
244 #define MULT16_16_16(a,b)     ((a)*(b))
245 #define MULT16_16(a,b)     ((opus_val32)(a)*(opus_val32)(b))
246 #define MAC16_16(c,a,b)     ((c)+(opus_val32)(a)*(opus_val32)(b))
247
248 #define MULT16_32_Q15(a,b)     ((a)*(b))
249 #define MULT16_32_Q16(a,b)     ((a)*(b))
250
251 #define MULT32_32_Q31(a,b)     ((a)*(b))
252
253 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
254 #define MAC16_32_Q16(c,a,b)     ((c)+(a)*(b))
255
256 #define MULT16_16_Q11_32(a,b)     ((a)*(b))
257 #define MULT16_16_Q11(a,b)     ((a)*(b))
258 #define MULT16_16_Q13(a,b)     ((a)*(b))
259 #define MULT16_16_Q14(a,b)     ((a)*(b))
260 #define MULT16_16_Q15(a,b)     ((a)*(b))
261 #define MULT16_16_P15(a,b)     ((a)*(b))
262 #define MULT16_16_P13(a,b)     ((a)*(b))
263 #define MULT16_16_P14(a,b)     ((a)*(b))
264 #define MULT16_32_P16(a,b)     ((a)*(b))
265
266 #define DIV32_16(a,b)     (((opus_val32)(a))/(opus_val16)(b))
267 #define DIV32(a,b)     (((opus_val32)(a))/(opus_val32)(b))
268
269 #define SCALEIN(a)      ((a)*CELT_SIG_SCALE)
270 #define SCALEOUT(a)     ((a)*(1/CELT_SIG_SCALE))
271
272 #define SIG2WORD16(x) (x)
273
274 #endif /* !FIXED_POINT */
275
276 #ifndef GLOBAL_STACK_SIZE
277 #ifdef FIXED_POINT
278 #define GLOBAL_STACK_SIZE 120000
279 #else
280 #define GLOBAL_STACK_SIZE 120000
281 #endif
282 #endif
283
284 #endif /* ARCH_H */