From patchwork Wed Apr 24 07:30:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Sayers X-Patchwork-Id: 48244 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a21:2d06:b0:1a9:af23:56c1 with SMTP id tw6csp479784pzb; Wed, 24 Apr 2024 00:30:45 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCWOYAraEnBzHXd5pCZqNw521OqiCd4WtBexYvmJd3CgC87yjryqMfT/UE+oXHa2VOX5xn945zjlSRLXSjiUzwRU/Fy8RIjS8N9Kqw== X-Google-Smtp-Source: AGHT+IEalLf8DEE1X9zrk2w7N49AZUC+woznPRNjmJy1VEyHZdhF8o+H6AcLG2rpSQTKk8ve4U3O X-Received: by 2002:a17:906:6b04:b0:a58:7857:fee7 with SMTP id q4-20020a1709066b0400b00a587857fee7mr948641ejr.68.1713943845116; Wed, 24 Apr 2024 00:30:45 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1713943845; cv=none; d=google.com; s=arc-20160816; b=sSJ0f6Xars4AFjZ6lAKMnnbYkHsgDkCKOBVYjm0VjFE8WcyKzIDQ6FQnzNAmdMdKMf v0o/k4D3NuGgv2K9CAAMdf4MZ213DoVh1DTx1La9oKujlkTarQDj94hY8GTc+Bwa57FZ JmKvxeV+mRQRrnm/gCD6f3s/MbCa1SMnzhuKcmHhWnV5cKku5dzNoovxFdknIFyemzSC IeumGoaj35Ajh3MzM7+4aJXUN22jwB3M8gXOocC3EDQkrbjUziLFqflsz5SK4b1LEemE NiEwBJX2rgkFFQnaLwrXpj+Pc8aAmvcsqCxDy9839IvBa90imbR7JV8bb/NZJHQRGuV8 ptyA== 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:references:in-reply-to :message-id:date:to:from:delivered-to; bh=QEXIrhzD8S7yw5q5THldGHvLpOlk+eD8b1P5ou/Oaww=; fh=73ExZnkQ8FYbu/qeQNmI0dtHCfShNh8/NmZJs1umltM=; b=nbIRaMvUx8XAyC4Rx0OvdvrPDkUaCBOVhC7Nk5PhHNa9eHt8iEVmo/7Jxq23SkZkf2 /ctubH5la3/BXgEJlJFN4P5VGB7wF04LZ7Kv+aaT2mI2tY2AVe52Ij0rgkkm/JN8iTWw dnRbDxUqlzDJYZGuDvvfTO0knd6GNWsPg6OMj+rYj4/riN0Wqe9SXS4VcwbA9qbFrQIP mOtsktuk+QcJbP+kvS0E8eYVeWk2R+Br086STiyueZ66c2HU9p4vvo96PNsqKRR6tXZF 5L25cLoec5fRAnUqZzmN0uQhJWxow5vMXb6hDvHSyiM0cI1kF1MIkhLe810PN8Saagnl XHXw==; dara=google.com 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 k18-20020a170906055200b00a525c60b08asi7893049eja.723.2024.04.24.00.30.44; Wed, 24 Apr 2024 00:30:45 -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 8B98C68D40A; Wed, 24 Apr 2024 10:30:40 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org 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 0164168CFF4 for ; Wed, 24 Apr 2024 10:30:32 +0300 (EEST) Received: from 0.b.4.b.7.4.0.8.c.4.a.5.d.8.b.2.0.5.8.0.9.1.8.0.0.b.8.0.1.0.0.2.ip6.arpa ([2001:8b0:819:850:2b8d:5a4c:8047:b4b0] helo=andrews-2024-laptop.lan) by painless-a.thn.aa.net.uk with esmtp (Exim 4.96) (envelope-from ) id 1rzX5M-00EScd-0r; Wed, 24 Apr 2024 08:30:31 +0100 From: Andrew Sayers To: ffmpeg-devel@ffmpeg.org Date: Wed, 24 Apr 2024 08:30:28 +0100 Message-ID: <20240424073028.565112-1-ffmpeg-devel@pileofstuff.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240423170843.GK6420@pb2> References: <20240423170843.GK6420@pb2> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH v3] lavu/opt: Clarify the scope of AVOptions 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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: 2XWr3HKPh+f+ See discussion on the mailing list: https://ffmpeg.org/pipermail/ffmpeg-devel/2024-April/326054.html --- libavutil/opt.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/libavutil/opt.h b/libavutil/opt.h index e6013662f6..6cf2b39a63 100644 --- a/libavutil/opt.h +++ b/libavutil/opt.h @@ -53,6 +53,16 @@ * question is allowed to access the field. This allows us to extend the * semantics of those fields without breaking API compatibility. * + * @section avoptions_scope Scope of AVOptions + * + * AVOptions is designed to support any set of multimedia configuration options + * that can be defined at compile-time. Although it is mainly used to expose + * FFmpeg options, you are welcome to adapt it to your own use case. + * + * No single approach can ever fully solve the problem of configuration, + * but please submit a patch if you believe you have found a problem + * that is best solved by extending AVOptions. + * * @section avoptions_implement Implementing AVOptions * This section describes how to add AVOptions capabilities to a struct. *