README.md

   1 aubio library
   2 =============
   3
   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.
   7
   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
  10 live audio.
  11
  12 aubio provide several algorithms and routines, including:
  13
  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
  19   - up/down-sampling
  20   - digital filters (low pass, high pass, and more)
  21   - spectral filtering
  22   - transient/steady-state separation
  23   - sound file and audio devices read and write access
  24   - various mathematics utilities for music applications
  25
  26 The name aubio comes from _audio_ with a typo: some errors are likely to be
  27 found in the results.
  28
  29 Python module
  30 -------------
  31
  32 A python module to access the library functions is also provided. Please see
  33 the file [`python/README.md`](python/README.md) for more information on how to
  34 use it.
  35
  36 Examples tools
  37 --------------
  38
  39 A few simple command line tools are included along with the library:
  40
  41  - `aubioonset` outputs the time stamp of detected note onsets
  42  - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for
  43    each frame of the input sound
  44  - `aubiomfcc` computes Mel-frequency Cepstrum Coefficients
  45  - `aubiotrack` outputs the time stamp of detected beats
  46  - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
  47  - `aubioquiet` extracts quiet and loud regions
  48
  49 Additionally, the python module comes with the following script:
  50
  51  - `aubiocut` slices sound files at onset or beat timestamps
  52
  53 Implementation and Design Basics
  54 --------------------------------
  55
  56 The library is written in C and is optimised for speed and portability.
  57
  58 The C API is designed in the following way:
  59
  60     aubio_something_t * new_aubio_something (void * args);
  61     audio_something_do (aubio_something_t * t, void * args);
  62     smpl_t aubio_something_get_a_parameter (aubio_something_t *t);
  63     uint_t aubio_something_set_a_parameter (aubio_something_t *t, smpl_t a_parameter);
  64     void del_aubio_something (aubio_something_t * t);
  65
  66 For performance and real-time operation, no memory allocation or freeing take
  67 place in the `_do` methods. Instead, memory allocation should always take place
  68 in the `new_` methods, whereas free operations are done in the `del_` methods.
  69
  70 The latest version of the documentation can be found at:
  71
  72   https://aubio.org/documentation
  73
  74 Build Instructions
  75 ------------------
  76
  77 A number of distributions already include aubio. Check your favorite package
  78 management system, or have a look at the [download
  79 page](https://aubio.org/download).
  80
  81 aubio uses [waf](https://waf.io/) to configure, compile, and test the source:
  82
  83     ./waf configure
  84     ./waf build
  85
  86 If waf is not found in the directory, you can download and install it with:
  87
  88     make getwaf
  89
  90 aubio compiles on Linux, Mac OS X, Cygwin, and iOS.
  91
  92 Installation
  93 ------------
  94
  95 To install aubio library and headers on your system, use:
  96
  97     sudo ./waf install
  98
  99 To uninstall:
 100
 101     sudo ./waf uninstall
 102
 103 If you don't have root access to install libaubio on your system, you can use
 104 libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
 105 copying it to `~/lib`.
 106
 107 On Linux, you should be able to set `LD_LIBRARY_PATH` with:
 108
 109     $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
 110
 111 On Mac OS X, a copy or a symlink can be made in `~/lib`:
 112
 113     $ mkdir -p ~/lib
 114     $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
 115
 116 Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
 117 variable can be set as follows:
 118
 119     $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
 120
 121 Credits and Publications
 122 ------------------------
 123
 124 This library gathers music signal processing algorithms designed at the Centre
 125 for Digital Music and elsewhere. This software project was developed along the
 126 research I did at the Centre for Digital Music, Queen Mary, University of
 127 London. Most of this C code was written by myself, starting from published
 128 papers and existing code. The header files of each algorithm contains brief
 129 descriptions and references to the corresponding papers.
 130
 131 Special thanks go Juan Pablo Bello, Chris Duxbury, Samer Abdallah, Alain de
 132 Cheveigne for their help and publications. Also many thanks to Miguel Ramirez
 133 and Nicolas Wack for their bug fixing.
 134
 135 Substantial informations about the algorithms and their evaluation are gathered
 136 in:
 137
 138   - Paul Brossier, _[Automatic annotation of musical audio for interactive
 139     systems](https://aubio.org/phd)_, PhD thesis, Centre for Digital music,
 140 Queen Mary University of London, London, UK, 2006.
 141
 142 Additional results obtained with this software were discussed in the following
 143 papers:
 144
 145   - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Real-time temporal
 146     segmentation of note objects in music signals](https://aubio.org/articles/brossier04fastnotes.pdf),
 147 in _Proceedings of the International Computer Music Conference_, 2004, Miami,
 148 Florida, ICMA
 149
 150   -  P. M. Brossier and J. P. Bello and M. D. Plumbley, [Fast labelling of note
 151      objects in music signals] (https://aubio.org/articles/brossier04fastnotes.pdf),
 152 in _Proceedings of the International Symposium on Music Information Retrieval_,
 153 2004, Barcelona, Spain
 154
 155
 156 Contact Info and Mailing List
 157 -----------------------------
 158
 159 The home page of this project can be found at: https://aubio.org/
 160
 161 Questions, comments, suggestions, and contributions are welcome. Use the
 162 mailing list: <aubio-user@aubio.org>.
 163
 164 To subscribe to the list, use the mailman form:
 165 http://lists.aubio.org/listinfo/aubio-user/
 166
 167 Alternatively, feel free to contact directly the author.
 168
 169
 170 Copyright and License Information
 171 ---------------------------------
 172
 173 Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
 174
 175 aubio is free software: you can redistribute it and/or modify it under the
 176 terms of the GNU General Public License as published by the Free Software
 177 Foundation, either version 3 of the License, or (at your option) any later
 178 version.