m4/gengetopt/afh_recv.m4

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