src/aubio_priv.h

   1 /*
   2   Copyright (C) 2003-2009 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 #if HAVE_STDLIB_H
  39 #include <stdlib.h>
  40 #endif
  41
  42 #if 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 #include "types.h"
  68
  69 #define AUBIO_UNSTABLE 1
  70
  71 #include "mathutils.h"
  72
  73 /****
  74  *
  75  * SYSTEM INTERFACE
  76  *
  77  */
  78
  79 /* Memory management */
  80 #define AUBIO_MALLOC(_n)             malloc(_n)
  81 #define AUBIO_REALLOC(_p,_n)         realloc(_p,_n)
  82 #define AUBIO_NEW(_t)                (_t*)calloc(sizeof(_t), 1)
  83 #define AUBIO_ARRAY(_t,_n)           (_t*)calloc((_n)*sizeof(_t), 1)
  84 #define AUBIO_MEMCPY(_dst,_src,_n)   memcpy(_dst,_src,_n)
  85 #define AUBIO_MEMSET(_dst,_src,_t)   memset(_dst,_src,_t)
  86 #define AUBIO_FREE(_p)               free(_p)
  87
  88
  89 /* file interface */
  90 #define AUBIO_FOPEN(_f,_m)           fopen(_f,_m)
  91 #define AUBIO_FCLOSE(_f)             fclose(_f)
  92 #define AUBIO_FREAD(_p,_s,_n,_f)     fread(_p,_s,_n,_f)
  93 #define AUBIO_FSEEK(_f,_n,_set)      fseek(_f,_n,_set)
  94
  95 /* strings */
  96 #define AUBIO_STRLEN(_s)             strlen(_s)
  97 #define AUBIO_STRCMP(_s,_t)          strcmp(_s,_t)
  98 #define AUBIO_STRNCMP(_s,_t,_n)      strncmp(_s,_t,_n)
  99 #define AUBIO_STRCPY(_dst,_src)      strcpy(_dst,_src)
 100 #define AUBIO_STRCHR(_s,_c)          strchr(_s,_c)
 101 #ifdef strdup
 102 #define AUBIO_STRDUP(s)              strdup(s)
 103 #else
 104 #define AUBIO_STRDUP(s)              AUBIO_STRCPY(AUBIO_MALLOC(AUBIO_STRLEN(s) + 1), s)
 105 #endif
 106
 107
 108 /* Error reporting */
 109 typedef enum {
 110   AUBIO_OK = 0,
 111   AUBIO_FAIL = 1
 112 } aubio_status;
 113
 114 #ifdef HAVE_C99_VARARGS_MACROS
 115 #define AUBIO_ERR(...)               fprintf(stderr, "AUBIO ERROR: " __VA_ARGS__)
 116 #define AUBIO_MSG(...)               fprintf(stdout, __VA_ARGS__)
 117 #define AUBIO_DBG(...)               fprintf(stderr, __VA_ARGS__)
 118 #define AUBIO_WRN(...)               fprintf(stderr, "AUBIO WARNING: " __VA_ARGS__)
 119 #else
 120 #define AUBIO_ERR(format, args...)   fprintf(stderr, "AUBIO ERROR: " format , ##args)
 121 #define AUBIO_MSG(format, args...)   fprintf(stdout, format , ##args)
 122 #define AUBIO_DBG(format, args...)   fprintf(stderr, format , ##args)
 123 #define AUBIO_WRN(format, args...)   fprintf(stderr, "AUBIO WARNING: " format, ##args)
 124 #endif
 125
 126 #define AUBIO_ERROR   AUBIO_ERR
 127
 128 #define AUBIO_QUIT(_s)               exit(_s)
 129 #define AUBIO_SPRINTF                sprintf
 130
 131 /* pi and 2*pi */
 132 #ifndef M_PI
 133 #define PI         (3.14159265358979323846)
 134 #else
 135 #define PI         (M_PI)
 136 #endif
 137 #define TWO_PI     (PI*2.)
 138
 139 /* aliases to math.h functions */
 140 #if !HAVE_AUBIO_DOUBLE
 141 #define EXP        expf
 142 #define COS        cosf
 143 #define SIN        sinf
 144 #define ABS        fabsf
 145 #define POW        powf
 146 #define SQRT       sqrtf
 147 #define LOG10      log10f
 148 #define LOG        logf
 149 #define FLOOR      floorf
 150 #define CEIL       ceilf
 151 #define ATAN2      atan2f
 152 #else
 153 #define EXP        exp
 154 #define COS        cos
 155 #define SIN        sin
 156 #define ABS        fabs
 157 #define POW        pow
 158 #define SQRT       sqrt
 159 #define LOG10      log10
 160 #define LOG        log
 161 #define FLOOR      floor
 162 #define CEIL       ceil
 163 #define ATAN2      atan2
 164 #endif
 165 #define ROUND(x)   FLOOR(x+.5)
 166
 167 /* aliases to complex.h functions */
 168 #if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
 169 /* mingw32 does not know about c*f functions */
 170 #define EXPC      cexp
 171 /** complex = CEXPC(complex) */
 172 #define CEXPC     cexp
 173 /** sample = ARGC(complex) */
 174 #define ARGC      carg
 175 /** sample = ABSC(complex) norm */
 176 #define ABSC      cabs
 177 /** sample = REAL(complex) */
 178 #define REAL      creal
 179 /** sample = IMAG(complex) */
 180 #define IMAG      cimag
 181 #else
 182 /** sample = EXPC(complex) */
 183 #define EXPC      cexpf
 184 /** complex = CEXPC(complex) */
 185 #define CEXPC     cexp
 186 /** sample = ARGC(complex) */
 187 #define ARGC      cargf
 188 /** sample = ABSC(complex) norm */
 189 #define ABSC      cabsf
 190 /** sample = REAL(complex) */
 191 #define REAL      crealf
 192 /** sample = IMAG(complex) */
 193 #define IMAG      cimagf
 194 #endif
 195
 196 /* handy shortcuts */
 197 #define DB2LIN(g) (POW(10.0,(g)*0.05f))
 198 #define LIN2DB(v) (20.0*LOG10(v))
 199 #define SQR(_a)   (_a*_a)
 200
 201 #define MAX(a,b)  ( a > b ? a : b)
 202 #define MIN(a,b)  ( a < b ? a : b)
 203
 204 #define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
 205
 206 #define VERY_SMALL_NUMBER 2.e-42 //1.e-37
 207
 208 /** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
 209 #define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
 210
 211 /** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
 212 #define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
 213
 214 /** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
 215 #define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
 216
 217 #define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
 218 #define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
 219
 220 /** silence unused parameter warning by adding an attribute */
 221 #if defined(__GNUC__)
 222 #define UNUSED __attribute__((unused))
 223 #else
 224 #define UNUSED
 225 #endif
 226
 227 #endif /* _AUBIO__PRIV_H */