summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2015-01-27 13:21:56 +0100
committerStefano Sabatini <stefasab@gmail.com>2015-01-29 10:12:34 +0100
commitaf7b89e08be8c4b39fd70ef59f50c5940f0dd187 (patch)
treef3ba99771cf0fe95ccd54808f456f734e716bf90
parentd11fcf735f4ae916789d45b85a5da783f207f7ec (diff)
lavfi: document assumptions about the input and output labels of a filter graph description
-rw-r--r--doc/filters.texi4
-rw-r--r--libavfilter/avfilter.h4
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 6fd192c285..cba2697fb6 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -195,6 +195,10 @@ instance two input pads. The first output pad of split is labelled
output pad of split is linked to the second input pad of overlay,
which are both unlabelled.
+In a filter description, if the input label of the first filter is not
+specified, "in" is assumed; if the output label of the last filter is not
+specified, "out" is assumed.
+
In a complete filterchain all the unlabelled filter input and output
pads must be connected. A filtergraph is considered valid if all the
filter input and output pads of all the filterchains are connected.
diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index b5220b96d9..d296536151 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -1419,6 +1419,10 @@ int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
/**
* Add a graph described by a string to a graph.
*
+ * In the graph filters description, if the input label of the first
+ * filter is not specified, "in" is assumed; if the output label of
+ * the last filter is not specified, "out" is assumed.
+ *
* @param graph the filter graph where to link the parsed graph context
* @param filters string to be parsed
* @param inputs pointer to a linked list to the inputs of the graph, may be NULL.