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