avfilter/af_sofalizer: Fix occured typo
[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 = NULL;
249     AVFilterFormats *overlay_formats = NULL;
250     int ret;
251
252     switch (s->format) {
253     case OVERLAY_FORMAT_YUV420:
254         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv420)) ||
255             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420))) {
256                 ret = AVERROR(ENOMEM);
257                 goto fail;
258             }
259         break;
260     case OVERLAY_FORMAT_YUV422:
261         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv422)) ||
262             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv422))) {
263                 ret = AVERROR(ENOMEM);
264                 goto fail;
265             }
266         break;
267     case OVERLAY_FORMAT_YUV444:
268         if (!(main_formats    = ff_make_format_list(main_pix_fmts_yuv444)) ||
269             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444))) {
270                 ret = AVERROR(ENOMEM);
271                 goto fail;
272             }
273         break;
274     case OVERLAY_FORMAT_RGB:
275         if (!(main_formats    = ff_make_format_list(main_pix_fmts_rgb)) ||
276             !(overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb))) {
277                 ret = AVERROR(ENOMEM);
278                 goto fail;
279             }
280         break;
281     default:
282         av_assert0(0);
283     }
284
285     if ((ret = ff_formats_ref(main_formats   , &ctx->inputs[MAIN]->out_formats   )) < 0 ||
286         (ret = ff_formats_ref(overlay_formats, &ctx->inputs[OVERLAY]->out_formats)) < 0 ||
287         (ret = ff_formats_ref(main_formats   , &ctx->outputs[MAIN]->in_formats   )) < 0)
288             goto fail;
289
290     return 0;
291 fail:
292     if (main_formats)
293         av_freep(&main_formats->formats);
294     av_freep(&main_formats);
295     if (overlay_formats)
296         av_freep(&overlay_formats->formats);
297     av_freep(&overlay_formats);
298     return ret;
299 }
300
301 static const enum AVPixelFormat alpha_pix_fmts[] = {
302     AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA444P,
303     AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA,
304     AV_PIX_FMT_BGRA, AV_PIX_FMT_NONE
305 };
306
307 static int config_input_main(AVFilterLink *inlink)
308 {
309     OverlayContext *s = inlink->dst->priv;
310     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
311
312     av_image_fill_max_pixsteps(s->main_pix_step,    NULL, pix_desc);
313
314     s->hsub = pix_desc->log2_chroma_w;
315     s->vsub = pix_desc->log2_chroma_h;
316
317     s->main_is_packed_rgb =
318         ff_fill_rgba_map(s->main_rgba_map, inlink->format) >= 0;
319     s->main_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
320     return 0;
321 }
322
323 static int config_input_overlay(AVFilterLink *inlink)
324 {
325     AVFilterContext *ctx  = inlink->dst;
326     OverlayContext  *s = inlink->dst->priv;
327     int ret;
328     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
329
330     av_image_fill_max_pixsteps(s->overlay_pix_step, NULL, pix_desc);
331
332     /* Finish the configuration by evaluating the expressions
333        now when both inputs are configured. */
334     s->var_values[VAR_MAIN_W   ] = s->var_values[VAR_MW] = ctx->inputs[MAIN   ]->w;
335     s->var_values[VAR_MAIN_H   ] = s->var_values[VAR_MH] = ctx->inputs[MAIN   ]->h;
336     s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
337     s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
338     s->var_values[VAR_HSUB]  = 1<<pix_desc->log2_chroma_w;
339     s->var_values[VAR_VSUB]  = 1<<pix_desc->log2_chroma_h;
340     s->var_values[VAR_X]     = NAN;
341     s->var_values[VAR_Y]     = NAN;
342     s->var_values[VAR_N]     = 0;
343     s->var_values[VAR_T]     = NAN;
344     s->var_values[VAR_POS]   = NAN;
345
346     if ((ret = set_expr(&s->x_pexpr,      s->x_expr,      "x",      ctx)) < 0 ||
347         (ret = set_expr(&s->y_pexpr,      s->y_expr,      "y",      ctx)) < 0)
348         return ret;
349
350     s->overlay_is_packed_rgb =
351         ff_fill_rgba_map(s->overlay_rgba_map, inlink->format) >= 0;
352     s->overlay_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
353
354     if (s->eval_mode == EVAL_MODE_INIT) {
355         eval_expr(ctx);
356         av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
357                s->var_values[VAR_X], s->x,
358                s->var_values[VAR_Y], s->y);
359     }
360
361     av_log(ctx, AV_LOG_VERBOSE,
362            "main w:%d h:%d fmt:%s overlay w:%d h:%d fmt:%s eof_action:%s\n",
363            ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
364            av_get_pix_fmt_name(ctx->inputs[MAIN]->format),
365            ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
366            av_get_pix_fmt_name(ctx->inputs[OVERLAY]->format),
367            eof_action_str[s->eof_action]);
368     return 0;
369 }
370
371 static int config_output(AVFilterLink *outlink)
372 {
373     AVFilterContext *ctx = outlink->src;
374     OverlayContext *s = ctx->priv;
375     int ret;
376
377     if ((ret = ff_dualinput_init(ctx, &s->dinput)) < 0)
378         return ret;
379
380     outlink->w = ctx->inputs[MAIN]->w;
381     outlink->h = ctx->inputs[MAIN]->h;
382     outlink->time_base = ctx->inputs[MAIN]->time_base;
383
384     return 0;
385 }
386
387 // divide by 255 and round to nearest
388 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
389 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
390
391 // calculate the unpremultiplied alpha, applying the general equation:
392 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
393 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
394 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
395 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
396
397 /**
398  * Blend image in src to destination buffer dst at position (x, y).
399  */
400 static void blend_image(AVFilterContext *ctx,
401                         AVFrame *dst, const AVFrame *src,
402                         int x, int y)
403 {
404     OverlayContext *s = ctx->priv;
405     int i, imax, j, jmax, k, kmax;
406     const int src_w = src->width;
407     const int src_h = src->height;
408     const int dst_w = dst->width;
409     const int dst_h = dst->height;
410
411     if (x >= dst_w || x+src_w < 0 ||
412         y >= dst_h || y+src_h < 0)
413         return; /* no intersection */
414
415     if (s->main_is_packed_rgb) {
416         uint8_t alpha;          ///< the amount of overlay to blend on to main
417         const int dr = s->main_rgba_map[R];
418         const int dg = s->main_rgba_map[G];
419         const int db = s->main_rgba_map[B];
420         const int da = s->main_rgba_map[A];
421         const int dstep = s->main_pix_step[0];
422         const int sr = s->overlay_rgba_map[R];
423         const int sg = s->overlay_rgba_map[G];
424         const int sb = s->overlay_rgba_map[B];
425         const int sa = s->overlay_rgba_map[A];
426         const int sstep = s->overlay_pix_step[0];
427         const int main_has_alpha = s->main_has_alpha;
428         uint8_t *s, *sp, *d, *dp;
429
430         i = FFMAX(-y, 0);
431         sp = src->data[0] + i     * src->linesize[0];
432         dp = dst->data[0] + (y+i) * dst->linesize[0];
433
434         for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
435             j = FFMAX(-x, 0);
436             s = sp + j     * sstep;
437             d = dp + (x+j) * dstep;
438
439             for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
440                 alpha = s[sa];
441
442                 // if the main channel has an alpha channel, alpha has to be calculated
443                 // to create an un-premultiplied (straight) alpha value
444                 if (main_has_alpha && alpha != 0 && alpha != 255) {
445                     uint8_t alpha_d = d[da];
446                     alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
447                 }
448
449                 switch (alpha) {
450                 case 0:
451                     break;
452                 case 255:
453                     d[dr] = s[sr];
454                     d[dg] = s[sg];
455                     d[db] = s[sb];
456                     break;
457                 default:
458                     // main_value = main_value * (1 - alpha) + overlay_value * alpha
459                     // since alpha is in the range 0-255, the result must divided by 255
460                     d[dr] = FAST_DIV255(d[dr] * (255 - alpha) + s[sr] * alpha);
461                     d[dg] = FAST_DIV255(d[dg] * (255 - alpha) + s[sg] * alpha);
462                     d[db] = FAST_DIV255(d[db] * (255 - alpha) + s[sb] * alpha);
463                 }
464                 if (main_has_alpha) {
465                     switch (alpha) {
466                     case 0:
467                         break;
468                     case 255:
469                         d[da] = s[sa];
470                         break;
471                     default:
472                         // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
473                         d[da] += FAST_DIV255((255 - d[da]) * s[sa]);
474                     }
475                 }
476                 d += dstep;
477                 s += sstep;
478             }
479             dp += dst->linesize[0];
480             sp += src->linesize[0];
481         }
482     } else {
483         const int main_has_alpha = s->main_has_alpha;
484         if (main_has_alpha) {
485             uint8_t alpha;          ///< the amount of overlay to blend on to main
486             uint8_t *s, *sa, *d, *da;
487
488             i = FFMAX(-y, 0);
489             sa = src->data[3] + i     * src->linesize[3];
490             da = dst->data[3] + (y+i) * dst->linesize[3];
491
492             for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
493                 j = FFMAX(-x, 0);
494                 s = sa + j;
495                 d = da + x+j;
496
497                 for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
498                     alpha = *s;
499                     if (alpha != 0 && alpha != 255) {
500                         uint8_t alpha_d = *d;
501                         alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
502                     }
503                     switch (alpha) {
504                     case 0:
505                         break;
506                     case 255:
507                         *d = *s;
508                         break;
509                     default:
510                         // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
511                         *d += FAST_DIV255((255 - *d) * *s);
512                     }
513                     d += 1;
514                     s += 1;
515                 }
516                 da += dst->linesize[3];
517                 sa += src->linesize[3];
518             }
519         }
520         for (i = 0; i < 3; i++) {
521             int hsub = i ? s->hsub : 0;
522             int vsub = i ? s->vsub : 0;
523             int src_wp = FF_CEIL_RSHIFT(src_w, hsub);
524             int src_hp = FF_CEIL_RSHIFT(src_h, vsub);
525             int dst_wp = FF_CEIL_RSHIFT(dst_w, hsub);
526             int dst_hp = FF_CEIL_RSHIFT(dst_h, vsub);
527             int yp = y>>vsub;
528             int xp = x>>hsub;
529             uint8_t *s, *sp, *d, *dp, *a, *ap;
530
531             j = FFMAX(-yp, 0);
532             sp = src->data[i] + j         * src->linesize[i];
533             dp = dst->data[i] + (yp+j)    * dst->linesize[i];
534             ap = src->data[3] + (j<<vsub) * src->linesize[3];
535
536             for (jmax = FFMIN(-yp + dst_hp, src_hp); j < jmax; j++) {
537                 k = FFMAX(-xp, 0);
538                 d = dp + xp+k;
539                 s = sp + k;
540                 a = ap + (k<<hsub);
541
542                 for (kmax = FFMIN(-xp + dst_wp, src_wp); k < kmax; k++) {
543                     int alpha_v, alpha_h, alpha;
544
545                     // average alpha for color components, improve quality
546                     if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
547                         alpha = (a[0] + a[src->linesize[3]] +
548                                  a[1] + a[src->linesize[3]+1]) >> 2;
549                     } else if (hsub || vsub) {
550                         alpha_h = hsub && k+1 < src_wp ?
551                             (a[0] + a[1]) >> 1 : a[0];
552                         alpha_v = vsub && j+1 < src_hp ?
553                             (a[0] + a[src->linesize[3]]) >> 1 : a[0];
554                         alpha = (alpha_v + alpha_h) >> 1;
555                     } else
556                         alpha = a[0];
557                     // if the main channel has an alpha channel, alpha has to be calculated
558                     // to create an un-premultiplied (straight) alpha value
559                     if (main_has_alpha && alpha != 0 && alpha != 255) {
560                         // average alpha for color components, improve quality
561                         uint8_t alpha_d;
562                         if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
563                             alpha_d = (d[0] + d[src->linesize[3]] +
564                                        d[1] + d[src->linesize[3]+1]) >> 2;
565                         } else if (hsub || vsub) {
566                             alpha_h = hsub && k+1 < src_wp ?
567                                 (d[0] + d[1]) >> 1 : d[0];
568                             alpha_v = vsub && j+1 < src_hp ?
569                                 (d[0] + d[src->linesize[3]]) >> 1 : d[0];
570                             alpha_d = (alpha_v + alpha_h) >> 1;
571                         } else
572                             alpha_d = d[0];
573                         alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
574                     }
575                     *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
576                     s++;
577                     d++;
578                     a += 1 << hsub;
579                 }
580                 dp += dst->linesize[i];
581                 sp += src->linesize[i];
582                 ap += (1 << vsub) * src->linesize[3];
583             }
584         }
585     }
586 }
587
588 static AVFrame *do_blend(AVFilterContext *ctx, AVFrame *mainpic,
589                          const AVFrame *second)
590 {
591     OverlayContext *s = ctx->priv;
592     AVFilterLink *inlink = ctx->inputs[0];
593
594     if (s->eval_mode == EVAL_MODE_FRAME) {
595         int64_t pos = av_frame_get_pkt_pos(mainpic);
596
597         s->var_values[VAR_N] = inlink->frame_count;
598         s->var_values[VAR_T] = mainpic->pts == AV_NOPTS_VALUE ?
599             NAN : mainpic->pts * av_q2d(inlink->time_base);
600         s->var_values[VAR_POS] = pos == -1 ? NAN : pos;
601
602         eval_expr(ctx);
603         av_log(ctx, AV_LOG_DEBUG, "n:%f t:%f pos:%f x:%f xi:%d y:%f yi:%d\n",
604                s->var_values[VAR_N], s->var_values[VAR_T], s->var_values[VAR_POS],
605                s->var_values[VAR_X], s->x,
606                s->var_values[VAR_Y], s->y);
607     }
608
609     blend_image(ctx, mainpic, second, s->x, s->y);
610     return mainpic;
611 }
612
613 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
614 {
615     OverlayContext *s = inlink->dst->priv;
616     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));
617     return ff_dualinput_filter_frame(&s->dinput, inlink, inpicref);
618 }
619
620 static int request_frame(AVFilterLink *outlink)
621 {
622     OverlayContext *s = outlink->src->priv;
623     return ff_dualinput_request_frame(&s->dinput, outlink);
624 }
625
626 static av_cold int init(AVFilterContext *ctx)
627 {
628     OverlayContext *s = ctx->priv;
629
630     if (s->allow_packed_rgb) {
631         av_log(ctx, AV_LOG_WARNING,
632                "The rgb option is deprecated and is overriding the format option, use format instead\n");
633         s->format = OVERLAY_FORMAT_RGB;
634     }
635     if (!s->dinput.repeatlast || s->eof_action == EOF_ACTION_PASS) {
636         s->dinput.repeatlast = 0;
637         s->eof_action = EOF_ACTION_PASS;
638     }
639     if (s->dinput.shortest || s->eof_action == EOF_ACTION_ENDALL) {
640         s->dinput.shortest = 1;
641         s->eof_action = EOF_ACTION_ENDALL;
642     }
643
644     s->dinput.process = do_blend;
645     return 0;
646 }
647
648 #define OFFSET(x) offsetof(OverlayContext, x)
649 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
650
651 static const AVOption overlay_options[] = {
652     { "x", "set the x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
653     { "y", "set the y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
654     { "eof_action", "Action to take when encountering EOF from secondary input ",
655         OFFSET(eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
656         EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
657         { "repeat", "Repeat the previous frame.",   0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
658         { "endall", "End both streams.",            0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
659         { "pass",   "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS },   .flags = FLAGS, "eof_action" },
660     { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_FRAME}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
661          { "init",  "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT},  .flags = FLAGS, .unit = "eval" },
662          { "frame", "eval expressions per-frame",                  0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
663     { "rgb", "force packed RGB in input and output (deprecated)", OFFSET(allow_packed_rgb), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
664     { "shortest", "force termination when the shortest input terminates", OFFSET(dinput.shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
665     { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=OVERLAY_FORMAT_YUV420}, 0, OVERLAY_FORMAT_NB-1, FLAGS, "format" },
666         { "yuv420", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV420}, .flags = FLAGS, .unit = "format" },
667         { "yuv422", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV422}, .flags = FLAGS, .unit = "format" },
668         { "yuv444", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV444}, .flags = FLAGS, .unit = "format" },
669         { "rgb",    "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_RGB},    .flags = FLAGS, .unit = "format" },
670     { "repeatlast", "repeat overlay of the last overlay frame", OFFSET(dinput.repeatlast), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
671     { NULL }
672 };
673
674 AVFILTER_DEFINE_CLASS(overlay);
675
676 static const AVFilterPad avfilter_vf_overlay_inputs[] = {
677     {
678         .name         = "main",
679         .type         = AVMEDIA_TYPE_VIDEO,
680         .config_props = config_input_main,
681         .filter_frame = filter_frame,
682         .needs_writable = 1,
683     },
684     {
685         .name         = "overlay",
686         .type         = AVMEDIA_TYPE_VIDEO,
687         .config_props = config_input_overlay,
688         .filter_frame = filter_frame,
689     },
690     { NULL }
691 };
692
693 static const AVFilterPad avfilter_vf_overlay_outputs[] = {
694     {
695         .name          = "default",
696         .type          = AVMEDIA_TYPE_VIDEO,
697         .config_props  = config_output,
698         .request_frame = request_frame,
699     },
700     { NULL }
701 };
702
703 AVFilter ff_vf_overlay = {
704     .name          = "overlay",
705     .description   = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
706     .init          = init,
707     .uninit        = uninit,
708     .priv_size     = sizeof(OverlayContext),
709     .priv_class    = &overlay_class,
710     .query_formats = query_formats,
711     .process_command = process_command,
712     .inputs        = avfilter_vf_overlay_inputs,
713     .outputs       = avfilter_vf_overlay_outputs,
714     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
715 };