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 842674568E
for <ffmpegdev@gitmailbox.com>; Mon, 20 Mar 2023 20:43:59 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 76B3468C54A;
Mon, 20 Mar 2023 22:43:56 +0200 (EET)
Received: from mail-wr1-f50.google.com (mail-wr1-f50.google.com
[209.85.221.50])
by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 4711668C435
for <ffmpeg-devel@ffmpeg.org>; Mon, 20 Mar 2023 22:43:49 +0200 (EET)
Received: by mail-wr1-f50.google.com with SMTP id j24so2778555wrd.0
for <ffmpeg-devel@ffmpeg.org>; Mon, 20 Mar 2023 13:43:49 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=gmail.com; s=20210112; t=1679345027;
h=content-transfer-encoding:mime-version:message-id:date:subject:cc
:to:from:from:to:cc:subject:date:message-id:reply-to;
bh=Bh0Nuu214ADZQzLfmr5XKAKDX5F35eAxI5ngxZmC2O0=;
b=p75wXrzw5mLKlB1chsGCaNBC7XCHUOSXy2YBSIXip3iacxR+Bco6qlaCZygW6yP+jj
Tac9QnbB4MAI30l+KJoJq9FzpY6kzwyQ+QqzkINuwxxlUBTtyDTEYeebzoFMt0kfCSuK
bmrWSoWePimIEaeAiQaPLLR9W+g70gojiByUxjmGbAgUZ/4Xa0idzSBZLRGRlfVQMfPL
rB2l7pwiL8jMoogr3B8oA4f4TXpqxCAk41RgAUbo9tQAT+J9rcjoct0j0VTMN2vo7ogO
2zWULbrouPe0MRq2C9TyQcp5B8/dWPHRqTxlb+yrTDos+l8ssj9TTHDUdSlzHlc6fMED
Z6Yg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20210112; t=1679345027;
h=content-transfer-encoding:mime-version:message-id:date:subject:cc
:to:from:x-gm-message-state:from:to:cc:subject:date:message-id
:reply-to;
bh=Bh0Nuu214ADZQzLfmr5XKAKDX5F35eAxI5ngxZmC2O0=;
b=YRNCRLMIxROsPnQdByaGjRxu0P6c1PmXWWvRWGGLh1wPsDlsi+OvKKVA9qQto+Y6m+
lMBWB+LxvDx0ETUzvbVEjPD09N+gUnZQT+x+AHKcRKCIgd4mEcyzSs9fpsr1w9W8cANh
TggsCbf9nD8KOKR05LVqYHHW+JfXafA3cCqLLL0wPzeqlvQiHSVnXKCzJoGToEma7eu0
j5YrICI4rU1BRPR2EpvG9++1ns+z5WW0d8wqwvtSbZH4zzA6QkuECq0jpX/ihBKwPydo
2wFOlEqkzr2rLGquWZvDN8xAv3nSaKn0p3SRm/B4ZppfCxkoYRKmcTxNeOgtjAkF1lvR
pIHA==
X-Gm-Message-State: AO0yUKWcM79qYZ8fgNuA4CsljgwD6mJfw8IA378qhXAit8YYimCQ8sWt
VJ7Nfk+koHRdQwFIuWeUx+/bH1ZlMtRPxg==
X-Google-Smtp-Source: AK7set+DxPAPXScbNnITRFA/UXvVoDUdtXSmGlipgcSsdYaW5aXRSZ1rXzRdX4Vw3Sla18DGSYlN+g==
X-Received: by 2002:adf:cf12:0:b0:2cb:76d4:42ea with SMTP id
o18-20020adfcf12000000b002cb76d442eamr460858wrj.36.1679345027114;
Mon, 20 Mar 2023 13:43:47 -0700 (PDT)
Received: from mariano (dynamic-adsl-62-10-98-143.clienti.tiscali.it.
[62.10.98.143]) by smtp.gmail.com with ESMTPSA id
j19-20020a05600c191300b003eddc6aa5fasm5770416wmq.39.2023.03.20.13.43.45
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Mon, 20 Mar 2023 13:43:45 -0700 (PDT)
Received: by mariano (Postfix, from userid 1000)
id EA6DABFB73; Mon, 20 Mar 2023 21:43:43 +0100 (CET)
From: Stefano Sabatini <stefasab@gmail.com>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Date: Mon, 20 Mar 2023 21:43:43 +0100
Message-Id: <20230320204343.135439-1-stefasab@gmail.com>
X-Mailer: git-send-email 2.25.1
MIME-Version: 1.0
Subject: [FFmpeg-devel] [PATCH] doc/ffmpeg: add vstats format documentation
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/20230320204343.135439-1-stefasab@gmail.com/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>
Address issue:
http://trac.ffmpeg.org/ticket/7520
---
doc/ffmpeg.texi | 79 ++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 69 insertions(+), 10 deletions(-)
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 7feba8ab70..879bb05499 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -1025,20 +1025,19 @@ factor if negative.
@item -psnr
Calculate PSNR of compressed frames. This option is deprecated, pass the
PSNR flag to the encoder instead, using @code{-flags +psnr}.
-@item -vstats
-Dump video coding statistics to @file{vstats_HHMMSS.log}.
-@item -vstats_file @var{file}
-Dump video coding statistics to @var{file}.
-@item -vstats_version @var{file}
-Specifies which version of the vstats format to use. Default is 2.
-version = 1 :
+@item -vstats
+Dump video coding statistics to @file{vstats_HHMMSS.log}. See the
+@ref{vstats_file_format,,vstats file format} section for the format description.
-@code{frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s}
+@item -vstats_file @var{file}
+Dump video coding statistics to @var{file}. See the
+@ref{vstats_file_format,,vstats file format} section for the format description.
-version > 1:
+@item -vstats_version @var{file}
+Specify which version of the vstats format to use. Default is @code{2}. See the
+@ref{vstats_file_format,,vstats file format} section for the format description.
-@code{out= %2d st= %2d frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s}
@item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
top=1/bottom=0/auto=-1 field first
@item -vtag @var{fourcc/tag} (@emph{output})
@@ -2087,6 +2086,7 @@ encoder/muxer, it does not change the stream to conform to this value. Setting
values that do not match the stream properties may result in encoding failures
or invalid output files.
+@anchor{stats_enc_options}
@item -stats_enc_pre[:@var{stream_specifier}] @var{path} (@emph{output,per-stream})
@item -stats_enc_post[:@var{stream_specifier}] @var{path} (@emph{output,per-stream})
@item -stats_mux_pre[:@var{stream_specifier}] @var{path} (@emph{output,per-stream})
@@ -2254,6 +2254,65 @@ search for the file @file{libvpx-1080p.avpreset}.
If no such file is found, then ffmpeg will search for a file named
@var{arg}.avpreset in the same directories.
+@anchor{vstats_file_format}
+@section vstats file format
+The @code{-vstats} and @code{-vstats-file} options enable generation of a file
+containing statistics about the generated outputs.
+
+See also the @ref{stats_enc_options,,-stats_enc options} for an alternative way
+to show encoding statistics.
+
+The @code{-vstats-version} option controls the generated version file.
+
+With version @code{1} the format is:
+@example
+frame= @var{FRAME} q= @var{FRAME_QUALITY} PSNR= @var{PSNR} f_size= @var{PACKET_SIZE} s_size= @var{S_SIZE}kB time= @var{PACKET_TIMESTAMP} @var{br}= @var{bitrate}kbits/s @var{avg_br}= @var{average_bitrate}kbits/s
+@end example
+
+With version @code{2} the format is:
+@example
+out= @var{OUT_FILE_INDEX} st= @var{OUT_FILE_STREAM_INDEX} frame= @var{FRAME_NUMBER} q= @var{FRAME_QUALITY}f PSNR= @var{PSNR} f_size= @var{FRAME_SIZE} s_size= @var{S_SIZE}kB time=@var{TIMESTAMP} br= @var{BITRATE}kbits/s avg_br= @var{AVERAGE_BITRATE}kbits/s
+@end example
+
+The value corresponding to each key is described below:
+@table @option
+@item avg_br
+average bitrate expressed in Kbits/s
+
+@item br
+bitrate expressed in Kbits/s
+
+@item frame
+number of encoded frame
+
+@item out
+out file index
+
+@item PSNR
+Peak Signal to Noise Ratio
+
+@item q
+quality of the frame
+
+@item f_size
+encoded packet size expressed as number of bytes
+
+@item s_size
+stream size expressed in KiB
+
+@item st
+out file stream index
+
+@item time
+time of the packet
+
+@item time
+package time
+
+@item type
+picture type
+@end table
+
@c man end OPTIONS
@chapter Examples
--
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".