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