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