shithub: aubio

ref: fcb6e8c8b48b215994d2b07d803a773643123c4d
dir: /doc/cli_features.rst/

View raw version
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!8  |  Y!6  |   N   |  Y   | -O,-t,-M         |
+--------------+-------+-------+------+-------+-------+-------+------+------------------+
| 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. ``aubionotes`` needs onset/pitch setters.

7. Silence was different for pitch and onset, test.

8. Some ``aubiotrack`` options should be disabled (minioi, threshold).