From patchwork Mon Apr 22 08:49:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Sayers X-Patchwork-Id: 48211 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:c906:b0:1a9:af23:56c1 with SMTP id gx6csp2139585pzb; Mon, 22 Apr 2024 01:50:07 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCVQfOpyxmLXh6VbKhCvicFbQR3RYmk5TMhQJWW8tq4Voc5eYJjvEB5FLtTMker4KyyAdIbe7Yi+3fWNPWd9efvuCG5dWpVnjUlQqg== X-Google-Smtp-Source: AGHT+IF/h2+xKZg27Rmn4n03fMrCXVBzXqO7KR+/X2/WnhGrCbyk2MKcSrVjevIurLhiNvwOua0j X-Received: by 2002:a50:d60f:0:b0:56e:87b3:a333 with SMTP id x15-20020a50d60f000000b0056e87b3a333mr5521106edi.3.1713775807057; Mon, 22 Apr 2024 01:50:07 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1713775806; cv=none; d=google.com; s=arc-20160816; b=b2IeHO8HJ4iH0CNSvA6DpAFWAEfIfSPn2EErd/wOpL6i+SBrbADJQNikZou3g6ihE7 RcuCzxp7E+DJlPRWZrD/daI/gxtM3P25yOwQdgXQoAjYueLOfVgCMD/LB/Bf4V2LrgFx wFrcSfBLB2fOXSUPl6OlpGSN3BY60gjqK4+g2rD4HdN8Jpm3mQXi0dvyPbIKy1fko5ha 0An47+nmlXXbnDSpr1VgstRDeVj3VNVVAiePmDbj0I0zF9AmibE/EESBC3bhBe/xF6GO qUDmVnmINsT1eweXNLtKX5/pFgI5HyAI5suWxDLFzSrvep3WYw9SHQcV+JUZXqSIx6cy Esaw== 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:message-id:date:to:from :delivered-to; bh=AndzQk7crrHqXDS6zax8tYABmiJHxQAOxAkNSmEG3s8=; fh=73ExZnkQ8FYbu/qeQNmI0dtHCfShNh8/NmZJs1umltM=; b=J6vwMFu6G6GkmcB44ZQxwGfUQRMZ/Hy4eCvAQcl+tsGfzzdaAWIm5SD7eiLEXT5abO /odZ5NNsyF7aesUeoSD1p+TJEer1aDM2Tse2AG4AZrsN2/nIipuhJJGcq2xCIuxDNeQe 2qmFuG1206S05JjFwQrm/MdeHUTe2cTY1AEvdnYMFPLUBSAOObd8DXZbachIHgq2vBIM bJKXqIx4ZdBKwXC5R2DYNLJKZoHIBUiAYuxPBeoFgcqd+FlSWa0WRjcN5bJ5VPQe/eoS zZbB0Ja9zIHbF2CWyajRr1ZxHvgBDHnT5ZY+Rg9fFEiJj/AsY4iC1QPgORU9W5Wf+NVZ R2ig==; 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 i3-20020a508703000000b0056fde9c51easi5717241edb.459.2024.04.22.01.50.05; Mon, 22 Apr 2024 01:50:06 -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 3BA60688177; Mon, 22 Apr 2024 11:50:02 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from b-painless.mh.aa.net.uk (b-painless.mh.aa.net.uk [81.187.30.52]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id CBF8D68D23E for ; Mon, 22 Apr 2024 11:49:54 +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-b.tch.aa.net.uk with esmtp (Exim 4.96) (envelope-from ) id 1rypN4-007mfP-0s; Mon, 22 Apr 2024 09:49:54 +0100 From: Andrew Sayers To: ffmpeg-devel@ffmpeg.org Date: Mon, 22 Apr 2024 09:49:45 +0100 Message-ID: <20240422084945.376401-1-ffmpeg-devel@pileofstuff.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] lavu/opt: Clarify that AVOptions is not indended for general use 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: 9ZwoUq4rjVGw --- libavutil/opt.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/libavutil/opt.h b/libavutil/opt.h index e6013662f6..795accb363 100644 --- a/libavutil/opt.h +++ b/libavutil/opt.h @@ -54,7 +54,11 @@ * semantics of those fields without breaking API compatibility. * * @section avoptions_implement Implementing AVOptions + * * This section describes how to add AVOptions capabilities to a struct. + * It is intended for developers of FFmpeg itself - AVOptions can technically + * be used as a more general toolkit, but is neither intended nor expected + * to be good fit for other use cases. * * All AVOptions-related information is stored in an AVClass. Therefore * the first member of the struct should be a pointer to an AVClass describing it.