src/aubio_priv.h: define PATH_MAX if needed
[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 defined(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 #define aubio_vDSP_dotpr      vDSP_dotpr
90 #else /* HAVE_AUBIO_DOUBLE */
91 #define aubio_vDSP_mmov       vDSP_mmovD
92 #define aubio_vDSP_vmul       vDSP_vmulD
93 #define aubio_vDSP_vfill      vDSP_vfillD
94 #define aubio_vDSP_meanv      vDSP_meanvD
95 #define aubio_vDSP_sve        vDSP_sveD
96 #define aubio_vDSP_maxv       vDSP_maxvD
97 #define aubio_vDSP_maxvi      vDSP_maxviD
98 #define aubio_vDSP_minv       vDSP_minvD
99 #define aubio_vDSP_minvi      vDSP_minviD
100 #define aubio_vDSP_dotpr      vDSP_dotprD
101 #endif /* HAVE_AUBIO_DOUBLE */
102 #endif /* HAVE_ACCELERATE */
103
104 #ifdef HAVE_ATLAS
105 #if !HAVE_AUBIO_DOUBLE
106 #define aubio_catlas_set      catlas_sset
107 #define aubio_cblas_copy      cblas_scopy
108 #define aubio_cblas_swap      cblas_sswap
109 #define aubio_cblas_dot       cblas_sdot
110 #else /* HAVE_AUBIO_DOUBLE */
111 #define aubio_catlas_set      catlas_dset
112 #define aubio_cblas_copy      cblas_dcopy
113 #define aubio_cblas_swap      cblas_dswap
114 #define aubio_cblas_dot       cblas_ddot
115 #endif /* HAVE_AUBIO_DOUBLE */
116 #endif /* HAVE_ATLAS */
117
118 #if !defined(HAVE_MEMCPY_HACKS) && !defined(HAVE_ACCELERATE) && !defined(HAVE_ATLAS)
119 #define HAVE_NOOPT 1
120 #else
121 #undef HAVE_NOOPT
122 #endif
123
124 #include "types.h"
125
126 #define AUBIO_UNSTABLE 1
127
128 #include "mathutils.h"
129
130 /****
131  *
132  * SYSTEM INTERFACE
133  *
134  */
135
136 /* Memory management */
137 #define AUBIO_MALLOC(_n)             malloc(_n)
138 #define AUBIO_REALLOC(_p,_n)         realloc(_p,_n)
139 #define AUBIO_NEW(_t)                (_t*)calloc(sizeof(_t), 1)
140 #define AUBIO_ARRAY(_t,_n)           (_t*)calloc((_n)*sizeof(_t), 1)
141 #define AUBIO_MEMCPY(_dst,_src,_n)   memcpy(_dst,_src,_n)
142 #define AUBIO_MEMSET(_dst,_src,_t)   memset(_dst,_src,_t)
143 #define AUBIO_FREE(_p)               free(_p)
144
145
146 /* file interface */
147 #define AUBIO_FOPEN(_f,_m)           fopen(_f,_m)
148 #define AUBIO_FCLOSE(_f)             fclose(_f)
149 #define AUBIO_FREAD(_p,_s,_n,_f)     fread(_p,_s,_n,_f)
150 #define AUBIO_FSEEK(_f,_n,_set)      fseek(_f,_n,_set)
151
152 /* strings */
153 #define AUBIO_STRLEN(_s)             strlen(_s)
154 #define AUBIO_STRCMP(_s,_t)          strcmp(_s,_t)
155 #define AUBIO_STRNCMP(_s,_t,_n)      strncmp(_s,_t,_n)
156 #define AUBIO_STRCPY(_dst,_src)      strcpy(_dst,_src)
157 #define AUBIO_STRCHR(_s,_c)          strchr(_s,_c)
158 #ifdef strdup
159 #define AUBIO_STRDUP(s)              strdup(s)
160 #else
161 #define AUBIO_STRDUP(s)              AUBIO_STRCPY(AUBIO_MALLOC(AUBIO_STRLEN(s) + 1), s)
162 #endif
163
164
165 /* Error reporting */
166 typedef enum {
167   AUBIO_OK = 0,
168   AUBIO_FAIL = 1
169 } aubio_status;
170
171 #ifdef HAVE_C99_VARARGS_MACROS
172 #define AUBIO_ERR(...)               fprintf(stderr, "AUBIO ERROR: " __VA_ARGS__)
173 #define AUBIO_MSG(...)               fprintf(stdout, __VA_ARGS__)
174 #define AUBIO_DBG(...)               fprintf(stderr, __VA_ARGS__)
175 #define AUBIO_WRN(...)               fprintf(stderr, "AUBIO WARNING: " __VA_ARGS__)
176 #else
177 #define AUBIO_ERR(format, args...)   fprintf(stderr, "AUBIO ERROR: " format , ##args)
178 #define AUBIO_MSG(format, args...)   fprintf(stdout, format , ##args)
179 #define AUBIO_DBG(format, args...)   fprintf(stderr, format , ##args)
180 #define AUBIO_WRN(format, args...)   fprintf(stderr, "AUBIO WARNING: " format, ##args)
181 #endif
182
183 #define AUBIO_ERROR   AUBIO_ERR
184
185 #define AUBIO_QUIT(_s)               exit(_s)
186 #define AUBIO_SPRINTF                sprintf
187
188 /* pi and 2*pi */
189 #ifndef M_PI
190 #define PI         (3.14159265358979323846)
191 #else
192 #define PI         (M_PI)
193 #endif
194 #define TWO_PI     (PI*2.)
195
196 #ifndef PATH_MAX
197 #define PATH_MAX 1024
198 #endif
199
200 /* aliases to math.h functions */
201 #if !HAVE_AUBIO_DOUBLE
202 #define EXP        expf
203 #define COS        cosf
204 #define SIN        sinf
205 #define ABS        fabsf
206 #define POW        powf
207 #define SQRT       sqrtf
208 #define LOG10      log10f
209 #define LOG        logf
210 #define FLOOR      floorf
211 #define CEIL       ceilf
212 #define ATAN2      atan2f
213 #else
214 #define EXP        exp
215 #define COS        cos
216 #define SIN        sin
217 #define ABS        fabs
218 #define POW        pow
219 #define SQRT       sqrt
220 #define LOG10      log10
221 #define LOG        log
222 #define FLOOR      floor
223 #define CEIL       ceil
224 #define ATAN2      atan2
225 #endif
226 #define ROUND(x)   FLOOR(x+.5)
227
228 /* aliases to complex.h functions */
229 #if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
230 /* mingw32 does not know about c*f functions */
231 #define EXPC      cexp
232 /** complex = CEXPC(complex) */
233 #define CEXPC     cexp
234 /** sample = ARGC(complex) */
235 #define ARGC      carg
236 /** sample = ABSC(complex) norm */
237 #define ABSC      cabs
238 /** sample = REAL(complex) */
239 #define REAL      creal
240 /** sample = IMAG(complex) */
241 #define IMAG      cimag
242 #else
243 /** sample = EXPC(complex) */
244 #define EXPC      cexpf
245 /** complex = CEXPC(complex) */
246 #define CEXPC     cexp
247 /** sample = ARGC(complex) */
248 #define ARGC      cargf
249 /** sample = ABSC(complex) norm */
250 #define ABSC      cabsf
251 /** sample = REAL(complex) */
252 #define REAL      crealf
253 /** sample = IMAG(complex) */
254 #define IMAG      cimagf
255 #endif
256
257 /* handy shortcuts */
258 #define DB2LIN(g) (POW(10.0,(g)*0.05f))
259 #define LIN2DB(v) (20.0*LOG10(v))
260 #define SQR(_a)   ((_a)*(_a))
261
262 #ifndef MAX
263 #define MAX(a,b)  (((a)>(b))?(a):(b))
264 #endif /* MAX */
265 #ifndef MIN
266 #define MIN(a,b)  (((a)<(b))?(a):(b))
267 #endif /* MIN */
268
269 #define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
270
271 #define VERY_SMALL_NUMBER 2.e-42 //1.e-37
272
273 /** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
274 #define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
275
276 /** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
277 #define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
278
279 /** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
280 #define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
281
282 #define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
283 #define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
284
285 /** silence unused parameter warning by adding an attribute */
286 #if defined(__GNUC__)
287 #define UNUSED __attribute__((unused))
288 #else
289 #define UNUSED
290 #endif
291
292 #endif /* AUBIO_PRIV_H */