[lib] add AUBIO_STRERR to log system error messages
[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 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #ifdef HAVE_STDLIB_H
41 #include <stdlib.h>
42 #endif
43
44 #ifdef HAVE_STDIO_H
45 #include <stdio.h>
46 #endif
47
48 /* must be included before fftw3.h */
49 #ifdef HAVE_COMPLEX_H
50 #include <complex.h>
51 #endif
52
53 #if defined(HAVE_FFTW3) || defined(HAVE_FFTW3F)
54 #include <fftw3.h>
55 #endif
56
57 #ifdef HAVE_MATH_H
58 #include <math.h>
59 #endif
60
61 #ifdef HAVE_STRING_H
62 #include <string.h>
63 #endif
64
65 #ifdef HAVE_ERRNO_H
66 #include <errno.h>
67 #endif
68
69 #ifdef HAVE_LIMITS_H
70 #include <limits.h> // for CHAR_BIT, in C99 standard
71 #endif
72
73 #ifdef HAVE_STDARG_H
74 #include <stdarg.h>
75 #endif
76
77 #if defined(HAVE_ACCELERATE)
78 #define HAVE_ATLAS 1
79 #define HAVE_BLAS 1
80 #include <Accelerate/Accelerate.h>
81 #elif defined(HAVE_ATLAS_CBLAS_H)
82 #elif defined(HAVE_BLAS)
83 #if defined(HAVE_ATLAS_CBLAS_H)
84 #define HAVE_ATLAS 1
85 #include <atlas/cblas.h>
86 #elif defined(HAVE_OPENBLAS_CBLAS_H)
87 #include <openblas/cblas.h>
88 #elif defined(HAVE_CBLAS_H)
89 #include <cblas.h>
90 #endif
91 #endif
92
93 #ifdef HAVE_ACCELERATE
94 #include <Accelerate/Accelerate.h>
95 #ifndef HAVE_AUBIO_DOUBLE
96 #define aubio_vDSP_mmov       vDSP_mmov
97 #define aubio_vDSP_vmul       vDSP_vmul
98 #define aubio_vDSP_vsmul      vDSP_vsmul
99 #define aubio_vDSP_vsadd      vDSP_vsadd
100 #define aubio_vDSP_vfill      vDSP_vfill
101 #define aubio_vDSP_meanv      vDSP_meanv
102 #define aubio_vDSP_sve        vDSP_sve
103 #define aubio_vDSP_maxv       vDSP_maxv
104 #define aubio_vDSP_maxvi      vDSP_maxvi
105 #define aubio_vDSP_minv       vDSP_minv
106 #define aubio_vDSP_minvi      vDSP_minvi
107 #define aubio_vDSP_dotpr      vDSP_dotpr
108 #define aubio_vDSP_vclr       vDSP_vclr
109 #else /* HAVE_AUBIO_DOUBLE */
110 #define aubio_vDSP_mmov       vDSP_mmovD
111 #define aubio_vDSP_vmul       vDSP_vmulD
112 #define aubio_vDSP_vsmul      vDSP_vsmulD
113 #define aubio_vDSP_vsadd      vDSP_vsaddD
114 #define aubio_vDSP_vfill      vDSP_vfillD
115 #define aubio_vDSP_meanv      vDSP_meanvD
116 #define aubio_vDSP_sve        vDSP_sveD
117 #define aubio_vDSP_maxv       vDSP_maxvD
118 #define aubio_vDSP_maxvi      vDSP_maxviD
119 #define aubio_vDSP_minv       vDSP_minvD
120 #define aubio_vDSP_minvi      vDSP_minviD
121 #define aubio_vDSP_dotpr      vDSP_dotprD
122 #define aubio_vDSP_vclr       vDSP_vclrD
123 #endif /* HAVE_AUBIO_DOUBLE */
124 #endif /* HAVE_ACCELERATE */
125
126 #if defined(HAVE_BLAS)
127 #ifndef HAVE_AUBIO_DOUBLE
128 #ifdef HAVE_ATLAS
129 #define aubio_catlas_set      catlas_sset
130 #endif /* HAVE_ATLAS */
131 #define aubio_cblas_copy      cblas_scopy
132 #define aubio_cblas_swap      cblas_sswap
133 #define aubio_cblas_dot       cblas_sdot
134 #else /* HAVE_AUBIO_DOUBLE */
135 #ifdef HAVE_ATLAS
136 #define aubio_catlas_set      catlas_dset
137 #endif /* HAVE_ATLAS */
138 #define aubio_cblas_copy      cblas_dcopy
139 #define aubio_cblas_swap      cblas_dswap
140 #define aubio_cblas_dot       cblas_ddot
141 #endif /* HAVE_AUBIO_DOUBLE */
142 #endif /* HAVE_BLAS */
143
144 #if defined HAVE_INTEL_IPP
145 #include <ippcore.h>
146 #include <ippvm.h>
147 #include <ipps.h>
148 #ifndef HAVE_AUBIO_DOUBLE
149 #define aubio_ippsSet         ippsSet_32f
150 #define aubio_ippsZero        ippsZero_32f
151 #define aubio_ippsCopy        ippsCopy_32f
152 #define aubio_ippsMul         ippsMul_32f
153 #define aubio_ippsMulC        ippsMulC_32f
154 #define aubio_ippsAddC        ippsAddC_32f
155 #define aubio_ippsLn          ippsLn_32f_A21
156 #define aubio_ippsMean(a,b,c) ippsMean_32f(a, b, c, ippAlgHintFast)
157 #define aubio_ippsSum(a,b,c)  ippsSum_32f(a, b, c, ippAlgHintFast)
158 #define aubio_ippsMax         ippsMax_32f
159 #define aubio_ippsMin         ippsMin_32f
160 #else /* HAVE_AUBIO_DOUBLE */
161 #define aubio_ippsSet         ippsSet_64f
162 #define aubio_ippsZero        ippsZero_64f
163 #define aubio_ippsCopy        ippsCopy_64f
164 #define aubio_ippsMul         ippsMul_64f
165 #define aubio_ippsMulC        ippsMulC_64f
166 #define aubio_ippsAddC        ippsAddC_64f
167 #define aubio_ippsLn          ippsLn_64f_A26
168 #define aubio_ippsMean        ippsMean_64f
169 #define aubio_ippsSum         ippsSum_64f
170 #define aubio_ippsMax         ippsMax_64f
171 #define aubio_ippsMin         ippsMin_64f
172 #endif /* HAVE_AUBIO_DOUBLE */
173 #endif
174
175 #if !defined(HAVE_MEMCPY_HACKS) && !defined(HAVE_ACCELERATE) && !defined(HAVE_ATLAS) && !defined(HAVE_INTEL_IPP)
176 #define HAVE_NOOPT 1
177 #endif
178
179 #include "types.h"
180
181 #define AUBIO_UNSTABLE 1
182
183 #include "mathutils.h"
184
185 /****
186  *
187  * SYSTEM INTERFACE
188  *
189  */
190
191 /* Memory management */
192 #define AUBIO_MALLOC(_n)             malloc(_n)
193 #define AUBIO_REALLOC(_p,_n)         realloc(_p,_n)
194 #define AUBIO_NEW(_t)                (_t*)calloc(sizeof(_t), 1)
195 #define AUBIO_ARRAY(_t,_n)           (_t*)calloc((_n)*sizeof(_t), 1)
196 #define AUBIO_MEMCPY(_dst,_src,_n)   memcpy(_dst,_src,_n)
197 #define AUBIO_MEMSET(_dst,_src,_t)   memset(_dst,_src,_t)
198 #define AUBIO_FREE(_p)               free(_p)
199
200
201 /* file interface */
202 #define AUBIO_FOPEN(_f,_m)           fopen(_f,_m)
203 #define AUBIO_FCLOSE(_f)             fclose(_f)
204 #define AUBIO_FREAD(_p,_s,_n,_f)     fread(_p,_s,_n,_f)
205 #define AUBIO_FSEEK(_f,_n,_set)      fseek(_f,_n,_set)
206
207 /* strings */
208 #define AUBIO_STRLEN(_s)             strlen(_s)
209 #define AUBIO_STRCMP(_s,_t)          strcmp(_s,_t)
210 #define AUBIO_STRNCMP(_s,_t,_n)      strncmp(_s,_t,_n)
211 #define AUBIO_STRCPY(_dst,_src)      strcpy(_dst,_src)
212 #define AUBIO_STRCHR(_s,_c)          strchr(_s,_c)
213 #ifdef strdup
214 #define AUBIO_STRDUP(s)              strdup(s)
215 #else
216 #define AUBIO_STRDUP(s)              AUBIO_STRCPY(AUBIO_MALLOC(AUBIO_STRLEN(s) + 1), s)
217 #endif
218
219
220 /* Error reporting */
221 typedef enum {
222   AUBIO_OK = 0,
223   AUBIO_FAIL = 1
224 } aubio_status;
225
226 /* Logging */
227
228 #include "utils/log.h"
229
230 /** internal logging function, defined in utils/log.c */
231 uint_t aubio_log(sint_t level, const char_t *fmt, ...);
232
233 #ifdef HAVE_C99_VARARGS_MACROS
234 #define AUBIO_ERR(...)               aubio_log(AUBIO_LOG_ERR, "AUBIO ERROR: " __VA_ARGS__)
235 #define AUBIO_INF(...)               aubio_log(AUBIO_LOG_INF, "AUBIO INFO: " __VA_ARGS__)
236 #define AUBIO_MSG(...)               aubio_log(AUBIO_LOG_MSG, __VA_ARGS__)
237 #define AUBIO_DBG(...)               aubio_log(AUBIO_LOG_DBG, __VA_ARGS__)
238 #define AUBIO_WRN(...)               aubio_log(AUBIO_LOG_WRN, "AUBIO WARNING: " __VA_ARGS__)
239 #else
240 #define AUBIO_ERR(format, args...)   aubio_log(AUBIO_LOG_ERR, "AUBIO ERROR: " format , ##args)
241 #define AUBIO_INF(format, args...)   aubio_log(AUBIO_LOG_INF, "AUBIO INFO: " format , ##args)
242 #define AUBIO_MSG(format, args...)   aubio_log(AUBIO_LOG_MSG, format , ##args)
243 #define AUBIO_DBG(format, args...)   aubio_log(AUBIO_LOG_DBG, format , ##args)
244 #define AUBIO_WRN(format, args...)   aubio_log(AUBIO_LOG_WRN, "AUBIO WARNING: " format, ##args)
245 #endif
246
247 #define AUBIO_ERROR   AUBIO_ERR
248
249 #define AUBIO_QUIT(_s)               exit(_s)
250 #define AUBIO_SPRINTF                sprintf
251
252 #define AUBIO_MAX_SAMPLERATE (192000*8)
253 #define AUBIO_MAX_CHANNELS 1024
254
255 /* pi and 2*pi */
256 #ifndef M_PI
257 #define PI         (3.14159265358979323846)
258 #else
259 #define PI         (M_PI)
260 #endif
261 #define TWO_PI     (PI*2.)
262
263 #ifndef PATH_MAX
264 #define PATH_MAX 1024
265 #endif
266
267 /* aliases to math.h functions */
268 #if !HAVE_AUBIO_DOUBLE
269 #define EXP        expf
270 #define COS        cosf
271 #define SIN        sinf
272 #define ABS        fabsf
273 #define POW        powf
274 #define SQRT       sqrtf
275 #define LOG10      log10f
276 #define LOG        logf
277 #define FLOOR      floorf
278 #define CEIL       ceilf
279 #define ATAN       atanf
280 #define ATAN2      atan2f
281 #else
282 #define EXP        exp
283 #define COS        cos
284 #define SIN        sin
285 #define ABS        fabs
286 #define POW        pow
287 #define SQRT       sqrt
288 #define LOG10      log10
289 #define LOG        log
290 #define FLOOR      floor
291 #define CEIL       ceil
292 #define ATAN       atan
293 #define ATAN2      atan2
294 #endif
295 #define ROUND(x)   FLOOR(x+.5)
296
297 /* aliases to complex.h functions */
298 #if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
299 /* mingw32 does not know about c*f functions */
300 #define EXPC      cexp
301 /** complex = CEXPC(complex) */
302 #define CEXPC     cexp
303 /** sample = ARGC(complex) */
304 #define ARGC      carg
305 /** sample = ABSC(complex) norm */
306 #define ABSC      cabs
307 /** sample = REAL(complex) */
308 #define REAL      creal
309 /** sample = IMAG(complex) */
310 #define IMAG      cimag
311 #else
312 /** sample = EXPC(complex) */
313 #define EXPC      cexpf
314 /** complex = CEXPC(complex) */
315 #define CEXPC     cexp
316 /** sample = ARGC(complex) */
317 #define ARGC      cargf
318 /** sample = ABSC(complex) norm */
319 #define ABSC      cabsf
320 /** sample = REAL(complex) */
321 #define REAL      crealf
322 /** sample = IMAG(complex) */
323 #define IMAG      cimagf
324 #endif
325
326 /* avoid unresolved symbol with msvc 9 */
327 #if defined(_MSC_VER) && (_MSC_VER < 1900)
328 #define isnan _isnan
329 #endif
330
331 #if !defined(_MSC_VER)
332 #define AUBIO_STRERROR(errno,buf,len) strerror_r(errno, buf, len)
333 #else
334 #define AUBIO_STRERROR(errno,buf,len) strerror_s(buf, len, errno)
335 #endif
336
337 #ifdef HAVE_C99_VARARGS_MACROS
338 #define AUBIO_STRERR(...)            \
339     char errorstr[256]; \
340     AUBIO_STRERROR(errno, errorstr, sizeof(errorstr)); \
341     AUBIO_ERR(__VA_ARGS__)
342 #else
343 #define AUBIO_STRERR(format, args...)   \
344     char errorstr[256]; \
345     AUBIO_STRERROR(errno, errorstr, sizeof(errorstr)); \
346     AUBIO_ERR(format, ##args)
347 #endif
348
349 /* handy shortcuts */
350 #define DB2LIN(g) (POW(10.0,(g)*0.05f))
351 #define LIN2DB(v) (20.0*LOG10(v))
352 #define SQR(_a)   ((_a)*(_a))
353
354 #ifndef MAX
355 #define MAX(a,b)  (((a)>(b))?(a):(b))
356 #endif /* MAX */
357 #ifndef MIN
358 #define MIN(a,b)  (((a)<(b))?(a):(b))
359 #endif /* MIN */
360
361 #define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
362
363 #define VERY_SMALL_NUMBER 2.e-42 //1.e-37
364
365 /** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
366 #define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
367
368 /** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
369 #define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
370
371 /** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
372 #define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
373
374 #define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
375 #define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
376
377 /** silence unused parameter warning by adding an attribute */
378 #if defined(__GNUC__)
379 #define UNUSED __attribute__((unused))
380 #else
381 #define UNUSED
382 #endif
383
384 /* are we using gcc -std=c99 ? */
385 #if defined(__STRICT_ANSI__)
386 #define strnlen(a,b) MIN(strlen(a),b)
387 #if !HAVE_AUBIO_DOUBLE
388 #define floorf floor
389 #endif
390 #endif /* __STRICT_ANSI__ */
391
392 #if defined(DEBUG)
393 #include <assert.h>
394 #define AUBIO_ASSERT(x) assert(x)
395 #else
396 #define AUBIO_ASSERT(x)
397 #endif /* DEBUG */
398
399 #endif /* AUBIO_PRIV_H */