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