summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLucas Cooper <bobobo-at-google.com@ffmpeg.org>2016-08-01 09:50:59 -0700
committerMichael Niedermayer <michael@niedermayer.cc>2016-08-02 12:50:06 +0200
commit3d7ea1d39e09d22b88c056b16dd04d1c49940012 (patch)
tree4731621f67b1fcea074bb36c71c75f5442c9e0b0 /doc
parent7be021d9495bb12189e2e51740a1a6e3c881007b (diff)
doc/filters: Add stats_version documentation to PSNR filter
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index c47dfeeb70..923d48117a 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