diff mbox series

[FFmpeg-devel,10/10] lavfi: clarify the behaviour of avfilter_graph_create_filter()

Message ID 20240925132921.11203-10-anton@khirnov.net
State New
Headers show
Series [FFmpeg-devel,01/10] fftools/ffmpeg_filter: stop using avfilter_graph_alloc_filter() incorrectly | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Anton Khirnov Sept. 25, 2024, 1:29 p.m. UTC 
Mention explicitly that no options can be set manually when using this
function.
---
 libavfilter/avfilter.h | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index 1401577c50..21066dd8da 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -845,9 +845,9 @@  AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name);
 
 /**
- * Create and add a filter instance into an existing graph.
- * The filter instance is created from the filter filt and inited
- * with the parameter args. opaque is currently ignored.
+ * A convenience wrapper that allocates and initializes a filter in a single
+ * step. The filter instance is created from the filter filt and inited with the
+ * parameter args. opaque is currently ignored.
  *
  * In case of success put in *filt_ctx the pointer to the created
  * filter instance, otherwise set *filt_ctx to NULL.
@@ -856,6 +856,11 @@  AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *nam
  * @param graph_ctx the filter graph
  * @return a negative AVERROR error code in case of failure, a non
  * negative value otherwise
+ *
+ * @note Since the filter is initialized after this function successfully
+ *       returns, you MUST NOT set any further options on it. If you need to do
+ *       that, call avfilter_graph_alloc_filter(), followed by setting the
+ *       options, followed by avfilter_init_dict() instead of this function.
  */
 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
                                  const char *name, const char *args, void *opaque,