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