doc/cli.rst

   1 .. _manpages:
   2
   3 Command line tools
   4 ==================
   5
   6 A few simple command line tools are included along with the library.
   7
   8  - ``aubioonset`` outputs the time stamp of detected note onsets
   9  - ``aubiopitch`` attempts to identify a fundamental frequency, or pitch, for
  10    each frame of the input sound
  11  - ``aubiomfcc`` computes Mel-frequency Cepstrum Coefficients
  12  - ``aubiotrack`` outputs the time stamp of detected beats
  13  - ``aubionotes`` emits midi-like notes, with an onset, a pitch, and a duration
  14  - ``aubioquiet`` extracts quiet and loud regions
  15
  16 Additionally, the python module comes with the following script:
  17
  18  - ``aubiocut`` slices sound files at onset or beat timestamps
  19
  20
  21 .. toctree::
  22
  23    cli_features
  24
  25
  26 ``aubioonset``
  27 --------------
  28
  29 .. literalinclude:: aubioonset.txt
  30
  31 ``aubiopitch``
  32 --------------
  33
  34 .. literalinclude:: aubiopitch.txt
  35
  36 ``aubiomfcc``
  37 --------------
  38
  39 .. literalinclude:: aubiomfcc.txt
  40
  41 ``aubiotrack``
  42 --------------
  43
  44 .. literalinclude:: aubiotrack.txt
  45
  46 ``aubionotes``
  47 --------------
  48
  49 .. literalinclude:: aubionotes.txt
  50
  51 ``aubioquiet``
  52 --------------
  53
  54 .. literalinclude:: aubioquiet.txt
  55
  56 ``aubiocut``
  57 --------------
  58
  59 .. literalinclude:: aubiocut.txt