From 2f965e2f8a57966608e7328cd6bebb0459baf617 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Sat, 27 Aug 2016 00:39:10 +0200 Subject: [PATCH] doc/cli.rst: include command line manpages --- doc/cli.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 doc/cli.rst diff --git a/doc/cli.rst b/doc/cli.rst new file mode 100644 index 00000000..00026a91 --- /dev/null +++ b/doc/cli.rst @@ -0,0 +1,54 @@ +.. _manpages: + +Command line tools +================== + +A few simple command line tools are included along with the library. + + - ``aubioonset`` outputs the time stamp of detected note onsets + - ``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 + - ``aubioquiet`` extracts quiet and loud regions + +Additionally, the python module comes with the following script: + + - ``aubiocut`` slices sound files at onset or beat timestamps + + +``aubioonset`` +-------------- + +.. literalinclude:: aubioonset.txt + +``aubiopitch`` +-------------- + +.. literalinclude:: aubiopitch.txt + +``aubiomfcc`` +-------------- + +.. literalinclude:: aubiomfcc.txt + +``aubiotrack`` +-------------- + +.. literalinclude:: aubiotrack.txt + +``aubionotes`` +-------------- + +.. literalinclude:: aubionotes.txt + +``aubioquiet`` +-------------- + +.. literalinclude:: aubioquiet.txt + +``aubiocut`` +-------------- + +.. literalinclude:: aubiocut.txt -- 2.11.0