From e564de26b363f306cf03960217a097a74c944efd Mon Sep 17 00:00:00 2001 From: Stefano Sabatini Date: Sun, 22 Jul 2012 12:12:51 +0200 Subject: [PATCH] lavfi/avfilter.h: add doxy for AVFilterLink.out_buf --- libavfilter/avfilter.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h index 47435f0879..91820dde3b 100644 --- a/libavfilter/avfilter.h +++ b/libavfilter/avfilter.h @@ -594,6 +594,24 @@ struct AVFilterLink { */ AVFilterBufferRef *cur_buf; + /** + * The buffer reference to the frame which is sent to output by + * the source filter. + * + * If no start_frame callback is defined on a link, + * ff_start_frame() will automatically request a new buffer on the + * first output link of the destination filter. The reference to + * the buffer so obtained is stored in the out_buf field on the + * output link. + * + * It can also be set by the filter code in case the filter needs + * to access the output buffer later. For example the filter code + * may set it in a custom start_frame, and access it in + * draw_slice. + * + * It is automatically freed by the filter system in + * ff_end_frame(). + */ AVFilterBufferRef *out_buf; struct AVFilterPool *pool;