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