Merge branch 'develop' of aubio.org:/git/aubio/aubio into develop
[aubio.git] / 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 /* Libc shortcuts */
132 #define PI         (M_PI)
133 #define TWO_PI     (PI*2.)
134
135 /* aliases to math.h functions */
136 #if !HAVE_AUBIO_DOUBLE
137 #define EXP        expf
138 #define COS        cosf
139 #define SIN        sinf
140 #define ABS        fabsf
141 #define POW        powf
142 #define SQRT       sqrtf
143 #define LOG10      log10f
144 #define LOG        logf
145 #define FLOOR      floorf
146 #define CEIL       ceilf
147 #define ATAN2      atan2f
148 #else
149 #define EXP        exp
150 #define COS        cos
151 #define SIN        sin
152 #define ABS        fabs
153 #define POW        pow
154 #define SQRT       sqrt
155 #define LOG10      log10
156 #define LOG        log
157 #define FLOOR      floor
158 #define CEIL       ceil
159 #define ATAN2      atan2
160 #endif
161 #define ROUND(x)   FLOOR(x+.5)
162
163 /* aliases to complex.h functions */
164 #if HAVE_AUBIO_DOUBLE || !defined(HAVE_COMPLEX_H) || defined(WIN32)
165 /* mingw32 does not know about c*f functions */
166 #define EXPC      cexp
167 /** complex = CEXPC(complex) */
168 #define CEXPC     cexp
169 /** sample = ARGC(complex) */
170 #define ARGC      carg
171 /** sample = ABSC(complex) norm */
172 #define ABSC      cabs
173 /** sample = REAL(complex) */
174 #define REAL      creal
175 /** sample = IMAG(complex) */
176 #define IMAG      cimag
177 #else
178 /** sample = EXPC(complex) */
179 #define EXPC      cexpf
180 /** complex = CEXPC(complex) */
181 #define CEXPC     cexp
182 /** sample = ARGC(complex) */
183 #define ARGC      cargf
184 /** sample = ABSC(complex) norm */
185 #define ABSC      cabsf
186 /** sample = REAL(complex) */
187 #define REAL      crealf
188 /** sample = IMAG(complex) */
189 #define IMAG      cimagf
190 #endif
191
192 /* handy shortcuts */
193 #define DB2LIN(g) (POW(10.0,(g)*0.05f))
194 #define LIN2DB(v) (20.0*LOG10(v))
195 #define SQR(_a)   (_a*_a)
196
197 #define MAX(a,b)  ( a > b ? a : b)
198 #define MIN(a,b)  ( a < b ? a : b)
199
200 #define ELEM_SWAP(a,b) { register smpl_t t=(a);(a)=(b);(b)=t; }
201
202 #define VERY_SMALL_NUMBER 2.e-42 //1.e-37
203
204 /** if ABS(f) < VERY_SMALL_NUMBER, returns 1, else 0 */
205 #define IS_DENORMAL(f) ABS(f) < VERY_SMALL_NUMBER
206
207 /** if ABS(f) < VERY_SMALL_NUMBER, returns 0., else f */
208 #define KILL_DENORMAL(f)  IS_DENORMAL(f) ? 0. : f
209
210 /** if f > VERY_SMALL_NUMBER, returns f, else returns VERY_SMALL_NUMBER */
211 #define CEIL_DENORMAL(f)  f < VERY_SMALL_NUMBER ? VERY_SMALL_NUMBER : f
212
213 #define SAFE_LOG10(f) LOG10(CEIL_DENORMAL(f))
214 #define SAFE_LOG(f)   LOG(CEIL_DENORMAL(f))
215
216 #define UNUSED __attribute__((unused))
217
218 #endif /* _AUBIO__PRIV_H */