yading@10: /*
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: #ifndef AVFILTER_INTERNAL_H
yading@10: #define AVFILTER_INTERNAL_H
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * internal API functions
yading@10:  */
yading@10: 
yading@10: #include "avfilter.h"
yading@10: #include "avfiltergraph.h"
yading@10: #include "formats.h"
yading@10: #include "video.h"
yading@10: 
yading@10: #define POOL_SIZE 32
yading@10: typedef struct AVFilterPool {
yading@10:     AVFilterBufferRef *pic[POOL_SIZE];
yading@10:     int count;
yading@10:     int refcount;
yading@10:     int draining;
yading@10: } AVFilterPool;
yading@10: 
yading@10: typedef struct AVFilterCommand {
yading@10:     double time;                ///< time expressed in seconds
yading@10:     char *command;              ///< command
yading@10:     char *arg;                  ///< optional argument for the command
yading@10:     int flags;
yading@10:     struct AVFilterCommand *next;
yading@10: } AVFilterCommand;
yading@10: 
yading@10: /**
yading@10:  * Update the position of a link in the age heap.
yading@10:  */
yading@10: void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
yading@10: 
yading@10: #if !FF_API_AVFILTERPAD_PUBLIC
yading@10: /**
yading@10:  * A filter pad used for either input or output.
yading@10:  */
yading@10: struct AVFilterPad {
yading@10:     /**
yading@10:      * Pad name. The name is unique among inputs and among outputs, but an
yading@10:      * input may have the same name as an output. This may be NULL if this
yading@10:      * pad has no need to ever be referenced by name.
yading@10:      */
yading@10:     const char *name;
yading@10: 
yading@10:     /**
yading@10:      * AVFilterPad type.
yading@10:      */
yading@10:     enum AVMediaType type;
yading@10: 
yading@10:     /**
yading@10:      * Callback function to get a video buffer. If NULL, the filter system will
yading@10:      * use ff_default_get_video_buffer().
yading@10:      *
yading@10:      * Input video pads only.
yading@10:      */
yading@10:     AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
yading@10: 
yading@10:     /**
yading@10:      * Callback function to get an audio buffer. If NULL, the filter system will
yading@10:      * use ff_default_get_audio_buffer().
yading@10:      *
yading@10:      * Input audio pads only.
yading@10:      */
yading@10:     AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
yading@10: 
yading@10:     /**
yading@10:      * Filtering callback. This is where a filter receives a frame with
yading@10:      * audio/video data and should do its processing.
yading@10:      *
yading@10:      * Input pads only.
yading@10:      *
yading@10:      * @return >= 0 on success, a negative AVERROR on error. This function
yading@10:      * must ensure that samplesref is properly unreferenced on error if it
yading@10:      * hasn't been passed on to another filter.
yading@10:      */
yading@10:     int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
yading@10: 
yading@10:     /**
yading@10:      * Frame poll callback. This returns the number of immediately available
yading@10:      * samples. It should return a positive value if the next request_frame()
yading@10:      * is guaranteed to return one frame (with no delay).
yading@10:      *
yading@10:      * Defaults to just calling the source poll_frame() method.
yading@10:      *
yading@10:      * Output pads only.
yading@10:      */
yading@10:     int (*poll_frame)(AVFilterLink *link);
yading@10: 
yading@10:     /**
yading@10:      * Frame request callback. A call to this should result in at least one
yading@10:      * frame being output over the given link. This should return zero on
yading@10:      * success, and another value on error.
yading@10:      *
yading@10:      * Output pads only.
yading@10:      */
yading@10:     int (*request_frame)(AVFilterLink *link);
yading@10: 
yading@10:     /**
yading@10:      * Link configuration callback.
yading@10:      *
yading@10:      * For output pads, this should set the link properties such as
yading@10:      * width/height. This should NOT set the format property - that is
yading@10:      * negotiated between filters by the filter system using the
yading@10:      * query_formats() callback before this function is called.
yading@10:      *
yading@10:      * For input pads, this should check the properties of the link, and update
yading@10:      * the filter's internal state as necessary.
yading@10:      *
yading@10:      * For both input and output filters, this should return zero on success,
yading@10:      * and another value on error.
yading@10:      */
yading@10:     int (*config_props)(AVFilterLink *link);
yading@10: 
yading@10:     /**
yading@10:      * The filter expects a fifo to be inserted on its input link,
yading@10:      * typically because it has a delay.
yading@10:      *
yading@10:      * input pads only.
yading@10:      */
yading@10:     int needs_fifo;
yading@10: };
yading@10: #endif
yading@10: 
yading@10: /** default handler for freeing audio/video buffer when there are no references left */
yading@10: void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
yading@10: 
yading@10: /** Tell is a format is contained in the provided list terminated by -1. */
yading@10: int ff_fmt_is_in(int fmt, const int *fmts);
yading@10: 
yading@10: /**
yading@10:  * Return a copy of a list of integers terminated by -1, or NULL in
yading@10:  * case of copy failure.
yading@10:  */
yading@10: int *ff_copy_int_list(const int * const list);
yading@10: 
yading@10: /**
yading@10:  * Return a copy of a list of 64-bit integers, or NULL in case of
yading@10:  * copy failure.
yading@10:  */
yading@10: int64_t *ff_copy_int64_list(const int64_t * const list);
yading@10: 
yading@10: /* Functions to parse audio format arguments */
yading@10: 
yading@10: /**
yading@10:  * Parse a pixel format.
yading@10:  *
yading@10:  * @param ret pixel format pointer to where the value should be written
yading@10:  * @param arg string to parse
yading@10:  * @param log_ctx log context
yading@10:  * @return 0 in case of success, a negative AVERROR code on error
yading@10:  */
yading@10: int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
yading@10: 
yading@10: /**
yading@10:  * Parse a sample rate.
yading@10:  *
yading@10:  * @param ret unsigned integer pointer to where the value should be written
yading@10:  * @param arg string to parse
yading@10:  * @param log_ctx log context
yading@10:  * @return 0 in case of success, a negative AVERROR code on error
yading@10:  */
yading@10: int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
yading@10: 
yading@10: /**
yading@10:  * Parse a time base.
yading@10:  *
yading@10:  * @param ret unsigned AVRational pointer to where the value should be written
yading@10:  * @param arg string to parse
yading@10:  * @param log_ctx log context
yading@10:  * @return 0 in case of success, a negative AVERROR code on error
yading@10:  */
yading@10: int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
yading@10: 
yading@10: /**
yading@10:  * Parse a sample format name or a corresponding integer representation.
yading@10:  *
yading@10:  * @param ret integer pointer to where the value should be written
yading@10:  * @param arg string to parse
yading@10:  * @param log_ctx log context
yading@10:  * @return 0 in case of success, a negative AVERROR code on error
yading@10:  */
yading@10: int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
yading@10: 
yading@10: /**
yading@10:  * Parse a channel layout or a corresponding integer representation.
yading@10:  *
yading@10:  * @param ret 64bit integer pointer to where the value should be written.
yading@10:  * @param arg string to parse
yading@10:  * @param log_ctx log context
yading@10:  * @return 0 in case of success, a negative AVERROR code on error
yading@10:  */
yading@10: int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
yading@10: 
yading@10: void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
yading@10: 
yading@10: void ff_command_queue_pop(AVFilterContext *filter);
yading@10: 
yading@10: /* misc trace functions */
yading@10: 
yading@10: /* #define FF_AVFILTER_TRACE */
yading@10: 
yading@10: #ifdef FF_AVFILTER_TRACE
yading@10: #    define ff_tlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
yading@10: #else
yading@10: #    define ff_tlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
yading@10: #endif
yading@10: 
yading@10: #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
yading@10: 
yading@10: char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
yading@10: 
yading@10: void ff_tlog_ref(void *ctx, AVFrame *ref, int end);
yading@10: 
yading@10: void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
yading@10: 
yading@10: /**
yading@10:  * Insert a new pad.
yading@10:  *
yading@10:  * @param idx Insertion point. Pad is inserted at the end if this point
yading@10:  *            is beyond the end of the list of pads.
yading@10:  * @param count Pointer to the number of pads in the list
yading@10:  * @param padidx_off Offset within an AVFilterLink structure to the element
yading@10:  *                   to increment when inserting a new pad causes link
yading@10:  *                   numbering to change
yading@10:  * @param pads Pointer to the pointer to the beginning of the list of pads
yading@10:  * @param links Pointer to the pointer to the beginning of the list of links
yading@10:  * @param newpad The new pad to add. A copy is made when adding.
yading@10:  */
yading@10: void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
yading@10:                    AVFilterPad **pads, AVFilterLink ***links,
yading@10:                    AVFilterPad *newpad);
yading@10: 
yading@10: /** Insert a new input pad for the filter. */
yading@10: static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
yading@10:                                    AVFilterPad *p)
yading@10: {
yading@10:     ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
yading@10:                   &f->input_pads, &f->inputs, p);
yading@10: #if FF_API_FOO_COUNT
yading@10:     f->input_count = f->nb_inputs;
yading@10: #endif
yading@10: }
yading@10: 
yading@10: /** Insert a new output pad for the filter. */
yading@10: static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
yading@10:                                     AVFilterPad *p)
yading@10: {
yading@10:     ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
yading@10:                   &f->output_pads, &f->outputs, p);
yading@10: #if FF_API_FOO_COUNT
yading@10:     f->output_count = f->nb_outputs;
yading@10: #endif
yading@10: }
yading@10: 
yading@10: /**
yading@10:  * Poll a frame from the filter chain.
yading@10:  *
yading@10:  * @param  link the input link
yading@10:  * @return the number of immediately available frames, a negative
yading@10:  * number in case of error
yading@10:  */
yading@10: int ff_poll_frame(AVFilterLink *link);
yading@10: 
yading@10: /**
yading@10:  * Request an input frame from the filter at the other end of the link.
yading@10:  *
yading@10:  * @param link the input link
yading@10:  * @return     zero on success
yading@10:  */
yading@10: int ff_request_frame(AVFilterLink *link);
yading@10: 
yading@10: #define AVFILTER_DEFINE_CLASS(fname)            \
yading@10:     static const AVClass fname##_class = {      \
yading@10:         .class_name = #fname,                   \
yading@10:         .item_name  = av_default_item_name,     \
yading@10:         .option     = fname##_options,          \
yading@10:         .version    = LIBAVUTIL_VERSION_INT,    \
yading@10:         .category   = AV_CLASS_CATEGORY_FILTER, \
yading@10:     }
yading@10: 
yading@10: AVFilterBufferRef *ff_copy_buffer_ref(AVFilterLink *outlink,
yading@10:                                       AVFilterBufferRef *ref);
yading@10: 
yading@10: /**
yading@10:  * Find the index of a link.
yading@10:  *
yading@10:  * I.e. find i such that link == ctx->(in|out)puts[i]
yading@10:  */
yading@10: #define FF_INLINK_IDX(link)  ((int)((link)->dstpad - (link)->dst->input_pads))
yading@10: #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
yading@10: 
yading@10: int ff_buffersink_read_compat(AVFilterContext *ctx, AVFilterBufferRef **buf);
yading@10: int ff_buffersink_read_samples_compat(AVFilterContext *ctx, AVFilterBufferRef **pbuf,
yading@10:                                       int nb_samples);
yading@10: /**
yading@10:  * Send a frame of data to the next filter.
yading@10:  *
yading@10:  * @param link   the output link over which the data is being sent
yading@10:  * @param frame a reference to the buffer of data being sent. The
yading@10:  *              receiving filter will free this reference when it no longer
yading@10:  *              needs it or pass it on to the next filter.
yading@10:  *
yading@10:  * @return >= 0 on success, a negative AVERROR on error. The receiving filter
yading@10:  * is responsible for unreferencing frame in case of error.
yading@10:  */
yading@10: int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
yading@10: 
yading@10: /**
yading@10:  * Flags for AVFilterLink.flags.
yading@10:  */
yading@10: enum {
yading@10: 
yading@10:     /**
yading@10:      * Frame requests may need to loop in order to be fulfilled.
yading@10:      * A filter must set this flags on an output link if it may return 0 in
yading@10:      * request_frame() without filtering a frame.
yading@10:      */
yading@10:     FF_LINK_FLAG_REQUEST_LOOP = 1,
yading@10: 
yading@10: };
yading@10: 
yading@10: /**
yading@10:  * Allocate a new filter context and return it.
yading@10:  *
yading@10:  * @param filter what filter to create an instance of
yading@10:  * @param inst_name name to give to the new filter context
yading@10:  *
yading@10:  * @return newly created filter context or NULL on failure
yading@10:  */
yading@10: AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
yading@10: 
yading@10: /**
yading@10:  * Remove a filter from a graph;
yading@10:  */
yading@10: void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter);
yading@10: 
yading@10: #endif /* AVFILTER_INTERNAL_H */