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