#ifndef AVFILTER_AVFILTER_H
#define AVFILTER_AVFILTER_H
-#define LIBAVFILTER_VERSION_MAJOR 0
-#define LIBAVFILTER_VERSION_MINOR 5
+#include "libavutil/avutil.h"
+
+#define LIBAVFILTER_VERSION_MAJOR 1
+#define LIBAVFILTER_VERSION_MINOR 13
#define LIBAVFILTER_VERSION_MICRO 0
#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
*/
unsigned avfilter_version(void);
+/**
+ * Returns the libavfilter build-time configuration.
+ */
+const char *avfilter_configuration(void);
+
+/**
+ * Returns the libavfilter license.
+ */
+const char *avfilter_license(void);
+
+
typedef struct AVFilterContext AVFilterContext;
typedef struct AVFilterLink AVFilterLink;
typedef struct AVFilterPad AVFilterPad;
* flags, etc)
*/
/**
- * A reference-counted picture data type used by the filter system. Filters
+ * A reference-counted picture data type used by the filter system. Filters
* should not store pointers to this structure directly, but instead use the
* AVFilterPicRef structure below.
*/
void *priv;
/**
* A pointer to the function to deallocate this image if the default
- * function is not sufficient. This could, for example, add the memory
+ * 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);
+
+ int w, h; ///< width and height of the allocated buffer
} AVFilterPic;
/**
- * A reference to an AVFilterPic. Since filters can manipulate the origin of
+ * A reference to an AVFilterPic. 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
+ * 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
struct AVFilterFormats
{
unsigned format_count; ///< number of formats
- int *formats; ///< list of formats
+ enum PixelFormat *formats; ///< list of pixel 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
+ * Creates a list of supported formats. This is intended for use in
+ * AVFilter->query_formats().
+ * @param pix_fmt list of pixel formats, terminated by PIX_FMT_NONE
+ * @return the format list, with no existing references
*/
-AVFilterFormats *avfilter_make_format_list(int len, ...);
+AVFilterFormats *avfilter_make_format_list(const enum PixelFormat *pix_fmts);
+
+/**
+ * Adds pix_fmt to the list of pixel formats contained in avff.
+ *
+ * @return a non negative value in case of success, or a negative
+ * value corresponding to an AVERROR code in case of error
+ */
+int avfilter_add_colorspace(AVFilterFormats *avff, enum PixelFormat pix_fmt);
/**
* Returns a list of all colorspaces supported by FFmpeg.
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 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. Only video supported now, hopefully someone will
+ * AVFilterPad type. Only video supported now, hopefully someone will
* add audio in the future.
*/
enum CodecType type;
/**
- * Minimum required permissions on incoming buffers. Any buffer with
+ * 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.
*
int min_perms;
/**
- * Permissions which are not accepted on incoming buffers. Any buffer
+ * 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
+ * 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
+ * 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.
*
void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
/**
- * Callback function to get a buffer. If NULL, the filter system will
- * handle buffer requests.
+ * Callback function to get a 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);
+ AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
/**
- * Callback called after the slices of a frame are completely sent. If
+ * 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().
*
void (*end_frame)(AVFilterLink *link);
/**
- * Slice drawing callback. This is where a filter receives video data
+ * 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);
+ void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
/**
- * Frame poll callback. This returns the number of immediately available
+ * Frame poll callback. This returns the number of immediately available
* frames. It should return a positive value if the next request_frame()
* is guaranteed to return one frame (with no delay).
*
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
+ * 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 video pads only.
* 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
+ * 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.
*
/** default handler for start_frame() for video inputs */
void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *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 */
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 perms, int w, int h);
/**
* 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
int avfilter_default_query_formats(AVFilterContext *ctx);
/**
- * Filter definition. This defines the pads a filter contains, and all the
+ * 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
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?
+ * 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 picture references, etc. This does not need
+ * Filter uninitialization function. Should deallocate any memory held
+ * by the filter, release any picture references, etc. This does not need
* to deallocate the AVFilterContext->priv memory itself.
*/
void (*uninit)(AVFilterContext *ctx);
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 */
};
/**
- * A link between two filters. This contains pointers to the source and
+ * A link between two filters. This contains pointers to the source and
* destination filters between which this link exists, and the indexes of
- * the pads involved. In addition, this link also contains the parameters
+ * the pads involved. In addition, this link also contains the parameters
* which have been negotiated and agreed upon between the filter, such as
* image dimensions, format, etc.
*/
/**
* The picture reference currently being sent across the link by the source
- * filter. This is used internally by the filter system to allow
+ * filter. This is used internally by the filter system to allow
* automatic copying of pictures which do not have sufficient permissions
- * for the destination. This should not be accessed directly by the
+ * for the destination. This should not be accessed directly by the
* filters.
*/
AVFilterPicRef *srcpic;
* @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
+ * @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.
*/
-AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
+AVFilterPicRef *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.
/**
* Notifies 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
+ * @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
+ * portion. The receiving filter will free this reference when
* it no longer needs it.
*/
void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
/**
* Sends 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 */
+/** Initializes the filter system. Registers all builtin filters. */
void avfilter_register_all(void);
-/** Uninitialize the filter system. Unregisters all filters */
+/** Uninitializes the filter system. Unregisters all filters. */
void avfilter_uninit(void);
/**
* 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.
*/
AVFilter *avfilter_get_by_name(const char *name);
+/**
+ * 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);
+
/**
* Creates 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.
+ * @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);
* @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.
- * @param opaque Any extra non-string data needed by the filter. The meaning
+ * @param opaque Any extra non-string data needed by the filter. The meaning
* of this parameter varies by filter.
* @return zero on success
*/
/**
* Inserts a new pad.
- * @param idx Insertion point. Pad is inserted at the end if this point
+ * @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
* @param padidx_off Offset within an AVFilterLink structure to the element
projects / ffmpeg / blobdiff