Statistics
| Branch: | Revision:

ffmpeg / libavfilter / avfilter.h @ 81c1ecab

History | View | Annotate | Download (27.6 KB)

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 AVFILTER_AVFILTER_H
23
#define AVFILTER_AVFILTER_H
24

    
25
#include "libavutil/avutil.h"
26

    
27
#define LIBAVFILTER_VERSION_MAJOR  1
28
#define LIBAVFILTER_VERSION_MINOR 34
29
#define LIBAVFILTER_VERSION_MICRO  1
30

    
31
#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
32
                                               LIBAVFILTER_VERSION_MINOR, \
33
                                               LIBAVFILTER_VERSION_MICRO)
34
#define LIBAVFILTER_VERSION     AV_VERSION(LIBAVFILTER_VERSION_MAJOR,   \
35
                                           LIBAVFILTER_VERSION_MINOR,   \
36
                                           LIBAVFILTER_VERSION_MICRO)
37
#define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
38

    
39
#include <stddef.h>
40
#include "libavcodec/avcodec.h"
41

    
42
/**
43
 * Return the LIBAVFILTER_VERSION_INT constant.
44
 */
45
unsigned avfilter_version(void);
46

    
47
/**
48
 * Return the libavfilter build-time configuration.
49
 */
50
const char *avfilter_configuration(void);
51

    
52
/**
53
 * Return the libavfilter license.
54
 */
55
const char *avfilter_license(void);
56

    
57

    
58
typedef struct AVFilterContext AVFilterContext;
59
typedef struct AVFilterLink    AVFilterLink;
60
typedef struct AVFilterPad     AVFilterPad;
61

    
62
/**
63
 * A reference-counted buffer data type used by the filter system. Filters
64
 * should not store pointers to this structure directly, but instead use the
65
 * AVFilterBufferRef structure below.
66
 */
67
typedef struct AVFilterBuffer
68
{
69
    uint8_t *data[8];           ///< buffer data for each plane/channel
70
    int linesize[8];            ///< number of bytes per line
71

    
72
    unsigned refcount;          ///< number of references to this buffer
73

    
74
    /** private data to be used by a custom free function */
75
    void *priv;
76
    /**
77
     * A pointer to the function to deallocate this buffer if the default
78
     * function is not sufficient. This could, for example, add the memory
79
     * back into a memory pool to be reused later without the overhead of
80
     * reallocating it from scratch.
81
     */
82
    void (*free)(struct AVFilterBuffer *buf);
83
} AVFilterBuffer;
84

    
85
#define AV_PERM_READ     0x01   ///< can read from the buffer
86
#define AV_PERM_WRITE    0x02   ///< can write to the buffer
87
#define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
88
#define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
89
#define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
90

    
91
/**
92
 * Video specific properties in a reference to an AVFilterBuffer. Since
93
 * AVFilterBufferRef is common to different media formats, video specific
94
 * per reference properties must be separated out.
95
 */
96
typedef struct AVFilterBufferRefVideoProps
97
{
98
    int w;                      ///< image width
99
    int h;                      ///< image height
100
    AVRational pixel_aspect;    ///< pixel aspect ratio
101
    int interlaced;             ///< is frame interlaced
102
    int top_field_first;        ///< field order
103
} AVFilterBufferRefVideoProps;
104

    
105
/**
106
 * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
107
 * a buffer to, for example, crop image without any memcpy, the buffer origin
108
 * and dimensions are per-reference properties. Linesize is also useful for
109
 * image flipping, frame to field filters, etc, and so is also per-reference.
110
 *
111
 * TODO: add anything necessary for frame reordering
112
 */
113
typedef struct AVFilterBufferRef
114
{
115
    AVFilterBuffer *buf;        ///< the buffer that this is a reference to
116
    uint8_t *data[8];           ///< picture data for each plane
117
    int linesize[8];            ///< number of bytes per line
118
    int format;                 ///< media format
119

    
120
    int64_t pts;                ///< presentation timestamp in units of 1/AV_TIME_BASE
121
    int64_t pos;                ///< byte position in stream, -1 if unknown
122

    
123
    int perms;                  ///< permissions, see the AV_PERM_* flags
124

    
125
    enum AVMediaType type;      ///< media type of buffer data
126
    AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
127
} AVFilterBufferRef;
128

    
129
/**
130
 * Copy properties of src to dst, without copying the actual video
131
 * data.
132
 */
133
static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src)
134
{
135
    // copy common properties
136
    dst->pts             = src->pts;
137
    dst->pos             = src->pos;
138

    
139
    switch (src->type) {
140
    case AVMEDIA_TYPE_VIDEO: *dst->video = *src->video; break;
141
    }
142
}
143

    
144
/**
145
 * Add a new reference to a buffer.
146
 * @param ref   an existing reference to the buffer
147
 * @param pmask a bitmask containing the allowable permissions in the new
148
 *              reference
149
 * @return      a new reference to the buffer with the same properties as the
150
 *              old, excluding any permissions denied by pmask
151
 */
152
AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
153

    
154
/**
155
 * Remove a reference to a buffer. If this is the last reference to the
156
 * buffer, the buffer itself is also automatically freed.
157
 * @param ref reference to the buffer
158
 */
159
void avfilter_unref_buffer(AVFilterBufferRef *ref);
160

    
161
/**
162
 * A list of supported formats for one end of a filter link. This is used
163
 * during the format negotiation process to try to pick the best format to
164
 * use to minimize the number of necessary conversions. Each filter gives a
165
 * list of the formats supported by each input and output pad. The list
166
 * given for each pad need not be distinct - they may be references to the
167
 * same list of formats, as is often the case when a filter supports multiple
168
 * formats, but will always output the same format as it is given in input.
169
 *
170
 * In this way, a list of possible input formats and a list of possible
171
 * output formats are associated with each link. When a set of formats is
172
 * negotiated over a link, the input and output lists are merged to form a
173
 * new list containing only the common elements of each list. In the case
174
 * that there were no common elements, a format conversion is necessary.
175
 * Otherwise, the lists are merged, and all other links which reference
176
 * either of the format lists involved in the merge are also affected.
177
 *
178
 * For example, consider the filter chain:
179
 * filter (a) --> (b) filter (b) --> (c) filter
180
 *
181
 * where the letters in parenthesis indicate a list of formats supported on
182
 * the input or output of the link. Suppose the lists are as follows:
183
 * (a) = {A, B}
184
 * (b) = {A, B, C}
185
 * (c) = {B, C}
186
 *
187
 * First, the first link's lists are merged, yielding:
188
 * filter (a) --> (a) filter (a) --> (c) filter
189
 *
190
 * Notice that format list (b) now refers to the same list as filter list (a).
191
 * Next, the lists for the second link are merged, yielding:
192
 * filter (a) --> (a) filter (a) --> (a) filter
193
 *
194
 * where (a) = {B}.
195
 *
196
 * Unfortunately, when the format lists at the two ends of a link are merged,
197
 * we must ensure that all links which reference either pre-merge format list
198
 * get updated as well. Therefore, we have the format list structure store a
199
 * pointer to each of the pointers to itself.
200
 */
201
typedef struct AVFilterFormats AVFilterFormats;
202
struct AVFilterFormats
203
{
204
    unsigned format_count;      ///< number of formats
205
    int *formats;               ///< list of media formats
206

    
207
    unsigned refcount;          ///< number of references to this list
208
    AVFilterFormats ***refs;    ///< references to this list
209
};
210

    
211
/**
212
 * Create a list of supported formats. This is intended for use in
213
 * AVFilter->query_formats().
214
 * @param fmts list of media formats, terminated by -1
215
 * @return the format list, with no existing references
216
 */
217
AVFilterFormats *avfilter_make_format_list(const int *fmts);
218

    
219
/**
220
 * Add fmt to the list of media formats contained in *avff.
221
 * If *avff is NULL the function allocates the filter formats struct
222
 * and puts its pointer in *avff.
223
 *
224
 * @return a non negative value in case of success, or a negative
225
 * value corresponding to an AVERROR code in case of error
226
 */
227
int avfilter_add_format(AVFilterFormats **avff, int fmt);
228

    
229
/**
230
 * Return a list of all formats supported by FFmpeg for the given media type.
231
 */
232
AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
233

    
234
/**
235
 * Return a format list which contains the intersection of the formats of
236
 * a and b. Also, all the references of a, all the references of b, and
237
 * a and b themselves will be deallocated.
238
 *
239
 * If a and b do not share any common formats, neither is modified, and NULL
240
 * is returned.
241
 */
242
AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
243

    
244
/**
245
 * Add *ref as a new reference to formats.
246
 * That is the pointers will point like in the ascii art below:
247
 *   ________
248
 *  |formats |<--------.
249
 *  |  ____  |     ____|___________________
250
 *  | |refs| |    |  __|_
251
 *  | |* * | |    | |  | |  AVFilterLink
252
 *  | |* *--------->|*ref|
253
 *  | |____| |    | |____|
254
 *  |________|    |________________________
255
 */
256
void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
257

    
258
/**
259
 * If *ref is non-NULL, remove *ref as a reference to the format list
260
 * it currently points to, deallocates that list if this was the last
261
 * reference, and sets *ref to NULL.
262
 *
263
 *         Before                                 After
264
 *   ________                               ________         NULL
265
 *  |formats |<--------.                   |formats |         ^
266
 *  |  ____  |     ____|________________   |  ____  |     ____|________________
267
 *  | |refs| |    |  __|_                  | |refs| |    |  __|_
268
 *  | |* * | |    | |  | |  AVFilterLink   | |* * | |    | |  | |  AVFilterLink
269
 *  | |* *--------->|*ref|                 | |*   | |    | |*ref|
270
 *  | |____| |    | |____|                 | |____| |    | |____|
271
 *  |________|    |_____________________   |________|    |_____________________
272
 */
273
void avfilter_formats_unref(AVFilterFormats **ref);
274

    
275
/**
276
 *
277
 *         Before                                 After
278
 *   ________                         ________
279
 *  |formats |<---------.            |formats |<---------.
280
 *  |  ____  |       ___|___         |  ____  |       ___|___
281
 *  | |refs| |      |   |   |        | |refs| |      |   |   |   NULL
282
 *  | |* *--------->|*oldref|        | |* *--------->|*newref|     ^
283
 *  | |* * | |      |_______|        | |* * | |      |_______|  ___|___
284
 *  | |____| |                       | |____| |                |   |   |
285
 *  |________|                       |________|                |*oldref|
286
 *                                                             |_______|
287
 */
288
void avfilter_formats_changeref(AVFilterFormats **oldref,
289
                                AVFilterFormats **newref);
290

    
291
/**
292
 * A filter pad used for either input or output.
293
 */
294
struct AVFilterPad
295
{
296
    /**
297
     * Pad name. The name is unique among inputs and among outputs, but an
298
     * input may have the same name as an output. This may be NULL if this
299
     * pad has no need to ever be referenced by name.
300
     */
301
    const char *name;
302

    
303
    /**
304
     * AVFilterPad type. Only video supported now, hopefully someone will
305
     * add audio in the future.
306
     */
307
    enum AVMediaType type;
308

    
309
    /**
310
     * Minimum required permissions on incoming buffers. Any buffer with
311
     * insufficient permissions will be automatically copied by the filter
312
     * system to a new buffer which provides the needed access permissions.
313
     *
314
     * Input pads only.
315
     */
316
    int min_perms;
317

    
318
    /**
319
     * Permissions which are not accepted on incoming buffers. Any buffer
320
     * which has any of these permissions set will be automatically copied
321
     * by the filter system to a new buffer which does not have those
322
     * permissions. This can be used to easily disallow buffers with
323
     * AV_PERM_REUSE.
324
     *
325
     * Input pads only.
326
     */
327
    int rej_perms;
328

    
329
    /**
330
     * Callback called before passing the first slice of a new frame. If
331
     * NULL, the filter layer will default to storing a reference to the
332
     * picture inside the link structure.
333
     *
334
     * Input video pads only.
335
     */
336
    void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
337

    
338
    /**
339
     * Callback function to get a buffer. If NULL, the filter system will
340
     * use avfilter_default_get_video_buffer().
341
     *
342
     * Input video pads only.
343
     */
344
    AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
345

    
346
    /**
347
     * Callback called after the slices of a frame are completely sent. If
348
     * NULL, the filter layer will default to releasing the reference stored
349
     * in the link structure during start_frame().
350
     *
351
     * Input video pads only.
352
     */
353
    void (*end_frame)(AVFilterLink *link);
354

    
355
    /**
356
     * Slice drawing callback. This is where a filter receives video data
357
     * and should do its processing.
358
     *
359
     * Input video pads only.
360
     */
361
    void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
362

    
363
    /**
364
     * Frame poll callback. This returns the number of immediately available
365
     * frames. It should return a positive value if the next request_frame()
366
     * is guaranteed to return one frame (with no delay).
367
     *
368
     * Defaults to just calling the source poll_frame() method.
369
     *
370
     * Output video pads only.
371
     */
372
    int (*poll_frame)(AVFilterLink *link);
373

    
374
    /**
375
     * Frame request callback. A call to this should result in at least one
376
     * frame being output over the given link. This should return zero on
377
     * success, and another value on error.
378
     *
379
     * Output video pads only.
380
     */
381
    int (*request_frame)(AVFilterLink *link);
382

    
383
    /**
384
     * Link configuration callback.
385
     *
386
     * For output pads, this should set the link properties such as
387
     * width/height. This should NOT set the format property - that is
388
     * negotiated between filters by the filter system using the
389
     * query_formats() callback before this function is called.
390
     *
391
     * For input pads, this should check the properties of the link, and update
392
     * the filter's internal state as necessary.
393
     *
394
     * For both input and output filters, this should return zero on success,
395
     * and another value on error.
396
     */
397
    int (*config_props)(AVFilterLink *link);
398
};
399

    
400
/** default handler for start_frame() for video inputs */
401
void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
402

    
403
/** default handler for draw_slice() for video inputs */
404
void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
405

    
406
/** default handler for end_frame() for video inputs */
407
void avfilter_default_end_frame(AVFilterLink *link);
408

    
409
/** default handler for config_props() for video outputs */
410
int avfilter_default_config_output_link(AVFilterLink *link);
411

    
412
/** default handler for config_props() for video inputs */
413
int avfilter_default_config_input_link (AVFilterLink *link);
414

    
415
/** default handler for get_video_buffer() for video inputs */
416
AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
417
                                                     int perms, int w, int h);
418
/**
419
 * A helper for query_formats() which sets all links to the same list of
420
 * formats. If there are no links hooked to this filter, the list of formats is
421
 * freed.
422
 */
423
void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
424

    
425
/** Default handler for query_formats() */
426
int avfilter_default_query_formats(AVFilterContext *ctx);
427

    
428
/** start_frame() handler for filters which simply pass video along */
429
void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
430

    
431
/** draw_slice() handler for filters which simply pass video along */
432
void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
433

    
434
/** end_frame() handler for filters which simply pass video along */
435
void avfilter_null_end_frame(AVFilterLink *link);
436

    
437
/** get_video_buffer() handler for filters which simply pass video along */
438
AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
439
                                                  int perms, int w, int h);
440

    
441
/**
442
 * Filter definition. This defines the pads a filter contains, and all the
443
 * callback functions used to interact with the filter.
444
 */
445
typedef struct AVFilter
446
{
447
    const char *name;         ///< filter name
448

    
449
    int priv_size;      ///< size of private data to allocate for the filter
450

    
451
    /**
452
     * Filter initialization function. Args contains the user-supplied
453
     * parameters. FIXME: maybe an AVOption-based system would be better?
454
     * opaque is data provided by the code requesting creation of the filter,
455
     * and is used to pass data to the filter.
456
     */
457
    int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
458

    
459
    /**
460
     * Filter uninitialization function. Should deallocate any memory held
461
     * by the filter, release any buffer references, etc. This does not need
462
     * to deallocate the AVFilterContext->priv memory itself.
463
     */
464
    void (*uninit)(AVFilterContext *ctx);
465

    
466
    /**
467
     * Queries formats supported by the filter and its pads, and sets the
468
     * in_formats for links connected to its output pads, and out_formats
469
     * for links connected to its input pads.
470
     *
471
     * @return zero on success, a negative value corresponding to an
472
     * AVERROR code otherwise
473
     */
474
    int (*query_formats)(AVFilterContext *);
475

    
476
    const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
477
    const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
478

    
479
    /**
480
     * A description for the filter. You should use the
481
     * NULL_IF_CONFIG_SMALL() macro to define it.
482
     */
483
    const char *description;
484
} AVFilter;
485

    
486
/** An instance of a filter */
487
struct AVFilterContext
488
{
489
    const AVClass *av_class;              ///< needed for av_log()
490

    
491
    AVFilter *filter;               ///< the AVFilter of which this is an instance
492

    
493
    char *name;                     ///< name of this filter instance
494

    
495
    unsigned input_count;           ///< number of input pads
496
    AVFilterPad   *input_pads;      ///< array of input pads
497
    AVFilterLink **inputs;          ///< array of pointers to input links
498

    
499
    unsigned output_count;          ///< number of output pads
500
    AVFilterPad   *output_pads;     ///< array of output pads
501
    AVFilterLink **outputs;         ///< array of pointers to output links
502

    
503
    void *priv;                     ///< private data for use by the filter
504
};
505

    
506
/**
507
 * A link between two filters. This contains pointers to the source and
508
 * destination filters between which this link exists, and the indexes of
509
 * the pads involved. In addition, this link also contains the parameters
510
 * which have been negotiated and agreed upon between the filter, such as
511
 * image dimensions, format, etc.
512
 */
513
struct AVFilterLink
514
{
515
    AVFilterContext *src;       ///< source filter
516
    unsigned int srcpad;        ///< index of the output pad on the source filter
517

    
518
    AVFilterContext *dst;       ///< dest filter
519
    unsigned int dstpad;        ///< index of the input pad on the dest filter
520

    
521
    /** stage of the initialization of the link properties (dimensions, etc) */
522
    enum {
523
        AVLINK_UNINIT = 0,      ///< not started
524
        AVLINK_STARTINIT,       ///< started, but incomplete
525
        AVLINK_INIT             ///< complete
526
    } init_state;
527

    
528
    enum AVMediaType type;      ///< filter media type
529

    
530
    int w;                      ///< agreed upon image width
531
    int h;                      ///< agreed upon image height
532
    int format;                 ///< agreed upon media format
533

    
534
    /**
535
     * Lists of formats supported by the input and output filters respectively.
536
     * These lists are used for negotiating the format to actually be used,
537
     * which will be loaded into the format member, above, when chosen.
538
     */
539
    AVFilterFormats *in_formats;
540
    AVFilterFormats *out_formats;
541

    
542
    /**
543
     * The buffer reference currently being sent across the link by the source
544
     * filter. This is used internally by the filter system to allow
545
     * automatic copying of buffers which do not have sufficient permissions
546
     * for the destination. This should not be accessed directly by the
547
     * filters.
548
     */
549
    AVFilterBufferRef *src_buf;
550

    
551
    AVFilterBufferRef *cur_buf;
552
    AVFilterBufferRef *out_buf;
553
};
554

    
555
/**
556
 * Link two filters together.
557
 * @param src    the source filter
558
 * @param srcpad index of the output pad on the source filter
559
 * @param dst    the destination filter
560
 * @param dstpad index of the input pad on the destination filter
561
 * @return       zero on success
562
 */
563
int avfilter_link(AVFilterContext *src, unsigned srcpad,
564
                  AVFilterContext *dst, unsigned dstpad);
565

    
566
/**
567
 * Negotiate the media format, dimensions, etc of all inputs to a filter.
568
 * @param filter the filter to negotiate the properties for its inputs
569
 * @return       zero on successful negotiation
570
 */
571
int avfilter_config_links(AVFilterContext *filter);
572

    
573
/**
574
 * Request a picture buffer with a specific set of permissions.
575
 * @param link  the output link to the filter from which the buffer will
576
 *              be requested
577
 * @param perms the required access permissions
578
 * @param w     the minimum width of the buffer to allocate
579
 * @param h     the minimum height of the buffer to allocate
580
 * @return      A reference to the buffer. This must be unreferenced with
581
 *              avfilter_unref_buffer when you are finished with it.
582
 */
583
AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
584
                                          int w, int h);
585

    
586
/**
587
 * Request an input frame from the filter at the other end of the link.
588
 * @param link the input link
589
 * @return     zero on success
590
 */
591
int avfilter_request_frame(AVFilterLink *link);
592

    
593
/**
594
 * Poll a frame from the filter chain.
595
 * @param  link the input link
596
 * @return the number of immediately available frames, a negative
597
 * number in case of error
598
 */
599
int avfilter_poll_frame(AVFilterLink *link);
600

    
601
/**
602
 * Notifie the next filter of the start of a frame.
603
 * @param link   the output link the frame will be sent over
604
 * @param picref A reference to the frame about to be sent. The data for this
605
 *               frame need only be valid once draw_slice() is called for that
606
 *               portion. The receiving filter will free this reference when
607
 *               it no longer needs it.
608
 */
609
void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
610

    
611
/**
612
 * Notifie the next filter that the current frame has finished.
613
 * @param link the output link the frame was sent over
614
 */
615
void avfilter_end_frame(AVFilterLink *link);
616

    
617
/**
618
 * Send a slice to the next filter.
619
 *
620
 * Slices have to be provided in sequential order, either in
621
 * top-bottom or bottom-top order. If slices are provided in
622
 * non-sequential order the behavior of the function is undefined.
623
 *
624
 * @param link the output link over which the frame is being sent
625
 * @param y    offset in pixels from the top of the image for this slice
626
 * @param h    height of this slice in pixels
627
 * @param slice_dir the assumed direction for sending slices,
628
 *             from the top slice to the bottom slice if the value is 1,
629
 *             from the bottom slice to the top slice if the value is -1,
630
 *             for other values the behavior of the function is undefined.
631
 */
632
void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
633

    
634
/** Initialize the filter system. Register all builtin filters. */
635
void avfilter_register_all(void);
636

    
637
/** Uninitialize the filter system. Unregister all filters. */
638
void avfilter_uninit(void);
639

    
640
/**
641
 * Register a filter. This is only needed if you plan to use
642
 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
643
 * filter can still by instantiated with avfilter_open even if it is not
644
 * registered.
645
 * @param filter the filter to register
646
 * @return 0 if the registration was succesfull, a negative value
647
 * otherwise
648
 */
649
int avfilter_register(AVFilter *filter);
650

    
651
/**
652
 * Get a filter definition matching the given name.
653
 * @param name the filter name to find
654
 * @return     the filter definition, if any matching one is registered.
655
 *             NULL if none found.
656
 */
657
AVFilter *avfilter_get_by_name(const char *name);
658

    
659
/**
660
 * If filter is NULL, returns a pointer to the first registered filter pointer,
661
 * if filter is non-NULL, returns the next pointer after filter.
662
 * If the returned pointer points to NULL, the last registered filter
663
 * was already reached.
664
 */
665
AVFilter **av_filter_next(AVFilter **filter);
666

    
667
/**
668
 * Create a filter instance.
669
 *
670
 * @param filter_ctx put here a pointer to the created filter context
671
 * on success, NULL on failure
672
 * @param filter    the filter to create an instance of
673
 * @param inst_name Name to give to the new instance. Can be NULL for none.
674
 * @return >= 0 in case of success, a negative error code otherwise
675
 */
676
int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
677

    
678
/**
679
 * Initialize a filter.
680
 * @param filter the filter to initialize
681
 * @param args   A string of parameters to use when initializing the filter.
682
 *               The format and meaning of this string varies by filter.
683
 * @param opaque Any extra non-string data needed by the filter. The meaning
684
 *               of this parameter varies by filter.
685
 * @return       zero on success
686
 */
687
int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
688

    
689
/**
690
 * Destroy a filter.
691
 * @param filter the filter to destroy
692
 */
693
void avfilter_destroy(AVFilterContext *filter);
694

    
695
/**
696
 * Insert a filter in the middle of an existing link.
697
 * @param link the link into which the filter should be inserted
698
 * @param filt the filter to be inserted
699
 * @param in   the input pad on the filter to connect
700
 * @param out  the output pad on the filter to connect
701
 * @return     zero on success
702
 */
703
int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
704
                           unsigned in, unsigned out);
705

    
706
/**
707
 * Insert a new pad.
708
 * @param idx Insertion point. Pad is inserted at the end if this point
709
 *            is beyond the end of the list of pads.
710
 * @param count Pointer to the number of pads in the list
711
 * @param padidx_off Offset within an AVFilterLink structure to the element
712
 *                   to increment when inserting a new pad causes link
713
 *                   numbering to change
714
 * @param pads Pointer to the pointer to the beginning of the list of pads
715
 * @param links Pointer to the pointer to the beginning of the list of links
716
 * @param newpad The new pad to add. A copy is made when adding.
717
 */
718
void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
719
                         AVFilterPad **pads, AVFilterLink ***links,
720
                         AVFilterPad *newpad);
721

    
722
/** Insert a new input pad for the filter. */
723
static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
724
                                         AVFilterPad *p)
725
{
726
    avfilter_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
727
                        &f->input_pads, &f->inputs, p);
728
}
729

    
730
/** Insert a new output pad for the filter. */
731
static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
732
                                          AVFilterPad *p)
733
{
734
    avfilter_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
735
                        &f->output_pads, &f->outputs, p);
736
}
737

    
738
#endif  /* AVFILTER_AVFILTER_H */