From patchwork Sat Jun 17 08:09:00 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anton Khirnov X-Patchwork-Id: 42169 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:c526:b0:117:ac03:c9de with SMTP id gm38csp2082904pzb; Sat, 17 Jun 2023 01:10:13 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6bB88nXqNZkydJshlplLre/widcTHKpQXKIiGx8SWo8+ULYp4ezPZIZpu21fQVH4Gk6v97 X-Received: by 2002:a17:907:9624:b0:987:9852:603a with SMTP id gb36-20020a170907962400b009879852603amr895032ejc.26.1686989413134; Sat, 17 Jun 2023 01:10:13 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686989413; cv=none; d=google.com; s=arc-20160816; b=Gja6Jz1E8oNhsf/821P+JYlZY6own8pXIF4uMoCIO+pAtDujgptTPsoPvFXdGgNa/+ B4H6PQSjbBnII88SJMU/NJ4JUQPDvoZ+I6xBU1nU4sDhZFFXGFE65MQS0LbL/b1raIAZ 6uYLE3NHlffuKWS4GH8rgnziPWOuIHWxTZlpWEG1fMpZOPeDh/cVEihcpRw9kfDxsFmk pB8ZeV0ewf2elTnLCZ6YG5piH8mOPyovDuoWG4n4LgQrCWTtG1/eZWwTrwMOclohyud+ loYD42JLIZ/h0+nBYRv6AygRNT7g31nSL208W6ZZaGvaA1zHV9ctdV+Algvg35xYOHhe Qkhg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:reply-to:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:subject:mime-version:message-id:date:to:from :delivered-to; bh=ObARMKazSPng4KBbEZmu9xZUs5IeUY2RNcd3r/ci04k=; b=yRYqAD0fO+xX4oOsxizv72n1pHpyyR1EGxITvCM1dTVvE/0Wng7YRcncMDk3I0z2J0 GZRATK0iUPT2AGzrxwleGQe6qOTJqSLPpNW5nuuCORlWFOxUss0guxHm2fFhpXoWMAiI XCd/UxUe0u6SmTFn3WigJf2aFINyZU4b7Xq+NdyAEXE7qIisaR0nztwhpNtR4tadBgea k/52omzg+qBsIoChbTl81tNV3PA0rJ3xAOS0CtYuuoXSh8gfxXI5IH/2RWbFAmoTvpzt tZEfrd51MgrRnup3f99ccND/SR4IkhqG83BR3IERwnmMn8WUTREbm4RK7xJ9TcwsAW5e c7dw== ARC-Authentication-Results: i=1; mx.google.com; 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 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id n16-20020a170906119000b009660febfbbfsi3529982eja.696.2023.06.17.01.10.12; Sat, 17 Jun 2023 01:10:13 -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; 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 Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 7E75068BFB0; Sat, 17 Jun 2023 11:10:09 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 9AEC768BF73 for ; Sat, 17 Jun 2023 11:10:02 +0300 (EEST) Received: from localhost (localhost [IPv6:::1]) by mail0.khirnov.net (Postfix) with ESMTP id 4A1852404EC for ; Sat, 17 Jun 2023 10:10:02 +0200 (CEST) Received: from mail0.khirnov.net ([IPv6:::1]) by localhost (mail0.khirnov.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id r-FWxx3OiYtE for ; Sat, 17 Jun 2023 10:10:01 +0200 (CEST) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:2a00:c500:561:201::7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "libav.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail0.khirnov.net (Postfix) with ESMTPS id A80482404EA for ; Sat, 17 Jun 2023 10:10:01 +0200 (CEST) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:::1]) by libav.khirnov.net (Postfix) with ESMTP id 1E6DD3A01C0 for ; Sat, 17 Jun 2023 10:09:55 +0200 (CEST) From: Anton Khirnov To: ffmpeg-devel@ffmpeg.org Date: Sat, 17 Jun 2023 10:09:00 +0200 Message-Id: <20230617080900.3336-1-anton@khirnov.net> X-Mailer: git-send-email 2.40.1 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] doc/ffmpeg: improve -stats_*_fmt 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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: A///oAm3/ahi --- doc/ffmpeg.texi | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi index c0fa90f381..6769f8d305 100644 --- a/doc/ffmpeg.texi +++ b/doc/ffmpeg.texi @@ -2145,8 +2145,8 @@ Input frame number. Index of the input frame (i.e. output by a decoder) that corresponds to this output frame or packet. -1 if unavailable. @item tb -Encoder timebase, as a rational number @var{num/den}. Note that this may be -different from the timebase used by the muxer. +Timebase in which this frame/packet's timestamps are expressed, as a rational +number @var{num/den}. Note that encoder and muxer may use different timebases. @item tbi Timebase for @var{ptsi}, as a rational number @var{num/den}. Available when @@ -2169,31 +2169,39 @@ Presentation time of the frame or packet, as a decimal number. Equal to Presentation time of the input frame (see @var{ni}), as a decimal number. Equal to @var{ptsi} multiplied by @var{tbi}. Printed as inf when not available. -@item dts +@item dts (@emph{packet}) Decoding timestamp of the packet, as an integer. Should be multiplied by the -timebase to compute presentation time. Post-encoding only. +timebase to compute presentation time. -@item dt +@item dt (@emph{packet}) Decoding time of the frame or packet, as a decimal number. Equal to @var{dts} multiplied by @var{tb}. -@item sn -Number of audio samples sent to the encoder so far. Audio and pre-encoding only. +@item sn (@emph{frame,audio}) +Number of audio samples sent to the encoder so far. -@item samp -Number of audio samples in the frame. Audio and pre-encoding only. +@item samp (@emph{frame,audio}) +Number of audio samples in the frame. -@item size -Size of the encoded packet in bytes. Post-encoding only. +@item size (@emph{packet}) +Size of the encoded packet in bytes. -@item br +@item br (@emph{packet}) Current bitrate in bits per second. Post-encoding only. -@item abr +@item abr (@emph{packet}) Average bitrate for the whole stream so far, in bits per second, -1 if it cannot be determined at this point. Post-encoding only. @end table +Directives tagged with @emph{packet} may only be used with +@option{-stats_enc_post_fmt} and @option{-stats_mux_pre_fmt}. + +Directives tagged with @emph{frame} may only be used with +@option{-stats_enc_pre_fmt}. + +Directives tagged with @emph{audio} may only be used with audio streams. + The default format strings are: @table @option @item pre-encoding