avfiltergraph.h 4.05 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Filter graphs
 * copyright (c) 2007 Bobby Bingham
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

22 23
#ifndef AVFILTER_AVFILTERGRAPH_H
#define AVFILTER_AVFILTERGRAPH_H
24 25 26

#include "avfilter.h"

Vitor Sessak's avatar
Vitor Sessak committed
27 28 29
typedef struct AVFilterGraph {
    unsigned filter_count;
    AVFilterContext **filters;
30 31

    char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
32
} AVFilterGraph;
Vitor Sessak's avatar
Vitor Sessak committed
33

34 35 36 37 38
/**
 * Allocate a filter graph.
 */
AVFilterGraph *avfilter_graph_alloc(void);

39
/**
40
 * Get a filter instance with name name from graph.
41 42 43
 *
 * @return the pointer to the found filter instance or NULL if it
 * 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
 */
Vitor Sessak's avatar
Vitor Sessak committed
53
int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
54

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/**
 * Create and add a filter instance into an existing graph.
 * The filter instance is created from the filter filt and inited
 * with the parameters args and opaque.
 *
 * In case of success put in *filt_ctx the pointer to the created
 * filter instance, otherwise set *filt_ctx to NULL.
 *
 * @param name the instance name to give to the created filter instance
 * @param graph_ctx the filter graph
 * @return a negative AVERROR error code in case of failure, a non
 * negative value otherwise
 */
int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
                                 const char *name, const char *args, void *opaque,
                                 AVFilterGraph *graph_ctx);

72 73 74
/**
 * Check validity and configure all the links and formats in the graph.
 *
75 76 77
 * @param graphctx the filter graph
 * @param log_ctx context used for logging
 * @return 0 in case of success, a negative AVERROR code otherwise
78 79 80
 */
int avfilter_graph_config(AVFilterGraph *graphctx, AVClass *log_ctx);

81
/**
82 83
 * Free a graph, destroy its links, and set *graph to NULL.
 * If *graph is NULL, do nothing.
84
 */
85
void avfilter_graph_free(AVFilterGraph **graph);
86

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
/**
 * A linked-list of the inputs/outputs of the filter chain.
 *
 * This is mainly useful for avfilter_graph_parse(), since this
 * function may accept a description of a graph with not connected
 * input/output pads. This struct specifies, per each not connected
 * pad contained in the graph, the filter context and the pad index
 * required for establishing a link.
 */
typedef struct AVFilterInOut {
    /** unique name for this input/output in the list */
    char *name;

    /** filter context associated to this input/output */
    AVFilterContext *filter_ctx;

    /** index of the filt_ctx pad to use for linking */
    int pad_idx;

    /** next input/input in the list, NULL if this is the last */
    struct AVFilterInOut *next;
} AVFilterInOut;

/**
 * Add a graph described by a string to a graph.
 *
 * @param graph   the filter graph where to link the parsed graph context
 * @param filters string to be parsed
 * @param inputs  linked list to the inputs of the graph
 * @param outputs linked list to the outputs of the graph
 * @return zero on success, a negative AVERROR code on error
 */
int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
                         AVFilterInOut *inputs, AVFilterInOut *outputs,
                         AVClass *log_ctx);

123
#endif  /* AVFILTER_AVFILTERGRAPH_H */