Merge commit '1565cbc65cbb9f95c11367314a080068895e0cf0'
[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 typedef struct AVFilterContext AVFilterContext;
64 typedef struct AVFilterLink    AVFilterLink;
65 typedef struct AVFilterPad     AVFilterPad;
66 typedef struct AVFilterFormats AVFilterFormats;
67
68 #if FF_API_AVFILTERBUFFER
69 /**
70  * A reference-counted buffer data type used by the filter system. Filters
71  * should not store pointers to this structure directly, but instead use the
72  * AVFilterBufferRef structure below.
73  */
74 typedef struct AVFilterBuffer {
75     uint8_t *data[8];           ///< buffer data for each plane/channel
76
77     /**
78      * pointers to the data planes/channels.
79      *
80      * For video, this should simply point to data[].
81      *
82      * For planar audio, each channel has a separate data pointer, and
83      * linesize[0] contains the size of each channel buffer.
84      * For packed audio, there is just one data pointer, and linesize[0]
85      * contains the total size of the buffer for all channels.
86      *
87      * Note: Both data and extended_data will always be set, but for planar
88      * audio with more channels that can fit in data, extended_data must be used
89      * in order to access all channels.
90      */
91     uint8_t **extended_data;
92     int linesize[8];            ///< number of bytes per line
93
94     /** private data to be used by a custom free function */
95     void *priv;
96     /**
97      * A pointer to the function to deallocate this buffer if the default
98      * function is not sufficient. This could, for example, add the memory
99      * back into a memory pool to be reused later without the overhead of
100      * reallocating it from scratch.
101      */
102     void (*free)(struct AVFilterBuffer *buf);
103
104     int format;                 ///< media format
105     int w, h;                   ///< width and height of the allocated buffer
106     unsigned refcount;          ///< number of references to this buffer
107 } AVFilterBuffer;
108
109 #define AV_PERM_READ     0x01   ///< can read from the buffer
110 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
111 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
112 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
113 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
114 #define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
115 #define AV_PERM_ALIGN    0x40   ///< the buffer must be aligned
116
117 #define AVFILTER_ALIGN 16 //not part of ABI
118
119 /**
120  * Audio specific properties in a reference to an AVFilterBuffer. Since
121  * AVFilterBufferRef is common to different media formats, audio specific
122  * per reference properties must be separated out.
123  */
124 typedef struct AVFilterBufferRefAudioProps {
125     uint64_t channel_layout;    ///< channel layout of audio buffer
126     int nb_samples;             ///< number of audio samples per channel
127     int sample_rate;            ///< audio buffer sample rate
128     int channels;               ///< number of channels (do not access directly)
129 } AVFilterBufferRefAudioProps;
130
131 /**
132  * Video specific properties in a reference to an AVFilterBuffer. Since
133  * AVFilterBufferRef is common to different media formats, video specific
134  * per reference properties must be separated out.
135  */
136 typedef struct AVFilterBufferRefVideoProps {
137     int w;                      ///< image width
138     int h;                      ///< image height
139     AVRational sample_aspect_ratio; ///< sample aspect ratio
140     int interlaced;             ///< is frame interlaced
141     int top_field_first;        ///< field order
142     enum AVPictureType pict_type; ///< picture type of the frame
143     int key_frame;              ///< 1 -> keyframe, 0-> not
144     int qp_table_linesize;                ///< qp_table stride
145     int qp_table_size;            ///< qp_table size
146     int8_t *qp_table;             ///< array of Quantization Parameters
147 } AVFilterBufferRefVideoProps;
148
149 /**
150  * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
151  * a buffer to, for example, crop image without any memcpy, the buffer origin
152  * and dimensions are per-reference properties. Linesize is also useful for
153  * image flipping, frame to field filters, etc, and so is also per-reference.
154  *
155  * TODO: add anything necessary for frame reordering
156  */
157 typedef struct AVFilterBufferRef {
158     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
159     uint8_t *data[8];           ///< picture/audio data for each plane
160     /**
161      * pointers to the data planes/channels.
162      *
163      * For video, this should simply point to data[].
164      *
165      * For planar audio, each channel has a separate data pointer, and
166      * linesize[0] contains the size of each channel buffer.
167      * For packed audio, there is just one data pointer, and linesize[0]
168      * contains the total size of the buffer for all channels.
169      *
170      * Note: Both data and extended_data will always be set, but for planar
171      * audio with more channels that can fit in data, extended_data must be used
172      * in order to access all channels.
173      */
174     uint8_t **extended_data;
175     int linesize[8];            ///< number of bytes per line
176
177     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
178     AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
179
180     /**
181      * presentation timestamp. The time unit may change during
182      * filtering, as it is specified in the link and the filter code
183      * may need to rescale the PTS accordingly.
184      */
185     int64_t pts;
186     int64_t pos;                ///< byte position in stream, -1 if unknown
187
188     int format;                 ///< media format
189
190     int perms;                  ///< permissions, see the AV_PERM_* flags
191
192     enum AVMediaType type;      ///< media type of buffer data
193
194     AVDictionary *metadata;     ///< dictionary containing metadata key=value tags
195 } AVFilterBufferRef;
196
197 /**
198  * Copy properties of src to dst, without copying the actual data
199  */
200 attribute_deprecated
201 void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
202
203 /**
204  * Add a new reference to a buffer.
205  *
206  * @param ref   an existing reference to the buffer
207  * @param pmask a bitmask containing the allowable permissions in the new
208  *              reference
209  * @return      a new reference to the buffer with the same properties as the
210  *              old, excluding any permissions denied by pmask
211  */
212 attribute_deprecated
213 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
214
215 /**
216  * Remove a reference to a buffer. If this is the last reference to the
217  * buffer, the buffer itself is also automatically freed.
218  *
219  * @param ref reference to the buffer, may be NULL
220  *
221  * @note it is recommended to use avfilter_unref_bufferp() instead of this
222  * function
223  */
224 attribute_deprecated
225 void avfilter_unref_buffer(AVFilterBufferRef *ref);
226
227 /**
228  * Remove a reference to a buffer and set the pointer to NULL.
229  * If this is the last reference to the buffer, the buffer itself
230  * is also automatically freed.
231  *
232  * @param ref pointer to the buffer reference
233  */
234 attribute_deprecated
235 void avfilter_unref_bufferp(AVFilterBufferRef **ref);
236 #endif
237
238 /**
239  * Get the number of channels of a buffer reference.
240  */
241 attribute_deprecated
242 int avfilter_ref_get_channels(AVFilterBufferRef *ref);
243
244 #if FF_API_AVFILTERPAD_PUBLIC
245 /**
246  * A filter pad used for either input or output.
247  *
248  * See doc/filter_design.txt for details on how to implement the methods.
249  *
250  * @warning this struct might be removed from public API.
251  * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
252  * to access the name and type fields; there should be no need to access
253  * any other fields from outside of libavfilter.
254  */
255 struct AVFilterPad {
256     /**
257      * Pad name. The name is unique among inputs and among outputs, but an
258      * input may have the same name as an output. This may be NULL if this
259      * pad has no need to ever be referenced by name.
260      */
261     const char *name;
262
263     /**
264      * AVFilterPad type.
265      */
266     enum AVMediaType type;
267
268     /**
269      * Input pads:
270      * Minimum required permissions on incoming buffers. Any buffer with
271      * insufficient permissions will be automatically copied by the filter
272      * system to a new buffer which provides the needed access permissions.
273      *
274      * Output pads:
275      * Guaranteed permissions on outgoing buffers. Any buffer pushed on the
276      * link must have at least these permissions; this fact is checked by
277      * asserts. It can be used to optimize buffer allocation.
278      */
279     attribute_deprecated int min_perms;
280
281     /**
282      * Input pads:
283      * Permissions which are not accepted on incoming buffers. Any buffer
284      * which has any of these permissions set will be automatically copied
285      * by the filter system to a new buffer which does not have those
286      * permissions. This can be used to easily disallow buffers with
287      * AV_PERM_REUSE.
288      *
289      * Output pads:
290      * Permissions which are automatically removed on outgoing buffers. It
291      * can be used to optimize buffer allocation.
292      */
293     attribute_deprecated int rej_perms;
294
295     /**
296      * @deprecated unused
297      */
298     int (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
299
300     /**
301      * Callback function to get a video buffer. If NULL, the filter system will
302      * use ff_default_get_video_buffer().
303      *
304      * Input video pads only.
305      */
306     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
307
308     /**
309      * Callback function to get an audio buffer. If NULL, the filter system will
310      * use ff_default_get_audio_buffer().
311      *
312      * Input audio pads only.
313      */
314     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
315
316     /**
317      * @deprecated unused
318      */
319     int (*end_frame)(AVFilterLink *link);
320
321     /**
322      * @deprecated unused
323      */
324     int (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
325
326     /**
327      * Filtering callback. This is where a filter receives a frame with
328      * audio/video data and should do its processing.
329      *
330      * Input pads only.
331      *
332      * @return >= 0 on success, a negative AVERROR on error. This function
333      * must ensure that frame is properly unreferenced on error if it
334      * hasn't been passed on to another filter.
335      */
336     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
337
338     /**
339      * Frame poll callback. This returns the number of immediately available
340      * samples. It should return a positive value if the next request_frame()
341      * is guaranteed to return one frame (with no delay).
342      *
343      * Defaults to just calling the source poll_frame() method.
344      *
345      * Output pads only.
346      */
347     int (*poll_frame)(AVFilterLink *link);
348
349     /**
350      * Frame request callback. A call to this should result in at least one
351      * frame being output over the given link. This should return zero on
352      * success, and another value on error.
353      * See ff_request_frame() for the error codes with a specific
354      * meaning.
355      *
356      * Output pads only.
357      */
358     int (*request_frame)(AVFilterLink *link);
359
360     /**
361      * Link configuration callback.
362      *
363      * For output pads, this should set the following link properties:
364      * video: width, height, sample_aspect_ratio, time_base
365      * audio: sample_rate.
366      *
367      * This should NOT set properties such as format, channel_layout, etc which
368      * are negotiated between filters by the filter system using the
369      * query_formats() callback before this function is called.
370      *
371      * For input pads, this should check the properties of the link, and update
372      * the filter's internal state as necessary.
373      *
374      * For both input and output pads, this should return zero on success,
375      * and another value on error.
376      */
377     int (*config_props)(AVFilterLink *link);
378
379     /**
380      * The filter expects a fifo to be inserted on its input link,
381      * typically because it has a delay.
382      *
383      * input pads only.
384      */
385     int needs_fifo;
386
387     int needs_writable;
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(const 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(const 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      * A class for the private data, used to access filter private
431      * AVOptions.
432      */
433     const AVClass *priv_class;
434
435     /*****************************************************************
436      * All fields below this line are not part of the public API. They
437      * may not be used outside of libavfilter and can be changed and
438      * removed at will.
439      * New public fields should be added right above.
440      *****************************************************************
441      */
442
443     /**
444      * Filter initialization function. Args contains the user-supplied
445      * parameters. FIXME: maybe an AVOption-based system would be better?
446      */
447     int (*init)(AVFilterContext *ctx, const char *args);
448
449     /**
450      * Should be set instead of init by the filters that want to pass a
451      * dictionary of AVOptions to nested contexts that are allocated in
452      * init.
453      */
454     int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
455
456     /**
457      * Filter uninitialization function. Should deallocate any memory held
458      * by the filter, release any buffer references, etc. This does not need
459      * to deallocate the AVFilterContext->priv memory itself.
460      */
461     void (*uninit)(AVFilterContext *ctx);
462
463     /**
464      * Queries formats/layouts supported by the filter and its pads, and sets
465      * the in_formats/in_chlayouts for links connected to its output pads,
466      * and out_formats/out_chlayouts for links connected to its input pads.
467      *
468      * @return zero on success, a negative value corresponding to an
469      * AVERROR code otherwise
470      */
471     int (*query_formats)(AVFilterContext *);
472
473     int priv_size;      ///< size of private data to allocate for the filter
474
475     /**
476      * Make the filter instance process a command.
477      *
478      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
479      * @param arg    the argument for the command
480      * @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.
481      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
482      *               time consuming then a filter should treat it like an unsupported command
483      *
484      * @returns >=0 on success otherwise an error code.
485      *          AVERROR(ENOSYS) on unsupported commands
486      */
487     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
488
489     /**
490      * Filter initialization function, alternative to the init()
491      * callback. Args contains the user-supplied parameters, opaque is
492      * used for providing binary data.
493      */
494     int (*init_opaque)(AVFilterContext *ctx, const char *args, void *opaque);
495
496     /**
497      * Shorthand syntax for init arguments.
498      * If this field is set (even to an empty list), just before init the
499      * private class will be set and the arguments string will be parsed
500      * using av_opt_set_from_string() with "=" and ":" delimiters, and
501      * av_opt_free() will be called just after uninit.
502      */
503     const char *const *shorthand;
504 } AVFilter;
505
506 /** An instance of a filter */
507 struct AVFilterContext {
508     const AVClass *av_class;        ///< needed for av_log()
509
510     const AVFilter *filter;         ///< the AVFilter of which this is an instance
511
512     char *name;                     ///< name of this filter instance
513
514     AVFilterPad   *input_pads;      ///< array of input pads
515     AVFilterLink **inputs;          ///< array of pointers to input links
516 #if FF_API_FOO_COUNT
517     unsigned input_count;           ///< @deprecated use nb_inputs
518 #endif
519     unsigned    nb_inputs;          ///< number of input pads
520
521     AVFilterPad   *output_pads;     ///< array of output pads
522     AVFilterLink **outputs;         ///< array of pointers to output links
523 #if FF_API_FOO_COUNT
524     unsigned output_count;          ///< @deprecated use nb_outputs
525 #endif
526     unsigned    nb_outputs;         ///< number of output pads
527
528     void *priv;                     ///< private data for use by the filter
529
530     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
531
532     struct AVFilterCommand *command_queue;
533 };
534
535 /**
536  * A link between two filters. This contains pointers to the source and
537  * destination filters between which this link exists, and the indexes of
538  * the pads involved. In addition, this link also contains the parameters
539  * which have been negotiated and agreed upon between the filter, such as
540  * image dimensions, format, etc.
541  */
542 struct AVFilterLink {
543     AVFilterContext *src;       ///< source filter
544     AVFilterPad *srcpad;        ///< output pad on the source filter
545
546     AVFilterContext *dst;       ///< dest filter
547     AVFilterPad *dstpad;        ///< input pad on the dest filter
548
549     enum AVMediaType type;      ///< filter media type
550
551     /* These parameters apply only to video */
552     int w;                      ///< agreed upon image width
553     int h;                      ///< agreed upon image height
554     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
555     /* These parameters apply only to audio */
556     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
557     int sample_rate;            ///< samples per second
558
559     int format;                 ///< agreed upon media format
560
561     /**
562      * Define the time base used by the PTS of the frames/samples
563      * which will pass through this link.
564      * During the configuration stage, each filter is supposed to
565      * change only the output timebase, while the timebase of the
566      * input link is assumed to be an unchangeable property.
567      */
568     AVRational time_base;
569
570     /*****************************************************************
571      * All fields below this line are not part of the public API. They
572      * may not be used outside of libavfilter and can be changed and
573      * removed at will.
574      * New public fields should be added right above.
575      *****************************************************************
576      */
577     /**
578      * Lists of formats and channel layouts supported by the input and output
579      * filters respectively. These lists are used for negotiating the format
580      * to actually be used, which will be loaded into the format and
581      * channel_layout members, above, when chosen.
582      *
583      */
584     AVFilterFormats *in_formats;
585     AVFilterFormats *out_formats;
586
587     /**
588      * Lists of channel layouts and sample rates used for automatic
589      * negotiation.
590      */
591     AVFilterFormats  *in_samplerates;
592     AVFilterFormats *out_samplerates;
593     struct AVFilterChannelLayouts  *in_channel_layouts;
594     struct AVFilterChannelLayouts *out_channel_layouts;
595
596     /**
597      * Audio only, the destination filter sets this to a non-zero value to
598      * request that buffers with the given number of samples should be sent to
599      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
600      * pad.
601      * Last buffer before EOF will be padded with silence.
602      */
603     int request_samples;
604
605     /** stage of the initialization of the link properties (dimensions, etc) */
606     enum {
607         AVLINK_UNINIT = 0,      ///< not started
608         AVLINK_STARTINIT,       ///< started, but incomplete
609         AVLINK_INIT             ///< complete
610     } init_state;
611
612     struct AVFilterPool *pool;
613
614     /**
615      * Graph the filter belongs to.
616      */
617     struct AVFilterGraph *graph;
618
619     /**
620      * Current timestamp of the link, as defined by the most recent
621      * frame(s), in AV_TIME_BASE units.
622      */
623     int64_t current_pts;
624
625     /**
626      * Index in the age array.
627      */
628     int age_index;
629
630     /**
631      * Frame rate of the stream on the link, or 1/0 if unknown;
632      * if left to 0/0, will be automatically be copied from the first input
633      * of the source filter if it exists.
634      *
635      * Sources should set it to the best estimation of the real frame rate.
636      * Filters should update it if necessary depending on their function.
637      * Sinks can use it to set a default output frame rate.
638      * It is similar to the r_frame_rate field in AVStream.
639      */
640     AVRational frame_rate;
641
642     /**
643      * Buffer partially filled with samples to achieve a fixed/minimum size.
644      */
645     AVFrame *partial_buf;
646
647     /**
648      * Size of the partial buffer to allocate.
649      * Must be between min_samples and max_samples.
650      */
651     int partial_buf_size;
652
653     /**
654      * Minimum number of samples to filter at once. If filter_frame() is
655      * called with fewer samples, it will accumulate them in partial_buf.
656      * This field and the related ones must not be changed after filtering
657      * has started.
658      * If 0, all related fields are ignored.
659      */
660     int min_samples;
661
662     /**
663      * Maximum number of samples to filter at once. If filter_frame() is
664      * called with more samples, it will split them.
665      */
666     int max_samples;
667
668     /**
669      * The buffer reference currently being received across the link by the
670      * destination filter. This is used internally by the filter system to
671      * allow automatic copying of buffers which do not have sufficient
672      * permissions for the destination. This should not be accessed directly
673      * by the filters.
674      */
675     AVFilterBufferRef *cur_buf_copy;
676
677     /**
678      * True if the link is closed.
679      * If set, all attemps of start_frame, filter_frame or request_frame
680      * will fail with AVERROR_EOF, and if necessary the reference will be
681      * destroyed.
682      * If request_frame returns AVERROR_EOF, this flag is set on the
683      * corresponding link.
684      * It can be set also be set by either the source or the destination
685      * filter.
686      */
687     int closed;
688
689     /**
690      * Number of channels.
691      */
692     int channels;
693
694     /**
695      * True if a frame is being requested on the link.
696      * Used internally by the framework.
697      */
698     unsigned frame_requested;
699
700     /**
701      * Link processing flags.
702      */
703     unsigned flags;
704 };
705
706 /**
707  * Link two filters together.
708  *
709  * @param src    the source filter
710  * @param srcpad index of the output pad on the source filter
711  * @param dst    the destination filter
712  * @param dstpad index of the input pad on the destination filter
713  * @return       zero on success
714  */
715 int avfilter_link(AVFilterContext *src, unsigned srcpad,
716                   AVFilterContext *dst, unsigned dstpad);
717
718 /**
719  * Free the link in *link, and set its pointer to NULL.
720  */
721 void avfilter_link_free(AVFilterLink **link);
722
723 /**
724  * Get the number of channels of a link.
725  */
726 int avfilter_link_get_channels(AVFilterLink *link);
727
728 /**
729  * Set the closed field of a link.
730  */
731 void avfilter_link_set_closed(AVFilterLink *link, int closed);
732
733 /**
734  * Negotiate the media format, dimensions, etc of all inputs to a filter.
735  *
736  * @param filter the filter to negotiate the properties for its inputs
737  * @return       zero on successful negotiation
738  */
739 int avfilter_config_links(AVFilterContext *filter);
740
741 #if FF_API_AVFILTERBUFFER
742 /**
743  * Create a buffer reference wrapped around an already allocated image
744  * buffer.
745  *
746  * @param data pointers to the planes of the image to reference
747  * @param linesize linesizes for the planes of the image to reference
748  * @param perms the required access permissions
749  * @param w the width of the image specified by the data and linesize arrays
750  * @param h the height of the image specified by the data and linesize arrays
751  * @param format the pixel format of the image specified by the data and linesize arrays
752  */
753 attribute_deprecated
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 AVPixelFormat format);
757
758 /**
759  * Create an audio buffer reference wrapped around an already
760  * allocated samples buffer.
761  *
762  * See avfilter_get_audio_buffer_ref_from_arrays_channels() for a version
763  * that can handle unknown channel layouts.
764  *
765  * @param data           pointers to the samples plane buffers
766  * @param linesize       linesize for the samples plane buffers
767  * @param perms          the required access permissions
768  * @param nb_samples     number of samples per channel
769  * @param sample_fmt     the format of each sample in the buffer to allocate
770  * @param channel_layout the channel layout of the buffer
771  */
772 attribute_deprecated
773 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
774                                                              int linesize,
775                                                              int perms,
776                                                              int nb_samples,
777                                                              enum AVSampleFormat sample_fmt,
778                                                              uint64_t channel_layout);
779 /**
780  * Create an audio buffer reference wrapped around an already
781  * allocated samples buffer.
782  *
783  * @param data           pointers to the samples plane buffers
784  * @param linesize       linesize for the samples plane buffers
785  * @param perms          the required access permissions
786  * @param nb_samples     number of samples per channel
787  * @param sample_fmt     the format of each sample in the buffer to allocate
788  * @param channels       the number of channels of the buffer
789  * @param channel_layout the channel layout of the buffer,
790  *                       must be either 0 or consistent with channels
791  */
792 attribute_deprecated
793 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays_channels(uint8_t **data,
794                                                                       int linesize,
795                                                                       int perms,
796                                                                       int nb_samples,
797                                                                       enum AVSampleFormat sample_fmt,
798                                                                       int channels,
799                                                                       uint64_t channel_layout);
800
801 #endif
802
803
804 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
805 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
806
807 /**
808  * Make the filter instance process a command.
809  * It is recommended to use avfilter_graph_send_command().
810  */
811 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
812
813 /** Initialize the filter system. Register all builtin filters. */
814 void avfilter_register_all(void);
815
816 /** Uninitialize the filter system. Unregister all filters. */
817 void avfilter_uninit(void);
818
819 /**
820  * Register a filter. This is only needed if you plan to use
821  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
822  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
823  * is not registered.
824  *
825  * @param filter the filter to register
826  * @return 0 if the registration was successful, a negative value
827  * otherwise
828  */
829 int avfilter_register(AVFilter *filter);
830
831 /**
832  * Get a filter definition matching the given name.
833  *
834  * @param name the filter name to find
835  * @return     the filter definition, if any matching one is registered.
836  *             NULL if none found.
837  */
838 AVFilter *avfilter_get_by_name(const char *name);
839
840 /**
841  * If filter is NULL, returns a pointer to the first registered filter pointer,
842  * if filter is non-NULL, returns the next pointer after filter.
843  * If the returned pointer points to NULL, the last registered filter
844  * was already reached.
845  */
846 AVFilter **av_filter_next(AVFilter **filter);
847
848 #if FF_API_AVFILTER_OPEN
849 /**
850  * Create a filter instance.
851  *
852  * @param filter_ctx put here a pointer to the created filter context
853  * on success, NULL on failure
854  * @param filter    the filter to create an instance of
855  * @param inst_name Name to give to the new instance. Can be NULL for none.
856  * @return >= 0 in case of success, a negative error code otherwise
857  * @deprecated use avfilter_graph_alloc_filter() instead
858  */
859 attribute_deprecated
860 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
861 #endif
862
863 /**
864  * Initialize a filter.
865  *
866  * @param filter the filter to initialize
867  * @param args   A string of parameters to use when initializing the filter.
868  *               The format and meaning of this string varies by filter.
869  * @param opaque Any extra non-string data needed by the filter. The meaning
870  *               of this parameter varies by filter.
871  * @return       zero on success
872  */
873 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
874
875 /**
876  * Free a filter context. This will also remove the filter from its
877  * filtergraph's list of filters.
878  *
879  * @param filter the filter to free
880  */
881 void avfilter_free(AVFilterContext *filter);
882
883 /**
884  * Insert a filter in the middle of an existing link.
885  *
886  * @param link the link into which the filter should be inserted
887  * @param filt the filter to be inserted
888  * @param filt_srcpad_idx the input pad on the filter to connect
889  * @param filt_dstpad_idx the output pad on the filter to connect
890  * @return     zero on success
891  */
892 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
893                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
894
895 #if FF_API_AVFILTERBUFFER
896 /**
897  * Copy the frame properties of src to dst, without copying the actual
898  * image data.
899  *
900  * @return 0 on success, a negative number on error.
901  */
902 attribute_deprecated
903 int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
904
905 /**
906  * Copy the frame properties and data pointers of src to dst, without copying
907  * the actual data.
908  *
909  * @return 0 on success, a negative number on error.
910  */
911 attribute_deprecated
912 int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
913 #endif
914
915 /**
916  * @return AVClass for AVFilterContext.
917  *
918  * @see av_opt_find().
919  */
920 const AVClass *avfilter_get_class(void);
921
922 typedef struct AVFilterGraph {
923     const AVClass *av_class;
924 #if FF_API_FOO_COUNT
925     attribute_deprecated
926     unsigned filter_count_unused;
927 #endif
928     AVFilterContext **filters;
929 #if !FF_API_FOO_COUNT
930     unsigned nb_filters;
931 #endif
932
933     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
934     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
935 #if FF_API_FOO_COUNT
936     unsigned nb_filters;
937 #endif
938     char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
939
940     /**
941      * Private fields
942      *
943      * The following fields are for internal use only.
944      * Their type, offset, number and semantic can change without notice.
945      */
946
947     AVFilterLink **sink_links;
948     int sink_links_count;
949
950     unsigned disable_auto_convert;
951 } AVFilterGraph;
952
953 /**
954  * Allocate a filter graph.
955  */
956 AVFilterGraph *avfilter_graph_alloc(void);
957
958 /**
959  * Create a new filter instance in a filter graph.
960  *
961  * @param graph graph in which the new filter will be used
962  * @param filter the filter to create an instance of
963  * @param name Name to give to the new instance (will be copied to
964  *             AVFilterContext.name). This may be used by the caller to identify
965  *             different filters, libavfilter itself assigns no semantics to
966  *             this parameter. May be NULL.
967  *
968  * @return the context of the newly created filter instance (note that it is
969  *         also retrievable directly through AVFilterGraph.filters or with
970  *         avfilter_graph_get_filter()) on success or NULL or failure.
971  */
972 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
973                                              const AVFilter *filter,
974                                              const char *name);
975
976 /**
977  * Get a filter instance with name name from graph.
978  *
979  * @return the pointer to the found filter instance or NULL if it
980  * cannot be found.
981  */
982 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
983
984 #if FF_API_AVFILTER_OPEN
985 /**
986  * Add an existing filter instance to a filter graph.
987  *
988  * @param graphctx  the filter graph
989  * @param filter the filter to be added
990  *
991  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
992  * filter graph
993  */
994 attribute_deprecated
995 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
996 #endif
997
998 /**
999  * Create and add a filter instance into an existing graph.
1000  * The filter instance is created from the filter filt and inited
1001  * with the parameters args and opaque.
1002  *
1003  * In case of success put in *filt_ctx the pointer to the created
1004  * filter instance, otherwise set *filt_ctx to NULL.
1005  *
1006  * @param name the instance name to give to the created filter instance
1007  * @param graph_ctx the filter graph
1008  * @return a negative AVERROR error code in case of failure, a non
1009  * negative value otherwise
1010  */
1011 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
1012                                  const char *name, const char *args, void *opaque,
1013                                  AVFilterGraph *graph_ctx);
1014
1015 /**
1016  * Enable or disable automatic format conversion inside the graph.
1017  *
1018  * Note that format conversion can still happen inside explicitly inserted
1019  * scale and aresample filters.
1020  *
1021  * @param flags  any of the AVFILTER_AUTO_CONVERT_* constants
1022  */
1023 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
1024
1025 enum {
1026     AVFILTER_AUTO_CONVERT_ALL  =  0, /**< all automatic conversions enabled */
1027     AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
1028 };
1029
1030 /**
1031  * Check validity and configure all the links and formats in the graph.
1032  *
1033  * @param graphctx the filter graph
1034  * @param log_ctx context used for logging
1035  * @return 0 in case of success, a negative AVERROR code otherwise
1036  */
1037 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
1038
1039 /**
1040  * Free a graph, destroy its links, and set *graph to NULL.
1041  * If *graph is NULL, do nothing.
1042  */
1043 void avfilter_graph_free(AVFilterGraph **graph);
1044
1045 /**
1046  * A linked-list of the inputs/outputs of the filter chain.
1047  *
1048  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
1049  * where it is used to communicate open (unlinked) inputs and outputs from and
1050  * to the caller.
1051  * This struct specifies, per each not connected pad contained in the graph, the
1052  * filter context and the pad index required for establishing a link.
1053  */
1054 typedef struct AVFilterInOut {
1055     /** unique name for this input/output in the list */
1056     char *name;
1057
1058     /** filter context associated to this input/output */
1059     AVFilterContext *filter_ctx;
1060
1061     /** index of the filt_ctx pad to use for linking */
1062     int pad_idx;
1063
1064     /** next input/input in the list, NULL if this is the last */
1065     struct AVFilterInOut *next;
1066 } AVFilterInOut;
1067
1068 /**
1069  * Allocate a single AVFilterInOut entry.
1070  * Must be freed with avfilter_inout_free().
1071  * @return allocated AVFilterInOut on success, NULL on failure.
1072  */
1073 AVFilterInOut *avfilter_inout_alloc(void);
1074
1075 /**
1076  * Free the supplied list of AVFilterInOut and set *inout to NULL.
1077  * If *inout is NULL, do nothing.
1078  */
1079 void avfilter_inout_free(AVFilterInOut **inout);
1080
1081 /**
1082  * Add a graph described by a string to a graph.
1083  *
1084  * @param graph   the filter graph where to link the parsed graph context
1085  * @param filters string to be parsed
1086  * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
1087  *                If non-NULL, *inputs is updated to contain the list of open inputs
1088  *                after the parsing, should be freed with avfilter_inout_free().
1089  * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
1090  *                If non-NULL, *outputs is updated to contain the list of open outputs
1091  *                after the parsing, should be freed with avfilter_inout_free().
1092  * @return non negative on success, a negative AVERROR code on error
1093  */
1094 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
1095                          AVFilterInOut **inputs, AVFilterInOut **outputs,
1096                          void *log_ctx);
1097
1098 /**
1099  * Add a graph described by a string to a graph.
1100  *
1101  * @param[in]  graph   the filter graph where to link the parsed graph context
1102  * @param[in]  filters string to be parsed
1103  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
1104  *                     parsed graph will be returned here. It is to be freed
1105  *                     by the caller using avfilter_inout_free().
1106  * @param[out] outputs a linked list of all free (unlinked) outputs of the
1107  *                     parsed graph will be returned here. It is to be freed by the
1108  *                     caller using avfilter_inout_free().
1109  * @return zero on success, a negative AVERROR code on error
1110  *
1111  * @note the difference between avfilter_graph_parse2() and
1112  * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
1113  * the lists of inputs and outputs, which therefore must be known before calling
1114  * the function. On the other hand, avfilter_graph_parse2() \em returns the
1115  * inputs and outputs that are left unlinked after parsing the graph and the
1116  * caller then deals with them. Another difference is that in
1117  * avfilter_graph_parse(), the inputs parameter describes inputs of the
1118  * <em>already existing</em> part of the graph; i.e. from the point of view of
1119  * the newly created part, they are outputs. Similarly the outputs parameter
1120  * describes outputs of the already existing filters, which are provided as
1121  * inputs to the parsed filters.
1122  * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
1123  * whatsoever to already existing parts of the graph and the inputs parameter
1124  * will on return contain inputs of the newly parsed part of the graph.
1125  * Analogously the outputs parameter will contain outputs of the newly created
1126  * filters.
1127  */
1128 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1129                           AVFilterInOut **inputs,
1130                           AVFilterInOut **outputs);
1131
1132 /**
1133  * Send a command to one or more filter instances.
1134  *
1135  * @param graph  the filter graph
1136  * @param target the filter(s) to which the command should be sent
1137  *               "all" sends to all filters
1138  *               otherwise it can be a filter or filter instance name
1139  *               which will send the command to all matching filters.
1140  * @param cmd    the command to sent, for handling simplicity all commands must be alphanumeric only
1141  * @param arg    the argument for the command
1142  * @param res    a buffer with size res_size where the filter(s) can return a response.
1143  *
1144  * @returns >=0 on success otherwise an error code.
1145  *              AVERROR(ENOSYS) on unsupported commands
1146  */
1147 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1148
1149 /**
1150  * Queue a command for one or more filter instances.
1151  *
1152  * @param graph  the filter graph
1153  * @param target the filter(s) to which the command should be sent
1154  *               "all" sends to all filters
1155  *               otherwise it can be a filter or filter instance name
1156  *               which will send the command to all matching filters.
1157  * @param cmd    the command to sent, for handling simplicity all commands must be alphanummeric only
1158  * @param arg    the argument for the command
1159  * @param ts     time at which the command should be sent to the filter
1160  *
1161  * @note As this executes commands after this function returns, no return code
1162  *       from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1163  */
1164 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1165
1166
1167 /**
1168  * Dump a graph into a human-readable string representation.
1169  *
1170  * @param graph    the graph to dump
1171  * @param options  formatting options; currently ignored
1172  * @return  a string, or NULL in case of memory allocation failure;
1173  *          the string must be freed using av_free
1174  */
1175 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1176
1177 /**
1178  * Request a frame on the oldest sink link.
1179  *
1180  * If the request returns AVERROR_EOF, try the next.
1181  *
1182  * Note that this function is not meant to be the sole scheduling mechanism
1183  * of a filtergraph, only a convenience function to help drain a filtergraph
1184  * in a balanced way under normal circumstances.
1185  *
1186  * Also note that AVERROR_EOF does not mean that frames did not arrive on
1187  * some of the sinks during the process.
1188  * When there are multiple sink links, in case the requested link
1189  * returns an EOF, this may cause a filter to flush pending frames
1190  * which are sent to another sink link, although unrequested.
1191  *
1192  * @return  the return value of ff_request_frame(),
1193  *          or AVERROR_EOF if all links returned AVERROR_EOF
1194  */
1195 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1196
1197 /**
1198  * @}
1199  */
1200 #endif /* AVFILTER_AVFILTER_H */