2 * Copyright (c) 2010 Stefano Sabatini
3 * Copyright (c) 2010 Baptiste Coudurier
4 * Copyright (c) 2007 Bobby Bingham
6 * This file is part of FFmpeg.
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.
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.
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
25 * overlay one video on top of another
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"
41 #include "bufferqueue.h"
42 #include "drawutils.h"
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
56 VAR_OVERLAY_W, VAR_OW,
57 VAR_OVERLAY_H, VAR_OH,
75 int x, y; ///< position of overlayed picture
78 uint8_t frame_requested;
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;
87 AVFilterBufferRef *overpicref;
88 struct FFBufQueue queue_main;
89 struct FFBufQueue queue_over;
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
95 char *x_expr, *y_expr;
98 #define OFFSET(x) offsetof(OverlayContext, x)
99 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
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 },
108 AVFILTER_DEFINE_CLASS(overlay);
110 static av_cold int init(AVFilterContext *ctx, const char *args)
112 OverlayContext *over = ctx->priv;
113 char *args1 = av_strdup(args);
114 char *expr, *bufptr = NULL;
117 over->class = &overlay_class;
118 av_opt_set_defaults(over);
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);
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);
135 if (bufptr && (ret = av_set_options_string(over, bufptr, "=", ":")) < 0)
143 static av_cold void uninit(AVFilterContext *ctx)
145 OverlayContext *over = ctx->priv;
147 av_freep(&over->x_expr);
148 av_freep(&over->y_expr);
150 avfilter_unref_bufferp(&over->overpicref);
151 ff_bufqueue_discard_all(&over->queue_main);
152 ff_bufqueue_discard_all(&over->queue_over);
155 static int query_formats(AVFilterContext *ctx)
157 OverlayContext *over = ctx->priv;
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_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,
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,
174 AVFilterFormats *main_formats;
175 AVFilterFormats *overlay_formats;
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);
181 main_formats = ff_make_format_list(main_pix_fmts_yuv);
182 overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv);
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 );
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
197 static int config_input_main(AVFilterLink *inlink)
199 OverlayContext *over = inlink->dst->priv;
200 const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
202 av_image_fill_max_pixsteps(over->main_pix_step, NULL, pix_desc);
204 over->hsub = pix_desc->log2_chroma_w;
205 over->vsub = pix_desc->log2_chroma_h;
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);
213 static int config_input_overlay(AVFilterLink *inlink)
215 AVFilterContext *ctx = inlink->dst;
216 OverlayContext *over = inlink->dst->priv;
218 double var_values[VAR_VARS_NB], res;
220 const AVPixFmtDescriptor *pix_desc = &av_pix_fmt_descriptors[inlink->format];
222 av_image_fill_max_pixsteps(over->overlay_pix_step, NULL, pix_desc);
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;
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)
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)))
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)
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);
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_pix_fmt_descriptors[ctx->inputs[MAIN]->format].name,
254 ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
255 av_pix_fmt_descriptors[ctx->inputs[OVERLAY]->format].name);
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",
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);
271 av_log(NULL, AV_LOG_ERROR,
272 "Error when evaluating the expression '%s'\n", expr);
276 static int config_output(AVFilterLink *outlink)
278 AVFilterContext *ctx = outlink->src;
280 outlink->w = ctx->inputs[MAIN]->w;
281 outlink->h = ctx->inputs[MAIN]->h;
282 outlink->time_base = ctx->inputs[MAIN]->time_base;
287 static AVFilterBufferRef *get_video_buffer(AVFilterLink *link, int perms, int w, int h)
289 return ff_get_video_buffer(link->dst->outputs[0], perms, w, h);
292 // divide by 255 and round to nearest
293 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
294 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
296 static void blend_slice(AVFilterContext *ctx,
297 AVFilterBufferRef *dst, AVFilterBufferRef *src,
298 int x, int y, int w, int h,
299 int slice_y, int slice_w, int slice_h)
301 OverlayContext *over = ctx->priv;
304 int overlay_end_y = y+h;
305 int slice_end_y = slice_y+slice_h;
308 width = FFMIN(slice_w - x, w);
309 end_y = FFMIN(slice_end_y, overlay_end_y);
310 start_y = FFMAX(y, slice_y);
311 height = end_y - start_y;
313 if (over->main_is_packed_rgb) {
314 uint8_t *dp = dst->data[0] + x * over->main_pix_step[0] +
315 start_y * dst->linesize[0];
316 uint8_t *sp = src->data[0];
317 uint8_t alpha; ///< the amount of overlay to blend on to main
318 const int dr = over->main_rgba_map[R];
319 const int dg = over->main_rgba_map[G];
320 const int db = over->main_rgba_map[B];
321 const int da = over->main_rgba_map[A];
322 const int dstep = over->main_pix_step[0];
323 const int sr = over->overlay_rgba_map[R];
324 const int sg = over->overlay_rgba_map[G];
325 const int sb = over->overlay_rgba_map[B];
326 const int sa = over->overlay_rgba_map[A];
327 const int sstep = over->overlay_pix_step[0];
328 const int main_has_alpha = over->main_has_alpha;
330 sp += (slice_y - y) * src->linesize[0];
331 for (i = 0; i < height; i++) {
332 uint8_t *d = dp, *s = sp;
333 for (j = 0; j < width; j++) {
336 // if the main channel has an alpha channel, alpha has to be calculated
337 // to create an un-premultiplied (straight) alpha value
338 if (main_has_alpha && alpha != 0 && alpha != 255) {
339 // apply the general equation:
340 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
342 // the next line is a faster version of: 255 * 255 * alpha
343 ( (alpha << 16) - (alpha << 9) + alpha )
345 // the next line is a faster version of: 255 * (alpha + d[da])
346 ( ((alpha + d[da]) << 8 ) - (alpha + d[da])
359 // main_value = main_value * (1 - alpha) + overlay_value * alpha
360 // since alpha is in the range 0-255, the result must divided by 255
361 d[dr] = FAST_DIV255(d[dr] * (255 - alpha) + s[sr] * alpha);
362 d[dg] = FAST_DIV255(d[dg] * (255 - alpha) + s[sg] * alpha);
363 d[db] = FAST_DIV255(d[db] * (255 - alpha) + s[sb] * alpha);
365 if (main_has_alpha) {
373 // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
374 d[da] += FAST_DIV255((255 - d[da]) * s[sa]);
380 dp += dst->linesize[0];
381 sp += src->linesize[0];
384 for (i = 0; i < 3; i++) {
385 int hsub = i ? over->hsub : 0;
386 int vsub = i ? over->vsub : 0;
387 uint8_t *dp = dst->data[i] + (x >> hsub) +
388 (start_y >> vsub) * dst->linesize[i];
389 uint8_t *sp = src->data[i];
390 uint8_t *ap = src->data[3];
391 int wp = FFALIGN(width, 1<<hsub) >> hsub;
392 int hp = FFALIGN(height, 1<<vsub) >> vsub;
394 sp += ((slice_y - y) >> vsub) * src->linesize[i];
395 ap += (slice_y - y) * src->linesize[3];
397 for (j = 0; j < hp; j++) {
398 uint8_t *d = dp, *s = sp, *a = ap;
399 for (k = 0; k < wp; k++) {
400 // average alpha for color components, improve quality
401 int alpha_v, alpha_h, alpha;
402 if (hsub && vsub && j+1 < hp && k+1 < wp) {
403 alpha = (a[0] + a[src->linesize[3]] +
404 a[1] + a[src->linesize[3]+1]) >> 2;
405 } else if (hsub || vsub) {
406 alpha_h = hsub && k+1 < wp ?
407 (a[0] + a[1]) >> 1 : a[0];
408 alpha_v = vsub && j+1 < hp ?
409 (a[0] + a[src->linesize[3]]) >> 1 : a[0];
410 alpha = (alpha_v + alpha_h) >> 1;
413 *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
418 dp += dst->linesize[i];
419 sp += src->linesize[i];
420 ap += (1 << vsub) * src->linesize[3];
426 static int try_start_frame(AVFilterContext *ctx, AVFilterBufferRef *mainpic)
428 OverlayContext *over = ctx->priv;
429 AVFilterLink *outlink = ctx->outputs[0];
430 AVFilterBufferRef *next_overpic, *outpicref;
433 /* Discard obsolete overlay frames: if there is a next frame with pts is
434 * before the main frame, we can drop the current overlay. */
436 next_overpic = ff_bufqueue_peek(&over->queue_over, 0);
437 if (!next_overpic || av_compare_ts(next_overpic->pts, ctx->inputs[OVERLAY]->time_base,
438 mainpic->pts , ctx->inputs[MAIN]->time_base) > 0)
440 ff_bufqueue_get(&over->queue_over);
441 avfilter_unref_buffer(over->overpicref);
442 over->overpicref = next_overpic;
444 /* If there is no next frame and no EOF and the overlay frame is before
445 * the main frame, we can not know yet if it will be superseded. */
446 if (!over->queue_over.available && !over->overlay_eof &&
447 (!over->overpicref || av_compare_ts(over->overpicref->pts, ctx->inputs[OVERLAY]->time_base,
448 mainpic->pts , ctx->inputs[MAIN]->time_base) < 0))
449 return AVERROR(EAGAIN);
450 /* At this point, we know that the current overlay frame extends to the
451 * time of the main frame. */
452 outlink->out_buf = outpicref = avfilter_ref_buffer(mainpic, ~0);
454 av_dlog(ctx, "main_pts:%s main_pts_time:%s",
455 av_ts2str(outpicref->pts), av_ts2timestr(outpicref->pts, &outlink->time_base));
456 if (over->overpicref)
457 av_dlog(ctx, " over_pts:%s over_pts_time:%s",
458 av_ts2str(over->overpicref->pts), av_ts2timestr(over->overpicref->pts, &outlink->time_base));
461 ret = ff_start_frame(ctx->outputs[0], avfilter_ref_buffer(outpicref, ~0));
462 over->frame_requested = 0;
466 static int try_start_next_frame(AVFilterContext *ctx)
468 OverlayContext *over = ctx->priv;
469 AVFilterBufferRef *next_mainpic = ff_bufqueue_peek(&over->queue_main, 0);
473 return AVERROR(EAGAIN);
474 if ((ret = try_start_frame(ctx, next_mainpic)) == AVERROR(EAGAIN))
476 avfilter_unref_buffer(ff_bufqueue_get(&over->queue_main));
480 static int try_push_frame(AVFilterContext *ctx)
482 OverlayContext *over = ctx->priv;
483 AVFilterLink *outlink = ctx->outputs[0];
484 AVFilterBufferRef *outpicref;
487 if ((ret = try_start_next_frame(ctx)) < 0)
489 outpicref = outlink->out_buf;
490 if (over->overpicref)
491 blend_slice(ctx, outpicref, over->overpicref, over->x, over->y,
492 over->overpicref->video->w, over->overpicref->video->h,
493 0, outpicref->video->w, outpicref->video->h);
494 if ((ret = ff_draw_slice(outlink, 0, outpicref->video->h, +1)) < 0 ||
495 (ret = ff_end_frame(outlink)) < 0)
500 static int flush_frames(AVFilterContext *ctx)
504 while (!(ret = try_push_frame(ctx)));
505 return ret == AVERROR(EAGAIN) ? 0 : ret;
508 static int start_frame_main(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
510 AVFilterContext *ctx = inlink->dst;
511 OverlayContext *over = ctx->priv;
514 if ((ret = flush_frames(ctx)) < 0)
516 if ((ret = try_start_frame(ctx, inpicref)) < 0) {
517 if (ret != AVERROR(EAGAIN))
519 ff_bufqueue_add(ctx, &over->queue_main, inpicref);
520 av_assert1(inpicref == inlink->cur_buf);
521 inlink->cur_buf = NULL;
526 static int draw_slice_main(AVFilterLink *inlink, int y, int h, int slice_dir)
528 AVFilterContext *ctx = inlink->dst;
529 OverlayContext *over = ctx->priv;
530 AVFilterLink *outlink = ctx->outputs[0];
531 AVFilterBufferRef *outpicref = outlink->out_buf;
535 if (over->overpicref &&
536 y + h > over->y && y < over->y + over->overpicref->video->h) {
537 blend_slice(ctx, outpicref, over->overpicref, over->x, over->y,
538 over->overpicref->video->w, over->overpicref->video->h,
539 y, outpicref->video->w, h);
541 return ff_draw_slice(outlink, y, h, slice_dir);
544 static int end_frame_main(AVFilterLink *inlink)
546 AVFilterContext *ctx = inlink->dst;
547 AVFilterLink *outlink = ctx->outputs[0];
548 AVFilterBufferRef *outpicref = outlink->out_buf;
553 return ff_end_frame(ctx->outputs[0]);
556 static int start_frame_over(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
561 static int end_frame_over(AVFilterLink *inlink)
563 AVFilterContext *ctx = inlink->dst;
564 OverlayContext *over = ctx->priv;
565 AVFilterBufferRef *inpicref = inlink->cur_buf;
568 inlink->cur_buf = NULL;
570 if ((ret = flush_frames(ctx)) < 0)
572 ff_bufqueue_add(ctx, &over->queue_over, inpicref);
573 ret = try_push_frame(ctx);
574 return ret == AVERROR(EAGAIN) ? 0 : ret;
577 static int request_frame(AVFilterLink *outlink)
579 AVFilterContext *ctx = outlink->src;
580 OverlayContext *over = ctx->priv;
583 if (!try_push_frame(ctx))
585 over->frame_requested = 1;
586 while (over->frame_requested) {
587 /* TODO if we had a frame duration, we could guess more accurately */
588 input = !over->overlay_eof && (over->queue_main.available ||
589 over->queue_over.available < 2) ?
591 ret = ff_request_frame(ctx->inputs[input]);
592 /* EOF on main is reported immediately */
593 if (ret == AVERROR_EOF && input == OVERLAY) {
594 over->overlay_eof = 1;
595 if ((ret = try_start_next_frame(ctx)) != AVERROR(EAGAIN))
597 ret = 0; /* continue requesting frames on main */
605 static int null_draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
610 AVFilter avfilter_vf_overlay = {
612 .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
617 .priv_size = sizeof(OverlayContext),
619 .query_formats = query_formats,
621 .inputs = (const AVFilterPad[]) {{ .name = "main",
622 .type = AVMEDIA_TYPE_VIDEO,
623 .get_video_buffer= get_video_buffer,
624 .config_props = config_input_main,
625 .start_frame = start_frame_main,
626 .draw_slice = draw_slice_main,
627 .end_frame = end_frame_main,
628 .min_perms = AV_PERM_READ | AV_PERM_WRITE | AV_PERM_PRESERVE },
630 .type = AVMEDIA_TYPE_VIDEO,
631 .config_props = config_input_overlay,
632 .start_frame = start_frame_over,
633 .draw_slice = null_draw_slice,
634 .end_frame = end_frame_over,
635 .min_perms = AV_PERM_READ | AV_PERM_PRESERVE },
637 .outputs = (const AVFilterPad[]) {{ .name = "default",
638 .type = AVMEDIA_TYPE_VIDEO,
639 .rej_perms = AV_PERM_WRITE,
640 .config_props = config_output,
641 .request_frame = request_frame, },
643 .priv_class = &overlay_class,