From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ffmpeg-devel-bounces@ffmpeg.org>
Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100])
	by master.gitmailbox.com (Postfix) with ESMTP id 18B4944CE8
	for <ffmpegdev@gitmailbox.com>; Mon, 16 Jan 2023 01:03:38 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
	by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 60B7B68B1C7;
	Mon, 16 Jan 2023 03:03:34 +0200 (EET)
Received: from mail-ej1-f54.google.com (mail-ej1-f54.google.com
 [209.85.218.54])
 by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 945B968080D
 for <ffmpeg-devel@ffmpeg.org>; Mon, 16 Jan 2023 03:03:28 +0200 (EET)
Received: by mail-ej1-f54.google.com with SMTP id kt14so5723115ejc.3
 for <ffmpeg-devel@ffmpeg.org>; Sun, 15 Jan 2023 17:03:28 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:from:to:cc:subject:date
 :message-id:reply-to;
 bh=DvNNrhEHLP2WyPK13MCbePPWMtOlhgCRmDTX+cpkUy0=;
 b=IVPG/QGRpMCxS4f/6BzZyYbnX6vAyLG4ArBJHXso2piezsbYWj6f89K5nutaXU/dBJ
 L/HIS+Wz3NuUgdVa4H1iDUv/oUR+Y0oPG/HqYyW2/Q0TKwXMLet3ujW1Za0W67oPk7+p
 V1SEIsA76rqTXkLAj6scn+PogQfTh/GiGwmpm12qY6nm0Lk3X0ACK5EFnMl/0YMy1y4+
 WX9Zmb3gRjPQDj/FrG8Ip/dWcdv50Sb567OPkZrR1iQh48UQVolBc+l13p3UJB3OnRQW
 qXgbCJZXFkaSnVAFx8CBLTkxXa/Na+/wPIYLjQnif0sWtLNOVQudl5LDefUyjbxfEAC8
 pihQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20210112;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
 :subject:date:message-id:reply-to;
 bh=DvNNrhEHLP2WyPK13MCbePPWMtOlhgCRmDTX+cpkUy0=;
 b=76XeGTyLCugSYiquaiUYbtiDO6XPWety+S8L0YyMQ5bFhAczSa4QfsaUs/1Lv0g2/C
 E4eyRi+p4aFqLR9Uoyo6G2nbNni8kd1zg46FpHb8PXYfPp3Ac1Gp+fiUlMxO/kADXrn6
 BAAAvhaexRwOI63VOleMUxP2CocGINwKS0GLqWCztQ5OjPiUUPsEBHPYCEZ+QDD5gHj7
 h3ONoV1pZ4jUfV5bL7X1CIjMMYFdj9yBHyKksQWReEqpOfm/RqsVX/mhVUqDW7MmD2jQ
 6NSLaRFjOi1eYkGqzCJnXSPihYVVOTvmejTWroMYknw472SuICW4BKH1cVS7SKy9URKK
 3cXg==
X-Gm-Message-State: AFqh2krFL0joERGPh625xzsBoHtb/zRl6Q6pVlZ3DBSQD6BHVCyRRh4z
 uaE83AHQluXkjBdBDpsyUXvK1JD3PPc=
X-Google-Smtp-Source: AMrXdXuz8HY+qJ96d8l9v11NqiEb8/ZW/4gLTJvJmkbqnZNp1bDlf8mMMi72v1Z9MbE1miE0E20VRg==
X-Received: by 2002:a17:906:3b53:b0:863:3a9b:6a79 with SMTP id
 h19-20020a1709063b5300b008633a9b6a79mr14410738ejf.63.1673831007125; 
 Sun, 15 Jan 2023 17:03:27 -0800 (PST)
Received: from mariano ([82.84.225.92]) by smtp.gmail.com with ESMTPSA id
 k22-20020a1709063fd600b00862497eafb2sm5141254ejj.103.2023.01.15.17.03.26
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Sun, 15 Jan 2023 17:03:26 -0800 (PST)
Received: by mariano (Postfix, from userid 1000)
 id 5BC57BFB74; Mon, 16 Jan 2023 02:03:25 +0100 (CET)
From: Stefano Sabatini <stefasab@gmail.com>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Date: Mon, 16 Jan 2023 02:03:25 +0100
Message-Id: <20230116010325.614034-2-stefasab@gmail.com>
X-Mailer: git-send-email 2.25.1
In-Reply-To: <20230116010325.614034-1-stefasab@gmail.com>
References: <20230116010325.614034-1-stefasab@gmail.com>
MIME-Version: 1.0
Subject: [FFmpeg-devel] [PATCH 2/2] doc/filters/astats: sort measure entries,
 add missing ones
X-BeenThere: ffmpeg-devel@ffmpeg.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: FFmpeg development discussions and patches <ffmpeg-devel.ffmpeg.org>
List-Unsubscribe: <https://ffmpeg.org/mailman/options/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=unsubscribe>
List-Archive: <https://ffmpeg.org/pipermail/ffmpeg-devel>
List-Post: <mailto:ffmpeg-devel@ffmpeg.org>
List-Help: <mailto:ffmpeg-devel-request@ffmpeg.org?subject=help>
List-Subscribe: <https://ffmpeg.org/mailman/listinfo/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=subscribe>
Reply-To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Cc: Stefano Sabatini <stefasab@gmail.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: ffmpeg-devel-bounces@ffmpeg.org
Sender: "ffmpeg-devel" <ffmpeg-devel-bounces@ffmpeg.org>
Archived-At: <https://master.gitmailbox.com/ffmpegdev/20230116010325.614034-2-stefasab@gmail.com/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>

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.
+@var{Bit_depth}
+@var{Crest_factor}
+@var{DC_offset}
+@var{Dynamic_range}
+@var{Entropy}
+@var{Flat_factor}
+@var{Max_difference}
+@var{Max_level}
+@var{Mean_difference}
+@var{Min_difference}
+@var{Min_level}
+@var{Noise_floor}
+@var{Noise_floor_count}
+@var{Number_of_Infs}
+@var{Number_of_NaNs}
+@var{Number_of_denormals}
+@var{Peak_count}
+@var{Peak_level}
+@var{RMS_difference}
+@var{RMS_peak}
+@var{RMS_trough}
+@var{Zero_crossings}
+@var{Zero_crossings_rate}
+
+and for @code{Overall}:
+@var{Bit_depth}
+@var{DC_offset}
+@var{Entropy}
+@var{Flat_factor}
+@var{Max_difference}
+@var{Max_level}
+@var{Mean_difference}
+@var{Min_difference}
+@var{Min_level}
+@var{Noise_floor}
+@var{Noise_floor_count}
+@var{Number_of_Infs}
+@var{Number_of_NaNs}
+@var{Number_of_denormals}
+@var{Number_of_samples}
+@var{Peak_count}
+@var{Peak_level}
+@var{RMS_difference}
+@var{RMS_level}
+@var{RMS_peak}
+@var{RMS_trough}
+
+For example, a full key looks like @code{lavfi.astats.1.DC_offset} or
+@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
-@item DC offset
-Mean amplitude displacement from zero.
+@item none
+no measures
 
-@item Min level
-Minimal sample level.
+@item all
+all measures
 
-@item Max level
-Maximal sample level.
+@item Bit_depth
+overall bit depth of audio, i.e. number of bits used for each sample
 
-@item Min difference
-Minimal difference between two consecutive samples.
+@item Crest_factor
+standard ratio of peak to RMS level (note: not in dB)
 
-@item Max difference
-Maximal difference between two consecutive samples.
+@item DC_offset
+mean amplitude displacement from zero
 
-@item Mean difference
-Mean difference between two consecutive samples.
-The average of each difference between two consecutive samples.
+@item Dynamic_range
+measured dynamic range of audio in dB
 
-@item RMS difference
-Root Mean Square difference between two consecutive samples.
+@item Entropy
+entropy measured across whole audio, entropy of value near 1.0 is typically measured for white noise
 
-@item Peak level dB
-@item RMS level dB
-Standard peak and RMS level measured in dBFS.
+@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 RMS peak dB
-@item RMS trough dB
-Peak and trough values for RMS level measured over a short window.
+@item Max_difference
+maximal difference between two consecutive samples
 
-@item Crest factor
-Standard ratio of peak to RMS level (note: not in dB).
+@item Max_level
+maximal sample level
 
-@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 Mean_difference
+mean difference between two consecutive samples, i.e. the average of each difference between two consecutive 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 Min_difference
+minimal difference between two consecutive samples
 
-@item Noise floor dB
-Minimum local peak measured in dBFS over a short window.
+@item Min_level
+minimal sample level
 
-@item Noise floor count
-Number of occasions (not the number of samples) that the signal attained
-@var{Noise floor}.
+@item Noise_floor
+minimum local peak measured in dBFS over a short window
 
-@item Entropy
-Entropy measured across whole audio. Entropy of value near 1.0 is typically measured for white noise.
+@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 Bit depth
-Overall bit depth of audio. Number of bits used for each sample.
+@item RMS_level
+standard RMS level measured in dBFS
 
-@item Dynamic range
-Measured dynamic range of audio in dB.
+@item RMS_peak
+@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

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".