From a2f4adf6803534b30283d72ddd2056e94952f387 Mon Sep 17 00:00:00 2001
From: Paul B Mahol <onemda@gmail.com>
Date: Sun, 16 Apr 2023 18:53:07 +0200
Subject: avfilter: add arls filter

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

(limited to 'doc')

diff --git a/doc/filters.texi b/doc/filters.texi
index f89b1d0b52..6d2672063c 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -2975,6 +2975,44 @@ atrim=end=5,areverse
 @end example
 @end itemize
 
+@section arls
+Apply Recursive Least Squares algorithm to the first audio stream using the second audio stream.
+
+This adaptive filter is used to mimic a desired filter by recursively finding the filter coefficients that
+relate to producing the minimal weighted linear least squares cost function of the error signal (difference
+between the desired, 2nd input audio stream and the actual signal, the 1st input audio stream).
+
+A description of the accepted options follows.
+
+@table @option
+@item order
+Set the filter order.
+
+@item lambda
+Set the forgetting factor.
+
+@item delta
+Set the coefficient to initialize internal covariance matrix.
+
+@item out_mode
+Set the filter output samples. It accepts the following values:
+@table @option
+@item i
+Pass the 1st input.
+
+@item d
+Pass the 2nd input.
+
+@item o
+Pass filtered samples.
+
+@item n
+Pass difference between desired and filtered samples.
+
+Default value is @var{o}.
+@end table
+@end table
+
 @section arnndn
 
 Reduce noise from speech using Recurrent Neural Networks.
-- 
cgit v1.2.1