2 * Copyright (c) 2008 vmrsss
3 * Copyright (c) 2009 Stefano Sabatini
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * video padding filter
28 #include "libavutil/avstring.h"
29 #include "libavutil/eval.h"
30 #include "libavutil/pixdesc.h"
31 #include "libavutil/colorspace.h"
32 #include "libavutil/avassert.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/parseutils.h"
35 #include "libavutil/mathematics.h"
36 #include "drawutils.h"
38 static const char *var_names[] = {
74 static int query_formats(AVFilterContext *ctx)
76 static const enum PixelFormat pix_fmts[] = {
77 PIX_FMT_ARGB, PIX_FMT_RGBA,
78 PIX_FMT_ABGR, PIX_FMT_BGRA,
79 PIX_FMT_RGB24, PIX_FMT_BGR24,
81 PIX_FMT_YUV444P, PIX_FMT_YUV422P,
82 PIX_FMT_YUV420P, PIX_FMT_YUV411P,
83 PIX_FMT_YUV410P, PIX_FMT_YUV440P,
84 PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P,
85 PIX_FMT_YUVJ420P, PIX_FMT_YUVJ440P,
91 avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
96 int w, h; ///< output dimensions, a value of 0 will result in the input size
97 int x, y; ///< offsets of the input area with respect to the padded area
98 int in_w, in_h; ///< width and height for the padded input video, which has to be aligned to the chroma values in order to avoid chroma issues
100 char w_expr[256]; ///< width expression string
101 char h_expr[256]; ///< height expression string
102 char x_expr[256]; ///< width expression string
103 char y_expr[256]; ///< height expression string
105 uint8_t color[4]; ///< color expressed either in YUVA or RGBA colorspace for the padding area
108 int hsub, vsub; ///< chroma subsampling values
112 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
114 PadContext *pad = ctx->priv;
115 char color_string[128] = "black";
117 av_strlcpy(pad->w_expr, "iw", sizeof(pad->w_expr));
118 av_strlcpy(pad->h_expr, "ih", sizeof(pad->h_expr));
119 av_strlcpy(pad->x_expr, "0" , sizeof(pad->w_expr));
120 av_strlcpy(pad->y_expr, "0" , sizeof(pad->h_expr));
123 sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]:%255s",
124 pad->w_expr, pad->h_expr, pad->x_expr, pad->y_expr, color_string);
126 if (av_parse_color(pad->color, color_string, -1, ctx) < 0)
127 return AVERROR(EINVAL);
132 static av_cold void uninit(AVFilterContext *ctx)
134 PadContext *pad = ctx->priv;
137 for (i = 0; i < 4; i++) {
138 av_freep(&pad->line[i]);
139 pad->line_step[i] = 0;
143 static int config_input(AVFilterLink *inlink)
145 AVFilterContext *ctx = inlink->dst;
146 PadContext *pad = ctx->priv;
147 const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
148 uint8_t rgba_color[4];
149 int ret, is_packed_rgba;
150 double var_values[VARS_NB], res;
153 pad->hsub = pix_desc->log2_chroma_w;
154 pad->vsub = pix_desc->log2_chroma_h;
156 var_values[VAR_PI] = M_PI;
157 var_values[VAR_PHI] = M_PHI;
158 var_values[VAR_E] = M_E;
159 var_values[VAR_IN_W] = var_values[VAR_IW] = inlink->w;
160 var_values[VAR_IN_H] = var_values[VAR_IH] = inlink->h;
161 var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
162 var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
163 var_values[VAR_A] = (float) inlink->w / inlink->h;
164 var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ?
165 (float) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
166 var_values[VAR_DAR] = var_values[VAR_A] * var_values[VAR_SAR];
167 var_values[VAR_HSUB] = 1<<pad->hsub;
168 var_values[VAR_VSUB] = 1<<pad->vsub;
170 /* evaluate width and height */
171 av_expr_parse_and_eval(&res, (expr = pad->w_expr),
172 var_names, var_values,
173 NULL, NULL, NULL, NULL, NULL, 0, ctx);
174 pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
175 if ((ret = av_expr_parse_and_eval(&res, (expr = pad->h_expr),
176 var_names, var_values,
177 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
179 pad->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
180 /* evaluate the width again, as it may depend on the evaluated output height */
181 if ((ret = av_expr_parse_and_eval(&res, (expr = pad->w_expr),
182 var_names, var_values,
183 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
185 pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
187 /* evaluate x and y */
188 av_expr_parse_and_eval(&res, (expr = pad->x_expr),
189 var_names, var_values,
190 NULL, NULL, NULL, NULL, NULL, 0, ctx);
191 pad->x = var_values[VAR_X] = res;
192 if ((ret = av_expr_parse_and_eval(&res, (expr = pad->y_expr),
193 var_names, var_values,
194 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
196 pad->y = var_values[VAR_Y] = res;
197 /* evaluate x again, as it may depend on the evaluated y value */
198 if ((ret = av_expr_parse_and_eval(&res, (expr = pad->x_expr),
199 var_names, var_values,
200 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
202 pad->x = var_values[VAR_X] = res;
204 /* sanity check params */
205 if (pad->w < 0 || pad->h < 0 || pad->x < 0 || pad->y < 0) {
206 av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
207 return AVERROR(EINVAL);
215 pad->w &= ~((1 << pad->hsub) - 1);
216 pad->h &= ~((1 << pad->vsub) - 1);
217 pad->x &= ~((1 << pad->hsub) - 1);
218 pad->y &= ~((1 << pad->vsub) - 1);
220 pad->in_w = inlink->w & ~((1 << pad->hsub) - 1);
221 pad->in_h = inlink->h & ~((1 << pad->vsub) - 1);
223 memcpy(rgba_color, pad->color, sizeof(rgba_color));
224 ff_fill_line_with_color(pad->line, pad->line_step, pad->w, pad->color,
225 inlink->format, rgba_color, &is_packed_rgba, NULL);
227 av_log(ctx, AV_LOG_INFO, "w:%d h:%d -> w:%d h:%d x:%d y:%d color:0x%02X%02X%02X%02X[%s]\n",
228 inlink->w, inlink->h, pad->w, pad->h, pad->x, pad->y,
229 pad->color[0], pad->color[1], pad->color[2], pad->color[3],
230 is_packed_rgba ? "rgba" : "yuva");
232 if (pad->x < 0 || pad->y < 0 ||
233 pad->w <= 0 || pad->h <= 0 ||
234 (unsigned)pad->x + (unsigned)inlink->w > pad->w ||
235 (unsigned)pad->y + (unsigned)inlink->h > pad->h) {
236 av_log(ctx, AV_LOG_ERROR,
237 "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
238 pad->x, pad->y, pad->x + inlink->w, pad->y + inlink->h, pad->w, pad->h);
239 return AVERROR(EINVAL);
245 av_log(NULL, AV_LOG_ERROR,
246 "Error when evaluating the expression '%s'\n", expr);
251 static int config_output(AVFilterLink *outlink)
253 PadContext *pad = outlink->src->priv;
260 static AVFilterBufferRef *get_video_buffer(AVFilterLink *inlink, int perms, int w, int h)
262 PadContext *pad = inlink->dst->priv;
264 AVFilterBufferRef *picref = avfilter_get_video_buffer(inlink->dst->outputs[0], perms,
265 w + (pad->w - pad->in_w),
266 h + (pad->h - pad->in_h));
269 picref->video->w = w;
270 picref->video->h = h;
272 for (plane = 0; plane < 4 && picref->data[plane]; plane++) {
273 int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
274 int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
276 picref->data[plane] += (pad->x >> hsub) * pad->line_step[plane] +
277 (pad->y >> vsub) * picref->linesize[plane];
283 static int does_clip(PadContext *pad, AVFilterBufferRef *outpicref, int plane, int hsub, int vsub, int x, int y)
285 int64_t x_in_buf, y_in_buf;
287 x_in_buf = outpicref->data[plane] - outpicref->buf->data[plane]
288 + (x >> hsub) * pad ->line_step[plane]
289 + (y >> vsub) * outpicref->linesize [plane];
291 if(x_in_buf < 0 || x_in_buf % pad->line_step[plane])
293 x_in_buf /= pad->line_step[plane];
295 av_assert0(outpicref->buf->linesize[plane]>0); //while reference can use negative linesize the main buffer should not
297 y_in_buf = x_in_buf / outpicref->buf->linesize[plane];
298 x_in_buf %= outpicref->buf->linesize[plane];
300 if( y_in_buf<<vsub >= outpicref->buf->h
301 || x_in_buf<<hsub >= outpicref->buf->w)
306 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
308 PadContext *pad = inlink->dst->priv;
309 AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
312 for (plane = 0; plane < 4 && outpicref->data[plane]; plane++) {
313 int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
314 int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
316 av_assert0(outpicref->buf->w>0 && outpicref->buf->h>0);
318 if(outpicref->format != outpicref->buf->format) //unsupported currently
321 outpicref->data[plane] -= (pad->x >> hsub) * pad ->line_step[plane]
322 + (pad->y >> vsub) * outpicref->linesize [plane];
324 if( does_clip(pad, outpicref, plane, hsub, vsub, 0, 0)
325 || does_clip(pad, outpicref, plane, hsub, vsub, 0, pad->h-1)
326 || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, 0)
327 || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, pad->h-1)
331 pad->needs_copy= plane < 4 && outpicref->data[plane];
333 av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
334 avfilter_unref_buffer(outpicref);
335 outpicref = avfilter_get_video_buffer(inlink->dst->outputs[0], AV_PERM_WRITE | AV_PERM_NEG_LINESIZES,
336 FFMAX(inlink->w, pad->w),
337 FFMAX(inlink->h, pad->h));
338 avfilter_copy_buffer_ref_props(outpicref, inpicref);
341 inlink->dst->outputs[0]->out_buf = outpicref;
343 outpicref->video->w = pad->w;
344 outpicref->video->h = pad->h;
346 avfilter_start_frame(inlink->dst->outputs[0], outpicref);
349 static void end_frame(AVFilterLink *link)
351 avfilter_end_frame(link->dst->outputs[0]);
352 avfilter_unref_buffer(link->cur_buf);
355 static void draw_send_bar_slice(AVFilterLink *link, int y, int h, int slice_dir, int before_slice)
357 PadContext *pad = link->dst->priv;
358 int bar_y, bar_h = 0;
360 if (slice_dir * before_slice == 1 && y == pad->y) {
364 } else if (slice_dir * before_slice == -1 && (y + h) == (pad->y + pad->in_h)) {
366 bar_y = pad->y + pad->in_h;
367 bar_h = pad->h - pad->in_h - pad->y;
371 ff_draw_rectangle(link->dst->outputs[0]->out_buf->data,
372 link->dst->outputs[0]->out_buf->linesize,
373 pad->line, pad->line_step, pad->hsub, pad->vsub,
374 0, bar_y, pad->w, bar_h);
375 avfilter_draw_slice(link->dst->outputs[0], bar_y, bar_h, slice_dir);
379 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
381 PadContext *pad = link->dst->priv;
382 AVFilterBufferRef *outpic = link->dst->outputs[0]->out_buf;
383 AVFilterBufferRef *inpic = link->cur_buf;
387 y &= ~((1 << pad->vsub) - 1);
388 h &= ~((1 << pad->vsub) - 1);
392 draw_send_bar_slice(link, y, h, slice_dir, 1);
395 ff_draw_rectangle(outpic->data, outpic->linesize, pad->line, pad->line_step,
396 pad->hsub, pad->vsub, 0, y, pad->x, h);
399 ff_copy_rectangle(outpic->data, outpic->linesize,
400 inpic->data, inpic->linesize, pad->line_step,
401 pad->hsub, pad->vsub,
402 pad->x, y, y-pad->y, inpic->video->w, h);
406 ff_draw_rectangle(outpic->data, outpic->linesize,
407 pad->line, pad->line_step, pad->hsub, pad->vsub,
408 pad->x + pad->in_w, y, pad->w - pad->x - pad->in_w, h);
409 avfilter_draw_slice(link->dst->outputs[0], y, h, slice_dir);
411 draw_send_bar_slice(link, y, h, slice_dir, -1);
414 AVFilter avfilter_vf_pad = {
416 .description = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
418 .priv_size = sizeof(PadContext),
421 .query_formats = query_formats,
423 .inputs = (AVFilterPad[]) {{ .name = "default",
424 .type = AVMEDIA_TYPE_VIDEO,
425 .config_props = config_input,
426 .get_video_buffer = get_video_buffer,
427 .start_frame = start_frame,
428 .draw_slice = draw_slice,
429 .end_frame = end_frame, },
432 .outputs = (AVFilterPad[]) {{ .name = "default",
433 .type = AVMEDIA_TYPE_VIDEO,
434 .config_props = config_output, },