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 #ifdef HAVE_C99_VARARGS_MACROS
 176 #define AUBIO_ERR(...)               fprintf(stderr, "AUBIO ERROR: " __VA_ARGS__)
 177 #define AUBIO_MSG(...)               fprintf(stdout, __VA_ARGS__)
 178 #define AUBIO_DBG(...)               fprintf(stderr, __VA_ARGS__)
 179 #define AUBIO_WRN(...)               fprintf(stderr, "AUBIO WARNING: " __VA_ARGS__)
 180 #else
 181 #define AUBIO_ERR(format, args...)   fprintf(stderr, "AUBIO ERROR: " format , ##args)
 182 #define AUBIO_MSG(format, args...)   fprintf(stdout, format , ##args)
 183 #define AUBIO_DBG(format, args...)   fprintf(stderr, format , ##args)
 184 #define AUBIO_WRN(format, args...)   fprintf(stderr, "AUBIO WARNING: " format, ##args)
 185 #endif
 186
 187 #define AUBIO_ERROR   AUBIO_ERR
 188
 189 #define AUBIO_QUIT(_s)               exit(_s)
 190 #define AUBIO_SPRINTF                sprintf
 191
 192 /* pi and 2*pi */
 193 #ifndef M_PI
 194 #define PI         (3.14159265358979323846)
 195 #else
 196 #define PI         (M_PI)
 197 #endif
 198 #define TWO_PI     (PI*2.)
 199
 200 #ifndef PATH_MAX
 201 #define PATH_MAX 1024
 202 #endif
 203
 204 /* aliases to math.h functions */
 205 #if !HAVE_AUBIO_DOUBLE
 206 #define EXP        expf
 207 #define COS        cosf
 208 #define SIN        sinf
 209 #define ABS        fabsf
 210 #define POW        powf
 211 #define SQRT       sqrtf
 212 #define LOG10      log10f
 213 #define LOG        logf
 214 #define FLOOR      floorf
 215 #define CEIL       ceilf
 216 #define ATAN2      atan2f
 217 #else
 218 #define EXP        exp
 219 #define COS        cos
 220 #define SIN        sin
 221 #define ABS        fabs
 222 #define POW        pow
 223 #define SQRT       sqrt
 224 #define LOG10      log10
 225 #define LOG        log
 226 #define FLOOR      floor
 227 #define CEIL       ceil
 228 #define ATAN2      atan2
 229 #endif
 230 #define ROUND(x)   FLOOR(x+.5)
 231
 232 /* aliases to complex.h functions */
 233 #if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
 234 /* mingw32 does not know about c*f functions */
 235 #define EXPC      cexp
 236 /** complex = CEXPC(complex) */
 237 #define CEXPC     cexp
 238 /** sample = ARGC(complex) */
 239 #define ARGC      carg
 240 /** sample = ABSC(complex) norm */
 241 #define ABSC      cabs
 242 /** sample = REAL(complex) */
 243 #define REAL      creal
 244 /** sample = IMAG(complex) */
 245 #define IMAG      cimag
 246 #else
 247 /** sample = EXPC(complex) */
 248 #define EXPC      cexpf
 249 /** complex = CEXPC(complex) */
 250 #define CEXPC     cexp
 251 /** sample = ARGC(complex) */
 252 #define ARGC      cargf
 253 /** sample = ABSC(complex) norm */
 254 #define ABSC      cabsf
 255 /** sample = REAL(complex) */
 256 #define REAL      crealf
 257 /** sample = IMAG(complex) */
 258 #define IMAG      cimagf
 259 #endif
 260
 261 /* avoid unresolved symbol with msvc 9 */
 262 #if defined(_MSC_VER) && (_MSC_VER < 1900)
 263 #define isnan _isnan
 264 #endif
 265
 266 /* handy shortcuts */
 267 #define DB2LIN(g) (POW(10.0,(g)*0.05f))
 268 #define LIN2DB(v) (20.0*LOG10(v))
 269 #define SQR(_a)   ((_a)*(_a))
 270
 271 #ifndef MAX
 272 #define MAX(a,b)  (((a)>(b))?(a):(b))
 273 #endif /* MAX */
 274 #ifndef MIN
 275 #define MIN(a,b)  (((a)<(b))?(a):(b))
 276 #endif /* MIN */
 277
 278 #define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
 279
 280 #define VERY_SMALL_NUMBER 2.e-42 //1.e-37
 281
 282 /** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
 283 #define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
 284
 285 /** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
 286 #define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
 287
 288 /** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
 289 #define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
 290
 291 #define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
 292 #define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
 293
 294 /** silence unused parameter warning by adding an attribute */
 295 #if defined(__GNUC__)
 296 #define UNUSED __attribute__((unused))
 297 #else
 298 #define UNUSED
 299 #endif
 300
 301 /* are we using gcc -std=c99 ? */
 302 #if defined(__STRICT_ANSI__)
 303 #define strnlen(a,b) MIN(strlen(a),b)
 304 #if !HAVE_AUBIO_DOUBLE
 305 #define floorf floor
 306 #endif
 307 #endif /* __STRICT_ANSI__ */
 308
 309 #endif /* AUBIO_PRIV_H */