From 3e12b5893d94f8cada7e8a040007a039c62f880d Mon Sep 17 00:00:00 2001 From: Mina Nagy Zaki Date: Thu, 4 Aug 2011 15:47:01 +0300 Subject: [PATCH] lavfi: fix doxygen doc for config_props() callback Update/extend documentation related to the link fields to set, and fix a pads->filters braino. Signed-off-by: Stefano Sabatini --- libavfilter/avfilter.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h index 66061b9a67..4c3192e9d0 100644 --- a/libavfilter/avfilter.h +++ b/libavfilter/avfilter.h @@ -438,15 +438,18 @@ struct AVFilterPad { /** * Link configuration callback. * - * For output pads, this should set the link properties such as - * width/height. This should NOT set the format property - that is - * negotiated between filters by the filter system using the + * For output pads, this should set the following link properties: + * video: width, height, sample_aspect_ratio, time_base + * audio: sample_rate. + * + * This should NOT set properties such as format, channel_layout, etc which + * are negotiated between filters by the filter system using the * query_formats() callback before this function is called. * * For input pads, this should check the properties of the link, and update * the filter's internal state as necessary. * - * For both input and output filters, this should return zero on success, + * For both input and output pads, this should return zero on success, * and another value on error. */ int (*config_props)(AVFilterLink *link);