README.md

   1 aubio
   2 =====
   3
   4 [![CircleCI build status](https://circleci.com/gh/aubio/aubio.svg?style=shield)](https://circleci.com/gh/aubio/aubio "CircleCI build status")
   5 [![Azure Pipelines](https://dev.azure.com/aubio/aubio/_apis/build/status/aubio.aubio)](https://dev.azure.com/aubio/aubio "Azure build status")
   6 [![Appveyor build status](https://img.shields.io/appveyor/ci/piem/aubio/master.svg)](https://ci.appveyor.com/project/piem/aubio "Appveyor build status")
   7 [![Pypi Downloads](https://img.shields.io/pypi/dm/aubio.svg?label=Pypi%20downloads)](https://pypi.org/project/aubio/)
   8 [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/aubio.svg?label=Conda%20downloads)](https://anaconda.org/conda-forge/aubio)
   9
  10 [![Documentation](https://readthedocs.org/projects/aubio/badge/?version=latest)](http://aubio.readthedocs.io/en/latest/?badge=latest "Latest documentation")
  11 [![DOI](https://zenodo.org/badge/396389.svg)](https://zenodo.org/badge/latestdoi/396389)
  12 [![Commits since last release](https://img.shields.io/github/commits-since/aubio/aubio/latest.svg)](https://github.com/aubio/aubio "Commits since last release")
  13
  14 aubio is a library to label music and sounds. It listens to audio signals and
  15 attempts to detect events. For instance, when a drum is hit, at which frequency
  16 is a note, or at what tempo is a rhythmic melody.
  17
  18 Its features include segmenting a sound file before each of its attacks,
  19 performing pitch detection, tapping the beat and producing midi streams from
  20 live audio.
  21
  22 aubio provide several algorithms and routines, including:
  23
  24   - several onset detection methods
  25   - different pitch detection methods
  26   - tempo tracking and beat detection
  27   - MFCC (mel-frequency cepstrum coefficients)
  28   - FFT and phase vocoder
  29   - up/down-sampling
  30   - digital filters (low pass, high pass, and more)
  31   - spectral filtering
  32   - transient/steady-state separation
  33   - sound file read and write access
  34   - various mathematics utilities for music applications
  35
  36 The name aubio comes from _audio_ with a typo: some errors are likely to be
  37 found in the results.
  38
  39 Python module
  40 -------------
  41
  42 A python module for aubio is provided. For more information on how to use it,
  43 please see the file [`python/README.md`](python/README.md) and the
  44 [manual](https://aubio.org/manual/latest/) .
  45
  46 Tools
  47 -----
  48
  49 The python module comes with the following command line tools:
  50
  51  - `aubio` extracts informations from sound files
  52  - `aubiocut` slices sound files at onset or beat timestamps
  53
  54 Additional command line tools are included along with the library:
  55
  56  - `aubioonset` outputs the time stamp of detected note onsets
  57  - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for
  58    each frame of the input sound
  59  - `aubiomfcc` computes Mel-frequency Cepstrum Coefficients
  60  - `aubiotrack` outputs the time stamp of detected beats
  61  - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
  62  - `aubioquiet` extracts quiet and loud regions
  63
  64 Documentation
  65 -------------
  66
  67   - [manual](https://aubio.org/manual/latest/), generated with sphinx
  68   - [developer documentation](https://aubio.org/doc/latest/), generated with Doxygen
  69
  70 The latest version of the documentation can be found at:
  71
  72   https://aubio.org/documentation
  73
  74 Build Instructions
  75 ------------------
  76
  77 aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
  78
  79 To compile aubio, you should be able to simply run:
  80
  81     make
  82
  83 To compile the python module:
  84
  85     ./setup.py build
  86
  87 See the [manual](https://aubio.org/manual/latest/) for more information about
  88 [installing aubio](https://aubio.org/manual/latest/installing.html).
  89
  90 Citation
  91 --------
  92
  93 Please use the DOI link above to cite this release in your publications. For
  94 more information, see also the [about
  95 page](https://aubio.org/manual/latest/about.html) in [aubio
  96 manual](https://aubio.org/manual/latest/).
  97
  98 Homepage
  99 --------
 100
 101 The home page of this project can be found at: https://aubio.org/
 102
 103 License
 104 -------
 105
 106 aubio is free software: you can redistribute it and/or modify it under the
 107 terms of the GNU General Public License as published by the Free Software
 108 Foundation, either version 3 of the License, or (at your option) any later
 109 version.
 110
 111 Contributing
 112 ------------
 113
 114 Patches are welcome: please fork the latest git repository and create a feature
 115 branch. Submitted requests should pass all continuous integration tests.