source: README.md @ d8e78e6

feature/cnnfeature/crepefix/ffmpeg5
Last change on this file since d8e78e6 was d8e78e6, checked in by Paul Brossier <piem@piem.org>, 2 years ago

[README] remove travis badge

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