summaryrefslogtreecommitdiff
path: root/libavfilter/avfilter.h
diff options
context:
space:
mode:
authorNicolas George <nicolas.george@normalesup.org>2012-07-29 18:58:42 +0200
committerNicolas George <nicolas.george@normalesup.org>2012-08-04 21:49:05 +0200
commit8d6eed7b56ee83e6e0a7d6c1fe4c87754fd88560 (patch)
treefc724ab08a3b4ee9eab31bbd45ae04d2723cf4e0 /libavfilter/avfilter.h
parent8ef740ce01abff3bc7df0f79803a3dc781d89daa (diff)
lavfi: document the constraints on incoming frames.
Diffstat (limited to 'libavfilter/avfilter.h')
-rw-r--r--libavfilter/avfilter.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index 0e7111d53b..54a0b97897 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -260,6 +260,12 @@ struct AVFilterPad {
* NULL, the filter layer will default to storing a reference to the
* picture inside the link structure.
*
+ * The reference given as argument is also available in link->cur_buf.
+ * It can be stored elsewhere or given away, but then clearing
+ * link->cur_buf is advised, as it is automatically unreferenced.
+ * The reference must not be unreferenced before end_frame(), as it may
+ * still be in use by the automatic copy mechanism.
+ *
* Input video pads only.
*
* @return >= 0 on success, a negative AVERROR on error. picref will be