X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=m4%2Fgengetopt%2Fafh.m4;fp=m4%2Fgengetopt%2Fafh.m4;h=ba7d790114f9138282e39336bf43446eb3cac46b;hp=0000000000000000000000000000000000000000;hb=2829202e393e4b0095d62739910ae56f04e83326;hpb=66b0f375732897cb76cfbefbb03ed951c4ed24ba

diff --git a/m4/gengetopt/afh.m4 b/m4/gengetopt/afh.m4
new file mode 100644
index 00000000..ba7d7901
--- /dev/null
+++ b/m4/gengetopt/afh.m4
@@ -0,0 +1,136 @@
+include(header.m4)
+<qu>
+text "
+para_afh, the audio format handler tool, is a stand-alone program
+contained in the paraslash package for analyzing and streaming audio
+files. It can be used to
+
+	- print tech info about the given audio file to stdout.
+	In particular, the 'chunk table' of the audio file, an array
+	of offsets within the audio file, may be printed. This table
+	can be used by other programs unaware of the particular audio
+	format to stream the audio file.
+
+	- write selected parts of the given audio file in complete
+	chunks without decoding. Thus para_afh can be used to 'cut'
+	an audio file.
+
+	- write selected parts of the given audio files 'just in time'
+	to stdout. This may be useful for third-party software that
+	is capable of reading from stdin.
+"
+</qu>
+
+include(loglevel.m4)
+
+<qu>
+defgroup "mode"
+#--------------
+groupdesc="
+	There are two modes of operation: Info mode and stream mode,
+	one of which must be selected by the corresponding option.
+	See below.
+"
+required
+
+groupoption "info" i
+#~~~~~~~~~~~~~~~~~~~
+"select info mode"
+group="mode"
+details="
+	In this mode, the program prints technical information about
+	the given audio file to stdout.
+"
+
+groupoption "stream" s
+#~~~~~~~~~~~~~~~~~~~~~
+"select stream mode"
+group="mode"
+details="
+	If this mode is selected, the selected parts of the content
+	of the audio file are written to stdout. Only complete chunks
+	with respect of the underlying audio format are written.
+	For example, only complete frames in case of mp3 files.
+"
+
+section "Options for info mode"
+#==============================
+
+option "chunk_table" c
+#~~~~~~~~~~~~~~~~~~~~~
+"print also the chunk table"
+flag off
+dependon="info"
+
+option "human" u
+#~~~~~~~~~~~~~~~
+"use human-readable output format"
+flag off
+dependon = "info"
+details = "
+	Currently this option only affects the format of the chunk table,
+	so it has no effect if --chunk_table is not given.
+
+	The human-readable output consists of one output line per
+	chunk and the output contains also the chunk number, the
+	duration and the size of each chunk.
+"
+
+section "Options for stream mode"
+#================================
+
+
+option "begin_chunk" b
+#~~~~~~~~~~~~~~~~~~~~~
+"skip a number of chunks"
+int typestr="chunk_num"
+default="0"
+dependon="stream"
+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"
+dependon="stream"
+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
+dependon="stream"
+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.
+"
+
+option "no_header" H
+#~~~~~~~~~~~~~~~~~~~
+"do not write an audio file header"
+flag off
+dependon="stream"
+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>