4dda0bf9dcd70d3dec7b7eafd81b52d45c681ae4
[paraslash.git] / m4 / lls / filter_cmd.suite.m4
1 [suite filter_cmd]
2 caption = filters
3 [subcommand aacdec]
4 purpose = decode an aac stream
5 [subcommand amp]
6 purpose = amplify (scale) a raw audio stream
7 [option amp]
8 short_opt = a
9 summary = amplification value
10 typestr = number
11 arg_info = required_arg
12 arg_type = uint32
13 default_val = 32
14 [help]
15 The amplification value determines the scaling factor by which the
16 amplitude of the audio stream is multiplied. The formula for the
17 scaling factor is
18
19 factor = 1 + amp / 64.
20
21 For example, an amplification value of zero results in a scaling factor
22 of one while an amplification value of 64 means to double the volume.
23 [/help]
24 [subcommand compress]
25 purpose = dynamically adjust the volume of an audio stream
26 [option blocksize]
27 short_opt = b
28 summary = use blocks of size 2**bits
29 typestr = bits
30 arg_info = required_arg
31 arg_type = uint32
32 default_val = 15
33 [help]
34 Larger blocksize means fewer volume adjustments per time unit.
35 [/help]
36 [option aggressiveness]
37 short_opt = a
38 summary = controls the maximum amount to amplify by
39 typestr = bits
40 arg_info = required_arg
41 arg_type = uint32
42 default_val = 4
43 [option inertia]
44 short_opt = i
45 summary = how much inertia ramping has
46 typestr = bits
47 arg_info = required_arg
48 arg_type = uint32
49 default_val = 6
50 [option target-level]
51 short_opt = t
52 summary = target signal level (0-32768)
53 typestr = level
54 arg_info = required_arg
55 arg_type = uint32
56 default_val = 20000
57 [option damp]
58 short_opt = d
59 summary = if non-zero, scale down after normalizing
60 typestr = bits
61 arg_info = required_arg
62 arg_type = uint32
63 default_val = 0
64 [subcommand fecdec]
65 purpose = decode a (lossy) input stream using forward error correction
66 [subcommand flacdec]
67 purpose = decode a flac stream
68 [subcommand mp3dec]
69 purpose = decode an mp3 stream
70 [option ignore-crc]
71 short_opt = i
72 summary = ignore CRC information in the audio stream
73 [help]
74 This causes frames with CRC errors to be decoded and played
75 anyway. This option is not recommended, but since some encoders
76 have been known to generate bad CRC information, this option is a
77 work-around to play streams from such encoders.
78 [/help]
79 [subcommand oggdec]
80 purpose = decode an ogg/vorbis stream
81 [subcommand opusdec]
82 purpose = decode an ogg/opus stream
83 [subcommand prebuffer]
84 purpose = delay processing of an audio stream
85 [option duration]
86 short_opt = d
87 summary = length of the prebuffer period
88 typestr = milliseconds
89 arg_info = required_arg
90 arg_type = uint32
91 default_val = 200
92 [help]
93 Wait this many milliseconds before letting data go through. The time
94 interval starts when the first data byte is seen in the input queue.
95 [/help]
96 [option size]
97 short_opt = s
98 summary = amount of data to prebuffer
99 typestr = bytes
100 arg_info = required_arg
101 arg_type = uint32
102 default_val = 0
103 [help]
104 Wait until this many data bytes are available in the input queue. The
105 default value of zero means to not prebuffer by size. If both
106 --duration and --size are given and non-zero, the prebuffer filter
107 waits until both conditions are met.
108 [/help]
109 [subcommand resample]
110 purpose = transform raw audio to a different sample rate
111 [option converter]
112 short_opt = C
113 summary = set conversion algorithm
114 typestr = type
115 arg_info = required_arg
116 arg_type = string
117 default_val = medium
118 [help]
119 best: This is a bandlimited interpolator derived from the mathematical
120 sinc function and this is the highest quality sinc based converter,
121 providing a worst case Signal-to-Noise Ratio (SNR) of 97 decibels
122 (dB) at a bandwidth of 97%.
123
124 medium: This is another bandlimited interpolator much like the previous
125 one. It has an SNR of 97dB and a bandwidth of 90%. The speed of the
126 conversion is much faster than the previous one.
127
128 fastest: This is the fastest bandlimited interpolator and has an SNR
129 of 97dB and a bandwidth of 80%.
130
131 zero_order_hold: A Zero Order Hold converter (interpolated value
132 is equal to the last value). The quality is poor but the conversion
133 speed is blindlingly fast.
134
135 linear: A linear converter. Again the quality is poor, but the
136 conversion speed is blindingly fast.
137 [/help]
138 [option dest-sample-rate]
139 short_opt = d
140 summary = sample rate to convert to
141 typestr = rate
142 arg_info = required_arg
143 arg_type = uint32
144 default_val = 44100
145 m4_include(channels.m4)
146 m4_include(sample-rate.m4)
147 m4_include(sample-format.m4)
148 [subcommand spxdec]
149 purpose = decode an ogg/speex stream
150 [subcommand sync]
151 purpose = synchronize playback between multiple clients
152 [option buddy]
153 short_opt = b
154 summary = client to synchronize with
155 typestr = url
156 arg_info = required_arg
157 arg_type = string
158 flag multiple
159 [help]
160 This option may be given multiple times, one per buddy. Each value
161 may be given as a host, port pair in either IPv4 or IPv6 form, with
162 port being optional. If no port was specified the listening port (as
163 specified with --port, see below) is used to send the synchronization
164 packet to this buddy.
165 [/help]
166 [option port]
167 short_opt = p
168 summary = UDP port for incoming synchronization packets
169 typestr = portnumber
170 arg_info = required_arg
171 arg_type = uint32
172 default_val = 29900
173 [help]
174 The sync filter expects incoming synchronization packets on this
175 UDP port.
176 [/help]
177 [option timeout]
178 short_opt = t
179 summary = how long to wait for other clients
180 typestr = milliseconds
181 arg_info = required_arg
182 arg_type = uint32
183 default_val = 2000
184 [help]
185 Once the sync filter receives its first chunk of input,
186 a synchronization period of the given number of milliseconds
187 begins. Playback is deferred until a synchronization packet has
188 been received from each defined buddy, or until the end of the
189 period. Buddies which did not send a synchronization packet in time
190 are temporarily disabled and are not waited for during subsequent
191 synchronization periods. They are re-enabled automatically when
192 another synchronization packet arrives.
193 [/help]
194 [subcommand wav]
195 purpose = insert a Microsoft wave header into a raw audio stream
196 [subcommand wmadec]
197 purpose = decode a wma stream