[io] prevent possible crash on empty string in source_apple_audio
[aubio.git] / doc / cli_features.rst
1 Command line features
2 ---------------------
3
4 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
5 | feat vs. prg | onset | pitch | mfcc | track | notes | quiet | cut1 | short options    |
6 +==============+=======+=======+======+=======+=======+=======+======+==================+
7 | input        |   Y   |   Y   |  Y   |   Y   |   Y   |   Y   |  Y   | -i               |
8 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
9 | output       |   Y   |   Y   |  N   |   Y   |   Y   |   N   | Y!1  | -o,-m,-f         |
10 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
11 | Hz/buf/hop   |   Y   |   Y   |  Y   |   Y   |   Y   |  Y!2  |  Y   | -r,-B-,H         |
12 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
13 | jack         |   Y   |   Y   |  N   |   Y   |   Y   |  N!3  |  N   | -j               |
14 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
15 | onset        |   Y   |   N   |  N   |  Y!8  |  Y!6  |   N   |  Y   | -O,-t,-M         |
16 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
17 | pitch        |   N   |   Y   |  N   |   N   |  Y!6  |   N   | N!5  | -p,-u,-l         |
18 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
19 | silence      |   Y   |   Y   |  N   |   Y   |  Y!7  |   Y   | N!4  | -s               |
20 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
21 | timefmt      |   Y   |   Y   |  Y   |   Y   |   Y   |   Y   |  !   | -T               |
22 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
23 | help         |   Y   |   Y   |  Y   |   Y   |   Y   |   Y   |  Y   | -h               |
24 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
25 | verbose      |   Y   |   Y   |  Y   |   Y   |   Y   |   Y   |  Y   | -v               |
26 +--------------+-------+-------+------+-------+-------+-------+------+------------------+
27
28 1. ``aubiocut --output`` is used to specify a directory, not a file.
29
30 2. Option ``--bufsize`` is useless for ``aubioquiet``
31
32 3. ``aubioquiet`` could have a jack output
33
34 4. Regression, re-add slicing at silences to ``aubiocut``
35
36 5. ``aubiocut`` could cut on notes
37
38 6. ``aubionotes`` needs onset/pitch setters.
39
40 7. Silence was different for pitch and onset, test.
41
42 8. Some ``aubiotrack`` options should be disabled (minioi, threshold).