git.sesse.net Git - ffmpeg/blob - 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/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/opt.h"
  39 #include "libavutil/parseutils.h"
  40 #include "libavutil/mathematics.h"
  41 #include "libavutil/opt.h"
  42
  43 #include "drawutils.h"
  44
  45 static const char *const var_names[] = {
  46     "in_w",   "iw",
  47     "in_h",   "ih",
  48     "out_w",  "ow",
  49     "out_h",  "oh",
  50     "x",
  51     "y",
  52     "a",
  53     "sar",
  54     "dar",
  55     "hsub",
  56     "vsub",
  57     NULL
  58 };
  59
  60 enum var_name {
  61     VAR_IN_W,   VAR_IW,
  62     VAR_IN_H,   VAR_IH,
  63     VAR_OUT_W,  VAR_OW,
  64     VAR_OUT_H,  VAR_OH,
  65     VAR_X,
  66     VAR_Y,
  67     VAR_A,
  68     VAR_SAR,
  69     VAR_DAR,
  70     VAR_HSUB,
  71     VAR_VSUB,
  72     VARS_NB
  73 };
  74
  75 static int query_formats(AVFilterContext *ctx)
  76 {
  77     ff_set_common_formats(ctx, ff_draw_supported_pixel_formats(0));
  78     return 0;
  79 }
  80
  81 typedef struct {
  82     const AVClass *class;
  83     int w, h;               ///< output dimensions, a value of 0 will result in the input size
  84     int x, y;               ///< offsets of the input area with respect to the padded area
  85     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
  86
  87     char *w_expr;           ///< width  expression string
  88     char *h_expr;           ///< height expression string
  89     char *x_expr;           ///< width  expression string
  90     char *y_expr;           ///< height expression string
  91     char *color_str;
  92     uint8_t rgba_color[4];  ///< color for the padding area
  93     FFDrawContext draw;
  94     FFDrawColor color;
  95 } PadContext;
  96
  97 static av_cold int init(AVFilterContext *ctx)
  98 {
  99     PadContext *s = ctx->priv;
 100
 101     if (av_parse_color(s->rgba_color, s->color_str, -1, ctx) < 0)
 102         return AVERROR(EINVAL);
 103
 104     return 0;
 105 }
 106
 107 static int config_input(AVFilterLink *inlink)
 108 {
 109     AVFilterContext *ctx = inlink->dst;
 110     PadContext *s = ctx->priv;
 111     int ret;
 112     double var_values[VARS_NB], res;
 113     char *expr;
 114
 115     ff_draw_init(&s->draw, inlink->format, 0);
 116     ff_draw_color(&s->draw, &s->color, s->rgba_color);
 117
 118     var_values[VAR_IN_W]  = var_values[VAR_IW] = inlink->w;
 119     var_values[VAR_IN_H]  = var_values[VAR_IH] = inlink->h;
 120     var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
 121     var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
 122     var_values[VAR_A]     = (double) inlink->w / inlink->h;
 123     var_values[VAR_SAR]   = inlink->sample_aspect_ratio.num ?
 124         (double) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
 125     var_values[VAR_DAR]   = var_values[VAR_A] * var_values[VAR_SAR];
 126     var_values[VAR_HSUB]  = 1 << s->draw.hsub_max;
 127     var_values[VAR_VSUB]  = 1 << s->draw.vsub_max;
 128
 129     /* evaluate width and height */
 130     av_expr_parse_and_eval(&res, (expr = s->w_expr),
 131                            var_names, var_values,
 132                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
 133     s->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
 134     if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
 135                                       var_names, var_values,
 136                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 137         goto eval_fail;
 138     s->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
 139     /* evaluate the width again, as it may depend on the evaluated output height */
 140     if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
 141                                       var_names, var_values,
 142                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 143         goto eval_fail;
 144     s->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
 145
 146     /* evaluate x and y */
 147     av_expr_parse_and_eval(&res, (expr = s->x_expr),
 148                            var_names, var_values,
 149                            NULL, NULL, NULL, NULL, NULL, 0, ctx);
 150     s->x = var_values[VAR_X] = res;
 151     if ((ret = av_expr_parse_and_eval(&res, (expr = s->y_expr),
 152                                       var_names, var_values,
 153                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 154         goto eval_fail;
 155     s->y = var_values[VAR_Y] = res;
 156     /* evaluate x again, as it may depend on the evaluated y value */
 157     if ((ret = av_expr_parse_and_eval(&res, (expr = s->x_expr),
 158                                       var_names, var_values,
 159                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
 160         goto eval_fail;
 161     s->x = var_values[VAR_X] = res;
 162
 163     /* sanity check params */
 164     if (s->w < 0 || s->h < 0 || s->x < 0 || s->y < 0) {
 165         av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
 166         return AVERROR(EINVAL);
 167     }
 168
 169     if (!s->w)
 170         s->w = inlink->w;
 171     if (!s->h)
 172         s->h = inlink->h;
 173
 174     s->w    = ff_draw_round_to_sub(&s->draw, 0, -1, s->w);
 175     s->h    = ff_draw_round_to_sub(&s->draw, 1, -1, s->h);
 176     s->x    = ff_draw_round_to_sub(&s->draw, 0, -1, s->x);
 177     s->y    = ff_draw_round_to_sub(&s->draw, 1, -1, s->y);
 178     s->in_w = ff_draw_round_to_sub(&s->draw, 0, -1, inlink->w);
 179     s->in_h = ff_draw_round_to_sub(&s->draw, 1, -1, inlink->h);
 180
 181     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d -> w:%d h:%d x:%d y:%d color:0x%02X%02X%02X%02X\n",
 182            inlink->w, inlink->h, s->w, s->h, s->x, s->y,
 183            s->rgba_color[0], s->rgba_color[1], s->rgba_color[2], s->rgba_color[3]);
 184
 185     if (s->x <  0 || s->y <  0                      ||
 186         s->w <= 0 || s->h <= 0                      ||
 187         (unsigned)s->x + (unsigned)inlink->w > s->w ||
 188         (unsigned)s->y + (unsigned)inlink->h > s->h) {
 189         av_log(ctx, AV_LOG_ERROR,
 190                "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
 191                s->x, s->y, s->x + inlink->w, s->y + inlink->h, s->w, s->h);
 192         return AVERROR(EINVAL);
 193     }
 194
 195     return 0;
 196
 197 eval_fail:
 198     av_log(NULL, AV_LOG_ERROR,
 199            "Error when evaluating the expression '%s'\n", expr);
 200     return ret;
 201
 202 }
 203
 204 static int config_output(AVFilterLink *outlink)
 205 {
 206     PadContext *s = outlink->src->priv;
 207
 208     outlink->w = s->w;
 209     outlink->h = s->h;
 210     return 0;
 211 }
 212
 213 static AVFrame *get_video_buffer(AVFilterLink *inlink, int w, int h)
 214 {
 215     PadContext *s = inlink->dst->priv;
 216
 217     AVFrame *frame = ff_get_video_buffer(inlink->dst->outputs[0],
 218                                          w + (s->w - s->in_w),
 219                                          h + (s->h - s->in_h));
 220     int plane;
 221
 222     if (!frame)
 223         return NULL;
 224
 225     frame->width  = w;
 226     frame->height = h;
 227
 228     for (plane = 0; plane < 4 && frame->data[plane]; plane++) {
 229         int hsub = s->draw.hsub[plane];
 230         int vsub = s->draw.vsub[plane];
 231         frame->data[plane] += (s->x >> hsub) * s->draw.pixelstep[plane] +
 232                               (s->y >> vsub) * frame->linesize[plane];
 233     }
 234
 235     return frame;
 236 }
 237
 238 /* check whether each plane in this buffer can be padded without copying */
 239 static int buffer_needs_copy(PadContext *s, AVFrame *frame, AVBufferRef *buf)
 240 {
 241     int planes[4] = { -1, -1, -1, -1}, *p = planes;
 242     int i, j;
 243
 244     /* get all planes in this buffer */
 245     for (i = 0; i < FF_ARRAY_ELEMS(planes) && frame->data[i]; i++) {
 246         if (av_frame_get_plane_buffer(frame, i) == buf)
 247             *p++ = i;
 248     }
 249
 250     /* for each plane in this buffer, check that it can be padded without
 251      * going over buffer bounds or other planes */
 252     for (i = 0; i < FF_ARRAY_ELEMS(planes) && planes[i] >= 0; i++) {
 253         int hsub = s->draw.hsub[planes[i]];
 254         int vsub = s->draw.vsub[planes[i]];
 255
 256         uint8_t *start = frame->data[planes[i]];
 257         uint8_t *end   = start + (frame->height >> vsub) *
 258                                  frame->linesize[planes[i]];
 259
 260         /* amount of free space needed before the start and after the end
 261          * of the plane */
 262         ptrdiff_t req_start = (s->x >> hsub) * s->draw.pixelstep[planes[i]] +
 263                               (s->y >> vsub) * frame->linesize[planes[i]];
 264         ptrdiff_t req_end   = ((s->w - s->x - frame->width) >> hsub) *
 265                               s->draw.pixelstep[planes[i]] +
 266                               (s->y >> vsub) * frame->linesize[planes[i]];
 267
 268         if (frame->linesize[planes[i]] < (s->w >> hsub) * s->draw.pixelstep[planes[i]])
 269             return 1;
 270         if (start - buf->data < req_start ||
 271             (buf->data + buf->size) - end < req_end)
 272             return 1;
 273
 274 #define SIGN(x) ((x) > 0 ? 1 : -1)
 275         for (j = 0; j < FF_ARRAY_ELEMS(planes) && planes[j] >= 0; j++) {
 276             int vsub1 = s->draw.vsub[planes[j]];
 277             uint8_t *start1 = frame->data[planes[j]];
 278             uint8_t *end1   = start1 + (frame->height >> vsub1) *
 279                                        frame->linesize[planes[j]];
 280             if (i == j)
 281                 continue;
 282
 283             if (SIGN(start - end1) != SIGN(start - end1 - req_start) ||
 284                 SIGN(end - start1) != SIGN(end - start1 + req_end))
 285                 return 1;
 286         }
 287     }
 288
 289     return 0;
 290 }
 291
 292 static int frame_needs_copy(PadContext *s, AVFrame *frame)
 293 {
 294     int i;
 295
 296     if (!av_frame_is_writable(frame))
 297         return 1;
 298
 299     for (i = 0; i < 4 && frame->buf[i]; i++)
 300         if (buffer_needs_copy(s, frame, frame->buf[i]))
 301             return 1;
 302     return 0;
 303 }
 304
 305 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 306 {
 307     PadContext *s = inlink->dst->priv;
 308     AVFrame *out;
 309     int needs_copy = frame_needs_copy(s, in);
 310
 311     if (needs_copy) {
 312         av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
 313         out = ff_get_video_buffer(inlink->dst->outputs[0],
 314                                   FFMAX(inlink->w, s->w),
 315                                   FFMAX(inlink->h, s->h));
 316         if (!out) {
 317             av_frame_free(&in);
 318             return AVERROR(ENOMEM);
 319         }
 320
 321         av_frame_copy_props(out, in);
 322     } else {
 323         int i;
 324
 325         out = in;
 326         for (i = 0; i < 4 && out->data[i]; i++) {
 327             int hsub = s->draw.hsub[i];
 328             int vsub = s->draw.vsub[i];
 329             out->data[i] -= (s->x >> hsub) * s->draw.pixelstep[i] +
 330                             (s->y >> vsub) * out->linesize[i];
 331         }
 332     }
 333
 334     /* top bar */
 335     if (s->y) {
 336         ff_fill_rectangle(&s->draw, &s->color,
 337                           out->data, out->linesize,
 338                           0, 0, s->w, s->y);
 339     }
 340
 341     /* bottom bar */
 342     if (s->h > s->y + s->in_h) {
 343         ff_fill_rectangle(&s->draw, &s->color,
 344                           out->data, out->linesize,
 345                           0, s->y + s->in_h, s->w, s->h - s->y - s->in_h);
 346     }
 347
 348     /* left border */
 349     ff_fill_rectangle(&s->draw, &s->color, out->data, out->linesize,
 350                       0, s->y, s->x, in->height);
 351
 352     if (needs_copy) {
 353         ff_copy_rectangle2(&s->draw,
 354                           out->data, out->linesize, in->data, in->linesize,
 355                           s->x, s->y, 0, 0, in->width, in->height);
 356     }
 357
 358     /* right border */
 359     ff_fill_rectangle(&s->draw, &s->color, out->data, out->linesize,
 360                       s->x + s->in_w, s->y, s->w - s->x - s->in_w,
 361                       in->height);
 362
 363     out->width  = s->w;
 364     out->height = s->h;
 365
 366     if (in != out)
 367         av_frame_free(&in);
 368     return ff_filter_frame(inlink->dst->outputs[0], out);
 369 }
 370
 371 #define OFFSET(x) offsetof(PadContext, x)
 372 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 373
 374 static const AVOption pad_options[] = {
 375     { "width",  "set the pad area width expression",       OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
 376     { "w",      "set the pad area width expression",       OFFSET(w_expr), AV_OPT_TYPE_STRING, {.str = "iw"}, CHAR_MIN, CHAR_MAX, FLAGS },
 377     { "height", "set the pad area height expression",      OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
 378     { "h",      "set the pad area height expression",      OFFSET(h_expr), AV_OPT_TYPE_STRING, {.str = "ih"}, CHAR_MIN, CHAR_MAX, FLAGS },
 379     { "x",      "set the x offset expression for the input image position", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
 380     { "y",      "set the y offset expression for the input image position", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
 381     { "color",  "set the color of the padded area border", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str = "black"}, .flags = FLAGS },
 382     { NULL },
 383 };
 384
 385 AVFILTER_DEFINE_CLASS(pad);
 386
 387 static const AVFilterPad avfilter_vf_pad_inputs[] = {
 388     {
 389         .name             = "default",
 390         .type             = AVMEDIA_TYPE_VIDEO,
 391         .config_props     = config_input,
 392         .get_video_buffer = get_video_buffer,
 393         .filter_frame     = filter_frame,
 394     },
 395     { NULL }
 396 };
 397
 398 static const AVFilterPad avfilter_vf_pad_outputs[] = {
 399     {
 400         .name         = "default",
 401         .type         = AVMEDIA_TYPE_VIDEO,
 402         .config_props = config_output,
 403     },
 404     { NULL }
 405 };
 406
 407 AVFilter avfilter_vf_pad = {
 408     .name          = "pad",
 409     .description   = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
 410
 411     .priv_size     = sizeof(PadContext),
 412     .priv_class    = &pad_class,
 413     .init          = init,
 414     .query_formats = query_formats,
 415
 416     .inputs    = avfilter_vf_pad_inputs,
 417
 418     .outputs   = avfilter_vf_pad_outputs,
 419 };