Adds 3rd clause to CELT license
[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    - Neither the name of Internet Society, IETF or IETF Trust, nor the
22    names of specific contributors, may be used to endorse or promote
23    products derived from this software without specific prior written
24    permission.
25
26    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
30    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 #ifndef ARCH_H
40 #define ARCH_H
41
42 #include "opus_types.h"
43
44 # if !defined(__GNUC_PREREQ)
45 #  if defined(__GNUC__)&&defined(__GNUC_MINOR__)
46 #   define __GNUC_PREREQ(_maj,_min) \
47  ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
48 #  else
49 #   define __GNUC_PREREQ(_maj,_min) 0
50 #  endif
51 # endif
52
53 #define CELT_SIG_SCALE 32768.f
54
55 #define celt_fatal(str) _celt_fatal(str, __FILE__, __LINE__);
56 #ifdef ENABLE_ASSERTIONS
57 #include <stdio.h>
58 #include <stdlib.h>
59 #ifdef __GNUC__
60 __attribute__((noreturn))
61 #endif
62 static inline void _celt_fatal(const char *str, const char *file, int line)
63 {
64    fprintf (stderr, "Fatal (internal) error in %s, line %d: %s\n", file, line, str);
65    abort();
66 }
67 #define celt_assert(cond) {if (!(cond)) {celt_fatal("assertion failed: " #cond);}}
68 #define celt_assert2(cond, message) {if (!(cond)) {celt_fatal("assertion failed: " #cond "\n" message);}}
69 #else
70 #define celt_assert(cond)
71 #define celt_assert2(cond, message)
72 #endif
73
74 #define IMUL32(a,b) ((a)*(b))
75
76 #define ABS(x) ((x) < 0 ? (-(x)) : (x))      /**< Absolute integer value. */
77 #define ABS16(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 16-bit value.  */
78 #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 16-bit value.   */
79 #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
80 #define ABS32(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 32-bit value.  */
81 #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 32-bit value.   */
82 #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
83 #define IMIN(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum int value.   */
84 #define IMAX(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum int value.   */
85 #define UADD32(a,b) ((a)+(b))
86 #define USUB32(a,b) ((a)-(b))
87
88 #define PRINT_MIPS(file)
89
90 #ifdef FIXED_POINT
91
92 typedef opus_int16 opus_val16;
93 typedef opus_int32 opus_val32;
94
95 typedef opus_val32 celt_sig;
96 typedef opus_val16 celt_norm;
97 typedef opus_val32 celt_ener;
98
99 #define Q15ONE 32767
100
101 #define SIG_SHIFT 12
102
103 #define NORM_SCALING 16384
104
105 #define DB_SHIFT 10
106
107 #define EPSILON 1
108 #define VERY_LARGE16 ((opus_val16)32767)
109 #define Q15_ONE ((opus_val16)32767)
110
111 #define SCALEIN(a)      (a)
112 #define SCALEOUT(a)     (a)
113
114 #ifdef FIXED_DEBUG
115 #include "fixed_debug.h"
116 #else
117
118 #include "fixed_generic.h"
119
120 #ifdef ARM5E_ASM
121 #include "fixed_arm5e.h"
122 #elif defined (ARM4_ASM)
123 #include "fixed_arm4.h"
124 #elif defined (BFIN_ASM)
125 #include "fixed_bfin.h"
126 #elif defined (TI_C5X_ASM)
127 #include "fixed_c5x.h"
128 #elif defined (TI_C6X_ASM)
129 #include "fixed_c6x.h"
130 #endif
131
132 #endif
133
134 #else /* FIXED_POINT */
135
136 typedef float opus_val16;
137 typedef float opus_val32;
138
139 typedef float celt_sig;
140 typedef float celt_norm;
141 typedef float celt_ener;
142
143 #define Q15ONE 1.0f
144
145 #define NORM_SCALING 1.f
146
147 #define EPSILON 1e-15f
148 #define VERY_LARGE16 1e15f
149 #define Q15_ONE ((opus_val16)1.f)
150
151 #define QCONST16(x,bits) (x)
152 #define QCONST32(x,bits) (x)
153
154 #define NEG16(x) (-(x))
155 #define NEG32(x) (-(x))
156 #define EXTRACT16(x) (x)
157 #define EXTEND32(x) (x)
158 #define SHR16(a,shift) (a)
159 #define SHL16(a,shift) (a)
160 #define SHR32(a,shift) (a)
161 #define SHL32(a,shift) (a)
162 #define PSHR32(a,shift) (a)
163 #define VSHR32(a,shift) (a)
164
165 #define PSHR(a,shift)   (a)
166 #define SHR(a,shift)    (a)
167 #define SHL(a,shift)    (a)
168 #define SATURATE(x,a)   (x)
169
170 #define ROUND16(a,shift)  (a)
171 #define HALF16(x)       (.5f*(x))
172 #define HALF32(x)       (.5f*(x))
173
174 #define ADD16(a,b) ((a)+(b))
175 #define SUB16(a,b) ((a)-(b))
176 #define ADD32(a,b) ((a)+(b))
177 #define SUB32(a,b) ((a)-(b))
178 #define MULT16_16_16(a,b)     ((a)*(b))
179 #define MULT16_16(a,b)     ((opus_val32)(a)*(opus_val32)(b))
180 #define MAC16_16(c,a,b)     ((c)+(opus_val32)(a)*(opus_val32)(b))
181
182 #define MULT16_32_Q15(a,b)     ((a)*(b))
183 #define MULT16_32_Q16(a,b)     ((a)*(b))
184
185 #define MULT32_32_Q31(a,b)     ((a)*(b))
186
187 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
188
189 #define MULT16_16_Q11_32(a,b)     ((a)*(b))
190 #define MULT16_16_Q13(a,b)     ((a)*(b))
191 #define MULT16_16_Q14(a,b)     ((a)*(b))
192 #define MULT16_16_Q15(a,b)     ((a)*(b))
193 #define MULT16_16_P15(a,b)     ((a)*(b))
194 #define MULT16_16_P13(a,b)     ((a)*(b))
195 #define MULT16_16_P14(a,b)     ((a)*(b))
196
197 #define DIV32_16(a,b)     (((opus_val32)(a))/(opus_val16)(b))
198 #define DIV32(a,b)     (((opus_val32)(a))/(opus_val32)(b))
199
200 #define SCALEIN(a)      ((a)*CELT_SIG_SCALE)
201 #define SCALEOUT(a)     ((a)*(1/CELT_SIG_SCALE))
202
203 #endif /* !FIXED_POINT */
204
205 #ifndef GLOBAL_STACK_SIZE
206 #ifdef FIXED_POINT
207 #define GLOBAL_STACK_SIZE 100000
208 #else
209 #define GLOBAL_STACK_SIZE 100000
210 #endif
211 #endif
212
213 #endif /* ARCH_H */