/*
* filter layer
- * copyright (c) 2007 Bobby Bingham
+ * Copyright (c) 2007 Bobby Bingham
*
- * This file is part of FFmpeg.
+ * This file is part of Libav.
*
- * FFmpeg is free software; you can redistribute it and/or
+ * 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.
*
- * FFmpeg is distributed in the hope that it will be useful,
+ * 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 FFmpeg; if not, write to the Free Software
+ * License along with Libav; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#define AVFILTER_AVFILTER_H
#include "libavutil/avutil.h"
+#include "libavutil/samplefmt.h"
-#define LIBAVFILTER_VERSION_MAJOR 1
-#define LIBAVFILTER_VERSION_MINOR 26
-#define LIBAVFILTER_VERSION_MICRO 2
+#define LIBAVFILTER_VERSION_MAJOR 2
+#define LIBAVFILTER_VERSION_MINOR 2
+#define LIBAVFILTER_VERSION_MICRO 0
#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
LIBAVFILTER_VERSION_MINOR, \
#define LIBAVFILTER_BUILD LIBAVFILTER_VERSION_INT
#include <stddef.h>
-#include "libavcodec/avcodec.h"
/**
* Return the LIBAVFILTER_VERSION_INT constant.
/**
* A reference-counted buffer data type used by the filter system. Filters
* should not store pointers to this structure directly, but instead use the
- * AVFilterPicRef structure below.
+ * AVFilterBufferRef structure below.
*/
-typedef struct AVFilterBuffer
-{
- uint8_t *data[4]; ///< buffer data for each plane
- int linesize[4]; ///< number of bytes per line
- int format; ///< media format
+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
* reallocating it from scratch.
*/
void (*free)(struct AVFilterBuffer *buf);
+
+ int format; ///< media format
+ int w, h; ///< width and height of the allocated buffer
} AVFilterBuffer;
#define AV_PERM_READ 0x01 ///< can read from 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 {
+ int64_t channel_layout; ///< channel layout of audio buffer
+ int nb_samples; ///< number of audio samples
+ int size; ///< audio buffer size
+ uint32_t 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
+} AVFilterBufferRefVideoProps;
/**
* A reference to an AVFilterBuffer. Since filters can manipulate the origin of
- * a picture to, for example, crop image without any memcpy, the picture origin
+ * 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 AVFilterPicRef
-{
- AVFilterBuffer *pic; ///< the picture that this is a reference to
- uint8_t *data[4]; ///< picture data for each plane
- int linesize[4]; ///< number of bytes per line
- int w; ///< image width
- int h; ///< image height
+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
- int64_t pts; ///< presentation timestamp in units of 1/AV_TIME_BASE
+ /**
+ * 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
- AVRational pixel_aspect; ///< pixel aspect ratio
-
int perms; ///< permissions, see the AV_PERM_* flags
- int interlaced; ///< is frame interlaced
- int top_field_first;
-} AVFilterPicRef;
+ enum AVMediaType type; ///< media type of buffer data
+ AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
+ AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
+} AVFilterBufferRef;
/**
- * Copy properties of src to dst, without copying the actual video
- * data.
+ * Copy properties of src to dst, without copying the actual data
*/
-static inline void avfilter_copy_picref_props(AVFilterPicRef *dst, AVFilterPicRef *src)
+static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src)
{
+ // copy common properties
dst->pts = src->pts;
dst->pos = src->pos;
- dst->pixel_aspect = src->pixel_aspect;
- dst->interlaced = src->interlaced;
- dst->top_field_first = src->top_field_first;
+
+ switch (src->type) {
+ case AVMEDIA_TYPE_VIDEO: *dst->video = *src->video; break;
+ case AVMEDIA_TYPE_AUDIO: *dst->audio = *src->audio; break;
+ }
}
/**
- * Add a new reference to a picture.
- * @param ref an existing reference to the picture
+ * 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 picture with the same properties as the
+ * @return a new reference to the buffer with the same properties as the
* old, excluding any permissions denied by pmask
*/
-AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask);
+AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
/**
- * Remove a reference to a picture. If this is the last reference to the
- * picture, the picture itself is also automatically freed.
- * @param ref reference to the picture
+ * 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_pic(AVFilterPicRef *ref);
+void avfilter_unref_buffer(AVFilterBufferRef *ref);
/**
* A list of supported formats for one end of a filter link. This is used
* get updated as well. Therefore, we have the format list structure store a
* pointer to each of the pointers to itself.
*/
-typedef struct AVFilterFormats AVFilterFormats;
-struct AVFilterFormats
-{
+typedef struct AVFilterFormats {
unsigned format_count; ///< number of formats
int *formats; ///< list of media formats
unsigned refcount; ///< number of references to this list
- AVFilterFormats ***refs; ///< references to this list
-};
+ struct AVFilterFormats ***refs; ///< references to this list
+} AVFilterFormats;
/**
* Create a list of supported formats. This is intended for use in
* AVFilter->query_formats().
+ *
* @param fmts list of media formats, terminated by -1
* @return the format list, with no existing references
*/
int avfilter_add_format(AVFilterFormats **avff, int fmt);
/**
- * Return a list of all formats supported by FFmpeg for the given media type.
+ * Return a list of all formats supported by Libav for the given media type.
*/
AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
/**
* A filter pad used for either input or output.
*/
-struct AVFilterPad
-{
+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
*
* Input video pads only.
*/
- void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
+ void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
/**
- * Callback function to get a buffer. If NULL, the filter system will
+ * Callback function to get a video buffer. If NULL, the filter system will
* use avfilter_default_get_video_buffer().
*
* Input video pads only.
*/
- AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
+ 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,
+ enum AVSampleFormat sample_fmt, int size,
+ int64_t channel_layout, int planar);
/**
* Callback called after the slices of a frame are completely sent. If
*/
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
- * frames. It should return a positive value if the next request_frame()
+ * 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.
};
/** default handler for start_frame() for video inputs */
-void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
+void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
+
/** default handler for draw_slice() for video inputs */
void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
+
/** default handler for end_frame() for video inputs */
void avfilter_default_end_frame(AVFilterLink *link);
-/** default handler for config_props() for video outputs */
+
+/** default handler for filter_samples() for audio inputs */
+void avfilter_default_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
+/** default handler for config_props() for audio/video outputs */
int avfilter_default_config_output_link(AVFilterLink *link);
-/** default handler for config_props() for video inputs */
+
+/** default handler for config_props() for audio/video inputs */
int avfilter_default_config_input_link (AVFilterLink *link);
+
/** default handler for get_video_buffer() for video inputs */
-AVFilterPicRef *avfilter_default_get_video_buffer(AVFilterLink *link,
- int perms, int w, int h);
+AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
+ int perms, int w, int h);
+
+/** default handler for get_audio_buffer() for audio inputs */
+AVFilterBufferRef *avfilter_default_get_audio_buffer(AVFilterLink *link, int perms,
+ enum AVSampleFormat sample_fmt, int size,
+ int64_t channel_layout, int planar);
+
/**
* A helper for query_formats() which sets all links to the same list of
* formats. If there are no links hooked to this filter, the list of formats is
* freed.
*/
void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
+
/** Default handler for query_formats() */
int avfilter_default_query_formats(AVFilterContext *ctx);
/** start_frame() handler for filters which simply pass video along */
-void avfilter_null_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
+void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
/** draw_slice() handler for filters which simply pass video along */
void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
/** end_frame() handler for filters which simply pass video along */
void avfilter_null_end_frame(AVFilterLink *link);
+/** filter_samples() handler for filters which simply pass audio along */
+void avfilter_null_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
/** get_video_buffer() handler for filters which simply pass video along */
-AVFilterPicRef *avfilter_null_get_video_buffer(AVFilterLink *link,
+AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
int perms, int w, int h);
+/** get_audio_buffer() handler for filters which simply pass audio along */
+AVFilterBufferRef *avfilter_null_get_audio_buffer(AVFilterLink *link, int perms,
+ enum AVSampleFormat sample_fmt, int size,
+ int64_t channel_layout, int planar);
+
/**
* Filter definition. This defines the pads a filter contains, and all the
* callback functions used to interact with the filter.
*/
-typedef struct AVFilter
-{
+typedef struct AVFilter {
const char *name; ///< filter name
int priv_size; ///< size of private data to allocate for the filter
/**
* Filter uninitialization function. Should deallocate any memory held
- * by the filter, release any picture references, etc. This does not need
+ * by the filter, release any buffer references, etc. This does not need
* to deallocate the AVFilterContext->priv memory itself.
*/
void (*uninit)(AVFilterContext *ctx);
} AVFilter;
/** An instance of a filter */
-struct AVFilterContext
-{
+struct AVFilterContext {
const AVClass *av_class; ///< needed for av_log()
AVFilter *filter; ///< the AVFilter of which this is an instance
* which have been negotiated and agreed upon between the filter, such as
* image dimensions, format, etc.
*/
-struct AVFilterLink
-{
+struct AVFilterLink {
AVFilterContext *src; ///< source filter
- unsigned int srcpad; ///< index of the output pad on the source filter
+ AVFilterPad *srcpad; ///< output pad on the source filter
AVFilterContext *dst; ///< dest filter
- unsigned int dstpad; ///< index of the input pad on the dest filter
+ AVFilterPad *dstpad; ///< input pad on the dest filter
/** stage of the initialization of the link properties (dimensions, etc) */
enum {
enum AVMediaType type; ///< filter media type
+ /* These parameters apply only to video */
int w; ///< agreed upon image width
int h; ///< agreed upon image height
+ AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
+ /* These two parameters apply only to audio */
+ int64_t channel_layout; ///< channel layout of current buffer (see libavutil/audioconvert.h)
+ int64_t sample_rate; ///< samples per second
+
int format; ///< agreed upon media format
/**
AVFilterFormats *out_formats;
/**
- * The picture reference currently being sent across the link by the source
+ * The buffer reference currently being sent across the link by the source
* filter. This is used internally by the filter system to allow
- * automatic copying of pictures which do not have sufficient permissions
+ * automatic copying of buffers which do not have sufficient permissions
* for the destination. This should not be accessed directly by the
* filters.
*/
- AVFilterPicRef *srcpic;
+ AVFilterBufferRef *src_buf;
+
+ AVFilterBufferRef *cur_buf;
+ AVFilterBufferRef *out_buf;
- AVFilterPicRef *cur_pic;
- AVFilterPicRef *outpic;
+ /**
+ * 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;
};
/**
* Link two filters together.
+ *
* @param src the source filter
* @param srcpad index of the output pad on the source filter
* @param dst the destination filter
/**
* Negotiate the media format, dimensions, etc of all inputs to a filter.
+ *
* @param filter the filter to negotiate the properties for its inputs
* @return zero on successful negotiation
*/
/**
* Request a picture buffer with a specific set of permissions.
- * @param link the output link to the filter from which the picture will
+ *
+ * @param link the output link to the filter from which the buffer will
* be requested
* @param perms the required access permissions
* @param w the minimum width of the buffer to allocate
* @param h the minimum height of the buffer to allocate
- * @return A reference to the picture. This must be unreferenced with
- * avfilter_unref_pic when you are finished with it.
+ * @return A reference to the buffer. This must be unreferenced with
+ * avfilter_unref_buffer when you are finished with it.
*/
-AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
+AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
int w, int h);
+/**
+ * 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);
+
+/**
+ * Request an audio samples buffer with a specific set of permissions.
+ *
+ * @param link the output link to the filter from which the buffer will
+ * be requested
+ * @param perms the required access permissions
+ * @param sample_fmt the format of each sample in the buffer to allocate
+ * @param size the buffer size in bytes
+ * @param channel_layout the number and type of channels per sample in the buffer to allocate
+ * @param planar audio data layout - planar or packed
+ * @return A reference to the samples. This must be unreferenced with
+ * avfilter_unref_buffer when you are finished with it.
+ */
+AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
+ enum AVSampleFormat sample_fmt, int size,
+ int64_t channel_layout, int planar);
+
/**
* Request an input frame from the filter at the other end of the link.
+ *
* @param link the input link
* @return zero on success
*/
/**
* Poll a frame from the filter chain.
+ *
* @param link the input link
* @return the number of immediately available frames, a negative
* number in case of error
/**
* Notifie the next filter of the start of a frame.
+ *
* @param link the output link the frame will be sent over
* @param picref A reference to the frame about to be sent. The data for this
* frame need only be valid once draw_slice() is called for that
* portion. The receiving filter will free this reference when
* it no longer needs it.
*/
-void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
+void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
/**
* Notifie the next filter that the current frame has finished.
+ *
* @param link the output link the frame was sent over
*/
void avfilter_end_frame(AVFilterLink *link);
*/
void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
+/**
+ * Send a buffer of audio samples to the next filter.
+ *
+ * @param link the output link over which the audio samples are being sent
+ * @param samplesref a reference to the buffer of audio samples being sent. The
+ * receiving filter will free this reference when it no longer
+ * needs it or pass it on to the next filter.
+ */
+void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
/** Initialize the filter system. Register all builtin filters. */
void avfilter_register_all(void);
* 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.
+ *
* @param filter the filter to register
* @return 0 if the registration was succesfull, a negative value
* otherwise
/**
* Get a filter definition matching the given name.
+ *
* @param name the filter name to find
* @return the filter definition, if any matching one is registered.
* NULL if none found.
/**
* Create a filter instance.
+ *
+ * @param filter_ctx put here a pointer to the created filter context
+ * on success, NULL on failure
* @param filter the filter to create an instance of
* @param inst_name Name to give to the new instance. Can be NULL for none.
- * @return Pointer to the new instance on success. NULL on failure.
+ * @return >= 0 in case of success, a negative error code otherwise
*/
-AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
+int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
/**
* Initialize a filter.
+ *
* @param filter the filter to initialize
* @param args A string of parameters to use when initializing the filter.
* The format and meaning of this string varies by filter.
int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
/**
- * Destroy a filter.
- * @param filter the filter to destroy
+ * Free a filter context.
+ *
+ * @param filter the filter to free
*/
-void avfilter_destroy(AVFilterContext *filter);
+void avfilter_free(AVFilterContext *filter);
/**
* Insert a filter in the middle of an existing link.
+ *
* @param link the link into which the filter should be inserted
* @param filt the filter to be inserted
- * @param in the input pad on the filter to connect
- * @param out the output pad on the filter to connect
+ * @param filt_srcpad_idx the input pad on the filter to connect
+ * @param filt_dstpad_idx the output pad on the filter to connect
* @return zero on success
*/
int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
- unsigned in, unsigned out);
+ unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
/**
* Insert a new pad.
+ *
* @param idx Insertion point. Pad is inserted at the end if this point
* is beyond the end of the list of pads.
* @param count Pointer to the number of pads in the list
projects / ffmpeg / blobdiff