The afh_receiver, infrastructure.

[paraslash.git] / m4 / gengetopt / afh_recv.m4

diff --git a/m4/gengetopt/afh_recv.m4 b/m4/gengetopt/afh_recv.m4
new file mode 100644 (file)
index 0000000..4995e77
--- /dev/null
+++ b/m4/gengetopt/afh_recv.m4
@@ -0,0 +1,71 @@
+include(header.m4)
+<qu>
+text "
+       The afh (audio format handler) receiver can be used to write
+       selected parts of the given audio file without decoding
+       the data.
+
+       The selected parts of the content of the audio file are passed
+       to the child nodes of the buffer tree. Only complete chunks
+       with respect of the underlying audio format are passed.
+
+"
+
+option "filename" f
+#~~~~~~~~~~~~~~~~~~
+"file to open"
+string typestr = "filename"
+required
+
+option "begin-chunk" b
+#~~~~~~~~~~~~~~~~~~~~~
+"skip a number of chunks"
+int typestr = "chunk_num"
+default = "0"
+optional
+details = "
+       The chunk_num argument must be between -num_chunks and
+       num_chunks - 1 inclusively where num_chunks is the total number
+       of chunks which is printed when using the --info option. If
+       chunk_num is negative, the given number of chunks are counted
+       backwards from the end of the file. For example --begin_chunk
+       -100 instructs para_afh to start output at chunk num_chunks
+       - 100. This is mainly useful for cutting off the end of an
+       audio file.
+"
+
+option "end-chunk" e
+#~~~~~~~~~~~~~~~~~~~
+"only write up to chunk chunk_num"
+int typestr = "chunk_num"
+optional
+details = "
+       For the chunk_num argument the same rules as for --begin_chunk
+       apply. The default is to write up to the last chunk.
+"
+
+option "just-in-time" j
+#~~~~~~~~~~~~~~~~~~~~~~
+"use timed writes"
+flag off
+details = "
+       Write the specified chunks of data 'just in time', i.e. the
+       write of each chunk is delayed until the time it is needed
+       by the decoder/player in order to guarantee an uninterrupted
+       audio stream. This may be useful for third-party software
+       that is capable of reading from stdin.
+"
+
+option "no-header" H
+#~~~~~~~~~~~~~~~~~~~
+"do not write an audio file header"
+flag off
+details = "
+       If an audio format needs information about the audio file
+       in a format-specific header in order to be understood by
+       the decoding software, a suitable header is automatically
+       send. This option changes the default behaviour, i.e. no
+       header is written.
+"
+
+</qu>