diff mbox series

[FFmpeg-devel,v3,1/3] lavu/opt: Rename AV_OPT_FLAG_RUNTIME_PARAM to ...POST_INIT_SETTABLE_PARAM

Message ID 20240616170934.426015-2-ffmpeg-devel@pileofstuff.org
State New
Headers show
Series s/RUNTIME/POST_INIT_SETTABLE/ | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Andrew Sayers June 16, 2024, 5:08 p.m. UTC 
The old name could be misread as the opposite of "AV_OPT_FLAG_READONLY" -
some things can be set at runtime, others are read-only.  Clarify that
this refers to options that can be set after the struct is initialized.
---
 libavutil/opt.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/libavutil/opt.h b/libavutil/opt.h
index 07e27a9208..e050d126ed 100644
--- a/libavutil/opt.h
+++ b/libavutil/opt.h
@@ -53,6 +53,9 @@ 
  * question is allowed to access the field. This allows us to extend the
  * semantics of those fields without breaking API compatibility.
  *
+ * Note: only options with the AV_OPT_FLAG_POST_INIT_SETTABLE_PARAM flag can be
+ * modified after the struct is initialized.
+ *
  * @section avoptions_scope Scope of AVOptions
  *
  * AVOptions is designed to support any set of multimedia configuration options
@@ -300,7 +303,12 @@  enum AVOptionType{
 #define AV_OPT_FLAG_BSF_PARAM       (1 << 8)
 
 /**
- * A generic parameter which can be set by the user at runtime.
+ * A generic parameter which can be set by the user after the struct is initialized.
+ */
+#define AV_OPT_FLAG_POST_INIT_SETTABLE_PARAM   (1 << 15)
+/**
+ * A generic parameter which can be set by the user after the struct is initialized.
+ * @deprecated Renamed to AV_OPT_FLAG_POST_INIT_SETTABLE_PARAM for clarity
  */
 #define AV_OPT_FLAG_RUNTIME_PARAM   (1 << 15)
 /**