3 * copyright (c) 2007 Bobby Bingham
5 * This file is part of FFmpeg.
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.
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.
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
22 #ifndef FFMPEG_AVFILTER_H
23 #define FFMPEG_AVFILTER_H
27 typedef struct AVFilterContext AVFilterContext;
28 typedef struct AVFilterLink AVFilterLink;
29 typedef struct AVFilterPad AVFilterPad;
31 /* TODO: look for other flags which may be useful in this structure (interlace
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
39 typedef struct AVFilterPic
42 int linesize[4]; ///< number of bytes per line
43 enum PixelFormat format;
47 void (*free)(struct AVFilterPic *pic);
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.
56 * TODO: add pts, and anything necessary for frame reordering
58 typedef struct AVFilterPicRef
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
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
77 AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref);
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.
84 void avfilter_unref_pic(AVFilterPicRef *ref);
89 * Pad name. The name is unique among inputs and among oututs, but an
90 * input may have the same name as an output.
95 * AVFilterPad type. Only video supported now, hopefully someone will
96 * add audio in the future.
99 #define AV_PAD_VIDEO 0
102 * Callback called before passing the first slice of a new frame. If
103 * NULL, the filter layer will default to storing a reference to the
104 * picture inside the link structure.
106 void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
109 * Callback function to get a buffer. If NULL, the filter system will
110 * handle buffer requests. Only required for input video pads.
112 AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms);
115 * Callback called after the slices of a frame are completely sent. If
116 * NULL, the filter layer will default to releasing the reference stored
117 * in the link structure during start_frame().
119 void (*end_frame)(AVFilterLink *link);
122 * Slice drawing callback. This is where a filter receives video data
123 * and should do its processing. Only required for input video pads.
125 void (*draw_slice)(AVFilterLink *link, uint8_t *data[4], int y, int height);
128 * Frame request callback. A call to this should result in at least one
129 * frame being output over the given link. Video output pads only.
131 void (*request_frame)(AVFilterLink *link);
134 * Callback to set properties of the link. Only for video output pads.
135 * XXX: this is not acceptable as is. it needs reworked to allow for
136 * negotiation of colorspace, etc.
138 int (*set_video_props)(AVFilterLink *link);
141 /* the default implementations of start_frame() and end_frame() */
142 void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
143 void avfilter_default_end_frame(AVFilterLink *link);
152 int (*init)(AVFilterContext *ctx);
153 void (*uninit)(AVFilterContext *ctx);
155 const AVFilterPad *inputs; /// NULL terminated list of inputs. NULL if none
156 const AVFilterPad *outputs; /// NULL terminated list of outputs. NULL if none
159 struct AVFilterContext
165 AVFilterLink **inputs;
166 AVFilterLink **outputs;
173 AVFilterContext *src;
176 AVFilterContext *dst;
180 enum PixelFormat format;
182 AVFilterPicRef *cur_pic;
185 /** Link two filters together */
186 int avfilter_link(AVFilterContext *src, unsigned srcpad,
187 AVFilterContext *dst, unsigned dstpad);
189 AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
190 void avfilter_request_frame(AVFilterLink *link);
191 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
192 void avfilter_end_frame(AVFilterLink *link);
193 void avfilter_draw_slice(AVFilterLink *link, uint8_t *data[4], int y, int h);
195 void avfilter_init(void);
196 void avfilter_uninit(void);
197 void avfilter_register(AVFilter *filter);
198 AVFilter *avfilter_get_by_name(char *name);
200 AVFilterContext *avfilter_create(AVFilter *filter);
201 AVFilterContext *avfilter_create_by_name(char *name);
202 int avfilter_init_filter(AVFilterContext *filter);
203 void avfilter_destroy(AVFilterContext *filter);
205 #endif /* FFMPEG_AVFILTER_H */