git.sesse.net Git - ffmpeg/blob - 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 validity and configure all the links and formats in the graph.
  57  *
  58  * @param graphctx the filter graph
  59  * @param log_ctx context used for logging
  60  * @return 0 in case of success, a negative AVERROR code otherwise
  61  */
  62 int avfilter_graph_config(AVFilterGraph *graphctx, AVClass *log_ctx);
  63
  64 /**
  65  * Free a graph and destroy its links.
  66  */
  67 void avfilter_graph_free(AVFilterGraph *graph);
  68
  69 /**
  70  * A linked-list of the inputs/outputs of the filter chain.
  71  *
  72  * This is mainly useful for avfilter_graph_parse(), since this
  73  * function may accept a description of a graph with not connected
  74  * input/output pads. This struct specifies, per each not connected
  75  * pad contained in the graph, the filter context and the pad index
  76  * required for establishing a link.
  77  */
  78 typedef struct AVFilterInOut {
  79     /** unique name for this input/output in the list */
  80     char *name;
  81
  82     /** filter context associated to this input/output */
  83     AVFilterContext *filter_ctx;
  84
  85     /** index of the filt_ctx pad to use for linking */
  86     int pad_idx;
  87
  88     /** next input/input in the list, NULL if this is the last */
  89     struct AVFilterInOut *next;
  90 } AVFilterInOut;
  91
  92 /**
  93  * Add a graph described by a string to a graph.
  94  *
  95  * @param graph   the filter graph where to link the parsed graph context
  96  * @param filters string to be parsed
  97  * @param inputs  linked list to the inputs of the graph
  98  * @param outputs linked list to the outputs of the graph
  99  * @return zero on success, a negative AVERROR code on error
 100  */
 101 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
 102                          AVFilterInOut *inputs, AVFilterInOut *outputs,
 103                          AVClass *log_ctx);
 104
 105 #endif  /* AVFILTER_AVFILTERGRAPH_H */