source: README.md @ 1dfe409

feature/autosink
Last change on this file since 1dfe409 was 3398a2e, checked in by Paul Brossier <piem@piem.org>, 10 months ago

[README] remove landscape icon

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