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