git.sesse.net Git - ffmpeg/blob - libavfilter/internal.h

   1 /*
   2  * This file is part of Libav.
   3  *
   4  * Libav is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * Libav is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with Libav; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef AVFILTER_INTERNAL_H
  20 #define AVFILTER_INTERNAL_H
  21
  22 /**
  23  * @file
  24  * internal API functions
  25  */
  26
  27 #include "libavutil/internal.h"
  28 #include "avfilter.h"
  29 #include "thread.h"
  30 #include "version.h"
  31
  32 /**
  33  * A filter pad used for either input or output.
  34  */
  35 struct AVFilterPad {
  36     /**
  37      * Pad name. The name is unique among inputs and among outputs, but an
  38      * input may have the same name as an output. This may be NULL if this
  39      * pad has no need to ever be referenced by name.
  40      */
  41     const char *name;
  42
  43     /**
  44      * AVFilterPad type.
  45      */
  46     enum AVMediaType type;
  47
  48     /**
  49      * Callback function to get a video buffer. If NULL, the filter system will
  50      * use avfilter_default_get_video_buffer().
  51      *
  52      * Input video pads only.
  53      */
  54     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
  55
  56     /**
  57      * Callback function to get an audio buffer. If NULL, the filter system will
  58      * use avfilter_default_get_audio_buffer().
  59      *
  60      * Input audio pads only.
  61      */
  62     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
  63
  64     /**
  65      * Filtering callback. This is where a filter receives a frame with
  66      * audio/video data and should do its processing.
  67      *
  68      * Input pads only.
  69      *
  70      * @return >= 0 on success, a negative AVERROR on error. This function
  71      * must ensure that samplesref is properly unreferenced on error if it
  72      * hasn't been passed on to another filter.
  73      */
  74     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
  75
  76     /**
  77      * Frame poll callback. This returns the number of immediately available
  78      * samples. It should return a positive value if the next request_frame()
  79      * is guaranteed to return one frame (with no delay).
  80      *
  81      * Defaults to just calling the source poll_frame() method.
  82      *
  83      * Output pads only.
  84      */
  85     int (*poll_frame)(AVFilterLink *link);
  86
  87     /**
  88      * Frame request callback. A call to this should result in at least one
  89      * frame being output over the given link. This should return zero on
  90      * success, and another value on error.
  91      *
  92      * Output pads only.
  93      */
  94     int (*request_frame)(AVFilterLink *link);
  95
  96     /**
  97      * Link configuration callback.
  98      *
  99      * For output pads, this should set the link properties such as
 100      * width/height. This should NOT set the format property - that is
 101      * negotiated between filters by the filter system using the
 102      * query_formats() callback before this function is called.
 103      *
 104      * For input pads, this should check the properties of the link, and update
 105      * the filter's internal state as necessary.
 106      *
 107      * For both input and output filters, this should return zero on success,
 108      * and another value on error.
 109      */
 110     int (*config_props)(AVFilterLink *link);
 111
 112     /**
 113      * The filter expects a fifo to be inserted on its input link,
 114      * typically because it has a delay.
 115      *
 116      * input pads only.
 117      */
 118     int needs_fifo;
 119
 120     /**
 121      * The filter expects writable frames from its input link,
 122      * duplicating data buffers if needed.
 123      *
 124      * input pads only.
 125      */
 126     int needs_writable;
 127 };
 128
 129 struct AVFilterGraphInternal {
 130     void *thread;
 131     avfilter_execute_func *thread_execute;
 132 };
 133
 134 struct AVFilterInternal {
 135     avfilter_execute_func *execute;
 136 };
 137
 138 #if FF_API_AVFILTERBUFFER
 139 /** default handler for freeing audio/video buffer when there are no references left */
 140 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
 141 #endif
 142
 143 /** Tell is a format is contained in the provided list terminated by -1. */
 144 int ff_fmt_is_in(int fmt, const int *fmts);
 145
 146 #define FF_DPRINTF_START(ctx, func) av_log(NULL, AV_LOG_TRACE, "%-16s: ", #func)
 147
 148 void ff_dlog_link(void *ctx, AVFilterLink *link, int end);
 149
 150 /**
 151  * Insert a new pad.
 152  *
 153  * @param idx Insertion point. Pad is inserted at the end if this point
 154  *            is beyond the end of the list of pads.
 155  * @param count Pointer to the number of pads in the list
 156  * @param padidx_off Offset within an AVFilterLink structure to the element
 157  *                   to increment when inserting a new pad causes link
 158  *                   numbering to change
 159  * @param pads Pointer to the pointer to the beginning of the list of pads
 160  * @param links Pointer to the pointer to the beginning of the list of links
 161  * @param newpad The new pad to add. A copy is made when adding.
 162  */
 163 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
 164                    AVFilterPad **pads, AVFilterLink ***links,
 165                    AVFilterPad *newpad);
 166
 167 /** Insert a new input pad for the filter. */
 168 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
 169                                    AVFilterPad *p)
 170 {
 171     ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
 172                   &f->input_pads, &f->inputs, p);
 173 }
 174
 175 /** Insert a new output pad for the filter. */
 176 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
 177                                     AVFilterPad *p)
 178 {
 179     ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
 180                   &f->output_pads, &f->outputs, p);
 181 }
 182
 183 /**
 184  * Poll a frame from the filter chain.
 185  *
 186  * @param  link the input link
 187  * @return the number of immediately available frames, a negative
 188  * number in case of error
 189  */
 190 int ff_poll_frame(AVFilterLink *link);
 191
 192 /**
 193  * Request an input frame from the filter at the other end of the link.
 194  *
 195  * @param link the input link
 196  * @return     zero on success
 197  */
 198 int ff_request_frame(AVFilterLink *link);
 199
 200 /**
 201  * Send a frame of data to the next filter.
 202  *
 203  * @param link   the output link over which the data is being sent
 204  * @param frame a reference to the buffer of data being sent. The
 205  *              receiving filter will free this reference when it no longer
 206  *              needs it or pass it on to the next filter.
 207  *
 208  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
 209  * is responsible for unreferencing frame in case of error.
 210  */
 211 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
 212
 213 /**
 214  * Allocate a new filter context and return it.
 215  *
 216  * @param filter what filter to create an instance of
 217  * @param inst_name name to give to the new filter context
 218  *
 219  * @return newly created filter context or NULL on failure
 220  */
 221 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
 222
 223 /**
 224  * Remove a filter from a graph;
 225  */
 226 void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
 227
 228 #endif /* AVFILTER_INTERNAL_H */