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