FFmpeg
vf_tpad.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
22 #include "libavutil/opt.h"
23 #include "avfilter.h"
24 #include "audio.h"
25 #include "filters.h"
26 #include "internal.h"
27 #include "formats.h"
28 #include "drawutils.h"
29 
30 typedef struct TPadContext {
31  const AVClass *class;
32  int pad_start;
33  int pad_stop;
35  int stop_mode;
36  int64_t start_duration;
37  int64_t stop_duration;
38  uint8_t rgba_color[4]; ///< color for the padding area
39 
42  int64_t pts;
43  int eof;
46 } TPadContext;
47 
48 #define OFFSET(x) offsetof(TPadContext, x)
49 #define VF AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
50 
51 static const AVOption tpad_options[] = {
52  { "start", "set the number of frames to delay input", OFFSET(pad_start), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, VF },
53  { "stop", "set the number of frames to add after input finished", OFFSET(pad_stop), AV_OPT_TYPE_INT, {.i64=0}, -1, INT_MAX, VF },
54  { "start_mode", "set the mode of added frames to start", OFFSET(start_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, VF, "mode" },
55  { "add", "add solid-color frames", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, VF, "mode" },
56  { "clone", "clone first/last frame", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, VF, "mode" },
57  { "stop_mode", "set the mode of added frames to end", OFFSET(stop_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, VF, "mode" },
58  { "start_duration", "set the duration to delay input", OFFSET(start_duration), AV_OPT_TYPE_DURATION, {.i64=0}, 0, INT64_MAX, VF },
59  { "stop_duration", "set the duration to pad input", OFFSET(stop_duration), AV_OPT_TYPE_DURATION, {.i64=0}, 0, INT64_MAX, VF },
60  { "color", "set the color of the added frames", OFFSET(rgba_color), AV_OPT_TYPE_COLOR, {.str="black"}, 0, 0, VF },
61  { NULL }
62 };
63 
65 
67 {
69 }
70 
72 {
73  AVFilterLink *inlink = ctx->inputs[0];
74  AVFilterLink *outlink = ctx->outputs[0];
75  TPadContext *s = ctx->priv;
76  AVFrame *frame = NULL;
77  int ret, status;
78  int64_t pts;
79 
81 
82  if (s->start_mode == 0 && s->pad_start > 0 && ff_outlink_frame_wanted(outlink)) {
83  frame = ff_get_video_buffer(outlink, outlink->w, outlink->h);
84  if (!frame)
85  return AVERROR(ENOMEM);
86  ff_fill_rectangle(&s->draw, &s->color,
87  frame->data, frame->linesize,
88  0, 0, frame->width, frame->height);
89  frame->pts = s->pts;
90  s->pts += av_rescale_q(1, av_inv_q(outlink->frame_rate), outlink->time_base);
91  s->pad_start--;
92  return ff_filter_frame(outlink, frame);
93  }
94 
95  if (s->start_mode == 1 && s->pad_start > 0) {
96  if (!s->cache_start && ff_inlink_queued_frames(inlink)) {
97  s->cache_start = ff_inlink_peek_frame(inlink, 0);
98  } else if (!s->cache_start) {
100  }
101  frame = av_frame_clone(s->cache_start);
102  if (!frame)
103  return AVERROR(ENOMEM);
104  frame->pts = s->pts;
105  s->pts += av_rescale_q(1, av_inv_q(outlink->frame_rate), outlink->time_base);
106  s->pad_start--;
107  if (s->pad_start == 0)
108  s->cache_start = NULL;
109  return ff_filter_frame(outlink, frame);
110  }
111 
112  if (!s->eof && !s->pad_start) {
114  if (ret < 0)
115  return ret;
116  if (ret > 0) {
117  if (s->stop_mode == 1 && s->pad_stop != 0) {
118  av_frame_free(&s->cache_stop);
119  s->cache_stop = av_frame_clone(frame);
120  }
121  frame->pts += s->pts;
122  return ff_filter_frame(outlink, frame);
123  }
124  }
125 
126  if (!s->eof && ff_inlink_acknowledge_status(inlink, &status, &pts)) {
127  if (status == AVERROR_EOF) {
128  pts = av_rescale_q(pts, inlink->time_base, outlink->time_base);
129  if (!s->pad_stop) {
130  ff_outlink_set_status(outlink, status, pts);
131  return 0;
132  }
133  s->eof = 1;
134  s->pts += pts;
135  }
136  }
137 
138  if (s->eof) {
139  if (!s->pad_stop) {
140  ff_outlink_set_status(outlink, AVERROR_EOF, s->pts);
141  return 0;
142  }
143  if (s->stop_mode == 0) {
144  frame = ff_get_video_buffer(outlink, outlink->w, outlink->h);
145  if (!frame)
146  return AVERROR(ENOMEM);
147  ff_fill_rectangle(&s->draw, &s->color,
148  frame->data, frame->linesize,
149  0, 0, frame->width, frame->height);
150  } else if (s->stop_mode == 1) {
151  frame = av_frame_clone(s->cache_stop);
152  if (!frame)
153  return AVERROR(ENOMEM);
154  }
155  frame->pts = s->pts;
156  s->pts += av_rescale_q(1, av_inv_q(outlink->frame_rate), outlink->time_base);
157  if (s->pad_stop > 0)
158  s->pad_stop--;
159  return ff_filter_frame(outlink, frame);
160  }
161 
162  if (!s->pad_start)
164 
165  return FFERROR_NOT_READY;
166 }
167 
169 {
170  AVFilterContext *ctx = inlink->dst;
171  TPadContext *s = ctx->priv;
172 
173  ff_draw_init(&s->draw, inlink->format, 0);
174  ff_draw_color(&s->draw, &s->color, s->rgba_color);
175 
176  if (s->start_duration)
177  s->pad_start = av_rescale_q(s->start_duration, inlink->frame_rate, av_inv_q(AV_TIME_BASE_Q));
178  if (s->stop_duration)
179  s->pad_stop = av_rescale_q(s->stop_duration, inlink->frame_rate, av_inv_q(AV_TIME_BASE_Q));
180 
181  return 0;
182 }
183 
185 {
186  TPadContext *s = ctx->priv;
187 
188  av_frame_free(&s->cache_stop);
189 }
190 
191 static const AVFilterPad tpad_inputs[] = {
192  {
193  .name = "default",
194  .type = AVMEDIA_TYPE_VIDEO,
195  .config_props = config_input,
196  },
197 };
198 
199 static const AVFilterPad tpad_outputs[] = {
200  {
201  .name = "default",
202  .type = AVMEDIA_TYPE_VIDEO,
203  },
204 };
205 
207  .name = "tpad",
208  .description = NULL_IF_CONFIG_SMALL("Temporarily pad video frames."),
209  .priv_size = sizeof(TPadContext),
210  .priv_class = &tpad_class,
211  .activate = activate,
212  .uninit = uninit,
216 };
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:98
FFDrawColor
Definition: drawutils.h:49
status
they must not be accessed directly The fifo field contains the frames that are queued in the input for processing by the filter The status_in and status_out fields contains the queued status(EOF or error) of the link
activate
static int activate(AVFilterContext *ctx)
Definition: vf_tpad.c:71
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
FFERROR_NOT_READY
return FFERROR_NOT_READY
Definition: filter_design.txt:204
TPadContext::start_mode
int start_mode
Definition: vf_tpad.c:34
AV_TIME_BASE_Q
#define AV_TIME_BASE_Q
Internal time base represented as fractional value.
Definition: avutil.h:260
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVOption
AVOption.
Definition: opt.h:247
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: internal.h:168
TPadContext::draw
FFDrawContext draw
Definition: vf_tpad.c:40
AV_OPT_TYPE_DURATION
@ AV_OPT_TYPE_DURATION
Definition: opt.h:238
TPadContext
Definition: vf_tpad.c:30
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
TPadContext::pts
int64_t pts
Definition: vf_tpad.c:42
FF_FILTER_FORWARD_STATUS_BACK
#define FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink)
Forward the status on an output link to an input link.
Definition: filters.h:199
ff_vf_tpad
const AVFilter ff_vf_tpad
Definition: vf_tpad.c:206
TPadContext::start_duration
int64_t start_duration
Definition: vf_tpad.c:36
formats.h
ff_inlink_consume_frame
int ff_inlink_consume_frame(AVFilterLink *link, AVFrame **rframe)
Take a frame from the link's FIFO and update the link's stats.
Definition: avfilter.c:1417
pts
static int64_t pts
Definition: transcode_aac.c:653
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
av_cold
#define av_cold
Definition: attributes.h:90
ff_set_common_formats
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:699
ff_outlink_set_status
static void ff_outlink_set_status(AVFilterLink *link, int status, int64_t pts)
Set the status field of a link from the source filter.
Definition: filters.h:189
s
#define s(width, name)
Definition: cbs_vp9.c:257
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_frame_clone
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:424
av_rescale_q
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:141
ff_draw_init
int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags)
Init a draw context.
Definition: drawutils.c:82
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
ff_inlink_peek_frame
AVFrame * ff_inlink_peek_frame(AVFilterLink *link, size_t idx)
Access a frame in the link fifo without consuming it.
Definition: avfilter.c:1456
TPadContext::cache_stop
AVFrame * cache_stop
Definition: vf_tpad.c:45
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
tpad_inputs
static const AVFilterPad tpad_inputs[]
Definition: vf_tpad.c:191
AV_OPT_TYPE_COLOR
@ AV_OPT_TYPE_COLOR
Definition: opt.h:239
ff_inlink_acknowledge_status
int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts)
Test and acknowledge the change of status on the link.
Definition: avfilter.c:1371
ff_inlink_queued_frames
size_t ff_inlink_queued_frames(AVFilterLink *link)
Get the number of frames available on the link.
Definition: avfilter.c:1386
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_tpad.c:184
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(tpad)
ff_fill_rectangle
void ff_fill_rectangle(FFDrawContext *draw, FFDrawColor *color, uint8_t *dst[], int dst_linesize[], int dst_x, int dst_y, int w, int h)
Fill a rectangle with an uniform color.
Definition: drawutils.c:222
config_input
static int config_input(AVFilterLink *inlink)
Definition: vf_tpad.c:168
OFFSET
#define OFFSET(x)
Definition: vf_tpad.c:48
FF_FILTER_FORWARD_WANTED
FF_FILTER_FORWARD_WANTED(outlink, inlink)
TPadContext::pad_start
int pad_start
Definition: vf_tpad.c:32
internal.h
TPadContext::stop_mode
int stop_mode
Definition: vf_tpad.c:35
TPadContext::color
FFDrawColor color
Definition: vf_tpad.c:41
ff_draw_supported_pixel_formats
AVFilterFormats * ff_draw_supported_pixel_formats(unsigned flags)
Return the list of pixel formats supported by the draw functions.
Definition: drawutils.c:635
FFDrawContext
Definition: drawutils.h:35
av_inv_q
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
TPadContext::rgba_color
uint8_t rgba_color[4]
color for the padding area
Definition: vf_tpad.c:38
ff_draw_color
void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4])
Prepare a color.
Definition: drawutils.c:135
AVFilter
Filter definition.
Definition: avfilter.h:149
ret
ret
Definition: filter_design.txt:187
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
tpad_outputs
static const AVFilterPad tpad_outputs[]
Definition: vf_tpad.c:199
VF
#define VF
Definition: vf_tpad.c:49
channel_layout.h
TPadContext::stop_duration
int64_t stop_duration
Definition: vf_tpad.c:37
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
TPadContext::eof
int eof
Definition: vf_tpad.c:43
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
audio.h
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
TPadContext::pad_stop
int pad_stop
Definition: vf_tpad.c:33
query_formats
static int query_formats(AVFilterContext *ctx)
Definition: vf_tpad.c:66
ff_outlink_frame_wanted
the definition of that something depends on the semantic of the filter The callback must examine the status of the filter s links and proceed accordingly The status of output links is stored in the status_in and status_out fields and tested by the ff_outlink_frame_wanted() function. If this function returns true
TPadContext::cache_start
AVFrame * cache_start
Definition: vf_tpad.c:44
drawutils.h
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
tpad_options
static const AVOption tpad_options[]
Definition: vf_tpad.c:51