4 aubio is a library to label music and sounds. It listens to audio signals and
5 attempts to detect events. For instance, when a drum is hit, at which frequency
6 is a note, or at what tempo is a rhythmic melody.
8 Its features include segmenting a sound file before each of its attacks,
9 performing pitch detection, tapping the beat and producing midi streams from
12 aubio provide several algorithms and routines, including:
14 - several onset detection methods
15 - different pitch detection methods
16 - tempo tracking and beat detection
17 - MFCC (mel-frequency cepstrum coefficients)
18 - FFT and phase vocoder
20 - digital filters (low pass, high pass, and more)
22 - transient/steady-state separation
23 - sound file and audio devices read and write access
24 - various mathematics utilities for music applications
26 The name aubio comes from _audio_ with a typo: some errors are likely to be
32 A python module to access the library functions is also provided. Please see
33 the file `python/README` for more information on how to use it.
38 A few simple command line tools are included along with the library:
40 - `aubioonset` outputs the time stamp of detected note onsets
41 - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for
42 each frame of the input sound
43 - `aubiomfcc` computes Mel-frequency Cepstrum Coefficients
44 - `aubiotrack` outputs the time stamp of detected beats
45 - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
46 - `aubioquiet` extracts quiet and loud regions
48 Additionally, the python module comes with the following script:
50 - `aubiocut` slices sound files at onset or beat timestamps
52 Implementation and Design Basics
53 --------------------------------
55 The library is written in C and is optimised for speed and portability.
57 The C API is designed in the following way:
59 aubio_something_t * new_aubio_something (void * args);
60 audio_something_do (aubio_something_t * t, void * args);
61 smpl_t aubio_something_get_a_parameter (aubio_something_t *t);
62 uint_t aubio_something_set_a_parameter (aubio_something_t *t, smpl_t a_parameter);
63 void del_aubio_something (aubio_something_t * t);
65 For performance and real-time operation, no memory allocation or freeing take
66 place in the `_do` methods. Instead, memory allocation should always take place
67 in the `new_` methods, whereas free operations are done in the `del_` methods.
69 The latest version of the documentation can be found at:
71 https://aubio.org/documentation
76 A number of distributions already include aubio. Check your favorite package
77 management system, or have a look at the [download
78 page](https://aubio.org/download).
80 aubio uses [waf](https://waf.io/) to configure, compile, and test the source:
85 If waf is not found in the directory, you can download and install it with:
89 aubio compiles on Linux, Mac OS X, Cygwin, and iOS.
94 To install aubio library and headers on your system, use:
102 If you don't have root access to install libaubio on your system, you can use
103 libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
104 copying it to `~/lib`.
106 On Linux, you should be able to set `LD_LIBRARY_PATH` with:
108 $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
110 On Mac OS X, a copy or a symlink can be made in `~/lib`:
113 $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
115 Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
116 variable can be set as follows:
118 $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
120 Credits and Publications
121 ------------------------
123 This library gathers music signal processing algorithms designed at the Centre
124 for Digital Music and elsewhere. This software project was developed along the
125 research I did at the Centre for Digital Music, Queen Mary, University of
126 London. Most of this C code was written by myself, starting from published
127 papers and existing code. The header files of each algorithm contains brief
128 descriptions and references to the corresponding papers.
130 Special thanks go Juan Pablo Bello, Chris Duxbury, Samer Abdallah, Alain de
131 Cheveigne for their help and publications. Also many thanks to Miguel Ramirez
132 and Nicolas Wack for their bug fixing.
134 Substantial informations about the algorithms and their evaluation are gathered
137 - Paul Brossier, _[Automatic annotation of musical audio for interactive
138 systems](https://aubio.org/phd)_, PhD thesis, Centre for Digital music,
139 Queen Mary University of London, London, UK, 2006.
141 Additional results obtained with this software were discussed in the following
144 - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Real-time temporal
145 segmentation of note objects in music signals](https://aubio.org/articles/brossier04fastnotes.pdf),
146 in _Proceedings of the International Computer Music Conference_, 2004, Miami,
149 - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Fast labelling of note
150 objects in music signals] (https://aubio.org/articles/brossier04fastnotes.pdf),
151 in _Proceedings of the International Symposium on Music Information Retrieval_,
152 2004, Barcelona, Spain
155 Contact Info and Mailing List
156 -----------------------------
158 The home page of this project can be found at: https://aubio.org/
160 Questions, comments, suggestions, and contributions are welcome. Use the
161 mailing list: <aubio-user@aubio.org>.
163 To subscribe to the list, use the mailman form:
164 http://lists.aubio.org/listinfo/aubio-user/
166 Alternatively, feel free to contact directly the author.
169 Copyright and License Information
170 ---------------------------------
172 Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
174 aubio is free software: you can redistribute it and/or modify it under the
175 terms of the GNU General Public License as published by the Free Software
176 Foundation, either version 3 of the License, or (at your option) any later