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