Update comment to match code
[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 FFMPEG_AVFILTER_H
23 #define FFMPEG_AVFILTER_H
24
25 #include <stddef.h>
26 #include "avcodec.h"
27
28 typedef struct AVFilterContext AVFilterContext;
29 typedef struct AVFilterLink    AVFilterLink;
30 typedef struct AVFilterPad     AVFilterPad;
31
32 /* TODO: look for other flags which may be useful in this structure (interlace
33  * flags, etc)
34  */
35 /**
36  * A reference-counted picture data type used by the filter system.  Filters
37  * should not store pointers to this structure directly, but instead use the
38  * AVFilterPicRef structure below.
39  */
40 typedef struct AVFilterPic
41 {
42     uint8_t *data[4];           ///< picture data for each plane
43     int linesize[4];            ///< number of bytes per line
44     enum PixelFormat format;    ///< colorspace
45
46     unsigned refcount;          ///< number of references to this image
47
48     /** private data to be used by a custom free function */
49     void *priv;
50     /**
51      * A pointer to the function to deallocate this image if the default
52      * function is not sufficient.  This could, for example, add the memory
53      * back into a memory pool to be reused later without the overhead of
54      * reallocating it from scratch.
55      */
56     void (*free)(struct AVFilterPic *pic);
57 } AVFilterPic;
58
59 /**
60  * A reference to an AVFilterPic.  Since filters can manipulate the origin of
61  * a picture to, for example, crop image without any memcpy, the picture origin
62  * and dimensions are per-reference properties.  Linesize is also useful for
63  * image flipping, frame to field filters, etc, and so is also per-reference.
64  *
65  * TODO: add anything necessary for frame reordering
66  */
67 typedef struct AVFilterPicRef
68 {
69     AVFilterPic *pic;           ///< the picture that this is a reference to
70     uint8_t *data[4];           ///< picture data for each plane
71     int linesize[4];            ///< number of bytes per line
72     int w;                      ///< image width
73     int h;                      ///< image height
74
75     int64_t pts;                ///< presentation timestamp in units of 1/AV_TIME_BASE
76
77     AVRational pixel_aspect;    ///< pixel aspect ratio
78
79     int perms;                  ///< permissions
80 #define AV_PERM_READ     0x01   ///< can read from the buffer
81 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
82 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
83 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
84 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
85 } AVFilterPicRef;
86
87 /**
88  * Add a new reference to a picture.
89  * @param ref   an existing reference to the picture
90  * @param pmask a bitmask containing the allowable permissions in the new
91  *              reference
92  * @return      a new reference to the picture with the same properties as the
93  *              old, excluding any permissions denied by pmask
94  */
95 AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask);
96
97 /**
98  * Remove a reference to a picture.  If this is the last reference to the
99  * picture, the picture itself is also automatically freed.
100  * @param ref reference to the picture
101  */
102 void avfilter_unref_pic(AVFilterPicRef *ref);
103
104 /**
105  * A list of supported formats for one end of a filter link. This is used
106  * during the format negotiation process to try to pick the best format to
107  * use to minimize the number of necessary conversions. Each filter gives a
108  * list of the formats supported by each input and output pad. The list
109  * given for each pad need not be distinct - they may be references to the
110  * same list of formats, as is often the case when a filter supports multiple
111  * formats, but will always outut the same format as it is given in input.
112  *
113  * In this way, a list of possible input formats and a list of possible
114  * output formats are associated with each link. When a set of formats is
115  * negotiated over a link, the input and output lists are merged to form a
116  * new list containing only the common elements of each list. In the case
117  * that there were no common elements, a format conversion is necessary.
118  * Otherwise, the lists are merged, and all other links which reference
119  * either of the format lists involved in the merge are also affected.
120  *
121  * For example, consider the filter chain:
122  * filter (a) --> (b) filter (b) --> (c) filter
123  *
124  * where the letters in parenthesis indicate a list of formats supported on
125  * the input or output of the link. Suppose the lists are as follows:
126  * (a) = {A, B}
127  * (b) = {A, B, C}
128  * (c) = {B, C}
129  *
130  * First, the first link's lists are merged, yielding:
131  * filter (a) --> (a) filter (a) --> (c) filter
132  *
133  * Notice that format list (b) now refers to the same list as filter list (a).
134  * Next, the lists for the second link are merged, yielding:
135  * filter (a) --> (a) filter (a) --> (a) filter
136  *
137  * where (a) = {B}.
138  *
139  * Unfortunately, when the format lists at the two ends of a link are merged,
140  * we must ensure that all links which reference either pre-merge format list
141  * get updated as well. Therefore, we have the format list structure store a
142  * pointer to each of the pointers to itself.
143  */
144 typedef struct AVFilterFormats AVFilterFormats;
145 struct AVFilterFormats
146 {
147     unsigned format_count;      ///< number of formats
148     int *formats;               ///< list of formats
149
150     unsigned refcount;          ///< number of references to this list
151     AVFilterFormats ***refs;    ///< references to this list
152 };
153
154 /**
155  * Helper function to create a list of supported formats.  This is intended
156  * for use in AVFilter->query_formats().
157  * @param len the number of formats supported
158  * @param ... a list of the supported formats
159  * @return    the format list, with no existing references
160  */
161 AVFilterFormats *avfilter_make_format_list(int len, ...);
162
163 /**
164  * Returns a list of all colorspaces supported by FFmpeg.
165  */
166 AVFilterFormats *avfilter_all_colorspaces(void);
167
168 /**
169  * If a and b share at least one common format, they are merged into a new
170  * format list which is returned.  All the references to a and b are updated
171  * to point to this new list, and a and b are deallocated.
172  *
173  * If a and b do not share any common formats, neither is modified, and NULL
174  * is returned.
175  */
176 AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
177
178 /** Adds *ref as a new reference to f */
179 void avfilter_formats_ref(AVFilterFormats *f, AVFilterFormats **ref);
180
181 /**
182  * Remove *ref as a reference to the format list it currently points to,
183  * deallocate that list if this was the last reference, and set *ref to NULL.
184  */
185 void avfilter_formats_unref(AVFilterFormats **ref);
186
187 int avfilter_poll_frame(AVFilterLink *link);
188
189 /**
190  * A filter pad used for either input or output.
191  */
192 struct AVFilterPad
193 {
194     /**
195      * Pad name.  The name is unique among inputs and among outputs, but an
196      * input may have the same name as an output.  This may be NULL if this
197      * pad has no need to ever be referenced by name.
198      */
199     const char *name;
200
201     /**
202      * AVFilterPad type.  Only video supported now, hopefully someone will
203      * add audio in the future.
204      */
205     int type;
206 #define AV_PAD_VIDEO 0      ///< video pad
207
208     /**
209      * Minimum required permissions on incoming buffers.  Any buffers with
210      * insufficient permissions will be automatically copied by the filter
211      * system to a new buffer which provides the needed access permissions.
212      *
213      * Input pads only.
214      */
215     int min_perms;
216
217     /**
218      * Permissions which are not accepted on incoming buffers.  Any buffer
219      * which has any of these permissions set be automatically copied by the
220      * filter system to a new buffer which does not have those permissions.
221      * This can be used to easily disallow buffers with AV_PERM_REUSE.
222      *
223      * Input pads only.
224      */
225     int rej_perms;
226
227     /**
228      * Callback called before passing the first slice of a new frame.  If
229      * NULL, the filter layer will default to storing a reference to the
230      * picture inside the link structure.
231      *
232      * Input video pads only.
233      */
234     void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
235
236     /**
237      * Callback function to get a buffer.  If NULL, the filter system will
238      * handle buffer requests.
239      *
240      * Input video pads only.
241      */
242     AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms);
243
244     /**
245      * Callback called after the slices of a frame are completely sent.  If
246      * NULL, the filter layer will default to releasing the reference stored
247      * in the link structure during start_frame().
248      *
249      * Input video pads only.
250      */
251     void (*end_frame)(AVFilterLink *link);
252
253     /**
254      * Slice drawing callback.  This is where a filter receives video data
255      * and should do its processing.
256      *
257      * Input video pads only.
258      */
259     void (*draw_slice)(AVFilterLink *link, int y, int height);
260
261     /**
262      * Frame poll callback.  This returns the number of immediately available
263      * frames. It should return a positive value if the next request_frame()
264      * is guaranteed to return one frame (with no delay).
265      *
266      * Defaults to just calling the source poll_frame() method.
267      *
268      * Output video pads only.
269      */
270     int (*poll_frame)(AVFilterLink *link);
271
272     /**
273      * Frame request callback.  A call to this should result in at least one
274      * frame being output over the given link.  This should return zero on
275      * success, and another value on error.
276      *
277      * Output video pads only.
278      */
279     int (*request_frame)(AVFilterLink *link);
280
281     /**
282      * Link configuration callback.
283      *
284      * For output pads, this should set the link properties such as
285      * width/height.  This should NOT set the format property - that is
286      * negotiated between filters by the filter system using the
287      * query_formats() callback before this function is called.
288      *
289      * For input pads, this should check the properties of the link, and update
290      * the filter's internal state as necessary.
291      *
292      * For both input and output filters, this should return zero on success,
293      * and another value on error.
294      */
295     int (*config_props)(AVFilterLink *link);
296 };
297
298 /** Default handler for start_frame() for video inputs */
299 void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
300 /** Default handler for end_frame() for video inputs */
301 void avfilter_default_end_frame(AVFilterLink *link);
302 /** Default handler for config_props() for video outputs */
303 int avfilter_default_config_output_link(AVFilterLink *link);
304 /** Default handler for config_props() for video inputs */
305 int avfilter_default_config_input_link (AVFilterLink *link);
306 /** Default handler for get_video_buffer() for video inputs */
307 AVFilterPicRef *avfilter_default_get_video_buffer(AVFilterLink *link,
308                                                   int perms);
309 /**
310  * A helper for query_formats() which sets all links to the same list of
311  * formats. If there are no links hooked to this filter, the list of formats is
312  * freed.
313  */
314 void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
315 /** Default handler for query_formats() */
316 int avfilter_default_query_formats(AVFilterContext *ctx);
317
318 void avfilter_formats_changeref(AVFilterFormats **oldref,
319                                 AVFilterFormats **newref);
320
321 /**
322  * Filter definition.  This defines the pads a filter contains, and all the
323  * callback functions used to interact with the filter.
324  */
325 typedef struct
326 {
327     const char *name;         ///< filter name
328     const char *author;       ///< filter author
329
330     int priv_size;      ///< size of private data to allocate for the filter
331
332     /**
333      * Filter initialization function.  Args contains the user-supplied
334      * parameters.  FIXME: maybe an AVOption-based system would be better?
335      * opaque is data provided by the code requesting creation of the filter,
336      * and is used to pass data to the filter.
337      */
338     int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
339
340     /**
341      * Filter uninitialization function.  Should deallocate any memory held
342      * by the filter, release any picture references, etc.  This does not need
343      * to deallocate the AVFilterContext->priv memory itself.
344      */
345     void (*uninit)(AVFilterContext *ctx);
346
347     /**
348      * Query formats supported by the filter and its pads. Should set the
349      * in_formats for links connected to its output pads, and out_formats
350      * for links connected to its input pads.
351      *
352      * Should return zero on success.
353      */
354     int (*query_formats)(AVFilterContext *);
355
356     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
357     const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
358 } AVFilter;
359
360 /** An instance of a filter */
361 struct AVFilterContext
362 {
363     AVClass *av_class;              ///< needed for av_log()
364
365     AVFilter *filter;               ///< the AVFilter of which this is an instance
366
367     char *name;                     ///< name of this filter instance
368
369     unsigned input_count;           ///< number of input pads
370     AVFilterPad   *input_pads;      ///< array of input pads
371     AVFilterLink **inputs;          ///< array of pointers to input links
372
373     unsigned output_count;          ///< number of output pads
374     AVFilterPad   *output_pads;     ///< array of output pads
375     AVFilterLink **outputs;         ///< array of pointers to output links
376
377     void *priv;                     ///< private data for use by the filter
378 };
379
380 /**
381  * A link between two filters.  This contains pointers to the source and
382  * destination filters between which this link exists, and the indices of
383  * the pads involved.  In addition, this link also contains the parameters
384  * which have been negotiated and agreed upon between the filter, such as
385  * image dimensions, format, etc
386  */
387 struct AVFilterLink
388 {
389     AVFilterContext *src;       ///< source filter
390     unsigned int srcpad;        ///< index of the output pad on the source filter
391
392     AVFilterContext *dst;       ///< dest filter
393     unsigned int dstpad;        ///< index of the input pad on the dest filter
394
395     /** stage of the initialization of the link properties (dimensions, etc) */
396     enum {
397         AVLINK_UNINIT = 0,      ///< not started
398         AVLINK_STARTINIT,       ///< started, but incomplete
399         AVLINK_INIT             ///< complete
400     } init_state;
401
402     int w;                      ///< agreed upon image width
403     int h;                      ///< agreed upon image height
404     enum PixelFormat format;    ///< agreed upon image colorspace
405
406     /**
407      * Lists of formats supported by the input and output filters respectively.
408      * These lists are used for negotiating the format to actually be used,
409      * which will be loaded into the format member, above, when chosen.
410      */
411     AVFilterFormats *in_formats;
412     AVFilterFormats *out_formats;
413
414     /**
415      * The picture reference currently being sent across the link by the source
416      * filter.  This is used internally by the filter system to allow
417      * automatic copying of pictures which do not have sufficient permissions
418      * for the destination.  This should not be accessed directly by the
419      * filters.
420      */
421     AVFilterPicRef *srcpic;
422
423     AVFilterPicRef *cur_pic;
424     AVFilterPicRef *outpic;
425 };
426
427 /**
428  * Link two filters together.
429  * @param src    the source filter
430  * @param srcpad index of the output pad on the source filter
431  * @param dst    the destination filter
432  * @param dstpad index of the input pad on the destination filter
433  * @return       zero on success
434  */
435 int avfilter_link(AVFilterContext *src, unsigned srcpad,
436                   AVFilterContext *dst, unsigned dstpad);
437
438 /**
439  * Negotiate the colorspace, dimensions, etc of all inputs to a filter.
440  * @param filter the filter to negotiate the properties for its inputs
441  * @return       zero on successful negotiation
442  */
443 int avfilter_config_links(AVFilterContext *filter);
444
445 /**
446  * Request a picture buffer with a specific set of permissions
447  * @param link  the output link to the filter from which the picture will
448  *              be requested
449  * @param perms the required access permissions
450  * @return      A reference to the picture.  This must be unreferenced with
451  *              avfilter_unref_pic when you are finished with it.
452  */
453 AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
454
455 /**
456  * Request an input frame from the filter at the other end of the link.
457  * @param link the input link
458  * @return     zero on success
459  */
460 int  avfilter_request_frame(AVFilterLink *link);
461
462 /**
463  * Notify the next filter of the start of a frame.
464  * @param link   the output link the frame will be sent over
465  * @param picref A reference to the frame about to be sent.  The data for this
466  *               frame need only be valid once draw_slice() is called for that
467  *               portion.  The receiving filter will free this reference when
468  *               it no longer needs it.
469  */
470 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
471
472 /**
473  * Notify the next filter that the current frame has finished
474  * @param link the output link the frame was sent over
475  */
476 void avfilter_end_frame(AVFilterLink *link);
477
478 /**
479  * Send a slice to the next filter.
480  * @param link the output link over which the frame is being sent
481  * @param y    offset in pixels from the top of the image for this slice
482  * @param h    height of this slice in pixels
483  */
484 void avfilter_draw_slice(AVFilterLink *link, int y, int h);
485
486 /** Initialize the filter system.  Registers all builtin filters */
487 void avfilter_init(void);
488
489 /** Uninitialize the filter system.  Unregisters all filters */
490 void avfilter_uninit(void);
491
492 /**
493  * Register a filter.  This is only needed if you plan to use
494  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
495  * filter can still by instantiated with avfilter_open even if it is not
496  * registered.
497  * @param filter the filter to register
498  */
499 void avfilter_register(AVFilter *filter);
500
501 /**
502  * Gets a filter definition matching the given name.
503  * @param name the filter name to find
504  * @return     the filter definition, if any matching one is registered.
505  *             NULL if none found.
506  */
507 AVFilter *avfilter_get_by_name(const char *name);
508
509 /**
510  * Create a filter instance.
511  * @param filter    the filter to create an instance of
512  * @param inst_name Name to give to the new instance.  Can be NULL for none.
513  * @return          Pointer to the new instance on success.  NULL on failure.
514  */
515 AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
516
517 /**
518  * Initialize a filter.
519  * @param filter the filter to initialize
520  * @param args   A string of parameters to use when initializing the filter.
521  *               The format and meaning of this string varies by filter.
522  * @param opaque Any extra non-string data needed by the filter.  The meaning
523  *               of this parameter varies by filter.
524  * @return       zero on success
525  */
526 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
527
528 /**
529  * Destroy a filter.
530  * @param filter the filter to destroy
531  */
532 void avfilter_destroy(AVFilterContext *filter);
533
534 /**
535  * Insert a filter in the middle of an existing link.
536  * @param link the link into which the filter should be inserted
537  * @param filt the filter to be inserted
538  * @param in   the input pad on the filter to connect
539  * @param out  the output pad on the filter to connect
540  * @return     zero on success
541  */
542 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
543                            unsigned in, unsigned out);
544
545 /**
546  * Insert a new pad.
547  * @param idx Insertion point.  Pad is inserted at the end if this point
548  *            is beyond the end of the list of pads.
549  * @param count Pointer to the number of pads in the list
550  * @param padidx_off Offset within an AVFilterLink structure to the element
551  *                   to increment when inserting a new pad causes link
552  *                   numbering to change
553  * @param pads Pointer to the pointer to the beginning of the list of pads
554  * @param links Pointer to the pointer to the beginning of the list of links
555  * @param newpad The new pad to add. A copy is made when adding.
556  */
557 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
558                          AVFilterPad **pads, AVFilterLink ***links,
559                          AVFilterPad *newpad);
560
561 /** insert a new input pad for the filter */
562 static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
563                                          AVFilterPad *p)
564 {
565     avfilter_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
566                         &f->input_pads, &f->inputs, p);
567 }
568
569 /** insert a new output pad for the filter */
570 static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
571                                           AVFilterPad *p)
572 {
573     avfilter_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
574                         &f->output_pads, &f->outputs, p);
575 }
576
577 #endif  /* FFMPEG_AVFILTER_H */