lavfi: loop on request_frame if necessary.
[ffmpeg.git] / libavfilter / avfilter.h
1 /*
2  * filter layer
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
22 #ifndef AVFILTER_AVFILTER_H
23 #define AVFILTER_AVFILTER_H
24
25 /**
26  * @file
27  * @ingroup lavfi
28  * external API header
29  */
30
31 /**
32  * @defgroup lavfi Libavfilter
33  * @{
34  */
35
36 #include <stddef.h>
37
38 #include "libavutil/avutil.h"
39 #include "libavutil/dict.h"
40 #include "libavutil/frame.h"
41 #include "libavutil/log.h"
42 #include "libavutil/samplefmt.h"
43 #include "libavutil/pixfmt.h"
44 #include "libavutil/rational.h"
45
46 #include "libavfilter/version.h"
47
48 /**
49  * Return the LIBAVFILTER_VERSION_INT constant.
50  */
51 unsigned avfilter_version(void);
52
53 /**
54  * Return the libavfilter build-time configuration.
55  */
56 const char *avfilter_configuration(void);
57
58 /**
59  * Return the libavfilter license.
60  */
61 const char *avfilter_license(void);
62
63 /**
64  * Get the class for the AVFilterContext struct.
65  */
66 const AVClass *avfilter_get_class(void);
67
68 typedef struct AVFilterContext AVFilterContext;
69 typedef struct AVFilterLink    AVFilterLink;
70 typedef struct AVFilterPad     AVFilterPad;
71 typedef struct AVFilterFormats AVFilterFormats;
72
73 #if FF_API_AVFILTERBUFFER
74 /**
75  * A reference-counted buffer data type used by the filter system. Filters
76  * should not store pointers to this structure directly, but instead use the
77  * AVFilterBufferRef structure below.
78  */
79 typedef struct AVFilterBuffer {
80     uint8_t *data[8];           ///< buffer data for each plane/channel
81
82     /**
83      * pointers to the data planes/channels.
84      *
85      * For video, this should simply point to data[].
86      *
87      * For planar audio, each channel has a separate data pointer, and
88      * linesize[0] contains the size of each channel buffer.
89      * For packed audio, there is just one data pointer, and linesize[0]
90      * contains the total size of the buffer for all channels.
91      *
92      * Note: Both data and extended_data will always be set, but for planar
93      * audio with more channels that can fit in data, extended_data must be used
94      * in order to access all channels.
95      */
96     uint8_t **extended_data;
97     int linesize[8];            ///< number of bytes per line
98
99     /** private data to be used by a custom free function */
100     void *priv;
101     /**
102      * A pointer to the function to deallocate this buffer if the default
103      * function is not sufficient. This could, for example, add the memory
104      * back into a memory pool to be reused later without the overhead of
105      * reallocating it from scratch.
106      */
107     void (*free)(struct AVFilterBuffer *buf);
108
109     int format;                 ///< media format
110     int w, h;                   ///< width and height of the allocated buffer
111     unsigned refcount;          ///< number of references to this buffer
112 } AVFilterBuffer;
113
114 #define AV_PERM_READ     0x01   ///< can read from the buffer
115 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
116 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
117 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
118 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
119 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
120 #define AV_PERM_ALIGN    0x40   ///< the buffer must be aligned
121
122 #define AVFILTER_ALIGN 16 //not part of ABI
123
124 /**
125  * Audio specific properties in a reference to an AVFilterBuffer. Since
126  * AVFilterBufferRef is common to different media formats, audio specific
127  * per reference properties must be separated out.
128  */
129 typedef struct AVFilterBufferRefAudioProps {
130     uint64_t channel_layout;    ///< channel layout of audio buffer
131     int nb_samples;             ///< number of audio samples per channel
132     int sample_rate;            ///< audio buffer sample rate
133     int channels;               ///< number of channels (do not access directly)
134 } AVFilterBufferRefAudioProps;
135
136 /**
137  * Video specific properties in a reference to an AVFilterBuffer. Since
138  * AVFilterBufferRef is common to different media formats, video specific
139  * per reference properties must be separated out.
140  */
141 typedef struct AVFilterBufferRefVideoProps {
142     int w;                      ///< image width
143     int h;                      ///< image height
144     AVRational sample_aspect_ratio; ///< sample aspect ratio
145     int interlaced;             ///< is frame interlaced
146     int top_field_first;        ///< field order
147     enum AVPictureType pict_type; ///< picture type of the frame
148     int key_frame;              ///< 1 -> keyframe, 0-> not
149     int qp_table_linesize;                ///< qp_table stride
150     int qp_table_size;            ///< qp_table size
151     int8_t *qp_table;             ///< array of Quantization Parameters
152 } AVFilterBufferRefVideoProps;
153
154 /**
155  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
156  * a buffer to, for example, crop image without any memcpy, the buffer origin
157  * and dimensions are per-reference properties. Linesize is also useful for
158  * image flipping, frame to field filters, etc, and so is also per-reference.
159  *
160  * TODO: add anything necessary for frame reordering
161  */
162 typedef struct AVFilterBufferRef {
163     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
164     uint8_t *data[8];           ///< picture/audio data for each plane
165     /**
166      * pointers to the data planes/channels.
167      *
168      * For video, this should simply point to data[].
169      *
170      * For planar audio, each channel has a separate data pointer, and
171      * linesize[0] contains the size of each channel buffer.
172      * For packed audio, there is just one data pointer, and linesize[0]
173      * contains the total size of the buffer for all channels.
174      *
175      * Note: Both data and extended_data will always be set, but for planar
176      * audio with more channels that can fit in data, extended_data must be used
177      * in order to access all channels.
178      */
179     uint8_t **extended_data;
180     int linesize[8];            ///< number of bytes per line
181
182     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
183     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
184
185     /**
186      * presentation timestamp. The time unit may change during
187      * filtering, as it is specified in the link and the filter code
188      * may need to rescale the PTS accordingly.
189      */
190     int64_t pts;
191     int64_t pos;                ///< byte position in stream, -1 if unknown
192
193     int format;                 ///< media format
194
195     int perms;                  ///< permissions, see the AV_PERM_* flags
196
197     enum AVMediaType type;      ///< media type of buffer data
198
199     AVDictionary *metadata;     ///< dictionary containing metadata key=value tags
200 } AVFilterBufferRef;
201
202 /**
203  * Copy properties of src to dst, without copying the actual data
204  */
205 attribute_deprecated
206 void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
207
208 /**
209  * Add a new reference to a buffer.
210  *
211  * @param ref   an existing reference to the buffer
212  * @param pmask a bitmask containing the allowable permissions in the new
213  *              reference
214  * @return      a new reference to the buffer with the same properties as the
215  *              old, excluding any permissions denied by pmask
216  */
217 attribute_deprecated
218 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
219
220 /**
221  * Remove a reference to a buffer. If this is the last reference to the
222  * buffer, the buffer itself is also automatically freed.
223  *
224  * @param ref reference to the buffer, may be NULL
225  *
226  * @note it is recommended to use avfilter_unref_bufferp() instead of this
227  * function
228  */
229 attribute_deprecated
230 void avfilter_unref_buffer(AVFilterBufferRef *ref);
231
232 /**
233  * Remove a reference to a buffer and set the pointer to NULL.
234  * If this is the last reference to the buffer, the buffer itself
235  * is also automatically freed.
236  *
237  * @param ref pointer to the buffer reference
238  */
239 attribute_deprecated
240 void avfilter_unref_bufferp(AVFilterBufferRef **ref);
241 #endif
242
243 /**
244  * Get the number of channels of a buffer reference.
245  */
246 attribute_deprecated
247 int avfilter_ref_get_channels(AVFilterBufferRef *ref);
248
249 #if FF_API_AVFILTERPAD_PUBLIC
250 /**
251  * A filter pad used for either input or output.
252  *
253  * See doc/filter_design.txt for details on how to implement the methods.
254  *
255  * @warning this struct might be removed from public API.
256  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
257  * to access the name and type fields; there should be no need to access
258  * any other fields from outside of libavfilter.
259  */
260 struct AVFilterPad {
261     /**
262      * Pad name. The name is unique among inputs and among outputs, but an
263      * input may have the same name as an output. This may be NULL if this
264      * pad has no need to ever be referenced by name.
265      */
266     const char *name;
267
268     /**
269      * AVFilterPad type.
270      */
271     enum AVMediaType type;
272
273     /**
274      * Input pads:
275      * Minimum required permissions on incoming buffers. Any buffer with
276      * insufficient permissions will be automatically copied by the filter
277      * system to a new buffer which provides the needed access permissions.
278      *
279      * Output pads:
280      * Guaranteed permissions on outgoing buffers. Any buffer pushed on the
281      * link must have at least these permissions; this fact is checked by
282      * asserts. It can be used to optimize buffer allocation.
283      */
284     attribute_deprecated int min_perms;
285
286     /**
287      * Input pads:
288      * Permissions which are not accepted on incoming buffers. Any buffer
289      * which has any of these permissions set will be automatically copied
290      * by the filter system to a new buffer which does not have those
291      * permissions. This can be used to easily disallow buffers with
292      * AV_PERM_REUSE.
293      *
294      * Output pads:
295      * Permissions which are automatically removed on outgoing buffers. It
296      * can be used to optimize buffer allocation.
297      */
298     attribute_deprecated int rej_perms;
299
300     /**
301      * @deprecated unused
302      */
303     int (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
304
305     /**
306      * Callback function to get a video buffer. If NULL, the filter system will
307      * use ff_default_get_video_buffer().
308      *
309      * Input video pads only.
310      */
311     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
312
313     /**
314      * Callback function to get an audio buffer. If NULL, the filter system will
315      * use ff_default_get_audio_buffer().
316      *
317      * Input audio pads only.
318      */
319     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
320
321     /**
322      * @deprecated unused
323      */
324     int (*end_frame)(AVFilterLink *link);
325
326     /**
327      * @deprecated unused
328      */
329     int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
330
331     /**
332      * Filtering callback. This is where a filter receives a frame with
333      * audio/video data and should do its processing.
334      *
335      * Input pads only.
336      *
337      * @return >= 0 on success, a negative AVERROR on error. This function
338      * must ensure that frame is properly unreferenced on error if it
339      * hasn't been passed on to another filter.
340      */
341     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
342
343     /**
344      * Frame poll callback. This returns the number of immediately available
345      * samples. It should return a positive value if the next request_frame()
346      * is guaranteed to return one frame (with no delay).
347      *
348      * Defaults to just calling the source poll_frame() method.
349      *
350      * Output pads only.
351      */
352     int (*poll_frame)(AVFilterLink *link);
353
354     /**
355      * Frame request callback. A call to this should result in at least one
356      * frame being output over the given link. This should return zero on
357      * success, and another value on error.
358      * See ff_request_frame() for the error codes with a specific
359      * meaning.
360      *
361      * Output pads only.
362      */
363     int (*request_frame)(AVFilterLink *link);
364
365     /**
366      * Link configuration callback.
367      *
368      * For output pads, this should set the following link properties:
369      * video: width, height, sample_aspect_ratio, time_base
370      * audio: sample_rate.
371      *
372      * This should NOT set properties such as format, channel_layout, etc which
373      * are negotiated between filters by the filter system using the
374      * query_formats() callback before this function is called.
375      *
376      * For input pads, this should check the properties of the link, and update
377      * the filter's internal state as necessary.
378      *
379      * For both input and output pads, this should return zero on success,
380      * and another value on error.
381      */
382     int (*config_props)(AVFilterLink *link);
383
384     /**
385      * The filter expects a fifo to be inserted on its input link,
386      * typically because it has a delay.
387      *
388      * input pads only.
389      */
390     int needs_fifo;
391
392     int needs_writable;
393 };
394 #endif
395
396 /**
397  * Get the name of an AVFilterPad.
398  *
399  * @param pads an array of AVFilterPads
400  * @param pad_idx index of the pad in the array it; is the caller's
401  *                responsibility to ensure the index is valid
402  *
403  * @return name of the pad_idx'th pad in pads
404  */
405 const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx);
406
407 /**
408  * Get the type of an AVFilterPad.
409  *
410  * @param pads an array of AVFilterPads
411  * @param pad_idx index of the pad in the array; it is the caller's
412  *                responsibility to ensure the index is valid
413  *
414  * @return type of the pad_idx'th pad in pads
415  */
416 enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx);
417
418 /**
419  * Filter definition. This defines the pads a filter contains, and all the
420  * callback functions used to interact with the filter.
421  */
422 typedef struct AVFilter {
423     const char *name;         ///< filter name
424
425     /**
426      * A description for the filter. You should use the
427      * NULL_IF_CONFIG_SMALL() macro to define it.
428      */
429     const char *description;
430
431     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
432     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
433
434     /*****************************************************************
435      * All fields below this line are not part of the public API. They
436      * may not be used outside of libavfilter and can be changed and
437      * removed at will.
438      * New public fields should be added right above.
439      *****************************************************************
440      */
441
442     /**
443      * Filter initialization function. Args contains the user-supplied
444      * parameters. FIXME: maybe an AVOption-based system would be better?
445      */
446     int (*init)(AVFilterContext *ctx, const char *args);
447
448     /**
449      * Filter uninitialization function. Should deallocate any memory held
450      * by the filter, release any buffer references, etc. This does not need
451      * to deallocate the AVFilterContext->priv memory itself.
452      */
453     void (*uninit)(AVFilterContext *ctx);
454
455     /**
456      * Queries formats/layouts supported by the filter and its pads, and sets
457      * the in_formats/in_chlayouts for links connected to its output pads,
458      * and out_formats/out_chlayouts for links connected to its input pads.
459      *
460      * @return zero on success, a negative value corresponding to an
461      * AVERROR code otherwise
462      */
463     int (*query_formats)(AVFilterContext *);
464
465     int priv_size;      ///< size of private data to allocate for the filter
466
467     /**
468      * Make the filter instance process a command.
469      *
470      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
471      * @param arg    the argument for the command
472      * @param res    a buffer with size res_size where the filter(s) can return a response. This must not change when the command is not supported.
473      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
474      *               time consuming then a filter should treat it like an unsupported command
475      *
476      * @returns >=0 on success otherwise an error code.
477      *          AVERROR(ENOSYS) on unsupported commands
478      */
479     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
480
481     /**
482      * Filter initialization function, alternative to the init()
483      * callback. Args contains the user-supplied parameters, opaque is
484      * used for providing binary data.
485      */
486     int (*init_opaque)(AVFilterContext *ctx, const char *args, void *opaque);
487
488     const AVClass *priv_class;      ///< private class, containing filter specific options
489
490     /**
491      * Shorthand syntax for init arguments.
492      * If this field is set (even to an empty list), just before init the
493      * private class will be set and the arguments string will be parsed
494      * using av_opt_set_from_string() with "=" and ":" delimiters, and
495      * av_opt_free() will be called just after uninit.
496      */
497     const char *const *shorthand;
498 } AVFilter;
499
500 /** An instance of a filter */
501 struct AVFilterContext {
502     const AVClass *av_class;        ///< needed for av_log()
503
504     AVFilter *filter;               ///< the AVFilter of which this is an instance
505
506     char *name;                     ///< name of this filter instance
507
508     AVFilterPad   *input_pads;      ///< array of input pads
509     AVFilterLink **inputs;          ///< array of pointers to input links
510 #if FF_API_FOO_COUNT
511     unsigned input_count;           ///< @deprecated use nb_inputs
512 #endif
513     unsigned    nb_inputs;          ///< number of input pads
514
515     AVFilterPad   *output_pads;     ///< array of output pads
516     AVFilterLink **outputs;         ///< array of pointers to output links
517 #if FF_API_FOO_COUNT
518     unsigned output_count;          ///< @deprecated use nb_outputs
519 #endif
520     unsigned    nb_outputs;         ///< number of output pads
521
522     void *priv;                     ///< private data for use by the filter
523
524     struct AVFilterCommand *command_queue;
525 };
526
527 /**
528  * A link between two filters. This contains pointers to the source and
529  * destination filters between which this link exists, and the indexes of
530  * the pads involved. In addition, this link also contains the parameters
531  * which have been negotiated and agreed upon between the filter, such as
532  * image dimensions, format, etc.
533  */
534 struct AVFilterLink {
535     AVFilterContext *src;       ///< source filter
536     AVFilterPad *srcpad;        ///< output pad on the source filter
537
538     AVFilterContext *dst;       ///< dest filter
539     AVFilterPad *dstpad;        ///< input pad on the dest filter
540
541     enum AVMediaType type;      ///< filter media type
542
543     /* These parameters apply only to video */
544     int w;                      ///< agreed upon image width
545     int h;                      ///< agreed upon image height
546     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
547     /* These parameters apply only to audio */
548     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
549     int sample_rate;            ///< samples per second
550
551     int format;                 ///< agreed upon media format
552
553     /**
554      * Define the time base used by the PTS of the frames/samples
555      * which will pass through this link.
556      * During the configuration stage, each filter is supposed to
557      * change only the output timebase, while the timebase of the
558      * input link is assumed to be an unchangeable property.
559      */
560     AVRational time_base;
561
562     /*****************************************************************
563      * All fields below this line are not part of the public API. They
564      * may not be used outside of libavfilter and can be changed and
565      * removed at will.
566      * New public fields should be added right above.
567      *****************************************************************
568      */
569     /**
570      * Lists of formats and channel layouts supported by the input and output
571      * filters respectively. These lists are used for negotiating the format
572      * to actually be used, which will be loaded into the format and
573      * channel_layout members, above, when chosen.
574      *
575      */
576     AVFilterFormats *in_formats;
577     AVFilterFormats *out_formats;
578
579     /**
580      * Lists of channel layouts and sample rates used for automatic
581      * negotiation.
582      */
583     AVFilterFormats  *in_samplerates;
584     AVFilterFormats *out_samplerates;
585     struct AVFilterChannelLayouts  *in_channel_layouts;
586     struct AVFilterChannelLayouts *out_channel_layouts;
587
588     /**
589      * Audio only, the destination filter sets this to a non-zero value to
590      * request that buffers with the given number of samples should be sent to
591      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
592      * pad.
593      * Last buffer before EOF will be padded with silence.
594      */
595     int request_samples;
596
597     /** stage of the initialization of the link properties (dimensions, etc) */
598     enum {
599         AVLINK_UNINIT = 0,      ///< not started
600         AVLINK_STARTINIT,       ///< started, but incomplete
601         AVLINK_INIT             ///< complete
602     } init_state;
603
604     struct AVFilterPool *pool;
605
606     /**
607      * Graph the filter belongs to.
608      */
609     struct AVFilterGraph *graph;
610
611     /**
612      * Current timestamp of the link, as defined by the most recent
613      * frame(s), in AV_TIME_BASE units.
614      */
615     int64_t current_pts;
616
617     /**
618      * Index in the age array.
619      */
620     int age_index;
621
622     /**
623      * Frame rate of the stream on the link, or 1/0 if unknown;
624      * if left to 0/0, will be automatically be copied from the first input
625      * of the source filter if it exists.
626      *
627      * Sources should set it to the best estimation of the real frame rate.
628      * Filters should update it if necessary depending on their function.
629      * Sinks can use it to set a default output frame rate.
630      * It is similar to the r_frame_rate field in AVStream.
631      */
632     AVRational frame_rate;
633
634     /**
635      * Buffer partially filled with samples to achieve a fixed/minimum size.
636      */
637     AVFrame *partial_buf;
638
639     /**
640      * Size of the partial buffer to allocate.
641      * Must be between min_samples and max_samples.
642      */
643     int partial_buf_size;
644
645     /**
646      * Minimum number of samples to filter at once. If filter_frame() is
647      * called with fewer samples, it will accumulate them in partial_buf.
648      * This field and the related ones must not be changed after filtering
649      * has started.
650      * If 0, all related fields are ignored.
651      */
652     int min_samples;
653
654     /**
655      * Maximum number of samples to filter at once. If filter_frame() is
656      * called with more samples, it will split them.
657      */
658     int max_samples;
659
660     /**
661      * The buffer reference currently being received across the link by the
662      * destination filter. This is used internally by the filter system to
663      * allow automatic copying of buffers which do not have sufficient
664      * permissions for the destination. This should not be accessed directly
665      * by the filters.
666      */
667     AVFilterBufferRef *cur_buf_copy;
668
669     /**
670      * True if the link is closed.
671      * If set, all attemps of start_frame, filter_frame or request_frame
672      * will fail with AVERROR_EOF, and if necessary the reference will be
673      * destroyed.
674      * If request_frame returns AVERROR_EOF, this flag is set on the
675      * corresponding link.
676      * It can be set also be set by either the source or the destination
677      * filter.
678      */
679     int closed;
680
681     /**
682      * Number of channels.
683      */
684     int channels;
685
686     /**
687      * True if a frame is being requested on the link.
688      * Used internally by the framework.
689      */
690     unsigned frame_requested;
691
692     /**
693      * Link processing flags.
694      */
695     unsigned flags;
696 };
697
698 /**
699  * Link two filters together.
700  *
701  * @param src    the source filter
702  * @param srcpad index of the output pad on the source filter
703  * @param dst    the destination filter
704  * @param dstpad index of the input pad on the destination filter
705  * @return       zero on success
706  */
707 int avfilter_link(AVFilterContext *src, unsigned srcpad,
708                   AVFilterContext *dst, unsigned dstpad);
709
710 /**
711  * Free the link in *link, and set its pointer to NULL.
712  */
713 void avfilter_link_free(AVFilterLink **link);
714
715 /**
716  * Get the number of channels of a link.
717  */
718 int avfilter_link_get_channels(AVFilterLink *link);
719
720 /**
721  * Set the closed field of a link.
722  */
723 void avfilter_link_set_closed(AVFilterLink *link, int closed);
724
725 /**
726  * Negotiate the media format, dimensions, etc of all inputs to a filter.
727  *
728  * @param filter the filter to negotiate the properties for its inputs
729  * @return       zero on successful negotiation
730  */
731 int avfilter_config_links(AVFilterContext *filter);
732
733 #if FF_API_AVFILTERBUFFER
734 /**
735  * Create a buffer reference wrapped around an already allocated image
736  * buffer.
737  *
738  * @param data pointers to the planes of the image to reference
739  * @param linesize linesizes for the planes of the image to reference
740  * @param perms the required access permissions
741  * @param w the width of the image specified by the data and linesize arrays
742  * @param h the height of the image specified by the data and linesize arrays
743  * @param format the pixel format of the image specified by the data and linesize arrays
744  */
745 attribute_deprecated
746 AVFilterBufferRef *
747 avfilter_get_video_buffer_ref_from_arrays(uint8_t * const data[4], const int linesize[4], int perms,
748                                           int w, int h, enum AVPixelFormat format);
749
750 /**
751  * Create an audio buffer reference wrapped around an already
752  * allocated samples buffer.
753  *
754  * See avfilter_get_audio_buffer_ref_from_arrays_channels() for a version
755  * that can handle unknown channel layouts.
756  *
757  * @param data           pointers to the samples plane buffers
758  * @param linesize       linesize for the samples plane buffers
759  * @param perms          the required access permissions
760  * @param nb_samples     number of samples per channel
761  * @param sample_fmt     the format of each sample in the buffer to allocate
762  * @param channel_layout the channel layout of the buffer
763  */
764 attribute_deprecated
765 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
766                                                              int linesize,
767                                                              int perms,
768                                                              int nb_samples,
769                                                              enum AVSampleFormat sample_fmt,
770                                                              uint64_t channel_layout);
771 /**
772  * Create an audio buffer reference wrapped around an already
773  * allocated samples buffer.
774  *
775  * @param data           pointers to the samples plane buffers
776  * @param linesize       linesize for the samples plane buffers
777  * @param perms          the required access permissions
778  * @param nb_samples     number of samples per channel
779  * @param sample_fmt     the format of each sample in the buffer to allocate
780  * @param channels       the number of channels of the buffer
781  * @param channel_layout the channel layout of the buffer,
782  *                       must be either 0 or consistent with channels
783  */
784 attribute_deprecated
785 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays_channels(uint8_t **data,
786                                                                       int linesize,
787                                                                       int perms,
788                                                                       int nb_samples,
789                                                                       enum AVSampleFormat sample_fmt,
790                                                                       int channels,
791                                                                       uint64_t channel_layout);
792
793 #endif
794
795
796 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
797 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
798
799 /**
800  * Make the filter instance process a command.
801  * It is recommended to use avfilter_graph_send_command().
802  */
803 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
804
805 /** Initialize the filter system. Register all builtin filters. */
806 void avfilter_register_all(void);
807
808 /** Uninitialize the filter system. Unregister all filters. */
809 void avfilter_uninit(void);
810
811 /**
812  * Register a filter. This is only needed if you plan to use
813  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
814  * filter can still by instantiated with avfilter_open even if it is not
815  * registered.
816  *
817  * @param filter the filter to register
818  * @return 0 if the registration was successful, a negative value
819  * otherwise
820  */
821 int avfilter_register(AVFilter *filter);
822
823 /**
824  * Get a filter definition matching the given name.
825  *
826  * @param name the filter name to find
827  * @return     the filter definition, if any matching one is registered.
828  *             NULL if none found.
829  */
830 AVFilter *avfilter_get_by_name(const char *name);
831
832 /**
833  * If filter is NULL, returns a pointer to the first registered filter pointer,
834  * if filter is non-NULL, returns the next pointer after filter.
835  * If the returned pointer points to NULL, the last registered filter
836  * was already reached.
837  */
838 AVFilter **av_filter_next(AVFilter **filter);
839
840 /**
841  * Create a filter instance.
842  *
843  * @param filter_ctx put here a pointer to the created filter context
844  * on success, NULL on failure
845  * @param filter    the filter to create an instance of
846  * @param inst_name Name to give to the new instance. Can be NULL for none.
847  * @return >= 0 in case of success, a negative error code otherwise
848  */
849 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
850
851 /**
852  * Initialize a filter.
853  *
854  * @param filter the filter to initialize
855  * @param args   A string of parameters to use when initializing the filter.
856  *               The format and meaning of this string varies by filter.
857  * @param opaque Any extra non-string data needed by the filter. The meaning
858  *               of this parameter varies by filter.
859  * @return       zero on success
860  */
861 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
862
863 /**
864  * Free a filter context.
865  *
866  * @param filter the filter to free
867  */
868 void avfilter_free(AVFilterContext *filter);
869
870 /**
871  * Insert a filter in the middle of an existing link.
872  *
873  * @param link the link into which the filter should be inserted
874  * @param filt the filter to be inserted
875  * @param filt_srcpad_idx the input pad on the filter to connect
876  * @param filt_dstpad_idx the output pad on the filter to connect
877  * @return     zero on success
878  */
879 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
880                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
881
882 #if FF_API_AVFILTERBUFFER
883 /**
884  * Copy the frame properties of src to dst, without copying the actual
885  * image data.
886  *
887  * @return 0 on success, a negative number on error.
888  */
889 attribute_deprecated
890 int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
891
892 /**
893  * Copy the frame properties and data pointers of src to dst, without copying
894  * the actual data.
895  *
896  * @return 0 on success, a negative number on error.
897  */
898 attribute_deprecated
899 int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
900 #endif
901
902 /**
903  * @}
904  */
905
906 #endif /* AVFILTER_AVFILTER_H */