773 lines · 27.4 KB · C
RawDownload
/* * filter layer * Copyright (c) 2007 Bobby Bingham * * This file is part of Libav. * * Libav is free software; you can redistribute it and/or * 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. * * Libav is distributed in the hope that it will be useful, * 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 * License along with Libav; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef AVFILTER_AVFILTER_H#define AVFILTER_AVFILTER_H #include "libavutil/avutil.h"#include "libavutil/log.h"#include "libavutil/samplefmt.h"#include "libavutil/pixfmt.h"#include "libavutil/rational.h"#include "libavcodec/avcodec.h" #include <stddef.h> #include "libavfilter/version.h" /** * Return the LIBAVFILTER_VERSION_INT constant. */unsigned avfilter_version(void); /** * Return the libavfilter build-time configuration. */const char *avfilter_configuration(void); /** * Return the libavfilter license. */const char *avfilter_license(void);  typedef struct AVFilterContext AVFilterContext;typedef struct AVFilterLink    AVFilterLink;typedef struct AVFilterPad     AVFilterPad;typedef struct AVFilterFormats AVFilterFormats; /** * A reference-counted buffer data type used by the filter system. Filters * should not store pointers to this structure directly, but instead use the * AVFilterBufferRef structure below. */typedef struct AVFilterBuffer {    uint8_t *data[8];           ///< buffer data for each plane/channel    int linesize[8];            ///< number of bytes per line     unsigned refcount;          ///< number of references to this buffer     /** private data to be used by a custom free function */    void *priv;    /**     * A pointer to the function to deallocate this buffer if the default     * function is not sufficient. This could, for example, add the memory     * back into a memory pool to be reused later without the overhead of     * reallocating it from scratch.     */    void (*free)(struct AVFilterBuffer *buf);     int format;                 ///< media format    int w, h;                   ///< width and height of the allocated buffer     /**     * 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;} AVFilterBuffer; #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#define AV_PERM_NEG_LINESIZES 0x20  ///< the buffer requested can have negative linesizes /** * 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 {    uint64_t channel_layout;    ///< channel layout of audio buffer    int nb_samples;             ///< number of audio samples    int sample_rate;            ///< audio buffer sample rate    int planar;                 ///< audio buffer - planar or packed} AVFilterBufferRefAudioProps; /** * 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. */typedef struct AVFilterBufferRefVideoProps {    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    enum AVPictureType pict_type; ///< picture type of the frame    int key_frame;              ///< 1 -> keyframe, 0-> not} AVFilterBufferRefVideoProps; /** * A reference to an AVFilterBuffer. Since filters can manipulate the origin of * a buffer to, for example, crop image without any memcpy, the buffer origin * and dimensions are per-reference properties. Linesize is also useful for * image flipping, frame to field filters, etc, and so is also per-reference. * * TODO: add anything necessary for frame reordering */typedef struct AVFilterBufferRef {    AVFilterBuffer *buf;        ///< the buffer that this is a reference to    uint8_t *data[8];           ///< picture/audio data for each plane    int linesize[8];            ///< number of bytes per line    int format;                 ///< media format     /**     * 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;    int64_t pos;                ///< byte position in stream, -1 if unknown     int perms;                  ///< permissions, see the AV_PERM_* flags     enum AVMediaType type;      ///< media type of buffer data    AVFilterBufferRefVideoProps *video; ///< video buffer specific properties    AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties     /**     * 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;} AVFilterBufferRef; /** * Copy properties of src to dst, without copying the actual data */void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src); /** * Add a new reference to a buffer. * * @param ref   an existing reference to the buffer * @param pmask a bitmask containing the allowable permissions in the new *              reference * @return      a new reference to the buffer with the same properties as the *              old, excluding any permissions denied by pmask */AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask); /** * Remove a reference to a buffer. If this is the last reference to the * buffer, the buffer itself is also automatically freed. * * @param ref reference to the buffer, may be NULL */void avfilter_unref_buffer(AVFilterBufferRef *ref); #if FF_API_FILTERS_PUBLIC/** * @addtogroup lavfi_deprecated * @deprecated Those functions are only useful inside filters and * user filters are not supported at this point. * @{ */struct AVFilterFormats {    unsigned format_count;      ///< number of formats    int *formats;               ///< list of media formats     unsigned refcount;          ///< number of references to this list    struct AVFilterFormats ***refs; ///< references to this list}; attribute_deprecatedAVFilterFormats *avfilter_make_format_list(const int *fmts);attribute_deprecatedint avfilter_add_format(AVFilterFormats **avff, int fmt);attribute_deprecatedAVFilterFormats *avfilter_all_formats(enum AVMediaType type);attribute_deprecatedAVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);attribute_deprecatedvoid avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);attribute_deprecatedvoid avfilter_formats_unref(AVFilterFormats **ref);attribute_deprecatedvoid avfilter_formats_changeref(AVFilterFormats **oldref,                                AVFilterFormats **newref);attribute_deprecatedvoid avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);/** * @} */#endif #if FF_API_AVFILTERPAD_PUBLIC/** * A filter pad used for either input or output. * * @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. */struct AVFilterPad {    /**     * 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     * pad has no need to ever be referenced by name.     */    const char *name;     /**     * AVFilterPad type.     */    enum AVMediaType type;     /**     * Minimum required permissions on incoming buffers. Any buffer with     * 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;     /**     * Permissions which are not accepted on incoming buffers. Any buffer     * which has any of these permissions set will be automatically copied     * by the filter system to a new buffer which does not have those     * permissions. This can be used to easily disallow buffers with     * AV_PERM_REUSE.     *     * Input pads only.     */    int rej_perms;     /**     * Callback called before passing the first slice of a new frame. If     * NULL, the filter layer will default to storing a reference to the     * picture inside the link structure.     *     * Input video pads only.     */    void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);     /**     * Callback function to get a video buffer. If NULL, the filter system will     * use avfilter_default_get_video_buffer().     *     * Input video pads only.     */    AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);     /**     * 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,                                           int nb_samples);     /**     * Callback called after the slices of a frame are completely sent. If     * NULL, the filter layer will default to releasing the reference stored     * in the link structure during start_frame().     *     * Input video pads only.     */    void (*end_frame)(AVFilterLink *link);     /**     * Slice drawing callback. This is where a filter receives video data     * and should do its processing.     *     * Input video pads only.     */    void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);     /**     * 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);     /**     * Frame poll callback. This returns the number of immediately available     * samples. It should return a positive value if the next request_frame()     * is guaranteed to return one frame (with no delay).     *     * Defaults to just calling the source poll_frame() method.     *     * Output pads only.     */    int (*poll_frame)(AVFilterLink *link);     /**     * 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     * success, and another value on error.     *     * Output pads only.     */    int (*request_frame)(AVFilterLink *link);     /**     * Link configuration callback.     *     * For output pads, this should set the link properties such as     * width/height. This should NOT set the format property - that is     * negotiated between filters by the filter system using the     * query_formats() callback before this function is called.     *     * For input pads, this should check the properties of the link, and update     * the filter's internal state as necessary.     *     * For both input and output filters, this should return zero on success,     * and another value on error.     */    int (*config_props)(AVFilterLink *link);};#endif /** * 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); #if FF_API_FILTERS_PUBLIC/** default handler for start_frame() for video inputs */attribute_deprecatedvoid avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref); /** default handler for draw_slice() for video inputs */attribute_deprecatedvoid avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir); /** default handler for end_frame() for video inputs */attribute_deprecatedvoid avfilter_default_end_frame(AVFilterLink *link); #if FF_API_DEFAULT_CONFIG_OUTPUT_LINK/** default handler for config_props() for audio/video outputs */attribute_deprecatedint avfilter_default_config_output_link(AVFilterLink *link);#endif /** default handler for get_video_buffer() for video inputs */attribute_deprecatedAVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,                                                     int perms, int w, int h); /** Default handler for query_formats() */attribute_deprecatedint avfilter_default_query_formats(AVFilterContext *ctx);#endif #if FF_API_FILTERS_PUBLIC/** start_frame() handler for filters which simply pass video along */attribute_deprecatedvoid avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref); /** draw_slice() handler for filters which simply pass video along */attribute_deprecatedvoid avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir); /** end_frame() handler for filters which simply pass video along */attribute_deprecatedvoid avfilter_null_end_frame(AVFilterLink *link); /** get_video_buffer() handler for filters which simply pass video along */attribute_deprecatedAVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,                                                  int perms, int w, int h);#endif /** * Filter definition. This defines the pads a filter contains, and all the * callback functions used to interact with the filter. */typedef struct AVFilter {    const char *name;         ///< filter name     int priv_size;      ///< size of private data to allocate for the filter     /**     * Filter initialization function. Args contains the user-supplied     * parameters. FIXME: maybe an AVOption-based system would be better?     * opaque is data provided by the code requesting creation of the filter,     * and is used to pass data to the filter.     */    int (*init)(AVFilterContext *ctx, const char *args, void *opaque);     /**     * Filter uninitialization function. Should deallocate any memory held     * by the filter, release any buffer references, etc. This does not need     * to deallocate the AVFilterContext->priv memory itself.     */    void (*uninit)(AVFilterContext *ctx);     /**     * Queries formats supported by the filter and its pads, and sets the     * in_formats for links connected to its output pads, and out_formats     * for links connected to its input pads.     *     * @return zero on success, a negative value corresponding to an     * AVERROR code otherwise     */    int (*query_formats)(AVFilterContext *);     const AVFilterPad *inputs;  ///< NULL terminated list of inputs. NULL if none    const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none     /**     * A description for the filter. You should use the     * NULL_IF_CONFIG_SMALL() macro to define it.     */    const char *description;} AVFilter; /** An instance of a filter */struct AVFilterContext {    const AVClass *av_class;              ///< needed for av_log()     AVFilter *filter;               ///< the AVFilter of which this is an instance     char *name;                     ///< name of this filter instance #if FF_API_FOO_COUNT    unsigned input_count;           ///< @deprecated use nb_inputs#endif    AVFilterPad   *input_pads;      ///< array of input pads    AVFilterLink **inputs;          ///< array of pointers to input links #if FF_API_FOO_COUNT    unsigned output_count;          ///< @deprecated use nb_outputs#endif    AVFilterPad   *output_pads;     ///< array of output pads

Lines 1–500 of 773.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t