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