Document AVFilterInOut fields.
[libav.git] / libavfilter / graphparser.h
CommitLineData
f0703f5d
VS
1/*
2 * Filter graph parser
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
98790382
SS
22#ifndef AVFILTER_GRAPHPARSER_H
23#define AVFILTER_GRAPHPARSER_H
f0703f5d
VS
24
25#include "avfilter.h"
26#include "avfiltergraph.h"
27
6a0c770b
VS
28/**
29 * A linked-list of the inputs/outputs of the filter chain.
0b90e4a2
SS
30 *
31 * This is mainly useful for avfilter_graph_parse(), since this
32 * function may accept a description of a graph with not connected
33 * input/output pads. This struct specifies, per each not connected
34 * pad contained in the graph, the filter context and the pad index
35 * required for establishing a link.
6a0c770b
VS
36 */
37typedef struct AVFilterInOut {
0b90e4a2 38 /** unique name for this input/output in the list */
0802356c 39 char *name;
0b90e4a2
SS
40
41 /** filter context associated to this input/output */
7313132b 42 AVFilterContext *filter_ctx;
0b90e4a2
SS
43
44 /** index of the filt_ctx pad to use for linking */
6a0c770b
VS
45 int pad_idx;
46
0b90e4a2 47 /** next input/input in the list, NULL if this is the last */
6a0c770b
VS
48 struct AVFilterInOut *next;
49} AVFilterInOut;
50
f0703f5d 51/**
49bd8e4b 52 * Add a graph described by a string to a graph.
175821c6 53 *
f0703f5d
VS
54 * @param graph the filter graph where to link the parsed graph context
55 * @param filters string to be parsed
175821c6
SS
56 * @param inputs linked list to the inputs of the graph
57 * @param outputs linked list to the outputs of the graph
a6fdd574 58 * @return zero on success, a negative AVERROR code on error
f0703f5d 59 */
86a47378 60int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
e2b5fdaf
VS
61 AVFilterInOut *inputs, AVFilterInOut *outputs,
62 AVClass *log_ctx);
f0703f5d 63
98790382 64#endif /* AVFILTER_GRAPHPARSER_H */