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