Merge commit '2a6eaeaa85d17b27ee0dd449183ec197c35c9675'
[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  * Main libavfilter public API header
29  */
30
31 /**
32  * @defgroup lavfi Libavfilter - graph-based frame editing library
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 number of elements in a NULL-terminated array of AVFilterPads (e.g.
393  * AVFilter.inputs/outputs).
394  */
395 int avfilter_pad_count(const AVFilterPad *pads);
396
397 /**
398  * Get the name of an AVFilterPad.
399  *
400  * @param pads an array of AVFilterPads
401  * @param pad_idx index of the pad in the array it; is the caller's
402  *                responsibility to ensure the index is valid
403  *
404  * @return name of the pad_idx'th pad in pads
405  */
406 const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
407
408 /**
409  * Get the type of an AVFilterPad.
410  *
411  * @param pads an array of AVFilterPads
412  * @param pad_idx index of the pad in the array; it is the caller's
413  *                responsibility to ensure the index is valid
414  *
415  * @return type of the pad_idx'th pad in pads
416  */
417 enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
418
419 /**
420  * The number of the filter inputs is not determined just by AVFilter.inputs.
421  * The filter might add additional inputs during initialization depending on the
422  * options supplied to it.
423  */
424 #define AVFILTER_FLAG_DYNAMIC_INPUTS        (1 << 0)
425 /**
426  * The number of the filter outputs is not determined just by AVFilter.outputs.
427  * The filter might add additional outputs during initialization depending on
428  * the options supplied to it.
429  */
430 #define AVFILTER_FLAG_DYNAMIC_OUTPUTS       (1 << 1)
431 /**
432  * Some filters support a generic "enable" expression option that can be used
433  * to enable or disable a filter in the timeline. Filters supporting this
434  * option have this flag set. When the enable expression is false, the default
435  * no-op filter_frame() function is called in place of the filter_frame()
436  * callback defined on each input pad, thus the frame is passed unchanged to
437  * the next filters.
438  */
439 #define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC  (1 << 16)
440 /**
441  * Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will
442  * have its filter_frame() callback(s) called as usual even when the enable
443  * expression is false. The filter will disable filtering within the
444  * filter_frame() callback(s) itself, for example executing code depending on
445  * the AVFilterContext->is_disabled value.
446  */
447 #define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17)
448 /**
449  * Handy mask to test whether the filter supports or no the timeline feature
450  * (internally or generically).
451  */
452 #define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL)
453
454 /**
455  * Filter definition. This defines the pads a filter contains, and all the
456  * callback functions used to interact with the filter.
457  */
458 typedef struct AVFilter {
459     const char *name;         ///< filter name
460
461     /**
462      * A description for the filter. You should use the
463      * NULL_IF_CONFIG_SMALL() macro to define it.
464      */
465     const char *description;
466
467     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
468     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
469
470     /**
471      * A class for the private data, used to access filter private
472      * AVOptions.
473      */
474     const AVClass *priv_class;
475
476     /**
477      * A combination of AVFILTER_FLAG_*
478      */
479     int flags;
480
481     /*****************************************************************
482      * All fields below this line are not part of the public API. They
483      * may not be used outside of libavfilter and can be changed and
484      * removed at will.
485      * New public fields should be added right above.
486      *****************************************************************
487      */
488
489     /**
490      * Filter initialization function. Called when all the options have been
491      * set.
492      */
493     int (*init)(AVFilterContext *ctx);
494
495     /**
496      * Should be set instead of init by the filters that want to pass a
497      * dictionary of AVOptions to nested contexts that are allocated in
498      * init.
499      */
500     int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
501
502     /**
503      * Filter uninitialization function. Should deallocate any memory held
504      * by the filter, release any buffer references, etc. This does not need
505      * to deallocate the AVFilterContext->priv memory itself.
506      */
507     void (*uninit)(AVFilterContext *ctx);
508
509     /**
510      * Queries formats/layouts supported by the filter and its pads, and sets
511      * the in_formats/in_chlayouts for links connected to its output pads,
512      * and out_formats/out_chlayouts for links connected to its input pads.
513      *
514      * @return zero on success, a negative value corresponding to an
515      * AVERROR code otherwise
516      */
517     int (*query_formats)(AVFilterContext *);
518
519     int priv_size;      ///< size of private data to allocate for the filter
520
521     struct AVFilter *next;
522
523     /**
524      * Make the filter instance process a command.
525      *
526      * @param cmd    the command to process, for handling simplicity all commands must be alphanumeric only
527      * @param arg    the argument for the command
528      * @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.
529      * @param flags  if AVFILTER_CMD_FLAG_FAST is set and the command would be
530      *               time consuming then a filter should treat it like an unsupported command
531      *
532      * @returns >=0 on success otherwise an error code.
533      *          AVERROR(ENOSYS) on unsupported commands
534      */
535     int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags);
536
537     /**
538      * Filter initialization function, alternative to the init()
539      * callback. Args contains the user-supplied parameters, opaque is
540      * used for providing binary data.
541      */
542     int (*init_opaque)(AVFilterContext *ctx, void *opaque);
543 } AVFilter;
544
545 /** An instance of a filter */
546 struct AVFilterContext {
547     const AVClass *av_class;        ///< needed for av_log() and filters common options
548
549     const AVFilter *filter;         ///< the AVFilter of which this is an instance
550
551     char *name;                     ///< name of this filter instance
552
553     AVFilterPad   *input_pads;      ///< array of input pads
554     AVFilterLink **inputs;          ///< array of pointers to input links
555 #if FF_API_FOO_COUNT
556     unsigned input_count;           ///< @deprecated use nb_inputs
557 #endif
558     unsigned    nb_inputs;          ///< number of input pads
559
560     AVFilterPad   *output_pads;     ///< array of output pads
561     AVFilterLink **outputs;         ///< array of pointers to output links
562 #if FF_API_FOO_COUNT
563     unsigned output_count;          ///< @deprecated use nb_outputs
564 #endif
565     unsigned    nb_outputs;         ///< number of output pads
566
567     void *priv;                     ///< private data for use by the filter
568
569     struct AVFilterGraph *graph;    ///< filtergraph this filter belongs to
570
571     struct AVFilterCommand *command_queue;
572
573     char *enable_str;               ///< enable expression string
574     void *enable;                   ///< parsed expression (AVExpr*)
575     double *var_values;             ///< variable values for the enable expression
576     int is_disabled;                ///< the enabled state from the last expression evaluation
577 };
578
579 /**
580  * A link between two filters. This contains pointers to the source and
581  * destination filters between which this link exists, and the indexes of
582  * the pads involved. In addition, this link also contains the parameters
583  * which have been negotiated and agreed upon between the filter, such as
584  * image dimensions, format, etc.
585  */
586 struct AVFilterLink {
587     AVFilterContext *src;       ///< source filter
588     AVFilterPad *srcpad;        ///< output pad on the source filter
589
590     AVFilterContext *dst;       ///< dest filter
591     AVFilterPad *dstpad;        ///< input pad on the dest filter
592
593     enum AVMediaType type;      ///< filter media type
594
595     /* These parameters apply only to video */
596     int w;                      ///< agreed upon image width
597     int h;                      ///< agreed upon image height
598     AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
599     /* These parameters apply only to audio */
600     uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/channel_layout.h)
601     int sample_rate;            ///< samples per second
602
603     int format;                 ///< agreed upon media format
604
605     /**
606      * Define the time base used by the PTS of the frames/samples
607      * which will pass through this link.
608      * During the configuration stage, each filter is supposed to
609      * change only the output timebase, while the timebase of the
610      * input link is assumed to be an unchangeable property.
611      */
612     AVRational time_base;
613
614     /*****************************************************************
615      * All fields below this line are not part of the public API. They
616      * may not be used outside of libavfilter and can be changed and
617      * removed at will.
618      * New public fields should be added right above.
619      *****************************************************************
620      */
621     /**
622      * Lists of formats and channel layouts supported by the input and output
623      * filters respectively. These lists are used for negotiating the format
624      * to actually be used, which will be loaded into the format and
625      * channel_layout members, above, when chosen.
626      *
627      */
628     AVFilterFormats *in_formats;
629     AVFilterFormats *out_formats;
630
631     /**
632      * Lists of channel layouts and sample rates used for automatic
633      * negotiation.
634      */
635     AVFilterFormats  *in_samplerates;
636     AVFilterFormats *out_samplerates;
637     struct AVFilterChannelLayouts  *in_channel_layouts;
638     struct AVFilterChannelLayouts *out_channel_layouts;
639
640     /**
641      * Audio only, the destination filter sets this to a non-zero value to
642      * request that buffers with the given number of samples should be sent to
643      * it. AVFilterPad.needs_fifo must also be set on the corresponding input
644      * pad.
645      * Last buffer before EOF will be padded with silence.
646      */
647     int request_samples;
648
649     /** stage of the initialization of the link properties (dimensions, etc) */
650     enum {
651         AVLINK_UNINIT = 0,      ///< not started
652         AVLINK_STARTINIT,       ///< started, but incomplete
653         AVLINK_INIT             ///< complete
654     } init_state;
655
656     struct AVFilterPool *pool;
657
658     /**
659      * Graph the filter belongs to.
660      */
661     struct AVFilterGraph *graph;
662
663     /**
664      * Current timestamp of the link, as defined by the most recent
665      * frame(s), in AV_TIME_BASE units.
666      */
667     int64_t current_pts;
668
669     /**
670      * Index in the age array.
671      */
672     int age_index;
673
674     /**
675      * Frame rate of the stream on the link, or 1/0 if unknown;
676      * if left to 0/0, will be automatically be copied from the first input
677      * of the source filter if it exists.
678      *
679      * Sources should set it to the best estimation of the real frame rate.
680      * Filters should update it if necessary depending on their function.
681      * Sinks can use it to set a default output frame rate.
682      * It is similar to the r_frame_rate field in AVStream.
683      */
684     AVRational frame_rate;
685
686     /**
687      * Buffer partially filled with samples to achieve a fixed/minimum size.
688      */
689     AVFrame *partial_buf;
690
691     /**
692      * Size of the partial buffer to allocate.
693      * Must be between min_samples and max_samples.
694      */
695     int partial_buf_size;
696
697     /**
698      * Minimum number of samples to filter at once. If filter_frame() is
699      * called with fewer samples, it will accumulate them in partial_buf.
700      * This field and the related ones must not be changed after filtering
701      * has started.
702      * If 0, all related fields are ignored.
703      */
704     int min_samples;
705
706     /**
707      * Maximum number of samples to filter at once. If filter_frame() is
708      * called with more samples, it will split them.
709      */
710     int max_samples;
711
712     /**
713      * The buffer reference currently being received across the link by the
714      * destination filter. This is used internally by the filter system to
715      * allow automatic copying of buffers which do not have sufficient
716      * permissions for the destination. This should not be accessed directly
717      * by the filters.
718      */
719     AVFilterBufferRef *cur_buf_copy;
720
721     /**
722      * True if the link is closed.
723      * If set, all attemps of start_frame, filter_frame or request_frame
724      * will fail with AVERROR_EOF, and if necessary the reference will be
725      * destroyed.
726      * If request_frame returns AVERROR_EOF, this flag is set on the
727      * corresponding link.
728      * It can be set also be set by either the source or the destination
729      * filter.
730      */
731     int closed;
732
733     /**
734      * Number of channels.
735      */
736     int channels;
737
738     /**
739      * True if a frame is being requested on the link.
740      * Used internally by the framework.
741      */
742     unsigned frame_requested;
743
744     /**
745      * Link processing flags.
746      */
747     unsigned flags;
748
749     /**
750      * Number of past frames sent through the link.
751      */
752     int64_t frame_count;
753 };
754
755 /**
756  * Link two filters together.
757  *
758  * @param src    the source filter
759  * @param srcpad index of the output pad on the source filter
760  * @param dst    the destination filter
761  * @param dstpad index of the input pad on the destination filter
762  * @return       zero on success
763  */
764 int avfilter_link(AVFilterContext *src, unsigned srcpad,
765                   AVFilterContext *dst, unsigned dstpad);
766
767 /**
768  * Free the link in *link, and set its pointer to NULL.
769  */
770 void avfilter_link_free(AVFilterLink **link);
771
772 /**
773  * Get the number of channels of a link.
774  */
775 int avfilter_link_get_channels(AVFilterLink *link);
776
777 /**
778  * Set the closed field of a link.
779  */
780 void avfilter_link_set_closed(AVFilterLink *link, int closed);
781
782 /**
783  * Negotiate the media format, dimensions, etc of all inputs to a filter.
784  *
785  * @param filter the filter to negotiate the properties for its inputs
786  * @return       zero on successful negotiation
787  */
788 int avfilter_config_links(AVFilterContext *filter);
789
790 #if FF_API_AVFILTERBUFFER
791 /**
792  * Create a buffer reference wrapped around an already allocated image
793  * buffer.
794  *
795  * @param data pointers to the planes of the image to reference
796  * @param linesize linesizes for the planes of the image to reference
797  * @param perms the required access permissions
798  * @param w the width of the image specified by the data and linesize arrays
799  * @param h the height of the image specified by the data and linesize arrays
800  * @param format the pixel format of the image specified by the data and linesize arrays
801  */
802 attribute_deprecated
803 AVFilterBufferRef *
804 avfilter_get_video_buffer_ref_from_arrays(uint8_t * const data[4], const int linesize[4], int perms,
805                                           int w, int h, enum AVPixelFormat format);
806
807 /**
808  * Create an audio buffer reference wrapped around an already
809  * allocated samples buffer.
810  *
811  * See avfilter_get_audio_buffer_ref_from_arrays_channels() for a version
812  * that can handle unknown channel layouts.
813  *
814  * @param data           pointers to the samples plane buffers
815  * @param linesize       linesize for the samples plane buffers
816  * @param perms          the required access permissions
817  * @param nb_samples     number of samples per channel
818  * @param sample_fmt     the format of each sample in the buffer to allocate
819  * @param channel_layout the channel layout of the buffer
820  */
821 attribute_deprecated
822 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
823                                                              int linesize,
824                                                              int perms,
825                                                              int nb_samples,
826                                                              enum AVSampleFormat sample_fmt,
827                                                              uint64_t channel_layout);
828 /**
829  * Create an audio buffer reference wrapped around an already
830  * allocated samples buffer.
831  *
832  * @param data           pointers to the samples plane buffers
833  * @param linesize       linesize for the samples plane buffers
834  * @param perms          the required access permissions
835  * @param nb_samples     number of samples per channel
836  * @param sample_fmt     the format of each sample in the buffer to allocate
837  * @param channels       the number of channels of the buffer
838  * @param channel_layout the channel layout of the buffer,
839  *                       must be either 0 or consistent with channels
840  */
841 attribute_deprecated
842 AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays_channels(uint8_t **data,
843                                                                       int linesize,
844                                                                       int perms,
845                                                                       int nb_samples,
846                                                                       enum AVSampleFormat sample_fmt,
847                                                                       int channels,
848                                                                       uint64_t channel_layout);
849
850 #endif
851
852
853 #define AVFILTER_CMD_FLAG_ONE   1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically
854 #define AVFILTER_CMD_FLAG_FAST  2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw)
855
856 /**
857  * Make the filter instance process a command.
858  * It is recommended to use avfilter_graph_send_command().
859  */
860 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags);
861
862 /** Initialize the filter system. Register all builtin filters. */
863 void avfilter_register_all(void);
864
865 #if FF_API_OLD_FILTER_REGISTER
866 /** Uninitialize the filter system. Unregister all filters. */
867 attribute_deprecated
868 void avfilter_uninit(void);
869 #endif
870
871 /**
872  * Register a filter. This is only needed if you plan to use
873  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
874  * filter can still by instantiated with avfilter_graph_alloc_filter even if it
875  * is not registered.
876  *
877  * @param filter the filter to register
878  * @return 0 if the registration was successful, a negative value
879  * otherwise
880  */
881 int avfilter_register(AVFilter *filter);
882
883 /**
884  * Get a filter definition matching the given name.
885  *
886  * @param name the filter name to find
887  * @return     the filter definition, if any matching one is registered.
888  *             NULL if none found.
889  */
890 AVFilter *avfilter_get_by_name(const char *name);
891
892 /**
893  * Iterate over all registered filters.
894  * @return If prev is non-NULL, next registered filter after prev or NULL if
895  * prev is the last filter. If prev is NULL, return the first registered filter.
896  */
897 const AVFilter *avfilter_next(const AVFilter *prev);
898
899 #if FF_API_OLD_FILTER_REGISTER
900 /**
901  * If filter is NULL, returns a pointer to the first registered filter pointer,
902  * if filter is non-NULL, returns the next pointer after filter.
903  * If the returned pointer points to NULL, the last registered filter
904  * was already reached.
905  * @deprecated use avfilter_next()
906  */
907 attribute_deprecated
908 AVFilter **av_filter_next(AVFilter **filter);
909 #endif
910
911 #if FF_API_AVFILTER_OPEN
912 /**
913  * Create a filter instance.
914  *
915  * @param filter_ctx put here a pointer to the created filter context
916  * on success, NULL on failure
917  * @param filter    the filter to create an instance of
918  * @param inst_name Name to give to the new instance. Can be NULL for none.
919  * @return >= 0 in case of success, a negative error code otherwise
920  * @deprecated use avfilter_graph_alloc_filter() instead
921  */
922 attribute_deprecated
923 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
924 #endif
925
926
927 #if FF_API_AVFILTER_INIT_FILTER
928 /**
929  * Initialize a filter.
930  *
931  * @param filter the filter to initialize
932  * @param args   A string of parameters to use when initializing the filter.
933  *               The format and meaning of this string varies by filter.
934  * @param opaque Any extra non-string data needed by the filter. The meaning
935  *               of this parameter varies by filter.
936  * @return       zero on success
937  */
938 attribute_deprecated
939 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
940 #endif
941
942 /**
943  * Initialize a filter with the supplied parameters.
944  *
945  * @param ctx  uninitialized filter context to initialize
946  * @param args Options to initialize the filter with. This must be a
947  *             ':'-separated list of options in the 'key=value' form.
948  *             May be NULL if the options have been set directly using the
949  *             AVOptions API or there are no options that need to be set.
950  * @return 0 on success, a negative AVERROR on failure
951  */
952 int avfilter_init_str(AVFilterContext *ctx, const char *args);
953
954 /**
955  * Initialize a filter with the supplied dictionary of options.
956  *
957  * @param ctx     uninitialized filter context to initialize
958  * @param options An AVDictionary filled with options for this filter. On
959  *                return this parameter will be destroyed and replaced with
960  *                a dict containing options that were not found. This dictionary
961  *                must be freed by the caller.
962  *                May be NULL, then this function is equivalent to
963  *                avfilter_init_str() with the second parameter set to NULL.
964  * @return 0 on success, a negative AVERROR on failure
965  *
966  * @note This function and avfilter_init_str() do essentially the same thing,
967  * the difference is in manner in which the options are passed. It is up to the
968  * calling code to choose whichever is more preferable. The two functions also
969  * behave differently when some of the provided options are not declared as
970  * supported by the filter. In such a case, avfilter_init_str() will fail, but
971  * this function will leave those extra options in the options AVDictionary and
972  * continue as usual.
973  */
974 int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
975
976 /**
977  * Free a filter context. This will also remove the filter from its
978  * filtergraph's list of filters.
979  *
980  * @param filter the filter to free
981  */
982 void avfilter_free(AVFilterContext *filter);
983
984 /**
985  * Insert a filter in the middle of an existing link.
986  *
987  * @param link the link into which the filter should be inserted
988  * @param filt the filter to be inserted
989  * @param filt_srcpad_idx the input pad on the filter to connect
990  * @param filt_dstpad_idx the output pad on the filter to connect
991  * @return     zero on success
992  */
993 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
994                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
995
996 #if FF_API_AVFILTERBUFFER
997 /**
998  * Copy the frame properties of src to dst, without copying the actual
999  * image data.
1000  *
1001  * @return 0 on success, a negative number on error.
1002  */
1003 attribute_deprecated
1004 int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
1005
1006 /**
1007  * Copy the frame properties and data pointers of src to dst, without copying
1008  * the actual data.
1009  *
1010  * @return 0 on success, a negative number on error.
1011  */
1012 attribute_deprecated
1013 int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
1014 #endif
1015
1016 /**
1017  * @return AVClass for AVFilterContext.
1018  *
1019  * @see av_opt_find().
1020  */
1021 const AVClass *avfilter_get_class(void);
1022
1023 typedef struct AVFilterGraph {
1024     const AVClass *av_class;
1025 #if FF_API_FOO_COUNT
1026     attribute_deprecated
1027     unsigned filter_count_unused;
1028 #endif
1029     AVFilterContext **filters;
1030 #if !FF_API_FOO_COUNT
1031     unsigned nb_filters;
1032 #endif
1033
1034     char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
1035     char *resample_lavr_opts;   ///< libavresample options to use for the auto-inserted resample filters
1036 #if FF_API_FOO_COUNT
1037     unsigned nb_filters;
1038 #endif
1039     char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions
1040
1041     /**
1042      * Private fields
1043      *
1044      * The following fields are for internal use only.
1045      * Their type, offset, number and semantic can change without notice.
1046      */
1047
1048     AVFilterLink **sink_links;
1049     int sink_links_count;
1050
1051     unsigned disable_auto_convert;
1052 } AVFilterGraph;
1053
1054 /**
1055  * Allocate a filter graph.
1056  */
1057 AVFilterGraph *avfilter_graph_alloc(void);
1058
1059 /**
1060  * Create a new filter instance in a filter graph.
1061  *
1062  * @param graph graph in which the new filter will be used
1063  * @param filter the filter to create an instance of
1064  * @param name Name to give to the new instance (will be copied to
1065  *             AVFilterContext.name). This may be used by the caller to identify
1066  *             different filters, libavfilter itself assigns no semantics to
1067  *             this parameter. May be NULL.
1068  *
1069  * @return the context of the newly created filter instance (note that it is
1070  *         also retrievable directly through AVFilterGraph.filters or with
1071  *         avfilter_graph_get_filter()) on success or NULL or failure.
1072  */
1073 AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
1074                                              const AVFilter *filter,
1075                                              const char *name);
1076
1077 /**
1078  * Get a filter instance with name name from graph.
1079  *
1080  * @return the pointer to the found filter instance or NULL if it
1081  * cannot be found.
1082  */
1083 AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
1084
1085 #if FF_API_AVFILTER_OPEN
1086 /**
1087  * Add an existing filter instance to a filter graph.
1088  *
1089  * @param graphctx  the filter graph
1090  * @param filter the filter to be added
1091  *
1092  * @deprecated use avfilter_graph_alloc_filter() to allocate a filter in a
1093  * filter graph
1094  */
1095 attribute_deprecated
1096 int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
1097 #endif
1098
1099 /**
1100  * Create and add a filter instance into an existing graph.
1101  * The filter instance is created from the filter filt and inited
1102  * with the parameters args and opaque.
1103  *
1104  * In case of success put in *filt_ctx the pointer to the created
1105  * filter instance, otherwise set *filt_ctx to NULL.
1106  *
1107  * @param name the instance name to give to the created filter instance
1108  * @param graph_ctx the filter graph
1109  * @return a negative AVERROR error code in case of failure, a non
1110  * negative value otherwise
1111  */
1112 int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
1113                                  const char *name, const char *args, void *opaque,
1114                                  AVFilterGraph *graph_ctx);
1115
1116 /**
1117  * Enable or disable automatic format conversion inside the graph.
1118  *
1119  * Note that format conversion can still happen inside explicitly inserted
1120  * scale and aresample filters.
1121  *
1122  * @param flags  any of the AVFILTER_AUTO_CONVERT_* constants
1123  */
1124 void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags);
1125
1126 enum {
1127     AVFILTER_AUTO_CONVERT_ALL  =  0, /**< all automatic conversions enabled */
1128     AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */
1129 };
1130
1131 /**
1132  * Check validity and configure all the links and formats in the graph.
1133  *
1134  * @param graphctx the filter graph
1135  * @param log_ctx context used for logging
1136  * @return 0 in case of success, a negative AVERROR code otherwise
1137  */
1138 int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
1139
1140 /**
1141  * Free a graph, destroy its links, and set *graph to NULL.
1142  * If *graph is NULL, do nothing.
1143  */
1144 void avfilter_graph_free(AVFilterGraph **graph);
1145
1146 /**
1147  * A linked-list of the inputs/outputs of the filter chain.
1148  *
1149  * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
1150  * where it is used to communicate open (unlinked) inputs and outputs from and
1151  * to the caller.
1152  * This struct specifies, per each not connected pad contained in the graph, the
1153  * filter context and the pad index required for establishing a link.
1154  */
1155 typedef struct AVFilterInOut {
1156     /** unique name for this input/output in the list */
1157     char *name;
1158
1159     /** filter context associated to this input/output */
1160     AVFilterContext *filter_ctx;
1161
1162     /** index of the filt_ctx pad to use for linking */
1163     int pad_idx;
1164
1165     /** next input/input in the list, NULL if this is the last */
1166     struct AVFilterInOut *next;
1167 } AVFilterInOut;
1168
1169 /**
1170  * Allocate a single AVFilterInOut entry.
1171  * Must be freed with avfilter_inout_free().
1172  * @return allocated AVFilterInOut on success, NULL on failure.
1173  */
1174 AVFilterInOut *avfilter_inout_alloc(void);
1175
1176 /**
1177  * Free the supplied list of AVFilterInOut and set *inout to NULL.
1178  * If *inout is NULL, do nothing.
1179  */
1180 void avfilter_inout_free(AVFilterInOut **inout);
1181
1182 /**
1183  * Add a graph described by a string to a graph.
1184  *
1185  * @param graph   the filter graph where to link the parsed graph context
1186  * @param filters string to be parsed
1187  * @param inputs  pointer to a linked list to the inputs of the graph, may be NULL.
1188  *                If non-NULL, *inputs is updated to contain the list of open inputs
1189  *                after the parsing, should be freed with avfilter_inout_free().
1190  * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
1191  *                If non-NULL, *outputs is updated to contain the list of open outputs
1192  *                after the parsing, should be freed with avfilter_inout_free().
1193  * @return non negative on success, a negative AVERROR code on error
1194  */
1195 int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
1196                          AVFilterInOut **inputs, AVFilterInOut **outputs,
1197                          void *log_ctx);
1198
1199 /**
1200  * Add a graph described by a string to a graph.
1201  *
1202  * @param[in]  graph   the filter graph where to link the parsed graph context
1203  * @param[in]  filters string to be parsed
1204  * @param[out] inputs  a linked list of all free (unlinked) inputs of the
1205  *                     parsed graph will be returned here. It is to be freed
1206  *                     by the caller using avfilter_inout_free().
1207  * @param[out] outputs a linked list of all free (unlinked) outputs of the
1208  *                     parsed graph will be returned here. It is to be freed by the
1209  *                     caller using avfilter_inout_free().
1210  * @return zero on success, a negative AVERROR code on error
1211  *
1212  * @note the difference between avfilter_graph_parse2() and
1213  * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
1214  * the lists of inputs and outputs, which therefore must be known before calling
1215  * the function. On the other hand, avfilter_graph_parse2() \em returns the
1216  * inputs and outputs that are left unlinked after parsing the graph and the
1217  * caller then deals with them. Another difference is that in
1218  * avfilter_graph_parse(), the inputs parameter describes inputs of the
1219  * <em>already existing</em> part of the graph; i.e. from the point of view of
1220  * the newly created part, they are outputs. Similarly the outputs parameter
1221  * describes outputs of the already existing filters, which are provided as
1222  * inputs to the parsed filters.
1223  * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
1224  * whatsoever to already existing parts of the graph and the inputs parameter
1225  * will on return contain inputs of the newly parsed part of the graph.
1226  * Analogously the outputs parameter will contain outputs of the newly created
1227  * filters.
1228  */
1229 int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
1230                           AVFilterInOut **inputs,
1231                           AVFilterInOut **outputs);
1232
1233 /**
1234  * Send a command to one or more filter instances.
1235  *
1236  * @param graph  the filter graph
1237  * @param target the filter(s) to which the command should be sent
1238  *               "all" sends to all filters
1239  *               otherwise it can be a filter or filter instance name
1240  *               which will send the command to all matching filters.
1241  * @param cmd    the command to send, for handling simplicity all commands must be alphanumeric only
1242  * @param arg    the argument for the command
1243  * @param res    a buffer with size res_size where the filter(s) can return a response.
1244  *
1245  * @returns >=0 on success otherwise an error code.
1246  *              AVERROR(ENOSYS) on unsupported commands
1247  */
1248 int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
1249
1250 /**
1251  * Queue a command for one or more filter instances.
1252  *
1253  * @param graph  the filter graph
1254  * @param target the filter(s) to which the command should be sent
1255  *               "all" sends to all filters
1256  *               otherwise it can be a filter or filter instance name
1257  *               which will send the command to all matching filters.
1258  * @param cmd    the command to sent, for handling simplicity all commands must be alphanummeric only
1259  * @param arg    the argument for the command
1260  * @param ts     time at which the command should be sent to the filter
1261  *
1262  * @note As this executes commands after this function returns, no return code
1263  *       from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
1264  */
1265 int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
1266
1267
1268 /**
1269  * Dump a graph into a human-readable string representation.
1270  *
1271  * @param graph    the graph to dump
1272  * @param options  formatting options; currently ignored
1273  * @return  a string, or NULL in case of memory allocation failure;
1274  *          the string must be freed using av_free
1275  */
1276 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
1277
1278 /**
1279  * Request a frame on the oldest sink link.
1280  *
1281  * If the request returns AVERROR_EOF, try the next.
1282  *
1283  * Note that this function is not meant to be the sole scheduling mechanism
1284  * of a filtergraph, only a convenience function to help drain a filtergraph
1285  * in a balanced way under normal circumstances.
1286  *
1287  * Also note that AVERROR_EOF does not mean that frames did not arrive on
1288  * some of the sinks during the process.
1289  * When there are multiple sink links, in case the requested link
1290  * returns an EOF, this may cause a filter to flush pending frames
1291  * which are sent to another sink link, although unrequested.
1292  *
1293  * @return  the return value of ff_request_frame(),
1294  *          or AVERROR_EOF if all links returned AVERROR_EOF
1295  */
1296 int avfilter_graph_request_oldest(AVFilterGraph *graph);
1297
1298 /**
1299  * @}
1300  */
1301
1302 #endif /* AVFILTER_AVFILTER_H */