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 called before passing the first slice of a new frame. If
  92      * NULL, the filter layer will default to storing a reference to the
  93      * picture inside the link structure.
  94      *
  95      * Input video pads only.
  96      *
  97      * @return >= 0 on success, a negative AVERROR on error. picref will be
  98      * unreferenced by the caller in case of error.
  99      */
 100     void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
 101
 102     /**
 103      * Callback function to get a video buffer. If NULL, the filter system will
 104      * use avfilter_default_get_video_buffer().
 105      *
 106      * Input video pads only.
 107      */
 108     AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
 109
 110     /**
 111      * Callback function to get an audio buffer. If NULL, the filter system will
 112      * use avfilter_default_get_audio_buffer().
 113      *
 114      * Input audio pads only.
 115      */
 116     AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
 117                                            int nb_samples);
 118
 119     /**
 120      * Callback called after the slices of a frame are completely sent. If
 121      * NULL, the filter layer will default to releasing the reference stored
 122      * in the link structure during start_frame().
 123      *
 124      * Input video pads only.
 125      *
 126      * @return >= 0 on success, a negative AVERROR on error.
 127      */
 128     int (*end_frame)(AVFilterLink *link);
 129
 130     /**
 131      * Slice drawing callback. This is where a filter receives video data
 132      * and should do its processing.
 133      *
 134      * Input video pads only.
 135      *
 136      * @return >= 0 on success, a negative AVERROR on error.
 137      */
 138     int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
 139
 140     /**
 141      * Samples filtering callback. This is where a filter receives audio data
 142      * and should do its processing.
 143      *
 144      * Input audio pads only.
 145      *
 146      * @return >= 0 on success, a negative AVERROR on error. This function
 147      * must ensure that samplesref is properly unreferenced on error if it
 148      * hasn't been passed on to another filter.
 149      */
 150     int (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
 151
 152     /**
 153      * Frame poll callback. This returns the number of immediately available
 154      * samples. It should return a positive value if the next request_frame()
 155      * is guaranteed to return one frame (with no delay).
 156      *
 157      * Defaults to just calling the source poll_frame() method.
 158      *
 159      * Output pads only.
 160      */
 161     int (*poll_frame)(AVFilterLink *link);
 162
 163     /**
 164      * Frame request callback. A call to this should result in at least one
 165      * frame being output over the given link. This should return zero on
 166      * success, and another value on error.
 167      *
 168      * Output pads only.
 169      */
 170     int (*request_frame)(AVFilterLink *link);
 171
 172     /**
 173      * Link configuration callback.
 174      *
 175      * For output pads, this should set the link properties such as
 176      * width/height. This should NOT set the format property - that is
 177      * negotiated between filters by the filter system using the
 178      * query_formats() callback before this function is called.
 179      *
 180      * For input pads, this should check the properties of the link, and update
 181      * the filter's internal state as necessary.
 182      *
 183      * For both input and output filters, this should return zero on success,
 184      * and another value on error.
 185      */
 186     int (*config_props)(AVFilterLink *link);
 187
 188     /**
 189      * The filter expects a fifo to be inserted on its input link,
 190      * typically because it has a delay.
 191      *
 192      * input pads only.
 193      */
 194     int needs_fifo;
 195 };
 196 #endif
 197
 198 /** default handler for freeing audio/video buffer when there are no references left */
 199 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
 200
 201 /** Tell is a format is contained in the provided list terminated by -1. */
 202 int ff_fmt_is_in(int fmt, const int *fmts);
 203
 204 /**
 205  * Return a copy of a list of integers terminated by -1, or NULL in
 206  * case of copy failure.
 207  */
 208 int *ff_copy_int_list(const int * const list);
 209
 210 /**
 211  * Return a copy of a list of 64-bit integers, or NULL in case of
 212  * copy failure.
 213  */
 214 int64_t *ff_copy_int64_list(const int64_t * const list);
 215
 216 /* Functions to parse audio format arguments */
 217
 218 /**
 219  * Parse a pixel format.
 220  *
 221  * @param ret pixel format pointer to where the value should be written
 222  * @param arg string to parse
 223  * @param log_ctx log context
 224  * @return 0 in case of success, a negative AVERROR code on error
 225  */
 226 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
 227
 228 /**
 229  * Parse a sample rate.
 230  *
 231  * @param ret unsigned integer pointer to where the value should be written
 232  * @param arg string to parse
 233  * @param log_ctx log context
 234  * @return 0 in case of success, a negative AVERROR code on error
 235  */
 236 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
 237
 238 /**
 239  * Parse a time base.
 240  *
 241  * @param ret unsigned AVRational pointer to where the value should be written
 242  * @param arg string to parse
 243  * @param log_ctx log context
 244  * @return 0 in case of success, a negative AVERROR code on error
 245  */
 246 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
 247
 248 /**
 249  * Parse a sample format name or a corresponding integer representation.
 250  *
 251  * @param ret integer pointer to where the value should be written
 252  * @param arg string to parse
 253  * @param log_ctx log context
 254  * @return 0 in case of success, a negative AVERROR code on error
 255  */
 256 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
 257
 258 /**
 259  * Parse a channel layout or a corresponding integer representation.
 260  *
 261  * @param ret 64bit integer pointer to where the value should be written.
 262  * @param arg string to parse
 263  * @param log_ctx log context
 264  * @return 0 in case of success, a negative AVERROR code on error
 265  */
 266 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
 267
 268 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
 269
 270 void ff_free_pool(AVFilterPool *pool);
 271
 272 void ff_command_queue_pop(AVFilterContext *filter);
 273
 274 /* misc trace functions */
 275
 276 /* #define FF_AVFILTER_TRACE */
 277
 278 #ifdef FF_AVFILTER_TRACE
 279 #    define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
 280 #else
 281 #    define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 282 #endif
 283
 284 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
 285
 286 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
 287
 288 void ff_tlog_ref(void *ctx, AVFilterBufferRef *ref, int end);
 289
 290 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
 291
 292 /**
 293  * Insert a new pad.
 294  *
 295  * @param idx Insertion point. Pad is inserted at the end if this point
 296  *            is beyond the end of the list of pads.
 297  * @param count Pointer to the number of pads in the list
 298  * @param padidx_off Offset within an AVFilterLink structure to the element
 299  *                   to increment when inserting a new pad causes link
 300  *                   numbering to change
 301  * @param pads Pointer to the pointer to the beginning of the list of pads
 302  * @param links Pointer to the pointer to the beginning of the list of links
 303  * @param newpad The new pad to add. A copy is made when adding.
 304  */
 305 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
 306                    AVFilterPad **pads, AVFilterLink ***links,
 307                    AVFilterPad *newpad);
 308
 309 /** Insert a new input pad for the filter. */
 310 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
 311                                    AVFilterPad *p)
 312 {
 313     ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
 314                   &f->input_pads, &f->inputs, p);
 315 #if FF_API_FOO_COUNT
 316     f->input_count = f->nb_inputs;
 317 #endif
 318 }
 319
 320 /** Insert a new output pad for the filter. */
 321 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
 322                                     AVFilterPad *p)
 323 {
 324     ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
 325                   &f->output_pads, &f->outputs, p);
 326 #if FF_API_FOO_COUNT
 327     f->output_count = f->nb_outputs;
 328 #endif
 329 }
 330
 331 /**
 332  * Poll a frame from the filter chain.
 333  *
 334  * @param  link the input link
 335  * @return the number of immediately available frames, a negative
 336  * number in case of error
 337  */
 338 int ff_poll_frame(AVFilterLink *link);
 339
 340 /**
 341  * Request an input frame from the filter at the other end of the link.
 342  *
 343  * @param link the input link
 344  * @return     zero on success
 345  */
 346 int ff_request_frame(AVFilterLink *link);
 347
 348 #define AVFILTER_DEFINE_CLASS(fname)            \
 349     static const AVClass fname##_class = {      \
 350         .class_name = #fname,                   \
 351         .item_name  = av_default_item_name,     \
 352         .option     = fname##_options,          \
 353         .version    = LIBAVUTIL_VERSION_INT,    \
 354         .category   = AV_CLASS_CATEGORY_FILTER, \
 355     }
 356
 357 AVFilterBufferRef *ff_copy_buffer_ref(AVFilterLink *outlink,
 358                                       AVFilterBufferRef *ref);
 359
 360 /**
 361  * Find the index of a link.
 362  *
 363  * I.e. find i such that link == ctx->(in|out)puts[i]
 364  */
 365 #define FF_INLINK_IDX(link)  ((int)((link)->dstpad - (link)->dst->input_pads))
 366 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
 367
 368 int ff_buffersink_read_compat(AVFilterContext *ctx, AVFilterBufferRef **buf);
 369 int ff_buffersink_read_samples_compat(AVFilterContext *ctx, AVFilterBufferRef **pbuf,
 370                                       int nb_samples);
 371
 372 #endif /* AVFILTER_INTERNAL_H */