Remove graphparser.h header, move AVFilterInOut and
[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 * Allocate a filter graph.
36 */
37 AVFilterGraph *avfilter_graph_alloc(void);
38
39 /**
40 * Get a filter instance with name name from graph.
41 *
42 * @return the pointer to the found filter instance or NULL if it
43 * cannot be found.
44 */
45 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
46
47 /**
48 * Add an existing filter instance to a filter graph.
49 *
50 * @param graphctx the filter graph
51 * @param filter the filter to be added
52 */
53 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
54
55 /**
56 * Check for the validity of graph.
57 *
58 * A graph is considered valid if all its input and output pads are
59 * connected.
60 *
61 * @return 0 in case of success, a negative value otherwise
62 */
63 int avfilter_graph_check_validity(AVFilterGraph *graphctx, AVClass *log_ctx);
64
65 /**
66 * Configure all the links of graphctx.
67 *
68 * @return 0 in case of success, a negative value otherwise
69 */
70 int avfilter_graph_config_links(AVFilterGraph *graphctx, AVClass *log_ctx);
71
72 /**
73 * Configure the formats of all the links in the graph.
74 */
75 int avfilter_graph_config_formats(AVFilterGraph *graphctx, AVClass *log_ctx);
76
77 /**
78 * Check validity and configure all the links and formats in the graph.
79 *
80 * @see avfilter_graph_check_validity(), avfilter_graph_config_links(),
81 * avfilter_graph_config_formats()
82 */
83 int avfilter_graph_config(AVFilterGraph *graphctx, AVClass *log_ctx);
84
85 /**
86 * Free a graph and destroy its links.
87 */
88 void avfilter_graph_free(AVFilterGraph *graph);
89
90 /**
91 * A linked-list of the inputs/outputs of the filter chain.
92 *
93 * This is mainly useful for avfilter_graph_parse(), since this
94 * function may accept a description of a graph with not connected
95 * input/output pads. This struct specifies, per each not connected
96 * pad contained in the graph, the filter context and the pad index
97 * required for establishing a link.
98 */
99 typedef struct AVFilterInOut {
100 /** unique name for this input/output in the list */
101 char *name;
102
103 /** filter context associated to this input/output */
104 AVFilterContext *filter_ctx;
105
106 /** index of the filt_ctx pad to use for linking */
107 int pad_idx;
108
109 /** next input/input in the list, NULL if this is the last */
110 struct AVFilterInOut *next;
111 } AVFilterInOut;
112
113 /**
114 * Add a graph described by a string to a graph.
115 *
116 * @param graph the filter graph where to link the parsed graph context
117 * @param filters string to be parsed
118 * @param inputs linked list to the inputs of the graph
119 * @param outputs linked list to the outputs of the graph
120 * @return zero on success, a negative AVERROR code on error
121 */
122 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
123 AVFilterInOut *inputs, AVFilterInOut *outputs,
124 AVClass *log_ctx);
125
126 #endif /* AVFILTER_AVFILTERGRAPH_H */