aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2015-01-27 13:22:48 +0100
committerStefano Sabatini <stefasab@gmail.com>2015-01-29 11:12:39 +0100
commitd43c1ec684ced58e2d4288c850ea774f06df9d23 (patch)
treea34ea4d7b6ca884170d75b04f83e69cf2a5e183b /doc
parentaf7b89e08be8c4b39fd70ef59f50c5940f0dd187 (diff)
downloadffmpeg-d43c1ec684ced58e2d4288c850ea774f06df9d23.tar.gz
examples/filtering: extend comments about setting the filter graph endpoints
That part is a constant source of confusions for readers, this should help clarify the apparently inverted logic.
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/filtering_audio.c18
-rw-r--r--doc/examples/filtering_video.c18
2 files changed, 34 insertions, 2 deletions
diff --git a/doc/examples/filtering_audio.c b/doc/examples/filtering_audio.c
index 46595fb3b8..f5cb8eb8a1 100644
--- a/doc/examples/filtering_audio.c
+++ b/doc/examples/filtering_audio.c
@@ -145,12 +145,28 @@ static int init_filters(const char *filters_descr)
goto end;
}
- /* Endpoints for the filter graph. */
+ /*
+ * Set the endpoints for the filter graph. The filter_graph will
+ * be linked to the graph described by filters_descr.
+ */
+
+ /*
+ * The buffer source output must be connected to the input pad of
+ * the first filter described by filters_descr; since the first
+ * filter input label is not specified, it is set to "in" by
+ * default.
+ */
outputs->name = av_strdup("in");
outputs->filter_ctx = buffersrc_ctx;
outputs->pad_idx = 0;
outputs->next = NULL;
+ /*
+ * The buffer sink input must be connected to the output pad of
+ * the last filter described by filters_descr; since the last
+ * filter output label is not specified, it is set to "out" by
+ * default.
+ */
inputs->name = av_strdup("out");
inputs->filter_ctx = buffersink_ctx;
inputs->pad_idx = 0;
diff --git a/doc/examples/filtering_video.c b/doc/examples/filtering_video.c
index 601c3d87f0..c02040ae35 100644
--- a/doc/examples/filtering_video.c
+++ b/doc/examples/filtering_video.c
@@ -128,12 +128,28 @@ static int init_filters(const char *filters_descr)
goto end;
}
- /* Endpoints for the filter graph. */
+ /*
+ * Set the endpoints for the filter graph. The filter_graph will
+ * be linked to the graph described by filters_descr.
+ */
+
+ /*
+ * The buffer source output must be connected to the input pad of
+ * the first filter described by filters_descr; since the first
+ * filter input label is not specified, it is set to "in" by
+ * default.
+ */
outputs->name = av_strdup("in");
outputs->filter_ctx = buffersrc_ctx;
outputs->pad_idx = 0;
outputs->next = NULL;
+ /*
+ * The buffer sink input must be connected to the output pad of
+ * the last filter described by filters_descr; since the last
+ * filter output label is not specified, it is set to "out" by
+ * default.
+ */
inputs->name = av_strdup("out");
inputs->filter_ctx = buffersink_ctx;
inputs->pad_idx = 0;