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