vf_pad: remove mathematical constants now redundant.
[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 "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"
37
38 static const char *var_names[] = {
39     "in_w",   "iw",
40     "in_h",   "ih",
41     "out_w",  "ow",
42     "out_h",  "oh",
43     "x",
44     "y",
45     "a",
46     "sar",
47     "dar",
48     "hsub",
49     "vsub",
50     NULL
51 };
52
53 enum var_name {
54     VAR_IN_W,   VAR_IW,
55     VAR_IN_H,   VAR_IH,
56     VAR_OUT_W,  VAR_OW,
57     VAR_OUT_H,  VAR_OH,
58     VAR_X,
59     VAR_Y,
60     VAR_A,
61     VAR_SAR,
62     VAR_DAR,
63     VAR_HSUB,
64     VAR_VSUB,
65     VARS_NB
66 };
67
68 static int query_formats(AVFilterContext *ctx)
69 {
70     static const enum PixelFormat pix_fmts[] = {
71         PIX_FMT_ARGB,         PIX_FMT_RGBA,
72         PIX_FMT_ABGR,         PIX_FMT_BGRA,
73         PIX_FMT_RGB24,        PIX_FMT_BGR24,
74
75         PIX_FMT_YUV444P,      PIX_FMT_YUV422P,
76         PIX_FMT_YUV420P,      PIX_FMT_YUV411P,
77         PIX_FMT_YUV410P,      PIX_FMT_YUV440P,
78         PIX_FMT_YUVJ444P,     PIX_FMT_YUVJ422P,
79         PIX_FMT_YUVJ420P,     PIX_FMT_YUVJ440P,
80         PIX_FMT_YUVA420P,
81
82         PIX_FMT_NONE
83     };
84
85     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
86     return 0;
87 }
88
89 typedef struct {
90     int w, h;               ///< output dimensions, a value of 0 will result in the input size
91     int x, y;               ///< offsets of the input area with respect to the padded area
92     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
93
94     char w_expr[256];       ///< width  expression string
95     char h_expr[256];       ///< height expression string
96     char x_expr[256];       ///< width  expression string
97     char y_expr[256];       ///< height expression string
98
99     uint8_t color[4];       ///< color expressed either in YUVA or RGBA colorspace for the padding area
100     uint8_t *line[4];
101     int      line_step[4];
102     int hsub, vsub;         ///< chroma subsampling values
103     int needs_copy;
104 } PadContext;
105
106 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
107 {
108     PadContext *pad = ctx->priv;
109     char color_string[128] = "black";
110
111     av_strlcpy(pad->w_expr, "iw", sizeof(pad->w_expr));
112     av_strlcpy(pad->h_expr, "ih", sizeof(pad->h_expr));
113     av_strlcpy(pad->x_expr, "0" , sizeof(pad->w_expr));
114     av_strlcpy(pad->y_expr, "0" , sizeof(pad->h_expr));
115
116     if (args)
117         sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]:%255s",
118                pad->w_expr, pad->h_expr, pad->x_expr, pad->y_expr, color_string);
119
120     if (av_parse_color(pad->color, color_string, -1, ctx) < 0)
121         return AVERROR(EINVAL);
122
123     return 0;
124 }
125
126 static av_cold void uninit(AVFilterContext *ctx)
127 {
128     PadContext *pad = ctx->priv;
129     int i;
130
131     for (i = 0; i < 4; i++) {
132         av_freep(&pad->line[i]);
133         pad->line_step[i] = 0;
134     }
135 }
136
137 static int config_input(AVFilterLink *inlink)
138 {
139     AVFilterContext *ctx = inlink->dst;
140     PadContext *pad = ctx->priv;
141     const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
142     uint8_t rgba_color[4];
143     int ret, is_packed_rgba;
144     double var_values[VARS_NB], res;
145     char *expr;
146
147     pad->hsub = pix_desc->log2_chroma_w;
148     pad->vsub = pix_desc->log2_chroma_h;
149
150     var_values[VAR_IN_W]  = var_values[VAR_IW] = inlink->w;
151     var_values[VAR_IN_H]  = var_values[VAR_IH] = inlink->h;
152     var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
153     var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
154     var_values[VAR_A]     = (float) inlink->w / inlink->h;
155     var_values[VAR_SAR]   = inlink->sample_aspect_ratio.num ?
156         (float) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
157     var_values[VAR_DAR]   = var_values[VAR_A] * var_values[VAR_SAR];
158     var_values[VAR_HSUB]  = 1<<pad->hsub;
159     var_values[VAR_VSUB]  = 1<<pad->vsub;
160
161     /* evaluate width and height */
162     av_expr_parse_and_eval(&res, (expr = pad->w_expr),
163                            var_names, var_values,
164                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
165     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
166     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->h_expr),
167                                       var_names, var_values,
168                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
169         goto eval_fail;
170     pad->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
171     /* evaluate the width again, as it may depend on the evaluated output height */
172     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->w_expr),
173                                       var_names, var_values,
174                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
175         goto eval_fail;
176     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
177
178     /* evaluate x and y */
179     av_expr_parse_and_eval(&res, (expr = pad->x_expr),
180                            var_names, var_values,
181                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
182     pad->x = var_values[VAR_X] = res;
183     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->y_expr),
184                                       var_names, var_values,
185                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
186         goto eval_fail;
187     pad->y = var_values[VAR_Y] = res;
188     /* evaluate x again, as it may depend on the evaluated y value */
189     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->x_expr),
190                                       var_names, var_values,
191                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
192         goto eval_fail;
193     pad->x = var_values[VAR_X] = res;
194
195     /* sanity check params */
196     if (pad->w < 0 || pad->h < 0 || pad->x < 0 || pad->y < 0) {
197         av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
198         return AVERROR(EINVAL);
199     }
200
201     if (!pad->w)
202         pad->w = inlink->w;
203     if (!pad->h)
204         pad->h = inlink->h;
205
206     pad->w &= ~((1 << pad->hsub) - 1);
207     pad->h &= ~((1 << pad->vsub) - 1);
208     pad->x &= ~((1 << pad->hsub) - 1);
209     pad->y &= ~((1 << pad->vsub) - 1);
210
211     pad->in_w = inlink->w & ~((1 << pad->hsub) - 1);
212     pad->in_h = inlink->h & ~((1 << pad->vsub) - 1);
213
214     memcpy(rgba_color, pad->color, sizeof(rgba_color));
215     ff_fill_line_with_color(pad->line, pad->line_step, pad->w, pad->color,
216                             inlink->format, rgba_color, &is_packed_rgba, NULL);
217
218     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",
219            inlink->w, inlink->h, pad->w, pad->h, pad->x, pad->y,
220            pad->color[0], pad->color[1], pad->color[2], pad->color[3],
221            is_packed_rgba ? "rgba" : "yuva");
222
223     if (pad->x <  0 || pad->y <  0                      ||
224         pad->w <= 0 || pad->h <= 0                      ||
225         (unsigned)pad->x + (unsigned)inlink->w > pad->w ||
226         (unsigned)pad->y + (unsigned)inlink->h > pad->h) {
227         av_log(ctx, AV_LOG_ERROR,
228                "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
229                pad->x, pad->y, pad->x + inlink->w, pad->y + inlink->h, pad->w, pad->h);
230         return AVERROR(EINVAL);
231     }
232
233     return 0;
234
235 eval_fail:
236     av_log(NULL, AV_LOG_ERROR,
237            "Error when evaluating the expression '%s'\n", expr);
238     return ret;
239
240 }
241
242 static int config_output(AVFilterLink *outlink)
243 {
244     PadContext *pad = outlink->src->priv;
245
246     outlink->w = pad->w;
247     outlink->h = pad->h;
248     return 0;
249 }
250
251 static AVFilterBufferRef *get_video_buffer(AVFilterLink *inlink, int perms, int w, int h)
252 {
253     PadContext *pad = inlink->dst->priv;
254
255     AVFilterBufferRef *picref = avfilter_get_video_buffer(inlink->dst->outputs[0], perms,
256                                                        w + (pad->w - pad->in_w),
257                                                        h + (pad->h - pad->in_h));
258     int plane;
259
260     picref->video->w = w;
261     picref->video->h = h;
262
263     for (plane = 0; plane < 4 && picref->data[plane]; plane++) {
264         int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
265         int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
266
267         picref->data[plane] += (pad->x >> hsub) * pad->line_step[plane] +
268             (pad->y >> vsub) * picref->linesize[plane];
269     }
270
271     return picref;
272 }
273
274 static int does_clip(PadContext *pad, AVFilterBufferRef *outpicref, int plane, int hsub, int vsub, int x, int y)
275 {
276     int64_t x_in_buf, y_in_buf;
277
278     x_in_buf =  outpicref->data[plane] - outpicref->buf->data[plane]
279              +  (x >> hsub) * pad      ->line_step[plane]
280              +  (y >> vsub) * outpicref->linesize [plane];
281
282     if(x_in_buf < 0 || x_in_buf % pad->line_step[plane])
283         return 1;
284     x_in_buf /= pad->line_step[plane];
285
286     av_assert0(outpicref->buf->linesize[plane]>0); //while reference can use negative linesize the main buffer should not
287
288     y_in_buf = x_in_buf / outpicref->buf->linesize[plane];
289     x_in_buf %= outpicref->buf->linesize[plane];
290
291     if(   y_in_buf<<vsub >= outpicref->buf->h
292        || x_in_buf<<hsub >= outpicref->buf->w)
293         return 1;
294     return 0;
295 }
296
297 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
298 {
299     PadContext *pad = inlink->dst->priv;
300     AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
301     int plane;
302
303     for (plane = 0; plane < 4 && outpicref->data[plane]; plane++) {
304         int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
305         int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
306
307         av_assert0(outpicref->buf->w>0 && outpicref->buf->h>0);
308
309         if(outpicref->format != outpicref->buf->format) //unsupported currently
310             break;
311
312         outpicref->data[plane] -=   (pad->x  >> hsub) * pad      ->line_step[plane]
313                                   + (pad->y  >> vsub) * outpicref->linesize [plane];
314
315         if(   does_clip(pad, outpicref, plane, hsub, vsub, 0, 0)
316            || does_clip(pad, outpicref, plane, hsub, vsub, 0, pad->h-1)
317            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, 0)
318            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, pad->h-1)
319           )
320             break;
321     }
322     pad->needs_copy= plane < 4 && outpicref->data[plane];
323     if(pad->needs_copy){
324         av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
325         avfilter_unref_buffer(outpicref);
326         outpicref = avfilter_get_video_buffer(inlink->dst->outputs[0], AV_PERM_WRITE | AV_PERM_NEG_LINESIZES,
327                                                        FFMAX(inlink->w, pad->w),
328                                                        FFMAX(inlink->h, pad->h));
329         avfilter_copy_buffer_ref_props(outpicref, inpicref);
330     }
331
332     inlink->dst->outputs[0]->out_buf = outpicref;
333
334     outpicref->video->w = pad->w;
335     outpicref->video->h = pad->h;
336
337     avfilter_start_frame(inlink->dst->outputs[0], outpicref);
338 }
339
340 static void end_frame(AVFilterLink *link)
341 {
342     avfilter_end_frame(link->dst->outputs[0]);
343     avfilter_unref_buffer(link->cur_buf);
344 }
345
346 static void draw_send_bar_slice(AVFilterLink *link, int y, int h, int slice_dir, int before_slice)
347 {
348     PadContext *pad = link->dst->priv;
349     int bar_y, bar_h = 0;
350
351     if        (slice_dir * before_slice ==  1 && y == pad->y) {
352         /* top bar */
353         bar_y = 0;
354         bar_h = pad->y;
355     } else if (slice_dir * before_slice == -1 && (y + h) == (pad->y + pad->in_h)) {
356         /* bottom bar */
357         bar_y = pad->y + pad->in_h;
358         bar_h = pad->h - pad->in_h - pad->y;
359     }
360
361     if (bar_h) {
362         ff_draw_rectangle(link->dst->outputs[0]->out_buf->data,
363                           link->dst->outputs[0]->out_buf->linesize,
364                           pad->line, pad->line_step, pad->hsub, pad->vsub,
365                           0, bar_y, pad->w, bar_h);
366         avfilter_draw_slice(link->dst->outputs[0], bar_y, bar_h, slice_dir);
367     }
368 }
369
370 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
371 {
372     PadContext *pad = link->dst->priv;
373     AVFilterBufferRef *outpic = link->dst->outputs[0]->out_buf;
374     AVFilterBufferRef *inpic = link->cur_buf;
375
376     y += pad->y;
377
378     y &= ~((1 << pad->vsub) - 1);
379     h &= ~((1 << pad->vsub) - 1);
380
381     if (!h)
382         return;
383     draw_send_bar_slice(link, y, h, slice_dir, 1);
384
385     /* left border */
386     ff_draw_rectangle(outpic->data, outpic->linesize, pad->line, pad->line_step,
387                       pad->hsub, pad->vsub, 0, y, pad->x, h);
388
389     if(pad->needs_copy){
390         ff_copy_rectangle(outpic->data, outpic->linesize,
391                           inpic->data, inpic->linesize, pad->line_step,
392                           pad->hsub, pad->vsub,
393                           pad->x, y, y-pad->y, inpic->video->w, h);
394     }
395
396     /* right border */
397     ff_draw_rectangle(outpic->data, outpic->linesize,
398                       pad->line, pad->line_step, pad->hsub, pad->vsub,
399                       pad->x + pad->in_w, y, pad->w - pad->x - pad->in_w, h);
400     avfilter_draw_slice(link->dst->outputs[0], y, h, slice_dir);
401
402     draw_send_bar_slice(link, y, h, slice_dir, -1);
403 }
404
405 AVFilter avfilter_vf_pad = {
406     .name          = "pad",
407     .description   = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
408
409     .priv_size     = sizeof(PadContext),
410     .init          = init,
411     .uninit        = uninit,
412     .query_formats = query_formats,
413
414     .inputs    = (AVFilterPad[]) {{ .name             = "default",
415                                     .type             = AVMEDIA_TYPE_VIDEO,
416                                     .config_props     = config_input,
417                                     .get_video_buffer = get_video_buffer,
418                                     .start_frame      = start_frame,
419                                     .draw_slice       = draw_slice,
420                                     .end_frame        = end_frame, },
421                                   { .name = NULL}},
422
423     .outputs   = (AVFilterPad[]) {{ .name             = "default",
424                                     .type             = AVMEDIA_TYPE_VIDEO,
425                                     .config_props     = config_output, },
426                                   { .name = NULL}},
427 };