Merge commit '1961e46c15c23a041f8d8614a25388a3ee9eff63'
[ffmpeg.git] / libavfilter / vf_pad.c
1 /*
2  * Copyright (c) 2008 vmrsss
3  * Copyright (c) 2009 Stefano Sabatini
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * video padding filter
25  */
26
27 #include "avfilter.h"
28 #include "formats.h"
29 #include "internal.h"
30 #include "video.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/eval.h"
33 #include "libavutil/pixdesc.h"
34 #include "libavutil/colorspace.h"
35 #include "libavutil/avassert.h"
36 #include "libavutil/imgutils.h"
37 #include "libavutil/parseutils.h"
38 #include "libavutil/mathematics.h"
39 #include "drawutils.h"
40
41 static const char *const var_names[] = {
42     "in_w",   "iw",
43     "in_h",   "ih",
44     "out_w",  "ow",
45     "out_h",  "oh",
46     "x",
47     "y",
48     "a",
49     "sar",
50     "dar",
51     "hsub",
52     "vsub",
53     NULL
54 };
55
56 enum var_name {
57     VAR_IN_W,   VAR_IW,
58     VAR_IN_H,   VAR_IH,
59     VAR_OUT_W,  VAR_OW,
60     VAR_OUT_H,  VAR_OH,
61     VAR_X,
62     VAR_Y,
63     VAR_A,
64     VAR_SAR,
65     VAR_DAR,
66     VAR_HSUB,
67     VAR_VSUB,
68     VARS_NB
69 };
70
71 static int query_formats(AVFilterContext *ctx)
72 {
73     ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
74     return 0;
75 }
76
77 typedef struct {
78     int w, h;               ///< output dimensions, a value of 0 will result in the input size
79     int x, y;               ///< offsets of the input area with respect to the padded area
80     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
81
82     char w_expr[256];       ///< width  expression string
83     char h_expr[256];       ///< height expression string
84     char x_expr[256];       ///< width  expression string
85     char y_expr[256];       ///< height expression string
86
87     uint8_t rgba_color[4];  ///< color for the padding area
88     FFDrawContext draw;
89     FFDrawColor color;
90     int needs_copy;
91 } PadContext;
92
93 static av_cold int init(AVFilterContext *ctx, const char *args)
94 {
95     PadContext *pad = ctx->priv;
96     char color_string[128] = "black";
97
98     av_strlcpy(pad->w_expr, "iw", sizeof(pad->w_expr));
99     av_strlcpy(pad->h_expr, "ih", sizeof(pad->h_expr));
100     av_strlcpy(pad->x_expr, "0" , sizeof(pad->w_expr));
101     av_strlcpy(pad->y_expr, "0" , sizeof(pad->h_expr));
102
103     if (args)
104         sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]:%127s",
105                pad->w_expr, pad->h_expr, pad->x_expr, pad->y_expr, color_string);
106
107     if (av_parse_color(pad->rgba_color, color_string, -1, ctx) < 0)
108         return AVERROR(EINVAL);
109
110     return 0;
111 }
112
113 static int config_input(AVFilterLink *inlink)
114 {
115     AVFilterContext *ctx = inlink->dst;
116     PadContext *pad = ctx->priv;
117     int ret;
118     double var_values[VARS_NB], res;
119     char *expr;
120
121     ff_draw_init(&pad->draw, inlink->format, 0);
122     ff_draw_color(&pad->draw, &pad->color, pad->rgba_color);
123
124     var_values[VAR_IN_W]  = var_values[VAR_IW] = inlink->w;
125     var_values[VAR_IN_H]  = var_values[VAR_IH] = inlink->h;
126     var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
127     var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
128     var_values[VAR_A]     = (float) inlink->w / inlink->h;
129     var_values[VAR_SAR]   = inlink->sample_aspect_ratio.num ?
130         (float) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
131     var_values[VAR_DAR]   = var_values[VAR_A] * var_values[VAR_SAR];
132     var_values[VAR_HSUB]  = 1 << pad->draw.hsub_max;
133     var_values[VAR_VSUB]  = 1 << pad->draw.vsub_max;
134
135     /* evaluate width and height */
136     av_expr_parse_and_eval(&res, (expr = pad->w_expr),
137                            var_names, var_values,
138                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
139     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
140     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->h_expr),
141                                       var_names, var_values,
142                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
143         goto eval_fail;
144     pad->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
145     /* evaluate the width again, as it may depend on the evaluated output height */
146     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->w_expr),
147                                       var_names, var_values,
148                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
149         goto eval_fail;
150     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
151
152     /* evaluate x and y */
153     av_expr_parse_and_eval(&res, (expr = pad->x_expr),
154                            var_names, var_values,
155                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
156     pad->x = var_values[VAR_X] = res;
157     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->y_expr),
158                                       var_names, var_values,
159                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
160         goto eval_fail;
161     pad->y = var_values[VAR_Y] = res;
162     /* evaluate x again, as it may depend on the evaluated y value */
163     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->x_expr),
164                                       var_names, var_values,
165                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
166         goto eval_fail;
167     pad->x = var_values[VAR_X] = res;
168
169     /* sanity check params */
170     if (pad->w < 0 || pad->h < 0 || pad->x < 0 || pad->y < 0) {
171         av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
172         return AVERROR(EINVAL);
173     }
174
175     if (!pad->w)
176         pad->w = inlink->w;
177     if (!pad->h)
178         pad->h = inlink->h;
179
180     pad->w    = ff_draw_round_to_sub(&pad->draw, 0, -1, pad->w);
181     pad->h    = ff_draw_round_to_sub(&pad->draw, 1, -1, pad->h);
182     pad->x    = ff_draw_round_to_sub(&pad->draw, 0, -1, pad->x);
183     pad->y    = ff_draw_round_to_sub(&pad->draw, 1, -1, pad->y);
184     pad->in_w = ff_draw_round_to_sub(&pad->draw, 0, -1, inlink->w);
185     pad->in_h = ff_draw_round_to_sub(&pad->draw, 1, -1, inlink->h);
186
187     av_log(ctx, AV_LOG_INFO, "w:%d h:%d -> w:%d h:%d x:%d y:%d color:0x%02X%02X%02X%02X\n",
188            inlink->w, inlink->h, pad->w, pad->h, pad->x, pad->y,
189            pad->rgba_color[0], pad->rgba_color[1], pad->rgba_color[2], pad->rgba_color[3]);
190
191     if (pad->x <  0 || pad->y <  0                      ||
192         pad->w <= 0 || pad->h <= 0                      ||
193         (unsigned)pad->x + (unsigned)inlink->w > pad->w ||
194         (unsigned)pad->y + (unsigned)inlink->h > pad->h) {
195         av_log(ctx, AV_LOG_ERROR,
196                "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
197                pad->x, pad->y, pad->x + inlink->w, pad->y + inlink->h, pad->w, pad->h);
198         return AVERROR(EINVAL);
199     }
200
201     return 0;
202
203 eval_fail:
204     av_log(NULL, AV_LOG_ERROR,
205            "Error when evaluating the expression '%s'\n", expr);
206     return ret;
207
208 }
209
210 static int config_output(AVFilterLink *outlink)
211 {
212     PadContext *pad = outlink->src->priv;
213
214     outlink->w = pad->w;
215     outlink->h = pad->h;
216     return 0;
217 }
218
219 static AVFilterBufferRef *get_video_buffer(AVFilterLink *inlink, int perms, int w, int h)
220 {
221     PadContext *pad = inlink->dst->priv;
222     int align = (perms&AV_PERM_ALIGN) ? AVFILTER_ALIGN : 1;
223
224     AVFilterBufferRef *picref = ff_get_video_buffer(inlink->dst->outputs[0], perms,
225                                                     w + (pad->w - pad->in_w) + 4*align,
226                                                     h + (pad->h - pad->in_h));
227     int plane;
228
229     picref->video->w = w;
230     picref->video->h = h;
231
232     for (plane = 0; plane < 4 && picref->data[plane]; plane++)
233         picref->data[plane] += FFALIGN(pad->x >> pad->draw.hsub[plane], align) * pad->draw.pixelstep[plane] +
234                                       (pad->y >> pad->draw.vsub[plane])        * picref->linesize[plane];
235
236     return picref;
237 }
238
239 static int does_clip(PadContext *pad, AVFilterBufferRef *outpicref, int plane, int hsub, int vsub, int x, int y)
240 {
241     int64_t x_in_buf, y_in_buf;
242
243     x_in_buf =  outpicref->data[plane] - outpicref->buf->data[plane]
244              +  (x >> hsub) * pad->draw.pixelstep[plane]
245              +  (y >> vsub) * outpicref->linesize[plane];
246
247     if(x_in_buf < 0 || x_in_buf % pad->draw.pixelstep[plane])
248         return 1;
249     x_in_buf /= pad->draw.pixelstep[plane];
250
251     av_assert0(outpicref->buf->linesize[plane]>0); //while reference can use negative linesize the main buffer should not
252
253     y_in_buf = x_in_buf / outpicref->buf->linesize[plane];
254     x_in_buf %= outpicref->buf->linesize[plane];
255
256     if(   y_in_buf<<vsub >= outpicref->buf->h
257        || x_in_buf<<hsub >= outpicref->buf->w)
258         return 1;
259     return 0;
260 }
261
262 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
263 {
264     PadContext *pad = inlink->dst->priv;
265     AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
266     int plane;
267
268     for (plane = 0; plane < 4 && outpicref->data[plane] && pad->draw.pixelstep[plane]; plane++) {
269         int hsub = pad->draw.hsub[plane];
270         int vsub = pad->draw.vsub[plane];
271
272         av_assert0(outpicref->buf->w>0 && outpicref->buf->h>0);
273
274         if(outpicref->format != outpicref->buf->format) //unsupported currently
275             break;
276
277         outpicref->data[plane] -=   (pad->x  >> hsub) * pad->draw.pixelstep[plane]
278                                   + (pad->y  >> vsub) * outpicref->linesize[plane];
279
280         if(   does_clip(pad, outpicref, plane, hsub, vsub, 0, 0)
281            || does_clip(pad, outpicref, plane, hsub, vsub, 0, pad->h-1)
282            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, 0)
283            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, pad->h-1)
284           )
285             break;
286     }
287     pad->needs_copy= plane < 4 && outpicref->data[plane] || !(outpicref->perms & AV_PERM_WRITE);
288     if(pad->needs_copy){
289         av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
290         avfilter_unref_buffer(outpicref);
291         outpicref = ff_get_video_buffer(inlink->dst->outputs[0], AV_PERM_WRITE | AV_PERM_NEG_LINESIZES,
292                                         FFMAX(inlink->w, pad->w),
293                                         FFMAX(inlink->h, pad->h));
294         avfilter_copy_buffer_ref_props(outpicref, inpicref);
295     }
296
297     inlink->dst->outputs[0]->out_buf = outpicref;
298
299     outpicref->video->w = pad->w;
300     outpicref->video->h = pad->h;
301
302     ff_start_frame(inlink->dst->outputs[0], avfilter_ref_buffer(outpicref, ~0));
303 }
304
305 static void draw_send_bar_slice(AVFilterLink *link, int y, int h, int slice_dir, int before_slice)
306 {
307     PadContext *pad = link->dst->priv;
308     int bar_y, bar_h = 0;
309
310     if        (slice_dir * before_slice ==  1 && y == pad->y) {
311         /* top bar */
312         bar_y = 0;
313         bar_h = pad->y;
314     } else if (slice_dir * before_slice == -1 && (y + h) == (pad->y + pad->in_h)) {
315         /* bottom bar */
316         bar_y = pad->y + pad->in_h;
317         bar_h = pad->h - pad->in_h - pad->y;
318     }
319
320     if (bar_h) {
321         ff_fill_rectangle(&pad->draw, &pad->color,
322                           link->dst->outputs[0]->out_buf->data,
323                           link->dst->outputs[0]->out_buf->linesize,
324                           0, bar_y, pad->w, bar_h);
325         ff_draw_slice(link->dst->outputs[0], bar_y, bar_h, slice_dir);
326     }
327 }
328
329 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
330 {
331     PadContext *pad = link->dst->priv;
332     AVFilterBufferRef *outpic = link->dst->outputs[0]->out_buf;
333     AVFilterBufferRef *inpic = link->cur_buf;
334
335     y += pad->y;
336
337     y = ff_draw_round_to_sub(&pad->draw, 1, -1, y);
338     h = ff_draw_round_to_sub(&pad->draw, 1, -1, h);
339
340     if (!h)
341         return;
342     draw_send_bar_slice(link, y, h, slice_dir, 1);
343
344     /* left border */
345     ff_fill_rectangle(&pad->draw, &pad->color, outpic->data, outpic->linesize,
346                       0, y, pad->x, h);
347
348     if(pad->needs_copy){
349         ff_copy_rectangle2(&pad->draw,
350                            outpic->data, outpic->linesize,
351                            inpic ->data, inpic ->linesize,
352                            pad->x, y, 0, y - pad->y, inpic->video->w, h);
353     }
354
355     /* right border */
356     ff_fill_rectangle(&pad->draw, &pad->color, outpic->data, outpic->linesize,
357                       pad->x + pad->in_w, y, pad->w - pad->x - pad->in_w, h);
358     ff_draw_slice(link->dst->outputs[0], y, h, slice_dir);
359
360     draw_send_bar_slice(link, y, h, slice_dir, -1);
361 }
362
363 AVFilter avfilter_vf_pad = {
364     .name          = "pad",
365     .description   = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
366
367     .priv_size     = sizeof(PadContext),
368     .init          = init,
369     .query_formats = query_formats,
370
371     .inputs    = (const AVFilterPad[]) {{ .name       = "default",
372                                     .type             = AVMEDIA_TYPE_VIDEO,
373                                     .config_props     = config_input,
374                                     .get_video_buffer = get_video_buffer,
375                                     .start_frame      = start_frame,
376                                     .draw_slice       = draw_slice, },
377                                   { .name = NULL}},
378
379     .outputs   = (const AVFilterPad[]) {{ .name       = "default",
380                                     .type             = AVMEDIA_TYPE_VIDEO,
381                                     .config_props     = config_output, },
382                                   { .name = NULL}},
383 };