source: src/aubio.h @ ab41f5c

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since ab41f5c was ab41f5c, checked in by Paul Brossier <piem@piem.org>, 7 years ago

src/io/sndfileio.{c,h}: remove old sndfile interface

Signed-off-by: Paul Brossier <piem@piem.org>

  • Property mode set to 100644
File size: 6.0 KB
Line 
1/*
2  Copyright (C) 2003-2013 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  \subsection unstable_api Unstable API
115
116  Several more functions are available and used within aubio, but not
117  documented here, either because they are not considered useful to the user,
118  or because they may need to be changed in the future. However, they can still
119  be used by defining AUBIO_UNSTABLE to 1 before including the aubio header:
120
121  \code
122  #define AUBIO_UNSTABLE 1
123  #include <aubio/aubio.h>
124  \endcode
125
126  Future versions of aubio could break API compatibility with these functions
127  without warning. If you choose to use functions in AUBIO_UNSTABLE, you are on
128  your own.
129
130  \section download Download
131
132  Latest versions, further documentation, examples, wiki, and mailing lists can
133  be found at http://aubio.org .
134
135 */
136
137#ifndef AUBIO_H
138#define AUBIO_H
139
140/** @file aubio.h Global aubio include file.
141
142  You will want to include this file as:
143
144  @code
145    #include <aubio/aubio.h>
146  @endcode
147
148  To access headers with unstable prototypes, use:
149
150  @code
151    #define AUBIO_UNSTABLE 1
152    #include <aubio/aubio.h>
153  @endcode
154
155 */
156
157#ifdef __cplusplus
158extern "C"
159{
160#endif
161
162/* in this order */
163#include "types.h"
164#include "fvec.h"
165#include "cvec.h"
166#include "lvec.h"
167#include "fmat.h"
168#include "musicutils.h"
169#include "vecutils.h"
170#include "temporal/resampler.h"
171#include "temporal/filter.h"
172#include "temporal/biquad.h"
173#include "temporal/a_weighting.h"
174#include "temporal/c_weighting.h"
175#include "spectral/fft.h"
176#include "spectral/phasevoc.h"
177#include "spectral/filterbank.h"
178#include "spectral/filterbank_mel.h"
179#include "spectral/mfcc.h"
180#include "spectral/specdesc.h"
181#include "spectral/tss.h"
182#include "pitch/pitch.h"
183#include "onset/onset.h"
184#include "tempo/tempo.h"
185#include "io/source.h"
186#include "io/sink.h"
187#include "io/audio_unit.h"
188#include "synth/sampler.h"
189#include "synth/wavetable.h"
190#include "utils/parameter.h"
191
192#if AUBIO_UNSTABLE
193#include "mathutils.h"
194#include "io/source_sndfile.h"
195#include "io/source_apple_audio.h"
196#include "io/source_avcodec.h"
197#include "io/sink_sndfile.h"
198#include "io/sink_apple_audio.h"
199#include "onset/peakpicker.h"
200#include "pitch/pitchmcomb.h"
201#include "pitch/pitchyin.h"
202#include "pitch/pitchyinfft.h"
203#include "pitch/pitchschmitt.h"
204#include "pitch/pitchfcomb.h"
205#include "pitch/pitchspecacf.h"
206#include "tempo/beattracking.h"
207#include "utils/scale.h"
208#include "utils/hist.h"
209#endif
210
211#ifdef __cplusplus
212} /* extern "C" */
213#endif
214
215#endif
Note: See TracBrowser for help on using the repository browser.