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