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 "avfilter.h"
  28
  29 #if !FF_API_AVFILTERPAD_PUBLIC
  30 /**
  31  * A filter pad used for either input or output.
  32  */
  33 struct AVFilterPad {
  34     /**
  35      * Pad name. The name is unique among inputs and among outputs, but an
  36      * input may have the same name as an output. This may be NULL if this
  37      * pad has no need to ever be referenced by name.
  38      */
  39     const char *name;
  40
  41     /**
  42      * AVFilterPad type.
  43      */
  44     enum AVMediaType type;
  45
  46     /**
  47      * Minimum required permissions on incoming buffers. Any buffer with
  48      * insufficient permissions will be automatically copied by the filter
  49      * system to a new buffer which provides the needed access permissions.
  50      *
  51      * Input pads only.
  52      */
  53     int min_perms;
  54
  55     /**
  56      * Permissions which are not accepted on incoming buffers. Any buffer
  57      * which has any of these permissions set will be automatically copied
  58      * by the filter system to a new buffer which does not have those
  59      * permissions. This can be used to easily disallow buffers with
  60      * AV_PERM_REUSE.
  61      *
  62      * Input pads only.
  63      */
  64     int rej_perms;
  65
  66     /**
  67      * Callback called before passing the first slice of a new frame. If
  68      * NULL, the filter layer will default to storing a reference to the
  69      * picture inside the link structure.
  70      *
  71      * Input video pads only.
  72      */
  73     void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
  74
  75     /**
  76      * Callback function to get a video buffer. If NULL, the filter system will
  77      * use avfilter_default_get_video_buffer().
  78      *
  79      * Input video pads only.
  80      */
  81     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
  82
  83     /**
  84      * Callback function to get an audio buffer. If NULL, the filter system will
  85      * use avfilter_default_get_audio_buffer().
  86      *
  87      * Input audio pads only.
  88      */
  89     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
  90                                            int nb_samples);
  91
  92     /**
  93      * Callback called after the slices of a frame are completely sent. If
  94      * NULL, the filter layer will default to releasing the reference stored
  95      * in the link structure during start_frame().
  96      *
  97      * Input video pads only.
  98      */
  99     void (*end_frame)(AVFilterLink *link);
 100
 101     /**
 102      * Slice drawing callback. This is where a filter receives video data
 103      * and should do its processing.
 104      *
 105      * Input video pads only.
 106      */
 107     void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
 108
 109     /**
 110      * Samples filtering callback. This is where a filter receives audio data
 111      * and should do its processing.
 112      *
 113      * Input audio pads only.
 114      */
 115     void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
 116
 117     /**
 118      * Frame poll callback. This returns the number of immediately available
 119      * samples. It should return a positive value if the next request_frame()
 120      * is guaranteed to return one frame (with no delay).
 121      *
 122      * Defaults to just calling the source poll_frame() method.
 123      *
 124      * Output pads only.
 125      */
 126     int (*poll_frame)(AVFilterLink *link);
 127
 128     /**
 129      * Frame request callback. A call to this should result in at least one
 130      * frame being output over the given link. This should return zero on
 131      * success, and another value on error.
 132      *
 133      * Output pads only.
 134      */
 135     int (*request_frame)(AVFilterLink *link);
 136
 137     /**
 138      * Link configuration callback.
 139      *
 140      * For output pads, this should set the link properties such as
 141      * width/height. This should NOT set the format property - that is
 142      * negotiated between filters by the filter system using the
 143      * query_formats() callback before this function is called.
 144      *
 145      * For input pads, this should check the properties of the link, and update
 146      * the filter's internal state as necessary.
 147      *
 148      * For both input and output filters, this should return zero on success,
 149      * and another value on error.
 150      */
 151     int (*config_props)(AVFilterLink *link);
 152 };
 153 #endif
 154
 155 /** default handler for freeing audio/video buffer when there are no references left */
 156 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
 157
 158 /** Tell is a format is contained in the provided list terminated by -1. */
 159 int ff_fmt_is_in(int fmt, const int *fmts);
 160
 161 #define FF_DPRINTF_START(ctx, func) av_dlog(NULL, "%-16s: ", #func)
 162
 163 void ff_dlog_link(void *ctx, AVFilterLink *link, int end);
 164
 165 /**
 166  * Insert a new pad.
 167  *
 168  * @param idx Insertion point. Pad is inserted at the end if this point
 169  *            is beyond the end of the list of pads.
 170  * @param count Pointer to the number of pads in the list
 171  * @param padidx_off Offset within an AVFilterLink structure to the element
 172  *                   to increment when inserting a new pad causes link
 173  *                   numbering to change
 174  * @param pads Pointer to the pointer to the beginning of the list of pads
 175  * @param links Pointer to the pointer to the beginning of the list of links
 176  * @param newpad The new pad to add. A copy is made when adding.
 177  */
 178 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
 179                    AVFilterPad **pads, AVFilterLink ***links,
 180                    AVFilterPad *newpad);
 181
 182 /** Insert a new input pad for the filter. */
 183 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
 184                                    AVFilterPad *p)
 185 {
 186     ff_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
 187                   &f->input_pads, &f->inputs, p);
 188 }
 189
 190 /** Insert a new output pad for the filter. */
 191 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
 192                                     AVFilterPad *p)
 193 {
 194     ff_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
 195                   &f->output_pads, &f->outputs, p);
 196 }
 197
 198 /**
 199  * Poll a frame from the filter chain.
 200  *
 201  * @param  link the input link
 202  * @return the number of immediately available frames, a negative
 203  * number in case of error
 204  */
 205 int ff_poll_frame(AVFilterLink *link);
 206
 207 /**
 208  * Request an input frame from the filter at the other end of the link.
 209  *
 210  * @param link the input link
 211  * @return     zero on success
 212  */
 213 int ff_request_frame(AVFilterLink *link);
 214
 215 #endif /* AVFILTER_INTERNAL_H */