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