API doc improvements
[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 FOUNDATION OR
25    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
39 # if !defined(__GNUC_PREREQ)
40 #  if defined(__GNUC__)&&defined(__GNUC_MINOR__)
41 #   define __GNUC_PREREQ(_maj,_min) \
42  ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
43 #  else
44 #   define __GNUC_PREREQ(_maj,_min) 0
45 #  endif
46 # endif
47
48 #define CELT_SIG_SCALE 32768.f
49
50 #define celt_fatal(str) _celt_fatal(str, __FILE__, __LINE__);
51 #ifdef ENABLE_ASSERTIONS
52 #include <stdio.h>
53 #include <stdlib.h>
54 static inline void _celt_fatal(const char *str, const char *file, int line)
55 {
56    fprintf (stderr, "Fatal (internal) error in %s, line %d: %s\n", file, line, str);
57    abort();
58 }
59 #define celt_assert(cond) {if (!(cond)) {celt_fatal("assertion failed: " #cond);}}
60 #define celt_assert2(cond, message) {if (!(cond)) {celt_fatal("assertion failed: " #cond "\n" message);}}
61 #else
62 #define celt_assert(cond)
63 #define celt_assert2(cond, message)
64 #endif
65
66 #define IMUL32(a,b) ((a)*(b))
67
68 #define ABS(x) ((x) < 0 ? (-(x)) : (x))      /**< Absolute integer value. */
69 #define ABS16(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 16-bit value.  */
70 #define MIN16(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 16-bit value.   */
71 #define MAX16(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 16-bit value.   */
72 #define ABS32(x) ((x) < 0 ? (-(x)) : (x))    /**< Absolute 32-bit value.  */
73 #define MIN32(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum 32-bit value.   */
74 #define MAX32(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum 32-bit value.   */
75 #define IMIN(a,b) ((a) < (b) ? (a) : (b))   /**< Minimum int value.   */
76 #define IMAX(a,b) ((a) > (b) ? (a) : (b))   /**< Maximum int value.   */
77 #define UADD32(a,b) ((a)+(b))
78 #define USUB32(a,b) ((a)-(b))
79
80 #define PRINT_MIPS(file)
81
82 #ifdef FIXED_POINT
83
84 typedef opus_int16 opus_val16;
85 typedef opus_int32 opus_val32;
86
87 typedef opus_val32 celt_sig;
88 typedef opus_val16 celt_norm;
89 typedef opus_val32 celt_ener;
90
91 #define Q15ONE 32767
92
93 #define SIG_SHIFT 12
94
95 #define NORM_SCALING 16384
96
97 #define DB_SHIFT 10
98
99 #define EPSILON 1
100 #define VERY_LARGE16 ((opus_val16)32767)
101 #define Q15_ONE ((opus_val16)32767)
102
103 #define SCALEIN(a)      (a)
104 #define SCALEOUT(a)     (a)
105
106 #ifdef FIXED_DEBUG
107 #include "fixed_debug.h"
108 #else
109
110 #include "fixed_generic.h"
111
112 #ifdef ARM5E_ASM
113 #include "fixed_arm5e.h"
114 #elif defined (ARM4_ASM)
115 #include "fixed_arm4.h"
116 #elif defined (BFIN_ASM)
117 #include "fixed_bfin.h"
118 #elif defined (TI_C5X_ASM)
119 #include "fixed_c5x.h"
120 #elif defined (TI_C6X_ASM)
121 #include "fixed_c6x.h"
122 #endif
123
124 #endif
125
126 #else /* FIXED_POINT */
127
128 typedef float opus_val16;
129 typedef float opus_val32;
130
131 typedef float celt_sig;
132 typedef float celt_norm;
133 typedef float celt_ener;
134
135 #define Q15ONE 1.0f
136
137 #define NORM_SCALING 1.f
138
139 #define EPSILON 1e-15f
140 #define VERY_LARGE16 1e15f
141 #define Q15_ONE ((opus_val16)1.f)
142
143 #define QCONST16(x,bits) (x)
144 #define QCONST32(x,bits) (x)
145
146 #define NEG16(x) (-(x))
147 #define NEG32(x) (-(x))
148 #define EXTRACT16(x) (x)
149 #define EXTEND32(x) (x)
150 #define SHR16(a,shift) (a)
151 #define SHL16(a,shift) (a)
152 #define SHR32(a,shift) (a)
153 #define SHL32(a,shift) (a)
154 #define PSHR32(a,shift) (a)
155 #define VSHR32(a,shift) (a)
156
157 #define PSHR(a,shift)   (a)
158 #define SHR(a,shift)    (a)
159 #define SHL(a,shift)    (a)
160 #define SATURATE(x,a)   (x)
161
162 #define ROUND16(a,shift)  (a)
163 #define HALF16(x)       (.5f*(x))
164 #define HALF32(x)       (.5f*(x))
165
166 #define ADD16(a,b) ((a)+(b))
167 #define SUB16(a,b) ((a)-(b))
168 #define ADD32(a,b) ((a)+(b))
169 #define SUB32(a,b) ((a)-(b))
170 #define MULT16_16_16(a,b)     ((a)*(b))
171 #define MULT16_16(a,b)     ((opus_val32)(a)*(opus_val32)(b))
172 #define MAC16_16(c,a,b)     ((c)+(opus_val32)(a)*(opus_val32)(b))
173
174 #define MULT16_32_Q15(a,b)     ((a)*(b))
175 #define MULT16_32_Q16(a,b)     ((a)*(b))
176
177 #define MULT32_32_Q31(a,b)     ((a)*(b))
178
179 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
180
181 #define MULT16_16_Q11_32(a,b)     ((a)*(b))
182 #define MULT16_16_Q13(a,b)     ((a)*(b))
183 #define MULT16_16_Q14(a,b)     ((a)*(b))
184 #define MULT16_16_Q15(a,b)     ((a)*(b))
185 #define MULT16_16_P15(a,b)     ((a)*(b))
186 #define MULT16_16_P13(a,b)     ((a)*(b))
187 #define MULT16_16_P14(a,b)     ((a)*(b))
188
189 #define DIV32_16(a,b)     (((opus_val32)(a))/(opus_val16)(b))
190 #define DIV32(a,b)     (((opus_val32)(a))/(opus_val32)(b))
191
192 #define SCALEIN(a)      ((a)*CELT_SIG_SCALE)
193 #define SCALEOUT(a)     ((a)*(1/CELT_SIG_SCALE))
194
195 #endif /* !FIXED_POINT */
196
197 #ifndef GLOBAL_STACK_SIZE
198 #ifdef FIXED_POINT
199 #define GLOBAL_STACK_SIZE 100000
200 #else
201 #define GLOBAL_STACK_SIZE 100000
202 #endif
203 #endif
204
205 #endif /* ARCH_H */