[FFmpeg-cvslog] doc/filters: Add stats_version documentation to PSNR filter

Lucas Cooper git at videolan.org
Tue Aug 2 13:53:42 EEST 2016

ffmpeg | branch: master | Lucas Cooper <bobobo-at-google.com at ffmpeg.org> | Mon Aug  1 09:50:59 2016 -0700| [3d7ea1d39e09d22b88c056b16dd04d1c49940012] | committer: Michael Niedermayer

doc/filters: Add stats_version documentation to PSNR filter

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=3d7ea1d39e09d22b88c056b16dd04d1c49940012

 doc/filters.texi | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

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.
+ at 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:
+ at table @option
+ at item psnr_log_version
+The version of the log file format. Will match @var{stats_version}.
+ at item fields
+A comma separated list of the per-frame-pair parameters included in
+the log.
+ at end table
+A description of each shown per-frame-pair parameter follows:
 @table @option
 @item n

More information about the ffmpeg-cvslog mailing list