diff mbox

[FFmpeg-devel,8/9] lavfi: document that AVFilterLink is not for applications.

Message ID 20161227180210.23100-8-george@nsup.org
State Accepted
Headers show

Commit Message

Nicolas George Dec. 27, 2016, 6:02 p.m. UTC 
Signed-off-by: Nicolas George <george@nsup.org>
---
 libavfilter/avfilterlink.h | 5 +++++
 1 file changed, 5 insertions(+)


I made the phrasing "filters implementation" intentionally vague: it can
mean filters within libavfilter or external filters as Michael wants.
diff mbox

Patch

diff --git a/libavfilter/avfilterlink.h b/libavfilter/avfilterlink.h
index 51ab322ae9..f8cc13923a 100644
--- a/libavfilter/avfilterlink.h
+++ b/libavfilter/avfilterlink.h
@@ -34,6 +34,11 @@ 
  * the pads involved. In addition, this link also contains the parameters
  * which have been negotiated and agreed upon between the filter, such as
  * image dimensions, format, etc.
+ *
+ * Applications must not normally access the link structure directly,
+ * and therefore should not include avfilterlink.h. Use the buffersrc and
+ * buffersink API instead. In the future, access to the header may be
+ * reserved for filters implementation.
  */
 struct AVFilterLink {
     AVFilterContext *src;       ///< source filter