X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavfilter%2Favfilter.h;h=832f421beeed2f091f31e46c5df171b881cbfd4e;hb=006aa1a4c2307209ad11c3ad0ad1d888c8df98fe;hp=af12880bfbe3ebffb841fdccd527c2690060b136;hpb=0155b1a1cc611d9f082d017d2afb9a0e63b87c6e;p=ffmpeg diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h index af12880bfbe..832f421beee 100644 --- a/libavfilter/avfilter.h +++ b/libavfilter/avfilter.h @@ -19,11 +19,41 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef FFMPEG_AVFILTER_H -#define FFMPEG_AVFILTER_H +#ifndef AVFILTER_AVFILTER_H +#define AVFILTER_AVFILTER_H + +#include "libavutil/avutil.h" + +#define LIBAVFILTER_VERSION_MAJOR 1 +#define LIBAVFILTER_VERSION_MINOR 17 +#define LIBAVFILTER_VERSION_MICRO 0 + +#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \ + LIBAVFILTER_VERSION_MINOR, \ + LIBAVFILTER_VERSION_MICRO) +#define LIBAVFILTER_VERSION AV_VERSION(LIBAVFILTER_VERSION_MAJOR, \ + LIBAVFILTER_VERSION_MINOR, \ + LIBAVFILTER_VERSION_MICRO) +#define LIBAVFILTER_BUILD LIBAVFILTER_VERSION_INT #include -#include "avcodec.h" +#include "libavcodec/avcodec.h" + +/** + * Returns the LIBAVFILTER_VERSION_INT constant. + */ +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; @@ -33,7 +63,7 @@ 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. */ @@ -49,17 +79,19 @@ typedef struct AVFilterPic 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 @@ -85,7 +117,7 @@ typedef struct AVFilterPicRef } AVFilterPicRef; /** - * Add a new reference to a picture. + * Adds 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 @@ -95,7 +127,7 @@ typedef struct AVFilterPicRef AVFilterPicRef *avfilter_ref_pic(AVFilterPicRef *ref, int pmask); /** - * Remove a reference to a picture. If this is the last reference to the + * Removes 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 */ @@ -108,7 +140,7 @@ void avfilter_unref_pic(AVFilterPicRef *ref); * list of the formats supported by each input and output pad. The list * given for each pad need not be distinct - they may be references to the * same list of formats, as is often the case when a filter supports multiple - * formats, but will always outut the same format as it is given in input. + * formats, but will always output the same format as it is given in input. * * In this way, a list of possible input formats and a list of possible * output formats are associated with each link. When a set of formats is @@ -145,20 +177,29 @@ typedef struct AVFilterFormats AVFilterFormats; 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. + * 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 + */ +int avfilter_add_colorspace(AVFilterFormats **avff, enum PixelFormat pix_fmt); /** * Returns a list of all colorspaces supported by FFmpeg. @@ -166,45 +207,82 @@ AVFilterFormats *avfilter_make_format_list(int len, ...); AVFilterFormats *avfilter_all_colorspaces(void); /** - * If a and b share at least one common format, they are merged into a new - * format list which is returned. All the references to a and b are updated - * to point to this new list, and a and b are deallocated. + * Returns 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. * * If a and b do not share any common formats, neither is modified, and NULL * is returned. */ AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b); -/** Adds *ref as a new reference to f */ -void avfilter_formats_ref(AVFilterFormats *f, AVFilterFormats **ref); +/** + * Adds *ref as a new reference to formats. + * That is the pointers will point like in the ascii art below: + * ________ + * |formats |<--------. + * | ____ | ____|___________________ + * | |refs| | | __|_ + * | |* * | | | | | | AVFilterLink + * | |* *--------->|*ref| + * | |____| | | |____| + * |________| |________________________ + */ +void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref); /** - * Remove *ref as a reference to the format list it currently points to, - * deallocate that list if this was the last reference, and set *ref to NULL. + * If *ref is non-NULL, 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. + * + * Before After + * ________ ________ NULL + * |formats |<--------. |formats | ^ + * | ____ | ____|________________ | ____ | ____|________________ + * | |refs| | | __|_ | |refs| | | __|_ + * | |* * | | | | | | AVFilterLink | |* * | | | | | | AVFilterLink + * | |* *--------->|*ref| | |* | | | |*ref| + * | |____| | | |____| | |____| | | |____| + * |________| |_____________________ |________| |_____________________ */ void avfilter_formats_unref(AVFilterFormats **ref); +/** + * + * Before After + * ________ ________ + * |formats |<---------. |formats |<---------. + * | ____ | ___|___ | ____ | ___|___ + * | |refs| | | | | | |refs| | | | | NULL + * | |* *--------->|*oldref| | |* *--------->|*newref| ^ + * | |* * | | |_______| | |* * | | |_______| ___|___ + * | |____| | | |____| | | | | + * |________| |________| |*oldref| + * |_______| + */ +void avfilter_formats_changeref(AVFilterFormats **oldref, + AVFilterFormats **newref); + /** * A filter pad used for either input or output. */ 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. */ - int type; -#define AV_PAD_VIDEO 0 ///< video pad + enum CodecType type; /** - * Minimum required permissions on incoming buffers. Any buffers 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. * @@ -213,17 +291,18 @@ struct AVFilterPad int min_perms; /** - * Permissions which are not accepted on incoming buffers. Any buffer - * which has any of these permissions set 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. + * 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 + * 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. * @@ -232,15 +311,15 @@ struct AVFilterPad 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(). * @@ -249,15 +328,15 @@ struct AVFilterPad 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). * @@ -268,8 +347,8 @@ struct AVFilterPad 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. @@ -280,7 +359,7 @@ struct AVFilterPad * 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. * @@ -293,17 +372,19 @@ struct AVFilterPad int (*config_props)(AVFilterLink *link); }; -/** Default handler for start_frame() for video inputs */ +/** default handler for start_frame() for video inputs */ void avfilter_default_start_frame(AVFilterLink *link, AVFilterPicRef *picref); -/** Default handler for end_frame() for video inputs */ +/** 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 config_props() for video outputs */ int avfilter_default_config_output_link(AVFilterLink *link); -/** Default handler for config_props() for video inputs */ +/** 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 */ +/** 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 @@ -313,52 +394,55 @@ void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats) /** Default handler for query_formats() */ int avfilter_default_query_formats(AVFilterContext *ctx); -void avfilter_formats_changeref(AVFilterFormats **oldref, - AVFilterFormats **newref); - /** - * 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 - const char *author; ///< filter author 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); /** - * 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 */ struct AVFilterContext { - AVClass *av_class; ///< needed for av_log() + const AVClass *av_class; ///< needed for av_log() AVFilter *filter; ///< the AVFilter of which this is an instance @@ -376,11 +460,11 @@ struct AVFilterContext }; /** - * A link between two filters. This contains pointers to the source and - * destination filters between which this link exists, and the indices of - * the pads involved. In addition, this link also contains the parameters + * 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 * which have been negotiated and agreed upon between the filter, such as - * image dimensions, format, etc + * image dimensions, format, etc. */ struct AVFilterLink { @@ -411,9 +495,9 @@ struct AVFilterLink /** * 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; @@ -423,7 +507,7 @@ struct AVFilterLink }; /** - * Link two filters together. + * Links two filters together. * @param src the source filter * @param srcpad index of the output pad on the source filter * @param dst the destination filter @@ -434,74 +518,89 @@ int avfilter_link(AVFilterContext *src, unsigned srcpad, AVFilterContext *dst, unsigned dstpad); /** - * Negotiate the colorspace, dimensions, etc of all inputs to a filter. + * Negotiates the colorspace, 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); /** - * Request a picture buffer with a specific set of permissions + * Requests 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 + * @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); /** - * Request an input frame from the filter at the other end of the link. + * Requests 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); /** - * Poll a frame from the filter chain. + * Polls a frame from the filter chain. * @param link the input link - * @return the number of imediately available frames + * @return the number of immediately available frames, a negative + * number in case of error */ int avfilter_poll_frame(AVFilterLink *link); /** - * Notify the next filter of the start of a frame. + * 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); /** - * Notify the next filter that the current frame has finished + * Notifies 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); /** - * Send a slice to the next filter. + * 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 */ -void avfilter_init(void); +/** 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); /** - * Register a filter. This is only needed if you plan to use + * Registers 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. @@ -512,32 +611,40 @@ void avfilter_register(AVFilter *filter); AVFilter *avfilter_get_by_name(const char *name); /** - * Create 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); + +/** + * 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); /** - * Initialize a filter. + * Initializes 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. - * @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 */ int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque); /** - * Destroy a filter. + * Destroys a filter. * @param filter the filter to destroy */ void avfilter_destroy(AVFilterContext *filter); /** - * Insert a filter in the middle of an existing link. + * Inserts 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 @@ -548,8 +655,8 @@ int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt, unsigned in, unsigned out); /** - * Insert a new pad. - * @param idx Insertion point. Pad is inserted at the end if this point + * Inserts 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 * @param padidx_off Offset within an AVFilterLink structure to the element @@ -563,7 +670,7 @@ void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off, AVFilterPad **pads, AVFilterLink ***links, AVFilterPad *newpad); -/** insert a new input pad for the filter */ +/** Inserts a new input pad for the filter. */ static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index, AVFilterPad *p) { @@ -571,7 +678,7 @@ static inline void avfilter_insert_inpad(AVFilterContext *f, unsigned index, &f->input_pads, &f->inputs, p); } -/** insert a new output pad for the filter */ +/** Inserts a new output pad for the filter. */ static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index, AVFilterPad *p) { @@ -579,4 +686,4 @@ static inline void avfilter_insert_outpad(AVFilterContext *f, unsigned index, &f->output_pads, &f->outputs, p); } -#endif /* FFMPEG_AVFILTER_H */ +#endif /* AVFILTER_AVFILTER_H */