doc/cli_features.rst: add matrix of command line features
authorPaul Brossier <piem@piem.org>
Sun, 11 Dec 2016 19:03:26 +0000 (20:03 +0100)
committerPaul Brossier <piem@piem.org>
Sun, 11 Dec 2016 19:03:26 +0000 (20:03 +0100)
doc/cli.rst
doc/cli_features.rst [new file with mode: 0644]

index 00026a9..2dc2f07 100644 (file)
@@ -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 (file)
index 0000000..a422798
--- /dev/null
@@ -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.