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