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