m4/lls/filter.suite.m4

   1 m4_define(PROGRAM, para_filter)
   2 [suite filter]
   3 version-string = GIT_VERSION()
   4 [supercommand para_filter]
   5         purpose = decode or process audio data from STDIN to STDOUT
   6         [description]
   7                 This program transforms the audio stream read from STDIN by chaining
   8                 one or more filters. A common mode of operation is to decode an
   9                 mp3 file with the mp3dec filter, but many other filters exist which
  10                 transform the audio stream in different ways.
  11         [/description]
  12         m4_include(common-option-section.m4)
  13         m4_include(help.m4)
  14         m4_include(detailed-help.m4)
  15         m4_include(version.m4)
  16         m4_include(loglevel.m4)
  17         m4_include(per-command-options-section.m4)
  18         [option filter]
  19                 short_opt = f
  20                 summary = add one filter to the filter chain
  21                 arg_info = required_arg
  22                 arg_type = string
  23                 flag multiple
  24                 typestr = filter_spec
  25                 [help]
  26                         A filter specifier begins with the name of a supported filter,
  27                         optionally followed by zero or more options for the named filter.
  28                         Filter name and options must be separated by whitespace. If the
  29                         there is at least one option, the filter specifier needs to be quoted
  30                         like this:
  31
  32                                 --filter 'compress --inertia 5 --damp 2'
  33
  34                         This option may be specified multiple times to 'pipe' the stream
  35                         through all given filters (in a single thread without copying the
  36                         data). The same filter may appear more than once, and order matters.
  37                 [/help]
  38 [section Examples]
  39         .IP \(bu 4
  40         Decode a wma file to wav format:
  41         .EX
  42         \       para_filter -f wmadec -f wav < file.wma > file.wav
  43         .EE
  44         .IP \(bu 4
  45         Amplify a raw audio file by a factor of 1.5:
  46         .EX
  47         \       para_filter -f amp --amp 32 < foo.raw > bar.raw
  48         .EE
  49 [/section]