From patchwork Mon Mar 20 20:43:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefano Sabatini X-Patchwork-Id: 40734 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:d046:b0:cd:afd7:272c with SMTP id hv6csp2079590pzb; Mon, 20 Mar 2023 13:44:00 -0700 (PDT) X-Google-Smtp-Source: AK7set9m2Wo9Xkfru7P49E3CZbWLG1GsPmaS+BdqXMjwkI1+eRS65PsDge5oULS1PTb+CjmH8Zhm X-Received: by 2002:a17:906:85cd:b0:922:6bde:2530 with SMTP id i13-20020a17090685cd00b009226bde2530mr444708ejy.32.1679345040430; Mon, 20 Mar 2023 13:44:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1679345040; cv=none; d=google.com; s=arc-20160816; b=uxRUVRPfHZr2FGQPra1D3+oKfjYq+ctBG8yqv/mrMYmh/t4mezxXAlO9TEIWdMPg3N j42BYDhsoefBirIRpJBewNE5oNtkW1BfHMLojzA30RdAMB7JjeyjfSE5QZiW5JDIkNi3 12fyobSbLLsgpSeIPfu92XiTMWb09grlE9FL4wkxgbUzS3s3U/ECs7VobbPuxuJQTJvJ neIwoCplcL28J+08uJSKpiiKeojnDxIKfPHSOLQL2OWtcCKJbamtA84/9Y3xjSjzY46h c0atTWvjUGAydySXpjDyYB8TrWrRqilU6H8anmH4lpxsALW6g1VlkHfH2Awk2M4JKtj9 kpxA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:mime-version:message-id:date:to:from :dkim-signature:delivered-to; bh=C2wkxjZFOIol9Uwt6YnRLVzK0xDM5mynAcskpP1sNzI=; b=m1F2ao+0G9ARjEwHaebKmyMoUD1Ed71JmSVS9dR15j7Ocoqt3BxQXNCogkLLEtBhV+ bZ39+90rciQNIzhFWwORPGUsppyH593/rBFgQ+BPxUonw56oFkGXJ7S66O7uZjOWYeeq QxgPEspAXU4Lz0hkGqvGk4d26xd51nb8aOOnQYdrABGj0w1/W2dkgVZMmdnj+14TpD2i 9Z9RmN0xdZb3IR/yG6Kd3/zlcpABfqPpzmZt11zca1M8tlKWTNegeT4Th0slxc/6KJnC x1fYCeVVuJtO7M5XB8rae7pIPC5SoLBScImyFhE5qyKFv+w52kxvyxafL2CKO6OYQFTW mZPA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=p75wXrzw; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id e7-20020a17090658c700b0093208bdc05fsi4916781ejs.68.2023.03.20.13.43.59; Mon, 20 Mar 2023 13:44:00 -0700 (PDT) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=p75wXrzw; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id A600968C54C; Mon, 20 Mar 2023 22:43:56 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org 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 ; Mon, 20 Mar 2023 22:43:49 +0200 (EET) Received: by mail-wr1-f50.google.com with SMTP id j24so2778555wrd.0 for ; 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-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 To: FFmpeg development discussions and patches 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Cc: Stefano Sabatini Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: EWGwLy+SsnsV 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