| [70ab9fe] | 1 | aubio |
|---|
| 2 | ===== |
|---|
| 3 | |
|---|
| [598fbb0] | 4 | [](https://circleci.com/gh/aubio/aubio "CircleCI build status") |
|---|
| [3e94f77e] | 5 | [](https://dev.azure.com/aubio/aubio "Azure build status") |
|---|
| [0eca01f] | 6 | [](https://ci.appveyor.com/project/piem/aubio "Appveyor build status") |
|---|
| [fce5bcd7] | 7 | [](https://pypi.org/project/aubio/) |
|---|
| 8 | [](https://anaconda.org/conda-forge/aubio) |
|---|
| [f4dbf64b] | 9 | |
|---|
| 10 | [](http://aubio.readthedocs.io/en/latest/?badge=latest "Latest documentation") |
|---|
| [b678858] | 11 | [](https://zenodo.org/badge/latestdoi/396389) |
|---|
| [245fd51] | 12 | [](https://github.com/aubio/aubio "Commits since last release") |
|---|
| [050a8f3] | 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 |
|---|
| [c3b1a7d] | 33 | - sound file read and write access |
|---|
| [050a8f3] | 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 | |
|---|
| [ac4a6b8] | 39 | Python module |
|---|
| 40 | ------------- |
|---|
| [050a8f3] | 41 | |
|---|
| [c2e2362] | 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/) . |
|---|
| [ac4a6b8] | 45 | |
|---|
| [ede63e3] | 46 | Tools |
|---|
| 47 | ----- |
|---|
| [050a8f3] | 48 | |
|---|
| [067d794] | 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: |
|---|
| [050a8f3] | 55 | |
|---|
| 56 | - `aubioonset` outputs the time stamp of detected note onsets |
|---|
| [ac4a6b8] | 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 |
|---|
| [050a8f3] | 61 | - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration |
|---|
| [ac4a6b8] | 62 | - `aubioquiet` extracts quiet and loud regions |
|---|
| 63 | |
|---|
| [ede63e3] | 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 | |
|---|
| [ac4a6b8] | 70 | The latest version of the documentation can be found at: |
|---|
| 71 | |
|---|
| [f4cc4a8] | 72 | https://aubio.org/documentation |
|---|
| [050a8f3] | 73 | |
|---|
| [c35e701] | 74 | Build Instructions |
|---|
| 75 | ------------------ |
|---|
| [050a8f3] | 76 | |
|---|
| [714ef0d] | 77 | aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS. |
|---|
| [050a8f3] | 78 | |
|---|
| [4e2173e] | 79 | To compile aubio, you should be able to simply run: |
|---|
| [c35e701] | 80 | |
|---|
| [4e2173e] | 81 | make |
|---|
| [c35e701] | 82 | |
|---|
| [4e2173e] | 83 | To compile the python module: |
|---|
| [c35e701] | 84 | |
|---|
| [4e2173e] | 85 | ./setup.py build |
|---|
| [c35e701] | 86 | |
|---|
| [7a2666f] | 87 | See the [manual](https://aubio.org/manual/latest/) for more information about |
|---|
| 88 | [installing aubio](https://aubio.org/manual/latest/installing.html). |
|---|
| [c35e701] | 89 | |
|---|
| [7a2666f] | 90 | Citation |
|---|
| 91 | -------- |
|---|
| [050a8f3] | 92 | |
|---|
| [f4dbf64b] | 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/). |
|---|
| [050a8f3] | 97 | |
|---|
| [ede63e3] | 98 | Homepage |
|---|
| 99 | -------- |
|---|
| [050a8f3] | 100 | |
|---|
| [f4cc4a8] | 101 | The home page of this project can be found at: https://aubio.org/ |
|---|
| [050a8f3] | 102 | |
|---|
| [ede63e3] | 103 | License |
|---|
| 104 | ------- |
|---|
| [050a8f3] | 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. |
|---|
| [ede63e3] | 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. |
|---|
