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