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