Statistics
| Branch: | Revision:

ffmpeg / libavfilter / avfilter.h @ 09b63a42

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