From ae785ea9276667be833c411b283cb242a3f52854 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Sun, 11 Dec 2016 20:03:26 +0100 Subject: [PATCH] doc/cli_features.rst: add matrix of command line features --- doc/cli.rst | 5 +++++ doc/cli_features.rst | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 doc/cli_features.rst diff --git a/doc/cli.rst b/doc/cli.rst index 00026a91..2dc2f070 100644 --- a/doc/cli.rst +++ b/doc/cli.rst @@ -18,6 +18,11 @@ Additionally, the python module comes with the following script: - ``aubiocut`` slices sound files at onset or beat timestamps +.. toctree:: + + cli_features + + ``aubioonset`` -------------- diff --git a/doc/cli_features.rst b/doc/cli_features.rst new file mode 100644 index 00000000..a422798e --- /dev/null +++ b/doc/cli_features.rst @@ -0,0 +1,40 @@ +Command line features +===================== + ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| feat vs. prg | onset | pitch | mfcc | track | notes | quiet | cut1 | short options | ++==============+=======+=======+======+=======+=======+=======+======+==================+ +| input | Y | Y | Y | Y | Y | Y | Y | -i | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| output | Y | Y | N | Y | Y | N | Y!1 | -o,-m,-f | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| Hz/buf/hop | Y | Y | Y | Y | Y | Y!2 | Y | -r,-B-,H | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| jack | Y | Y | N | Y | Y | N!3 | N | -j | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| onset | Y | N | N | Y? | Y!6 | N | Y | -O,-t | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| pitch | N | Y | N | N | Y!6 | N | N!5 | -p,-u,-l | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| silence | Y | Y | N | Y | Y!7 | Y | N!4 | -s | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| timefmt | Y | Y | Y | Y | Y | Y | ! | -T | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| help | Y | Y | Y | Y | Y | Y | Y | -h | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ +| verbose | Y | Y | Y | Y | Y | Y | Y | -v | ++--------------+-------+-------+------+-------+-------+-------+------+------------------+ + +1. ``aubiocut --output`` is used to specify a directory, not a file. + +2. Option ``--bufsize`` is useless for ``aubioquiet`` + +3. ``aubioquiet`` could have a jack output + +4. Regression, re-add slicing at silences to ``aubiocut`` + +5. ``aubiocut`` could cut on notes + +6. New ``aubionotes`` needs onset/pitch setters. + +7. Silence was different for pitch and onset, test. -- 2.11.0