doc/cli.rst

   1 .. _manpages:
   2
   3 Command line tools
   4 ==================
   5
   6 The 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
  11 More command line tools are included along with the library.
  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
  22 ``aubio``
  23 ---------
  24
  25 .. literalinclude:: aubio.txt
  26    :language: text
  27
  28
  29 ``aubiocut``
  30 --------------
  31
  32 .. literalinclude:: aubiocut.txt
  33    :language: text
  34
  35
  36 ``aubioonset``
  37 --------------
  38
  39 .. literalinclude:: aubioonset.txt
  40    :language: text
  41
  42 ``aubiopitch``
  43 --------------
  44
  45 .. literalinclude:: aubiopitch.txt
  46    :language: text
  47
  48 ``aubiomfcc``
  49 --------------
  50
  51 .. literalinclude:: aubiomfcc.txt
  52    :language: text
  53
  54 ``aubiotrack``
  55 --------------
  56
  57 .. literalinclude:: aubiotrack.txt
  58    :language: text
  59
  60 ``aubionotes``
  61 --------------
  62
  63 .. literalinclude:: aubionotes.txt
  64    :language: text
  65
  66 ``aubioquiet``
  67 --------------
  68
  69 .. literalinclude:: aubioquiet.txt
  70    :language: text
  71
  72
  73 .. include:: cli_features.rst