vf_pad.c 15.2 KB
Newer Older
Michael Niedermayer's avatar
Michael Niedermayer committed
1
/*
2 3
 * Copyright (c) 2008 vmrsss
 * Copyright (c) 2009 Stefano Sabatini
Michael Niedermayer's avatar
Michael Niedermayer committed
4
 *
5
 * This file is part of Libav.
Michael Niedermayer's avatar
Michael Niedermayer committed
6
 *
7
 * Libav is free software; you can redistribute it and/or
Michael Niedermayer's avatar
Michael Niedermayer committed
8 9 10 11
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
12
 * Libav is distributed in the hope that it will be useful,
Michael Niedermayer's avatar
Michael Niedermayer committed
13 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with Libav; if not, write to the Free Software
Michael Niedermayer's avatar
Michael Niedermayer committed
19 20 21 22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
23
 * @file
24
 * video padding filter
Michael Niedermayer's avatar
Michael Niedermayer committed
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"
Michael Niedermayer's avatar
Michael Niedermayer committed
34
#include "libavutil/pixdesc.h"
35
#include "libavutil/colorspace.h"
36
#include "libavutil/avassert.h"
37 38
#include "libavutil/imgutils.h"
#include "libavutil/parseutils.h"
39
#include "libavutil/mathematics.h"
40 41
#include "libavutil/opt.h"

Stefano Sabatini's avatar
Stefano Sabatini committed
42
#include "drawutils.h"
43

44
static const char *const var_names[] = {
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
    "PI",
    "PHI",
    "E",
    "in_w",   "iw",
    "in_h",   "ih",
    "out_w",  "ow",
    "out_h",  "oh",
    "x",
    "y",
    "a",
    "hsub",
    "vsub",
    NULL
};

enum var_name {
    VAR_PI,
    VAR_PHI,
    VAR_E,
    VAR_IN_W,   VAR_IW,
    VAR_IN_H,   VAR_IH,
    VAR_OUT_W,  VAR_OW,
    VAR_OUT_H,  VAR_OH,
    VAR_X,
    VAR_Y,
    VAR_A,
    VAR_HSUB,
    VAR_VSUB,
    VARS_NB
};

76 77
static int query_formats(AVFilterContext *ctx)
{
78 79 80 81
    static const enum AVPixelFormat pix_fmts[] = {
        AV_PIX_FMT_ARGB,         AV_PIX_FMT_RGBA,
        AV_PIX_FMT_ABGR,         AV_PIX_FMT_BGRA,
        AV_PIX_FMT_RGB24,        AV_PIX_FMT_BGR24,
82

83 84 85 86 87 88
        AV_PIX_FMT_YUV444P,      AV_PIX_FMT_YUV422P,
        AV_PIX_FMT_YUV420P,      AV_PIX_FMT_YUV411P,
        AV_PIX_FMT_YUV410P,      AV_PIX_FMT_YUV440P,
        AV_PIX_FMT_YUVJ444P,     AV_PIX_FMT_YUVJ422P,
        AV_PIX_FMT_YUVJ420P,     AV_PIX_FMT_YUVJ440P,
        AV_PIX_FMT_YUVA420P,
89

90
        AV_PIX_FMT_NONE
91 92
    };

93
    ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
94 95 96
    return 0;
}

97
typedef struct PadContext {
98
    const AVClass *class;
Michael Niedermayer's avatar
Michael Niedermayer committed
99 100 101 102
    int w, h;               ///< output dimensions, a value of 0 will result in the input size
    int x, y;               ///< offsets of the input area with respect to the padded area
    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

103 104 105 106 107
    char *w_expr;           ///< width  expression string
    char *h_expr;           ///< height expression string
    char *x_expr;           ///< width  expression string
    char *y_expr;           ///< height expression string
    char *color_str;
108

Michael Niedermayer's avatar
Michael Niedermayer committed
109 110 111 112 113 114
    uint8_t color[4];       ///< color expressed either in YUVA or RGBA colorspace for the padding area
    uint8_t *line[4];
    int      line_step[4];
    int hsub, vsub;         ///< chroma subsampling values
} PadContext;

115
static av_cold int init(AVFilterContext *ctx)
Michael Niedermayer's avatar
Michael Niedermayer committed
116
{
117
    PadContext *s = ctx->priv;
118

119
    if (av_parse_color(s->color, s->color_str, -1, ctx) < 0)
120
        return AVERROR(EINVAL);
Michael Niedermayer's avatar
Michael Niedermayer committed
121 122 123 124 125 126

    return 0;
}

static av_cold void uninit(AVFilterContext *ctx)
{
127
    PadContext *s = ctx->priv;
Michael Niedermayer's avatar
Michael Niedermayer committed
128 129 130
    int i;

    for (i = 0; i < 4; i++) {
131 132
        av_freep(&s->line[i]);
        s->line_step[i] = 0;
Michael Niedermayer's avatar
Michael Niedermayer committed
133 134 135 136 137 138
    }
}

static int config_input(AVFilterLink *inlink)
{
    AVFilterContext *ctx = inlink->dst;
139
    PadContext *s = ctx->priv;
140
    const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
Michael Niedermayer's avatar
Michael Niedermayer committed
141
    uint8_t rgba_color[4];
142 143 144
    int ret, is_packed_rgba;
    double var_values[VARS_NB], res;
    char *expr;
Michael Niedermayer's avatar
Michael Niedermayer committed
145

146 147
    s->hsub = pix_desc->log2_chroma_w;
    s->vsub = pix_desc->log2_chroma_h;
Michael Niedermayer's avatar
Michael Niedermayer committed
148

149 150 151 152 153 154 155
    var_values[VAR_PI]    = M_PI;
    var_values[VAR_PHI]   = M_PHI;
    var_values[VAR_E]     = M_E;
    var_values[VAR_IN_W]  = var_values[VAR_IW] = inlink->w;
    var_values[VAR_IN_H]  = var_values[VAR_IH] = inlink->h;
    var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
    var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
156
    var_values[VAR_A]     = (double) inlink->w / inlink->h;
157 158
    var_values[VAR_HSUB]  = 1<<s->hsub;
    var_values[VAR_VSUB]  = 1<<s->vsub;
159 160

    /* evaluate width and height */
161
    av_expr_parse_and_eval(&res, (expr = s->w_expr),
162 163
                           var_names, var_values,
                           NULL, NULL, NULL, NULL, NULL, 0, ctx);
164 165
    s->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
    if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
166 167 168
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
169
    s->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
170
    /* evaluate the width again, as it may depend on the evaluated output height */
171
    if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
172 173 174
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
175
    s->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
176 177

    /* evaluate x and y */
178
    av_expr_parse_and_eval(&res, (expr = s->x_expr),
179 180
                           var_names, var_values,
                           NULL, NULL, NULL, NULL, NULL, 0, ctx);
181 182
    s->x = var_values[VAR_X] = res;
    if ((ret = av_expr_parse_and_eval(&res, (expr = s->y_expr),
183 184 185
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
186
    s->y = var_values[VAR_Y] = res;
187
    /* evaluate x again, as it may depend on the evaluated y value */
188
    if ((ret = av_expr_parse_and_eval(&res, (expr = s->x_expr),
189 190 191
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
192
    s->x = var_values[VAR_X] = res;
193 194

    /* sanity check params */
195
    if (s->w < 0 || s->h < 0 || s->x < 0 || s->y < 0) {
196 197 198 199
        av_log(ctx, AV_LOG_ERROR, "Negative values are not acceptable.\n");
        return AVERROR(EINVAL);
    }

200 201 202 203
    if (!s->w)
        s->w = inlink->w;
    if (!s->h)
        s->h = inlink->h;
Michael Niedermayer's avatar
Michael Niedermayer committed
204

205 206 207 208
    s->w &= ~((1 << s->hsub) - 1);
    s->h &= ~((1 << s->vsub) - 1);
    s->x &= ~((1 << s->hsub) - 1);
    s->y &= ~((1 << s->vsub) - 1);
Michael Niedermayer's avatar
Michael Niedermayer committed
209

210 211
    s->in_w = inlink->w & ~((1 << s->hsub) - 1);
    s->in_h = inlink->h & ~((1 << s->vsub) - 1);
Michael Niedermayer's avatar
Michael Niedermayer committed
212

213 214
    memcpy(rgba_color, s->color, sizeof(rgba_color));
    ff_fill_line_with_color(s->line, s->line_step, s->w, s->color,
Stefano Sabatini's avatar
Stefano Sabatini committed
215
                            inlink->format, rgba_color, &is_packed_rgba, NULL);
Michael Niedermayer's avatar
Michael Niedermayer committed
216

217
    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",
218 219
           inlink->w, inlink->h, s->w, s->h, s->x, s->y,
           s->color[0], s->color[1], s->color[2], s->color[3],
220
           is_packed_rgba ? "rgba" : "yuva");
Michael Niedermayer's avatar
Michael Niedermayer committed
221

222 223 224 225
    if (s->x <  0 || s->y <  0                      ||
        s->w <= 0 || s->h <= 0                      ||
        (unsigned)s->x + (unsigned)inlink->w > s->w ||
        (unsigned)s->y + (unsigned)inlink->h > s->h) {
Michael Niedermayer's avatar
Michael Niedermayer committed
226 227
        av_log(ctx, AV_LOG_ERROR,
               "Input area %d:%d:%d:%d not within the padded area 0:0:%d:%d or zero-sized\n",
228
               s->x, s->y, s->x + inlink->w, s->y + inlink->h, s->w, s->h);
229
        return AVERROR(EINVAL);
Michael Niedermayer's avatar
Michael Niedermayer committed
230 231 232
    }

    return 0;
233 234 235 236 237 238

eval_fail:
    av_log(NULL, AV_LOG_ERROR,
           "Error when evaluating the expression '%s'\n", expr);
    return ret;

Michael Niedermayer's avatar
Michael Niedermayer committed
239 240 241 242
}

static int config_output(AVFilterLink *outlink)
{
243
    PadContext *s = outlink->src->priv;
Michael Niedermayer's avatar
Michael Niedermayer committed
244

245 246
    outlink->w = s->w;
    outlink->h = s->h;
Michael Niedermayer's avatar
Michael Niedermayer committed
247 248 249
    return 0;
}

250
static AVFrame *get_video_buffer(AVFilterLink *inlink, int w, int h)
Michael Niedermayer's avatar
Michael Niedermayer committed
251
{
252
    PadContext *s = inlink->dst->priv;
Michael Niedermayer's avatar
Michael Niedermayer committed
253

254
    AVFrame *frame = ff_get_video_buffer(inlink->dst->outputs[0],
255 256
                                         w + (s->w - s->in_w),
                                         h + (s->h - s->in_h));
257
    int plane;
Michael Niedermayer's avatar
Michael Niedermayer committed
258

259
    if (!frame)
260 261
        return NULL;

262 263
    frame->width  = w;
    frame->height = h;
264

265
    for (plane = 0; plane < 4 && frame->data[plane]; plane++) {
266 267
        int hsub = (plane == 1 || plane == 2) ? s->hsub : 0;
        int vsub = (plane == 1 || plane == 2) ? s->vsub : 0;
Michael Niedermayer's avatar
Michael Niedermayer committed
268

269 270
        frame->data[plane] += (s->x >> hsub) * s->line_step[plane] +
            (s->y >> vsub) * frame->linesize[plane];
Michael Niedermayer's avatar
Michael Niedermayer committed
271 272
    }

273
    return frame;
Michael Niedermayer's avatar
Michael Niedermayer committed
274 275
}

276 277
/* check whether each plane in this buffer can be padded without copying */
static int buffer_needs_copy(PadContext *s, AVFrame *frame, AVBufferRef *buf)
278
{
279 280
    int planes[4] = { -1, -1, -1, -1}, *p = planes;
    int i, j;
281

282 283 284 285 286
    /* get all planes in this buffer */
    for (i = 0; i < FF_ARRAY_ELEMS(planes) && frame->data[i]; i++) {
        if (av_frame_get_plane_buffer(frame, i) == buf)
            *p++ = i;
    }
287

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
    /* for each plane in this buffer, check that it can be padded without
     * going over buffer bounds or other planes */
    for (i = 0; i < FF_ARRAY_ELEMS(planes) && planes[i] >= 0; i++) {
        int hsub = (planes[i] == 1 || planes[i] == 2) ? s->hsub : 0;
        int vsub = (planes[i] == 1 || planes[i] == 2) ? s->vsub : 0;

        uint8_t *start = frame->data[planes[i]];
        uint8_t *end   = start + (frame->height >> hsub) *
                                 frame->linesize[planes[i]];

        /* amount of free space needed before the start and after the end
         * of the plane */
        ptrdiff_t req_start = (s->x >> hsub) * s->line_step[planes[i]] +
                              (s->y >> vsub) * frame->linesize[planes[i]];
        ptrdiff_t req_end   = ((s->w - s->x - frame->width) >> hsub) *
                              s->line_step[planes[i]] +
                              (s->y >> vsub) * frame->linesize[planes[i]];

        if (frame->linesize[planes[i]] < (s->w >> hsub) * s->line_step[planes[i]])
            return 1;
        if (start - buf->data < req_start ||
            (buf->data + buf->size) - end < req_end)
            return 1;

#define SIGN(x) ((x) > 0 ? 1 : -1)
313
        for (j = 0; j < FF_ARRAY_ELEMS(planes) && planes[j] >= 0; j++) {
314 315 316 317 318 319 320 321 322 323 324 325
            int hsub1 = (planes[j] == 1 || planes[j] == 2) ? s->hsub : 0;
            uint8_t *start1 = frame->data[planes[j]];
            uint8_t *end1   = start1 + (frame->height >> hsub1) *
                                       frame->linesize[planes[j]];
            if (i == j)
                continue;

            if (SIGN(start - end1) != SIGN(start - end1 - req_start) ||
                SIGN(end - start1) != SIGN(end - start1 + req_end))
                return 1;
        }
    }
326

327 328
    return 0;
}
329

330 331 332
static int frame_needs_copy(PadContext *s, AVFrame *frame)
{
    int i;
333

334
    if (!av_frame_is_writable(frame))
335
        return 1;
336 337 338 339

    for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++)
        if (buffer_needs_copy(s, frame, frame->buf[i]))
            return 1;
340 341 342
    return 0;
}

343
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
Michael Niedermayer's avatar
Michael Niedermayer committed
344
{
345
    PadContext *s = inlink->dst->priv;
346
    AVFrame *out;
347
    int needs_copy = frame_needs_copy(s, in);
348

349
    if (needs_copy) {
350
        av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
351
        out = ff_get_video_buffer(inlink->dst->outputs[0],
352 353
                                  FFMAX(inlink->w, s->w),
                                  FFMAX(inlink->h, s->h));
354
        if (!out) {
355
            av_frame_free(&in);
356
            return AVERROR(ENOMEM);
357
        }
358

359 360 361
        av_frame_copy_props(out, in);
    } else {
        int i;
362

363 364
        out = in;
        for (i = 0; i < FF_ARRAY_ELEMS(out->data) && out->data[i]; i++) {
365 366 367 368
            int hsub = (i == 1 || i == 2) ? s->hsub : 0;
            int vsub = (i == 1 || i == 2) ? s->vsub : 0;
            out->data[i] -= (s->x >> hsub) * s->line_step[i] +
                            (s->y >> vsub) * out->linesize[i];
369 370
        }
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
371

372
    /* top bar */
373
    if (s->y) {
374
        ff_draw_rectangle(out->data, out->linesize,
375 376
                          s->line, s->line_step, s->hsub, s->vsub,
                          0, 0, s->w, s->y);
Michael Niedermayer's avatar
Michael Niedermayer committed
377 378
    }

379
    /* bottom bar */
380
    if (s->h > s->y + s->in_h) {
381
        ff_draw_rectangle(out->data, out->linesize,
382 383
                          s->line, s->line_step, s->hsub, s->vsub,
                          0, s->y + s->in_h, s->w, s->h - s->y - s->in_h);
Michael Niedermayer's avatar
Michael Niedermayer committed
384 385 386
    }

    /* left border */
387 388
    ff_draw_rectangle(out->data, out->linesize, s->line, s->line_step,
                      s->hsub, s->vsub, 0, s->y, s->x, in->height);
389 390 391

    if (needs_copy) {
        ff_copy_rectangle(out->data, out->linesize, in->data, in->linesize,
392 393
                          s->line_step, s->hsub, s->vsub,
                          s->x, s->y, 0, in->width, in->height);
394 395
    }

Michael Niedermayer's avatar
Michael Niedermayer committed
396
    /* right border */
397
    ff_draw_rectangle(out->data, out->linesize,
398 399
                      s->line, s->line_step, s->hsub, s->vsub,
                      s->x + s->in_w, s->y, s->w - s->x - s->in_w,
400 401
                      in->height);

402 403
    out->width  = s->w;
    out->height = s->h;
Michael Niedermayer's avatar
Michael Niedermayer committed
404

405 406
    if (in != out)
        av_frame_free(&in);
407
    return ff_filter_frame(inlink->dst->outputs[0], out);
Michael Niedermayer's avatar
Michael Niedermayer committed
408 409
}

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
#define OFFSET(x) offsetof(PadContext, x)
#define FLAGS AV_OPT_FLAG_VIDEO_PARAM
static const AVOption options[] = {
    { "width",  "Output video width",       OFFSET(w_expr),    AV_OPT_TYPE_STRING, { .str = "iw" },    .flags = FLAGS },
    { "height", "Output video height",      OFFSET(h_expr),    AV_OPT_TYPE_STRING, { .str = "ih" },    .flags = FLAGS },
    { "x",      "Horizontal position of the left edge of the input video in the "
        "output video",                     OFFSET(x_expr),    AV_OPT_TYPE_STRING, { .str = "0"  },    .flags = FLAGS },
    { "y",      "Vertical position of the top edge of the input video in the "
        "output video",                     OFFSET(y_expr),    AV_OPT_TYPE_STRING, { .str = "0"  },    .flags = FLAGS },
    { "color",  "Color of the padded area", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, .flags = FLAGS },
    { NULL },
};

static const AVClass pad_class = {
    .class_name = "pad",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
};

430 431 432 433 434 435
static const AVFilterPad avfilter_vf_pad_inputs[] = {
    {
        .name             = "default",
        .type             = AVMEDIA_TYPE_VIDEO,
        .config_props     = config_input,
        .get_video_buffer = get_video_buffer,
436
        .filter_frame     = filter_frame,
437 438 439 440 441 442 443 444 445 446 447 448 449
    },
    { NULL }
};

static const AVFilterPad avfilter_vf_pad_outputs[] = {
    {
        .name         = "default",
        .type         = AVMEDIA_TYPE_VIDEO,
        .config_props = config_output,
    },
    { NULL }
};

450
AVFilter ff_vf_pad = {
Michael Niedermayer's avatar
Michael Niedermayer committed
451
    .name          = "pad",
452
    .description   = NULL_IF_CONFIG_SMALL("Pad input image to width:height[:x:y[:color]] (default x and y: 0, default color: black)."),
Michael Niedermayer's avatar
Michael Niedermayer committed
453 454

    .priv_size     = sizeof(PadContext),
455
    .priv_class    = &pad_class,
Michael Niedermayer's avatar
Michael Niedermayer committed
456 457 458 459
    .init          = init,
    .uninit        = uninit,
    .query_formats = query_formats,

460 461 462
    .inputs    = avfilter_vf_pad_inputs,

    .outputs   = avfilter_vf_pad_outputs,
Michael Niedermayer's avatar
Michael Niedermayer committed
463
};