From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 6313348ACB for ; Thu, 29 Feb 2024 16:24:53 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 58ECB68D1B3; Thu, 29 Feb 2024 18:24:36 +0200 (EET) Received: from alt2.a-painless.mh.aa.net.uk (alt2.a-painless.mh.aa.net.uk [81.187.30.51]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 551E268D125 for ; Thu, 29 Feb 2024 18:24:29 +0200 (EET) Received: from c.e.9.3.3.0.b.1.e.3.4.b.6.2.c.9.0.5.8.0.9.1.8.0.0.b.8.0.1.0.0.2.ip6.arpa ([2001:8b0:819:850:9c26:b43e:1b03:39ec] helo=andrews-2024-laptop.lan) by painless-a.thn.aa.net.uk with esmtp (Exim 4.96) (envelope-from ) id 1rfjCu-00DkRE-2Z; Thu, 29 Feb 2024 16:24:28 +0000 From: Andrew Sayers To: ffmpeg-devel@ffmpeg.org Date: Thu, 29 Feb 2024 16:23:07 +0000 Message-ID: <20240229162424.850294-3-ffmpeg-devel@pileofstuff.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240229162424.850294-1-ffmpeg-devel@pileofstuff.org> References: <20240229162424.850294-1-ffmpeg-devel@pileofstuff.org> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 2/2] all: harmonise "{Decoding, Encoding, Audio, Video}:" comments 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: Andrew Sayers Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: There seems to be a convention for documenting meanings: /** * Encoding: (meaning in encoding context) * Decoding: (meaning in decoding context) */ At a glance, these are confusingly similar to ownership comments. They are also rendered by doxygen as long, hard-to-read paragraphs. Reformat these comments to be more visually distinct and readable. --- libavcodec/avcodec.h | 19 +++++++++++++------ libavformat/avformat.h | 22 +++++++++++++++------- 2 files changed, 28 insertions(+), 13 deletions(-) diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 43859251cc..e2193f1d00 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -586,16 +586,23 @@ typedef struct AVCodecContext { /** * Codec delay. * - * Encoding: Number of frames delay there will be from the encoder input to - * the decoder output. (we assume the decoder matches the spec) - * Decoding: Number of frames delay in addition to what a standard decoder - * as specified in the spec would produce. + * *Encoding:* + * + * Number of frames delay there will be from the encoder input to + * the decoder output. (we assume the decoder matches the spec). + * + * *Decoding:* + * + * Number of frames delay in addition to what a standard decoder + * as specified in the spec would produce. + * + * *Video:* * - * Video: * Number of frames the decoded output will be delayed relative to the * encoded input. * - * Audio: + * *Audio:* + * * For encoding, this field is unused (see initial_padding). * * For decoding, this is the number of samples the decoder needs to diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 35b7f78ec7..be97947bd1 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -882,19 +882,27 @@ typedef struct AVStream { AVRational time_base; /** - * Decoding: pts of the first frame of the stream in presentation order, in stream time base. - * Only set this if you are absolutely 100% sure that the value you set - * it to really is the pts of the first frame. - * This may be undefined (AV_NOPTS_VALUE). + * *Decoding:* + * + * pts of the first frame of the stream in presentation order, in stream time base. + * + * Only set this if you are absolutely 100% sure that the value you set + * it to really is the pts of the first frame. + * + * This may be undefined (AV_NOPTS_VALUE). + * * @note The ASF header does NOT contain a correct start_time the ASF * demuxer must NOT set this. */ int64_t start_time; /** - * Decoding: duration of the stream, in stream time base. - * If a source file does not specify a duration, but does specify - * a bitrate, this value will be estimated from bitrate and file size. + * *Decoding:* + * + * Duration of the stream, in stream time base. + * + * If a source file does not specify a duration, but does specify + * a bitrate, this value will be estimated from bitrate and file size. * * - decoding: set by libavformat * - encoding: may be set by the caller before avformat_write_header() to -- 2.43.0 _______________________________________________ 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".