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