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