source: doc/index.rst @ e65fbec

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

doc/index.rst: more shuffling

  • Property mode set to 100644
File size: 3.5 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
[a96413e]21Current status
22==============
[34abeaf]23
[a96413e]24.. image:: https://travis-ci.org/aubio/aubio.svg?branch=master
25   :target: https://travis-ci.org/aubio/aubio
26   :alt: Travis build status
[34abeaf]27
[a96413e]28.. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true
29   :target: https://ci.appveyor.com/project/piem/aubio/
30   :alt: Appveyor build status
[34abeaf]31
[a96413e]32.. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat
33   :target: https://landscape.io/github/aubio/aubio/master
34   :alt: Landscape code health
[34abeaf]35
[55027f3]36.. image:: https://readthedocs.org/projects/aubio/badge/?version=latest
[a429d1c]37   :target: https://aubio.readthedocs.io/en/latest/?badge=latest
[a96413e]38   :alt: Documentation status
[34abeaf]39
[55027f3]40.. image:: https://img.shields.io/github/commits-since/aubio/aubio/0.4.3.svg?maxAge=2592000
41   :target: https://github.com/aubio/aubio
42   :alt: Commits since last release
43
[a429d1c]44Project pages
45=============
46
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
50* `Doxygen documentation`_: https://aubio.org/doc/latest/
51* `Mailing lists`_: https://lists.aubio.org
52
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
56.. _Doxygen documentation: https://aubio.org/doc/latest/
57.. _Mailing lists: https://lists.aubio.org/
58
[a96413e]59* `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
60* `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
[e523483]61* `Landscape python code validation <https://landscape.io/github/aubio/aubio/master>`_
[a429d1c]62* `ReadTheDocs documentation <https://aubio.readthedocs.io/en/latest/>`_
[34abeaf]63
[e65fbec]64Features
65========
66
67aubio provides several algorithms and routines, including:
68
69- several onset detection methods
70- different pitch detection methods
71- tempo tracking and beat detection
72- MFCC (mel-frequency cepstrum coefficients)
73- FFT and phase vocoder
74- up/down-sampling
75- digital filters (low pass, high pass, and more)
76- spectral filtering
77- transient/steady-state separation
78- sound file read and write access
79- various mathematics utilities for music applications
80
81The name aubio comes from *audio* with a typo: some errors are likely to be
82found in the results.
83
84Copyright
85=========
[34abeaf]86
[a96413e]87Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
[34abeaf]88
[e65fbec]89License
90=======
91
[a96413e]92aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
93<http://www.opensource.org/docs/definition.php>`_ software; **you** can
94redistribute it and/or modify it under the terms of the `GNU
[a429d1c]95<https://www.gnu.org/>`_ `General Public License
[a96413e]96<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
97Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
98option) any later version.
[34abeaf]99
[a429d1c]100.. note::
101
102   aubio is not MIT or BSD licensed. Contact the author if you need it in your
103   commercial product.
104
105Content
106=======
107
108.. toctree::
109   :maxdepth: 2
110
111   installing
112   python_module
113   cli
114   develop
Note: See TracBrowser for help on using the repository browser.