2 Copyright (C) 2003-2009 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 optionally on several channels. ::cvec_t are used to store complex number,
53 as two vectors of norm and phase elements, also on several channels.
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, channels);
68 aubio_pvoc_t *pv = new_aubio_pvoc (winsize, stepsize, channels);
70 aubio_onset_t *onset = new_aubio_onset (method, winsize, stepsize, channels, samplerate);
72 aubio_pitch_t *pitch = new_aubio_pitch (method, winsize, stepsize, channels, samplerate);
74 aubio_tempo_t *tempo = new_aubio_tempo (method, winsize, stepsize, channels, 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 channels, window size, and sampling rate
88 uint_t channels = 2, winsize = 1024, samplerate = 44100;
90 fvec_t *this_buffer = new_fvec (winsize, channels);
91 // create the a-weighting filter
92 aubio_filter_t *this_filter = new_aubio_filter_weighting (channels, samplerate);
95 // here some code to pass some data in fvec_t in ...
96 // apply the filter, in place
97 aubio_filter_do (this_filter, this_buffer);
98 // here some code to used the filtered buffer
101 // and free the structures
102 del_aubio_filter (this_filter);
103 del_fvec (this_buffer);
107 Several examples of C programs are available in the \p examples/ and \p tests/src
108 directory of the source tree.
110 \subsection unstable_api Unstable API
112 Several more functions are available and used within aubio, but not
113 documented here, either because they are not considered useful to the user,
114 or because they may need to be changed in the future. However, they can still
115 be used by defining AUBIO_UNSTABLE to 1 before including the aubio header:
118 #define AUBIO_UNSTABLE 1
119 #include <aubio/aubio.h>
122 Future versions of aubio could break API compatibility with these functions
123 without warning. If you choose to use functions in AUBIO_UNSTABLE, you are on
126 \section download Download
128 Latest versions, further documentation, examples, wiki, and mailing lists can
129 be found at http://aubio.org .
136 /** @file aubio.h Global aubio include file.
138 Programmers just need to include this file as:
141 #include <aubio/aubio.h>
151 /* first the generated config file */
159 #include "musicutils.h"
160 #include "temporal/resampler.h"
161 #include "temporal/filter.h"
162 #include "temporal/biquad.h"
163 #include "temporal/a_weighting.h"
164 #include "temporal/c_weighting.h"
165 #include "spectral/fft.h"
166 #include "spectral/phasevoc.h"
167 #include "spectral/mfcc.h"
168 #include "pitch/pitch.h"
169 #include "onset/onset.h"
170 #include "tempo/tempo.h"
173 #include "vecutils.h"
174 #include "mathutils.h"
175 #include "utils/scale.h"
176 #include "utils/hist.h"
177 #include "spectral/tss.h"
178 #include "spectral/filterbank.h"
179 #include "spectral/filterbank_mel.h"
180 #include "pitch/pitchmcomb.h"
181 #include "pitch/pitchyin.h"
182 #include "pitch/pitchyinfft.h"
183 #include "pitch/pitchschmitt.h"
184 #include "pitch/pitchfcomb.h"
185 #include "onset/onsetdetection.h"
186 #include "spectral/spectral_centroid.h"
187 #include "onset/peakpick.h"
188 #include "tempo/beattracking.h"