From patchwork Wed Oct 4 12:28:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Almer X-Patchwork-Id: 44140 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:4f21:b0:15d:8365:d4b8 with SMTP id gi33csp477029pzb; Wed, 4 Oct 2023 05:29:34 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGRQi4uMiQ+w3ef9nmdx/Avq8CsAT/R4xq1/Tgkeolt5IdgX6IJ3XahjJlK5Xqh+sHGUIP/ X-Received: by 2002:a17:907:7719:b0:9ae:63bd:a81d with SMTP id kw25-20020a170907771900b009ae63bda81dmr1909230ejc.71.1696422574456; Wed, 04 Oct 2023 05:29:34 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696422574; cv=none; d=google.com; s=arc-20160816; b=vf+crWIXNQmOCrUu8AQ6Ua/OtKVvEAzYTxiuvMT5X20so9/K4IpSkIWyUY6JAbHPAp L6RURQuU9mdn+Y5yWfoW0zZWtTPcVrlnTlWV3Q7Vl9XH3nBmUD2OV0FQApS8JA4Y8+wc o79rVCIPaQYXwA6oxV3wUtPGLfso5BUogffkwKiqJedtGV2WtKYHo1aGrwpVevJzHie/ 5qDbca1qq0TmBNe/zg/wkY29TAbXw8/kbFp6smWSw7Kdl1pFP+dQgIhvJ7vbpPuwEu5n nG9avbvuFp+QUMsNn9nr/kUGFz/+DNZM89Czgh4VSLgy7TMMLzLsBIFCsV/Cz3gq7tCL JDeg== 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:references:in-reply-to:message-id :date:to:from:dkim-signature:delivered-to; bh=k7PZkOaoZjXs+qowa/Fy6ubLeRTlVqBW2x4BFTCgmzI=; fh=YOA8vD9MJZuwZ71F/05pj6KdCjf6jQRmzLS+CATXUQk=; b=mc+GIxojA8WihHlzwsvWoR0c5Ac0tLuGgprRZFcX9QxhgoOZ6GEaL6suCWzQIcmys7 njnYPYjnoQam3tCA0AHcqLOhIOLiOwhw39plEQb3CQbcBIyFVZjcpYv9FSfHE0kYFgln nj3i8wZ/C11V108AuFCW+2aLBP5mhkaQgDfjaoDee66+4qMEHRJ8YFozKsnbKYK7Psbe bH55SSbbm8MapGGppmCXlJ0655ApQHJZRitR7w5rmrxGcYJOXnP3xHPMwC4C6keMOcsw lZ4+Uk8iW5KzN7iU7IbmQ5BXe2llub1KAeRW5P09lGSo4oDF01ZRG7Iw8G9Ra7wU5y8f /LUg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20230601 header.b=GQYgEbOR; 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 d23-20020a1709067f1700b00992ca650b77si1634065ejr.416.2023.10.04.05.29.34; Wed, 04 Oct 2023 05:29:34 -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=20230601 header.b=GQYgEbOR; 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 9604268CBCD; Wed, 4 Oct 2023 15:29:04 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 2D4C668CC0E for ; Wed, 4 Oct 2023 15:28:58 +0300 (EEST) Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-1c60a514f3aso15961445ad.3 for ; Wed, 04 Oct 2023 05:28:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1696422536; x=1697027336; darn=ffmpeg.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=GboCO06O9YHMhScsWXoo71XRemcyBMDvrlO4rMJj0sE=; b=GQYgEbOReZ2fZipjokGPkU75wr9Jx+IQq4p/d4zND1aCfHAS8qsCOeTAJIzDbBeYTU G/DWCX0ksRTeAWWGQUt4nRaF4i0v9lVEcvkMyd9H4V+0DY6M+y4fh+Mg5gSIVpXgEc4l 2lijv1X+quED0kvSvO0eKMRtbbObBnWNysjLzJPNo9nmeZp+CRvMZ+h4EqY+oteBFCFz CKsrW1QJrLmtRPM1A/5H1tIUAnD2tcVvrnrVJlnnLK0gKJJNdDzivv0H8e7d6bnGWQTv 44RJU31Rl7Wgg+ZLT2d5Ev89ESgc5rm6KqYqcsl0w7e+EFp5NLK4szEMhKoXmxYgpj3e Qz/Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696422536; x=1697027336; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=GboCO06O9YHMhScsWXoo71XRemcyBMDvrlO4rMJj0sE=; b=OmvRLP3EDg9KLODtDa3sb8LmDXRz9TwskDs3SCEvjtqSxfhXeek7e3ND3J/Q+d3iOg Oj0PiWt5He6P+pVEcQ2j7ysyHAjNV4xMg0UPd3Kx1L8UfemCzmxh+UbBNonXU6yl0lKe f6ej+dI9GpqTn9ww0kyqqml4zs1RyNZi6AJxH6nFIAgQG7SiLMXwyqlVjpuJoB5QqYXH dYE3c/fY/2Oe2lkOnJ6kZgvlqfdt/xts5ZlVdYmOZjTbNrwaHvXuZBdg1mCkHaTmSUuF DzFBBE9c/hu6EQm84eMHscsX16VBchL7ZqMGOo9EjQgSIyFOScRsA9THvqsoYVzb9ma5 KV/Q== X-Gm-Message-State: AOJu0Yzo4yCNpNYd7t4smI2/2n0ENbwIGlDbGrxpeZi68iwx0ZDWPuj9 T1Oj4SXHRxNDpMPFmTRAi8Baw30OX5s= X-Received: by 2002:a17:903:22c3:b0:1c3:cee1:cc8e with SMTP id y3-20020a17090322c300b001c3cee1cc8emr2710171plg.68.1696422536152; Wed, 04 Oct 2023 05:28:56 -0700 (PDT) Received: from localhost.localdomain (host197.190-225-105.telecom.net.ar. [190.225.105.197]) by smtp.gmail.com with ESMTPSA id h11-20020a170902748b00b001c57aac6e5esm3551831pll.23.2023.10.04.05.28.55 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Oct 2023 05:28:55 -0700 (PDT) From: James Almer To: ffmpeg-devel@ffmpeg.org Date: Wed, 4 Oct 2023 09:28:42 -0300 Message-ID: <20231004122849.56604-5-jamrial@gmail.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231004122849.56604-1-jamrial@gmail.com> References: <20231004122849.56604-1-jamrial@gmail.com> MIME-Version: 1.0 Subject: [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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: g4fdZcn6y119 Explaining what or who may use it, and in what scenarios. Signed-off-by: James Almer --- libavcodec/packet.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/libavcodec/packet.h b/libavcodec/packet.h index 96fc0084d6..85b3eeb728 100644 --- a/libavcodec/packet.h +++ b/libavcodec/packet.h @@ -312,6 +312,25 @@ enum AVPacketSideDataType { #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED +/** + * This structure stores information for decoding, presenting, or otherwise + * processing the coded stream. It is typically exported by demuxers and + * encoders and can be fed to decoders and muxers in a per packet basis, or as + * global side data (applying to the entire coded stream) as follows: + * - During demuxing, it will be exported through global side data in + * @ref AVStream.codecpar.side_data "AVStream's codec parameters", which can + * then be passed as input to decoders through the + * @ref AVCodecContext.coded_side_data "decoder context's side data", for + * initialization. + * - For muxing, it can be fed through global side data in + * @ref AVStream.codecpar.side_data "AVStream's codec parameters", typically + * the output of encoders through the @ref AVCodecContext.coded_side_data + * "encoder context's side data", for initialization. + * + * Different modules may accept or export different types of side data + * depending on media type and codec. Refer to @ref AVPacketSideDataType for a + * list of defined types and where they may be found or used. + */ typedef struct AVPacketSideData { uint8_t *data; size_t size;