git.sesse.net Git - ffmpeg/blob - libavfilter/vf_overlay.c

   1 /*
   2  * Copyright (c) 2010 Stefano Sabatini
   3  * Copyright (c) 2010 Baptiste Coudurier
   4  * Copyright (c) 2007 Bobby Bingham
   5  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * FFmpeg is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with FFmpeg; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 /**
  24  * @file
  25  * overlay one video on top of another
  26  */
  27
  28 #include "avfilter.h"
  29 #include "formats.h"
  30 #include "libavutil/common.h"
  31 #include "libavutil/eval.h"
  32 #include "libavutil/avstring.h"
  33 #include "libavutil/pixdesc.h"
  34 #include "libavutil/imgutils.h"
  35 #include "libavutil/mathematics.h"
  36 #include "libavutil/opt.h"
  37 #include "libavutil/timestamp.h"
  38 #include "internal.h"
  39 #include "drawutils.h"
  40 #include "framesync.h"
  41 #include "video.h"
  42
  43 static const char *const var_names[] = {
  44     "main_w",    "W", ///< width  of the main    video
  45     "main_h",    "H", ///< height of the main    video
  46     "overlay_w", "w", ///< width  of the overlay video
  47     "overlay_h", "h", ///< height of the overlay video
  48     "hsub",
  49     "vsub",
  50     "x",
  51     "y",
  52     "n",            ///< number of frame
  53     "pos",          ///< position in the file
  54     "t",            ///< timestamp expressed in seconds
  55     NULL
  56 };
  57
  58 enum var_name {
  59     VAR_MAIN_W,    VAR_MW,
  60     VAR_MAIN_H,    VAR_MH,
  61     VAR_OVERLAY_W, VAR_OW,
  62     VAR_OVERLAY_H, VAR_OH,
  63     VAR_HSUB,
  64     VAR_VSUB,
  65     VAR_X,
  66     VAR_Y,
  67     VAR_N,
  68     VAR_POS,
  69     VAR_T,
  70     VAR_VARS_NB
  71 };
  72
  73 #define MAIN    0
  74 #define OVERLAY 1
  75
  76 #define R 0
  77 #define G 1
  78 #define B 2
  79 #define A 3
  80
  81 #define Y 0
  82 #define U 1
  83 #define V 2
  84
  85 enum EvalMode {
  86     EVAL_MODE_INIT,
  87     EVAL_MODE_FRAME,
  88     EVAL_MODE_NB
  89 };
  90
  91 enum OverlayFormat {
  92     OVERLAY_FORMAT_YUV420,
  93     OVERLAY_FORMAT_YUV422,
  94     OVERLAY_FORMAT_YUV444,
  95     OVERLAY_FORMAT_RGB,
  96     OVERLAY_FORMAT_GBRP,
  97     OVERLAY_FORMAT_AUTO,
  98     OVERLAY_FORMAT_NB
  99 };
 100
 101 typedef struct OverlayContext {
 102     const AVClass *class;
 103     int x, y;                   ///< position of overlaid picture
 104
 105     uint8_t main_is_packed_rgb;
 106     uint8_t main_rgba_map[4];
 107     uint8_t main_has_alpha;
 108     uint8_t overlay_is_packed_rgb;
 109     uint8_t overlay_rgba_map[4];
 110     uint8_t overlay_has_alpha;
 111     int format;                 ///< OverlayFormat
 112     int alpha_format;
 113     int eval_mode;              ///< EvalMode
 114
 115     FFFrameSync fs;
 116
 117     int main_pix_step[4];       ///< steps per pixel for each plane of the main output
 118     int overlay_pix_step[4];    ///< steps per pixel for each plane of the overlay
 119     int hsub, vsub;             ///< chroma subsampling values
 120     const AVPixFmtDescriptor *main_desc; ///< format descriptor for main input
 121
 122     double var_values[VAR_VARS_NB];
 123     char *x_expr, *y_expr;
 124
 125     AVExpr *x_pexpr, *y_pexpr;
 126
 127     void (*blend_image)(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y);
 128 } OverlayContext;
 129
 130 static av_cold void uninit(AVFilterContext *ctx)
 131 {
 132     OverlayContext *s = ctx->priv;
 133
 134     ff_framesync_uninit(&s->fs);
 135     av_expr_free(s->x_pexpr); s->x_pexpr = NULL;
 136     av_expr_free(s->y_pexpr); s->y_pexpr = NULL;
 137 }
 138
 139 static inline int normalize_xy(double d, int chroma_sub)
 140 {
 141     if (isnan(d))
 142         return INT_MAX;
 143     return (int)d & ~((1 << chroma_sub) - 1);
 144 }
 145
 146 static void eval_expr(AVFilterContext *ctx)
 147 {
 148     OverlayContext *s = ctx->priv;
 149
 150     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
 151     s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, NULL);
 152     /* It is necessary if x is expressed from y  */
 153     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
 154     s->x = normalize_xy(s->var_values[VAR_X], s->hsub);
 155     s->y = normalize_xy(s->var_values[VAR_Y], s->vsub);
 156 }
 157
 158 static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
 159 {
 160     int ret;
 161     AVExpr *old = NULL;
 162
 163     if (*pexpr)
 164         old = *pexpr;
 165     ret = av_expr_parse(pexpr, expr, var_names,
 166                         NULL, NULL, NULL, NULL, 0, log_ctx);
 167     if (ret < 0) {
 168         av_log(log_ctx, AV_LOG_ERROR,
 169                "Error when evaluating the expression '%s' for %s\n",
 170                expr, option);
 171         *pexpr = old;
 172         return ret;
 173     }
 174
 175     av_expr_free(old);
 176     return 0;
 177 }
 178
 179 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
 180                            char *res, int res_len, int flags)
 181 {
 182     OverlayContext *s = ctx->priv;
 183     int ret;
 184
 185     if      (!strcmp(cmd, "x"))
 186         ret = set_expr(&s->x_pexpr, args, cmd, ctx);
 187     else if (!strcmp(cmd, "y"))
 188         ret = set_expr(&s->y_pexpr, args, cmd, ctx);
 189     else
 190         ret = AVERROR(ENOSYS);
 191
 192     if (ret < 0)
 193         return ret;
 194
 195     if (s->eval_mode == EVAL_MODE_INIT) {
 196         eval_expr(ctx);
 197         av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
 198                s->var_values[VAR_X], s->x,
 199                s->var_values[VAR_Y], s->y);
 200     }
 201     return ret;
 202 }
 203
 204 static const enum AVPixelFormat alpha_pix_fmts[] = {
 205     AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
 206     AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA,
 207     AV_PIX_FMT_BGRA, AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
 208 };
 209
 210 static int query_formats(AVFilterContext *ctx)
 211 {
 212     OverlayContext *s = ctx->priv;
 213
 214     /* overlay formats contains alpha, for avoiding conversion with alpha information loss */
 215     static const enum AVPixelFormat main_pix_fmts_yuv420[] = {
 216         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVA420P,
 217         AV_PIX_FMT_NV12, AV_PIX_FMT_NV21,
 218         AV_PIX_FMT_NONE
 219     };
 220     static const enum AVPixelFormat overlay_pix_fmts_yuv420[] = {
 221         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_NONE
 222     };
 223
 224     static const enum AVPixelFormat main_pix_fmts_yuv422[] = {
 225         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_NONE
 226     };
 227     static const enum AVPixelFormat overlay_pix_fmts_yuv422[] = {
 228         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_NONE
 229     };
 230
 231     static const enum AVPixelFormat main_pix_fmts_yuv444[] = {
 232         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
 233     };
 234     static const enum AVPixelFormat overlay_pix_fmts_yuv444[] = {
 235         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
 236     };
 237
 238     static const enum AVPixelFormat main_pix_fmts_gbrp[] = {
 239         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
 240     };
 241     static const enum AVPixelFormat overlay_pix_fmts_gbrp[] = {
 242         AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
 243     };
 244
 245     static const enum AVPixelFormat main_pix_fmts_rgb[] = {
 246         AV_PIX_FMT_ARGB,  AV_PIX_FMT_RGBA,
 247         AV_PIX_FMT_ABGR,  AV_PIX_FMT_BGRA,
 248         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
 249         AV_PIX_FMT_NONE
 250     };
 251     static const enum AVPixelFormat overlay_pix_fmts_rgb[] = {
 252         AV_PIX_FMT_ARGB,  AV_PIX_FMT_RGBA,
 253         AV_PIX_FMT_ABGR,  AV_PIX_FMT_BGRA,
 254         AV_PIX_FMT_NONE
 255     };
 256
 257     AVFilterFormats *main_formats = NULL;
 258     AVFilterFormats *overlay_formats = NULL;
 259     int ret;
 260
 261     switch (s->format) {
 262     case OVERLAY_FORMAT_YUV420:
 263         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv420)) ||
 264             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420))) {
 265                 ret = AVERROR(ENOMEM);
 266                 goto fail;
 267             }
 268         break;
 269     case OVERLAY_FORMAT_YUV422:
 270         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv422)) ||
 271             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv422))) {
 272                 ret = AVERROR(ENOMEM);
 273                 goto fail;
 274             }
 275         break;
 276     case OVERLAY_FORMAT_YUV444:
 277         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv444)) ||
 278             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444))) {
 279                 ret = AVERROR(ENOMEM);
 280                 goto fail;
 281             }
 282         break;
 283     case OVERLAY_FORMAT_RGB:
 284         if (!(main_formats    = ff_make_format_list(main_pix_fmts_rgb)) ||
 285             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb))) {
 286                 ret = AVERROR(ENOMEM);
 287                 goto fail;
 288             }
 289         break;
 290     case OVERLAY_FORMAT_GBRP:
 291         if (!(main_formats    = ff_make_format_list(main_pix_fmts_gbrp)) ||
 292             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_gbrp))) {
 293                 ret = AVERROR(ENOMEM);
 294                 goto fail;
 295             }
 296         break;
 297     case OVERLAY_FORMAT_AUTO:
 298         if (!(main_formats    = ff_make_format_list(alpha_pix_fmts))) {
 299                 ret = AVERROR(ENOMEM);
 300                 goto fail;
 301             }
 302         break;
 303     default:
 304         av_assert0(0);
 305     }
 306
 307     if (s->format == OVERLAY_FORMAT_AUTO) {
 308         ret = ff_set_common_formats(ctx, main_formats);
 309         if (ret < 0)
 310             goto fail;
 311     } else {
 312         if ((ret = ff_formats_ref(main_formats   , &ctx->inputs[MAIN]->out_formats   )) < 0 ||
 313             (ret = ff_formats_ref(overlay_formats, &ctx->inputs[OVERLAY]->out_formats)) < 0 ||
 314             (ret = ff_formats_ref(main_formats   , &ctx->outputs[MAIN]->in_formats   )) < 0)
 315                 goto fail;
 316     }
 317
 318     return 0;
 319 fail:
 320     if (main_formats)
 321         av_freep(&main_formats->formats);
 322     av_freep(&main_formats);
 323     if (overlay_formats)
 324         av_freep(&overlay_formats->formats);
 325     av_freep(&overlay_formats);
 326     return ret;
 327 }
 328
 329 static int config_input_overlay(AVFilterLink *inlink)
 330 {
 331     AVFilterContext *ctx  = inlink->dst;
 332     OverlayContext  *s = inlink->dst->priv;
 333     int ret;
 334     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
 335
 336     av_image_fill_max_pixsteps(s->overlay_pix_step, NULL, pix_desc);
 337
 338     /* Finish the configuration by evaluating the expressions
 339        now when both inputs are configured. */
 340     s->var_values[VAR_MAIN_W   ] = s->var_values[VAR_MW] = ctx->inputs[MAIN   ]->w;
 341     s->var_values[VAR_MAIN_H   ] = s->var_values[VAR_MH] = ctx->inputs[MAIN   ]->h;
 342     s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
 343     s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
 344     s->var_values[VAR_HSUB]  = 1<<pix_desc->log2_chroma_w;
 345     s->var_values[VAR_VSUB]  = 1<<pix_desc->log2_chroma_h;
 346     s->var_values[VAR_X]     = NAN;
 347     s->var_values[VAR_Y]     = NAN;
 348     s->var_values[VAR_N]     = 0;
 349     s->var_values[VAR_T]     = NAN;
 350     s->var_values[VAR_POS]   = NAN;
 351
 352     if ((ret = set_expr(&s->x_pexpr,      s->x_expr,      "x",      ctx)) < 0 ||
 353         (ret = set_expr(&s->y_pexpr,      s->y_expr,      "y",      ctx)) < 0)
 354         return ret;
 355
 356     s->overlay_is_packed_rgb =
 357         ff_fill_rgba_map(s->overlay_rgba_map, inlink->format) >= 0;
 358     s->overlay_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
 359
 360     if (s->eval_mode == EVAL_MODE_INIT) {
 361         eval_expr(ctx);
 362         av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
 363                s->var_values[VAR_X], s->x,
 364                s->var_values[VAR_Y], s->y);
 365     }
 366
 367     av_log(ctx, AV_LOG_VERBOSE,
 368            "main w:%d h:%d fmt:%s overlay w:%d h:%d fmt:%s\n",
 369            ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
 370            av_get_pix_fmt_name(ctx->inputs[MAIN]->format),
 371            ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
 372            av_get_pix_fmt_name(ctx->inputs[OVERLAY]->format));
 373     return 0;
 374 }
 375
 376 static int config_output(AVFilterLink *outlink)
 377 {
 378     AVFilterContext *ctx = outlink->src;
 379     OverlayContext *s = ctx->priv;
 380     int ret;
 381
 382     if ((ret = ff_framesync_init_dualinput(&s->fs, ctx)) < 0)
 383         return ret;
 384
 385     outlink->w = ctx->inputs[MAIN]->w;
 386     outlink->h = ctx->inputs[MAIN]->h;
 387     outlink->time_base = ctx->inputs[MAIN]->time_base;
 388
 389     return ff_framesync_configure(&s->fs);
 390 }
 391
 392 // divide by 255 and round to nearest
 393 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
 394 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
 395
 396 // calculate the unpremultiplied alpha, applying the general equation:
 397 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
 398 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
 399 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
 400 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
 401
 402 /**
 403  * Blend image in src to destination buffer dst at position (x, y).
 404  */
 405
 406 static av_always_inline void blend_image_packed_rgb(AVFilterContext *ctx,
 407                                    AVFrame *dst, const AVFrame *src,
 408                                    int main_has_alpha, int x, int y,
 409                                    int is_straight)
 410 {
 411     OverlayContext *s = ctx->priv;
 412     int i, imax, j, jmax;
 413     const int src_w = src->width;
 414     const int src_h = src->height;
 415     const int dst_w = dst->width;
 416     const int dst_h = dst->height;
 417     uint8_t alpha;          ///< the amount of overlay to blend on to main
 418     const int dr = s->main_rgba_map[R];
 419     const int dg = s->main_rgba_map[G];
 420     const int db = s->main_rgba_map[B];
 421     const int da = s->main_rgba_map[A];
 422     const int dstep = s->main_pix_step[0];
 423     const int sr = s->overlay_rgba_map[R];
 424     const int sg = s->overlay_rgba_map[G];
 425     const int sb = s->overlay_rgba_map[B];
 426     const int sa = s->overlay_rgba_map[A];
 427     const int sstep = s->overlay_pix_step[0];
 428     uint8_t *S, *sp, *d, *dp;
 429
 430     i = FFMAX(-y, 0);
 431     sp = src->data[0] + i     * src->linesize[0];
 432     dp = dst->data[0] + (y+i) * dst->linesize[0];
 433
 434     for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
 435         j = FFMAX(-x, 0);
 436         S = sp + j     * sstep;
 437         d = dp + (x+j) * dstep;
 438
 439         for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
 440             alpha = S[sa];
 441
 442             // if the main channel has an alpha channel, alpha has to be calculated
 443             // to create an un-premultiplied (straight) alpha value
 444             if (main_has_alpha && alpha != 0 && alpha != 255) {
 445                 uint8_t alpha_d = d[da];
 446                 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
 447             }
 448
 449             switch (alpha) {
 450             case 0:
 451                 break;
 452             case 255:
 453                 d[dr] = S[sr];
 454                 d[dg] = S[sg];
 455                 d[db] = S[sb];
 456                 break;
 457             default:
 458                 // main_value = main_value * (1 - alpha) + overlay_value * alpha
 459                 // since alpha is in the range 0-255, the result must divided by 255
 460                 d[dr] = is_straight ? FAST_DIV255(d[dr] * (255 - alpha) + S[sr] * alpha) :
 461                         FFMIN(FAST_DIV255(d[dr] * (255 - alpha)) + S[sr], 255);
 462                 d[dg] = is_straight ? FAST_DIV255(d[dg] * (255 - alpha) + S[sg] * alpha) :
 463                         FFMIN(FAST_DIV255(d[dg] * (255 - alpha)) + S[sg], 255);
 464                 d[db] = is_straight ? FAST_DIV255(d[db] * (255 - alpha) + S[sb] * alpha) :
 465                         FFMIN(FAST_DIV255(d[db] * (255 - alpha)) + S[sb], 255);
 466             }
 467             if (main_has_alpha) {
 468                 switch (alpha) {
 469                 case 0:
 470                     break;
 471                 case 255:
 472                     d[da] = S[sa];
 473                     break;
 474                 default:
 475                     // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
 476                     d[da] += FAST_DIV255((255 - d[da]) * S[sa]);
 477                 }
 478             }
 479             d += dstep;
 480             S += sstep;
 481         }
 482         dp += dst->linesize[0];
 483         sp += src->linesize[0];
 484     }
 485 }
 486
 487 static av_always_inline void blend_plane(AVFilterContext *ctx,
 488                                          AVFrame *dst, const AVFrame *src,
 489                                          int src_w, int src_h,
 490                                          int dst_w, int dst_h,
 491                                          int i, int hsub, int vsub,
 492                                          int x, int y,
 493                                          int main_has_alpha,
 494                                          int dst_plane,
 495                                          int dst_offset,
 496                                          int dst_step,
 497                                          int straight,
 498                                          int yuv)
 499 {
 500     int src_wp = AV_CEIL_RSHIFT(src_w, hsub);
 501     int src_hp = AV_CEIL_RSHIFT(src_h, vsub);
 502     int dst_wp = AV_CEIL_RSHIFT(dst_w, hsub);
 503     int dst_hp = AV_CEIL_RSHIFT(dst_h, vsub);
 504     int yp = y>>vsub;
 505     int xp = x>>hsub;
 506     uint8_t *s, *sp, *d, *dp, *dap, *a, *da, *ap;
 507     int jmax, j, k, kmax;
 508
 509     j = FFMAX(-yp, 0);
 510     sp = src->data[i] + j         * src->linesize[i];
 511     dp = dst->data[dst_plane]
 512                       + (yp+j)    * dst->linesize[dst_plane]
 513                       + dst_offset;
 514     ap = src->data[3] + (j<<vsub) * src->linesize[3];
 515     dap = dst->data[3] + ((yp+j) << vsub) * dst->linesize[3];
 516
 517     for (jmax = FFMIN(-yp + dst_hp, src_hp); j < jmax; j++) {
 518         k = FFMAX(-xp, 0);
 519         d = dp + (xp+k) * dst_step;
 520         s = sp + k;
 521         a = ap + (k<<hsub);
 522         da = dap + ((xp+k) << hsub);
 523
 524         for (kmax = FFMIN(-xp + dst_wp, src_wp); k < kmax; k++) {
 525             int alpha_v, alpha_h, alpha;
 526
 527             // average alpha for color components, improve quality
 528             if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
 529                 alpha = (a[0] + a[src->linesize[3]] +
 530                          a[1] + a[src->linesize[3]+1]) >> 2;
 531             } else if (hsub || vsub) {
 532                 alpha_h = hsub && k+1 < src_wp ?
 533                     (a[0] + a[1]) >> 1 : a[0];
 534                 alpha_v = vsub && j+1 < src_hp ?
 535                     (a[0] + a[src->linesize[3]]) >> 1 : a[0];
 536                 alpha = (alpha_v + alpha_h) >> 1;
 537             } else
 538                 alpha = a[0];
 539             // if the main channel has an alpha channel, alpha has to be calculated
 540             // to create an un-premultiplied (straight) alpha value
 541             if (main_has_alpha && alpha != 0 && alpha != 255) {
 542                 // average alpha for color components, improve quality
 543                 uint8_t alpha_d;
 544                 if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
 545                     alpha_d = (da[0] + da[dst->linesize[3]] +
 546                                da[1] + da[dst->linesize[3]+1]) >> 2;
 547                 } else if (hsub || vsub) {
 548                     alpha_h = hsub && k+1 < src_wp ?
 549                         (da[0] + da[1]) >> 1 : da[0];
 550                     alpha_v = vsub && j+1 < src_hp ?
 551                         (da[0] + da[dst->linesize[3]]) >> 1 : da[0];
 552                     alpha_d = (alpha_v + alpha_h) >> 1;
 553                 } else
 554                     alpha_d = da[0];
 555                 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
 556             }
 557             if (straight) {
 558                 *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
 559             } else {
 560                 if (i && yuv)
 561                     *d = av_clip(FAST_DIV255((*d - 128) * (255 - alpha)) + *s - 128, -128, 128) + 128;
 562                 else
 563                     *d = FFMIN(FAST_DIV255(*d * (255 - alpha)) + *s, 255);
 564             }
 565             s++;
 566             d += dst_step;
 567             da += 1 << hsub;
 568             a += 1 << hsub;
 569         }
 570         dp += dst->linesize[dst_plane];
 571         sp += src->linesize[i];
 572         ap += (1 << vsub) * src->linesize[3];
 573         dap += (1 << vsub) * dst->linesize[3];
 574     }
 575 }
 576
 577 static inline void alpha_composite(const AVFrame *src, const AVFrame *dst,
 578                                    int src_w, int src_h,
 579                                    int dst_w, int dst_h,
 580                                    int x, int y)
 581 {
 582     uint8_t alpha;          ///< the amount of overlay to blend on to main
 583     uint8_t *s, *sa, *d, *da;
 584     int i, imax, j, jmax;
 585
 586     i = FFMAX(-y, 0);
 587     sa = src->data[3] + i     * src->linesize[3];
 588     da = dst->data[3] + (y+i) * dst->linesize[3];
 589
 590     for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
 591         j = FFMAX(-x, 0);
 592         s = sa + j;
 593         d = da + x+j;
 594
 595         for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
 596             alpha = *s;
 597             if (alpha != 0 && alpha != 255) {
 598                 uint8_t alpha_d = *d;
 599                 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
 600             }
 601             switch (alpha) {
 602             case 0:
 603                 break;
 604             case 255:
 605                 *d = *s;
 606                 break;
 607             default:
 608                 // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
 609                 *d += FAST_DIV255((255 - *d) * *s);
 610             }
 611             d += 1;
 612             s += 1;
 613         }
 614         da += dst->linesize[3];
 615         sa += src->linesize[3];
 616     }
 617 }
 618
 619 static av_always_inline void blend_image_yuv(AVFilterContext *ctx,
 620                                              AVFrame *dst, const AVFrame *src,
 621                                              int hsub, int vsub,
 622                                              int main_has_alpha,
 623                                              int x, int y,
 624                                              int is_straight)
 625 {
 626     OverlayContext *s = ctx->priv;
 627     const int src_w = src->width;
 628     const int src_h = src->height;
 629     const int dst_w = dst->width;
 630     const int dst_h = dst->height;
 631
 632     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 0, 0,       0, x, y, main_has_alpha,
 633                 s->main_desc->comp[0].plane, s->main_desc->comp[0].offset, s->main_desc->comp[0].step, is_straight, 1);
 634     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 1, hsub, vsub, x, y, main_has_alpha,
 635                 s->main_desc->comp[1].plane, s->main_desc->comp[1].offset, s->main_desc->comp[1].step, is_straight, 1);
 636     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 2, hsub, vsub, x, y, main_has_alpha,
 637                 s->main_desc->comp[2].plane, s->main_desc->comp[2].offset, s->main_desc->comp[2].step, is_straight, 1);
 638
 639     if (main_has_alpha)
 640         alpha_composite(src, dst, src_w, src_h, dst_w, dst_h, x, y);
 641 }
 642
 643 static av_always_inline void blend_image_planar_rgb(AVFilterContext *ctx,
 644                                                     AVFrame *dst, const AVFrame *src,
 645                                                     int hsub, int vsub,
 646                                                     int main_has_alpha,
 647                                                     int x, int y,
 648                                                     int is_straight)
 649 {
 650     OverlayContext *s = ctx->priv;
 651     const int src_w = src->width;
 652     const int src_h = src->height;
 653     const int dst_w = dst->width;
 654     const int dst_h = dst->height;
 655
 656     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 0, 0,       0, x, y, main_has_alpha,
 657                 s->main_desc->comp[1].plane, s->main_desc->comp[1].offset, s->main_desc->comp[1].step, is_straight, 0);
 658     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 1, hsub, vsub, x, y, main_has_alpha,
 659                 s->main_desc->comp[2].plane, s->main_desc->comp[2].offset, s->main_desc->comp[2].step, is_straight, 0);
 660     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 2, hsub, vsub, x, y, main_has_alpha,
 661                 s->main_desc->comp[0].plane, s->main_desc->comp[0].offset, s->main_desc->comp[0].step, is_straight, 0);
 662
 663     if (main_has_alpha)
 664         alpha_composite(src, dst, src_w, src_h, dst_w, dst_h, x, y);
 665 }
 666
 667 static void blend_image_yuv420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 668 {
 669     blend_image_yuv(ctx, dst, src, 1, 1, 0, x, y, 1);
 670 }
 671
 672 static void blend_image_yuva420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 673 {
 674     blend_image_yuv(ctx, dst, src, 1, 1, 1, x, y, 1);
 675 }
 676
 677 static void blend_image_yuv422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 678 {
 679     blend_image_yuv(ctx, dst, src, 1, 0, 0, x, y, 1);
 680 }
 681
 682 static void blend_image_yuva422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 683 {
 684     blend_image_yuv(ctx, dst, src, 1, 0, 1, x, y, 1);
 685 }
 686
 687 static void blend_image_yuv444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 688 {
 689     blend_image_yuv(ctx, dst, src, 0, 0, 0, x, y, 1);
 690 }
 691
 692 static void blend_image_yuva444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 693 {
 694     blend_image_yuv(ctx, dst, src, 0, 0, 1, x, y, 1);
 695 }
 696
 697 static void blend_image_gbrp(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 698 {
 699     blend_image_planar_rgb(ctx, dst, src, 0, 0, 0, x, y, 1);
 700 }
 701
 702 static void blend_image_gbrap(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 703 {
 704     blend_image_planar_rgb(ctx, dst, src, 0, 0, 1, x, y, 1);
 705 }
 706
 707 static void blend_image_yuv420_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 708 {
 709     blend_image_yuv(ctx, dst, src, 1, 1, 0, x, y, 0);
 710 }
 711
 712 static void blend_image_yuva420_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 713 {
 714     blend_image_yuv(ctx, dst, src, 1, 1, 1, x, y, 0);
 715 }
 716
 717 static void blend_image_yuv422_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 718 {
 719     blend_image_yuv(ctx, dst, src, 1, 0, 0, x, y, 0);
 720 }
 721
 722 static void blend_image_yuva422_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 723 {
 724     blend_image_yuv(ctx, dst, src, 1, 0, 1, x, y, 0);
 725 }
 726
 727 static void blend_image_yuv444_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 728 {
 729     blend_image_yuv(ctx, dst, src, 0, 0, 0, x, y, 0);
 730 }
 731
 732 static void blend_image_yuva444_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 733 {
 734     blend_image_yuv(ctx, dst, src, 0, 0, 1, x, y, 0);
 735 }
 736
 737 static void blend_image_gbrp_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 738 {
 739     blend_image_planar_rgb(ctx, dst, src, 0, 0, 0, x, y, 0);
 740 }
 741
 742 static void blend_image_gbrap_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 743 {
 744     blend_image_planar_rgb(ctx, dst, src, 0, 0, 1, x, y, 0);
 745 }
 746
 747 static void blend_image_rgb(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 748 {
 749     blend_image_packed_rgb(ctx, dst, src, 0, x, y, 1);
 750 }
 751
 752 static void blend_image_rgba(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 753 {
 754     blend_image_packed_rgb(ctx, dst, src, 1, x, y, 1);
 755 }
 756
 757 static void blend_image_rgb_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 758 {
 759     blend_image_packed_rgb(ctx, dst, src, 0, x, y, 0);
 760 }
 761
 762 static void blend_image_rgba_pm(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 763 {
 764     blend_image_packed_rgb(ctx, dst, src, 1, x, y, 0);
 765 }
 766
 767 static int config_input_main(AVFilterLink *inlink)
 768 {
 769     OverlayContext *s = inlink->dst->priv;
 770     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
 771
 772     av_image_fill_max_pixsteps(s->main_pix_step,    NULL, pix_desc);
 773
 774     s->hsub = pix_desc->log2_chroma_w;
 775     s->vsub = pix_desc->log2_chroma_h;
 776
 777     s->main_desc = pix_desc;
 778
 779     s->main_is_packed_rgb =
 780         ff_fill_rgba_map(s->main_rgba_map, inlink->format) >= 0;
 781     s->main_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
 782     switch (s->format) {
 783     case OVERLAY_FORMAT_YUV420:
 784         s->blend_image = s->main_has_alpha ? blend_image_yuva420 : blend_image_yuv420;
 785         break;
 786     case OVERLAY_FORMAT_YUV422:
 787         s->blend_image = s->main_has_alpha ? blend_image_yuva422 : blend_image_yuv422;
 788         break;
 789     case OVERLAY_FORMAT_YUV444:
 790         s->blend_image = s->main_has_alpha ? blend_image_yuva444 : blend_image_yuv444;
 791         break;
 792     case OVERLAY_FORMAT_RGB:
 793         s->blend_image = s->main_has_alpha ? blend_image_rgba : blend_image_rgb;
 794         break;
 795     case OVERLAY_FORMAT_GBRP:
 796         s->blend_image = s->main_has_alpha ? blend_image_gbrap : blend_image_gbrp;
 797         break;
 798     case OVERLAY_FORMAT_AUTO:
 799         switch (inlink->format) {
 800         case AV_PIX_FMT_YUVA420P:
 801             s->blend_image = blend_image_yuva420;
 802             break;
 803         case AV_PIX_FMT_YUVA422P:
 804             s->blend_image = blend_image_yuva422;
 805             break;
 806         case AV_PIX_FMT_YUVA444P:
 807             s->blend_image = blend_image_yuva444;
 808             break;
 809         case AV_PIX_FMT_ARGB:
 810         case AV_PIX_FMT_RGBA:
 811         case AV_PIX_FMT_BGRA:
 812         case AV_PIX_FMT_ABGR:
 813             s->blend_image = blend_image_rgba;
 814             break;
 815         case AV_PIX_FMT_GBRAP:
 816             s->blend_image = blend_image_gbrap;
 817             break;
 818         default:
 819             av_assert0(0);
 820             break;
 821         }
 822         break;
 823     }
 824
 825     if (!s->alpha_format)
 826         return 0;
 827
 828     switch (s->format) {
 829     case OVERLAY_FORMAT_YUV420:
 830         s->blend_image = s->main_has_alpha ? blend_image_yuva420_pm : blend_image_yuv420_pm;
 831         break;
 832     case OVERLAY_FORMAT_YUV422:
 833         s->blend_image = s->main_has_alpha ? blend_image_yuva422_pm : blend_image_yuv422_pm;
 834         break;
 835     case OVERLAY_FORMAT_YUV444:
 836         s->blend_image = s->main_has_alpha ? blend_image_yuva444_pm : blend_image_yuv444_pm;
 837         break;
 838     case OVERLAY_FORMAT_RGB:
 839         s->blend_image = s->main_has_alpha ? blend_image_rgba_pm : blend_image_rgb_pm;
 840         break;
 841     case OVERLAY_FORMAT_GBRP:
 842         s->blend_image = s->main_has_alpha ? blend_image_gbrap_pm : blend_image_gbrp_pm;
 843         break;
 844     case OVERLAY_FORMAT_AUTO:
 845         switch (inlink->format) {
 846         case AV_PIX_FMT_YUVA420P:
 847             s->blend_image = blend_image_yuva420_pm;
 848             break;
 849         case AV_PIX_FMT_YUVA422P:
 850             s->blend_image = blend_image_yuva422_pm;
 851             break;
 852         case AV_PIX_FMT_YUVA444P:
 853             s->blend_image = blend_image_yuva444_pm;
 854             break;
 855         case AV_PIX_FMT_ARGB:
 856         case AV_PIX_FMT_RGBA:
 857         case AV_PIX_FMT_BGRA:
 858         case AV_PIX_FMT_ABGR:
 859             s->blend_image = blend_image_rgba_pm;
 860             break;
 861         case AV_PIX_FMT_GBRAP:
 862             s->blend_image = blend_image_gbrap_pm;
 863             break;
 864         default:
 865             av_assert0(0);
 866             break;
 867         }
 868         break;
 869     }
 870     return 0;
 871 }
 872
 873 static int do_blend(FFFrameSync *fs)
 874 {
 875     AVFilterContext *ctx = fs->parent;
 876     AVFrame *mainpic, *second;
 877     OverlayContext *s = ctx->priv;
 878     AVFilterLink *inlink = ctx->inputs[0];
 879     int ret;
 880
 881     ret = ff_framesync_dualinput_get_writable(fs, &mainpic, &second);
 882     if (ret < 0)
 883         return ret;
 884     if (!second)
 885         return ff_filter_frame(ctx->outputs[0], mainpic);
 886
 887     if (s->eval_mode == EVAL_MODE_FRAME) {
 888         int64_t pos = mainpic->pkt_pos;
 889
 890         s->var_values[VAR_N] = inlink->frame_count_out;
 891         s->var_values[VAR_T] = mainpic->pts == AV_NOPTS_VALUE ?
 892             NAN : mainpic->pts * av_q2d(inlink->time_base);
 893         s->var_values[VAR_POS] = pos == -1 ? NAN : pos;
 894
 895         s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = second->width;
 896         s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = second->height;
 897         s->var_values[VAR_MAIN_W   ] = s->var_values[VAR_MW] = mainpic->width;
 898         s->var_values[VAR_MAIN_H   ] = s->var_values[VAR_MH] = mainpic->height;
 899
 900         eval_expr(ctx);
 901         av_log(ctx, AV_LOG_DEBUG, "n:%f t:%f pos:%f x:%f xi:%d y:%f yi:%d\n",
 902                s->var_values[VAR_N], s->var_values[VAR_T], s->var_values[VAR_POS],
 903                s->var_values[VAR_X], s->x,
 904                s->var_values[VAR_Y], s->y);
 905     }
 906
 907     if (s->x < mainpic->width  && s->x + second->width  >= 0 ||
 908         s->y < mainpic->height && s->y + second->height >= 0)
 909         s->blend_image(ctx, mainpic, second, s->x, s->y);
 910     return ff_filter_frame(ctx->outputs[0], mainpic);
 911 }
 912
 913 static av_cold int init(AVFilterContext *ctx)
 914 {
 915     OverlayContext *s = ctx->priv;
 916
 917     s->fs.on_event = do_blend;
 918     return 0;
 919 }
 920
 921 static int activate(AVFilterContext *ctx)
 922 {
 923     OverlayContext *s = ctx->priv;
 924     return ff_framesync_activate(&s->fs);
 925 }
 926
 927 #define OFFSET(x) offsetof(OverlayContext, x)
 928 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 929
 930 static const AVOption overlay_options[] = {
 931     { "x", "set the x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
 932     { "y", "set the y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
 933     { "eof_action", "Action to take when encountering EOF from secondary input ",
 934         OFFSET(fs.opt_eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
 935         EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
 936         { "repeat", "Repeat the previous frame.",   0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
 937         { "endall", "End both streams.",            0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
 938         { "pass",   "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS },   .flags = FLAGS, "eof_action" },
 939     { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_FRAME}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
 940          { "init",  "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT},  .flags = FLAGS, .unit = "eval" },
 941          { "frame", "eval expressions per-frame",                  0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
 942     { "shortest", "force termination when the shortest input terminates", OFFSET(fs.opt_shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
 943     { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=OVERLAY_FORMAT_YUV420}, 0, OVERLAY_FORMAT_NB-1, FLAGS, "format" },
 944         { "yuv420", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV420}, .flags = FLAGS, .unit = "format" },
 945         { "yuv422", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV422}, .flags = FLAGS, .unit = "format" },
 946         { "yuv444", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV444}, .flags = FLAGS, .unit = "format" },
 947         { "rgb",    "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_RGB},    .flags = FLAGS, .unit = "format" },
 948         { "gbrp",   "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_GBRP},   .flags = FLAGS, .unit = "format" },
 949         { "auto",   "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_AUTO},   .flags = FLAGS, .unit = "format" },
 950     { "repeatlast", "repeat overlay of the last overlay frame", OFFSET(fs.opt_repeatlast), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
 951     { "alpha", "alpha format", OFFSET(alpha_format), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "alpha_format" },
 952         { "straight",      "", 0, AV_OPT_TYPE_CONST, {.i64=0}, .flags = FLAGS, .unit = "alpha_format" },
 953         { "premultiplied", "", 0, AV_OPT_TYPE_CONST, {.i64=1}, .flags = FLAGS, .unit = "alpha_format" },
 954     { NULL }
 955 };
 956
 957 FRAMESYNC_DEFINE_CLASS(overlay, OverlayContext, fs);
 958
 959 static const AVFilterPad avfilter_vf_overlay_inputs[] = {
 960     {
 961         .name         = "main",
 962         .type         = AVMEDIA_TYPE_VIDEO,
 963         .config_props = config_input_main,
 964     },
 965     {
 966         .name         = "overlay",
 967         .type         = AVMEDIA_TYPE_VIDEO,
 968         .config_props = config_input_overlay,
 969     },
 970     { NULL }
 971 };
 972
 973 static const AVFilterPad avfilter_vf_overlay_outputs[] = {
 974     {
 975         .name          = "default",
 976         .type          = AVMEDIA_TYPE_VIDEO,
 977         .config_props  = config_output,
 978     },
 979     { NULL }
 980 };
 981
 982 AVFilter ff_vf_overlay = {
 983     .name          = "overlay",
 984     .description   = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
 985     .preinit       = overlay_framesync_preinit,
 986     .init          = init,
 987     .uninit        = uninit,
 988     .priv_size     = sizeof(OverlayContext),
 989     .priv_class    = &overlay_class,
 990     .query_formats = query_formats,
 991     .activate      = activate,
 992     .process_command = process_command,
 993     .inputs        = avfilter_vf_overlay_inputs,
 994     .outputs       = avfilter_vf_overlay_outputs,
 995     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
 996 };