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 "dualinput.h"
  40 #include "drawutils.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 enum EOFAction {
  74     EOF_ACTION_REPEAT,
  75     EOF_ACTION_ENDALL,
  76     EOF_ACTION_PASS
  77 };
  78
  79 static const char * const eof_action_str[] = {
  80     "repeat", "endall", "pass"
  81 };
  82
  83 #define MAIN    0
  84 #define OVERLAY 1
  85
  86 #define R 0
  87 #define G 1
  88 #define B 2
  89 #define A 3
  90
  91 #define Y 0
  92 #define U 1
  93 #define V 2
  94
  95 enum EvalMode {
  96     EVAL_MODE_INIT,
  97     EVAL_MODE_FRAME,
  98     EVAL_MODE_NB
  99 };
 100
 101 enum OverlayFormat {
 102     OVERLAY_FORMAT_YUV420,
 103     OVERLAY_FORMAT_YUV422,
 104     OVERLAY_FORMAT_YUV444,
 105     OVERLAY_FORMAT_RGB,
 106     OVERLAY_FORMAT_NB
 107 };
 108
 109 typedef struct OverlayContext {
 110     const AVClass *class;
 111     int x, y;                   ///< position of overlaid picture
 112
 113     int allow_packed_rgb;
 114     uint8_t main_is_packed_rgb;
 115     uint8_t main_rgba_map[4];
 116     uint8_t main_has_alpha;
 117     uint8_t overlay_is_packed_rgb;
 118     uint8_t overlay_rgba_map[4];
 119     uint8_t overlay_has_alpha;
 120     int format;                 ///< OverlayFormat
 121     int eval_mode;              ///< EvalMode
 122
 123     FFDualInputContext dinput;
 124
 125     int main_pix_step[4];       ///< steps per pixel for each plane of the main output
 126     int overlay_pix_step[4];    ///< steps per pixel for each plane of the overlay
 127     int hsub, vsub;             ///< chroma subsampling values
 128     const AVPixFmtDescriptor *main_desc; ///< format descriptor for main input
 129
 130     double var_values[VAR_VARS_NB];
 131     char *x_expr, *y_expr;
 132
 133     int eof_action;             ///< action to take on EOF from source
 134
 135     AVExpr *x_pexpr, *y_pexpr;
 136
 137     void (*blend_image)(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y);
 138 } OverlayContext;
 139
 140 static av_cold void uninit(AVFilterContext *ctx)
 141 {
 142     OverlayContext *s = ctx->priv;
 143
 144     ff_dualinput_uninit(&s->dinput);
 145     av_expr_free(s->x_pexpr); s->x_pexpr = NULL;
 146     av_expr_free(s->y_pexpr); s->y_pexpr = NULL;
 147 }
 148
 149 static inline int normalize_xy(double d, int chroma_sub)
 150 {
 151     if (isnan(d))
 152         return INT_MAX;
 153     return (int)d & ~((1 << chroma_sub) - 1);
 154 }
 155
 156 static void eval_expr(AVFilterContext *ctx)
 157 {
 158     OverlayContext *s = ctx->priv;
 159
 160     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
 161     s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, NULL);
 162     s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
 163     s->x = normalize_xy(s->var_values[VAR_X], s->hsub);
 164     s->y = normalize_xy(s->var_values[VAR_Y], s->vsub);
 165 }
 166
 167 static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
 168 {
 169     int ret;
 170     AVExpr *old = NULL;
 171
 172     if (*pexpr)
 173         old = *pexpr;
 174     ret = av_expr_parse(pexpr, expr, var_names,
 175                         NULL, NULL, NULL, NULL, 0, log_ctx);
 176     if (ret < 0) {
 177         av_log(log_ctx, AV_LOG_ERROR,
 178                "Error when evaluating the expression '%s' for %s\n",
 179                expr, option);
 180         *pexpr = old;
 181         return ret;
 182     }
 183
 184     av_expr_free(old);
 185     return 0;
 186 }
 187
 188 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
 189                            char *res, int res_len, int flags)
 190 {
 191     OverlayContext *s = ctx->priv;
 192     int ret;
 193
 194     if      (!strcmp(cmd, "x"))
 195         ret = set_expr(&s->x_pexpr, args, cmd, ctx);
 196     else if (!strcmp(cmd, "y"))
 197         ret = set_expr(&s->y_pexpr, args, cmd, ctx);
 198     else
 199         ret = AVERROR(ENOSYS);
 200
 201     if (ret < 0)
 202         return ret;
 203
 204     if (s->eval_mode == EVAL_MODE_INIT) {
 205         eval_expr(ctx);
 206         av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
 207                s->var_values[VAR_X], s->x,
 208                s->var_values[VAR_Y], s->y);
 209     }
 210     return ret;
 211 }
 212
 213 static int query_formats(AVFilterContext *ctx)
 214 {
 215     OverlayContext *s = ctx->priv;
 216
 217     /* overlay formats contains alpha, for avoiding conversion with alpha information loss */
 218     static const enum AVPixelFormat main_pix_fmts_yuv420[] = {
 219         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVA420P,
 220         AV_PIX_FMT_NV12, AV_PIX_FMT_NV21,
 221         AV_PIX_FMT_NONE
 222     };
 223     static const enum AVPixelFormat overlay_pix_fmts_yuv420[] = {
 224         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_NONE
 225     };
 226
 227     static const enum AVPixelFormat main_pix_fmts_yuv422[] = {
 228         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_NONE
 229     };
 230     static const enum AVPixelFormat overlay_pix_fmts_yuv422[] = {
 231         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_NONE
 232     };
 233
 234     static const enum AVPixelFormat main_pix_fmts_yuv444[] = {
 235         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
 236     };
 237     static const enum AVPixelFormat overlay_pix_fmts_yuv444[] = {
 238         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
 239     };
 240
 241     static const enum AVPixelFormat main_pix_fmts_rgb[] = {
 242         AV_PIX_FMT_ARGB,  AV_PIX_FMT_RGBA,
 243         AV_PIX_FMT_ABGR,  AV_PIX_FMT_BGRA,
 244         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
 245         AV_PIX_FMT_NONE
 246     };
 247     static const enum AVPixelFormat overlay_pix_fmts_rgb[] = {
 248         AV_PIX_FMT_ARGB,  AV_PIX_FMT_RGBA,
 249         AV_PIX_FMT_ABGR,  AV_PIX_FMT_BGRA,
 250         AV_PIX_FMT_NONE
 251     };
 252
 253     AVFilterFormats *main_formats = NULL;
 254     AVFilterFormats *overlay_formats = NULL;
 255     int ret;
 256
 257     switch (s->format) {
 258     case OVERLAY_FORMAT_YUV420:
 259         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv420)) ||
 260             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420))) {
 261                 ret = AVERROR(ENOMEM);
 262                 goto fail;
 263             }
 264         break;
 265     case OVERLAY_FORMAT_YUV422:
 266         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv422)) ||
 267             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv422))) {
 268                 ret = AVERROR(ENOMEM);
 269                 goto fail;
 270             }
 271         break;
 272     case OVERLAY_FORMAT_YUV444:
 273         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv444)) ||
 274             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444))) {
 275                 ret = AVERROR(ENOMEM);
 276                 goto fail;
 277             }
 278         break;
 279     case OVERLAY_FORMAT_RGB:
 280         if (!(main_formats    = ff_make_format_list(main_pix_fmts_rgb)) ||
 281             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb))) {
 282                 ret = AVERROR(ENOMEM);
 283                 goto fail;
 284             }
 285         break;
 286     default:
 287         av_assert0(0);
 288     }
 289
 290     if ((ret = ff_formats_ref(main_formats   , &ctx->inputs[MAIN]->out_formats   )) < 0 ||
 291         (ret = ff_formats_ref(overlay_formats, &ctx->inputs[OVERLAY]->out_formats)) < 0 ||
 292         (ret = ff_formats_ref(main_formats   , &ctx->outputs[MAIN]->in_formats   )) < 0)
 293             goto fail;
 294
 295     return 0;
 296 fail:
 297     if (main_formats)
 298         av_freep(&main_formats->formats);
 299     av_freep(&main_formats);
 300     if (overlay_formats)
 301         av_freep(&overlay_formats->formats);
 302     av_freep(&overlay_formats);
 303     return ret;
 304 }
 305
 306 static const enum AVPixelFormat alpha_pix_fmts[] = {
 307     AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
 308     AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA,
 309     AV_PIX_FMT_BGRA, AV_PIX_FMT_NONE
 310 };
 311
 312 static int config_input_overlay(AVFilterLink *inlink)
 313 {
 314     AVFilterContext *ctx  = inlink->dst;
 315     OverlayContext  *s = inlink->dst->priv;
 316     int ret;
 317     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
 318
 319     av_image_fill_max_pixsteps(s->overlay_pix_step, NULL, pix_desc);
 320
 321     /* Finish the configuration by evaluating the expressions
 322        now when both inputs are configured. */
 323     s->var_values[VAR_MAIN_W   ] = s->var_values[VAR_MW] = ctx->inputs[MAIN   ]->w;
 324     s->var_values[VAR_MAIN_H   ] = s->var_values[VAR_MH] = ctx->inputs[MAIN   ]->h;
 325     s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
 326     s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
 327     s->var_values[VAR_HSUB]  = 1<<pix_desc->log2_chroma_w;
 328     s->var_values[VAR_VSUB]  = 1<<pix_desc->log2_chroma_h;
 329     s->var_values[VAR_X]     = NAN;
 330     s->var_values[VAR_Y]     = NAN;
 331     s->var_values[VAR_N]     = 0;
 332     s->var_values[VAR_T]     = NAN;
 333     s->var_values[VAR_POS]   = NAN;
 334
 335     if ((ret = set_expr(&s->x_pexpr,      s->x_expr,      "x",      ctx)) < 0 ||
 336         (ret = set_expr(&s->y_pexpr,      s->y_expr,      "y",      ctx)) < 0)
 337         return ret;
 338
 339     s->overlay_is_packed_rgb =
 340         ff_fill_rgba_map(s->overlay_rgba_map, inlink->format) >= 0;
 341     s->overlay_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
 342
 343     if (s->eval_mode == EVAL_MODE_INIT) {
 344         eval_expr(ctx);
 345         av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
 346                s->var_values[VAR_X], s->x,
 347                s->var_values[VAR_Y], s->y);
 348     }
 349
 350     av_log(ctx, AV_LOG_VERBOSE,
 351            "main w:%d h:%d fmt:%s overlay w:%d h:%d fmt:%s eof_action:%s\n",
 352            ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
 353            av_get_pix_fmt_name(ctx->inputs[MAIN]->format),
 354            ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
 355            av_get_pix_fmt_name(ctx->inputs[OVERLAY]->format),
 356            eof_action_str[s->eof_action]);
 357     return 0;
 358 }
 359
 360 static int config_output(AVFilterLink *outlink)
 361 {
 362     AVFilterContext *ctx = outlink->src;
 363     OverlayContext *s = ctx->priv;
 364     int ret;
 365
 366     if ((ret = ff_dualinput_init(ctx, &s->dinput)) < 0)
 367         return ret;
 368
 369     outlink->w = ctx->inputs[MAIN]->w;
 370     outlink->h = ctx->inputs[MAIN]->h;
 371     outlink->time_base = ctx->inputs[MAIN]->time_base;
 372
 373     return 0;
 374 }
 375
 376 // divide by 255 and round to nearest
 377 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
 378 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
 379
 380 // calculate the unpremultiplied alpha, applying the general equation:
 381 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
 382 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
 383 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
 384 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
 385
 386 /**
 387  * Blend image in src to destination buffer dst at position (x, y).
 388  */
 389
 390 static void blend_image_packed_rgb(AVFilterContext *ctx,
 391                                    AVFrame *dst, const AVFrame *src,
 392                                    int x, int y)
 393 {
 394     OverlayContext *s = ctx->priv;
 395     int i, imax, j, jmax;
 396     const int src_w = src->width;
 397     const int src_h = src->height;
 398     const int dst_w = dst->width;
 399     const int dst_h = dst->height;
 400     uint8_t alpha;          ///< the amount of overlay to blend on to main
 401     const int dr = s->main_rgba_map[R];
 402     const int dg = s->main_rgba_map[G];
 403     const int db = s->main_rgba_map[B];
 404     const int da = s->main_rgba_map[A];
 405     const int dstep = s->main_pix_step[0];
 406     const int sr = s->overlay_rgba_map[R];
 407     const int sg = s->overlay_rgba_map[G];
 408     const int sb = s->overlay_rgba_map[B];
 409     const int sa = s->overlay_rgba_map[A];
 410     const int sstep = s->overlay_pix_step[0];
 411     const int main_has_alpha = s->main_has_alpha;
 412     uint8_t *S, *sp, *d, *dp;
 413
 414     i = FFMAX(-y, 0);
 415     sp = src->data[0] + i     * src->linesize[0];
 416     dp = dst->data[0] + (y+i) * dst->linesize[0];
 417
 418     for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
 419         j = FFMAX(-x, 0);
 420         S = sp + j     * sstep;
 421         d = dp + (x+j) * dstep;
 422
 423         for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
 424             alpha = S[sa];
 425
 426             // if the main channel has an alpha channel, alpha has to be calculated
 427             // to create an un-premultiplied (straight) alpha value
 428             if (main_has_alpha && alpha != 0 && alpha != 255) {
 429                 uint8_t alpha_d = d[da];
 430                 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
 431             }
 432
 433             switch (alpha) {
 434             case 0:
 435                 break;
 436             case 255:
 437                 d[dr] = S[sr];
 438                 d[dg] = S[sg];
 439                 d[db] = S[sb];
 440                 break;
 441             default:
 442                 // main_value = main_value * (1 - alpha) + overlay_value * alpha
 443                 // since alpha is in the range 0-255, the result must divided by 255
 444                 d[dr] = FAST_DIV255(d[dr] * (255 - alpha) + S[sr] * alpha);
 445                 d[dg] = FAST_DIV255(d[dg] * (255 - alpha) + S[sg] * alpha);
 446                 d[db] = FAST_DIV255(d[db] * (255 - alpha) + S[sb] * alpha);
 447             }
 448             if (main_has_alpha) {
 449                 switch (alpha) {
 450                 case 0:
 451                     break;
 452                 case 255:
 453                     d[da] = S[sa];
 454                     break;
 455                 default:
 456                     // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
 457                     d[da] += FAST_DIV255((255 - d[da]) * S[sa]);
 458                 }
 459             }
 460             d += dstep;
 461             S += sstep;
 462         }
 463         dp += dst->linesize[0];
 464         sp += src->linesize[0];
 465     }
 466 }
 467
 468 static av_always_inline void blend_plane(AVFilterContext *ctx,
 469                                          AVFrame *dst, const AVFrame *src,
 470                                          int src_w, int src_h,
 471                                          int dst_w, int dst_h,
 472                                          int i, int hsub, int vsub,
 473                                          int x, int y,
 474                                          int main_has_alpha)
 475 {
 476     OverlayContext *ol = ctx->priv;
 477     int src_wp = AV_CEIL_RSHIFT(src_w, hsub);
 478     int src_hp = AV_CEIL_RSHIFT(src_h, vsub);
 479     int dst_wp = AV_CEIL_RSHIFT(dst_w, hsub);
 480     int dst_hp = AV_CEIL_RSHIFT(dst_h, vsub);
 481     int yp = y>>vsub;
 482     int xp = x>>hsub;
 483     uint8_t *s, *sp, *d, *dp, *a, *ap;
 484     int jmax, j, k, kmax;
 485
 486     int dst_plane  = ol->main_desc->comp[i].plane;
 487     int dst_offset = ol->main_desc->comp[i].offset;
 488     int dst_step   = ol->main_desc->comp[i].step;
 489
 490     j = FFMAX(-yp, 0);
 491     sp = src->data[i] + j         * src->linesize[i];
 492     dp = dst->data[dst_plane]
 493                       + (yp+j)    * dst->linesize[dst_plane]
 494                       + dst_offset;
 495     ap = src->data[3] + (j<<vsub) * src->linesize[3];
 496
 497     for (jmax = FFMIN(-yp + dst_hp, src_hp); j < jmax; j++) {
 498         k = FFMAX(-xp, 0);
 499         d = dp + (xp+k) * dst_step;
 500         s = sp + k;
 501         a = ap + (k<<hsub);
 502
 503         for (kmax = FFMIN(-xp + dst_wp, src_wp); k < kmax; k++) {
 504             int alpha_v, alpha_h, alpha;
 505
 506             // average alpha for color components, improve quality
 507             if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
 508                 alpha = (a[0] + a[src->linesize[3]] +
 509                          a[1] + a[src->linesize[3]+1]) >> 2;
 510             } else if (hsub || vsub) {
 511                 alpha_h = hsub && k+1 < src_wp ?
 512                     (a[0] + a[1]) >> 1 : a[0];
 513                 alpha_v = vsub && j+1 < src_hp ?
 514                     (a[0] + a[src->linesize[3]]) >> 1 : a[0];
 515                 alpha = (alpha_v + alpha_h) >> 1;
 516             } else
 517                 alpha = a[0];
 518             // if the main channel has an alpha channel, alpha has to be calculated
 519             // to create an un-premultiplied (straight) alpha value
 520             if (main_has_alpha && alpha != 0 && alpha != 255) {
 521                 // average alpha for color components, improve quality
 522                 uint8_t alpha_d;
 523                 if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
 524                     alpha_d = (d[0] + d[src->linesize[3]] +
 525                                d[1] + d[src->linesize[3]+1]) >> 2;
 526                 } else if (hsub || vsub) {
 527                     alpha_h = hsub && k+1 < src_wp ?
 528                         (d[0] + d[1]) >> 1 : d[0];
 529                     alpha_v = vsub && j+1 < src_hp ?
 530                         (d[0] + d[src->linesize[3]]) >> 1 : d[0];
 531                     alpha_d = (alpha_v + alpha_h) >> 1;
 532                 } else
 533                     alpha_d = d[0];
 534                 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
 535             }
 536             *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
 537             s++;
 538             d += dst_step;
 539             a += 1 << hsub;
 540         }
 541         dp += dst->linesize[dst_plane];
 542         sp += src->linesize[i];
 543         ap += (1 << vsub) * src->linesize[3];
 544     }
 545 }
 546
 547 static inline void alpha_composite(const AVFrame *src, const AVFrame *dst,
 548                                    int src_w, int src_h,
 549                                    int dst_w, int dst_h,
 550                                    int x, int y)
 551 {
 552     uint8_t alpha;          ///< the amount of overlay to blend on to main
 553     uint8_t *s, *sa, *d, *da;
 554     int i, imax, j, jmax;
 555
 556     i = FFMAX(-y, 0);
 557     sa = src->data[3] + i     * src->linesize[3];
 558     da = dst->data[3] + (y+i) * dst->linesize[3];
 559
 560     for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
 561         j = FFMAX(-x, 0);
 562         s = sa + j;
 563         d = da + x+j;
 564
 565         for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
 566             alpha = *s;
 567             if (alpha != 0 && alpha != 255) {
 568                 uint8_t alpha_d = *d;
 569                 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
 570             }
 571             switch (alpha) {
 572             case 0:
 573                 break;
 574             case 255:
 575                 *d = *s;
 576                 break;
 577             default:
 578                 // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
 579                 *d += FAST_DIV255((255 - *d) * *s);
 580             }
 581             d += 1;
 582             s += 1;
 583         }
 584         da += dst->linesize[3];
 585         sa += src->linesize[3];
 586     }
 587 }
 588
 589 static av_always_inline void blend_image_yuv(AVFilterContext *ctx,
 590                                              AVFrame *dst, const AVFrame *src,
 591                                              int hsub, int vsub,
 592                                              int main_has_alpha,
 593                                              int x, int y)
 594 {
 595     const int src_w = src->width;
 596     const int src_h = src->height;
 597     const int dst_w = dst->width;
 598     const int dst_h = dst->height;
 599
 600     if (main_has_alpha)
 601         alpha_composite(src, dst, src_w, src_h, dst_w, dst_h, x, y);
 602
 603     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 0, 0,       0, x, y, main_has_alpha);
 604     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 1, hsub, vsub, x, y, main_has_alpha);
 605     blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 2, hsub, vsub, x, y, main_has_alpha);
 606 }
 607
 608 static void blend_image_yuv420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 609 {
 610     OverlayContext *s = ctx->priv;
 611
 612     blend_image_yuv(ctx, dst, src, 1, 1, s->main_has_alpha, x, y);
 613 }
 614
 615 static void blend_image_yuv422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 616 {
 617     OverlayContext *s = ctx->priv;
 618
 619     blend_image_yuv(ctx, dst, src, 1, 0, s->main_has_alpha, x, y);
 620 }
 621
 622 static void blend_image_yuv444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
 623 {
 624     OverlayContext *s = ctx->priv;
 625
 626     blend_image_yuv(ctx, dst, src, 0, 0, s->main_has_alpha, x, y);
 627 }
 628
 629 static int config_input_main(AVFilterLink *inlink)
 630 {
 631     OverlayContext *s = inlink->dst->priv;
 632     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
 633
 634     av_image_fill_max_pixsteps(s->main_pix_step,    NULL, pix_desc);
 635
 636     s->hsub = pix_desc->log2_chroma_w;
 637     s->vsub = pix_desc->log2_chroma_h;
 638
 639     s->main_desc = pix_desc;
 640
 641     s->main_is_packed_rgb =
 642         ff_fill_rgba_map(s->main_rgba_map, inlink->format) >= 0;
 643     s->main_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
 644     switch (s->format) {
 645     case OVERLAY_FORMAT_YUV420:
 646         s->blend_image = blend_image_yuv420;
 647         break;
 648     case OVERLAY_FORMAT_YUV422:
 649         s->blend_image = blend_image_yuv422;
 650         break;
 651     case OVERLAY_FORMAT_YUV444:
 652         s->blend_image = blend_image_yuv444;
 653         break;
 654     case OVERLAY_FORMAT_RGB:
 655         s->blend_image = blend_image_packed_rgb;
 656         break;
 657     }
 658     return 0;
 659 }
 660
 661 static AVFrame *do_blend(AVFilterContext *ctx, AVFrame *mainpic,
 662                          const AVFrame *second)
 663 {
 664     OverlayContext *s = ctx->priv;
 665     AVFilterLink *inlink = ctx->inputs[0];
 666
 667     if (s->eval_mode == EVAL_MODE_FRAME) {
 668         int64_t pos = av_frame_get_pkt_pos(mainpic);
 669
 670         s->var_values[VAR_N] = inlink->frame_count_out;
 671         s->var_values[VAR_T] = mainpic->pts == AV_NOPTS_VALUE ?
 672             NAN : mainpic->pts * av_q2d(inlink->time_base);
 673         s->var_values[VAR_POS] = pos == -1 ? NAN : pos;
 674
 675         s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = second->width;
 676         s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = second->height;
 677         s->var_values[VAR_MAIN_W   ] = s->var_values[VAR_MW] = mainpic->width;
 678         s->var_values[VAR_MAIN_H   ] = s->var_values[VAR_MH] = mainpic->height;
 679
 680         eval_expr(ctx);
 681         av_log(ctx, AV_LOG_DEBUG, "n:%f t:%f pos:%f x:%f xi:%d y:%f yi:%d\n",
 682                s->var_values[VAR_N], s->var_values[VAR_T], s->var_values[VAR_POS],
 683                s->var_values[VAR_X], s->x,
 684                s->var_values[VAR_Y], s->y);
 685     }
 686
 687     if (s->x < mainpic->width  && s->x + second->width  >= 0 ||
 688         s->y < mainpic->height && s->y + second->height >= 0)
 689         s->blend_image(ctx, mainpic, second, s->x, s->y);
 690     return mainpic;
 691 }
 692
 693 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
 694 {
 695     OverlayContext *s = inlink->dst->priv;
 696     av_log(inlink->dst, AV_LOG_DEBUG, "Incoming frame (time:%s) from link #%d\n", av_ts2timestr(inpicref->pts, &inlink->time_base), FF_INLINK_IDX(inlink));
 697     return ff_dualinput_filter_frame(&s->dinput, inlink, inpicref);
 698 }
 699
 700 static int request_frame(AVFilterLink *outlink)
 701 {
 702     OverlayContext *s = outlink->src->priv;
 703     return ff_dualinput_request_frame(&s->dinput, outlink);
 704 }
 705
 706 static av_cold int init(AVFilterContext *ctx)
 707 {
 708     OverlayContext *s = ctx->priv;
 709
 710     if (s->allow_packed_rgb) {
 711         av_log(ctx, AV_LOG_WARNING,
 712                "The rgb option is deprecated and is overriding the format option, use format instead\n");
 713         s->format = OVERLAY_FORMAT_RGB;
 714     }
 715     if (!s->dinput.repeatlast || s->eof_action == EOF_ACTION_PASS) {
 716         s->dinput.repeatlast = 0;
 717         s->eof_action = EOF_ACTION_PASS;
 718     }
 719     if (s->dinput.shortest || s->eof_action == EOF_ACTION_ENDALL) {
 720         s->dinput.shortest = 1;
 721         s->eof_action = EOF_ACTION_ENDALL;
 722     }
 723
 724     s->dinput.process = do_blend;
 725     return 0;
 726 }
 727
 728 #define OFFSET(x) offsetof(OverlayContext, x)
 729 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 730
 731 static const AVOption overlay_options[] = {
 732     { "x", "set the x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
 733     { "y", "set the y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
 734     { "eof_action", "Action to take when encountering EOF from secondary input ",
 735         OFFSET(eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
 736         EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
 737         { "repeat", "Repeat the previous frame.",   0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
 738         { "endall", "End both streams.",            0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
 739         { "pass",   "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS },   .flags = FLAGS, "eof_action" },
 740     { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_FRAME}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
 741          { "init",  "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT},  .flags = FLAGS, .unit = "eval" },
 742          { "frame", "eval expressions per-frame",                  0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
 743     { "rgb", "force packed RGB in input and output (deprecated)", OFFSET(allow_packed_rgb), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
 744     { "shortest", "force termination when the shortest input terminates", OFFSET(dinput.shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
 745     { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=OVERLAY_FORMAT_YUV420}, 0, OVERLAY_FORMAT_NB-1, FLAGS, "format" },
 746         { "yuv420", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV420}, .flags = FLAGS, .unit = "format" },
 747         { "yuv422", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV422}, .flags = FLAGS, .unit = "format" },
 748         { "yuv444", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV444}, .flags = FLAGS, .unit = "format" },
 749         { "rgb",    "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_RGB},    .flags = FLAGS, .unit = "format" },
 750     { "repeatlast", "repeat overlay of the last overlay frame", OFFSET(dinput.repeatlast), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
 751     { NULL }
 752 };
 753
 754 AVFILTER_DEFINE_CLASS(overlay);
 755
 756 static const AVFilterPad avfilter_vf_overlay_inputs[] = {
 757     {
 758         .name         = "main",
 759         .type         = AVMEDIA_TYPE_VIDEO,
 760         .config_props = config_input_main,
 761         .filter_frame = filter_frame,
 762         .needs_writable = 1,
 763     },
 764     {
 765         .name         = "overlay",
 766         .type         = AVMEDIA_TYPE_VIDEO,
 767         .config_props = config_input_overlay,
 768         .filter_frame = filter_frame,
 769     },
 770     { NULL }
 771 };
 772
 773 static const AVFilterPad avfilter_vf_overlay_outputs[] = {
 774     {
 775         .name          = "default",
 776         .type          = AVMEDIA_TYPE_VIDEO,
 777         .config_props  = config_output,
 778         .request_frame = request_frame,
 779     },
 780     { NULL }
 781 };
 782
 783 AVFilter ff_vf_overlay = {
 784     .name          = "overlay",
 785     .description   = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
 786     .init          = init,
 787     .uninit        = uninit,
 788     .priv_size     = sizeof(OverlayContext),
 789     .priv_class    = &overlay_class,
 790     .query_formats = query_formats,
 791     .process_command = process_command,
 792     .inputs        = avfilter_vf_overlay_inputs,
 793     .outputs       = avfilter_vf_overlay_outputs,
 794     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
 795 };