source: doc/index.rst @ a96413e

Last change on this file since a96413e was a96413e, checked in by Paul Brossier <>, 3 years ago

doc/index.rst: clean up and add some external links

  • Property mode set to 100644
File size: 3.1 KB
[88f7cf9]4aubio is a collection of algorithms and tools to label and transform music and
5sounds. It scans or `listens` to audio signals and attempts to detect musical
6events. For instance, when a drum is hit, at which frequency is a note, or at
7what tempo is a rhythmic melody.
[88f7cf9]9aubio features include segmenting a sound file before each of its attacks,
[34abeaf]10performing pitch detection, tapping the beat and producing midi streams from
11live audio.
[34abeaf]16aubio provide several algorithms and routines, including:
18- several onset detection methods
19- different pitch detection methods
20- tempo tracking and beat detection
21- MFCC (mel-frequency cepstrum coefficients)
22- FFT and phase vocoder
23- up/down-sampling
24- digital filters (low pass, high pass, and more)
25- spectral filtering
26- transient/steady-state separation
[88f7cf9]27- sound file read and write access
[34abeaf]28- various mathematics utilities for music applications
30The name aubio comes from *audio* with a typo: some errors are likely to be
31found in the results.
[a96413e]36.. toctree::
37   :maxdepth: 2
[a96413e]39   installing
40   cli
41   python_module
[a96413e]43Project pages
[a96413e]46* `Project homepage`_:
47* `aubio on github`_:
48* `aubio on pypi`_:
49* `API documentation`_:
50* `Mailing lists`_:
[a96413e]52.. _Project homepage:
53.. _aubio on github:
54.. _aubio on pypi:
55.. _api documentation:
56.. _Mailing lists:
[a96413e]58Current status
[a96413e]61.. image::
62   :target:
63   :alt: Travis build status
[a96413e]65.. image::
66   :target:
67   :alt: Appveyor build status
[a96413e]69.. image::
70   :target:
71   :alt: Landscape code health
[a96413e]73.. image::
74   :target:
75   :alt: Documentation status
[a96413e]77* `Travis Continuous integration page <>`_
78* `Appveyor Continuous integration page <>`_
79* `ReadTheDocs documentation <>`_
[a96413e]81Copyright and License
[a96413e]84Copyright © 2003-2016 Paul Brossier <>
[a96413e]86aubio is a `free <>`_ and `open source
87<>`_ software; **you** can
88redistribute it and/or modify it under the terms of the `GNU
89<>`_ `General Public License
90<>`_ as published by the `Free Software
91Foundation <>`_, either version 3 of the License, or (at your
92option) any later version.
[a96413e]94.. Note:: aubio is not MIT or BSD licensed. Contact the author if you need it
95  in your commercial product.
Note: See TracBrowser for help on using the repository browser.