summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul B Mahol <onemda@gmail.com>2015-09-05 19:12:58 +0000
committerPaul B Mahol <onemda@gmail.com>2015-09-12 13:29:20 +0000
commit39c61d84594780fc3f329806ab864a3734c84527 (patch)
treede8a9abdc2bde40e9f95507ff6e9ebd3f90edc11 /doc
parenta0a2ca024bd0e6e3cd6cfa3fb878871a18a611e6 (diff)
avfilter: add audio limiter filter
Signed-off-by: Paul B Mahol <onemda@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 447caf5251..4958374edf 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -641,6 +641,41 @@ Force the output to either unsigned 8-bit or signed 16-bit stereo
aformat=sample_fmts=u8|s16:channel_layouts=stereo
@end example
+@section alimiter
+
+The limiter prevents input signal from raising over a desired threshold.
+This limiter uses lookahead technology to prevent your signal from distorting.
+It means that there is a small delay after signal is processed. Keep in mind
+that the delay it produces is the attack time you set.
+
+The filter accepts the following options:
+
+@table @option
+@item limit
+Don't let signals above this level pass the limiter. The removed amplitude is
+added automatically. Default is 1.
+
+@item attack
+The limiter will reach its attenuation level in this amount of time in
+milliseconds. Default is 5 milliseconds.
+
+@item release
+Come back from limiting to attenuation 1.0 in this amount of milliseconds.
+Default is 50 milliseconds.
+
+@item asc
+When gain reduction is always needed ASC takes care of releasing to an
+average reduction level rather than reaching a reduction of 0 in the release
+time.
+
+@item asc_level
+Select how much the release time is affected by ASC, 0 means nearly no changes
+in release time while 1 produces higher release times.
+@end table
+
+Depending on picked setting it is recommended to upsample input 2x or 4x times
+with @ref{aresample} before applying this filter.
+
@section allpass
Apply a two-pole all-pass filter with central frequency (in Hz)