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