source: doc/index.rst @ 7a8a07e

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 7a8a07e was 7a8a07e, checked in by Paul Brossier <piem@piem.org>, 8 years ago

doc/develop.rst: add some documentation about the c-api

  • Property mode set to 100644
File size: 3.2 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
[e523483]16aubio provides several algorithms and routines, including:
[34abeaf]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
[7a8a07e]42   develop
[34abeaf]43
[a96413e]44Project pages
45=============
[34abeaf]46
[a96413e]47* `Project homepage`_: https://aubio.org
48* `aubio on github`_: https://github.com/aubio/aubio
49* `aubio on pypi`_: https://pypi.python.org/pypi/aubio
[7a8a07e]50* `Doxygen documentation`_: https://aubio.org/doc/latest/
[a96413e]51* `Mailing lists`_: https://lists.aubio.org
[34abeaf]52
[a96413e]53.. _Project homepage: https://aubio.org
54.. _aubio on github: https://github.com/aubio/aubio
55.. _aubio on pypi: https://pypi.python.org/pypi/aubio
[7a8a07e]56.. _Doxygen documentation: https://aubio.org/doc/latest/
[a96413e]57.. _Mailing lists: https://lists.aubio.org/
[34abeaf]58
[a96413e]59Current status
60==============
[34abeaf]61
[a96413e]62.. image:: https://travis-ci.org/aubio/aubio.svg?branch=master
63   :target: https://travis-ci.org/aubio/aubio
64   :alt: Travis build status
[34abeaf]65
[a96413e]66.. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true
67   :target: https://ci.appveyor.com/project/piem/aubio/
68   :alt: Appveyor build status
[34abeaf]69
[a96413e]70.. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat
71   :target: https://landscape.io/github/aubio/aubio/master
72   :alt: Landscape code health
[34abeaf]73
[a96413e]74.. image:: http://readthedocs.org/projects/aubio/badge/?version=latest
75   :target: http://aubio.readthedocs.io/en/latest/?badge=latest
76   :alt: Documentation status
[34abeaf]77
[a96413e]78* `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
79* `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
[e523483]80* `Landscape python code validation <https://landscape.io/github/aubio/aubio/master>`_
[a96413e]81* `ReadTheDocs documentation <http://aubio.readthedocs.io/en/latest/>`_
[34abeaf]82
[a96413e]83Copyright and License
84=====================
[34abeaf]85
[a96413e]86Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
[34abeaf]87
[a96413e]88aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
89<http://www.opensource.org/docs/definition.php>`_ software; **you** can
90redistribute it and/or modify it under the terms of the `GNU
91<http://www.gnu.org/>`_ `General Public License
92<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
93Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
94option) any later version.
[34abeaf]95
[a96413e]96.. Note:: aubio is not MIT or BSD licensed. Contact the author if you need it
97  in your commercial product.
Note: See TracBrowser for help on using the repository browser.