m4/gengetopt/afh_recv.m4

   1 args "--no-version --no-help"
   2
   3 include(header.m4)
   4 <qu>
   5 text "
   6         The afh (audio format handler) receiver can be used to write
   7         selected parts of the given audio file without decoding
   8         the data.
   9
  10         The selected parts of the content of the audio file are passed
  11         to the child nodes of the buffer tree. Only complete chunks
  12         with respect of the underlying audio format are passed.
  13
  14 "
  15
  16 option "filename" f
  17 #~~~~~~~~~~~~~~~~~~
  18 "file to open"
  19 string typestr = "filename"
  20 required
  21
  22 option "begin-chunk" b
  23 #~~~~~~~~~~~~~~~~~~~~~
  24 "skip a number of chunks"
  25 int typestr = "chunk_num"
  26 default = "0"
  27 optional
  28 details = "
  29         The chunk_num argument must be between -num_chunks and
  30         num_chunks - 1 inclusively where num_chunks is the total number
  31         of chunks which is printed when using the --info option. If
  32         chunk_num is negative, the given number of chunks are counted
  33         backwards from the end of the file. For example --begin_chunk
  34         -100 instructs para_afh to start output at chunk num_chunks
  35         - 100. This is mainly useful for cutting off the end of an
  36         audio file.
  37 "
  38
  39 option "end-chunk" e
  40 #~~~~~~~~~~~~~~~~~~~
  41 "only write up to chunk chunk_num"
  42 int typestr = "chunk_num"
  43 optional
  44 details = "
  45         For the chunk_num argument the same rules as for --begin_chunk
  46         apply. The default is to write up to the last chunk.
  47 "
  48
  49 option "just-in-time" j
  50 #~~~~~~~~~~~~~~~~~~~~~~
  51 "use timed writes"
  52 flag off
  53 details = "
  54         Write the specified chunks of data 'just in time', i.e. the
  55         write of each chunk is delayed until the time it is needed
  56         by the decoder/player in order to guarantee an uninterrupted
  57         audio stream. This may be useful for third-party software
  58         that is capable of reading from stdin.
  59 "
  60
  61 option "no-header" H
  62 #~~~~~~~~~~~~~~~~~~~
  63 "do not write an audio file header"
  64 flag off
  65 details = "
  66         If an audio format needs information about the audio file
  67         in a format-specific header in order to be understood by
  68         the decoding software, a suitable header is automatically
  69         send. This option changes the default behaviour, i.e. no
  70         header is written.
  71 "
  72
  73 </qu>