ref: ae785ea9276667be833c411b283cb242a3f52854
parent: 5a19f33bb07417f08bf164d45412d4c143d12175
author: Paul Brossier <piem@piem.org>
date: Sun Dec 11 15:03:26 EST 2016
doc/cli_features.rst: add matrix of command line features
--- a/doc/cli.rst
+++ b/doc/cli.rst
@@ -18,6 +18,11 @@
- ``aubiocut`` slices sound files at onset or beat timestamps
+.. toctree::
+
+ cli_features
+
+
``aubioonset``
--------------
--- /dev/null
+++ b/doc/cli_features.rst
@@ -1,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.