Apply grammar/consistency nits to avfilter_graph_add_filter() doxy.
[ffmpeg.git] / libavfilter / avfiltergraph.h
1 /*
2  * Filter graphs
3  * copyright (c) 2007 Bobby Bingham
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVFILTER_AVFILTERGRAPH_H
23 #define AVFILTER_AVFILTERGRAPH_H
24
25 #include "avfilter.h"
26
27 typedef struct AVFilterGraph {
28     unsigned filter_count;
29     AVFilterContext **filters;
30
31     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
32 } AVFilterGraph;
33
34 /**
35  * Gets a filter instance with name name from graph.
36  *
37  * @return the pointer to the found filter instance or NULL if it
38  * cannot be found.
39  */
40 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
41
42 /**
43  * Adds an existing filter instance to a filter graph.
44  *
45  * @param graph  the filter graph
46  * @param filter the filter to be added
47  */
48 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
49
50 /**
51  * Checks for the validity of graph.
52  *
53  * A graph is considered valid if all its input and output pads are
54  * connected.
55  *
56  * @return 0 in case of success, a negative value otherwise
57  */
58 int avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
59
60 /**
61  * Configures all the links of graphctx.
62  *
63  * @return 0 in case of success, a negative value otherwise
64  */
65 int avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
66
67 /**
68  * Configures the formats of all the links in the graph.
69  */
70 int avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
71
72 /**
73  * Frees a graph and destroys its links.
74  */
75 void avfilter_graph_destroy(AVFilterGraph *graph);
76
77 #endif  /* AVFILTER_AVFILTERGRAPH_H */