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
Stefano Sabatini's avatar
Stefano Sabatini committed
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"
Stefano Sabatini's avatar
Stefano Sabatini committed
40
#include "drawutils.h"
41

42
static const char *const var_names[] = {
43 44 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
    "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
};

74 75
static int query_formats(AVFilterContext *ctx)
{
76 77 78 79
    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,
80

81 82 83 84 85 86
        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,
87

88
        AV_PIX_FMT_NONE
89 90
    };

91
    ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
92 93 94
    return 0;
}

Michael Niedermayer's avatar
Michael Niedermayer committed
95 96 97 98 99
typedef struct {
    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

100 101 102 103 104
    char w_expr[256];       ///< width  expression string
    char h_expr[256];       ///< height expression string
    char x_expr[256];       ///< width  expression string
    char y_expr[256];       ///< height expression string

Michael Niedermayer's avatar
Michael Niedermayer committed
105 106 107 108
    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
109
    int needs_copy;
Michael Niedermayer's avatar
Michael Niedermayer committed
110 111
} PadContext;

112
static av_cold int init(AVFilterContext *ctx, const char *args)
Michael Niedermayer's avatar
Michael Niedermayer committed
113 114 115 116
{
    PadContext *pad = ctx->priv;
    char color_string[128] = "black";

117 118 119 120 121
    av_strlcpy(pad->w_expr, "iw", sizeof(pad->w_expr));
    av_strlcpy(pad->h_expr, "ih", sizeof(pad->h_expr));
    av_strlcpy(pad->x_expr, "0" , sizeof(pad->w_expr));
    av_strlcpy(pad->y_expr, "0" , sizeof(pad->h_expr));

Michael Niedermayer's avatar
Michael Niedermayer committed
122
    if (args)
123 124
        sscanf(args, "%255[^:]:%255[^:]:%255[^:]:%255[^:]:%255s",
               pad->w_expr, pad->h_expr, pad->x_expr, pad->y_expr, color_string);
Michael Niedermayer's avatar
Michael Niedermayer committed
125

126
    if (av_parse_color(pad->color, color_string, -1, ctx) < 0)
127
        return AVERROR(EINVAL);
Michael Niedermayer's avatar
Michael Niedermayer committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

    return 0;
}

static av_cold void uninit(AVFilterContext *ctx)
{
    PadContext *pad = ctx->priv;
    int i;

    for (i = 0; i < 4; i++) {
        av_freep(&pad->line[i]);
        pad->line_step[i] = 0;
    }
}

static int config_input(AVFilterLink *inlink)
{
    AVFilterContext *ctx = inlink->dst;
    PadContext *pad = ctx->priv;
147
    const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
Michael Niedermayer's avatar
Michael Niedermayer committed
148
    uint8_t rgba_color[4];
149 150 151
    int ret, is_packed_rgba;
    double var_values[VARS_NB], res;
    char *expr;
Michael Niedermayer's avatar
Michael Niedermayer committed
152 153 154 155

    pad->hsub = pix_desc->log2_chroma_w;
    pad->vsub = pix_desc->log2_chroma_h;

156 157 158 159 160 161 162
    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;
163
    var_values[VAR_A]     = (double) inlink->w / inlink->h;
164
    var_values[VAR_HSUB]  = 1<<pad->hsub;
165
    var_values[VAR_VSUB]  = 1<<pad->vsub;
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

    /* evaluate width and height */
    av_expr_parse_and_eval(&res, (expr = pad->w_expr),
                           var_names, var_values,
                           NULL, NULL, NULL, NULL, NULL, 0, ctx);
    pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
    if ((ret = av_expr_parse_and_eval(&res, (expr = pad->h_expr),
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
    pad->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
    /* evaluate the width again, as it may depend on the evaluated output height */
    if ((ret = av_expr_parse_and_eval(&res, (expr = pad->w_expr),
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
    pad->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;

    /* evaluate x and y */
    av_expr_parse_and_eval(&res, (expr = pad->x_expr),
                           var_names, var_values,
                           NULL, NULL, NULL, NULL, NULL, 0, ctx);
    pad->x = var_values[VAR_X] = res;
    if ((ret = av_expr_parse_and_eval(&res, (expr = pad->y_expr),
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
    pad->y = var_values[VAR_Y] = res;
    /* evaluate x again, as it may depend on the evaluated y value */
    if ((ret = av_expr_parse_and_eval(&res, (expr = pad->x_expr),
                                      var_names, var_values,
                                      NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
        goto eval_fail;
    pad->x = var_values[VAR_X] = res;

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

Michael Niedermayer's avatar
Michael Niedermayer committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220
    if (!pad->w)
        pad->w = inlink->w;
    if (!pad->h)
        pad->h = inlink->h;

    pad->w &= ~((1 << pad->hsub) - 1);
    pad->h &= ~((1 << pad->vsub) - 1);
    pad->x &= ~((1 << pad->hsub) - 1);
    pad->y &= ~((1 << pad->vsub) - 1);

    pad->in_w = inlink->w & ~((1 << pad->hsub) - 1);
    pad->in_h = inlink->h & ~((1 << pad->vsub) - 1);

    memcpy(rgba_color, pad->color, sizeof(rgba_color));
Stefano Sabatini's avatar
Stefano Sabatini committed
221 222
    ff_fill_line_with_color(pad->line, pad->line_step, pad->w, pad->color,
                            inlink->format, rgba_color, &is_packed_rgba, NULL);
Michael Niedermayer's avatar
Michael Niedermayer committed
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,
Michael Niedermayer's avatar
Michael Niedermayer committed
226
           pad->color[0], pad->color[1], pad->color[2], pad->color[3],
227
           is_packed_rgba ? "rgba" : "yuva");
Michael Niedermayer's avatar
Michael Niedermayer committed
228 229 230 231 232 233 234 235

    if (pad->x <  0 || pad->y <  0                      ||
        pad->w <= 0 || pad->h <= 0                      ||
        (unsigned)pad->x + (unsigned)inlink->w > pad->w ||
        (unsigned)pad->y + (unsigned)inlink->h > pad->h) {
        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",
               pad->x, pad->y, pad->x + inlink->w, pad->y + inlink->h, pad->w, pad->h);
236
        return AVERROR(EINVAL);
Michael Niedermayer's avatar
Michael Niedermayer committed
237 238 239
    }

    return 0;
240 241 242 243 244 245

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
246 247 248 249 250 251 252 253 254 255 256
}

static int config_output(AVFilterLink *outlink)
{
    PadContext *pad = outlink->src->priv;

    outlink->w = pad->w;
    outlink->h = pad->h;
    return 0;
}

257
static AVFilterBufferRef *get_video_buffer(AVFilterLink *inlink, int perms, int w, int h)
Michael Niedermayer's avatar
Michael Niedermayer committed
258 259 260
{
    PadContext *pad = inlink->dst->priv;

261 262 263
    AVFilterBufferRef *picref = ff_get_video_buffer(inlink->dst->outputs[0], perms,
                                                    w + (pad->w - pad->in_w),
                                                    h + (pad->h - pad->in_h));
264
    int plane;
Michael Niedermayer's avatar
Michael Niedermayer committed
265

266 267 268
    if (!picref)
        return NULL;

269 270 271
    picref->video->w = w;
    picref->video->h = h;

272
    for (plane = 0; plane < 4 && picref->data[plane]; plane++) {
Michael Niedermayer's avatar
Michael Niedermayer committed
273 274 275 276 277 278 279 280 281 282
        int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
        int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;

        picref->data[plane] += (pad->x >> hsub) * pad->line_step[plane] +
            (pad->y >> vsub) * picref->linesize[plane];
    }

    return picref;
}

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
static int does_clip(PadContext *pad, AVFilterBufferRef *outpicref, int plane, int hsub, int vsub, int x, int y)
{
    int64_t x_in_buf, y_in_buf;

    x_in_buf =  outpicref->data[plane] - outpicref->buf->data[plane]
             +  (x >> hsub) * pad      ->line_step[plane]
             +  (y >> vsub) * outpicref->linesize [plane];

    if(x_in_buf < 0 || x_in_buf % pad->line_step[plane])
        return 1;
    x_in_buf /= pad->line_step[plane];

    av_assert0(outpicref->buf->linesize[plane]>0); //while reference can use negative linesize the main buffer should not

    y_in_buf = x_in_buf / outpicref->buf->linesize[plane];
    x_in_buf %= outpicref->buf->linesize[plane];

    if(   y_in_buf<<vsub >= outpicref->buf->h
       || x_in_buf<<hsub >= outpicref->buf->w)
        return 1;
    return 0;
}

306
static int start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
Michael Niedermayer's avatar
Michael Niedermayer committed
307 308
{
    PadContext *pad = inlink->dst->priv;
309
    AVFilterBufferRef *outpicref = avfilter_ref_buffer(inpicref, ~0);
310
    AVFilterBufferRef *for_next_filter;
311 312 313 314
    int plane, ret = 0;

    if (!outpicref)
        return AVERROR(ENOMEM);
315 316

    for (plane = 0; plane < 4 && outpicref->data[plane]; plane++) {
Michael Niedermayer's avatar
Michael Niedermayer committed
317 318 319
        int hsub = (plane == 1 || plane == 2) ? pad->hsub : 0;
        int vsub = (plane == 1 || plane == 2) ? pad->vsub : 0;

320 321 322 323 324 325 326 327 328 329 330 331 332 333
        av_assert0(outpicref->buf->w>0 && outpicref->buf->h>0);

        if(outpicref->format != outpicref->buf->format) //unsupported currently
            break;

        outpicref->data[plane] -=   (pad->x  >> hsub) * pad      ->line_step[plane]
                                  + (pad->y  >> vsub) * outpicref->linesize [plane];

        if(   does_clip(pad, outpicref, plane, hsub, vsub, 0, 0)
           || does_clip(pad, outpicref, plane, hsub, vsub, 0, pad->h-1)
           || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, 0)
           || does_clip(pad, outpicref, plane, hsub, vsub, pad->w-1, pad->h-1)
          )
            break;
Michael Niedermayer's avatar
Michael Niedermayer committed
334
    }
335 336 337 338
    pad->needs_copy= plane < 4 && outpicref->data[plane];
    if(pad->needs_copy){
        av_log(inlink->dst, AV_LOG_DEBUG, "Direct padding impossible allocating new frame\n");
        avfilter_unref_buffer(outpicref);
339 340 341
        outpicref = ff_get_video_buffer(inlink->dst->outputs[0], AV_PERM_WRITE | AV_PERM_NEG_LINESIZES,
                                        FFMAX(inlink->w, pad->w),
                                        FFMAX(inlink->h, pad->h));
342 343 344
        if (!outpicref)
            return AVERROR(ENOMEM);

345 346 347
        avfilter_copy_buffer_ref_props(outpicref, inpicref);
    }

348 349 350
    outpicref->video->w = pad->w;
    outpicref->video->h = pad->h;

351
    for_next_filter = avfilter_ref_buffer(outpicref, ~0);
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    if (!for_next_filter) {
        ret = AVERROR(ENOMEM);
        goto fail;
    }

    ret = ff_start_frame(inlink->dst->outputs[0], for_next_filter);
    if (ret < 0)
        goto fail;

    inlink->dst->outputs[0]->out_buf = outpicref;
    return 0;

fail:
    avfilter_unref_bufferp(&outpicref);
    return ret;
Michael Niedermayer's avatar
Michael Niedermayer committed
367 368
}

369
static int end_frame(AVFilterLink *link)
Michael Niedermayer's avatar
Michael Niedermayer committed
370
{
371
    return ff_end_frame(link->dst->outputs[0]);
Michael Niedermayer's avatar
Michael Niedermayer committed
372 373
}

374
static int draw_send_bar_slice(AVFilterLink *link, int y, int h, int slice_dir, int before_slice)
Michael Niedermayer's avatar
Michael Niedermayer committed
375 376
{
    PadContext *pad = link->dst->priv;
377
    int bar_y, bar_h = 0, ret = 0;
Michael Niedermayer's avatar
Michael Niedermayer committed
378 379 380 381 382 383 384 385 386 387 388 389

    if        (slice_dir * before_slice ==  1 && y == pad->y) {
        /* top bar */
        bar_y = 0;
        bar_h = pad->y;
    } else if (slice_dir * before_slice == -1 && (y + h) == (pad->y + pad->in_h)) {
        /* bottom bar */
        bar_y = pad->y + pad->in_h;
        bar_h = pad->h - pad->in_h - pad->y;
    }

    if (bar_h) {
Stefano Sabatini's avatar
Stefano Sabatini committed
390 391 392 393
        ff_draw_rectangle(link->dst->outputs[0]->out_buf->data,
                          link->dst->outputs[0]->out_buf->linesize,
                          pad->line, pad->line_step, pad->hsub, pad->vsub,
                          0, bar_y, pad->w, bar_h);
394
        ret = ff_draw_slice(link->dst->outputs[0], bar_y, bar_h, slice_dir);
Michael Niedermayer's avatar
Michael Niedermayer committed
395
    }
396
    return ret;
Michael Niedermayer's avatar
Michael Niedermayer committed
397 398
}

399
static int draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
Michael Niedermayer's avatar
Michael Niedermayer committed
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;
Michael Niedermayer's avatar
Michael Niedermayer committed
405 406 407 408 409 410 411

    y += pad->y;

    y &= ~((1 << pad->vsub) - 1);
    h &= ~((1 << pad->vsub) - 1);

    if (!h)
412
        return 0;
Michael Niedermayer's avatar
Michael Niedermayer committed
413 414 415
    draw_send_bar_slice(link, y, h, slice_dir, 1);

    /* left border */
Stefano Sabatini's avatar
Stefano Sabatini committed
416 417
    ff_draw_rectangle(outpic->data, outpic->linesize, pad->line, pad->line_step,
                      pad->hsub, pad->vsub, 0, y, pad->x, h);
418 419

    if(pad->needs_copy){
Stefano Sabatini's avatar
Stefano Sabatini committed
420 421 422 423
        ff_copy_rectangle(outpic->data, outpic->linesize,
                          inpic->data, inpic->linesize, pad->line_step,
                          pad->hsub, pad->vsub,
                          pad->x, y, y-pad->y, inpic->video->w, h);
424 425
    }

Michael Niedermayer's avatar
Michael Niedermayer committed
426
    /* right border */
Stefano Sabatini's avatar
Stefano Sabatini committed
427 428 429
    ff_draw_rectangle(outpic->data, outpic->linesize,
                      pad->line, pad->line_step, pad->hsub, pad->vsub,
                      pad->x + pad->in_w, y, pad->w - pad->x - pad->in_w, h);
430 431 432
    ret = ff_draw_slice(link->dst->outputs[0], y, h, slice_dir);
    if (ret < 0)
        return ret;
Michael Niedermayer's avatar
Michael Niedermayer committed
433

434
    return draw_send_bar_slice(link, y, h, slice_dir, -1);
Michael Niedermayer's avatar
Michael Niedermayer committed
435 436
}

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
static const AVFilterPad avfilter_vf_pad_inputs[] = {
    {
        .name             = "default",
        .type             = AVMEDIA_TYPE_VIDEO,
        .config_props     = config_input,
        .get_video_buffer = get_video_buffer,
        .start_frame      = start_frame,
        .draw_slice       = draw_slice,
        .end_frame        = end_frame,
    },
    { NULL }
};

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

Michael Niedermayer's avatar
Michael Niedermayer committed
459 460
AVFilter avfilter_vf_pad = {
    .name          = "pad",
461
    .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
462 463 464 465 466 467

    .priv_size     = sizeof(PadContext),
    .init          = init,
    .uninit        = uninit,
    .query_formats = query_formats,

468 469 470
    .inputs    = avfilter_vf_pad_inputs,

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