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