lavfi: add const to the pads parameter of avfilter_pad_get_name/type
[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"
7e350379 26#include "libavutil/frame.h"
abc78a5a 27#include "libavutil/log.h"
737eb597 28#include "libavutil/samplefmt.h"
d49ea4af 29#include "libavutil/pixfmt.h"
e91709ca 30#include "libavutil/rational.h"
1c9e340d 31#include "libavcodec/avcodec.h"
1f20782c 32
a9c81431 33#include <stddef.h>
a5cbb2f4 34
3167dc95
AK
35#include "libavfilter/version.h"
36
540f1c7b 37/**
49bd8e4b 38 * Return the LIBAVFILTER_VERSION_INT constant.
540f1c7b
SS
39 */
40unsigned avfilter_version(void);
41
c1736936 42/**
49bd8e4b 43 * Return the libavfilter build-time configuration.
c1736936 44 */
41600690 45const char *avfilter_configuration(void);
c1736936
DB
46
47/**
49bd8e4b 48 * Return the libavfilter license.
c1736936 49 */
41600690 50const char *avfilter_license(void);
c1736936
DB
51
52
a5cbb2f4
VS
53typedef struct AVFilterContext AVFilterContext;
54typedef struct AVFilterLink AVFilterLink;
55typedef struct AVFilterPad AVFilterPad;
b74a1da4 56typedef struct AVFilterFormats AVFilterFormats;
a5cbb2f4 57
7e350379 58#if FF_API_AVFILTERBUFFER
a5cbb2f4 59/**
32d7bcd4 60 * A reference-counted buffer data type used by the filter system. Filters
a5cbb2f4 61 * should not store pointers to this structure directly, but instead use the
ecc8dada 62 * AVFilterBufferRef structure below.
a5cbb2f4 63 */
f607cc18 64typedef struct AVFilterBuffer {
56b5e9d5 65 uint8_t *data[8]; ///< buffer data for each plane/channel
9453c9e1
AK
66
67 /**
68 * pointers to the data planes/channels.
69 *
70 * For video, this should simply point to data[].
71 *
72 * For planar audio, each channel has a separate data pointer, and
73 * linesize[0] contains the size of each channel buffer.
74 * For packed audio, there is just one data pointer, and linesize[0]
75 * contains the total size of the buffer for all channels.
76 *
77 * Note: Both data and extended_data will always be set, but for planar
78 * audio with more channels that can fit in data, extended_data must be used
79 * in order to access all channels.
80 */
81 uint8_t **extended_data;
cb81e291
AK
82 int linesize[8]; ///< number of bytes per line
83
84 /** private data to be used by a custom free function */
85 void *priv;
86 /**
87 * A pointer to the function to deallocate this buffer if the default
88 * function is not sufficient. This could, for example, add the memory
89 * back into a memory pool to be reused later without the overhead of
90 * reallocating it from scratch.
91 */
92 void (*free)(struct AVFilterBuffer *buf);
93
94 int format; ///< media format
95 int w, h; ///< width and height of the allocated buffer
96 unsigned refcount; ///< number of references to this buffer
f0d77b20 97} AVFilterBuffer;
a5cbb2f4 98
ff5f1be0
HM
99#define AV_PERM_READ 0x01 ///< can read from the buffer
100#define AV_PERM_WRITE 0x02 ///< can write to the buffer
101#define AV_PERM_PRESERVE 0x04 ///< nobody else can overwrite the buffer
102#define AV_PERM_REUSE 0x08 ///< can output the buffer multiple times, with the same contents each time
103#define AV_PERM_REUSE2 0x10 ///< can output the buffer multiple times, modified each time
0ccabeea 104#define AV_PERM_NEG_LINESIZES 0x20 ///< the buffer requested can have negative linesizes
ff5f1be0 105
a5cbb2f4 106/**
ad2c9501
HM
107 * Audio specific properties in a reference to an AVFilterBuffer. Since
108 * AVFilterBufferRef is common to different media formats, audio specific
109 * per reference properties must be separated out.
110 */
111typedef struct AVFilterBufferRefAudioProps {
cc276c85 112 uint64_t channel_layout; ///< channel layout of audio buffer
a242ac36 113 int nb_samples; ///< number of audio samples
a6bdfc2a 114 int sample_rate; ///< audio buffer sample rate
ad2c9501
HM
115 int planar; ///< audio buffer - planar or packed
116} AVFilterBufferRefAudioProps;
117
118/**
cc80caff
HM
119 * Video specific properties in a reference to an AVFilterBuffer. Since
120 * AVFilterBufferRef is common to different media formats, video specific
121 * per reference properties must be separated out.
122 */
f607cc18 123typedef struct AVFilterBufferRefVideoProps {
cc80caff
HM
124 int w; ///< image width
125 int h; ///< image height
126 AVRational pixel_aspect; ///< pixel aspect ratio
127 int interlaced; ///< is frame interlaced
128 int top_field_first; ///< field order
bebe72f4 129 enum AVPictureType pict_type; ///< picture type of the frame
10d39405 130 int key_frame; ///< 1 -> keyframe, 0-> not
cc80caff
HM
131} AVFilterBufferRefVideoProps;
132
133/**
f0d77b20 134 * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
7fce481a 135 * a buffer to, for example, crop image without any memcpy, the buffer origin
38efe768 136 * and dimensions are per-reference properties. Linesize is also useful for
bbf42679 137 * image flipping, frame to field filters, etc, and so is also per-reference.
a5cbb2f4 138 *
1a18860a 139 * TODO: add anything necessary for frame reordering
a5cbb2f4 140 */
f607cc18 141typedef struct AVFilterBufferRef {
7fce481a 142 AVFilterBuffer *buf; ///< the buffer that this is a reference to
ad2c9501 143 uint8_t *data[8]; ///< picture/audio data for each plane
9453c9e1
AK
144 /**
145 * pointers to the data planes/channels.
146 *
147 * For video, this should simply point to data[].
148 *
149 * For planar audio, each channel has a separate data pointer, and
150 * linesize[0] contains the size of each channel buffer.
151 * For packed audio, there is just one data pointer, and linesize[0]
152 * contains the total size of the buffer for all channels.
153 *
154 * Note: Both data and extended_data will always be set, but for planar
155 * audio with more channels that can fit in data, extended_data must be used
156 * in order to access all channels.
157 */
158 uint8_t **extended_data;
f14e6856
AK
159 int linesize[8]; ///< number of bytes per line
160
161 AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
162 AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
163
164 /**
165 * presentation timestamp. The time unit may change during
166 * filtering, as it is specified in the link and the filter code
167 * may need to rescale the PTS accordingly.
168 */
169 int64_t pts;
170 int64_t pos; ///< byte position in stream, -1 if unknown
171
172 int format; ///< media format
173
174 int perms; ///< permissions, see the AV_PERM_* flags
175
176 enum AVMediaType type; ///< media type of buffer data
ecc8dada 177} AVFilterBufferRef;
a5cbb2f4
VS
178
179/**
ad2c9501 180 * Copy properties of src to dst, without copying the actual data
4d508e4d 181 */
7e350379 182attribute_deprecated
8134fafe 183void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
4d508e4d
SS
184
185/**
7fce481a 186 * Add a new reference to a buffer.
3fa3e4f4 187 *
7fce481a 188 * @param ref an existing reference to the buffer
664f6595 189 * @param pmask a bitmask containing the allowable permissions in the new
13ff8fd0 190 * reference
7fce481a 191 * @return a new reference to the buffer with the same properties as the
13ff8fd0 192 * old, excluding any permissions denied by pmask
a5cbb2f4 193 */
7e350379 194attribute_deprecated
7fce481a 195AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
a5cbb2f4
VS
196
197/**
7fce481a
HM
198 * Remove a reference to a buffer. If this is the last reference to the
199 * buffer, the buffer itself is also automatically freed.
3fa3e4f4 200 *
6baf4afa 201 * @param ref reference to the buffer, may be NULL
b70d89a0
RN
202 *
203 * @note it is recommended to use avfilter_unref_bufferp() instead of this
204 * function
a5cbb2f4 205 */
7e350379 206attribute_deprecated
7fce481a 207void avfilter_unref_buffer(AVFilterBufferRef *ref);
a5cbb2f4 208
b70d89a0
RN
209/**
210 * Remove a reference to a buffer and set the pointer to NULL.
211 * If this is the last reference to the buffer, the buffer itself
212 * is also automatically freed.
213 *
214 * @param ref pointer to the buffer reference
215 */
7e350379 216attribute_deprecated
b70d89a0 217void avfilter_unref_bufferp(AVFilterBufferRef **ref);
7e350379 218#endif
b70d89a0 219
9d0bfc50 220#if FF_API_AVFILTERPAD_PUBLIC
35f3fdf4 221/**
664f6595 222 * A filter pad used for either input or output.
9d0bfc50
AK
223 *
224 * @warning this struct will be removed from public API.
225 * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
226 * to access the name and type fields; there should be no need to access
227 * any other fields from outside of libavfilter.
13ff8fd0 228 */
f607cc18 229struct AVFilterPad {
a5cbb2f4 230 /**
38efe768
SS
231 * Pad name. The name is unique among inputs and among outputs, but an
232 * input may have the same name as an output. This may be NULL if this
13ff8fd0 233 * pad has no need to ever be referenced by name.
a5cbb2f4 234 */
2844dd39 235 const char *name;
a5cbb2f4
VS
236
237 /**
0ce4a627 238 * AVFilterPad type.
a5cbb2f4 239 */
72415b2a 240 enum AVMediaType type;
a5cbb2f4
VS
241
242 /**
38efe768 243 * Minimum required permissions on incoming buffers. Any buffer with
60bf6ce3
VS
244 * insufficient permissions will be automatically copied by the filter
245 * system to a new buffer which provides the needed access permissions.
246 *
247 * Input pads only.
248 */
7e350379 249 attribute_deprecated int min_perms;
60bf6ce3
VS
250
251 /**
38efe768 252 * Permissions which are not accepted on incoming buffers. Any buffer
9ce95f27
SS
253 * which has any of these permissions set will be automatically copied
254 * by the filter system to a new buffer which does not have those
38efe768 255 * permissions. This can be used to easily disallow buffers with
9ce95f27 256 * AV_PERM_REUSE.
60bf6ce3
VS
257 *
258 * Input pads only.
259 */
7e350379 260 attribute_deprecated int rej_perms;
60bf6ce3
VS
261
262 /**
565e4993 263 * @deprecated unused
a5cbb2f4 264 */
ebc8d974 265 int (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
a5cbb2f4
VS
266
267 /**
ad2c9501 268 * Callback function to get a video buffer. If NULL, the filter system will
da23d424 269 * use avfilter_default_get_video_buffer().
13ff8fd0
VS
270 *
271 * Input video pads only.
a5cbb2f4 272 */
7e350379 273 AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
a5cbb2f4
VS
274
275 /**
ad2c9501
HM
276 * Callback function to get an audio buffer. If NULL, the filter system will
277 * use avfilter_default_get_audio_buffer().
278 *
279 * Input audio pads only.
280 */
7e350379 281 AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
ad2c9501
HM
282
283 /**
565e4993 284 * @deprecated unused
a5cbb2f4 285 */
d4f89906 286 int (*end_frame)(AVFilterLink *link);
a5cbb2f4
VS
287
288 /**
565e4993 289 * @deprecated unused
a5cbb2f4 290 */
e9b992d0 291 int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
a5cbb2f4
VS
292
293 /**
565e4993
AK
294 * Filtering callback. This is where a filter receives a frame with
295 * audio/video data and should do its processing.
ad2c9501 296 *
565e4993 297 * Input pads only.
cd991462
AK
298 *
299 * @return >= 0 on success, a negative AVERROR on error. This function
300 * must ensure that samplesref is properly unreferenced on error if it
301 * hasn't been passed on to another filter.
ad2c9501 302 */
7e350379 303 int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
ad2c9501
HM
304
305 /**
38efe768 306 * Frame poll callback. This returns the number of immediately available
177477f5 307 * samples. It should return a positive value if the next request_frame()
d224d73a
VS
308 * is guaranteed to return one frame (with no delay).
309 *
310 * Defaults to just calling the source poll_frame() method.
311 *
ce353a88 312 * Output pads only.
d224d73a
VS
313 */
314 int (*poll_frame)(AVFilterLink *link);
315
316 /**
38efe768
SS
317 * Frame request callback. A call to this should result in at least one
318 * frame being output over the given link. This should return zero on
13ff8fd0
VS
319 * success, and another value on error.
320 *
ce353a88 321 * Output pads only.
a5cbb2f4 322 */
63f64e6f 323 int (*request_frame)(AVFilterLink *link);
a5cbb2f4
VS
324
325 /**
13ff8fd0
VS
326 * Link configuration callback.
327 *
328 * For output pads, this should set the link properties such as
38efe768 329 * width/height. This should NOT set the format property - that is
13ff8fd0
VS
330 * negotiated between filters by the filter system using the
331 * query_formats() callback before this function is called.
d3e57c15
VS
332 *
333 * For input pads, this should check the properties of the link, and update
334 * the filter's internal state as necessary.
13ff8fd0
VS
335 *
336 * For both input and output filters, this should return zero on success,
337 * and another value on error.
a5cbb2f4 338 */
d3e57c15 339 int (*config_props)(AVFilterLink *link);
58b049f2
AK
340
341 /**
342 * The filter expects a fifo to be inserted on its input link,
343 * typically because it has a delay.
344 *
345 * input pads only.
346 */
347 int needs_fifo;
7e350379
AK
348
349 int needs_writable;
a5cbb2f4 350};
9d0bfc50 351#endif
a5cbb2f4 352
84b9fbe0
AK
353/**
354 * Get the name of an AVFilterPad.
355 *
356 * @param pads an array of AVFilterPads
357 * @param pad_idx index of the pad in the array it; is the caller's
358 * responsibility to ensure the index is valid
359 *
360 * @return name of the pad_idx'th pad in pads
361 */
4a37d4b3 362const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
84b9fbe0
AK
363
364/**
365 * Get the type of an AVFilterPad.
366 *
367 * @param pads an array of AVFilterPads
368 * @param pad_idx index of the pad in the array; it is the caller's
369 * responsibility to ensure the index is valid
370 *
371 * @return type of the pad_idx'th pad in pads
372 */
4a37d4b3 373enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
84b9fbe0 374
13ff8fd0 375/**
38efe768 376 * Filter definition. This defines the pads a filter contains, and all the
13ff8fd0
VS
377 * callback functions used to interact with the filter.
378 */
f607cc18 379typedef struct AVFilter {
2844dd39 380 const char *name; ///< filter name
a5cbb2f4 381
96180805
AK
382 /**
383 * A description for the filter. You should use the
384 * NULL_IF_CONFIG_SMALL() macro to define it.
385 */
386 const char *description;
387
388 const AVFilterPad *inputs; ///< NULL terminated list of inputs. NULL if none
389 const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
390
b439c992
AK
391 /**
392 * A class for the private data, used to access filter private
393 * AVOptions.
394 */
395 const AVClass *priv_class;
396
96180805
AK
397 /*****************************************************************
398 * All fields below this line are not part of the public API. They
399 * may not be used outside of libavfilter and can be changed and
400 * removed at will.
401 * New public fields should be added right above.
402 *****************************************************************
403 */
a5cbb2f4 404
4d96a914 405 /**
c43a7eca
AK
406 * Filter initialization function. Called when all the options have been
407 * set.
4d96a914 408 */
c43a7eca 409 int (*init)(AVFilterContext *ctx);
13ff8fd0
VS
410
411 /**
4fa1f52e
AK
412 * Should be set instead of init by the filters that want to pass a
413 * dictionary of AVOptions to nested contexts that are allocated in
414 * init.
415 */
416 int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
417
418 /**
38efe768 419 * Filter uninitialization function. Should deallocate any memory held
7fce481a 420 * by the filter, release any buffer references, etc. This does not need
13ff8fd0
VS
421 * to deallocate the AVFilterContext->priv memory itself.
422 */
a5cbb2f4
VS
423 void (*uninit)(AVFilterContext *ctx);
424
35f3fdf4 425 /**
c4d2e41c 426 * Queries formats supported by the filter and its pads, and sets the
35f3fdf4
VS
427 * in_formats for links connected to its output pads, and out_formats
428 * for links connected to its input pads.
429 *
fe592585
SS
430 * @return zero on success, a negative value corresponding to an
431 * AVERROR code otherwise
35f3fdf4
VS
432 */
433 int (*query_formats)(AVFilterContext *);
434
96180805 435 int priv_size; ///< size of private data to allocate for the filter
a5cbb2f4
VS
436} AVFilter;
437
13ff8fd0 438/** An instance of a filter */
f607cc18 439struct AVFilterContext {
d42a814e 440 const AVClass *av_class; ///< needed for av_log()
a5cbb2f4 441
91d2efa7 442 const AVFilter *filter; ///< the AVFilter of which this is an instance
a5cbb2f4 443
13ff8fd0 444 char *name; ///< name of this filter instance
dcea2482 445
f892013a
AK
446 AVFilterPad *input_pads; ///< array of input pads
447 AVFilterLink **inputs; ///< array of pointers to input links
9baeff95
AK
448#if FF_API_FOO_COUNT
449 unsigned input_count; ///< @deprecated use nb_inputs
450#endif
f892013a 451 unsigned nb_inputs; ///< number of input pads
25f8e601 452
f892013a
AK
453 AVFilterPad *output_pads; ///< array of output pads
454 AVFilterLink **outputs; ///< array of pointers to output links
9baeff95
AK
455#if FF_API_FOO_COUNT
456 unsigned output_count; ///< @deprecated use nb_outputs
457#endif
f892013a 458 unsigned nb_outputs; ///< number of output pads
a5cbb2f4 459
13ff8fd0 460 void *priv; ///< private data for use by the filter
a5cbb2f4
VS
461};
462
13ff8fd0 463/**
38efe768 464 * A link between two filters. This contains pointers to the source and
f4433de9 465 * destination filters between which this link exists, and the indexes of
38efe768 466 * the pads involved. In addition, this link also contains the parameters
13ff8fd0 467 * which have been negotiated and agreed upon between the filter, such as
2b187df9 468 * image dimensions, format, etc.
13ff8fd0 469 */
f607cc18 470struct AVFilterLink {
13ff8fd0 471 AVFilterContext *src; ///< source filter
acc0490f 472 AVFilterPad *srcpad; ///< output pad on the source filter
a5cbb2f4 473
13ff8fd0 474 AVFilterContext *dst; ///< dest filter
acc0490f 475 AVFilterPad *dstpad; ///< input pad on the dest filter
a5cbb2f4 476
bdab614b
HM
477 enum AVMediaType type; ///< filter media type
478
910b5b82 479 /* These parameters apply only to video */
13ff8fd0
VS
480 int w; ///< agreed upon image width
481 int h; ///< agreed upon image height
910b5b82 482 AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
ad2c9501 483 /* These two parameters apply only to audio */
a903f8f0 484 uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/channel_layout.h)
f20ab492 485 int sample_rate; ///< samples per second
ad2c9501 486
bdab614b 487 int format; ///< agreed upon media format
a5cbb2f4 488
60bf6ce3 489 /**
867ae7aa
SS
490 * Define the time base used by the PTS of the frames/samples
491 * which will pass through this link.
492 * During the configuration stage, each filter is supposed to
493 * change only the output timebase, while the timebase of the
494 * input link is assumed to be an unchangeable property.
495 */
496 AVRational time_base;
5775a183
AK
497
498 /*****************************************************************
499 * All fields below this line are not part of the public API. They
500 * may not be used outside of libavfilter and can be changed and
501 * removed at will.
502 * New public fields should be added right above.
503 *****************************************************************
504 */
505 /**
83ba2239
AK
506 * Lists of formats supported by the input and output filters respectively.
507 * These lists are used for negotiating the format to actually be used,
508 * which will be loaded into the format member, above, when chosen.
509 */
510 AVFilterFormats *in_formats;
511 AVFilterFormats *out_formats;
512
513 /**
5775a183
AK
514 * Lists of channel layouts and sample rates used for automatic
515 * negotiation.
516 */
517 AVFilterFormats *in_samplerates;
518 AVFilterFormats *out_samplerates;
519 struct AVFilterChannelLayouts *in_channel_layouts;
520 struct AVFilterChannelLayouts *out_channel_layouts;
f75be985
AK
521
522 /**
523 * Audio only, the destination filter sets this to a non-zero value to
524 * request that buffers with the given number of samples should be sent to
525 * it. AVFilterPad.needs_fifo must also be set on the corresponding input
526 * pad.
527 * Last buffer before EOF will be padded with silence.
528 */
529 int request_samples;
83ba2239
AK
530
531 /** stage of the initialization of the link properties (dimensions, etc) */
532 enum {
533 AVLINK_UNINIT = 0, ///< not started
534 AVLINK_STARTINIT, ///< started, but incomplete
535 AVLINK_INIT ///< complete
536 } init_state;
a5cbb2f4
VS
537};
538
13ff8fd0 539/**
49bd8e4b 540 * Link two filters together.
3fa3e4f4 541 *
664f6595
VS
542 * @param src the source filter
543 * @param srcpad index of the output pad on the source filter
544 * @param dst the destination filter
545 * @param dstpad index of the input pad on the destination filter
546 * @return zero on success
13ff8fd0 547 */
a5cbb2f4
VS
548int avfilter_link(AVFilterContext *src, unsigned srcpad,
549 AVFilterContext *dst, unsigned dstpad);
550
13ff8fd0 551/**
bdab614b 552 * Negotiate the media format, dimensions, etc of all inputs to a filter.
3fa3e4f4 553 *
664f6595
VS
554 * @param filter the filter to negotiate the properties for its inputs
555 * @return zero on successful negotiation
13ff8fd0 556 */
24c4eff6 557int avfilter_config_links(AVFilterContext *filter);
85322466 558
7e350379 559#if FF_API_AVFILTERBUFFER
13ff8fd0 560/**
d38c340f
SS
561 * Create a buffer reference wrapped around an already allocated image
562 * buffer.
563 *
564 * @param data pointers to the planes of the image to reference
565 * @param linesize linesizes for the planes of the image to reference
566 * @param perms the required access permissions
567 * @param w the width of the image specified by the data and linesize arrays
568 * @param h the height of the image specified by the data and linesize arrays
569 * @param format the pixel format of the image specified by the data and linesize arrays
570 */
7e350379 571attribute_deprecated
d38c340f
SS
572AVFilterBufferRef *
573avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
716d413c 574 int w, int h, enum AVPixelFormat format);
d38c340f
SS
575
576/**
1b8c9271
SS
577 * Create an audio buffer reference wrapped around an already
578 * allocated samples buffer.
579 *
580 * @param data pointers to the samples plane buffers
581 * @param linesize linesize for the samples plane buffers
582 * @param perms the required access permissions
583 * @param nb_samples number of samples per channel
584 * @param sample_fmt the format of each sample in the buffer to allocate
585 * @param channel_layout the channel layout of the buffer
586 */
7e350379 587attribute_deprecated
1b8c9271
SS
588AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
589 int linesize,
590 int perms,
591 int nb_samples,
592 enum AVSampleFormat sample_fmt,
593 uint64_t channel_layout);
7e350379 594#endif
1b8c9271 595
49bd8e4b 596/** Initialize the filter system. Register all builtin filters. */
11de6cac 597void avfilter_register_all(void);
e4152452 598
49bd8e4b 599/** Uninitialize the filter system. Unregister all filters. */
a5cbb2f4 600void avfilter_uninit(void);
13ff8fd0
VS
601
602/**
49bd8e4b 603 * Register a filter. This is only needed if you plan to use
fc815c56
VS
604 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
605 * filter can still by instantiated with avfilter_open even if it is not
606 * registered.
3fa3e4f4 607 *
664f6595 608 * @param filter the filter to register
86a60fa1
SS
609 * @return 0 if the registration was succesfull, a negative value
610 * otherwise
13ff8fd0 611 */
86a60fa1 612int avfilter_register(AVFilter *filter);
13ff8fd0
VS
613
614/**
49bd8e4b 615 * Get a filter definition matching the given name.
3fa3e4f4 616 *
664f6595
VS
617 * @param name the filter name to find
618 * @return the filter definition, if any matching one is registered.
13ff8fd0
VS
619 * NULL if none found.
620 */
2844dd39 621AVFilter *avfilter_get_by_name(const char *name);
a5cbb2f4 622
13ff8fd0 623/**
1433c4ab
SS
624 * If filter is NULL, returns a pointer to the first registered filter pointer,
625 * if filter is non-NULL, returns the next pointer after filter.
626 * If the returned pointer points to NULL, the last registered filter
627 * was already reached.
628 */
629AVFilter **av_filter_next(AVFilter **filter);
630
631/**
49bd8e4b 632 * Create a filter instance.
84c03869
SS
633 *
634 * @param filter_ctx put here a pointer to the created filter context
635 * on success, NULL on failure
664f6595 636 * @param filter the filter to create an instance of
38efe768 637 * @param inst_name Name to give to the new instance. Can be NULL for none.
84c03869 638 * @return >= 0 in case of success, a negative error code otherwise
13ff8fd0 639 */
84c03869 640int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
13ff8fd0
VS
641
642/**
49bd8e4b 643 * Initialize a filter.
3fa3e4f4 644 *
664f6595 645 * @param filter the filter to initialize
13ff8fd0
VS
646 * @param args A string of parameters to use when initializing the filter.
647 * The format and meaning of this string varies by filter.
38efe768 648 * @param opaque Any extra non-string data needed by the filter. The meaning
13ff8fd0 649 * of this parameter varies by filter.
664f6595 650 * @return zero on success
13ff8fd0 651 */
6e365c57 652int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
13ff8fd0
VS
653
654/**
24de0edb 655 * Free a filter context.
3fa3e4f4 656 *
24de0edb 657 * @param filter the filter to free
13ff8fd0 658 */
24de0edb 659void avfilter_free(AVFilterContext *filter);
a5cbb2f4 660
13ff8fd0 661/**
49bd8e4b 662 * Insert a filter in the middle of an existing link.
3fa3e4f4 663 *
664f6595
VS
664 * @param link the link into which the filter should be inserted
665 * @param filt the filter to be inserted
486adc55
SS
666 * @param filt_srcpad_idx the input pad on the filter to connect
667 * @param filt_dstpad_idx the output pad on the filter to connect
664f6595 668 * @return zero on success
13ff8fd0 669 */
35f3fdf4 670int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
486adc55 671 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
d3e57c15 672
7e350379 673#if FF_API_AVFILTERBUFFER
1c9e340d
SS
674/**
675 * Copy the frame properties of src to dst, without copying the actual
676 * image data.
677 *
678 * @return 0 on success, a negative number on error.
679 */
7e350379 680attribute_deprecated
1c9e340d
SS
681int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
682
ab165047
AK
683/**
684 * Copy the frame properties and data pointers of src to dst, without copying
685 * the actual data.
686 *
687 * @return 0 on success, a negative number on error.
688 */
7e350379 689attribute_deprecated
ab165047 690int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
7e350379 691#endif
ab165047 692
8114c101
AK
693/**
694 * @return AVClass for AVFilterContext.
695 *
696 * @see av_opt_find().
697 */
698const AVClass *avfilter_get_class(void);
699
153382e1 700#endif /* AVFILTER_AVFILTER_H */