virtualenv/FFmpeg
1
0
Fork 0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-01-24 13:56:33 +02:00
Code Issues Releases Activity

doc/filters/astats: sort measure entries, add missing ones

Browse Source 
Also apply minor consistency and formatting fixes.

Fix trac issue:
http://trac.ffmpeg.org/ticket/8397
This commit is contained in:
Stefano Sabatini 2023-01-16 01:58:15 +01:00
parent abfe8456a2
commit 2a3a36e279
1 changed files with 119 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

219
doc/filters.texi
View File

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