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