Add APIchanges entry after the addition of av_get_image_linesize() of
[libav.git] / libavfilter / avfilter.h
CommitLineData
a5cbb2f4 1/*
664f6595 2 * filter layer
a5cbb2f4
VS
3 * copyright (c) 2007 Bobby Bingham
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
98790382
SS
22#ifndef AVFILTER_AVFILTER_H
23#define AVFILTER_AVFILTER_H
a5cbb2f4 24
1f20782c
DB
25#include "libavutil/avutil.h"
26
0eb4ff9e 27#define LIBAVFILTER_VERSION_MAJOR 1
c1db7bff 28#define LIBAVFILTER_VERSION_MINOR 34
81c1ecab 29#define LIBAVFILTER_VERSION_MICRO 1
be19d752
VS
30
31#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
32 LIBAVFILTER_VERSION_MINOR, \
33 LIBAVFILTER_VERSION_MICRO)
34#define LIBAVFILTER_VERSION AV_VERSION(LIBAVFILTER_VERSION_MAJOR, \
35 LIBAVFILTER_VERSION_MINOR, \
36 LIBAVFILTER_VERSION_MICRO)
37#define LIBAVFILTER_BUILD LIBAVFILTER_VERSION_INT
a7d46657 38
a9c81431 39#include <stddef.h>
245976da 40#include "libavcodec/avcodec.h"
a5cbb2f4 41
540f1c7b 42/**
49bd8e4b 43 * Return the LIBAVFILTER_VERSION_INT constant.
540f1c7b
SS
44 */
45unsigned avfilter_version(void);
46
c1736936 47/**
49bd8e4b 48 * Return the libavfilter build-time configuration.
c1736936 49 */
41600690 50const char *avfilter_configuration(void);
c1736936
DB
51
52/**
49bd8e4b 53 * Return the libavfilter license.
c1736936 54 */
41600690 55const char *avfilter_license(void);
c1736936
DB
56
57
a5cbb2f4
VS
58typedef struct AVFilterContext AVFilterContext;
59typedef struct AVFilterLink AVFilterLink;
60typedef struct AVFilterPad AVFilterPad;
61
a5cbb2f4 62/**
32d7bcd4 63 * A reference-counted buffer data type used by the filter system. Filters
a5cbb2f4 64 * should not store pointers to this structure directly, but instead use the
ecc8dada 65 * AVFilterBufferRef structure below.
a5cbb2f4 66 */
f0d77b20 67typedef struct AVFilterBuffer
a5cbb2f4 68{
56b5e9d5
HM
69 uint8_t *data[8]; ///< buffer data for each plane/channel
70 int linesize[8]; ///< number of bytes per line
a5cbb2f4 71
32d7bcd4 72 unsigned refcount; ///< number of references to this buffer
13ff8fd0
VS
73
74 /** private data to be used by a custom free function */
a5cbb2f4 75 void *priv;
13ff8fd0 76 /**
32d7bcd4 77 * A pointer to the function to deallocate this buffer if the default
38efe768 78 * function is not sufficient. This could, for example, add the memory
13ff8fd0
VS
79 * back into a memory pool to be reused later without the overhead of
80 * reallocating it from scratch.
81 */
32d7bcd4 82 void (*free)(struct AVFilterBuffer *buf);
f0d77b20 83} AVFilterBuffer;
a5cbb2f4 84
ff5f1be0
HM
85#define AV_PERM_READ 0x01 ///< can read from the buffer
86#define AV_PERM_WRITE 0x02 ///< can write to the buffer
87#define AV_PERM_PRESERVE 0x04 ///< nobody else can overwrite the buffer
88#define AV_PERM_REUSE 0x08 ///< can output the buffer multiple times, with the same contents each time
89#define AV_PERM_REUSE2 0x10 ///< can output the buffer multiple times, modified each time
90
a5cbb2f4 91/**
cc80caff
HM
92 * Video specific properties in a reference to an AVFilterBuffer. Since
93 * AVFilterBufferRef is common to different media formats, video specific
94 * per reference properties must be separated out.
95 */
96typedef struct AVFilterBufferRefVideoProps
97{
98 int w; ///< image width
99 int h; ///< image height
100 AVRational pixel_aspect; ///< pixel aspect ratio
101 int interlaced; ///< is frame interlaced
102 int top_field_first; ///< field order
103} AVFilterBufferRefVideoProps;
104
105/**
f0d77b20 106 * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
7fce481a 107 * a buffer to, for example, crop image without any memcpy, the buffer origin
38efe768 108 * and dimensions are per-reference properties. Linesize is also useful for
bbf42679 109 * image flipping, frame to field filters, etc, and so is also per-reference.
a5cbb2f4 110 *
1a18860a 111 * TODO: add anything necessary for frame reordering
a5cbb2f4 112 */
ecc8dada 113typedef struct AVFilterBufferRef
a5cbb2f4 114{
7fce481a 115 AVFilterBuffer *buf; ///< the buffer that this is a reference to
c1db7bff
HM
116 uint8_t *data[8]; ///< picture data for each plane
117 int linesize[8]; ///< number of bytes per line
d54e0948 118 int format; ///< media format
a5cbb2f4 119
056f0431 120 int64_t pts; ///< presentation timestamp in units of 1/AV_TIME_BASE
5bb5c1dc 121 int64_t pos; ///< byte position in stream, -1 if unknown
1a18860a 122
ff5f1be0 123 int perms; ///< permissions, see the AV_PERM_* flags
efdc74ef 124
cc80caff
HM
125 enum AVMediaType type; ///< media type of buffer data
126 AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
ecc8dada 127} AVFilterBufferRef;
a5cbb2f4
VS
128
129/**
4d508e4d
SS
130 * Copy properties of src to dst, without copying the actual video
131 * data.
132 */
7fce481a 133static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src)
4d508e4d 134{
cc80caff 135 // copy common properties
4d508e4d
SS
136 dst->pts = src->pts;
137 dst->pos = src->pos;
cc80caff
HM
138
139 switch (src->type) {
140 case AVMEDIA_TYPE_VIDEO: *dst->video = *src->video; break;
141 }
4d508e4d
SS
142}
143
144/**
7fce481a
HM
145 * Add a new reference to a buffer.
146 * @param ref an existing reference to the buffer
664f6595 147 * @param pmask a bitmask containing the allowable permissions in the new
13ff8fd0 148 * reference
7fce481a 149 * @return a new reference to the buffer with the same properties as the
13ff8fd0 150 * old, excluding any permissions denied by pmask
a5cbb2f4 151 */
7fce481a 152AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
a5cbb2f4
VS
153
154/**
7fce481a
HM
155 * Remove a reference to a buffer. If this is the last reference to the
156 * buffer, the buffer itself is also automatically freed.
157 * @param ref reference to the buffer
a5cbb2f4 158 */
7fce481a 159void avfilter_unref_buffer(AVFilterBufferRef *ref);
a5cbb2f4 160
13ff8fd0 161/**
35f3fdf4
VS
162 * A list of supported formats for one end of a filter link. This is used
163 * during the format negotiation process to try to pick the best format to
164 * use to minimize the number of necessary conversions. Each filter gives a
165 * list of the formats supported by each input and output pad. The list
166 * given for each pad need not be distinct - they may be references to the
167 * same list of formats, as is often the case when a filter supports multiple
42f72a3a 168 * formats, but will always output the same format as it is given in input.
35f3fdf4
VS
169 *
170 * In this way, a list of possible input formats and a list of possible
171 * output formats are associated with each link. When a set of formats is
172 * negotiated over a link, the input and output lists are merged to form a
173 * new list containing only the common elements of each list. In the case
174 * that there were no common elements, a format conversion is necessary.
175 * Otherwise, the lists are merged, and all other links which reference
176 * either of the format lists involved in the merge are also affected.
177 *
178 * For example, consider the filter chain:
179 * filter (a) --> (b) filter (b) --> (c) filter
180 *
181 * where the letters in parenthesis indicate a list of formats supported on
182 * the input or output of the link. Suppose the lists are as follows:
183 * (a) = {A, B}
184 * (b) = {A, B, C}
185 * (c) = {B, C}
186 *
187 * First, the first link's lists are merged, yielding:
188 * filter (a) --> (a) filter (a) --> (c) filter
189 *
190 * Notice that format list (b) now refers to the same list as filter list (a).
191 * Next, the lists for the second link are merged, yielding:
192 * filter (a) --> (a) filter (a) --> (a) filter
193 *
194 * where (a) = {B}.
195 *
196 * Unfortunately, when the format lists at the two ends of a link are merged,
197 * we must ensure that all links which reference either pre-merge format list
198 * get updated as well. Therefore, we have the format list structure store a
199 * pointer to each of the pointers to itself.
200 */
201typedef struct AVFilterFormats AVFilterFormats;
202struct AVFilterFormats
203{
204 unsigned format_count; ///< number of formats
bdab614b 205 int *formats; ///< list of media formats
35f3fdf4
VS
206
207 unsigned refcount; ///< number of references to this list
208 AVFilterFormats ***refs; ///< references to this list
209};
210
211/**
49bd8e4b 212 * Create a list of supported formats. This is intended for use in
f6a1fa85 213 * AVFilter->query_formats().
bdab614b 214 * @param fmts list of media formats, terminated by -1
f6a1fa85
SS
215 * @return the format list, with no existing references
216 */
bdab614b 217AVFilterFormats *avfilter_make_format_list(const int *fmts);
f6a1fa85
SS
218
219/**
bdab614b 220 * Add fmt to the list of media formats contained in *avff.
c1d662fd
SS
221 * If *avff is NULL the function allocates the filter formats struct
222 * and puts its pointer in *avff.
4fd1f187
SS
223 *
224 * @return a non negative value in case of success, or a negative
225 * value corresponding to an AVERROR code in case of error
226 */
bdab614b 227int avfilter_add_format(AVFilterFormats **avff, int fmt);
4fd1f187
SS
228
229/**
bdab614b 230 * Return a list of all formats supported by FFmpeg for the given media type.
35f3fdf4 231 */
bdab614b 232AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
35f3fdf4
VS
233
234/**
49bd8e4b 235 * Return a format list which contains the intersection of the formats of
39981f53
SS
236 * a and b. Also, all the references of a, all the references of b, and
237 * a and b themselves will be deallocated.
35f3fdf4
VS
238 *
239 * If a and b do not share any common formats, neither is modified, and NULL
240 * is returned.
241 */
242AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
243
09b63a42 244/**
49bd8e4b 245 * Add *ref as a new reference to formats.
09b63a42
MN
246 * That is the pointers will point like in the ascii art below:
247 * ________
a27c8d5f
MN
248 * |formats |<--------.
249 * | ____ | ____|___________________
250 * | |refs| | | __|_
251 * | |* * | | | | | | AVFilterLink
09b63a42 252 * | |* *--------->|*ref|
a27c8d5f
MN
253 * | |____| | | |____|
254 * |________| |________________________
09b63a42 255 */
a27c8d5f 256void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
35f3fdf4
VS
257
258/**
49bd8e4b 259 * If *ref is non-NULL, remove *ref as a reference to the format list
063e7692
SS
260 * it currently points to, deallocates that list if this was the last
261 * reference, and sets *ref to NULL.
a27c8d5f
MN
262 *
263 * Before After
264 * ________ ________ NULL
265 * |formats |<--------. |formats | ^
266 * | ____ | ____|________________ | ____ | ____|________________
267 * | |refs| | | __|_ | |refs| | | __|_
268 * | |* * | | | | | | AVFilterLink | |* * | | | | | | AVFilterLink
269 * | |* *--------->|*ref| | |* | | | |*ref|
270 * | |____| | | |____| | |____| | | |____|
271 * |________| |_____________________ |________| |_____________________
35f3fdf4
VS
272 */
273void avfilter_formats_unref(AVFilterFormats **ref);
274
b9c2fb34
MN
275/**
276 *
277 * Before After
278 * ________ ________
a27c8d5f 279 * |formats |<---------. |formats |<---------.
b9c2fb34
MN
280 * | ____ | ___|___ | ____ | ___|___
281 * | |refs| | | | | | |refs| | | | | NULL
282 * | |* *--------->|*oldref| | |* *--------->|*newref| ^
283 * | |* * | | |_______| | |* * | | |_______| ___|___
284 * | |____| | | |____| | | | |
285 * |________| |________| |*oldref|
286 * |_______|
287 */
eb30e86c
MN
288void avfilter_formats_changeref(AVFilterFormats **oldref,
289 AVFilterFormats **newref);
290
35f3fdf4 291/**
664f6595 292 * A filter pad used for either input or output.
13ff8fd0 293 */
a5cbb2f4
VS
294struct AVFilterPad
295{
296 /**
38efe768
SS
297 * Pad name. The name is unique among inputs and among outputs, but an
298 * input may have the same name as an output. This may be NULL if this
13ff8fd0 299 * pad has no need to ever be referenced by name.
a5cbb2f4 300 */
2844dd39 301 const char *name;
a5cbb2f4
VS
302
303 /**
38efe768 304 * AVFilterPad type. Only video supported now, hopefully someone will
a5cbb2f4
VS
305 * add audio in the future.
306 */
72415b2a 307 enum AVMediaType type;
a5cbb2f4
VS
308
309 /**
38efe768 310 * Minimum required permissions on incoming buffers. Any buffer with
60bf6ce3
VS
311 * insufficient permissions will be automatically copied by the filter
312 * system to a new buffer which provides the needed access permissions.
313 *
314 * Input pads only.
315 */
316 int min_perms;
317
318 /**
38efe768 319 * Permissions which are not accepted on incoming buffers. Any buffer
9ce95f27
SS
320 * which has any of these permissions set will be automatically copied
321 * by the filter system to a new buffer which does not have those
38efe768 322 * permissions. This can be used to easily disallow buffers with
9ce95f27 323 * AV_PERM_REUSE.
60bf6ce3
VS
324 *
325 * Input pads only.
326 */
327 int rej_perms;
328
329 /**
38efe768 330 * Callback called before passing the first slice of a new frame. If
a5cbb2f4
VS
331 * NULL, the filter layer will default to storing a reference to the
332 * picture inside the link structure.
13ff8fd0
VS
333 *
334 * Input video pads only.
a5cbb2f4 335 */
ecc8dada 336 void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
a5cbb2f4
VS
337
338 /**
38efe768 339 * Callback function to get a buffer. If NULL, the filter system will
da23d424 340 * use avfilter_default_get_video_buffer().
13ff8fd0
VS
341 *
342 * Input video pads only.
a5cbb2f4 343 */
ecc8dada 344 AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
a5cbb2f4
VS
345
346 /**
38efe768 347 * Callback called after the slices of a frame are completely sent. If
a5cbb2f4
VS
348 * NULL, the filter layer will default to releasing the reference stored
349 * in the link structure during start_frame().
13ff8fd0
VS
350 *
351 * Input video pads only.
a5cbb2f4
VS
352 */
353 void (*end_frame)(AVFilterLink *link);
354
355 /**
38efe768 356 * Slice drawing callback. This is where a filter receives video data
13ff8fd0
VS
357 * and should do its processing.
358 *
359 * Input video pads only.
a5cbb2f4 360 */
a13a5437 361 void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
a5cbb2f4
VS
362
363 /**
38efe768 364 * Frame poll callback. This returns the number of immediately available
d224d73a
VS
365 * frames. It should return a positive value if the next request_frame()
366 * is guaranteed to return one frame (with no delay).
367 *
368 * Defaults to just calling the source poll_frame() method.
369 *
370 * Output video pads only.
371 */
372 int (*poll_frame)(AVFilterLink *link);
373
374 /**
38efe768
SS
375 * Frame request callback. A call to this should result in at least one
376 * frame being output over the given link. This should return zero on
13ff8fd0
VS
377 * success, and another value on error.
378 *
379 * Output video pads only.
a5cbb2f4 380 */
63f64e6f 381 int (*request_frame)(AVFilterLink *link);
a5cbb2f4
VS
382
383 /**
13ff8fd0
VS
384 * Link configuration callback.
385 *
386 * For output pads, this should set the link properties such as
38efe768 387 * width/height. This should NOT set the format property - that is
13ff8fd0
VS
388 * negotiated between filters by the filter system using the
389 * query_formats() callback before this function is called.
d3e57c15
VS
390 *
391 * For input pads, this should check the properties of the link, and update
392 * the filter's internal state as necessary.
13ff8fd0
VS
393 *
394 * For both input and output filters, this should return zero on success,
395 * and another value on error.
a5cbb2f4 396 */
d3e57c15 397 int (*config_props)(AVFilterLink *link);
a5cbb2f4
VS
398};
399
2b187df9 400/** default handler for start_frame() for video inputs */
ecc8dada 401void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
a4fb0ada 402
b9609848 403/** default handler for draw_slice() for video inputs */
a13a5437 404void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
a4fb0ada 405
2b187df9 406/** default handler for end_frame() for video inputs */
a5cbb2f4 407void avfilter_default_end_frame(AVFilterLink *link);
a4fb0ada 408
2b187df9 409/** default handler for config_props() for video outputs */
901e6b39 410int avfilter_default_config_output_link(AVFilterLink *link);
a4fb0ada 411
2b187df9 412/** default handler for config_props() for video inputs */
85322466 413int avfilter_default_config_input_link (AVFilterLink *link);
a4fb0ada 414
2b187df9 415/** default handler for get_video_buffer() for video inputs */
ecc8dada 416AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
a4fb0ada 417 int perms, int w, int h);
35f3fdf4
VS
418/**
419 * A helper for query_formats() which sets all links to the same list of
420 * formats. If there are no links hooked to this filter, the list of formats is
421 * freed.
422 */
423void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
a4fb0ada 424
35f3fdf4
VS
425/** Default handler for query_formats() */
426int avfilter_default_query_formats(AVFilterContext *ctx);
a5cbb2f4 427
91d1c741 428/** start_frame() handler for filters which simply pass video along */
ecc8dada 429void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
91d1c741
BB
430
431/** draw_slice() handler for filters which simply pass video along */
432void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
433
434/** end_frame() handler for filters which simply pass video along */
435void avfilter_null_end_frame(AVFilterLink *link);
436
437/** get_video_buffer() handler for filters which simply pass video along */
ecc8dada 438AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
91d1c741
BB
439 int perms, int w, int h);
440
13ff8fd0 441/**
38efe768 442 * Filter definition. This defines the pads a filter contains, and all the
13ff8fd0
VS
443 * callback functions used to interact with the filter.
444 */
243110f9 445typedef struct AVFilter
a5cbb2f4 446{
2844dd39 447 const char *name; ///< filter name
a5cbb2f4 448
13ff8fd0 449 int priv_size; ///< size of private data to allocate for the filter
a5cbb2f4 450
4d96a914 451 /**
38efe768
SS
452 * Filter initialization function. Args contains the user-supplied
453 * parameters. FIXME: maybe an AVOption-based system would be better?
6e365c57
VS
454 * opaque is data provided by the code requesting creation of the filter,
455 * and is used to pass data to the filter.
4d96a914 456 */
95bcf498 457 int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
13ff8fd0
VS
458
459 /**
38efe768 460 * Filter uninitialization function. Should deallocate any memory held
7fce481a 461 * by the filter, release any buffer references, etc. This does not need
13ff8fd0
VS
462 * to deallocate the AVFilterContext->priv memory itself.
463 */
a5cbb2f4
VS
464 void (*uninit)(AVFilterContext *ctx);
465
35f3fdf4 466 /**
c4d2e41c 467 * Queries formats supported by the filter and its pads, and sets the
35f3fdf4
VS
468 * in_formats for links connected to its output pads, and out_formats
469 * for links connected to its input pads.
470 *
fe592585
SS
471 * @return zero on success, a negative value corresponding to an
472 * AVERROR code otherwise
35f3fdf4
VS
473 */
474 int (*query_formats)(AVFilterContext *);
475
13ff8fd0
VS
476 const AVFilterPad *inputs; ///< NULL terminated list of inputs. NULL if none
477 const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
cccd292a
SS
478
479 /**
480 * A description for the filter. You should use the
481 * NULL_IF_CONFIG_SMALL() macro to define it.
482 */
483 const char *description;
a5cbb2f4
VS
484} AVFilter;
485
13ff8fd0 486/** An instance of a filter */
a5cbb2f4
VS
487struct AVFilterContext
488{
d42a814e 489 const AVClass *av_class; ///< needed for av_log()
a5cbb2f4 490
664f6595 491 AVFilter *filter; ///< the AVFilter of which this is an instance
a5cbb2f4 492
13ff8fd0 493 char *name; ///< name of this filter instance
dcea2482 494
13ff8fd0
VS
495 unsigned input_count; ///< number of input pads
496 AVFilterPad *input_pads; ///< array of input pads
497 AVFilterLink **inputs; ///< array of pointers to input links
25f8e601 498
13ff8fd0
VS
499 unsigned output_count; ///< number of output pads
500 AVFilterPad *output_pads; ///< array of output pads
501 AVFilterLink **outputs; ///< array of pointers to output links
a5cbb2f4 502
13ff8fd0 503 void *priv; ///< private data for use by the filter
a5cbb2f4
VS
504};
505
13ff8fd0 506/**
38efe768 507 * A link between two filters. This contains pointers to the source and
f4433de9 508 * destination filters between which this link exists, and the indexes of
38efe768 509 * the pads involved. In addition, this link also contains the parameters
13ff8fd0 510 * which have been negotiated and agreed upon between the filter, such as
2b187df9 511 * image dimensions, format, etc.
13ff8fd0 512 */
a5cbb2f4
VS
513struct AVFilterLink
514{
13ff8fd0
VS
515 AVFilterContext *src; ///< source filter
516 unsigned int srcpad; ///< index of the output pad on the source filter
a5cbb2f4 517
13ff8fd0
VS
518 AVFilterContext *dst; ///< dest filter
519 unsigned int dstpad; ///< index of the input pad on the dest filter
a5cbb2f4 520
24c4eff6
VS
521 /** stage of the initialization of the link properties (dimensions, etc) */
522 enum {
523 AVLINK_UNINIT = 0, ///< not started
524 AVLINK_STARTINIT, ///< started, but incomplete
525 AVLINK_INIT ///< complete
526 } init_state;
527
bdab614b
HM
528 enum AVMediaType type; ///< filter media type
529
13ff8fd0
VS
530 int w; ///< agreed upon image width
531 int h; ///< agreed upon image height
bdab614b 532 int format; ///< agreed upon media format
a5cbb2f4 533
60bf6ce3 534 /**
35f3fdf4
VS
535 * Lists of formats supported by the input and output filters respectively.
536 * These lists are used for negotiating the format to actually be used,
537 * which will be loaded into the format member, above, when chosen.
538 */
539 AVFilterFormats *in_formats;
540 AVFilterFormats *out_formats;
541
542 /**
7fce481a 543 * The buffer reference currently being sent across the link by the source
38efe768 544 * filter. This is used internally by the filter system to allow
7fce481a 545 * automatic copying of buffers which do not have sufficient permissions
38efe768 546 * for the destination. This should not be accessed directly by the
60bf6ce3
VS
547 * filters.
548 */
5d4890d7 549 AVFilterBufferRef *src_buf;
60bf6ce3 550
5d4890d7
HM
551 AVFilterBufferRef *cur_buf;
552 AVFilterBufferRef *out_buf;
a5cbb2f4
VS
553};
554
13ff8fd0 555/**
49bd8e4b 556 * Link two filters together.
664f6595
VS
557 * @param src the source filter
558 * @param srcpad index of the output pad on the source filter
559 * @param dst the destination filter
560 * @param dstpad index of the input pad on the destination filter
561 * @return zero on success
13ff8fd0 562 */
a5cbb2f4
VS
563int avfilter_link(AVFilterContext *src, unsigned srcpad,
564 AVFilterContext *dst, unsigned dstpad);
565
13ff8fd0 566/**
bdab614b 567 * Negotiate the media format, dimensions, etc of all inputs to a filter.
664f6595
VS
568 * @param filter the filter to negotiate the properties for its inputs
569 * @return zero on successful negotiation
13ff8fd0 570 */
24c4eff6 571int avfilter_config_links(AVFilterContext *filter);
85322466 572
13ff8fd0 573/**
49bd8e4b 574 * Request a picture buffer with a specific set of permissions.
7fce481a 575 * @param link the output link to the filter from which the buffer will
13ff8fd0 576 * be requested
664f6595 577 * @param perms the required access permissions
0eb4ff9e
SS
578 * @param w the minimum width of the buffer to allocate
579 * @param h the minimum height of the buffer to allocate
7fce481a
HM
580 * @return A reference to the buffer. This must be unreferenced with
581 * avfilter_unref_buffer when you are finished with it.
13ff8fd0 582 */
ecc8dada 583AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
0eb4ff9e 584 int w, int h);
13ff8fd0
VS
585
586/**
49bd8e4b 587 * Request an input frame from the filter at the other end of the link.
664f6595
VS
588 * @param link the input link
589 * @return zero on success
13ff8fd0 590 */
0155b1a1 591int avfilter_request_frame(AVFilterLink *link);
13ff8fd0
VS
592
593/**
49bd8e4b 594 * Poll a frame from the filter chain.
b04c740a 595 * @param link the input link
055068d0
SS
596 * @return the number of immediately available frames, a negative
597 * number in case of error
b04c740a
VS
598 */
599int avfilter_poll_frame(AVFilterLink *link);
600
601/**
49bd8e4b 602 * Notifie the next filter of the start of a frame.
664f6595 603 * @param link the output link the frame will be sent over
38efe768 604 * @param picref A reference to the frame about to be sent. The data for this
13ff8fd0 605 * frame need only be valid once draw_slice() is called for that
38efe768 606 * portion. The receiving filter will free this reference when
13ff8fd0
VS
607 * it no longer needs it.
608 */
ecc8dada 609void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
13ff8fd0
VS
610
611/**
49bd8e4b 612 * Notifie the next filter that the current frame has finished.
664f6595 613 * @param link the output link the frame was sent over
13ff8fd0 614 */
a5cbb2f4 615void avfilter_end_frame(AVFilterLink *link);
13ff8fd0
VS
616
617/**
49bd8e4b 618 * Send a slice to the next filter.
bd283738
SS
619 *
620 * Slices have to be provided in sequential order, either in
621 * top-bottom or bottom-top order. If slices are provided in
622 * non-sequential order the behavior of the function is undefined.
623 *
664f6595
VS
624 * @param link the output link over which the frame is being sent
625 * @param y offset in pixels from the top of the image for this slice
626 * @param h height of this slice in pixels
a13a5437
SS
627 * @param slice_dir the assumed direction for sending slices,
628 * from the top slice to the bottom slice if the value is 1,
629 * from the bottom slice to the top slice if the value is -1,
630 * for other values the behavior of the function is undefined.
13ff8fd0 631 */
a13a5437 632void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
a5cbb2f4 633
49bd8e4b 634/** Initialize the filter system. Register all builtin filters. */
11de6cac 635void avfilter_register_all(void);
e4152452 636
49bd8e4b 637/** Uninitialize the filter system. Unregister all filters. */
a5cbb2f4 638void avfilter_uninit(void);
13ff8fd0
VS
639
640/**
49bd8e4b 641 * Register a filter. This is only needed if you plan to use
fc815c56
VS
642 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
643 * filter can still by instantiated with avfilter_open even if it is not
644 * registered.
664f6595 645 * @param filter the filter to register
86a60fa1
SS
646 * @return 0 if the registration was succesfull, a negative value
647 * otherwise
13ff8fd0 648 */
86a60fa1 649int avfilter_register(AVFilter *filter);
13ff8fd0
VS
650
651/**
49bd8e4b 652 * Get a filter definition matching the given name.
664f6595
VS
653 * @param name the filter name to find
654 * @return the filter definition, if any matching one is registered.
13ff8fd0
VS
655 * NULL if none found.
656 */
2844dd39 657AVFilter *avfilter_get_by_name(const char *name);
a5cbb2f4 658
13ff8fd0 659/**
1433c4ab
SS
660 * If filter is NULL, returns a pointer to the first registered filter pointer,
661 * if filter is non-NULL, returns the next pointer after filter.
662 * If the returned pointer points to NULL, the last registered filter
663 * was already reached.
664 */
665AVFilter **av_filter_next(AVFilter **filter);
666
667/**
49bd8e4b 668 * Create a filter instance.
84c03869
SS
669 *
670 * @param filter_ctx put here a pointer to the created filter context
671 * on success, NULL on failure
664f6595 672 * @param filter the filter to create an instance of
38efe768 673 * @param inst_name Name to give to the new instance. Can be NULL for none.
84c03869 674 * @return >= 0 in case of success, a negative error code otherwise
13ff8fd0 675 */
84c03869 676int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
13ff8fd0
VS
677
678/**
49bd8e4b 679 * Initialize a filter.
664f6595 680 * @param filter the filter to initialize
13ff8fd0
VS
681 * @param args A string of parameters to use when initializing the filter.
682 * The format and meaning of this string varies by filter.
38efe768 683 * @param opaque Any extra non-string data needed by the filter. The meaning
13ff8fd0 684 * of this parameter varies by filter.
664f6595 685 * @return zero on success
13ff8fd0 686 */
6e365c57 687int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
13ff8fd0
VS
688
689/**
49bd8e4b 690 * Destroy a filter.
664f6595 691 * @param filter the filter to destroy
13ff8fd0 692 */
a5cbb2f4
VS
693void avfilter_destroy(AVFilterContext *filter);
694
13ff8fd0 695/**
49bd8e4b 696 * Insert a filter in the middle of an existing link.
664f6595
VS
697 * @param link the link into which the filter should be inserted
698 * @param filt the filter to be inserted
699 * @param in the input pad on the filter to connect
700 * @param out the output pad on the filter to connect
701 * @return zero on success
13ff8fd0 702 */
35f3fdf4
VS
703int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
704 unsigned in, unsigned out);
d3e57c15 705
a9c81431 706/**
49bd8e4b 707 * Insert a new pad.
38efe768 708 * @param idx Insertion point. Pad is inserted at the end if this point
a9c81431
VS
709 * is beyond the end of the list of pads.
710 * @param count Pointer to the number of pads in the list
711 * @param padidx_off Offset within an AVFilterLink structure to the element
712 * to increment when inserting a new pad causes link
713 * numbering to change
714 * @param pads Pointer to the pointer to the beginning of the list of pads
715 * @param links Pointer to the pointer to the beginning of the list of links
716 * @param newpad The new pad to add. A copy is made when adding.
717 */
718void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
719 AVFilterPad **pads, AVFilterLink ***links,
720 AVFilterPad *newpad);
721
49bd8e4b 722/** Insert a new input pad for the filter. */
a9c81431
VS
723static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
724 AVFilterPad *p)
725{
726 avfilter_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
727 &f->input_pads, &f->inputs, p);
728}
729
49bd8e4b 730/** Insert a new output pad for the filter. */
a9c81431
VS
731static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
732 AVFilterPad *p)
733{
734 avfilter_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
735 &f->output_pads, &f->outputs, p);
736}
737
98790382 738#endif /* AVFILTER_AVFILTER_H */