diff mbox

[FFmpeg-devel] Add stats_version documentation to PSNR filter

Message ID 1470070259-7332-1-git-send-email-bobobo@google.com
State Accepted
Commit 3d7ea1d39e09d22b88c056b16dd04d1c49940012
Headers show

Commit Message

Lucas Cooper Aug. 1, 2016, 4:50 p.m. UTC 
---
 doc/filters.texi | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

Comments

Michael Niedermayer Aug. 2, 2016, 10:50 a.m. UTC | #1 
On Mon, Aug 01, 2016 at 09:50:59AM -0700, Lucas Cooper wrote:
> ---
>  doc/filters.texi | 20 +++++++++++++++++++-
>  1 file changed, 19 insertions(+), 1 deletion(-)

applied

thx

[...]
diff mbox

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index c47dfee..923d481 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -10692,13 +10692,31 @@  The description of the accepted parameters follows.
 If specified the filter will use the named file to save the PSNR of
 each individual frame. When filename equals "-" the data is sent to
 standard output.
+
+@item stats_version
+Specifies which version of the stats file format to use. Details of
+each format are written below.
+Default value is 1.
 @end table
 
 The file printed if @var{stats_file} is selected, contains a sequence of
 key/value pairs of the form @var{key}:@var{value} for each compared
 couple of frames.
 
-A description of each shown parameter follows:
+If a @var{stats_version} greater than 1 is specified, a header line precedes
+the list of per-frame-pair stats, with key value pairs following the frame
+format with the following parameters:
+
+@table @option
+@item psnr_log_version
+The version of the log file format. Will match @var{stats_version}.
+
+@item fields
+A comma separated list of the per-frame-pair parameters included in
+the log.
+@end table
+
+A description of each shown per-frame-pair parameter follows:
 
 @table @option
 @item n