Rework filter initialization sequence. Now supports passing user parameters,
[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 "avcodec.h"
26
27 typedef struct AVFilterContext AVFilterContext;
28 typedef struct AVFilterLink    AVFilterLink;
29 typedef struct AVFilterPad     AVFilterPad;
30
31 /* TODO: look for other flags which may be useful in this structure (interlace
32  * flags, etc)
33  */
34 /**
35  * A reference-counted picture data type used by the filter system.  Filters
36  * should not store pointers to this structure directly, but instead use the
37  * AVFilterPicRef structure below
38  */
39 typedef struct AVFilterPic
40 {
41     uint8_t *data[4];
42     int linesize[4];    ///< number of bytes per line
43     enum PixelFormat format;
44
45     unsigned refcount;
46     void *priv;
47     void (*free)(struct AVFilterPic *pic);
48 } AVFilterPic;
49
50 /**
51  * A reference to an AVFilterPic.  Since filters can manipulate the origin of
52  * a picture to, for example, crop image without any memcpy, the picture origin
53  * and dimensions are per-reference properties.  Linesize is also useful for
54  * image flipping, frame to field filters, etc, and so is also per-reference.
55  *
56  * TODO: add pts, and anything necessary for frame reordering
57  */
58 typedef struct AVFilterPicRef
59 {
60     AVFilterPic *pic;
61     uint8_t *data[4];
62     int linesize[4];
63     int w, h;
64
65     int perms;                  ///< permissions
66 #define AV_PERM_READ     0x01   ///< can read from the buffer
67 #define AV_PERM_WRITE    0x02   ///< can write to the buffer
68 #define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
69 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times
70 } AVFilterPicRef;
71
72 /**
73  * Add a new reference to a picture.
74  * @param ref An existing reference to the picture
75  * @return A new reference to the picture with the same properties as the old
76  */
77 AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref);
78
79 /**
80  * Remove a reference to a picture.  If this is the last reference to the
81  * picture, the picture itself is also automatically freed.
82  * @param ref Reference to the picture.
83  */
84 void avfilter_unref_pic(AVFilterPicRef *ref);
85
86 struct AVFilterPad
87 {
88     /**
89      * Pad name.  The name is unique among inputs and among oututs, but an
90      * input may have the same name as an output.
91      */
92     char *name;
93
94     /**
95      * AVFilterPad type.  Only video supported now, hopefully someone will
96      * add audio in the future.
97      */
98     int type;
99 #define AV_PAD_VIDEO 0
100
101     /**
102      * Callback to get a list of supported formats.  The returned list should
103      * be terminated by -1.  This is used for both input and output pads and
104      * is required for both.
105      */
106     int *(*query_formats)(AVFilterLink *link);
107
108     /**
109      * Callback called before passing the first slice of a new frame.  If
110      * NULL, the filter layer will default to storing a reference to the
111      * picture inside the link structure.
112      */
113     void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
114
115     /**
116      * Callback function to get a buffer.  If NULL, the filter system will
117      * handle buffer requests.  Only required for input video pads.
118      */
119     AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms);
120
121     /**
122      * Callback called after the slices of a frame are completely sent.  If
123      * NULL, the filter layer will default to releasing the reference stored
124      * in the link structure during start_frame().
125      */
126     void (*end_frame)(AVFilterLink *link);
127
128     /**
129      * Slice drawing callback.  This is where a filter receives video data
130      * and should do its processing.  Only required for input video pads.
131      */
132     void (*draw_slice)(AVFilterLink *link, uint8_t *data[4], int y, int height);
133
134     /**
135      * Frame request callback.  A call to this should result in at least one
136      * frame being output over the given link.  Video output pads only.
137      */
138     void (*request_frame)(AVFilterLink *link);
139
140     /**
141      * Link configuration callback.  For output pads, this should set the link
142      * properties such as width/height.  NOTE: this should not set the format
143      * property - that is negotiated between filters by the filter system using
144      * the query_formats() callback.
145      *
146      * For input pads, this should check the properties of the link, and update
147      * the filter's internal state as necessary.
148      */
149     int (*config_props)(AVFilterLink *link);
150 };
151
152 /* the default implementations of start_frame() and end_frame() */
153 void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
154 void avfilter_default_end_frame(AVFilterLink *link);
155
156 typedef struct
157 {
158     char *name;
159     char *author;
160
161     int priv_size;
162
163     /**
164      * Filter initialization function.  Args contains the user-supplied
165      * parameters.  FIXME: maybe an AVOption-based system would be better?
166      */
167     int (*init)(AVFilterContext *ctx, const char *args);
168     void (*uninit)(AVFilterContext *ctx);
169
170     const AVFilterPad *inputs;  /// NULL terminated list of inputs. NULL if none
171     const AVFilterPad *outputs; /// NULL terminated list of outputs. NULL if none
172 } AVFilter;
173
174 struct AVFilterContext
175 {
176     AVClass *av_class;
177
178     AVFilter *filter;
179
180     AVFilterLink **inputs;
181     AVFilterLink **outputs;
182
183     void *priv;
184 };
185
186 struct AVFilterLink
187 {
188     AVFilterContext *src;
189     unsigned int srcpad;
190
191     AVFilterContext *dst;
192     unsigned int dstpad;
193
194     int w, h;
195     enum PixelFormat format;
196
197     AVFilterPicRef *cur_pic;
198 };
199
200 /** Link two filters together */
201 int avfilter_link(AVFilterContext *src, unsigned srcpad,
202                   AVFilterContext *dst, unsigned dstpad);
203
204 AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
205 void avfilter_request_frame(AVFilterLink *link);
206 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
207 void avfilter_end_frame(AVFilterLink *link);
208 void avfilter_draw_slice(AVFilterLink *link, uint8_t *data[4], int y, int h);
209
210 void avfilter_init(void);
211 void avfilter_uninit(void);
212 void avfilter_register(AVFilter *filter);
213 AVFilter *avfilter_get_by_name(char *name);
214
215 AVFilterContext *avfilter_create(AVFilter *filter);
216 AVFilterContext *avfilter_create_by_name(char *name);
217 int avfilter_init_filter(AVFilterContext *filter, const char *args);
218 void avfilter_destroy(AVFilterContext *filter);
219
220 int *avfilter_make_format_list(int len, ...);
221
222 #endif  /* FFMPEG_AVFILTER_H */