From 19148a5b9f44bed660258a5896d1d12d77d3d9ab Mon Sep 17 00:00:00 2001
From: Paul B Mahol <onemda@gmail.com>
Date: Fri, 13 Jan 2023 13:32:26 +0100
Subject: avfilter: add FIR equalizer coefficients source filter

---
 doc/filters.texi | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)

(limited to 'doc')

diff --git a/doc/filters.texi b/doc/filters.texi
index 5dde79919a..5022f96e46 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -7624,6 +7624,71 @@ Specifies the channel layout, and can be a string representing a channel layout.
 The default value of @var{channel_layout} is "stereo".
 @end table
 
+@section afireqsrc
+
+Generate a FIR equalizer coefficients.
+
+The resulting stream can be used with @ref{afir} filter for filtering the audio signal.
+
+The filter accepts the following options:
+
+@table @option
+@item preset, p
+Set equalizer preset.
+Default preset is @code{flat}.
+
+Available presets are:
+@table @samp
+@item custom
+@item flat
+@item acoustic
+@item bass
+@item beats
+@item classic
+@item clear
+@item deep bass
+@item dubstep
+@item electronic
+@item hard-style
+@item hip-hop
+@item jazz
+@item metal
+@item movie
+@item pop
+@item r&b
+@item rock
+@item vocal booster
+@end table
+
+@item gains, g
+Set custom gains for each band. Only used if the preset option is set to @code{custom}.
+Gains are separated by white spaces and each gain is set in dBFS.
+Default is @code{0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0}.
+
+@item bands, b
+Set the custom bands from where custon equalizer gains are set.
+This must be in strictly increasing order. Only used if the preset option is set to @code{custom}.
+Bands are separated by white spaces and each band represent frequency in Hz.
+Default is @code{25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000}.
+
+@item taps, t
+Set number of filter coefficents in output audio stream.
+Default value is @code{4096}.
+
+@item sample_rate, r
+Set sample rate of output audio stream, default is @code{44100}.
+
+@item nb_samples, n
+Set number of samples per each frame in output audio stream. Default is @code{1024}.
+
+@item interp, i
+Set interpolation method for FIR equalizer coefficients. Can be @code{linear} or @code{cubic}.
+
+@item phase, h
+Set phase type of FIR filter. Can be @code{linear} or @code{min}: minimum-phase.
+Default is minimum-phase filter.
+@end table
+
 @section afirsrc
 
 Generate a FIR coefficients using frequency sampling method.
-- 
cgit v1.2.1