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