[FFmpeg-devel] [PATCH 2/2] doc/filters/astats: sort measure entries, add missing ones

[Stefano Sabatini]

Also apply minor consistency and formatting fixes.

Fix trac issue:
http://trac.ffmpeg.org/ticket/8397
---
 doc/filters.texi | 211 ++++++++++++++++++++++++++---------------------
 1 file changed, 115 insertions(+), 96 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 57088ccc6c..03c1b9bb1f 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -3167,62 +3167,61 @@ where @code{X} is channel number starting from 1 or string @code{Overall}. Defau
 disabled.
 
 Available keys for each channel are:
-DC_offset
-Min_level
-Max_level
-Min_difference
-Max_difference
-Mean_difference
-RMS_difference
-Peak_level
-RMS_peak
-RMS_trough
-Crest_factor
-Flat_factor
-Peak_count
-Noise_floor
-Noise_floor_count
-Entropy
-Bit_depth
-Dynamic_range
-Zero_crossings
-Zero_crossings_rate
-Number_of_NaNs
-Number_of_Infs
-Number_of_denormals
-
-and for Overall:
-DC_offset
-Min_level
-Max_level
-Min_difference
-Max_difference
-Mean_difference
-RMS_difference
-Peak_level
-RMS_level
-RMS_peak
-RMS_trough
-Flat_factor
-Peak_count
-Noise_floor
-Noise_floor_count
-Entropy
-Bit_depth
-Number_of_samples
-Number_of_NaNs
-Number_of_Infs
-Number_of_denormals
-
-For example full key look like this @code{lavfi.astats.1.DC_offset} or
-this @code{lavfi.astats.Overall.Peak_count}.
-
-For description what each key means read below.
+ at var{Bit_depth}
+ at var{Crest_factor}
+ at var{DC_offset}
+ at var{Dynamic_range}
+ at var{Entropy}
+ at var{Flat_factor}
+ at var{Max_difference}
+ at var{Max_level}
+ at var{Mean_difference}
+ at var{Min_difference}
+ at var{Min_level}
+ at var{Noise_floor}
+ at var{Noise_floor_count}
+ at var{Number_of_Infs}
+ at var{Number_of_NaNs}
+ at var{Number_of_denormals}
+ at var{Peak_count}
+ at var{Peak_level}
+ at var{RMS_difference}
+ at var{RMS_peak}
+ at var{RMS_trough}
+ at var{Zero_crossings}
+ at var{Zero_crossings_rate}
+
+and for @code{Overall}:
+ at var{Bit_depth}
+ at var{DC_offset}
+ at var{Entropy}
+ at var{Flat_factor}
+ at var{Max_difference}
+ at var{Max_level}
+ at var{Mean_difference}
+ at var{Min_difference}
+ at var{Min_level}
+ at var{Noise_floor}
+ at var{Noise_floor_count}
+ at var{Number_of_Infs}
+ at var{Number_of_NaNs}
+ at var{Number_of_denormals}
+ at var{Number_of_samples}
+ at var{Peak_count}
+ at var{Peak_level}
+ at var{RMS_difference}
+ at var{RMS_level}
+ at var{RMS_peak}
+ at var{RMS_trough}
+
+For example, a full key looks like @code{lavfi.astats.1.DC_offset} or
+ at code{lavfi.astats.Overall.Peak_count}.
+
+Read below for the description of the keys.
 
 @item reset
 Set the number of frames over which cumulative stats are calculated before
-being reset
-Default is disabled.
+being reset. Default is disabled.
 
 @item measure_perchannel
 Select the parameters which are measured per channel. The metadata keys can
@@ -3236,71 +3235,91 @@ be used as flags, default is @option{all} which measures everything.
 
 @end table
 
-A description of each shown parameter follows:
+A description of the measure keys follow:
 
 @table @option
- at item DC offset
-Mean amplitude displacement from zero.
+ at item none
+no measures
 
- at item Min level
-Minimal sample level.
+ at item all
+all measures
 
- at item Max level
-Maximal sample level.
+ at item Bit_depth
+overall bit depth of audio, i.e. number of bits used for each sample
 
- at item Min difference
-Minimal difference between two consecutive samples.
+ at item Crest_factor
+standard ratio of peak to RMS level (note: not in dB)
 
- at item Max difference
-Maximal difference between two consecutive samples.
+ at item DC_offset
+mean amplitude displacement from zero
 
- at item Mean difference
-Mean difference between two consecutive samples.
-The average of each difference between two consecutive samples.
+ at item Dynamic_range
+measured dynamic range of audio in dB
 
- at item RMS difference
-Root Mean Square difference between two consecutive samples.
+ at item Entropy
+entropy measured across whole audio, entropy of value near 1.0 is typically measured for white noise
 
- at item Peak level dB
- at item RMS level dB
-Standard peak and RMS level measured in dBFS.
+ at item Flat_factor
+flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
+(i.e. either @var{Min_level} or @var{Max_level})
 
- at item RMS peak dB
- at item RMS trough dB
-Peak and trough values for RMS level measured over a short window.
+ at item Max_difference
+maximal difference between two consecutive samples
 
- at item Crest factor
-Standard ratio of peak to RMS level (note: not in dB).
+ at item Max_level
+maximal sample level
 
- at item Flat factor
-Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
-(i.e. either @var{Min level} or @var{Max level}).
+ at item Mean_difference
+mean difference between two consecutive samples, i.e. the average of each difference between two consecutive samples
 
- at item Peak count
-Number of occasions (not the number of samples) that the signal attained either
- at var{Min level} or @var{Max level}.
+ at item Min_difference
+minimal difference between two consecutive samples
 
- at item Noise floor dB
-Minimum local peak measured in dBFS over a short window.
+ at item Min_level
+minimal sample level
 
- at item Noise floor count
-Number of occasions (not the number of samples) that the signal attained
- at var{Noise floor}.
+ at item Noise_floor
+minimum local peak measured in dBFS over a short window
 
- at item Entropy
-Entropy measured across whole audio. Entropy of value near 1.0 is typically measured for white noise.
+ at item Noise_floor_count
+number of occasions (not the number of samples) that the signal attained
+ at var{Noise floor}
+
+ at item Number_of_Infs
+number of samples with an infinite value
+
+ at item Number_of_NaNs
+number of samples with a NaN (not a number) value
+
+ at item Number_of_denormals
+number of samples with a subnormal value
+
+ at item Number_of_samples
+number of samples
+
+ at item Peak_count
+number of occasions (not the number of samples) that the signal attained either
+ at var{Min_level} or @var{Max_level}
+
+ at item Peak_level
+standard peak level measured in dBFS
+
+ at item RMS_difference
+Root Mean Square difference between two consecutive samples
 
- at item Bit depth
-Overall bit depth of audio. Number of bits used for each sample.
+ at item RMS_level
+standard RMS level measured in dBFS
 
- at item Dynamic range
-Measured dynamic range of audio in dB.
+ at item RMS_peak
+ at item RMS_trough
+peak and trough values for RMS level measured over a short window,
+measured in dBFS.
 
 @item Zero crossings
-Number of points where the waveform crosses the zero level axis.
+number of points where the waveform crosses the zero level axis
 
 @item Zero crossings rate
-Rate of Zero crossings and number of audio samples.
+rate of Zero crossings and number of audio samples
 @end table
 
 @section asubboost
-- 
2.25.1