Statistics
| Branch: | Revision:

ffmpeg / libavfilter / avfilter.h @ 63613fe6

History | View | Annotate | Download (24 KB)

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