source: doc/index.rst @ 275524e

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

doc/index.rst: include status links for development documentation

  • Property mode set to 100644
File size: 2.7 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
[e65fbec]13Quick 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]25Project 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]45Features
46========
47
48aubio 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
62The name aubio comes from *audio* with a typo: some errors are likely to be
63found in the results.
64
65Copyright
66=========
[34abeaf]67
[a96413e]68Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
[34abeaf]69
[e65fbec]70License
71=======
72
[a96413e]73aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
74<http://www.opensource.org/docs/definition.php>`_ software; **you** can
75redistribute it and/or modify it under the terms of the `GNU
[a429d1c]76<https://www.gnu.org/>`_ `General Public License
[a96413e]77<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
78Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
79option) any later version.
[34abeaf]80
[a429d1c]81.. note::
82
83   aubio is not MIT or BSD licensed. Contact the author if you need it in your
84   commercial product.
85
86Content
87=======
88
89.. toctree::
90   :maxdepth: 2
91
92   installing
93   python_module
94   cli
95   develop
Note: See TracBrowser for help on using the repository browser.