matroskadec: fix a sanity check.
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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/common.h"
33 #include "libavutil/eval.h"
34 #include "libavutil/pixdesc.h"
35 #include "libavutil/colorspace.h"
36 #include "libavutil/avassert.h"
37 #include "libavutil/imgutils.h"
38 #include "libavutil/parseutils.h"
39 #include "libavutil/mathematics.h"
40 #include "drawutils.h"
41
42 static const char *const var_names[] = {
43     "PI",
44     "PHI",
45     "E",
46     "in_w",   "iw",
47     "in_h",   "ih",
48     "out_w",  "ow",
49     "out_h",  "oh",
50     "x",
51     "y",
52     "a",
53     "hsub",
54     "vsub",
55     NULL
56 };
57
58 enum var_name {
59     VAR_PI,
60     VAR_PHI,
61     VAR_E,
62     VAR_IN_W,   VAR_IW,
63     VAR_IN_H,   VAR_IH,
64     VAR_OUT_W,  VAR_OW,
65     VAR_OUT_H,  VAR_OH,
66     VAR_X,
67     VAR_Y,
68     VAR_A,
69     VAR_HSUB,
70     VAR_VSUB,
71     VARS_NB
72 };
73
74 static int query_formats(AVFilterContext *ctx)
75 {
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,
80
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,
86         PIX_FMT_YUVA420P,
87
88         PIX_FMT_NONE
89     };
90
91     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
92     return 0;
93 }
94
95 typedef struct {
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
99
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
104
105     uint8_t color[4];       ///< color expressed either in YUVA or RGBA colorspace for the padding area
106     uint8_t *line[4];
107     int      line_step[4];
108     int hsub, vsub;         ///< chroma subsampling values
109     int needs_copy;
110 } PadContext;
111
112 static av_cold int init(AVFilterContext *ctx, const char *args)
113 {
114     PadContext *pad = ctx->priv;
115     char color_string[128] = "black";
116
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));
121
122     if (args)
123         sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]:%255s",
124                pad->w_expr, pad->h_expr, pad->x_expr, pad->y_expr, color_string);
125
126     if (av_parse_color(pad->color, color_string, -1, ctx) < 0)
127         return AVERROR(EINVAL);
128
129     return 0;
130 }
131
132 static av_cold void uninit(AVFilterContext *ctx)
133 {
134     PadContext *pad = ctx->priv;
135     int i;
136
137     for (i = 0; i < 4; i++) {
138         av_freep(&pad->line[i]);
139         pad->line_step[i] = 0;
140     }
141 }
142
143 static int config_input(AVFilterLink *inlink)
144 {
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;
151     char *expr;
152
153     pad->hsub = pix_desc->log2_chroma_w;
154     pad->vsub = pix_desc->log2_chroma_h;
155
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_HSUB]  = 1<<pad->hsub;
165     var_values[VAR_VSUB]  = 1<<pad->vsub;
166
167     /* evaluate width and height */
168     av_expr_parse_and_eval(&res, (expr = pad->w_expr),
169                            var_names, var_values,
170                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
171     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
172     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->h_expr),
173                                       var_names, var_values,
174                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
175         goto eval_fail;
176     pad->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
177     /* evaluate the width again, as it may depend on the evaluated output height */
178     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->w_expr),
179                                       var_names, var_values,
180                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
181         goto eval_fail;
182     pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
183
184     /* evaluate x and y */
185     av_expr_parse_and_eval(&res, (expr = pad->x_expr),
186                            var_names, var_values,
187                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
188     pad->x = var_values[VAR_X] = res;
189     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->y_expr),
190                                       var_names, var_values,
191                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
192         goto eval_fail;
193     pad->y = var_values[VAR_Y] = res;
194     /* evaluate x again, as it may depend on the evaluated y value */
195     if ((ret = av_expr_parse_and_eval(&res, (expr = pad->x_expr),
196                                       var_names, var_values,
197                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
198         goto eval_fail;
199     pad->x = var_values[VAR_X] = res;
200
201     /* sanity check params */
202     if (pad->w < 0 || pad->h < 0 || pad->x < 0 || pad->y < 0) {
203         av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
204         return AVERROR(EINVAL);
205     }
206
207     if (!pad->w)
208         pad->w = inlink->w;
209     if (!pad->h)
210         pad->h = inlink->h;
211
212     pad->w &= ~((1 << pad->hsub) - 1);
213     pad->h &= ~((1 << pad->vsub) - 1);
214     pad->x &= ~((1 << pad->hsub) - 1);
215     pad->y &= ~((1 << pad->vsub) - 1);
216
217     pad->in_w = inlink->w & ~((1 << pad->hsub) - 1);
218     pad->in_h = inlink->h & ~((1 << pad->vsub) - 1);
219
220     memcpy(rgba_color, pad->color, sizeof(rgba_color));
221     ff_fill_line_with_color(pad->line, pad->line_step, pad->w, pad->color,
222                             inlink->format, rgba_color, &is_packed_rgba, NULL);
223
224     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d -> w:%d h:%d x:%d y:%d color:0x%02X%02X%02X%02X[%s]\n",
225            inlink->w, inlink->h, pad->w, pad->h, pad->x, pad->y,
226            pad->color[0], pad->color[1], pad->color[2], pad->color[3],
227            is_packed_rgba ? "rgba" : "yuva");
228
229     if (pad->x <  0 || pad->y <  0                      ||
230         pad->w <= 0 || pad->h <= 0                      ||
231         (unsigned)pad->x + (unsigned)inlink->w > pad->w ||
232         (unsigned)pad->y + (unsigned)inlink->h > pad->h) {
233         av_log(ctx, AV_LOG_ERROR,
234                "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
235                pad->x, pad->y, pad->x + inlink->w, pad->y + inlink->h, pad->w, pad->h);
236         return AVERROR(EINVAL);
237     }
238
239     return 0;
240
241 eval_fail:
242     av_log(NULL, AV_LOG_ERROR,
243            "Error when evaluating the expression '%s'\n", expr);
244     return ret;
245
246 }
247
248 static int config_output(AVFilterLink *outlink)
249 {
250     PadContext *pad = outlink->src->priv;
251
252     outlink->w = pad->w;
253     outlink->h = pad->h;
254     return 0;
255 }
256
257 static AVFilterBufferRef *get_video_buffer(AVFilterLink *inlink, int perms, int w, int h)
258 {
259     PadContext *pad = inlink->dst->priv;
260
261     AVFilterBufferRef *picref = ff_get_video_buffer(inlink->dst->outputs[0], perms,
262                                                     w + (pad->w - pad->in_w),
263                                                     h + (pad->h - pad->in_h));
264     int plane;
265
266     if (!picref)
267         return NULL;
268
269     picref->video->w = w;
270     picref->video->h = h;
271
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;
275
276         picref->data[plane] += (pad->x >> hsub) * pad->line_step[plane] +
277             (pad->y >> vsub) * picref->linesize[plane];
278     }
279
280     return picref;
281 }
282
283 static int does_clip(PadContext *pad, AVFilterBufferRef *outpicref, int plane, int hsub, int vsub, int x, int y)
284 {
285     int64_t x_in_buf, y_in_buf;
286
287     x_in_buf =  outpicref->data[plane] - outpicref->buf->data[plane]
288              +  (x >> hsub) * pad      ->line_step[plane]
289              +  (y >> vsub) * outpicref->linesize [plane];
290
291     if(x_in_buf < 0 || x_in_buf % pad->line_step[plane])
292         return 1;
293     x_in_buf /= pad->line_step[plane];
294
295     av_assert0(outpicref->buf->linesize[plane]>0); //while reference can use negative linesize the main buffer should not
296
297     y_in_buf = x_in_buf / outpicref->buf->linesize[plane];
298     x_in_buf %= outpicref->buf->linesize[plane];
299
300     if(   y_in_buf<<vsub >= outpicref->buf->h
301        || x_in_buf<<hsub >= outpicref->buf->w)
302         return 1;
303     return 0;
304 }
305
306 static int start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
307 {
308     PadContext *pad = inlink->dst->priv;
309     AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
310     AVFilterBufferRef *for_next_filter;
311     int plane, ret = 0;
312
313     if (!outpicref)
314         return AVERROR(ENOMEM);
315
316     for (plane = 0; plane < 4 && outpicref->data[plane]; plane++) {
317         int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
318         int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;
319
320         av_assert0(outpicref->buf->w>0 && outpicref->buf->h>0);
321
322         if(outpicref->format != outpicref->buf->format) //unsupported currently
323             break;
324
325         outpicref->data[plane] -=   (pad->x  >> hsub) * pad      ->line_step[plane]
326                                   + (pad->y  >> vsub) * outpicref->linesize [plane];
327
328         if(   does_clip(pad, outpicref, plane, hsub, vsub, 0, 0)
329            || does_clip(pad, outpicref, plane, hsub, vsub, 0, pad->h-1)
330            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, 0)
331            || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, pad->h-1)
332           )
333             break;
334     }
335     pad->needs_copy= plane < 4 && outpicref->data[plane];
336     if(pad->needs_copy){
337         av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
338         avfilter_unref_buffer(outpicref);
339         outpicref = ff_get_video_buffer(inlink->dst->outputs[0], AV_PERM_WRITE | AV_PERM_NEG_LINESIZES,
340                                         FFMAX(inlink->w, pad->w),
341                                         FFMAX(inlink->h, pad->h));
342         if (!outpicref)
343             return AVERROR(ENOMEM);
344
345         avfilter_copy_buffer_ref_props(outpicref, inpicref);
346     }
347
348     outpicref->video->w = pad->w;
349     outpicref->video->h = pad->h;
350
351     for_next_filter = avfilter_ref_buffer(outpicref, ~0);
352     if (!for_next_filter) {
353         ret = AVERROR(ENOMEM);
354         goto fail;
355     }
356
357     ret = ff_start_frame(inlink->dst->outputs[0], for_next_filter);
358     if (ret < 0)
359         goto fail;
360
361     inlink->dst->outputs[0]->out_buf = outpicref;
362     return 0;
363
364 fail:
365     avfilter_unref_bufferp(&outpicref);
366     return ret;
367 }
368
369 static int end_frame(AVFilterLink *link)
370 {
371     return ff_end_frame(link->dst->outputs[0]);
372 }
373
374 static int draw_send_bar_slice(AVFilterLink *link, int y, int h, int slice_dir, int before_slice)
375 {
376     PadContext *pad = link->dst->priv;
377     int bar_y, bar_h = 0, ret = 0;
378
379     if        (slice_dir * before_slice ==  1 && y == pad->y) {
380         /* top bar */
381         bar_y = 0;
382         bar_h = pad->y;
383     } else if (slice_dir * before_slice == -1 && (y + h) == (pad->y + pad->in_h)) {
384         /* bottom bar */
385         bar_y = pad->y + pad->in_h;
386         bar_h = pad->h - pad->in_h - pad->y;
387     }
388
389     if (bar_h) {
390         ff_draw_rectangle(link->dst->outputs[0]->out_buf->data,
391                           link->dst->outputs[0]->out_buf->linesize,
392                           pad->line, pad->line_step, pad->hsub, pad->vsub,
393                           0, bar_y, pad->w, bar_h);
394         ret = ff_draw_slice(link->dst->outputs[0], bar_y, bar_h, slice_dir);
395     }
396     return ret;
397 }
398
399 static int draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
400 {
401     PadContext *pad = link->dst->priv;
402     AVFilterBufferRef *outpic = link->dst->outputs[0]->out_buf;
403     AVFilterBufferRef *inpic = link->cur_buf;
404     int ret;
405
406     y += pad->y;
407
408     y &= ~((1 << pad->vsub) - 1);
409     h &= ~((1 << pad->vsub) - 1);
410
411     if (!h)
412         return 0;
413     draw_send_bar_slice(link, y, h, slice_dir, 1);
414
415     /* left border */
416     ff_draw_rectangle(outpic->data, outpic->linesize, pad->line, pad->line_step,
417                       pad->hsub, pad->vsub, 0, y, pad->x, h);
418
419     if(pad->needs_copy){
420         ff_copy_rectangle(outpic->data, outpic->linesize,
421                           inpic->data, inpic->linesize, pad->line_step,
422                           pad->hsub, pad->vsub,
423                           pad->x, y, y-pad->y, inpic->video->w, h);
424     }
425
426     /* right border */
427     ff_draw_rectangle(outpic->data, outpic->linesize,
428                       pad->line, pad->line_step, pad->hsub, pad->vsub,
429                       pad->x + pad->in_w, y, pad->w - pad->x - pad->in_w, h);
430     ret = ff_draw_slice(link->dst->outputs[0], y, h, slice_dir);
431     if (ret < 0)
432         return ret;
433
434     return draw_send_bar_slice(link, y, h, slice_dir, -1);
435 }
436
437 AVFilter avfilter_vf_pad = {
438     .name          = "pad",
439     .description   = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
440
441     .priv_size     = sizeof(PadContext),
442     .init          = init,
443     .uninit        = uninit,
444     .query_formats = query_formats,
445
446     .inputs    = (const AVFilterPad[]) {{ .name             = "default",
447                                           .type             = AVMEDIA_TYPE_VIDEO,
448                                           .config_props     = config_input,
449                                           .get_video_buffer = get_video_buffer,
450                                           .start_frame      = start_frame,
451                                           .draw_slice       = draw_slice,
452                                           .end_frame        = end_frame, },
453                                         { .name = NULL}},
454
455     .outputs   = (const AVFilterPad[]) {{ .name             = "default",
456                                           .type             = AVMEDIA_TYPE_VIDEO,
457                                           .config_props     = config_output, },
458                                         { .name = NULL}},
459 };