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

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 #include "avfiltergraph.h"
  29 #include "formats.h"
  30 #include "video.h"
  31
  32 #define POOL_SIZE 32
  33 typedef struct AVFilterPool {
  34     AVFilterBufferRef *pic[POOL_SIZE];
  35     int count;
  36     int refcount;
  37     int draining;
  38 } AVFilterPool;
  39
  40 typedef struct AVFilterCommand {
  41     double time;                ///< time expressed in seconds
  42     char *command;              ///< command
  43     char *arg;                  ///< optional argument for the command
  44     int flags;
  45     struct AVFilterCommand *next;
  46 } AVFilterCommand;
  47
  48 /**
  49  * Update the position of a link in the age heap.
  50  */
  51 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
  52
  53 #if !FF_API_AVFILTERPAD_PUBLIC
  54 /**
  55  * A filter pad used for either input or output.
  56  */
  57 struct AVFilterPad {
  58     /**
  59      * Pad name. The name is unique among inputs and among outputs, but an
  60      * input may have the same name as an output. This may be NULL if this
  61      * pad has no need to ever be referenced by name.
  62      */
  63     const char *name;
  64
  65     /**
  66      * AVFilterPad type.
  67      */
  68     enum AVMediaType type;
  69
  70     /**
  71      * Minimum required permissions on incoming buffers. Any buffer with
  72      * insufficient permissions will be automatically copied by the filter
  73      * system to a new buffer which provides the needed access permissions.
  74      *
  75      * Input pads only.
  76      */
  77     int min_perms;
  78
  79     /**
  80      * Permissions which are not accepted on incoming buffers. Any buffer
  81      * which has any of these permissions set will be automatically copied
  82      * by the filter system to a new buffer which does not have those
  83      * permissions. This can be used to easily disallow buffers with
  84      * AV_PERM_REUSE.
  85      *
  86      * Input pads only.
  87      */
  88     int rej_perms;
  89
  90     /**
  91      * Callback function to get a video buffer. If NULL, the filter system will
  92      * use ff_default_get_video_buffer().
  93      *
  94      * Input video pads only.
  95      */
  96     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
  97
  98     /**
  99      * Callback function to get an audio buffer. If NULL, the filter system will
 100      * use ff_default_get_audio_buffer().
 101      *
 102      * Input audio pads only.
 103      */
 104     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
 105                                            int nb_samples);
 106
 107     /**
 108      * Filtering callback. This is where a filter receives a frame with
 109      * audio/video data and should do its processing.
 110      *
 111      * Input pads only.
 112      *
 113      * @return >= 0 on success, a negative AVERROR on error. This function
 114      * must ensure that samplesref is properly unreferenced on error if it
 115      * hasn't been passed on to another filter.
 116      */
 117     int (*filter_frame)(AVFilterLink *link, AVFilterBufferRef *frame);
 118
 119     /**
 120      * Frame poll callback. This returns the number of immediately available
 121      * samples. It should return a positive value if the next request_frame()
 122      * is guaranteed to return one frame (with no delay).
 123      *
 124      * Defaults to just calling the source poll_frame() method.
 125      *
 126      * Output pads only.
 127      */
 128     int (*poll_frame)(AVFilterLink *link);
 129
 130     /**
 131      * Frame request callback. A call to this should result in at least one
 132      * frame being output over the given link. This should return zero on
 133      * success, and another value on error.
 134      *
 135      * Output pads only.
 136      */
 137     int (*request_frame)(AVFilterLink *link);
 138
 139     /**
 140      * Link configuration callback.
 141      *
 142      * For output pads, this should set the link properties such as
 143      * width/height. This should NOT set the format property - that is
 144      * negotiated between filters by the filter system using the
 145      * query_formats() callback before this function is called.
 146      *
 147      * For input pads, this should check the properties of the link, and update
 148      * the filter's internal state as necessary.
 149      *
 150      * For both input and output filters, this should return zero on success,
 151      * and another value on error.
 152      */
 153     int (*config_props)(AVFilterLink *link);
 154
 155     /**
 156      * The filter expects a fifo to be inserted on its input link,
 157      * typically because it has a delay.
 158      *
 159      * input pads only.
 160      */
 161     int needs_fifo;
 162 };
 163 #endif
 164
 165 /** default handler for freeing audio/video buffer when there are no references left */
 166 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
 167
 168 /** Tell is a format is contained in the provided list terminated by -1. */
 169 int ff_fmt_is_in(int fmt, const int *fmts);
 170
 171 /**
 172  * Return a copy of a list of integers terminated by -1, or NULL in
 173  * case of copy failure.
 174  */
 175 int *ff_copy_int_list(const int * const list);
 176
 177 /**
 178  * Return a copy of a list of 64-bit integers, or NULL in case of
 179  * copy failure.
 180  */
 181 int64_t *ff_copy_int64_list(const int64_t * const list);
 182
 183 /* Functions to parse audio format arguments */
 184
 185 /**
 186  * Parse a pixel format.
 187  *
 188  * @param ret pixel format pointer to where the value should be written
 189  * @param arg string to parse
 190  * @param log_ctx log context
 191  * @return 0 in case of success, a negative AVERROR code on error
 192  */
 193 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
 194
 195 /**
 196  * Parse a sample rate.
 197  *
 198  * @param ret unsigned integer pointer to where the value should be written
 199  * @param arg string to parse
 200  * @param log_ctx log context
 201  * @return 0 in case of success, a negative AVERROR code on error
 202  */
 203 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
 204
 205 /**
 206  * Parse a time base.
 207  *
 208  * @param ret unsigned AVRational pointer to where the value should be written
 209  * @param arg string to parse
 210  * @param log_ctx log context
 211  * @return 0 in case of success, a negative AVERROR code on error
 212  */
 213 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
 214
 215 /**
 216  * Parse a sample format name or a corresponding integer representation.
 217  *
 218  * @param ret integer pointer to where the value should be written
 219  * @param arg string to parse
 220  * @param log_ctx log context
 221  * @return 0 in case of success, a negative AVERROR code on error
 222  */
 223 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
 224
 225 /**
 226  * Parse a channel layout or a corresponding integer representation.
 227  *
 228  * @param ret 64bit integer pointer to where the value should be written.
 229  * @param arg string to parse
 230  * @param log_ctx log context
 231  * @return 0 in case of success, a negative AVERROR code on error
 232  */
 233 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
 234
 235 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
 236
 237 void ff_free_pool(AVFilterPool *pool);
 238
 239 void ff_command_queue_pop(AVFilterContext *filter);
 240
 241 /* misc trace functions */
 242
 243 /* #define FF_AVFILTER_TRACE */
 244
 245 #ifdef FF_AVFILTER_TRACE
 246 #    define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
 247 #else
 248 #    define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 249 #endif
 250
 251 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
 252
 253 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
 254
 255 void ff_tlog_ref(void *ctx, AVFilterBufferRef *ref, int end);
 256
 257 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
 258
 259 /**
 260  * Insert a new pad.
 261  *
 262  * @param idx Insertion point. Pad is inserted at the end if this point
 263  *            is beyond the end of the list of pads.
 264  * @param count Pointer to the number of pads in the list
 265  * @param padidx_off Offset within an AVFilterLink structure to the element
 266  *                   to increment when inserting a new pad causes link
 267  *                   numbering to change
 268  * @param pads Pointer to the pointer to the beginning of the list of pads
 269  * @param links Pointer to the pointer to the beginning of the list of links
 270  * @param newpad The new pad to add. A copy is made when adding.
 271  */
 272 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
 273                    AVFilterPad **pads, AVFilterLink ***links,
 274                    AVFilterPad *newpad);
 275
 276 /** Insert a new input pad for the filter. */
 277 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
 278                                    AVFilterPad *p)
 279 {
 280     ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
 281                   &f->input_pads, &f->inputs, p);
 282 #if FF_API_FOO_COUNT
 283     f->input_count = f->nb_inputs;
 284 #endif
 285 }
 286
 287 /** Insert a new output pad for the filter. */
 288 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
 289                                     AVFilterPad *p)
 290 {
 291     ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
 292                   &f->output_pads, &f->outputs, p);
 293 #if FF_API_FOO_COUNT
 294     f->output_count = f->nb_outputs;
 295 #endif
 296 }
 297
 298 /**
 299  * Poll a frame from the filter chain.
 300  *
 301  * @param  link the input link
 302  * @return the number of immediately available frames, a negative
 303  * number in case of error
 304  */
 305 int ff_poll_frame(AVFilterLink *link);
 306
 307 /**
 308  * Request an input frame from the filter at the other end of the link.
 309  *
 310  * @param link the input link
 311  * @return     zero on success
 312  */
 313 int ff_request_frame(AVFilterLink *link);
 314
 315 #define AVFILTER_DEFINE_CLASS(fname)            \
 316     static const AVClass fname##_class = {      \
 317         .class_name = #fname,                   \
 318         .item_name  = av_default_item_name,     \
 319         .option     = fname##_options,          \
 320         .version    = LIBAVUTIL_VERSION_INT,    \
 321         .category   = AV_CLASS_CATEGORY_FILTER, \
 322     }
 323
 324 AVFilterBufferRef *ff_copy_buffer_ref(AVFilterLink *outlink,
 325                                       AVFilterBufferRef *ref);
 326
 327 /**
 328  * Find the index of a link.
 329  *
 330  * I.e. find i such that link == ctx->(in|out)puts[i]
 331  */
 332 #define FF_INLINK_IDX(link)  ((int)((link)->dstpad - (link)->dst->input_pads))
 333 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
 334
 335 int ff_buffersink_read_compat(AVFilterContext *ctx, AVFilterBufferRef **buf);
 336 int ff_buffersink_read_samples_compat(AVFilterContext *ctx, AVFilterBufferRef **pbuf,
 337                                       int nb_samples);
 338 /**
 339  * Send a frame of data to the next filter.
 340  *
 341  * @param link   the output link over which the data is being sent
 342  * @param frame a reference to the buffer of data being sent. The
 343  *              receiving filter will free this reference when it no longer
 344  *              needs it or pass it on to the next filter.
 345  *
 346  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
 347  * is responsible for unreferencing frame in case of error.
 348  */
 349 int ff_filter_frame(AVFilterLink *link, AVFilterBufferRef *frame);
 350
 351 #endif /* AVFILTER_INTERNAL_H */