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