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