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