X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=m4%2Flls%2Ffilter_cmd.suite.m4;h=dece6e6e54f9c90429c4fe14d070b8dea6cdb1de;hb=e0441a354b25f6fdd97480fe4e1f4f942347611f;hp=d269d2374176adef783ca1f78ee0ac4832eb86da;hpb=1f12ea375358a0b30689e01efe82796ea4fcb14f;p=paraslash.git

diff --git a/m4/lls/filter_cmd.suite.m4 b/m4/lls/filter_cmd.suite.m4
index d269d237..dece6e6e 100644
--- a/m4/lls/filter_cmd.suite.m4
+++ b/m4/lls/filter_cmd.suite.m4
@@ -25,7 +25,7 @@ caption = filters
 	purpose = dynamically adjust the volume of an audio stream
 	[option blocksize]
 		short_opt = b
-		summary = use blocks of size 2**bits
+		summary = adjust volume after each block of size 2**bits (1-31)
 		typestr = bits
 		arg_info = required_arg
 		arg_type = uint32
@@ -35,32 +35,52 @@ caption = filters
 		[/help]
 	[option aggressiveness]
 		short_opt = a
-		summary = controls the maximum amount to amplify by
+		summary = controls the maximum amount to amplify by (1-15)
 		typestr = bits
 		arg_info = required_arg
 		arg_type = uint32
 		default_val = 4
+		[help]
+			This caps the maximal gain factor to 2**bits. The sum of the arguments
+			to --aggressiveness and --inertia (see below) must not exceed 16.
+		[/help]
 	[option inertia]
 		short_opt = i
-		summary = how much inertia ramping has
+		summary = how much inertia ramping has (1-15)
 		typestr = bits
 		arg_info = required_arg
 		arg_type = uint32
 		default_val = 6
+		[help]
+			Larger values cause smaller volume adjustments. See --aggressiveness
+			above.
+		[/help]
 	[option target-level]
 		short_opt = t
-		summary = target signal level (0-32768)
+		summary = target signal level (0-32767)
 		typestr = level
 		arg_info = required_arg
 		arg_type = uint32
-		default_val = 20000
+		default_val = 16384
+		[help]
+			If the peak of the previous block is less than the target level,
+			volume is increased slightly for the next block. Otherwise it is
+			decreased. The default value is chosen to minimize clipping. There
+			is usually no reason to change it.
+		[/help]
 	[option damp]
 		short_opt = d
-		summary = if non-zero, scale down after normalizing
+		summary = if non-zero, scale down after normalizing (0-16)
 		typestr = bits
 		arg_info = required_arg
 		arg_type = uint32
 		default_val = 0
+		[help]
+			This scales down the volume of the audio stream by factor 2**bits.
+			This is mostly useful if another audio application (e.g., a video
+			game) is running in parallel and the relative volume of the audio
+			stream is too high.
+		[/help]
 [subcommand fecdec]
 	purpose = decode a (lossy) input stream using forward error correction
 [subcommand flacdec]