src/aubio_priv.h: add aliases for cblas_xswap
[aubio.git] / src / aubio_priv.h
1 /*
2   Copyright (C) 2003-2015 Paul Brossier <piem@aubio.org>
3
4   This file is part of aubio.
5
6   aubio is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   aubio is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 /** @file
22  * Private include file
23  *
24  * This file is for inclusion from _within_ the library only.
25  */
26
27 #ifndef _AUBIO__PRIV_H
28 #define _AUBIO__PRIV_H
29
30 /*********************
31  *
32  * External includes
33  *
34  */
35
36 #include "config.h"
37
38 #if HAVE_STDLIB_H
39 #include <stdlib.h>
40 #endif
41
42 #if HAVE_STDIO_H
43 #include <stdio.h>
44 #endif
45
46 /* must be included before fftw3.h */
47 #ifdef HAVE_COMPLEX_H
48 #include <complex.h>
49 #endif
50
51 #if defined(HAVE_FFTW3) || defined(HAVE_FFTW3F)
52 #include <fftw3.h>
53 #endif
54
55 #ifdef HAVE_MATH_H
56 #include <math.h>
57 #endif
58
59 #ifdef HAVE_STRING_H
60 #include <string.h>
61 #endif
62
63 #ifdef HAVE_LIMITS_H
64 #include <limits.h> // for CHAR_BIT, in C99 standard
65 #endif
66
67 #ifdef HAVE_ACCELERATE
68 #define HAVE_ATLAS 1
69 #include <Accelerate/Accelerate.h>
70 #elif HAVE_ATLAS_CBLAS_H
71 #define HAVE_ATLAS 1
72 #include <atlas/cblas.h>
73 #else
74 #undef HAVE_ATLAS
75 #endif
76
77 #ifdef HAVE_ACCELERATE
78 #include <Accelerate/Accelerate.h>
79 #if !HAVE_AUBIO_DOUBLE
80 #define aubio_vDSP_mmov       vDSP_mmov
81 #define aubio_vDSP_vmul       vDSP_vmul
82 #define aubio_vDSP_vfill      vDSP_vfill
83 #define aubio_vDSP_meanv      vDSP_meanv
84 #define aubio_vDSP_sve        vDSP_sve
85 #define aubio_vDSP_maxv       vDSP_maxv
86 #define aubio_vDSP_maxvi      vDSP_maxvi
87 #define aubio_vDSP_minv       vDSP_minv
88 #define aubio_vDSP_minvi      vDSP_minvi
89 #else /* HAVE_AUBIO_DOUBLE */
90 #define aubio_vDSP_mmov       vDSP_mmovD
91 #define aubio_vDSP_vmul       vDSP_vmulD
92 #define aubio_vDSP_vfill      vDSP_vfillD
93 #define aubio_vDSP_meanv      vDSP_meanvD
94 #define aubio_vDSP_sve        vDSP_sveD
95 #define aubio_vDSP_maxv       vDSP_maxvD
96 #define aubio_vDSP_maxvi      vDSP_maxviD
97 #define aubio_vDSP_minv       vDSP_minvD
98 #define aubio_vDSP_minvi      vDSP_minviD
99 #endif /* HAVE_AUBIO_DOUBLE */
100 #endif /* HAVE_ACCELERATE */
101
102 #ifdef HAVE_ATLAS
103 #if !HAVE_AUBIO_DOUBLE
104 #define aubio_catlas_set      catlas_sset
105 #define aubio_cblas_copy      cblas_scopy
106 #define aubio_cblas_swap      cblas_sswap
107 #define aubio_cblas_dot       cblas_sdot
108 #else /* HAVE_AUBIO_DOUBLE */
109 #define aubio_catlas_set      catlas_dset
110 #define aubio_cblas_copy      cblas_dcopy
111 #define aubio_cblas_swap      cblas_dswap
112 #define aubio_cblas_dot       cblas_ddot
113 #endif /* HAVE_AUBIO_DOUBLE */
114 #endif /* HAVE_ATLAS */
115
116 #if !defined(HAVE_MEMCPY_HACKS) && !defined(HAVE_ACCELERATE) && !defined(HAVE_ATLAS)
117 #define HAVE_NOOPT 1
118 #else
119 #undef HAVE_NOOPT
120 #endif
121
122 #include "types.h"
123
124 #define AUBIO_UNSTABLE 1
125
126 #include "mathutils.h"
127
128 /****
129  *
130  * SYSTEM INTERFACE
131  *
132  */
133
134 /* Memory management */
135 #define AUBIO_MALLOC(_n)             malloc(_n)
136 #define AUBIO_REALLOC(_p,_n)         realloc(_p,_n)
137 #define AUBIO_NEW(_t)                (_t*)calloc(sizeof(_t), 1)
138 #define AUBIO_ARRAY(_t,_n)           (_t*)calloc((_n)*sizeof(_t), 1)
139 #define AUBIO_MEMCPY(_dst,_src,_n)   memcpy(_dst,_src,_n)
140 #define AUBIO_MEMSET(_dst,_src,_t)   memset(_dst,_src,_t)
141 #define AUBIO_FREE(_p)               free(_p)
142
143
144 /* file interface */
145 #define AUBIO_FOPEN(_f,_m)           fopen(_f,_m)
146 #define AUBIO_FCLOSE(_f)             fclose(_f)
147 #define AUBIO_FREAD(_p,_s,_n,_f)     fread(_p,_s,_n,_f)
148 #define AUBIO_FSEEK(_f,_n,_set)      fseek(_f,_n,_set)
149
150 /* strings */
151 #define AUBIO_STRLEN(_s)             strlen(_s)
152 #define AUBIO_STRCMP(_s,_t)          strcmp(_s,_t)
153 #define AUBIO_STRNCMP(_s,_t,_n)      strncmp(_s,_t,_n)
154 #define AUBIO_STRCPY(_dst,_src)      strcpy(_dst,_src)
155 #define AUBIO_STRCHR(_s,_c)          strchr(_s,_c)
156 #ifdef strdup
157 #define AUBIO_STRDUP(s)              strdup(s)
158 #else
159 #define AUBIO_STRDUP(s)              AUBIO_STRCPY(AUBIO_MALLOC(AUBIO_STRLEN(s) + 1), s)
160 #endif
161
162
163 /* Error reporting */
164 typedef enum {
165   AUBIO_OK = 0,
166   AUBIO_FAIL = 1
167 } aubio_status;
168
169 #ifdef HAVE_C99_VARARGS_MACROS
170 #define AUBIO_ERR(...)               fprintf(stderr, "AUBIO ERROR: " __VA_ARGS__)
171 #define AUBIO_MSG(...)               fprintf(stdout, __VA_ARGS__)
172 #define AUBIO_DBG(...)               fprintf(stderr, __VA_ARGS__)
173 #define AUBIO_WRN(...)               fprintf(stderr, "AUBIO WARNING: " __VA_ARGS__)
174 #else
175 #define AUBIO_ERR(format, args...)   fprintf(stderr, "AUBIO ERROR: " format , ##args)
176 #define AUBIO_MSG(format, args...)   fprintf(stdout, format , ##args)
177 #define AUBIO_DBG(format, args...)   fprintf(stderr, format , ##args)
178 #define AUBIO_WRN(format, args...)   fprintf(stderr, "AUBIO WARNING: " format, ##args)
179 #endif
180
181 #define AUBIO_ERROR   AUBIO_ERR
182
183 #define AUBIO_QUIT(_s)               exit(_s)
184 #define AUBIO_SPRINTF                sprintf
185
186 /* pi and 2*pi */
187 #ifndef M_PI
188 #define PI         (3.14159265358979323846)
189 #else
190 #define PI         (M_PI)
191 #endif
192 #define TWO_PI     (PI*2.)
193
194 /* aliases to math.h functions */
195 #if !HAVE_AUBIO_DOUBLE
196 #define EXP        expf
197 #define COS        cosf
198 #define SIN        sinf
199 #define ABS        fabsf
200 #define POW        powf
201 #define SQRT       sqrtf
202 #define LOG10      log10f
203 #define LOG        logf
204 #define FLOOR      floorf
205 #define CEIL       ceilf
206 #define ATAN2      atan2f
207 #else
208 #define EXP        exp
209 #define COS        cos
210 #define SIN        sin
211 #define ABS        fabs
212 #define POW        pow
213 #define SQRT       sqrt
214 #define LOG10      log10
215 #define LOG        log
216 #define FLOOR      floor
217 #define CEIL       ceil
218 #define ATAN2      atan2
219 #endif
220 #define ROUND(x)   FLOOR(x+.5)
221
222 /* aliases to complex.h functions */
223 #if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
224 /* mingw32 does not know about c*f functions */
225 #define EXPC      cexp
226 /** complex = CEXPC(complex) */
227 #define CEXPC     cexp
228 /** sample = ARGC(complex) */
229 #define ARGC      carg
230 /** sample = ABSC(complex) norm */
231 #define ABSC      cabs
232 /** sample = REAL(complex) */
233 #define REAL      creal
234 /** sample = IMAG(complex) */
235 #define IMAG      cimag
236 #else
237 /** sample = EXPC(complex) */
238 #define EXPC      cexpf
239 /** complex = CEXPC(complex) */
240 #define CEXPC     cexp
241 /** sample = ARGC(complex) */
242 #define ARGC      cargf
243 /** sample = ABSC(complex) norm */
244 #define ABSC      cabsf
245 /** sample = REAL(complex) */
246 #define REAL      crealf
247 /** sample = IMAG(complex) */
248 #define IMAG      cimagf
249 #endif
250
251 /* handy shortcuts */
252 #define DB2LIN(g) (POW(10.0,(g)*0.05f))
253 #define LIN2DB(v) (20.0*LOG10(v))
254 #define SQR(_a)   ((_a)*(_a))
255
256 #ifndef MAX
257 #define MAX(a,b)  (((a)>(b))?(a):(b))
258 #endif /* MAX */
259 #ifndef MIN
260 #define MIN(a,b)  (((a)<(b))?(a):(b))
261 #endif /* MIN */
262
263 #define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
264
265 #define VERY_SMALL_NUMBER 2.e-42 //1.e-37
266
267 /** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
268 #define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
269
270 /** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
271 #define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
272
273 /** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
274 #define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
275
276 #define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
277 #define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
278
279 /** silence unused parameter warning by adding an attribute */
280 #if defined(__GNUC__)
281 #define UNUSED __attribute__((unused))
282 #else
283 #define UNUSED
284 #endif
285
286 #endif /* _AUBIO__PRIV_H */