#ifndef AVFILTER_AVFILTER_H
#define AVFILTER_AVFILTER_H
+#include "libavutil/avutil.h"
+
#define LIBAVFILTER_VERSION_MAJOR 1
-#define LIBAVFILTER_VERSION_MINOR 0
-#define LIBAVFILTER_VERSION_MICRO 1
+#define LIBAVFILTER_VERSION_MINOR 29
+#define LIBAVFILTER_VERSION_MICRO 0
#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
LIBAVFILTER_VERSION_MINOR, \
#include "libavcodec/avcodec.h"
/**
- * Returns the LIBAVFILTER_VERSION_INT constant.
+ * 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;
-/* TODO: look for other flags which may be useful in this structure (interlace
- * flags, etc)
- */
/**
- * A reference-counted picture data type used by the filter system. Filters
+ * 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 AVFilterPic
+typedef struct AVFilterBuffer
{
- uint8_t *data[4]; ///< picture data for each plane
- int linesize[4]; ///< number of bytes per line
- enum PixelFormat format; ///< colorspace
+ 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 image
+ 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 image if the default
+ * 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 AVFilterPic *pic);
+ void (*free)(struct AVFilterBuffer *buf);
+} AVFilterBuffer;
- int w, h; ///< width and height of the allocated buffer
-} AVFilterPic;
+#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
/**
- * A reference to an AVFilterPic. Since filters can manipulate the origin of
+ * 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
* 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
+typedef struct AVFilterBufferRef
{
- AVFilterPic *pic; ///< the picture that this is a reference to
+ 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
+ int format; ///< media format
int64_t pts; ///< presentation timestamp in units of 1/AV_TIME_BASE
+ int64_t pos; ///< byte position in stream, -1 if unknown
AVRational pixel_aspect; ///< pixel aspect ratio
- int perms; ///< permissions
-#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
-} AVFilterPicRef;
+ int perms; ///< permissions, see the AV_PERM_* flags
+
+ int interlaced; ///< is frame interlaced
+ int top_field_first;
+} AVFilterBufferRef;
/**
- * Adds a new reference to a picture.
+ * Copy properties of src to dst, without copying the actual video
+ * data.
+ */
+static inline void avfilter_copy_picref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src)
+{
+ 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;
+ dst->w = src->w;
+ dst->h = src->h;
+}
+
+/**
+ * Add a new reference to a picture.
* @param ref an existing reference to the picture
* @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
* old, excluding any permissions denied by pmask
*/
-AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask);
+AVFilterBufferRef *avfilter_ref_pic(AVFilterBufferRef *ref, int pmask);
/**
- * Removes a reference to a picture. If this is the last reference to the
+ * 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
*/
-void avfilter_unref_pic(AVFilterPicRef *ref);
+void avfilter_unref_pic(AVFilterBufferRef *ref);
/**
* A list of supported formats for one end of a filter link. This is used
struct AVFilterFormats
{
unsigned format_count; ///< number of formats
- enum PixelFormat *formats; ///< list of pixel formats
+ int *formats; ///< list of media formats
unsigned refcount; ///< number of references to this list
AVFilterFormats ***refs; ///< references to this list
};
/**
- * Helper function to create a list of supported formats. This is intended
- * for use in AVFilter->query_formats().
- * @param len the number of formats supported
- * @param ... a list of the supported formats
- * @return the format list, with no existing references
+ * 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
*/
-AVFilterFormats *avfilter_make_format_list(int len, ...);
+AVFilterFormats *avfilter_make_format_list(const int *fmts);
/**
- * Returns a list of all colorspaces supported by FFmpeg.
+ * Add fmt to the list of media formats contained in *avff.
+ * If *avff is NULL the function allocates the filter formats struct
+ * and puts its pointer in *avff.
+ *
+ * @return a non negative value in case of success, or a negative
+ * value corresponding to an AVERROR code in case of error
*/
-AVFilterFormats *avfilter_all_colorspaces(void);
+int avfilter_add_format(AVFilterFormats **avff, int fmt);
/**
- * Returns a format list which contains the intersection of the formats of
+ * Return a list of all formats supported by FFmpeg for the given media type.
+ */
+AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
+
+/**
+ * Return a format list which contains the intersection of the formats of
* a and b. Also, all the references of a, all the references of b, and
* a and b themselves will be deallocated.
*
AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
/**
- * Adds *ref as a new reference to formats.
+ * Add *ref as a new reference to formats.
* That is the pointers will point like in the ascii art below:
* ________
* |formats |<--------.
void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
/**
- * Removes *ref as a reference to the format list it currently points to,
- * deallocates that list if this was the last reference, and sets *ref to NULL.
+ * If *ref is non-NULL, remove *ref as a reference to the format list
+ * it currently points to, deallocates that list if this was the last
+ * reference, and sets *ref to NULL.
*
* Before After
* ________ ________ NULL
* AVFilterPad type. Only video supported now, hopefully someone will
* add audio in the future.
*/
- enum CodecType type;
+ enum AVMediaType type;
/**
* Minimum required permissions on incoming buffers. Any buffer with
*
* 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
- * handle buffer requests.
+ * 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 called after the slices of a frame are completely sent. If
*
* Input video pads only.
*/
- void (*draw_slice)(AVFilterLink *link, int y, int height);
+ void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
/**
* Frame poll callback. This returns the number of immediately available
};
/** 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);
+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 config_props() for 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,
+AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
int perms, int w, int h);
/**
* A helper for query_formats() which sets all links to the same list of
/** 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, 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);
+
+/** get_video_buffer() handler for filters which simply pass video along */
+AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
+ int perms, int w, int h);
+
/**
* Filter definition. This defines the pads a filter contains, and all the
* callback functions used to interact with the filter.
*/
-typedef struct
+typedef struct AVFilter
{
const char *name; ///< filter name
void (*uninit)(AVFilterContext *ctx);
/**
- * Query formats supported by the filter and its pads. Should set the
+ * 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.
*
- * Should return zero on success.
+ * @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 */
AVLINK_INIT ///< complete
} init_state;
+ enum AVMediaType type; ///< filter media type
+
int w; ///< agreed upon image width
int h; ///< agreed upon image height
- enum PixelFormat format; ///< agreed upon image colorspace
+ int format; ///< agreed upon media format
/**
* Lists of formats supported by the input and output filters respectively.
* for the destination. This should not be accessed directly by the
* filters.
*/
- AVFilterPicRef *srcpic;
+ AVFilterBufferRef *srcpic;
- AVFilterPicRef *cur_pic;
- AVFilterPicRef *outpic;
+ AVFilterBufferRef *cur_pic;
+ AVFilterBufferRef *outpic;
};
/**
- * Links two filters together.
+ * 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
AVFilterContext *dst, unsigned dstpad);
/**
- * Negotiates the colorspace, dimensions, etc of all inputs to a 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
*/
int avfilter_config_links(AVFilterContext *filter);
/**
- * Requests a picture buffer with a specific set of permissions.
+ * Request a picture buffer with a specific set of permissions.
* @param link the output link to the filter from which the picture will
* be requested
* @param perms the required access permissions
* @return A reference to the picture. This must be unreferenced with
* avfilter_unref_pic 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);
/**
- * Requests an input frame from the filter at the other end of the link.
+ * Request an input frame from the filter at the other end of the link.
* @param link the input link
* @return zero on success
*/
int avfilter_request_frame(AVFilterLink *link);
/**
- * Polls a frame from the filter chain.
+ * 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
int avfilter_poll_frame(AVFilterLink *link);
/**
- * Notifies the next filter of the start of a frame.
+ * 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);
/**
- * Notifies the next filter that the current frame has finished.
+ * 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);
/**
- * Sends a slice to the next filter.
+ * Send a slice to the next filter.
+ *
+ * Slices have to be provided in sequential order, either in
+ * top-bottom or bottom-top order. If slices are provided in
+ * non-sequential order the behavior of the function is undefined.
+ *
* @param link the output link over which the frame is being sent
* @param y offset in pixels from the top of the image for this slice
* @param h height of this slice in pixels
+ * @param slice_dir the assumed direction for sending slices,
+ * from the top slice to the bottom slice if the value is 1,
+ * from the bottom slice to the top slice if the value is -1,
+ * for other values the behavior of the function is undefined.
*/
-void avfilter_draw_slice(AVFilterLink *link, int y, int h);
+void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
-/** Initialize the filter system. Registers all builtin filters */
+/** Initialize the filter system. Register all builtin filters. */
void avfilter_register_all(void);
-/** Uninitialize the filter system. Unregisters all filters */
+/** Uninitialize the filter system. Unregister all filters. */
void avfilter_uninit(void);
/**
- * Registers a filter. This is only needed if you plan to use
+ * Register a filter. This is only needed if you plan to use
* 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
*/
-void avfilter_register(AVFilter *filter);
+int avfilter_register(AVFilter *filter);
/**
- * Gets a filter definition matching the given name.
+ * 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.
AVFilter *avfilter_get_by_name(const char *name);
/**
- * Creates a filter instance.
+ * 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);
+
+/**
+ * Create a filter instance.
* @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.
AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
/**
- * Initializes a filter.
+ * 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);
/**
- * Destroys a filter.
+ * Destroy a filter.
* @param filter the filter to destroy
*/
void avfilter_destroy(AVFilterContext *filter);
/**
- * Inserts a filter in the middle of an existing link.
+ * 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
unsigned in, unsigned out);
/**
- * Inserts a new pad.
+ * 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
AVFilterPad **pads, AVFilterLink ***links,
AVFilterPad *newpad);
-/** Inserts a new input pad for the filter. */
+/** Insert a new input pad for the filter. */
static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
AVFilterPad *p)
{
&f->input_pads, &f->inputs, p);
}
-/** Inserts a new output pad for the filter. */
+/** Insert a new output pad for the filter. */
static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
AVFilterPad *p)
{
projects / ffmpeg / blobdiff