source: doc/cli.rst

Last change on this file was e3c83bb, checked in by Paul Brossier <piem@piem.org>, 7 years ago

doc/cli.rst: revamp

  • Property mode set to 100644
File size: 1.4 KB
RevLine 
[2f965e2]1.. _manpages:
2
3Command line tools
4==================
5
[e3c83bb]6The python module comes with the following tools:
7
8 - ``aubio`` estimate and extract descriptors from sound files
9 - ``aubiocut`` slices sound files at onset or beat timestamps
10
11More command line tools are included along with the library.
[2f965e2]12
13 - ``aubioonset`` outputs the time stamp of detected note onsets
14 - ``aubiopitch`` attempts to identify a fundamental frequency, or pitch, for
15   each frame of the input sound
16 - ``aubiomfcc`` computes Mel-frequency Cepstrum Coefficients
17 - ``aubiotrack`` outputs the time stamp of detected beats
18 - ``aubionotes`` emits midi-like notes, with an onset, a pitch, and a duration
19 - ``aubioquiet`` extracts quiet and loud regions
20
21
[e3c83bb]22``aubio``
23---------
[2f965e2]24
[e3c83bb]25.. literalinclude:: aubio.txt
26   :language: text
[2f965e2]27
[ae785ea]28
[e3c83bb]29``aubiocut``
30--------------
31
32.. literalinclude:: aubiocut.txt
33   :language: text
[ae785ea]34
35
[2f965e2]36``aubioonset``
37--------------
38
39.. literalinclude:: aubioonset.txt
[e3c83bb]40   :language: text
[2f965e2]41
42``aubiopitch``
43--------------
44
45.. literalinclude:: aubiopitch.txt
[e3c83bb]46   :language: text
[2f965e2]47
48``aubiomfcc``
49--------------
50
51.. literalinclude:: aubiomfcc.txt
[e3c83bb]52   :language: text
[2f965e2]53
54``aubiotrack``
55--------------
56
57.. literalinclude:: aubiotrack.txt
[e3c83bb]58   :language: text
[2f965e2]59
60``aubionotes``
61--------------
62
63.. literalinclude:: aubionotes.txt
[e3c83bb]64   :language: text
[2f965e2]65
66``aubioquiet``
67--------------
68
69.. literalinclude:: aubioquiet.txt
[e3c83bb]70   :language: text
[2f965e2]71
72
[e3c83bb]73.. include:: cli_features.rst
Note: See TracBrowser for help on using the repository browser.