Add avfilter_graph_create_filter().
[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  * 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  * Create and add a filter instance into an existing graph.
57  * The filter instance is created from the filter filt and inited
58  * with the parameters args and opaque.
59  *
60  * In case of success put in *filt_ctx the pointer to the created
61  * filter instance, otherwise set *filt_ctx to NULL.
62  *
63  * @param name the instance name to give to the created filter instance
64  * @param graph_ctx the filter graph
65  * @return a negative AVERROR error code in case of failure, a non
66  * negative value otherwise
67  */
68 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
69                                  const char *name, const char *args, void *opaque,
70                                  AVFilterGraph *graph_ctx);
71
72 /**
73  * Check validity and configure all the links and formats in the graph.
74  *
75  * @param graphctx the filter graph
76  * @param log_ctx context used for logging
77  * @return 0 in case of success, a negative AVERROR code otherwise
78  */
79 int avfilter_graph_config(AVFilterGraph *graphctx, AVClass *log_ctx);
80
81 /**
82  * Free a graph and destroy its links.
83  */
84 void avfilter_graph_free(AVFilterGraph *graph);
85
86 /**
87  * A linked-list of the inputs/outputs of the filter chain.
88  *
89  * This is mainly useful for avfilter_graph_parse(), since this
90  * function may accept a description of a graph with not connected
91  * input/output pads. This struct specifies, per each not connected
92  * pad contained in the graph, the filter context and the pad index
93  * required for establishing a link.
94  */
95 typedef struct AVFilterInOut {
96     /** unique name for this input/output in the list */
97     char *name;
98
99     /** filter context associated to this input/output */
100     AVFilterContext *filter_ctx;
101
102     /** index of the filt_ctx pad to use for linking */
103     int pad_idx;
104
105     /** next input/input in the list, NULL if this is the last */
106     struct AVFilterInOut *next;
107 } AVFilterInOut;
108
109 /**
110  * Add a graph described by a string to a graph.
111  *
112  * @param graph   the filter graph where to link the parsed graph context
113  * @param filters string to be parsed
114  * @param inputs  linked list to the inputs of the graph
115  * @param outputs linked list to the outputs of the graph
116  * @return zero on success, a negative AVERROR code on error
117  */
118 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
119                          AVFilterInOut *inputs, AVFilterInOut *outputs,
120                          AVClass *log_ctx);
121
122 #endif  /* AVFILTER_AVFILTERGRAPH_H */