2 Copyright (C) 2003-2015 Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
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.
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.
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/>.
23 \section introduction Introduction
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.
29 \section basics Basics
31 All object structures in aubio share the same function prefixes and suffixes:
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
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:
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
44 Unless specified in its documentation, no memory operations take place in the
45 getter functions. However, memory resizing can take place in setter
48 \subsection vectors Vectors
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
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.
59 \subsection objects Available objects
61 Here is a list of some of the most common objects for aubio:
65 // fast Fourier transform (FFT)
66 aubio_fft_t *fft = new_aubio_fft (winsize);
68 aubio_pvoc_t *pv = new_aubio_pvoc (winsize, stepsize);
70 aubio_onset_t *onset = new_aubio_onset (method, winsize, stepsize, samplerate);
72 aubio_pitch_t *pitch = new_aubio_pitch (method, winsize, stepsize, samplerate);
74 aubio_tempo_t *tempo = new_aubio_tempo (method, winsize, stepsize, samplerate);
78 See the <a href="globals_type.html">list of typedefs</a> for a complete list.
80 \subsection example Example
82 Here is a simple example that creates an A-Weighting filter and applies it to a
87 // set window size, and sampling rate
88 uint_t winsize = 1024, sr = 44100;
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);
95 // here some code to put some data in this_buffer
98 // apply the filter, in place
99 aubio_filter_do (this_filter, this_buffer);
101 // here some code to get some data from this_buffer
105 // and free the structures
106 del_aubio_filter (this_filter);
107 del_fvec (this_buffer);
111 Several examples of C programs are available in the \p examples/ and \p tests/src
112 directories of the source tree.
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
123 \subsection unstable_api Unstable API
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:
131 #define AUBIO_UNSTABLE 1
132 #include <aubio/aubio.h>
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
139 \section download Download
141 Latest versions, further documentation, examples, wiki, and mailing lists can
142 be found at https://aubio.org .
149 /** @file aubio.h Global aubio include file.
151 You will want to include this file as:
154 #include <aubio/aubio.h>
157 To access headers with unstable prototypes, use:
160 #define AUBIO_UNSTABLE 1
161 #include <aubio/aubio.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/phasevoc.h"
186 #include "spectral/filterbank.h"
187 #include "spectral/filterbank_mel.h"
188 #include "spectral/mfcc.h"
189 #include "spectral/specdesc.h"
190 #include "spectral/tss.h"
191 #include "pitch/pitch.h"
192 #include "onset/onset.h"
193 #include "tempo/tempo.h"
194 #include "notes/notes.h"
195 #include "io/source.h"
197 #include "synth/sampler.h"
198 #include "synth/wavetable.h"
199 #include "utils/parameter.h"
200 #include "utils/log.h"
203 #include "mathutils.h"
204 #include "io/source_sndfile.h"
205 #include "io/source_apple_audio.h"
206 #include "io/source_avcodec.h"
207 #include "io/source_wavread.h"
208 #include "io/sink_sndfile.h"
209 #include "io/sink_apple_audio.h"
210 #include "io/sink_wavwrite.h"
211 #include "io/audio_unit.h"
212 #include "onset/peakpicker.h"
213 #include "pitch/pitchmcomb.h"
214 #include "pitch/pitchyin.h"
215 #include "pitch/pitchyinfft.h"
216 #include "pitch/pitchschmitt.h"
217 #include "pitch/pitchfcomb.h"
218 #include "pitch/pitchspecacf.h"
219 #include "tempo/beattracking.h"
220 #include "utils/scale.h"
221 #include "utils/hist.h"