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