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