FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Functions
internal.h File Reference

internal API functions More...

#include "libavutil/internal.h"
#include "avfilter.h"
#include "avfiltergraph.h"
#include "formats.h"
#include "framepool.h"
#include "thread.h"
#include "version.h"
#include "video.h"
#include "libavcodec/avcodec.h"

Go to the source code of this file.

Data Structures

struct  AVFilterCommand
 
struct  AVFilterPad
 A filter pad used for either input or output. More...
 
struct  AVFilterGraphInternal
 
struct  AVFilterInternal
 

Macros

#define ff_tlog(pctx,...)   do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 
#define FF_TPRINTF_START(ctx, func)   ff_tlog(NULL, "%-16s: ", #func)
 
#define AVFILTER_DEFINE_CLASS(fname)
 
#define FF_INLINK_IDX(link)   ((int)((link)->dstpad - (link)->dst->input_pads))
 Find the index of a link. More...
 
#define FF_OUTLINK_IDX(link)   ((int)((link)->srcpad - (link)->src->output_pads))
 

Functions

void ff_avfilter_graph_update_heap (AVFilterGraph *graph, AVFilterLink *link)
 Update the position of a link in the age heap. More...
 
int ff_fmt_is_in (int fmt, const int *fmts)
 Tell if an integer is contained in the provided -1-terminated list of integers. More...
 
av_warn_unused_result int ff_parse_pixel_format (enum AVPixelFormat *ret, const char *arg, void *log_ctx)
 Parse a pixel format. More...
 
av_warn_unused_result int ff_parse_sample_rate (int *ret, const char *arg, void *log_ctx)
 Parse a sample rate. More...
 
av_warn_unused_result int ff_parse_time_base (AVRational *ret, const char *arg, void *log_ctx)
 Parse a time base. More...
 
av_warn_unused_result int ff_parse_sample_format (int *ret, const char *arg, void *log_ctx)
 Parse a sample format name or a corresponding integer representation. More...
 
av_warn_unused_result int ff_parse_channel_layout (int64_t *ret, int *nret, const char *arg, void *log_ctx)
 Parse a channel layout or a corresponding integer representation. More...
 
void ff_update_link_current_pts (AVFilterLink *link, int64_t pts)
 
void ff_avfilter_link_set_in_status (AVFilterLink *link, int status, int64_t pts)
 Set the status field of a link from the source filter. More...
 
void ff_avfilter_link_set_out_status (AVFilterLink *link, int status, int64_t pts)
 Set the status field of a link from the destination filter. More...
 
void ff_command_queue_pop (AVFilterContext *filter)
 
char * ff_get_ref_perms_string (char *buf, size_t buf_size, int perms)
 
void ff_tlog_ref (void *ctx, AVFrame *ref, int end)
 
void ff_tlog_link (void *ctx, AVFilterLink *link, int end)
 
int ff_insert_pad (unsigned idx, unsigned *count, size_t padidx_off, AVFilterPad **pads, AVFilterLink ***links, AVFilterPad *newpad)
 Insert a new pad. More...
 
static int ff_insert_inpad (AVFilterContext *f, unsigned index, AVFilterPad *p)
 Insert a new input pad for the filter. More...
 
static int ff_insert_outpad (AVFilterContext *f, unsigned index, AVFilterPad *p)
 Insert a new output pad for the filter. More...
 
int ff_poll_frame (AVFilterLink *link)
 Poll a frame from the filter chain. More...
 
int ff_request_frame (AVFilterLink *link)
 Request an input frame from the filter at the other end of the link. More...
 
int ff_request_frame_to_filter (AVFilterLink *link)
 
int ff_filter_frame (AVFilterLink *link, AVFrame *frame)
 Send a frame of data to the next filter. More...
 
AVFilterContextff_filter_alloc (const AVFilter *filter, const char *inst_name)
 Allocate a new filter context and return it. More...
 
void ff_filter_graph_remove_filter (AVFilterGraph *graph, AVFilterContext *filter)
 Remove a filter from a graph;. More...
 
int ff_filter_graph_run_once (AVFilterGraph *graph)
 Run one round of processing on a filter graph. More...
 
static int ff_norm_qscale (int qscale, int type)
 Normalize the qscale factor FIXME the H264 qscale is a log based scale, mpeg1/2 is not, the code below cannot be optimal. More...
 
int ff_filter_get_nb_threads (AVFilterContext *ctx)
 Get number of threads for current filter instance. More...
 

Detailed Description

internal API functions

Definition in file internal.h.

Macro Definition Documentation

#define ff_tlog (   pctx,
  ... 
)    do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)

Definition at line 253 of file internal.h.

#define FF_TPRINTF_START (   ctx,
  func 
)    ff_tlog(NULL, "%-16s: ", #func)
#define AVFILTER_DEFINE_CLASS (   fname)
Value:
static const AVClass fname##_class = { \
.class_name = #fname, \
.item_name = av_default_item_name, \
.option = fname##_options, \
.version = LIBAVUTIL_VERSION_INT, \
.category = AV_CLASS_CATEGORY_FILTER, \
}
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
av_default_item_name
Describe the class of an AVClass context structure.
Definition: log.h:67

Definition at line 339 of file internal.h.

#define FF_INLINK_IDX (   link)    ((int)((link)->dstpad - (link)->dst->input_pads))

Find the index of a link.

I.e. find i such that link == ctx->(in|out)puts[i]

Definition at line 353 of file internal.h.

Referenced by ff_framesync_filter_frame(), filter_frame(), get_audio_buffer(), get_video_buffer(), and process_frame().

#define FF_OUTLINK_IDX (   link)    ((int)((link)->srcpad - (link)->src->output_pads))

Function Documentation

void ff_avfilter_graph_update_heap ( AVFilterGraph graph,
AVFilterLink link 
)

Update the position of a link in the age heap.

Definition at line 1374 of file avfiltergraph.c.

Referenced by ff_update_link_current_pts().

int ff_fmt_is_in ( int  fmt,
const int fmts 
)

Tell if an integer is contained in the provided -1-terminated list of integers.

This is useful for determining (for instance) if an AVPixelFormat is in an array of supported formats.

Parameters
fmtprovided format
fmts-1-terminated list of formats
Returns
1 if present, 0 if absent

Definition at line 254 of file formats.c.

Referenced by config_input(), config_input_main(), config_input_overlay(), config_out_props(), and config_props().

av_warn_unused_result int ff_parse_pixel_format ( enum AVPixelFormat ret,
const char *  arg,
void log_ctx 
)

Parse a pixel format.

Parameters
retpixel format pointer to where the value should be written
argstring to parse
log_ctxlog context
Returns
>= 0 in case of success, a negative AVERROR code on error

Definition at line 609 of file formats.c.

Referenced by init().

av_warn_unused_result int ff_parse_sample_rate ( int ret,
const char *  arg,
void log_ctx 
)

Parse a sample rate.

Parameters
retunsigned integer pointer to where the value should be written
argstring to parse
log_ctxlog context
Returns
>= 0 in case of success, a negative AVERROR code on error

Definition at line 650 of file formats.c.

Referenced by init().

av_warn_unused_result int ff_parse_time_base ( AVRational ret,
const char *  arg,
void log_ctx 
)

Parse a time base.

Parameters
retunsigned AVRational pointer to where the value should be written
argstring to parse
log_ctxlog context
Returns
>= 0 in case of success, a negative AVERROR code on error

Definition at line 639 of file formats.c.

av_warn_unused_result int ff_parse_sample_format ( int ret,
const char *  arg,
void log_ctx 
)

Parse a sample format name or a corresponding integer representation.

Parameters
retinteger pointer to where the value should be written
argstring to parse
log_ctxlog context
Returns
>= 0 in case of success, a negative AVERROR code on error

Definition at line 624 of file formats.c.

av_warn_unused_result int ff_parse_channel_layout ( int64_t *  ret,
int nret,
const char *  arg,
void log_ctx 
)

Parse a channel layout or a corresponding integer representation.

Parameters
ret64bit integer pointer to where the value should be written.
nretinteger pointer to the number of channels; if not NULL, then unknown channel layouts are accepted
argstring to parse
log_ctxlog context
Returns
>= 0 in case of success, a negative AVERROR code on error

Definition at line 662 of file formats.c.

Referenced by init(), and main().

void ff_update_link_current_pts ( AVFilterLink link,
int64_t  pts 
)

Definition at line 481 of file avfilter.c.

Referenced by ff_avfilter_link_set_out_status(), and ff_filter_frame_framed().

void ff_avfilter_link_set_in_status ( AVFilterLink link,
int  status,
int64_t  pts 
)

Set the status field of a link from the source filter.

The pts should reflect the timestamp of the status change, in link time base and relative to the frames timeline. In particular, for AVERROR_EOF, it should reflect the end time of the last frame.

Definition at line 183 of file avfilter.c.

Referenced by ff_request_frame_to_filter().

void ff_avfilter_link_set_out_status ( AVFilterLink link,
int  status,
int64_t  pts 
)

Set the status field of a link from the destination filter.

The pts should probably be left unset (AV_NOPTS_VALUE).

Definition at line 188 of file avfilter.c.

Referenced by avfilter_link_set_closed(), and ff_avfilter_link_set_in_status().

void ff_command_queue_pop ( AVFilterContext filter)

Definition at line 92 of file avfilter.c.

Referenced by avfilter_free(), and ff_filter_frame_framed().

char* ff_get_ref_perms_string ( char *  buf,
size_t  buf_size,
int  perms 
)
void ff_tlog_ref ( void ctx,
AVFrame ref,
int  end 
)

Definition at line 47 of file avfilter.c.

Referenced by ff_filter_frame().

void ff_tlog_link ( void ctx,
AVFilterLink link,
int  end 
)
int ff_insert_pad ( unsigned  idx,
unsigned *  count,
size_t  padidx_off,
AVFilterPad **  pads,
AVFilterLink ***  links,
AVFilterPad newpad 
)

Insert a new pad.

Parameters
idxInsertion point. Pad is inserted at the end if this point is beyond the end of the list of pads.
countPointer to the number of pads in the list
padidx_offOffset within an AVFilterLink structure to the element to increment when inserting a new pad causes link numbering to change
padsPointer to the pointer to the beginning of the list of pads
linksPointer to the pointer to the beginning of the list of links
newpadThe new pad to add. A copy is made when adding.
Returns
>= 0 in case of success, a negative AVERROR code on error

Definition at line 101 of file avfilter.c.

Referenced by ff_insert_inpad(), and ff_insert_outpad().

static int ff_insert_inpad ( AVFilterContext f,
unsigned  index,
AVFilterPad p 
)
inlinestatic

Insert a new input pad for the filter.

Definition at line 283 of file internal.h.

Referenced by decimate_init(), fieldmatch_init(), init(), join_init(), and parse_definition().

static int ff_insert_outpad ( AVFilterContext f,
unsigned  index,
AVFilterPad p 
)
inlinestatic

Insert a new output pad for the filter.

Definition at line 291 of file internal.h.

Referenced by init(), movie_common_init(), parse_definition(), and split_init().

int ff_poll_frame ( AVFilterLink link)

Poll a frame from the filter chain.

Parameters
linkthe input link
Returns
the number of immediately available frames, a negative number in case of error

Definition at line 405 of file avfilter.c.

Referenced by ff_poll_frame().

int ff_request_frame ( AVFilterLink link)

Request an input frame from the filter at the other end of the link.

The input filter may pass the request on to its inputs, fulfill the request from an internal buffer or any other means specific to its function.

When the end of a stream is reached AVERROR_EOF is returned and no further frames are returned after that.

When a filter is unable to output a frame for example due to its sources being unable to do so or because it depends on external means pushing data into it then AVERROR(EAGAIN) is returned. It is important that a AVERROR(EAGAIN) return is returned all the way to the caller (generally eventually a user application) as this step may (but does not have to be) necessary to provide the input with the next frame.

If a request is successful then some progress has been made towards providing a frame on the link (through ff_filter_frame()). A filter that needs several frames to produce one is allowed to return success if one more frame has been processed but no output has been produced yet. A filter is also allowed to simply forward a success return value.

Parameters
linkthe input link
Returns
zero on success AVERROR_EOF on end of file AVERROR(EAGAIN) if the previous filter cannot output a frame currently and can neither guarantee that EOF has been reached.

Definition at line 369 of file avfilter.c.

Referenced by av_buffersink_get_frame_flags(), avfilter_graph_request_oldest(), ff_framesync_request_frame(), ff_request_frame_to_filter(), join_request_frame(), request_frame(), request_frame_ref(), request_inlink(), request_samples(), and return_audio_frame().

int ff_request_frame_to_filter ( AVFilterLink link)

Definition at line 380 of file avfilter.c.

Referenced by ff_filter_graph_run_once().

int ff_filter_frame ( AVFilterLink link,
AVFrame frame 
)

Send a frame of data to the next filter.

Parameters
linkthe output link over which the data is being sent
framea reference to the buffer of data being sent. The receiving filter will free this reference when it no longer needs it or pass it on to the next filter.
Returns
>= 0 on success, a negative AVERROR on error. The receiving filter is responsible for unreferencing frame in case of error.

Definition at line 1189 of file avfilter.c.

Referenced by apply_filter(), channelmap_filter_frame(), compand_delay(), compand_nodelay(), cudaupload_filter_frame(), default_filter_frame(), end_last_frame(), filter(), filter_frame(), filter_frame16(), filter_frame8(), filter_frame_ref(), flush(), geq_filter_frame(), hwdownload_filter_frame(), hwupload_filter_frame(), movie_push_frame(), nppscale_filter_frame(), output_frame(), output_single_frame(), plot_freqs(), plot_spectrum_column(), pp_filter_frame(), process_frame(), process_work_frame(), push_frame(), push_samples(), request_frame(), return_audio_frame(), return_frame(), scale_vaapi_filter_frame(), send_silence(), shuffleplanes_filter_frame(), and try_push_frame().

AVFilterContext* ff_filter_alloc ( const AVFilter filter,
const char *  inst_name 
)

Allocate a new filter context and return it.

Parameters
filterwhat filter to create an instance of
inst_namename to give to the new filter context
Returns
newly created filter context or NULL on failure

Definition at line 647 of file avfilter.c.

Referenced by avfilter_graph_alloc_filter().

void ff_filter_graph_remove_filter ( AVFilterGraph graph,
AVFilterContext filter 
)

Remove a filter from a graph;.

Definition at line 94 of file avfiltergraph.c.

Referenced by avfilter_free().

int ff_filter_graph_run_once ( AVFilterGraph graph)

Run one round of processing on a filter graph.

Definition at line 1432 of file avfiltergraph.c.

Referenced by av_buffersink_get_frame_flags(), and avfilter_graph_request_oldest().

static int ff_norm_qscale ( int  qscale,
int  type 
)
inlinestatic

Normalize the qscale factor FIXME the H264 qscale is a log based scale, mpeg1/2 is not, the code below cannot be optimal.

Definition at line 394 of file internal.h.

Referenced by filter(), and filter_frame().

int ff_filter_get_nb_threads ( AVFilterContext ctx)

Get number of threads for current filter instance.

This number is always same or less than graph->nb_threads.

Definition at line 786 of file avfilter.c.

Referenced by apply_lut(), averageiir2d(), blend_frame(), config_input(), config_props(), filter(), filter_frame(), filter_frame16(), filter_frame8(), gaussianiir2d(), and nlmeans_plane().