source: README.md @ 067d794

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5sampler
Last change on this file since 067d794 was 067d794, checked in by Paul Brossier <piem@piem.org>, 7 years ago

README.md: update list of command line tools

  • Property mode set to 100644
File size: 5.4 KB
Line 
1aubio
2=====
3
4[![Travis build status](https://travis-ci.org/aubio/aubio.svg?branch=master)](https://travis-ci.org/aubio/aubio "Travis build status")
5[![Appveyor build status](https://img.shields.io/appveyor/ci/piem/aubio/master.svg)](https://ci.appveyor.com/project/piem/aubio "Appveyor build status")
6[![Landscape code health](https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat)](https://landscape.io/github/aubio/aubio/master "Landscape code health")
7[![Documentation Status](https://readthedocs.org/projects/aubio/badge/?version=latest)](http://aubio.readthedocs.io/en/latest/?badge=latest "Documentation status")
8[![Commits since last release](https://img.shields.io/github/commits-since/aubio/aubio/0.4.4.svg)](https://github.com/aubio/aubio "Commits since last release")
9[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.438682.svg)](https://doi.org/10.5281/zenodo.438682)
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
30  - sound file read and write access
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
36Python module
37-------------
38
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/) .
42
43Examples tools
44--------------
45
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:
52
53 - `aubioonset` outputs the time stamp of detected note onsets
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
58 - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
59 - `aubioquiet` extracts quiet and loud regions
60
61The latest version of the documentation can be found at:
62
63  https://aubio.org/documentation
64
65Build Instructions
66------------------
67
68aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
69
70To compile aubio, you should be able to simply run:
71
72    make
73
74To compile the python module:
75
76    ./setup.py build
77
78See also the [manual](https://aubio.org/manual/latest/) for more information
79about [installing aubio](https://aubio.org/manual/latest/installing.html).
80
81Credits and Publications
82------------------------
83
84This library gathers music signal processing algorithms designed at the Centre
85for Digital Music and elsewhere. This software project was developed along the
86research I did at the Centre for Digital Music, Queen Mary, University of
87London. Most of this C code was written by myself, starting from published
88papers and existing code. The header files of each algorithm contains brief
89descriptions and references to the corresponding papers.
90
91Special thanks go Juan Pablo Bello, Chris Duxbury, Samer Abdallah, Alain de
92Cheveigne for their help and publications. Also many thanks to Miguel Ramirez
93and Nicolas Wack for their bug fixing.
94
95Substantial informations about the algorithms and their evaluation are gathered
96in:
97
98  - Paul Brossier, _[Automatic annotation of musical audio for interactive
99    systems](https://aubio.org/phd)_, PhD thesis, Centre for Digital music,
100Queen Mary University of London, London, UK, 2006.
101
102Additional results obtained with this software were discussed in the following
103papers:
104
105  - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Real-time temporal
106    segmentation of note objects in music signals](https://aubio.org/articles/brossier04fastnotes.pdf),
107in _Proceedings of the International Computer Music Conference_, 2004, Miami,
108Florida, ICMA
109
110  -  P. M. Brossier and J. P. Bello and M. D. Plumbley, [Fast labelling of note
111     objects in music signals] (https://aubio.org/articles/brossier04fastnotes.pdf),
112in _Proceedings of the International Symposium on Music Information Retrieval_,
1132004, Barcelona, Spain
114
115
116Contact Info and Mailing List
117-----------------------------
118
119The home page of this project can be found at: https://aubio.org/
120
121Questions, comments, suggestions, and contributions are welcome. Use the
122mailing list: <aubio-user@aubio.org>.
123
124To subscribe to the list, use the mailman form:
125https://lists.aubio.org/listinfo/aubio-user/
126
127Alternatively, feel free to contact directly the author.
128
129
130Copyright and License Information
131---------------------------------
132
133Copyright (C) 2003-2016 Paul Brossier <piem@aubio.org>
134
135aubio is free software: you can redistribute it and/or modify it under the
136terms of the GNU General Public License as published by the Free Software
137Foundation, either version 3 of the License, or (at your option) any later
138version.
Note: See TracBrowser for help on using the repository browser.