FFmpeg
internal.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #ifndef AVFILTER_INTERNAL_H
20 #define AVFILTER_INTERNAL_H
21 
27 #include "libavutil/internal.h"
28 #include "avfilter.h"
29 #include "formats.h"
30 #include "framepool.h"
31 #include "framequeue.h"
32 #include "thread.h"
33 #include "version.h"
34 #include "video.h"
35 #include "libavcodec/avcodec.h"
36 #include "libavcodec/internal.h"
37 
38 typedef struct AVFilterCommand {
39  double time;
40  char *command;
41  char *arg;
42  int flags;
43  struct AVFilterCommand *next;
45 
50 
54 struct AVFilterPad {
60  const char *name;
61 
65  enum AVMediaType type;
66 
73  AVFrame *(*get_video_buffer)(AVFilterLink *link, int w, int h);
74 
81  AVFrame *(*get_audio_buffer)(AVFilterLink *link, int nb_samples);
82 
93  int (*filter_frame)(AVFilterLink *link, AVFrame *frame);
94 
104  int (*poll_frame)(AVFilterLink *link);
105 
113  int (*request_frame)(AVFilterLink *link);
114 
129  int (*config_props)(AVFilterLink *link);
130 
138 
146 };
147 
149  void *thread;
150  avfilter_execute_func *thread_execute;
151  FFFrameQueueGlobal frame_queues;
152 };
153 
155  avfilter_execute_func *execute;
156 };
157 
167 int ff_fmt_is_in(int fmt, const int *fmts);
168 
169 /* Functions to parse audio format arguments */
170 
179 av_warn_unused_result
180 int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx);
181 
190 av_warn_unused_result
191 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
192 
201 av_warn_unused_result
202 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
203 
212 av_warn_unused_result
213 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
214 
225 av_warn_unused_result
226 int ff_parse_channel_layout(int64_t *ret, int *nret, const char *arg,
227  void *log_ctx);
228 
229 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
230 
238 void ff_avfilter_link_set_in_status(AVFilterLink *link, int status, int64_t pts);
239 
244 void ff_avfilter_link_set_out_status(AVFilterLink *link, int status, int64_t pts);
245 
246 void ff_command_queue_pop(AVFilterContext *filter);
247 
248 /* misc trace functions */
249 
250 #define FF_TPRINTF_START(ctx, func) ff_tlog(NULL, "%-16s: ", #func)
251 
252 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
253 
254 void ff_tlog_ref(void *ctx, AVFrame *ref, int end);
255 
256 void ff_tlog_link(void *ctx, AVFilterLink *link, int end);
257 
272 int ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
273  AVFilterPad **pads, AVFilterLink ***links,
274  AVFilterPad *newpad);
275 
277 static inline int ff_insert_inpad(AVFilterContext *f, unsigned index,
278  AVFilterPad *p)
279 {
280  return ff_insert_pad(index, &f->nb_inputs, offsetof(AVFilterLink, dstpad),
281  &f->input_pads, &f->inputs, p);
282 }
283 
285 static inline int ff_insert_outpad(AVFilterContext *f, unsigned index,
286  AVFilterPad *p)
287 {
288  return ff_insert_pad(index, &f->nb_outputs, offsetof(AVFilterLink, srcpad),
289  &f->output_pads, &f->outputs, p);
290 }
291 
299 int ff_poll_frame(AVFilterLink *link);
300 
332 int ff_request_frame(AVFilterLink *link);
333 
334 #define AVFILTER_DEFINE_CLASS(fname) \
335  static const AVClass fname##_class = { \
336  .class_name = #fname, \
337  .item_name = av_default_item_name, \
338  .option = fname##_options, \
339  .version = LIBAVUTIL_VERSION_INT, \
340  .category = AV_CLASS_CATEGORY_FILTER, \
341  }
342 
348 #define FF_INLINK_IDX(link) ((int)((link)->dstpad - (link)->dst->input_pads))
349 #define FF_OUTLINK_IDX(link) ((int)((link)->srcpad - (link)->src->output_pads))
350 
362 int ff_filter_frame(AVFilterLink *link, AVFrame *frame);
363 
372 AVFilterContext *ff_filter_alloc(const AVFilter *filter, const char *inst_name);
373 
374 int ff_filter_activate(AVFilterContext *filter);
375 
380 
385 #define FF_FILTER_FLAG_HWFRAME_AWARE (1 << 0)
386 
391 
397 static inline int ff_norm_qscale(int qscale, int type)
398 {
399  switch (type) {
400  case FF_QSCALE_TYPE_MPEG1: return qscale;
401  case FF_QSCALE_TYPE_MPEG2: return qscale >> 1;
402  case FF_QSCALE_TYPE_H264: return qscale >> 2;
403  case FF_QSCALE_TYPE_VP56: return (63 - qscale + 2) >> 2;
404  }
405  return qscale;
406 }
407 
413 
428  int default_pool_size);
429 
430 #endif /* AVFILTER_INTERNAL_H */
This structure describes decoded (raw) audio or video data.
Definition: frame.h:218
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1080
int ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off, AVFilterPad **pads, AVFilterLink ***links, AVFilterPad *newpad)
Insert a new pad.
Definition: avfilter.c:103
Main libavfilter public API header.
Definition: internal.h:148
Libavfilter version macros.
void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link)
Update the position of a link in the age heap.
Definition: avfiltergraph.c:1390
const char * name
Pad name.
Definition: internal.h:60
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:346
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.
Definition: avfilter.c:211
AVFilterPad * output_pads
array of output pads
Definition: avfilter.h:349
int ff_fmt_is_in(int fmt, const int *fmts)
Tell if an integer is contained in the provided -1-terminated list of integers.
Definition: formats.c:254
int( avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func, void *arg, int *ret, int nb_jobs)
A function executing multiple jobs, possibly in parallel.
Definition: avfilter.h:837
int ff_filter_graph_run_once(AVFilterGraph *graph)
Run one round of processing on a filter graph.
Definition: avfiltergraph.c:1441
int ff_filter_init_hw_frames(AVFilterContext *avctx, AVFilterLink *link, int default_pool_size)
Perform any additional setup required for hardware frames.
Definition: avfilter.c:1625
A filter pad used for either input or output.
Definition: internal.h:54
AVFilterPad * input_pads
array of input pads
Definition: avfilter.h:345
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:802
unsigned nb_outputs
number of output pads
Definition: avfilter.h:351
common internal API header
av_warn_unused_result int ff_parse_pixel_format(enum AVPixelFormat *ret, const char *arg, void *log_ctx)
Parse a pixel format.
Definition: formats.c:609
unsigned nb_inputs
number of input pads
Definition: avfilter.h:347
Definition: internal.h:154
int needs_writable
The filter expects writable frames from its input link, duplicating data buffers if needed...
Definition: internal.h:145
Definition: avfilter.h:840
Libavcodec external API header.
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.
Definition: formats.c:662
void ff_filter_graph_remove_filter(AVFilterGraph *graph, AVFilterContext *filter)
Remove a filter from a graph;.
Definition: avfiltergraph.c:102
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.
Definition: avfilter.c:224
Filter definition.
Definition: avfilter.h:144
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVMediaType
Definition: avutil.h:199
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:350
Definition: internal.h:38
av_warn_unused_result int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx)
Parse a time base.
Definition: formats.c:639
common internal api header.
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.
Definition: formats.c:624
av_warn_unused_result int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx)
Parse a sample rate.
Definition: formats.c:650
An instance of a filter.
Definition: avfilter.h:338
int ff_poll_frame(AVFilterLink *link)
Poll a frame from the filter chain.
Definition: avfilter.c:470
AVFilterContext * ff_filter_alloc(const AVFilter *filter, const char *inst_name)
Allocate a new filter context and return it.
Definition: avfilter.c:663
double time
time expressed in seconds
Definition: internal.h:39
int needs_fifo
The filter expects a fifo to be inserted on its input link, typically because it has a delay...
Definition: internal.h:137
int ff_request_frame(AVFilterLink *link)
Request an input frame from the filter at the other end of the link.
Definition: avfilter.c:407
Structure to hold global options and statistics for frame queues.
Definition: framequeue.h:46
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
char * command
command
Definition: internal.h:40
char * arg
optional argument for the command
Definition: internal.h:41