source: doc/index.rst @ a96413e

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

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

  • Property mode set to 100644
File size: 3.1 KB
RevLine 
[88f7cf9]1Welcome
2=======
[34abeaf]3
[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.
[34abeaf]8
[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.
12
[a96413e]13Features
14========
15
[34abeaf]16aubio provide several algorithms and routines, including:
17
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
29
30The name aubio comes from *audio* with a typo: some errors are likely to be
31found in the results.
32
[a96413e]33Content
34=======
[34abeaf]35
[a96413e]36.. toctree::
37   :maxdepth: 2
[34abeaf]38
[a96413e]39   installing
40   cli
41   python_module
[34abeaf]42
[a96413e]43Project pages
44=============
[34abeaf]45
[a96413e]46* `Project homepage`_: https://aubio.org
47* `aubio on github`_: https://github.com/aubio/aubio
48* `aubio on pypi`_: https://pypi.python.org/pypi/aubio
49* `API documentation`_: https://aubio.org/doc/latest/
50* `Mailing lists`_: https://lists.aubio.org
[34abeaf]51
[a96413e]52.. _Project homepage: https://aubio.org
53.. _aubio on github: https://github.com/aubio/aubio
54.. _aubio on pypi: https://pypi.python.org/pypi/aubio
55.. _api documentation: https://aubio.org/doc/latest/
56.. _Mailing lists: https://lists.aubio.org/
[34abeaf]57
[a96413e]58Current status
59==============
[34abeaf]60
[a96413e]61.. image:: https://travis-ci.org/aubio/aubio.svg?branch=master
62   :target: https://travis-ci.org/aubio/aubio
63   :alt: Travis build status
[34abeaf]64
[a96413e]65.. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true
66   :target: https://ci.appveyor.com/project/piem/aubio/
67   :alt: Appveyor build status
[34abeaf]68
[a96413e]69.. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat
70   :target: https://landscape.io/github/aubio/aubio/master
71   :alt: Landscape code health
[34abeaf]72
[a96413e]73.. image:: http://readthedocs.org/projects/aubio/badge/?version=latest
74   :target: http://aubio.readthedocs.io/en/latest/?badge=latest
75   :alt: Documentation status
[34abeaf]76
[a96413e]77* `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
78* `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
79* `ReadTheDocs documentation <http://aubio.readthedocs.io/en/latest/>`_
[34abeaf]80
[a96413e]81Copyright and License
82=====================
[34abeaf]83
[a96413e]84Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
[34abeaf]85
[a96413e]86aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
87<http://www.opensource.org/docs/definition.php>`_ software; **you** can
88redistribute it and/or modify it under the terms of the `GNU
89<http://www.gnu.org/>`_ `General Public License
90<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
91Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
92option) any later version.
[34abeaf]93
[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.