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