Make avfilter_ref_pic also handle removal of permissions for the caller.
[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  * @param pmask A bitmask containing the allowable permissions in the new reference
76  * @return A new reference to the picture with the same properties as the old
77  */
78 AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask);
79
80 /**
81  * Remove a reference to a picture.  If this is the last reference to the
82  * picture, the picture itself is also automatically freed.
83  * @param ref Reference to the picture.
84  */
85 void avfilter_unref_pic(AVFilterPicRef *ref);
86
87 struct AVFilterPad
88 {
89     /**
90      * Pad name.  The name is unique among inputs and among oututs, but an
91      * input may have the same name as an output.
92      */
93     char *name;
94
95     /**
96      * AVFilterPad type.  Only video supported now, hopefully someone will
97      * add audio in the future.
98      */
99     int type;
100 #define AV_PAD_VIDEO 0
101
102     /**
103      * Callback to get a list of supported formats.  The returned list should
104      * be terminated by -1.  This is used for both input and output pads and
105      * is required for both.
106      */
107     int *(*query_formats)(AVFilterLink *link);
108
109     /**
110      * Callback called before passing the first slice of a new frame.  If
111      * NULL, the filter layer will default to storing a reference to the
112      * picture inside the link structure.
113      */
114     void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
115
116     /**
117      * Callback function to get a buffer.  If NULL, the filter system will
118      * handle buffer requests.  Only required for input video pads.
119      */
120     AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms);
121
122     /**
123      * Callback called after the slices of a frame are completely sent.  If
124      * NULL, the filter layer will default to releasing the reference stored
125      * in the link structure during start_frame().
126      */
127     void (*end_frame)(AVFilterLink *link);
128
129     /**
130      * Slice drawing callback.  This is where a filter receives video data
131      * and should do its processing.  Only required for input video pads.
132      */
133     void (*draw_slice)(AVFilterLink *link, uint8_t *data[4], int y, int height);
134
135     /**
136      * Frame request callback.  A call to this should result in at least one
137      * frame being output over the given link.  Video output pads only.
138      */
139     void (*request_frame)(AVFilterLink *link);
140
141     /**
142      * Link configuration callback.  For output pads, this should set the link
143      * properties such as width/height.  NOTE: this should not set the format
144      * property - that is negotiated between filters by the filter system using
145      * the query_formats() callback.
146      *
147      * For input pads, this should check the properties of the link, and update
148      * the filter's internal state as necessary.
149      */
150     int (*config_props)(AVFilterLink *link);
151 };
152
153 /* the default implementations of start_frame() and end_frame() */
154 void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
155 void avfilter_default_end_frame(AVFilterLink *link);
156
157 typedef struct
158 {
159     char *name;
160     char *author;
161
162     int priv_size;
163
164     /**
165      * Filter initialization function.  Args contains the user-supplied
166      * parameters.  FIXME: maybe an AVOption-based system would be better?
167      */
168     int (*init)(AVFilterContext *ctx, const char *args);
169     void (*uninit)(AVFilterContext *ctx);
170
171     const AVFilterPad *inputs;  /// NULL terminated list of inputs. NULL if none
172     const AVFilterPad *outputs; /// NULL terminated list of outputs. NULL if none
173 } AVFilter;
174
175 struct AVFilterContext
176 {
177     AVClass *av_class;
178
179     AVFilter *filter;
180
181     AVFilterLink **inputs;
182     AVFilterLink **outputs;
183
184     void *priv;
185 };
186
187 struct AVFilterLink
188 {
189     AVFilterContext *src;
190     unsigned int srcpad;
191
192     AVFilterContext *dst;
193     unsigned int dstpad;
194
195     int w, h;
196     enum PixelFormat format;
197
198     AVFilterPicRef *cur_pic;
199 };
200
201 /** Link two filters together */
202 int avfilter_link(AVFilterContext *src, unsigned srcpad,
203                   AVFilterContext *dst, unsigned dstpad);
204
205 AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
206 void avfilter_request_frame(AVFilterLink *link);
207 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
208 void avfilter_end_frame(AVFilterLink *link);
209 void avfilter_draw_slice(AVFilterLink *link, uint8_t *data[4], int y, int h);
210
211 void avfilter_init(void);
212 void avfilter_uninit(void);
213 void avfilter_register(AVFilter *filter);
214 AVFilter *avfilter_get_by_name(char *name);
215
216 AVFilterContext *avfilter_create(AVFilter *filter);
217 AVFilterContext *avfilter_create_by_name(char *name);
218 int avfilter_init_filter(AVFilterContext *filter, const char *args);
219 void avfilter_destroy(AVFilterContext *filter);
220
221 int *avfilter_make_format_list(int len, ...);
222
223 #endif  /* FFMPEG_AVFILTER_H */