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 7A09047286 for ; Tue, 3 Oct 2023 11:02:16 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 507D568CBB6; Tue, 3 Oct 2023 14:02:12 +0300 (EEST) Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id CF01F68CBFE for ; Tue, 3 Oct 2023 14:02:05 +0300 (EEST) Received: from localhost (localhost [IPv6:::1]) by mail0.khirnov.net (Postfix) with ESMTP id 705BE240490 for ; Tue, 3 Oct 2023 13:02:05 +0200 (CEST) Received: from mail0.khirnov.net ([IPv6:::1]) by localhost (mail0.khirnov.net [IPv6:::1]) (amavis, port 10024) with ESMTP id zSqM5diDN-Jt for ; Tue, 3 Oct 2023 13:02:04 +0200 (CEST) Received: from lain.khirnov.net (lain.khirnov.net [IPv6:2001:67c:1138:4306::3]) (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 "lain.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail0.khirnov.net (Postfix) with ESMTPS id D7783240445 for ; Tue, 3 Oct 2023 13:02:04 +0200 (CEST) Received: by lain.khirnov.net (Postfix, from userid 1000) id B3FD51601B9; Tue, 3 Oct 2023 13:02:04 +0200 (CEST) From: Anton Khirnov To: FFmpeg development discussions and patches In-Reply-To: <20230927131242.1950-5-jamrial@gmail.com> References: <20230927131242.1950-1-jamrial@gmail.com> <20230927131242.1950-5-jamrial@gmail.com> Mail-Followup-To: FFmpeg development discussions and patches Date: Tue, 03 Oct 2023 13:02:04 +0200 Message-ID: <169633092470.6638.11150484080536467126@lain.khirnov.net> User-Agent: alot/0.8.1 MIME-Version: 1.0 Subject: Re: [FFmpeg-devel] [PATCH 04/11] avcodec/packet: add some documentation for AVPacketSideData 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 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: Quoting James Almer (2023-09-27 15:12:35) > Explaining what or who may use it, and in what scenarios. > > Signed-off-by: James Almer > --- > libavcodec/packet.h | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) > > diff --git a/libavcodec/packet.h b/libavcodec/packet.h > index 96fc0084d6..f88dad2b3c 100644 > --- a/libavcodec/packet.h > +++ b/libavcodec/packet.h > @@ -312,6 +312,21 @@ enum AVPacketSideDataType { > > #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED > > +/** > + * This structure stores auxiliary ...information for decoding, presenting, or otherwise processing the coded stream. > It is typically exported by demuxers > + * within @ref AVStream.codecpar.side_data "AVStream's codec parameters" or an > + * @ref AVPacket.side_data "AVPacket" and then passed as input to decoders > + * through the @ref AVCodecContext.coded_side_data "decoder context's side data" > + * for initialization or through @ref AVPacket.side_data "AVPacket", or received > + * as output from encoders within the @ref AVCodecContext.coded_side_data > + * "encoder context's side data" or @ref AVPacket.side_data "AVPacket" and then > + * passed to muxers through @ref AVStream.codecpar.side_data "AVStream's codec > + * parameters" for initialization or through @ref AVPacket.side_data "AVPacket". Long sentence is long. Consider the following: * first state that it may be global or per-packet * then describe the typical decoding path (demuxer->decoder, mention that it may be mapped to frame side data) * then same for encoding > + * Different modules may export or be provided different types of side data ^^^^^^^^^^^^^^^^^^^^^ accept or export Also, the doxy for AVCodecContext.coded_side_data, AVCodecParameters.side_data and AVPacket.side_data should link to this text, so it's actually discoverable for readers. -- Anton Khirnov _______________________________________________ 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".