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