[FFmpeg-cvslog] doc/filters: mention sample_noise/sn options too

Paul B Mahol git at videolan.org
Thu Mar 17 12:01:06 EET 2022


ffmpeg | branch: master | Paul B Mahol <onemda at gmail.com> | Thu Mar 17 10:06:08 2022 +0100| [44fb2463a3ba4a1496648cf74038e96fad448713] | committer: Paul B Mahol

doc/filters: mention sample_noise/sn options too

Also simplify commands section.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=44fb2463a3ba4a1496648cf74038e96fad448713
---

 doc/filters.texi | 33 ++++++++++++++-------------------
 1 file changed, 14 insertions(+), 19 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 67c125e9fd..f25c5c1640 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -1311,7 +1311,7 @@ Default value is white noise.
 @end table
 
 @item band_noise, bn
-Set custom band noise for every one of 15 bands.
+Set custom band noise profile for every one of 15 bands.
 Bands are separated by ' ' or '|'.
 
 @item residual_floor, rf
@@ -1376,31 +1376,26 @@ Default value is @var{min}.
 @item band_multiplier, bm
 Set the band multiplier factor, used how much to spread bands across frequency bins.
 Allowed range is from @var{0.2} to @var{5}. Default value is @var{1.25}.
- at end table
 
- at subsection Commands
+ at item sample_noise, sn
+Toggle capturing and measurement of noise profile from input audio.
 
-This filter supports the following commands:
+It accepts the following values:
 @table @option
- at item sample_noise, sn
-Start or stop measuring noise profile.
-Syntax for the command is : "start" or "stop" string.
-After measuring noise profile is stopped it will be
-automatically applied in filtering.
+ at item start, begin
+Start sample noise capture.
 
- at item noise_reduction, nr
-Change noise reduction. Argument is single float number.
-Syntax for the command is : "@var{noise_reduction}"
+ at item stop, end
+Stop sample noise capture and measure new noise band profile.
 
- at item noise_floor, nf
-Change noise floor. Argument is single float number.
-Syntax for the command is : "@var{noise_floor}"
-
- at item output_mode, om
-Change output mode operation.
-Syntax for the command is : "i", "o" or "n" string.
+Default value is @code{none}.
+ at end table
 @end table
 
+ at subsection Commands
+
+This filter supports the some above mentioned options as @ref{commands}.
+
 @section afftfilt
 Apply arbitrary expressions to samples in frequency domain.
 



More information about the ffmpeg-cvslog mailing list