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