lavfi/overlay: add format 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/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     AVFilterBufferRef *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     static const char *shorthand[] = { "x", "y", NULL };
123     int ret;
124
125     over->class = &overlay_class;
126     av_opt_set_defaults(over);
127
128     ret = av_opt_set_from_string(over, args, shorthand, "=", ":");
129     if (ret < 0)
130         return ret;
131
132     if (over->allow_packed_rgb) {
133         av_log(ctx, AV_LOG_WARNING,
134                "The rgb option is deprecated and is overriding the format option, use format instead\n");
135         over->format = OVERLAY_FORMAT_RGB;
136     }
137     return 0;
138 }
139
140 static av_cold void uninit(AVFilterContext *ctx)
141 {
142     OverlayContext *over = ctx->priv;
143
144     av_opt_free(over);
145
146     avfilter_unref_bufferp(&over->overpicref);
147     ff_bufqueue_discard_all(&over->queue_main);
148     ff_bufqueue_discard_all(&over->queue_over);
149 }
150
151 static int query_formats(AVFilterContext *ctx)
152 {
153     OverlayContext *over = ctx->priv;
154
155     /* overlay formats contains alpha, for avoiding conversion with alpha information loss */
156     static const enum AVPixelFormat main_pix_fmts_yuv420[] = {
157         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_NONE
158     };
159     static const enum AVPixelFormat overlay_pix_fmts_yuv420[] = {
160         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_NONE
161     };
162
163     static const enum AVPixelFormat main_pix_fmts_yuv444[] = {
164         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
165     };
166     static const enum AVPixelFormat overlay_pix_fmts_yuv444[] = {
167         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
168     };
169
170     static const enum AVPixelFormat main_pix_fmts_rgb[] = {
171         AV_PIX_FMT_ARGB,  AV_PIX_FMT_RGBA,
172         AV_PIX_FMT_ABGR,  AV_PIX_FMT_BGRA,
173         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
174         AV_PIX_FMT_NONE
175     };
176     static const enum AVPixelFormat overlay_pix_fmts_rgb[] = {
177         AV_PIX_FMT_ARGB,  AV_PIX_FMT_RGBA,
178         AV_PIX_FMT_ABGR,  AV_PIX_FMT_BGRA,
179         AV_PIX_FMT_NONE
180     };
181
182     AVFilterFormats *main_formats;
183     AVFilterFormats *overlay_formats;
184
185     switch (over->format) {
186     case OVERLAY_FORMAT_YUV420:
187         main_formats    = ff_make_format_list(main_pix_fmts_yuv420);
188         overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420);
189         break;
190     case OVERLAY_FORMAT_YUV444:
191         main_formats    = ff_make_format_list(main_pix_fmts_yuv444);
192         overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444);
193         break;
194     case OVERLAY_FORMAT_RGB:
195         main_formats    = ff_make_format_list(main_pix_fmts_rgb);
196         overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb);
197         break;
198     }
199
200     ff_formats_ref(main_formats,    &ctx->inputs [MAIN   ]->out_formats);
201     ff_formats_ref(overlay_formats, &ctx->inputs [OVERLAY]->out_formats);
202     ff_formats_ref(main_formats,    &ctx->outputs[MAIN   ]->in_formats );
203
204     return 0;
205 }
206
207 static const enum AVPixelFormat alpha_pix_fmts[] = {
208     AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA444P,
209     AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA,
210     AV_PIX_FMT_BGRA, AV_PIX_FMT_NONE
211 };
212
213 static int config_input_main(AVFilterLink *inlink)
214 {
215     OverlayContext *over = inlink->dst->priv;
216     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
217
218     av_image_fill_max_pixsteps(over->main_pix_step,    NULL, pix_desc);
219
220     over->hsub = pix_desc->log2_chroma_w;
221     over->vsub = pix_desc->log2_chroma_h;
222
223     over->main_is_packed_rgb =
224         ff_fill_rgba_map(over->main_rgba_map, inlink->format) >= 0;
225     over->main_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
226     return 0;
227 }
228
229 static int config_input_overlay(AVFilterLink *inlink)
230 {
231     AVFilterContext *ctx  = inlink->dst;
232     OverlayContext  *over = inlink->dst->priv;
233     char *expr;
234     double var_values[VAR_VARS_NB], res;
235     int ret;
236     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
237
238     av_image_fill_max_pixsteps(over->overlay_pix_step, NULL, pix_desc);
239
240     /* Finish the configuration by evaluating the expressions
241        now when both inputs are configured. */
242     var_values[VAR_MAIN_W   ] = var_values[VAR_MW] = ctx->inputs[MAIN   ]->w;
243     var_values[VAR_MAIN_H   ] = var_values[VAR_MH] = ctx->inputs[MAIN   ]->h;
244     var_values[VAR_OVERLAY_W] = var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
245     var_values[VAR_OVERLAY_H] = var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
246
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     if ((ret = av_expr_parse_and_eval(&res, (expr = over->y_expr), var_names, var_values,
252                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)))
253         goto fail;
254     over->y = res;
255     /* x may depend on y */
256     if ((ret = av_expr_parse_and_eval(&res, (expr = over->x_expr), var_names, var_values,
257                                       NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
258         goto fail;
259     over->x = res;
260
261     over->overlay_is_packed_rgb =
262         ff_fill_rgba_map(over->overlay_rgba_map, inlink->format) >= 0;
263     over->overlay_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
264
265     av_log(ctx, AV_LOG_VERBOSE,
266            "main w:%d h:%d fmt:%s overlay x:%d y:%d w:%d h:%d fmt:%s\n",
267            ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
268            av_get_pix_fmt_name(ctx->inputs[MAIN]->format),
269            over->x, over->y,
270            ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
271            av_get_pix_fmt_name(ctx->inputs[OVERLAY]->format));
272
273     if (over->x < 0 || over->y < 0 ||
274         over->x + var_values[VAR_OVERLAY_W] > var_values[VAR_MAIN_W] ||
275         over->y + var_values[VAR_OVERLAY_H] > var_values[VAR_MAIN_H]) {
276         av_log(ctx, AV_LOG_ERROR,
277                "Overlay area (%d,%d)<->(%d,%d) not within the main area (0,0)<->(%d,%d) or zero-sized\n",
278                over->x, over->y,
279                (int)(over->x + var_values[VAR_OVERLAY_W]),
280                (int)(over->y + var_values[VAR_OVERLAY_H]),
281                (int)var_values[VAR_MAIN_W], (int)var_values[VAR_MAIN_H]);
282         return AVERROR(EINVAL);
283     }
284     return 0;
285
286 fail:
287     av_log(NULL, AV_LOG_ERROR,
288            "Error when evaluating the expression '%s'\n", expr);
289     return ret;
290 }
291
292 static int config_output(AVFilterLink *outlink)
293 {
294     AVFilterContext *ctx = outlink->src;
295
296     outlink->w = ctx->inputs[MAIN]->w;
297     outlink->h = ctx->inputs[MAIN]->h;
298     outlink->time_base = ctx->inputs[MAIN]->time_base;
299
300     return 0;
301 }
302
303 // divide by 255 and round to nearest
304 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
305 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
306
307 // calculate the unpremultiplied alpha, applying the general equation:
308 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
309 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
310 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
311 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
312
313 /**
314  * Blend image in src to destination buffer dst at position (x, y).
315  *
316  * It is assumed that the src image at position (x, y) is contained in
317  * dst.
318  */
319 static void blend_image(AVFilterContext *ctx,
320                         AVFilterBufferRef *dst, AVFilterBufferRef *src,
321                         int x, int y)
322 {
323     OverlayContext *over = ctx->priv;
324     int i, j, k;
325     int width   = src->video->w;
326     int height  = src->video->h;
327
328     if (over->main_is_packed_rgb) {
329         uint8_t *dp = dst->data[0] + x * over->main_pix_step[0] +
330                       y * dst->linesize[0];
331         uint8_t *sp = src->data[0];
332         uint8_t alpha;          ///< the amount of overlay to blend on to main
333         const int dr = over->main_rgba_map[R];
334         const int dg = over->main_rgba_map[G];
335         const int db = over->main_rgba_map[B];
336         const int da = over->main_rgba_map[A];
337         const int dstep = over->main_pix_step[0];
338         const int sr = over->overlay_rgba_map[R];
339         const int sg = over->overlay_rgba_map[G];
340         const int sb = over->overlay_rgba_map[B];
341         const int sa = over->overlay_rgba_map[A];
342         const int sstep = over->overlay_pix_step[0];
343         const int main_has_alpha = over->main_has_alpha;
344         for (i = 0; i < height; i++) {
345             uint8_t *d = dp, *s = sp;
346             for (j = 0; j < width; 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 *da = dst->data[3] + x * over->main_pix_step[3] +
393                           y * dst->linesize[3];
394             uint8_t *sa = src->data[3];
395             uint8_t alpha;          ///< the amount of overlay to blend on to main
396             for (i = 0; i < height; i++) {
397                 uint8_t *d = da, *s = sa;
398                 for (j = 0; j < width; j++) {
399                     alpha = *s;
400                     if (alpha != 0 && alpha != 255) {
401                         uint8_t alpha_d = *d;
402                         alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
403                     }
404                     switch (alpha) {
405                     case 0:
406                         break;
407                     case 255:
408                         *d = *s;
409                         break;
410                     default:
411                         // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
412                         *d += FAST_DIV255((255 - *d) * *s);
413                     }
414                     d += 1;
415                     s += 1;
416                 }
417                 da += dst->linesize[3];
418                 sa += src->linesize[3];
419             }
420         }
421         for (i = 0; i < 3; i++) {
422             int hsub = i ? over->hsub : 0;
423             int vsub = i ? over->vsub : 0;
424             uint8_t *dp = dst->data[i] + (x >> hsub) +
425                 (y >> vsub) * dst->linesize[i];
426             uint8_t *sp = src->data[i];
427             uint8_t *ap = src->data[3];
428             int wp = FFALIGN(width, 1<<hsub) >> hsub;
429             int hp = FFALIGN(height, 1<<vsub) >> vsub;
430             for (j = 0; j < hp; j++) {
431                 uint8_t *d = dp, *s = sp, *a = ap;
432                 for (k = 0; k < wp; k++) {
433                     // average alpha for color components, improve quality
434                     int alpha_v, alpha_h, alpha;
435                     if (hsub && vsub && j+1 < hp && k+1 < wp) {
436                         alpha = (a[0] + a[src->linesize[3]] +
437                                  a[1] + a[src->linesize[3]+1]) >> 2;
438                     } else if (hsub || vsub) {
439                         alpha_h = hsub && k+1 < wp ?
440                             (a[0] + a[1]) >> 1 : a[0];
441                         alpha_v = vsub && j+1 < hp ?
442                             (a[0] + a[src->linesize[3]]) >> 1 : a[0];
443                         alpha = (alpha_v + alpha_h) >> 1;
444                     } else
445                         alpha = a[0];
446                     // if the main channel has an alpha channel, alpha has to be calculated
447                     // to create an un-premultiplied (straight) alpha value
448                     if (main_has_alpha && alpha != 0 && alpha != 255) {
449                         // average alpha for color components, improve quality
450                         uint8_t alpha_d;
451                         if (hsub && vsub && j+1 < hp && k+1 < wp) {
452                             alpha_d = (d[0] + d[src->linesize[3]] +
453                                        d[1] + d[src->linesize[3]+1]) >> 2;
454                         } else if (hsub || vsub) {
455                             alpha_h = hsub && k+1 < wp ?
456                                 (d[0] + d[1]) >> 1 : d[0];
457                             alpha_v = vsub && j+1 < hp ?
458                                 (d[0] + d[src->linesize[3]]) >> 1 : d[0];
459                             alpha_d = (alpha_v + alpha_h) >> 1;
460                         } else
461                             alpha_d = d[0];
462                         alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
463                     }
464                     *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
465                     s++;
466                     d++;
467                     a += 1 << hsub;
468                 }
469                 dp += dst->linesize[i];
470                 sp += src->linesize[i];
471                 ap += (1 << vsub) * src->linesize[3];
472             }
473         }
474     }
475 }
476
477 static int try_filter_frame(AVFilterContext *ctx, AVFilterBufferRef *mainpic)
478 {
479     OverlayContext *over = ctx->priv;
480     AVFilterLink *outlink = ctx->outputs[0];
481     AVFilterBufferRef *next_overpic;
482     int ret;
483
484     /* Discard obsolete overlay frames: if there is a next overlay frame with pts
485      * before the main frame, we can drop the current overlay. */
486     while (1) {
487         next_overpic = ff_bufqueue_peek(&over->queue_over, 0);
488         if (!next_overpic || av_compare_ts(next_overpic->pts, ctx->inputs[OVERLAY]->time_base,
489                                            mainpic->pts     , ctx->inputs[MAIN]->time_base) > 0)
490             break;
491         ff_bufqueue_get(&over->queue_over);
492         avfilter_unref_buffer(over->overpicref);
493         over->overpicref = next_overpic;
494     }
495
496     /* If there is no next frame and no EOF and the overlay frame is before
497      * the main frame, we can not know yet if it will be superseded. */
498     if (!over->queue_over.available && !over->overlay_eof &&
499         (!over->overpicref || av_compare_ts(over->overpicref->pts, ctx->inputs[OVERLAY]->time_base,
500                                             mainpic->pts         , ctx->inputs[MAIN]->time_base) < 0))
501         return AVERROR(EAGAIN);
502
503     /* At this point, we know that the current overlay frame extends to the
504      * time of the main frame. */
505     av_dlog(ctx, "main_pts:%s main_pts_time:%s",
506             av_ts2str(mainpic->pts), av_ts2timestr(mainpic->pts, &outlink->time_base));
507     if (over->overpicref)
508         av_dlog(ctx, " over_pts:%s over_pts_time:%s",
509                 av_ts2str(over->overpicref->pts), av_ts2timestr(over->overpicref->pts, &outlink->time_base));
510     av_dlog(ctx, "\n");
511
512     if (over->overpicref)
513         blend_image(ctx, mainpic, over->overpicref, over->x, over->y);
514     ret = ff_filter_frame(ctx->outputs[0], mainpic);
515     av_assert1(ret != AVERROR(EAGAIN));
516     over->frame_requested = 0;
517     return ret;
518 }
519
520 static int try_filter_next_frame(AVFilterContext *ctx)
521 {
522     OverlayContext *over = ctx->priv;
523     AVFilterBufferRef *next_mainpic = ff_bufqueue_peek(&over->queue_main, 0);
524     int ret;
525
526     if (!next_mainpic)
527         return AVERROR(EAGAIN);
528     if ((ret = try_filter_frame(ctx, next_mainpic)) == AVERROR(EAGAIN))
529         return ret;
530     ff_bufqueue_get(&over->queue_main);
531     return ret;
532 }
533
534 static int flush_frames(AVFilterContext *ctx)
535 {
536     int ret;
537
538     while (!(ret = try_filter_next_frame(ctx)));
539     return ret == AVERROR(EAGAIN) ? 0 : ret;
540 }
541
542 static int filter_frame_main(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
543 {
544     AVFilterContext *ctx = inlink->dst;
545     OverlayContext *over = ctx->priv;
546     int ret;
547
548     if ((ret = flush_frames(ctx)) < 0)
549         return ret;
550     if ((ret = try_filter_frame(ctx, inpicref)) < 0) {
551         if (ret != AVERROR(EAGAIN))
552             return ret;
553         ff_bufqueue_add(ctx, &over->queue_main, inpicref);
554     }
555
556     if (!over->overpicref)
557         return 0;
558     flush_frames(ctx);
559
560     return 0;
561 }
562
563 static int filter_frame_over(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
564 {
565     AVFilterContext *ctx = inlink->dst;
566     OverlayContext *over = ctx->priv;
567     int ret;
568
569     if ((ret = flush_frames(ctx)) < 0)
570         return ret;
571     ff_bufqueue_add(ctx, &over->queue_over, inpicref);
572     ret = try_filter_next_frame(ctx);
573     return ret == AVERROR(EAGAIN) ? 0 : ret;
574 }
575
576 static int request_frame(AVFilterLink *outlink)
577 {
578     AVFilterContext *ctx = outlink->src;
579     OverlayContext *over = ctx->priv;
580     int input, ret;
581
582     if (!try_filter_next_frame(ctx))
583         return 0;
584     over->frame_requested = 1;
585     while (over->frame_requested) {
586         /* TODO if we had a frame duration, we could guess more accurately */
587         input = !over->overlay_eof && (over->queue_main.available ||
588                                        over->queue_over.available < 2) ?
589                 OVERLAY : MAIN;
590         ret = ff_request_frame(ctx->inputs[input]);
591         /* EOF on main is reported immediately */
592         if (ret == AVERROR_EOF && input == OVERLAY) {
593             over->overlay_eof = 1;
594             if (over->shortest)
595                 return ret;
596             if ((ret = try_filter_next_frame(ctx)) != AVERROR(EAGAIN))
597                 return ret;
598             ret = 0; /* continue requesting frames on main */
599         }
600         if (ret < 0)
601             return ret;
602     }
603     return 0;
604 }
605
606 static const AVFilterPad avfilter_vf_overlay_inputs[] = {
607     {
608         .name         = "main",
609         .type         = AVMEDIA_TYPE_VIDEO,
610         .get_video_buffer = ff_null_get_video_buffer,
611         .config_props = config_input_main,
612         .filter_frame = filter_frame_main,
613         .min_perms    = AV_PERM_READ | AV_PERM_WRITE | AV_PERM_PRESERVE,
614     },
615     {
616         .name         = "overlay",
617         .type         = AVMEDIA_TYPE_VIDEO,
618         .config_props = config_input_overlay,
619         .filter_frame = filter_frame_over,
620         .min_perms    = AV_PERM_READ | AV_PERM_PRESERVE,
621     },
622     { NULL }
623 };
624
625 static const AVFilterPad avfilter_vf_overlay_outputs[] = {
626     {
627         .name          = "default",
628         .type          = AVMEDIA_TYPE_VIDEO,
629         .rej_perms     = AV_PERM_WRITE,
630         .config_props  = config_output,
631         .request_frame = request_frame,
632     },
633     { NULL }
634 };
635
636 AVFilter avfilter_vf_overlay = {
637     .name      = "overlay",
638     .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
639
640     .init      = init,
641     .uninit    = uninit,
642
643     .priv_size = sizeof(OverlayContext),
644
645     .query_formats = query_formats,
646
647     .inputs    = avfilter_vf_overlay_inputs,
648     .outputs   = avfilter_vf_overlay_outputs,
649     .priv_class = &overlay_class,
650 };