aubio: aubio.h Source File

aubio 0.4.9

aubio.h
Go to the documentation of this file.
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 /** \mainpage
22
23 \section introduction Introduction
24
25 aubio is a library to extract annotations from audio signals: it provides a
26 set of functions that take an input audio signal, and output pitch estimates,
27 attack times (onset), beat location estimates, and other annotation tasks.
28
29 \section basics Basics
30
31 All object structures in aubio share the same function prefixes and suffixes:
32
33 - \p new_aubio_foo creates the object \p foo
34 - \p aubio_foo_do executes the object \p foo
35 - \p del_aubio_foo destroys the object \p foo
36
37 All memory allocation and deallocation take place in the \p new_ and \p del_
38 functions. Optionally, more than one \p _do methods are available.
39 Additional parameters can be adjusted and observed using:
40
41 - \p aubio_foo_get_param, getter function, gets the value of a parameter
42 - \p aubio_foo_set_param, setter function, changes the value of a parameter
43
44 Unless specified in its documentation, no memory operations take place in the
45 getter functions. However, memory resizing can take place in setter
46 functions.
47
48 \subsection vectors Vectors
49
50 Two basic structures are being used in aubio: ::fvec_t and ::cvec_t. The
51 ::fvec_t structures are used to store vectors of floating pointer number.
52 ::cvec_t are used to store complex number, as two vectors of norm and phase
53 elements.
54
55 Additionally, the ::lvec_t structure can be used to store floating point
56 numbers in double precision. They are mostly used to store filter
57 coefficients, to avoid instability.
58
59 \subsection objects Available objects
60
61 Here is a list of some of the most common objects for aubio:
62
63 \code
64
65 // fast Fourier transform (FFT)
66 aubio_fft_t *fft = new_aubio_fft (winsize);
67 // phase vocoder
68 aubio_pvoc_t *pv = new_aubio_pvoc (winsize, stepsize);
69 // onset detection
70 aubio_onset_t *onset = new_aubio_onset (method, winsize, stepsize, samplerate);
71 // pitch detection
72 aubio_pitch_t *pitch = new_aubio_pitch (method, winsize, stepsize, samplerate);
73 // beat tracking
74 aubio_tempo_t *tempo = new_aubio_tempo (method, winsize, stepsize, samplerate);
75
76 \endcode
77
78 See the <a href="globals_type.html">list of typedefs</a> for a complete list.
79
80 \subsection example Example
81
82 Here is a simple example that creates an A-Weighting filter and applies it to a
83 vector.
84
85 \code
86
87 // set window size, and sampling rate
88 uint_t winsize = 1024, sr = 44100;
89 // create a vector
90 fvec_t *this_buffer = new_fvec (winsize);
91 // create the a-weighting filter
92 aubio_filter_t *this_filter = new_aubio_filter_a_weighting (sr);
93
94 while (running) {
95 // here some code to put some data in this_buffer
96 // ...
97
98 // apply the filter, in place
99 aubio_filter_do (this_filter, this_buffer);
100
101 // here some code to get some data from this_buffer
102 // ...
103 }
104
105 // and free the structures
106 del_aubio_filter (this_filter);
107 del_fvec (this_buffer);
108
109 \endcode
110
111 Several examples of C programs are available in the \p examples/ and \p tests/src
112 directories of the source tree.
113
114 Some examples:
115 - @ref spectral/test-fft.c
116 - @ref spectral/test-phasevoc.c
117 - @ref onset/test-onset.c
118 - @ref pitch/test-pitch.c
119 - @ref tempo/test-tempo.c
120 - @ref test-fvec.c
121 - @ref test-cvec.c
122
123 \subsection unstable_api Unstable API
124
125 Several more functions are available and used within aubio, but not
126 documented here, either because they are not considered useful to the user,
127 or because they may need to be changed in the future. However, they can still
128 be used by defining AUBIO_UNSTABLE to 1 before including the aubio header:
129
130 \code
131 #define AUBIO_UNSTABLE 1
132 #include <aubio/aubio.h>
133 \endcode
134
135 Future versions of aubio could break API compatibility with these functions
136 without warning. If you choose to use functions in AUBIO_UNSTABLE, you are on
137 your own.
138
139 \section download Download
140
141 Latest versions, further documentation, examples, wiki, and mailing lists can
142 be found at https://aubio.org .
143
144 */
145
146 #ifndef AUBIO_H
147 #define AUBIO_H
148
149 /** @file aubio.h Global aubio include file.
150
151 You will want to include this file as:
152
153 @code
154 #include <aubio/aubio.h>
155 @endcode
156
157 To access headers with unstable prototypes, use:
158
159 @code
160 #define AUBIO_UNSTABLE 1
161 #include <aubio/aubio.h>
162 @endcode
163
164 */
165
166 #ifdef __cplusplus
167 extern "C"
168 {
169 #endif
170
171 /* in this order */
172 #include "types.h"
173 #include "fvec.h"
174 #include "cvec.h"
175 #include "lvec.h"
176 #include "fmat.h"
177 #include "musicutils.h"
178 #include "vecutils.h"
179 #include "temporal/resampler.h"
180 #include "temporal/filter.h"
181 #include "temporal/biquad.h"
182 #include "temporal/a_weighting.h"
183 #include "temporal/c_weighting.h"
184 #include "spectral/fft.h"
185 #include "spectral/dct.h"
186 #include "spectral/phasevoc.h"
187 #include "spectral/filterbank.h"
188 #include "spectral/filterbank_mel.h"
189 #include "spectral/mfcc.h"
190 #include "spectral/specdesc.h"
191 #include "spectral/awhitening.h"
192 #include "spectral/tss.h"
193 #include "pitch/pitch.h"
194 #include "onset/onset.h"
195 #include "tempo/tempo.h"
196 #include "notes/notes.h"
197 #include "io/source.h"
198 #include "io/sink.h"
199 #include "synth/sampler.h"
200 #include "synth/wavetable.h"
201 #include "utils/parameter.h"
202 #include "utils/log.h"
203
204 #if AUBIO_UNSTABLE
205 #include "mathutils.h"
206 #include "io/source_sndfile.h"
207 #include "io/source_apple_audio.h"
208 #include "io/source_avcodec.h"
209 #include "io/source_wavread.h"
210 #include "io/sink_sndfile.h"
211 #include "io/sink_apple_audio.h"
212 #include "io/sink_wavwrite.h"
213 #include "io/audio_unit.h"
214 #include "onset/peakpicker.h"
215 #include "pitch/pitchmcomb.h"
216 #include "pitch/pitchyin.h"
217 #include "pitch/pitchyinfft.h"
218 #include "pitch/pitchyinfast.h"
219 #include "pitch/pitchschmitt.h"
220 #include "pitch/pitchfcomb.h"
221 #include "pitch/pitchspecacf.h"
222 #include "tempo/beattracking.h"
223 #include "utils/scale.h"
224 #include "utils/hist.h"
225 #endif
226
227 #ifdef __cplusplus
228 } /* extern "C" */
229 #endif
230
231 #endif
tempo.h
Tempo detection object.
notes.h
Note detection object.
types.h
Definition of data types used in aubio.
filterbank.h
Filterbank object.
tss.h
Transient / Steady-state Separation (TSS)
filter.h
Digital filter.
mfcc.h
Mel-Frequency Cepstrum Coefficients object.
biquad.h
Second order Infinite Impulse Response filter.
wavetable.h
Wavetable synthesis.
onset.h
Onset detection object.
cvec.h
Vector of complex-valued data, stored in polar coordinates.
sink.h
Media sink to write blocks of consecutive audio samples to file.
fmat.h
Matrix of real valued data.
vecutils.h
Utility functions for fvec_t.
lvec.h
Vector of real-valued data in double precision.
dct.h
Discrete Cosine Transform.
c_weighting.h
C-weighting filter coefficients.
a_weighting.h
A-weighting filter coefficients.
musicutils.h
various functions useful in audio signal processing
resampler.h
Resampling object.
filterbank_mel.h
Filterbank object coefficients initialization.
phasevoc.h
Phase vocoder object.
source.h
Media source to read blocks of consecutive audio samples from file.
awhitening.h
Spectral adaptive whitening.
pitch.h
Pitch detection object.
sampler.h
Load and play sound files.
fvec.h
Vector of real-valued data.
fft.h
Fast Fourier Transform.
specdesc.h
Spectral description functions.
log.h
Logging features.
parameter.h
Parameter with linear interpolation.