avfilter.h 27.6 KB
Newer Older
V
Vitor Sessak 已提交
1
/*
2
 * filter layer
3
 * Copyright (c) 2007 Bobby Bingham
V
Vitor Sessak 已提交
4
 *
5
 * This file is part of Libav.
V
Vitor Sessak 已提交
6
 *
7
 * Libav is free software; you can redistribute it and/or
V
Vitor Sessak 已提交
8 9 10 11
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
12
 * Libav is distributed in the hope that it will be useful,
V
Vitor Sessak 已提交
13 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with Libav; if not, write to the Free Software
V
Vitor Sessak 已提交
19 20 21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

22 23
#ifndef AVFILTER_AVFILTER_H
#define AVFILTER_AVFILTER_H
V
Vitor Sessak 已提交
24

25
#include "libavutil/avutil.h"
M
Mans Rullgard 已提交
26
#include "libavutil/log.h"
27
#include "libavutil/samplefmt.h"
28
#include "libavutil/pixfmt.h"
29
#include "libavutil/rational.h"
30
#include "libavcodec/avcodec.h"
31

32
#include <stddef.h>
V
Vitor Sessak 已提交
33

34 35
#include "libavfilter/version.h"

S
Stefano Sabatini 已提交
36
/**
37
 * Return the LIBAVFILTER_VERSION_INT constant.
S
Stefano Sabatini 已提交
38 39 40
 */
unsigned avfilter_version(void);

41
/**
42
 * Return the libavfilter build-time configuration.
43
 */
44
const char *avfilter_configuration(void);
45 46

/**
47
 * Return the libavfilter license.
48
 */
49
const char *avfilter_license(void);
50 51


V
Vitor Sessak 已提交
52 53 54
typedef struct AVFilterContext AVFilterContext;
typedef struct AVFilterLink    AVFilterLink;
typedef struct AVFilterPad     AVFilterPad;
55
typedef struct AVFilterFormats AVFilterFormats;
V
Vitor Sessak 已提交
56 57

/**
58
 * A reference-counted buffer data type used by the filter system. Filters
V
Vitor Sessak 已提交
59
 * should not store pointers to this structure directly, but instead use the
60
 * AVFilterBufferRef structure below.
V
Vitor Sessak 已提交
61
 */
62
typedef struct AVFilterBuffer {
63 64
    uint8_t *data[8];           ///< buffer data for each plane/channel
    int linesize[8];            ///< number of bytes per line
V
Vitor Sessak 已提交
65

66
    unsigned refcount;          ///< number of references to this buffer
67 68

    /** private data to be used by a custom free function */
V
Vitor Sessak 已提交
69
    void *priv;
70
    /**
71
     * A pointer to the function to deallocate this buffer if the default
72
     * function is not sufficient. This could, for example, add the memory
73 74 75
     * back into a memory pool to be reused later without the overhead of
     * reallocating it from scratch.
     */
76
    void (*free)(struct AVFilterBuffer *buf);
77 78 79

    int format;                 ///< media format
    int w, h;                   ///< width and height of the allocated buffer
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

    /**
     * pointers to the data planes/channels.
     *
     * For video, this should simply point to data[].
     *
     * For planar audio, each channel has a separate data pointer, and
     * linesize[0] contains the size of each channel buffer.
     * For packed audio, there is just one data pointer, and linesize[0]
     * contains the total size of the buffer for all channels.
     *
     * Note: Both data and extended_data will always be set, but for planar
     * audio with more channels that can fit in data, extended_data must be used
     * in order to access all channels.
     */
    uint8_t **extended_data;
96
} AVFilterBuffer;
V
Vitor Sessak 已提交
97

98 99 100 101 102
#define AV_PERM_READ     0x01   ///< can read from the buffer
#define AV_PERM_WRITE    0x02   ///< can write to the buffer
#define AV_PERM_PRESERVE 0x04   ///< nobody else can overwrite the buffer
#define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
#define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
103
#define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes
104

105 106 107 108 109 110
/**
 * Audio specific properties in a reference to an AVFilterBuffer. Since
 * AVFilterBufferRef is common to different media formats, audio specific
 * per reference properties must be separated out.
 */
typedef struct AVFilterBufferRefAudioProps {
M
Mans Rullgard 已提交
111
    uint64_t channel_layout;    ///< channel layout of audio buffer
112
    int nb_samples;             ///< number of audio samples
113
    int sample_rate;            ///< audio buffer sample rate
114 115 116
    int planar;                 ///< audio buffer - planar or packed
} AVFilterBufferRefAudioProps;

117 118 119 120 121
/**
 * Video specific properties in a reference to an AVFilterBuffer. Since
 * AVFilterBufferRef is common to different media formats, video specific
 * per reference properties must be separated out.
 */
122
typedef struct AVFilterBufferRefVideoProps {
123 124 125 126 127
    int w;                      ///< image width
    int h;                      ///< image height
    AVRational pixel_aspect;    ///< pixel aspect ratio
    int interlaced;             ///< is frame interlaced
    int top_field_first;        ///< field order
128
    enum AVPictureType pict_type; ///< picture type of the frame
129
    int key_frame;              ///< 1 -> keyframe, 0-> not
130 131
} AVFilterBufferRefVideoProps;

V
Vitor Sessak 已提交
132
/**
133
 * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
134
 * a buffer to, for example, crop image without any memcpy, the buffer origin
135
 * and dimensions are per-reference properties. Linesize is also useful for
136
 * image flipping, frame to field filters, etc, and so is also per-reference.
V
Vitor Sessak 已提交
137
 *
V
Vitor Sessak 已提交
138
 * TODO: add anything necessary for frame reordering
V
Vitor Sessak 已提交
139
 */
140
typedef struct AVFilterBufferRef {
141
    AVFilterBuffer *buf;        ///< the buffer that this is a reference to
142
    uint8_t *data[8];           ///< picture/audio data for each plane
143
    int linesize[8];            ///< number of bytes per line
144
    int format;                 ///< media format
V
Vitor Sessak 已提交
145

146 147 148 149 150 151
    /**
     * presentation timestamp. The time unit may change during
     * filtering, as it is specified in the link and the filter code
     * may need to rescale the PTS accordingly.
     */
    int64_t pts;
152
    int64_t pos;                ///< byte position in stream, -1 if unknown
V
Vitor Sessak 已提交
153

154
    int perms;                  ///< permissions, see the AV_PERM_* flags
155

156 157
    enum AVMediaType type;      ///< media type of buffer data
    AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
158
    AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174

    /**
     * pointers to the data planes/channels.
     *
     * For video, this should simply point to data[].
     *
     * For planar audio, each channel has a separate data pointer, and
     * linesize[0] contains the size of each channel buffer.
     * For packed audio, there is just one data pointer, and linesize[0]
     * contains the total size of the buffer for all channels.
     *
     * Note: Both data and extended_data will always be set, but for planar
     * audio with more channels that can fit in data, extended_data must be used
     * in order to access all channels.
     */
    uint8_t **extended_data;
175
} AVFilterBufferRef;
V
Vitor Sessak 已提交
176

177
/**
178
 * Copy properties of src to dst, without copying the actual data
179
 */
180
void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
181

V
Vitor Sessak 已提交
182
/**
183
 * Add a new reference to a buffer.
184
 *
185
 * @param ref   an existing reference to the buffer
186
 * @param pmask a bitmask containing the allowable permissions in the new
187
 *              reference
188
 * @return      a new reference to the buffer with the same properties as the
189
 *              old, excluding any permissions denied by pmask
V
Vitor Sessak 已提交
190
 */
191
AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
V
Vitor Sessak 已提交
192 193

/**
194 195
 * Remove a reference to a buffer. If this is the last reference to the
 * buffer, the buffer itself is also automatically freed.
196
 *
197
 * @param ref reference to the buffer, may be NULL
V
Vitor Sessak 已提交
198
 */
199
void avfilter_unref_buffer(AVFilterBufferRef *ref);
V
Vitor Sessak 已提交
200

201
#if FF_API_FILTERS_PUBLIC
V
Vitor Sessak 已提交
202
/**
203 204 205 206
 * @addtogroup lavfi_deprecated
 * @deprecated Those functions are only useful inside filters and
 * user filters are not supported at this point.
 * @{
V
Vitor Sessak 已提交
207
 */
208
struct AVFilterFormats {
V
Vitor Sessak 已提交
209
    unsigned format_count;      ///< number of formats
210
    int *formats;               ///< list of media formats
V
Vitor Sessak 已提交
211 212

    unsigned refcount;          ///< number of references to this list
213
    struct AVFilterFormats ***refs; ///< references to this list
214
};
V
Vitor Sessak 已提交
215

216
attribute_deprecated
217
AVFilterFormats *avfilter_make_format_list(const int *fmts);
218
attribute_deprecated
219
int avfilter_add_format(AVFilterFormats **avff, int fmt);
220
attribute_deprecated
221
AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
222
attribute_deprecated
V
Vitor Sessak 已提交
223
AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
224
attribute_deprecated
225
void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
226
attribute_deprecated
V
Vitor Sessak 已提交
227
void avfilter_formats_unref(AVFilterFormats **ref);
228
attribute_deprecated
M
Michael Niedermayer 已提交
229 230
void avfilter_formats_changeref(AVFilterFormats **oldref,
                                AVFilterFormats **newref);
231 232 233 234 235 236
attribute_deprecated
void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
/**
 * @}
 */
#endif
M
Michael Niedermayer 已提交
237

238
#if FF_API_AVFILTERPAD_PUBLIC
239
/**
240
 * A filter pad used for either input or output.
241 242 243 244 245
 *
 * @warning this struct will be removed from public API.
 * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
 * to access the name and type fields; there should be no need to access
 * any other fields from outside of libavfilter.
246
 */
247
struct AVFilterPad {
V
Vitor Sessak 已提交
248
    /**
249 250
     * Pad name. The name is unique among inputs and among outputs, but an
     * input may have the same name as an output. This may be NULL if this
251
     * pad has no need to ever be referenced by name.
V
Vitor Sessak 已提交
252
     */
V
Vitor Sessak 已提交
253
    const char *name;
V
Vitor Sessak 已提交
254 255

    /**
256
     * AVFilterPad type.
V
Vitor Sessak 已提交
257
     */
258
    enum AVMediaType type;
V
Vitor Sessak 已提交
259

260
    /**
261
     * Minimum required permissions on incoming buffers. Any buffer with
262 263 264 265 266 267 268 269
     * insufficient permissions will be automatically copied by the filter
     * system to a new buffer which provides the needed access permissions.
     *
     * Input pads only.
     */
    int min_perms;

    /**
270
     * Permissions which are not accepted on incoming buffers. Any buffer
271 272
     * which has any of these permissions set will be automatically copied
     * by the filter system to a new buffer which does not have those
273
     * permissions. This can be used to easily disallow buffers with
274
     * AV_PERM_REUSE.
275 276 277 278 279
     *
     * Input pads only.
     */
    int rej_perms;

V
Vitor Sessak 已提交
280
    /**
281
     * Callback called before passing the first slice of a new frame. If
V
Vitor Sessak 已提交
282 283
     * NULL, the filter layer will default to storing a reference to the
     * picture inside the link structure.
284 285
     *
     * Input video pads only.
V
Vitor Sessak 已提交
286
     */
287
    void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
V
Vitor Sessak 已提交
288 289

    /**
290
     * Callback function to get a video buffer. If NULL, the filter system will
291
     * use avfilter_default_get_video_buffer().
292 293
     *
     * Input video pads only.
V
Vitor Sessak 已提交
294
     */
295
    AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
V
Vitor Sessak 已提交
296

297 298 299 300 301 302 303
    /**
     * Callback function to get an audio buffer. If NULL, the filter system will
     * use avfilter_default_get_audio_buffer().
     *
     * Input audio pads only.
     */
    AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
304
                                           int nb_samples);
305

V
Vitor Sessak 已提交
306
    /**
307
     * Callback called after the slices of a frame are completely sent. If
V
Vitor Sessak 已提交
308 309
     * NULL, the filter layer will default to releasing the reference stored
     * in the link structure during start_frame().
310 311
     *
     * Input video pads only.
V
Vitor Sessak 已提交
312 313 314 315
     */
    void (*end_frame)(AVFilterLink *link);

    /**
316
     * Slice drawing callback. This is where a filter receives video data
317 318 319
     * and should do its processing.
     *
     * Input video pads only.
V
Vitor Sessak 已提交
320
     */
321
    void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
V
Vitor Sessak 已提交
322

323 324 325 326 327 328 329 330
    /**
     * Samples filtering callback. This is where a filter receives audio data
     * and should do its processing.
     *
     * Input audio pads only.
     */
    void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);

331
    /**
332
     * Frame poll callback. This returns the number of immediately available
333
     * samples. It should return a positive value if the next request_frame()
334 335 336 337
     * is guaranteed to return one frame (with no delay).
     *
     * Defaults to just calling the source poll_frame() method.
     *
A
Anton Khirnov 已提交
338
     * Output pads only.
339 340 341
     */
    int (*poll_frame)(AVFilterLink *link);

V
Vitor Sessak 已提交
342
    /**
343 344
     * Frame request callback. A call to this should result in at least one
     * frame being output over the given link. This should return zero on
345 346
     * success, and another value on error.
     *
A
Anton Khirnov 已提交
347
     * Output pads only.
V
Vitor Sessak 已提交
348
     */
349
    int (*request_frame)(AVFilterLink *link);
V
Vitor Sessak 已提交
350 351

    /**
352 353 354
     * Link configuration callback.
     *
     * For output pads, this should set the link properties such as
355
     * width/height. This should NOT set the format property - that is
356 357
     * negotiated between filters by the filter system using the
     * query_formats() callback before this function is called.
358 359 360
     *
     * For input pads, this should check the properties of the link, and update
     * the filter's internal state as necessary.
361 362 363
     *
     * For both input and output filters, this should return zero on success,
     * and another value on error.
V
Vitor Sessak 已提交
364
     */
365
    int (*config_props)(AVFilterLink *link);
366 367 368 369 370 371 372 373

    /**
     * The filter expects a fifo to be inserted on its input link,
     * typically because it has a delay.
     *
     * input pads only.
     */
    int needs_fifo;
V
Vitor Sessak 已提交
374
};
375
#endif
V
Vitor Sessak 已提交
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
/**
 * Get the name of an AVFilterPad.
 *
 * @param pads an array of AVFilterPads
 * @param pad_idx index of the pad in the array it; is the caller's
 *                responsibility to ensure the index is valid
 *
 * @return name of the pad_idx'th pad in pads
 */
const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx);

/**
 * Get the type of an AVFilterPad.
 *
 * @param pads an array of AVFilterPads
 * @param pad_idx index of the pad in the array; it is the caller's
 *                responsibility to ensure the index is valid
 *
 * @return type of the pad_idx'th pad in pads
 */
enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx);

399
#if FF_API_FILTERS_PUBLIC
400
/** default handler for start_frame() for video inputs */
401
attribute_deprecated
402
void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
403

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

408
/** default handler for end_frame() for video inputs */
409
attribute_deprecated
V
Vitor Sessak 已提交
410
void avfilter_default_end_frame(AVFilterLink *link);
411

412
#if FF_API_DEFAULT_CONFIG_OUTPUT_LINK
413
/** default handler for config_props() for audio/video outputs */
414
attribute_deprecated
415
int avfilter_default_config_output_link(AVFilterLink *link);
416
#endif
417

418
/** default handler for get_video_buffer() for video inputs */
419
attribute_deprecated
420
AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
421
                                                     int perms, int w, int h);
422

423 424 425 426 427
/** Default handler for query_formats() */
attribute_deprecated
int avfilter_default_query_formats(AVFilterContext *ctx);
#endif

428
#if FF_API_FILTERS_PUBLIC
429
/** start_frame() handler for filters which simply pass video along */
430
attribute_deprecated
431
void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
432 433

/** draw_slice() handler for filters which simply pass video along */
434
attribute_deprecated
435 436 437
void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);

/** end_frame() handler for filters which simply pass video along */
438
attribute_deprecated
439 440 441
void avfilter_null_end_frame(AVFilterLink *link);

/** get_video_buffer() handler for filters which simply pass video along */
442
attribute_deprecated
443
AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
444
                                                  int perms, int w, int h);
445
#endif
446

447
/**
448
 * Filter definition. This defines the pads a filter contains, and all the
449 450
 * callback functions used to interact with the filter.
 */
451
typedef struct AVFilter {
V
Vitor Sessak 已提交
452
    const char *name;         ///< filter name
V
Vitor Sessak 已提交
453

454
    int priv_size;      ///< size of private data to allocate for the filter
V
Vitor Sessak 已提交
455

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

    /**
465
     * Filter uninitialization function. Should deallocate any memory held
466
     * by the filter, release any buffer references, etc. This does not need
467 468
     * to deallocate the AVFilterContext->priv memory itself.
     */
V
Vitor Sessak 已提交
469 470
    void (*uninit)(AVFilterContext *ctx);

V
Vitor Sessak 已提交
471
    /**
472
     * Queries formats supported by the filter and its pads, and sets the
V
Vitor Sessak 已提交
473 474 475
     * in_formats for links connected to its output pads, and out_formats
     * for links connected to its input pads.
     *
476 477
     * @return zero on success, a negative value corresponding to an
     * AVERROR code otherwise
V
Vitor Sessak 已提交
478 479 480
     */
    int (*query_formats)(AVFilterContext *);

481 482
    const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none
    const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
483 484 485 486 487 488

    /**
     * A description for the filter. You should use the
     * NULL_IF_CONFIG_SMALL() macro to define it.
     */
    const char *description;
V
Vitor Sessak 已提交
489 490
} AVFilter;

491
/** An instance of a filter */
492
struct AVFilterContext {
493
    const AVClass *av_class;              ///< needed for av_log()
V
Vitor Sessak 已提交
494

495
    AVFilter *filter;               ///< the AVFilter of which this is an instance
V
Vitor Sessak 已提交
496

497
    char *name;                     ///< name of this filter instance
498

499 500 501
#if FF_API_FOO_COUNT
    unsigned input_count;           ///< @deprecated use nb_inputs
#endif
502 503
    AVFilterPad   *input_pads;      ///< array of input pads
    AVFilterLink **inputs;          ///< array of pointers to input links
V
Vitor Sessak 已提交
504

505 506 507
#if FF_API_FOO_COUNT
    unsigned output_count;          ///< @deprecated use nb_outputs
#endif
508 509
    AVFilterPad   *output_pads;     ///< array of output pads
    AVFilterLink **outputs;         ///< array of pointers to output links
V
Vitor Sessak 已提交
510

511
    void *priv;                     ///< private data for use by the filter
512 513 514

    unsigned nb_inputs;             ///< number of input pads
    unsigned nb_outputs;            ///< number of output pads
V
Vitor Sessak 已提交
515 516
};

517
/**
518
 * A link between two filters. This contains pointers to the source and
519
 * destination filters between which this link exists, and the indexes of
520
 * the pads involved. In addition, this link also contains the parameters
521
 * which have been negotiated and agreed upon between the filter, such as
522
 * image dimensions, format, etc.
523
 */
524
struct AVFilterLink {
525
    AVFilterContext *src;       ///< source filter
526
    AVFilterPad *srcpad;        ///< output pad on the source filter
V
Vitor Sessak 已提交
527

528
    AVFilterContext *dst;       ///< dest filter
529
    AVFilterPad *dstpad;        ///< input pad on the dest filter
V
Vitor Sessak 已提交
530

531 532 533 534 535 536 537
    /** stage of the initialization of the link properties (dimensions, etc) */
    enum {
        AVLINK_UNINIT = 0,      ///< not started
        AVLINK_STARTINIT,       ///< started, but incomplete
        AVLINK_INIT             ///< complete
    } init_state;

538 539
    enum AVMediaType type;      ///< filter media type

540
    /* These parameters apply only to video */
541 542
    int w;                      ///< agreed upon image width
    int h;                      ///< agreed upon image height
543
    AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
544
    /* These two parameters apply only to audio */
M
Mans Rullgard 已提交
545
    uint64_t channel_layout;    ///< channel layout of current buffer (see libavutil/audioconvert.h)
546
#if FF_API_SAMPLERATE64
547
    int64_t sample_rate;        ///< samples per second
548 549 550
#else
    int sample_rate;            ///< samples per second
#endif
551

552
    int format;                 ///< agreed upon media format
V
Vitor Sessak 已提交
553

V
Vitor Sessak 已提交
554 555 556 557 558 559 560 561
    /**
     * Lists of formats supported by the input and output filters respectively.
     * These lists are used for negotiating the format to actually be used,
     * which will be loaded into the format member, above, when chosen.
     */
    AVFilterFormats *in_formats;
    AVFilterFormats *out_formats;

562
    /**
563
     * The buffer reference currently being sent across the link by the source
564
     * filter. This is used internally by the filter system to allow
565
     * automatic copying of buffers which do not have sufficient permissions
566
     * for the destination. This should not be accessed directly by the
567 568
     * filters.
     */
S
S.N. Hemanth Meenakshisundaram 已提交
569
    AVFilterBufferRef *src_buf;
570

S
S.N. Hemanth Meenakshisundaram 已提交
571 572
    AVFilterBufferRef *cur_buf;
    AVFilterBufferRef *out_buf;
573 574 575 576 577 578 579 580 581

    /**
     * Define the time base used by the PTS of the frames/samples
     * which will pass through this link.
     * During the configuration stage, each filter is supposed to
     * change only the output timebase, while the timebase of the
     * input link is assumed to be an unchangeable property.
     */
    AVRational time_base;
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597

    /*****************************************************************
     * All fields below this line are not part of the public API. They
     * may not be used outside of libavfilter and can be changed and
     * removed at will.
     * New public fields should be added right above.
     *****************************************************************
     */
    /**
     * Lists of channel layouts and sample rates used for automatic
     * negotiation.
     */
    AVFilterFormats  *in_samplerates;
    AVFilterFormats *out_samplerates;
    struct AVFilterChannelLayouts  *in_channel_layouts;
    struct AVFilterChannelLayouts *out_channel_layouts;
V
Vitor Sessak 已提交
598 599
};

600
/**
601
 * Link two filters together.
602
 *
603 604 605 606 607
 * @param src    the source filter
 * @param srcpad index of the output pad on the source filter
 * @param dst    the destination filter
 * @param dstpad index of the input pad on the destination filter
 * @return       zero on success
608
 */
V
Vitor Sessak 已提交
609 610 611
int avfilter_link(AVFilterContext *src, unsigned srcpad,
                  AVFilterContext *dst, unsigned dstpad);

612
/**
613
 * Negotiate the media format, dimensions, etc of all inputs to a filter.
614
 *
615 616
 * @param filter the filter to negotiate the properties for its inputs
 * @return       zero on successful negotiation
617
 */
618
int avfilter_config_links(AVFilterContext *filter);
619

620 621
#if FF_API_FILTERS_PUBLIC
attribute_deprecated
622
AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
623
                                          int w, int h);
624
#endif
625

626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
/**
 * Create a buffer reference wrapped around an already allocated image
 * buffer.
 *
 * @param data pointers to the planes of the image to reference
 * @param linesize linesizes for the planes of the image to reference
 * @param perms the required access permissions
 * @param w the width of the image specified by the data and linesize arrays
 * @param h the height of the image specified by the data and linesize arrays
 * @param format the pixel format of the image specified by the data and linesize arrays
 */
AVFilterBufferRef *
avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
                                          int w, int h, enum PixelFormat format);

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
/**
 * Create an audio buffer reference wrapped around an already
 * allocated samples buffer.
 *
 * @param data           pointers to the samples plane buffers
 * @param linesize       linesize for the samples plane buffers
 * @param perms          the required access permissions
 * @param nb_samples     number of samples per channel
 * @param sample_fmt     the format of each sample in the buffer to allocate
 * @param channel_layout the channel layout of the buffer
 */
AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
                                                             int linesize,
                                                             int perms,
                                                             int nb_samples,
                                                             enum AVSampleFormat sample_fmt,
                                                             uint64_t channel_layout);

659 660
#if FF_API_FILTERS_PUBLIC
attribute_deprecated
V
Vitor Sessak 已提交
661
int avfilter_request_frame(AVFilterLink *link);
662

663
attribute_deprecated
664 665
int avfilter_poll_frame(AVFilterLink *link);

666
attribute_deprecated
667
void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
668
attribute_deprecated
V
Vitor Sessak 已提交
669
void avfilter_end_frame(AVFilterLink *link);
670
attribute_deprecated
671
void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
672
#endif
V
Vitor Sessak 已提交
673

674
/** Initialize the filter system. Register all builtin filters. */
V
Oops  
Vitor Sessak 已提交
675
void avfilter_register_all(void);
676

677
/** Uninitialize the filter system. Unregister all filters. */
V
Vitor Sessak 已提交
678
void avfilter_uninit(void);
679 680

/**
681
 * Register a filter. This is only needed if you plan to use
682 683 684
 * avfilter_get_by_name later to lookup the AVFilter structure by name. A
 * filter can still by instantiated with avfilter_open even if it is not
 * registered.
685
 *
686
 * @param filter the filter to register
687 688
 * @return 0 if the registration was succesfull, a negative value
 * otherwise
689
 */
690
int avfilter_register(AVFilter *filter);
691 692

/**
693
 * Get a filter definition matching the given name.
694
 *
695 696
 * @param name the filter name to find
 * @return     the filter definition, if any matching one is registered.
697 698
 *             NULL if none found.
 */
V
Vitor Sessak 已提交
699
AVFilter *avfilter_get_by_name(const char *name);
V
Vitor Sessak 已提交
700

S
Stefano Sabatini 已提交
701 702 703 704 705 706 707 708
/**
 * If filter is NULL, returns a pointer to the first registered filter pointer,
 * if filter is non-NULL, returns the next pointer after filter.
 * If the returned pointer points to NULL, the last registered filter
 * was already reached.
 */
AVFilter **av_filter_next(AVFilter **filter);

709
/**
710
 * Create a filter instance.
711 712 713
 *
 * @param filter_ctx put here a pointer to the created filter context
 * on success, NULL on failure
714
 * @param filter    the filter to create an instance of
715
 * @param inst_name Name to give to the new instance. Can be NULL for none.
716
 * @return >= 0 in case of success, a negative error code otherwise
717
 */
718
int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
719 720

/**
721
 * Initialize a filter.
722
 *
723
 * @param filter the filter to initialize
724 725
 * @param args   A string of parameters to use when initializing the filter.
 *               The format and meaning of this string varies by filter.
726
 * @param opaque Any extra non-string data needed by the filter. The meaning
727
 *               of this parameter varies by filter.
728
 * @return       zero on success
729
 */
730
int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
731 732

/**
733
 * Free a filter context.
734
 *
735
 * @param filter the filter to free
736
 */
737
void avfilter_free(AVFilterContext *filter);
V
Vitor Sessak 已提交
738

739
/**
740
 * Insert a filter in the middle of an existing link.
741
 *
742 743
 * @param link the link into which the filter should be inserted
 * @param filt the filter to be inserted
744 745
 * @param filt_srcpad_idx the input pad on the filter to connect
 * @param filt_dstpad_idx the output pad on the filter to connect
746
 * @return     zero on success
747
 */
V
Vitor Sessak 已提交
748
int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
749
                           unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
750

751 752
#if FF_API_FILTERS_PUBLIC
attribute_deprecated
753 754 755 756
void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
                         AVFilterPad **pads, AVFilterLink ***links,
                         AVFilterPad *newpad);

757 758 759 760 761 762 763
attribute_deprecated
void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
                           AVFilterPad *p);
attribute_deprecated
void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
                            AVFilterPad *p);
#endif
764

765 766 767 768 769 770 771 772
/**
 * Copy the frame properties of src to dst, without copying the actual
 * image data.
 *
 * @return 0 on success, a negative number on error.
 */
int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);

773 774 775 776 777 778 779 780
/**
 * Copy the frame properties and data pointers of src to dst, without copying
 * the actual data.
 *
 * @return 0 on success, a negative number on error.
 */
int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);

D
Diego Biurrun 已提交
781
#endif /* AVFILTER_AVFILTER_H */