diff options
| author | Andrew Sayers <ffmpeg-devel@pileofstuff.org> | 2024-04-24 08:30:28 +0100 |
|---|---|---|
| committer | Michael Niedermayer <michael@niedermayer.cc> | 2024-05-01 02:57:13 +0200 |
| commit | 99e43a6dfecbc170192d3229a725cc963c6e7c15 (patch) | |
| tree | bf1938935b782b75f3d145400e3feeeab86aa4cc /libavutil/opt.h | |
| parent | 9f54c13bc4650c59fe2ffb04f5b85145f196fbb7 (diff) | |
| download | ffmpeg-99e43a6dfecbc170192d3229a725cc963c6e7c15.tar.gz | |
lavu/opt: Clarify the scope of AVOptions
See discussion on the mailing list:
https://ffmpeg.org/pipermail/ffmpeg-devel/2024-April/326054.html
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavutil/opt.h')
| -rw-r--r-- | libavutil/opt.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/libavutil/opt.h b/libavutil/opt.h index 855e363091..e8f4e69705 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. * |