source: src/aubio_priv.h @ ae9b76b

Last change on this file since ae9b76b was 5c3cdc8, checked in by Paul Brossier <piem@piem.org>, 12 months ago

[priv] remove sprintf and add snprintf
  • Property mode set to 100644
File size: 11.2 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#else /* HAVE_AUBIO_DOUBLE */
137#ifdef HAVE_ATLAS
138#define aubio_catlas_set      catlas_dset
139#endif /* HAVE_ATLAS */
140#define aubio_cblas_copy      cblas_dcopy
141#define aubio_cblas_swap      cblas_dswap
142#define aubio_cblas_dot       cblas_ddot
143#endif /* HAVE_AUBIO_DOUBLE */
144#endif /* HAVE_BLAS */
145
146#if defined HAVE_INTEL_IPP
147#include <ippcore.h>
148#include <ippvm.h>
149#include <ipps.h>
150#ifndef HAVE_AUBIO_DOUBLE
151#define aubio_ippsSet         ippsSet_32f
152#define aubio_ippsZero        ippsZero_32f
153#define aubio_ippsCopy        ippsCopy_32f
154#define aubio_ippsMul         ippsMul_32f
155#define aubio_ippsMulC        ippsMulC_32f
156#define aubio_ippsAddC        ippsAddC_32f
157#define aubio_ippsLn          ippsLn_32f_A21
158#define aubio_ippsMean(a,b,c) ippsMean_32f(a, b, c, ippAlgHintFast)
159#define aubio_ippsSum(a,b,c)  ippsSum_32f(a, b, c, ippAlgHintFast)
160#define aubio_ippsMax         ippsMax_32f
161#define aubio_ippsMin         ippsMin_32f
162#else /* HAVE_AUBIO_DOUBLE */
163#define aubio_ippsSet         ippsSet_64f
164#define aubio_ippsZero        ippsZero_64f
165#define aubio_ippsCopy        ippsCopy_64f
166#define aubio_ippsMul         ippsMul_64f
167#define aubio_ippsMulC        ippsMulC_64f
168#define aubio_ippsAddC        ippsAddC_64f
169#define aubio_ippsLn          ippsLn_64f_A26
170#define aubio_ippsMean        ippsMean_64f
171#define aubio_ippsSum         ippsSum_64f
172#define aubio_ippsMax         ippsMax_64f
173#define aubio_ippsMin         ippsMin_64f
174#endif /* HAVE_AUBIO_DOUBLE */
175#endif
176
177#if !defined(HAVE_MEMCPY_HACKS) && !defined(HAVE_ACCELERATE) && !defined(HAVE_ATLAS) && !defined(HAVE_INTEL_IPP)
178#define HAVE_NOOPT 1
179#endif
180
181#include "types.h"
182
183#define AUBIO_UNSTABLE 1
184
185#include "mathutils.h"
186
187/****
188 *
189 * SYSTEM INTERFACE
190 *
191 */
192
193/* Memory management */
194#define AUBIO_MALLOC(_n)             malloc(_n)
195#define AUBIO_REALLOC(_p,_n)         realloc(_p,_n)
196#define AUBIO_NEW(_t)                (_t*)calloc(sizeof(_t), 1)
197#define AUBIO_ARRAY(_t,_n)           (_t*)calloc((_n)*sizeof(_t), 1)
198#define AUBIO_MEMCPY(_dst,_src,_n)   memcpy(_dst,_src,_n)
199#define AUBIO_MEMSET(_dst,_src,_t)   memset(_dst,_src,_t)
200#define AUBIO_FREE(_p)               free(_p)
201
202
203/* file interface */
204#define AUBIO_FOPEN(_f,_m)           fopen(_f,_m)
205#define AUBIO_FCLOSE(_f)             fclose(_f)
206#define AUBIO_FREAD(_p,_s,_n,_f)     fread(_p,_s,_n,_f)
207#define AUBIO_FSEEK(_f,_n,_set)      fseek(_f,_n,_set)
208
209/* strings */
210#define AUBIO_STRLEN(_s)             strlen(_s)
211#define AUBIO_STRCMP(_s,_t)          strcmp(_s,_t)
212#define AUBIO_STRNCMP(_s,_t,_n)      strncmp(_s,_t,_n)
213#define AUBIO_STRCPY(_dst,_src)      strcpy(_dst,_src)
214#define AUBIO_STRCHR(_s,_c)          strchr(_s,_c)
215#ifdef strdup
216#define AUBIO_STRDUP(s)              strdup(s)
217#else
218#define AUBIO_STRDUP(s)              AUBIO_STRCPY(AUBIO_MALLOC(AUBIO_STRLEN(s) + 1), s)
219#endif
220
221
222/* Error reporting */
223typedef enum {
224  AUBIO_OK = 0,
225  AUBIO_FAIL = 1
226} aubio_status;
227
228/* Logging */
229
230#include "utils/log.h"
231
232/** internal logging function, defined in utils/log.c */
233uint_t aubio_log(sint_t level, const char_t *fmt, ...);
234
235#ifdef HAVE_C99_VARARGS_MACROS
236#define AUBIO_ERR(...)               aubio_log(AUBIO_LOG_ERR, "AUBIO ERROR: " __VA_ARGS__)
237#define AUBIO_INF(...)               aubio_log(AUBIO_LOG_INF, "AUBIO INFO: " __VA_ARGS__)
238#define AUBIO_MSG(...)               aubio_log(AUBIO_LOG_MSG, __VA_ARGS__)
239#define _AUBIO_DBG(...)              aubio_log(AUBIO_LOG_DBG, __VA_ARGS__)
240#define AUBIO_WRN(...)               aubio_log(AUBIO_LOG_WRN, "AUBIO WARNING: " __VA_ARGS__)
241#else
242#define AUBIO_ERR(format, args...)   aubio_log(AUBIO_LOG_ERR, "AUBIO ERROR: " format , ##args)
243#define AUBIO_INF(format, args...)   aubio_log(AUBIO_LOG_INF, "AUBIO INFO: " format , ##args)
244#define AUBIO_MSG(format, args...)   aubio_log(AUBIO_LOG_MSG, format , ##args)
245#define _AUBIO_DBG(format, args...)  aubio_log(AUBIO_LOG_DBG, format , ##args)
246#define AUBIO_WRN(format, args...)   aubio_log(AUBIO_LOG_WRN, "AUBIO WARNING: " format, ##args)
247#endif
248
249#ifdef DEBUG
250#define AUBIO_DBG _AUBIO_DBG
251#else
252// disable debug output
253#ifdef HAVE_C99_VARARGS_MACROS
254#define AUBIO_DBG(...)               {}
255#else
256#define AUBIO_DBG(format, args...)   {}
257#endif
258#endif
259
260#define AUBIO_ERROR   AUBIO_ERR
261
262#define AUBIO_QUIT(_s)               exit(_s)
263#define AUBIO_SNPRINTF               snprintf
264
265#define AUBIO_MAX_SAMPLERATE (192000*8)
266#define AUBIO_MAX_CHANNELS 1024
267
268/* pi and 2*pi */
269#ifndef M_PI
270#define PI         (3.14159265358979323846)
271#else
272#define PI         (M_PI)
273#endif
274#define TWO_PI     (PI*2.)
275
276#ifndef PATH_MAX
277#define PATH_MAX 1024
278#endif
279
280/* aliases to math.h functions */
281#if !HAVE_AUBIO_DOUBLE
282#define EXP        expf
283#define COS        cosf
284#define SIN        sinf
285#define ABS        fabsf
286#define POW        powf
287#define SQRT       sqrtf
288#define LOG10      log10f
289#define LOG        logf
290#define FLOOR      floorf
291#define CEIL       ceilf
292#define ATAN       atanf
293#define ATAN2      atan2f
294#else
295#define EXP        exp
296#define COS        cos
297#define SIN        sin
298#define ABS        fabs
299#define POW        pow
300#define SQRT       sqrt
301#define LOG10      log10
302#define LOG        log
303#define FLOOR      floor
304#define CEIL       ceil
305#define ATAN       atan
306#define ATAN2      atan2
307#endif
308#define ROUND(x)   FLOOR(x+.5)
309
310/* aliases to complex.h functions */
311#if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
312/* mingw32 does not know about c*f functions */
313#define EXPC      cexp
314/** complex = CEXPC(complex) */
315#define CEXPC     cexp
316/** sample = ARGC(complex) */
317#define ARGC      carg
318/** sample = ABSC(complex) norm */
319#define ABSC      cabs
320/** sample = REAL(complex) */
321#define REAL      creal
322/** sample = IMAG(complex) */
323#define IMAG      cimag
324#else
325/** sample = EXPC(complex) */
326#define EXPC      cexpf
327/** complex = CEXPC(complex) */
328#define CEXPC     cexp
329/** sample = ARGC(complex) */
330#define ARGC      cargf
331/** sample = ABSC(complex) norm */
332#define ABSC      cabsf
333/** sample = REAL(complex) */
334#define REAL      crealf
335/** sample = IMAG(complex) */
336#define IMAG      cimagf
337#endif
338
339/* avoid unresolved symbol with msvc 9 */
340#if defined(_MSC_VER) && (_MSC_VER < 1900)
341#define isnan _isnan
342#endif
343
344#if !defined(_MSC_VER)
345#define AUBIO_STRERROR(errno,buf,len) strerror_r(errno, buf, len)
346#else
347#define AUBIO_STRERROR(errno,buf,len) strerror_s(buf, len, errno)
348#endif
349
350#ifdef HAVE_C99_VARARGS_MACROS
351#define AUBIO_STRERR(...)            \
352    char errorstr[256]; \
353    AUBIO_STRERROR(errno, errorstr, sizeof(errorstr)); \
354    AUBIO_ERR(__VA_ARGS__)
355#else
356#define AUBIO_STRERR(format, args...)   \
357    char errorstr[256]; \
358    AUBIO_STRERROR(errno, errorstr, sizeof(errorstr)); \
359    AUBIO_ERR(format, ##args)
360#endif
361
362/* handy shortcuts */
363#define DB2LIN(g) (POW(10.0,(g)*0.05f))
364#define LIN2DB(v) (20.0*LOG10(v))
365#define SQR(_a)   ((_a)*(_a))
366
367#ifndef MAX
368#define MAX(a,b)  (((a)>(b))?(a):(b))
369#endif /* MAX */
370#ifndef MIN
371#define MIN(a,b)  (((a)<(b))?(a):(b))
372#endif /* MIN */
373
374#define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
375
376#define VERY_SMALL_NUMBER 2.e-42 //1.e-37
377
378/** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
379#define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
380
381/** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
382#define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
383
384/** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
385#define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
386
387#define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
388#define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
389
390/** silence unused parameter warning by adding an attribute */
391#if defined(__GNUC__)
392#define UNUSED __attribute__((unused))
393#else
394#define UNUSED
395#endif
396
397/* are we using gcc -std=c99 ? */
398#if defined(__STRICT_ANSI__)
399#define strnlen(a,b) MIN(strlen(a),b)
400#if !HAVE_AUBIO_DOUBLE
401#define floorf floor
402#endif
403#endif /* __STRICT_ANSI__ */
404
405#if defined(DEBUG)
406#include <assert.h>
407#define AUBIO_ASSERT(x) assert(x)
408#else
409#define AUBIO_ASSERT(x)
410#endif /* DEBUG */
411
412#endif /* AUBIO_PRIV_H */
Note: See TracBrowser for help on using the repository browser.