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     void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
 140
 141     /**
 142      * Frame poll callback. This returns the number of immediately available
 143      * samples. It should return a positive value if the next request_frame()
 144      * is guaranteed to return one frame (with no delay).
 145      *
 146      * Defaults to just calling the source poll_frame() method.
 147      *
 148      * Output pads only.
 149      */
 150     int (*poll_frame)(AVFilterLink *link);
 151
 152     /**
 153      * Frame request callback. A call to this should result in at least one
 154      * frame being output over the given link. This should return zero on
 155      * success, and another value on error.
 156      *
 157      * Output pads only.
 158      */
 159     int (*request_frame)(AVFilterLink *link);
 160
 161     /**
 162      * Link configuration callback.
 163      *
 164      * For output pads, this should set the link properties such as
 165      * width/height. This should NOT set the format property - that is
 166      * negotiated between filters by the filter system using the
 167      * query_formats() callback before this function is called.
 168      *
 169      * For input pads, this should check the properties of the link, and update
 170      * the filter's internal state as necessary.
 171      *
 172      * For both input and output filters, this should return zero on success,
 173      * and another value on error.
 174      */
 175     int (*config_props)(AVFilterLink *link);
 176 };
 177 #endif
 178
 179 /** default handler for freeing audio/video buffer when there are no references left */
 180 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
 181
 182 /** Tell is a format is contained in the provided list terminated by -1. */
 183 int ff_fmt_is_in(int fmt, const int *fmts);
 184
 185 /**
 186  * Return a copy of a list of integers terminated by -1, or NULL in
 187  * case of copy failure.
 188  */
 189 int *ff_copy_int_list(const int * const list);
 190
 191 /**
 192  * Return a copy of a list of 64-bit integers, or NULL in case of
 193  * copy failure.
 194  */
 195 int64_t *ff_copy_int64_list(const int64_t * const list);
 196
 197 /* Functions to parse audio format arguments */
 198
 199 /**
 200  * Parse a pixel format.
 201  *
 202  * @param ret pixel format 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_pixel_format(enum PixelFormat *ret, const char *arg, void *log_ctx);
 208
 209 /**
 210  * Parse a sample rate.
 211  *
 212  * @param ret unsigned 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_rate(int *ret, const char *arg, void *log_ctx);
 218
 219 /**
 220  * Parse a time base.
 221  *
 222  * @param ret unsigned AVRational 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_time_base(AVRational *ret, const char *arg, void *log_ctx);
 228
 229 /**
 230  * Parse a sample format name or a corresponding integer representation.
 231  *
 232  * @param ret integer pointer to where the value should be written
 233  * @param arg string to parse
 234  * @param log_ctx log context
 235  * @return 0 in case of success, a negative AVERROR code on error
 236  */
 237 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
 238
 239 /**
 240  * Parse a channel layout or a corresponding integer representation.
 241  *
 242  * @param ret 64bit integer pointer to where the value should be written.
 243  * @param arg string to parse
 244  * @param log_ctx log context
 245  * @return 0 in case of success, a negative AVERROR code on error
 246  */
 247 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
 248
 249 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
 250
 251 void ff_free_pool(AVFilterPool *pool);
 252
 253 void ff_command_queue_pop(AVFilterContext *filter);
 254
 255 /* misc trace functions */
 256
 257 /* #define FF_AVFILTER_TRACE */
 258
 259 #ifdef FF_AVFILTER_TRACE
 260 #    define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
 261 #else
 262 #    define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 263 #endif
 264
 265 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
 266
 267 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
 268
 269 void ff_tlog_ref(void *ctx, AVFilterBufferRef *ref, int end);
 270
 271 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
 272
 273 /**
 274  * Insert a new pad.
 275  *
 276  * @param idx Insertion point. Pad is inserted at the end if this point
 277  *            is beyond the end of the list of pads.
 278  * @param count Pointer to the number of pads in the list
 279  * @param padidx_off Offset within an AVFilterLink structure to the element
 280  *                   to increment when inserting a new pad causes link
 281  *                   numbering to change
 282  * @param pads Pointer to the pointer to the beginning of the list of pads
 283  * @param links Pointer to the pointer to the beginning of the list of links
 284  * @param newpad The new pad to add. A copy is made when adding.
 285  */
 286 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
 287                    AVFilterPad **pads, AVFilterLink ***links,
 288                    AVFilterPad *newpad);
 289
 290 /** Insert a new input pad for the filter. */
 291 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
 292                                    AVFilterPad *p)
 293 {
 294     ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
 295                   &f->input_pads, &f->inputs, p);
 296 #if FF_API_FOO_COUNT
 297     f->input_count = f->nb_inputs;
 298 #endif
 299 }
 300
 301 /** Insert a new output pad for the filter. */
 302 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
 303                                     AVFilterPad *p)
 304 {
 305     ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
 306                   &f->output_pads, &f->outputs, p);
 307 #if FF_API_FOO_COUNT
 308     f->output_count = f->nb_outputs;
 309 #endif
 310 }
 311
 312 /**
 313  * Poll a frame from the filter chain.
 314  *
 315  * @param  link the input link
 316  * @return the number of immediately available frames, a negative
 317  * number in case of error
 318  */
 319 int ff_poll_frame(AVFilterLink *link);
 320
 321 /**
 322  * Request an input frame from the filter at the other end of the link.
 323  *
 324  * @param link the input link
 325  * @return     zero on success
 326  */
 327 int ff_request_frame(AVFilterLink *link);
 328
 329 #endif /* AVFILTER_INTERNAL_H */