doc/index.rst

   1 Welcome
   2 =======
   3
   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.
   8
   9 aubio features include segmenting a sound file before each of its attacks,
  10 performing pitch detection, tapping the beat and producing midi streams from
  11 live audio.
  12
  13 Features
  14 ========
  15
  16 aubio provides 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
  27 - sound file read and write access
  28 - various mathematics utilities for music applications
  29
  30 The name aubio comes from *audio* with a typo: some errors are likely to be
  31 found in the results.
  32
  33 Current status
  34 ==============
  35
  36 .. image:: https://travis-ci.org/aubio/aubio.svg?branch=master
  37    :target: https://travis-ci.org/aubio/aubio
  38    :alt: Travis build status
  39
  40 .. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true
  41    :target: https://ci.appveyor.com/project/piem/aubio/
  42    :alt: Appveyor build status
  43
  44 .. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat
  45    :target: https://landscape.io/github/aubio/aubio/master
  46    :alt: Landscape code health
  47
  48 .. image:: https://readthedocs.org/projects/aubio/badge/?version=latest
  49    :target: https://aubio.readthedocs.io/en/latest/?badge=latest
  50    :alt: Documentation status
  51
  52 .. image:: https://img.shields.io/github/commits-since/aubio/aubio/0.4.3.svg?maxAge=2592000
  53    :target: https://github.com/aubio/aubio
  54    :alt: Commits since last release
  55
  56 Project pages
  57 =============
  58
  59 * `Project homepage`_: https://aubio.org
  60 * `aubio on github`_: https://github.com/aubio/aubio
  61 * `aubio on pypi`_: https://pypi.python.org/pypi/aubio
  62 * `Doxygen documentation`_: https://aubio.org/doc/latest/
  63 * `Mailing lists`_: https://lists.aubio.org
  64
  65 .. _Project homepage: https://aubio.org
  66 .. _aubio on github: https://github.com/aubio/aubio
  67 .. _aubio on pypi: https://pypi.python.org/pypi/aubio
  68 .. _Doxygen documentation: https://aubio.org/doc/latest/
  69 .. _Mailing lists: https://lists.aubio.org/
  70
  71 * `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
  72 * `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
  73 * `Landscape python code validation <https://landscape.io/github/aubio/aubio/master>`_
  74 * `ReadTheDocs documentation <https://aubio.readthedocs.io/en/latest/>`_
  75
  76 Copyright and License
  77 =====================
  78
  79 Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
  80
  81 aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
  82 <http://www.opensource.org/docs/definition.php>`_ software; **you** can
  83 redistribute it and/or modify it under the terms of the `GNU
  84 <https://www.gnu.org/>`_ `General Public License
  85 <https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
  86 Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
  87 option) any later version.
  88
  89 .. note::
  90
  91    aubio is not MIT or BSD licensed. Contact the author if you need it in your
  92    commercial product.
  93
  94 Content
  95 =======
  96
  97 .. toctree::
  98    :maxdepth: 2
  99
 100    installing
 101    python_module
 102    cli
 103    develop