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