summaryrefslogtreecommitdiff
path: root/libavfilter
diff options
context:
space:
mode:
authorMina Nagy Zaki <mnzaki@gmail.com>2011-08-04 15:47:01 +0300
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2011-08-06 12:14:37 +0200
commit3e12b5893d94f8cada7e8a040007a039c62f880d (patch)
tree966ef39c5855047fe8468f6012ebbebea93b01df /libavfilter
parent5f68a91be242c05bdd5aeffd74b36a1e6c782dd5 (diff)
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 <stefano.sabatini-lala@poste.it>
Diffstat (limited to 'libavfilter')
-rw-r--r--libavfilter/avfilter.h11
1 files 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);