source: src/aubio_priv.h @ 07c70b4b

feature/crepe
Last change on this file since 07c70b4b was 07c70b4b, checked in by Paul Brossier <piem@piem.org>, 2 years ago

[aubio_priv.h] add AUBIO_UNUSED

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