From ac4a6b8f65151cbbfa9a98ef6b24cd373802dee8 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Fri, 3 Jan 2014 19:14:00 -0400 Subject: [PATCH] README.md: improve --- README.md | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 00bbdbca..ab56a195 100644 --- a/README.md +++ b/README.md @@ -26,21 +26,33 @@ aubio provide several algorithms and routines, including: The name aubio comes from _audio_ with a typo: some errors are likely to be found in the results. +Python module +------------- -Implementation and Design Basics --------------------------------- +A python module to access the library functions is also provided. Please see +the file `python/README` for more information on how to use it. + +Examples tools +-------------- -The library is written in C and is optimised for speed and portability. A -python module to access the library functions is also provided. A few simple -applications are included along with the library: +A few simple command line tools are included along with the library: - `aubioonset` outputs the time stamp of detected note onsets - - `aubiotempo` does the same for the tempo + - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for + each frame of the input sound + - `aubiomfcc` computes Mel-frequency Cepstrum Coefficients + - `aubiotrack` outputs the time stamp of detected beats - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration - - `aubiocut` slices an input sound and cuts it in several smaller files, sliced - at each detected onset or beat - - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for each - frame of the input sound + - `aubioquiet` extracts quiet and loud regions + +Additionaly, the python module comes with the following script: + + - `aubiocut` slices sound files at onset or beat timestamps + +Implementation and Design Basics +-------------------------------- + +The library is written in C and is optimised for speed and portability. The C API is designed in the following way: @@ -54,6 +66,9 @@ For performance and real-time operation, no memory allocation or freeing take place in the `_do` methods. Instead, memory allocation should always take place in the `new_` methods, whereas free operations are done in the `del_` methods. +The latest version of the documentation can be found at: + + http://aubio.org/documentation Installation and Build Instructions ----------------------------------- @@ -71,7 +86,6 @@ test the source: aubio compiles on Linux, Mac OS X, Cygwin, and iPhone. - Credits and Publications ------------------------ -- 2.11.0