[FFmpeg-devel] [PATCH] lavfi/avfilter.h: add doxy for AVFilterLink.out_buf

[Alexander Strasser]

Hi Stefano,

Stefano Sabatini wrote:
> ---
>  libavfilter/avfilter.h |   16 ++++++++++++++++
>  1 files changed, 16 insertions(+), 0 deletions(-)
> 
> diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
> index a9665f5..70e1bcf 100644
> --- a/libavfilter/avfilter.h
> +++ b/libavfilter/avfilter.h
> @@ -583,6 +583,22 @@ 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, and will set the
> +     * out_buf on the output link to the buffer so obtained.

  No objection from me. But this sentence is a bit long and unwieldy,
especially "the buffer so obtained" sounds odd to me.

  Maybe you can split this in 2 to 3 sentences and be more satisfied
with the result. 

> +     *
> +     * It can also be set by the filter code in case it needs to
> +     * access it later. For example the filter code may define it in a
> +     * custom start_frame, and access it in draw_slice.
> +     *
> +     * It is automatically freed by the filter system in
> +     * ff_end_frame().
> +     */

[...]

  Alexander