df71ef85431aaa1dff0377aaa5b39f09bd207af6
[libav.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 * @param graph The filter graph
45 * @param filter The filter to be added
46 */
47 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
48
49 /**
50 * Checks for the validity of graph.
51 *
52 * A graph is considered valid if all its input and output pads are
53 * connected.
54 *
55 * @return 0 in case of success, a negative value otherwise
56 */
57 int avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
58
59 /**
60 * Configures all the links of graphctx.
61 *
62 * @return 0 in case of success, a negative value otherwise
63 */
64 int avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
65
66 /**
67 * Configures the formats of all the links in the graph.
68 */
69 int avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
70
71 /**
72 * Frees a graph and destroys its links.
73 */
74 void avfilter_graph_destroy(AVFilterGraph *graph);
75
76 #endif /* AVFILTER_AVFILTERGRAPH_H */