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