| [88f7cf9] | 1 | Welcome |
|---|
| 2 | ======= |
|---|
| [34abeaf] | 3 | |
|---|
| [88f7cf9] | 4 | aubio is a collection of algorithms and tools to label and transform music and |
|---|
| 5 | sounds. It scans or `listens` to audio signals and attempts to detect musical |
|---|
| 6 | events. For instance, when a drum is hit, at which frequency is a note, or at |
|---|
| 7 | what tempo is a rhythmic melody. |
|---|
| [34abeaf] | 8 | |
|---|
| [88f7cf9] | 9 | aubio features include segmenting a sound file before each of its attacks, |
|---|
| [34abeaf] | 10 | performing pitch detection, tapping the beat and producing midi streams from |
|---|
| 11 | live audio. |
|---|
| 12 | |
|---|
| [e65fbec] | 13 | Quick links |
|---|
| 14 | =========== |
|---|
| [34abeaf] | 15 | |
|---|
| [e65fbec] | 16 | * :ref:`python` |
|---|
| 17 | * :ref:`manpages` |
|---|
| 18 | * :ref:`develop` |
|---|
| 19 | * :ref:`building` |
|---|
| [34abeaf] | 20 | |
|---|
| [275524e] | 21 | .. only:: devel |
|---|
| 22 | |
|---|
| 23 | .. include:: statuslinks.rst |
|---|
| 24 | |
|---|
| [a429d1c] | 25 | Project pages |
|---|
| 26 | ============= |
|---|
| 27 | |
|---|
| 28 | * `Project homepage`_: https://aubio.org |
|---|
| 29 | * `aubio on github`_: https://github.com/aubio/aubio |
|---|
| 30 | * `aubio on pypi`_: https://pypi.python.org/pypi/aubio |
|---|
| 31 | * `Doxygen documentation`_: https://aubio.org/doc/latest/ |
|---|
| 32 | * `Mailing lists`_: https://lists.aubio.org |
|---|
| 33 | |
|---|
| 34 | .. _Project homepage: https://aubio.org |
|---|
| 35 | .. _aubio on github: https://github.com/aubio/aubio |
|---|
| 36 | .. _aubio on pypi: https://pypi.python.org/pypi/aubio |
|---|
| 37 | .. _Doxygen documentation: https://aubio.org/doc/latest/ |
|---|
| 38 | .. _Mailing lists: https://lists.aubio.org/ |
|---|
| 39 | |
|---|
| [a96413e] | 40 | * `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_ |
|---|
| 41 | * `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_ |
|---|
| [e523483] | 42 | * `Landscape python code validation <https://landscape.io/github/aubio/aubio/master>`_ |
|---|
| [a429d1c] | 43 | * `ReadTheDocs documentation <https://aubio.readthedocs.io/en/latest/>`_ |
|---|
| [34abeaf] | 44 | |
|---|
| [e65fbec] | 45 | Features |
|---|
| 46 | ======== |
|---|
| 47 | |
|---|
| 48 | aubio provides several algorithms and routines, including: |
|---|
| 49 | |
|---|
| 50 | - several onset detection methods |
|---|
| 51 | - different pitch detection methods |
|---|
| 52 | - tempo tracking and beat detection |
|---|
| 53 | - MFCC (mel-frequency cepstrum coefficients) |
|---|
| 54 | - FFT and phase vocoder |
|---|
| 55 | - up/down-sampling |
|---|
| 56 | - digital filters (low pass, high pass, and more) |
|---|
| 57 | - spectral filtering |
|---|
| 58 | - transient/steady-state separation |
|---|
| 59 | - sound file read and write access |
|---|
| 60 | - various mathematics utilities for music applications |
|---|
| 61 | |
|---|
| 62 | The name aubio comes from *audio* with a typo: some errors are likely to be |
|---|
| 63 | found in the results. |
|---|
| 64 | |
|---|
| [a429d1c] | 65 | Content |
|---|
| 66 | ======= |
|---|
| 67 | |
|---|
| 68 | .. toctree:: |
|---|
| 69 | :maxdepth: 2 |
|---|
| 70 | |
|---|
| 71 | installing |
|---|
| 72 | python_module |
|---|
| 73 | cli |
|---|
| 74 | develop |
|---|
| [60fdc89] | 75 | about |
|---|
