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
30 #include "libavutil/common.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/pixdesc.h"
34 #include "libavutil/imgutils.h"
35 #include "libavutil/mathematics.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/timestamp.h"
39 #include "drawutils.h"
40 #include "framesync.h"
43 static const char *const var_names[] = {
44 "main_w", "W", ///< width of the main video
45 "main_h", "H", ///< height of the main video
46 "overlay_w", "w", ///< width of the overlay video
47 "overlay_h", "h", ///< height of the overlay video
52 "n", ///< number of frame
53 "pos", ///< position in the file
54 "t", ///< timestamp expressed in seconds
61 VAR_OVERLAY_W, VAR_OW,
62 VAR_OVERLAY_H, VAR_OH,
92 OVERLAY_FORMAT_YUV420,
93 OVERLAY_FORMAT_YUV422,
94 OVERLAY_FORMAT_YUV444,
101 typedef struct OverlayContext {
102 const AVClass *class;
103 int x, y; ///< position of overlaid picture
105 uint8_t main_is_packed_rgb;
106 uint8_t main_rgba_map[4];
107 uint8_t main_has_alpha;
108 uint8_t overlay_is_packed_rgb;
109 uint8_t overlay_rgba_map[4];
110 uint8_t overlay_has_alpha;
111 int format; ///< OverlayFormat
112 int eval_mode; ///< EvalMode
116 int main_pix_step[4]; ///< steps per pixel for each plane of the main output
117 int overlay_pix_step[4]; ///< steps per pixel for each plane of the overlay
118 int hsub, vsub; ///< chroma subsampling values
119 const AVPixFmtDescriptor *main_desc; ///< format descriptor for main input
121 double var_values[VAR_VARS_NB];
122 char *x_expr, *y_expr;
124 AVExpr *x_pexpr, *y_pexpr;
126 void (*blend_image)(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y);
129 static av_cold void uninit(AVFilterContext *ctx)
131 OverlayContext *s = ctx->priv;
133 ff_framesync_uninit(&s->fs);
134 av_expr_free(s->x_pexpr); s->x_pexpr = NULL;
135 av_expr_free(s->y_pexpr); s->y_pexpr = NULL;
138 static inline int normalize_xy(double d, int chroma_sub)
142 return (int)d & ~((1 << chroma_sub) - 1);
145 static void eval_expr(AVFilterContext *ctx)
147 OverlayContext *s = ctx->priv;
149 s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
150 s->var_values[VAR_Y] = av_expr_eval(s->y_pexpr, s->var_values, NULL);
151 s->var_values[VAR_X] = av_expr_eval(s->x_pexpr, s->var_values, NULL);
152 s->x = normalize_xy(s->var_values[VAR_X], s->hsub);
153 s->y = normalize_xy(s->var_values[VAR_Y], s->vsub);
156 static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
163 ret = av_expr_parse(pexpr, expr, var_names,
164 NULL, NULL, NULL, NULL, 0, log_ctx);
166 av_log(log_ctx, AV_LOG_ERROR,
167 "Error when evaluating the expression '%s' for %s\n",
177 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
178 char *res, int res_len, int flags)
180 OverlayContext *s = ctx->priv;
183 if (!strcmp(cmd, "x"))
184 ret = set_expr(&s->x_pexpr, args, cmd, ctx);
185 else if (!strcmp(cmd, "y"))
186 ret = set_expr(&s->y_pexpr, args, cmd, ctx);
188 ret = AVERROR(ENOSYS);
193 if (s->eval_mode == EVAL_MODE_INIT) {
195 av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
196 s->var_values[VAR_X], s->x,
197 s->var_values[VAR_Y], s->y);
202 static const enum AVPixelFormat alpha_pix_fmts[] = {
203 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
204 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, AV_PIX_FMT_RGBA,
205 AV_PIX_FMT_BGRA, AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
208 static int query_formats(AVFilterContext *ctx)
210 OverlayContext *s = ctx->priv;
212 /* overlay formats contains alpha, for avoiding conversion with alpha information loss */
213 static const enum AVPixelFormat main_pix_fmts_yuv420[] = {
214 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVA420P,
215 AV_PIX_FMT_NV12, AV_PIX_FMT_NV21,
218 static const enum AVPixelFormat overlay_pix_fmts_yuv420[] = {
219 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_NONE
222 static const enum AVPixelFormat main_pix_fmts_yuv422[] = {
223 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_NONE
225 static const enum AVPixelFormat overlay_pix_fmts_yuv422[] = {
226 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_NONE
229 static const enum AVPixelFormat main_pix_fmts_yuv444[] = {
230 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
232 static const enum AVPixelFormat overlay_pix_fmts_yuv444[] = {
233 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_NONE
236 static const enum AVPixelFormat main_pix_fmts_gbrp[] = {
237 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
239 static const enum AVPixelFormat overlay_pix_fmts_gbrp[] = {
240 AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
243 static const enum AVPixelFormat main_pix_fmts_rgb[] = {
244 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA,
245 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA,
246 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
249 static const enum AVPixelFormat overlay_pix_fmts_rgb[] = {
250 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA,
251 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA,
255 AVFilterFormats *main_formats = NULL;
256 AVFilterFormats *overlay_formats = NULL;
260 case OVERLAY_FORMAT_YUV420:
261 if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv420)) ||
262 !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420))) {
263 ret = AVERROR(ENOMEM);
267 case OVERLAY_FORMAT_YUV422:
268 if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv422)) ||
269 !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv422))) {
270 ret = AVERROR(ENOMEM);
274 case OVERLAY_FORMAT_YUV444:
275 if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv444)) ||
276 !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444))) {
277 ret = AVERROR(ENOMEM);
281 case OVERLAY_FORMAT_RGB:
282 if (!(main_formats = ff_make_format_list(main_pix_fmts_rgb)) ||
283 !(overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb))) {
284 ret = AVERROR(ENOMEM);
288 case OVERLAY_FORMAT_GBRP:
289 if (!(main_formats = ff_make_format_list(main_pix_fmts_gbrp)) ||
290 !(overlay_formats = ff_make_format_list(overlay_pix_fmts_gbrp))) {
291 ret = AVERROR(ENOMEM);
295 case OVERLAY_FORMAT_AUTO:
296 if (!(main_formats = ff_make_format_list(alpha_pix_fmts))) {
297 ret = AVERROR(ENOMEM);
305 if (s->format == OVERLAY_FORMAT_AUTO) {
306 ret = ff_set_common_formats(ctx, main_formats);
310 if ((ret = ff_formats_ref(main_formats , &ctx->inputs[MAIN]->out_formats )) < 0 ||
311 (ret = ff_formats_ref(overlay_formats, &ctx->inputs[OVERLAY]->out_formats)) < 0 ||
312 (ret = ff_formats_ref(main_formats , &ctx->outputs[MAIN]->in_formats )) < 0)
319 av_freep(&main_formats->formats);
320 av_freep(&main_formats);
322 av_freep(&overlay_formats->formats);
323 av_freep(&overlay_formats);
327 static int config_input_overlay(AVFilterLink *inlink)
329 AVFilterContext *ctx = inlink->dst;
330 OverlayContext *s = inlink->dst->priv;
332 const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
334 av_image_fill_max_pixsteps(s->overlay_pix_step, NULL, pix_desc);
336 /* Finish the configuration by evaluating the expressions
337 now when both inputs are configured. */
338 s->var_values[VAR_MAIN_W ] = s->var_values[VAR_MW] = ctx->inputs[MAIN ]->w;
339 s->var_values[VAR_MAIN_H ] = s->var_values[VAR_MH] = ctx->inputs[MAIN ]->h;
340 s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = ctx->inputs[OVERLAY]->w;
341 s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = ctx->inputs[OVERLAY]->h;
342 s->var_values[VAR_HSUB] = 1<<pix_desc->log2_chroma_w;
343 s->var_values[VAR_VSUB] = 1<<pix_desc->log2_chroma_h;
344 s->var_values[VAR_X] = NAN;
345 s->var_values[VAR_Y] = NAN;
346 s->var_values[VAR_N] = 0;
347 s->var_values[VAR_T] = NAN;
348 s->var_values[VAR_POS] = NAN;
350 if ((ret = set_expr(&s->x_pexpr, s->x_expr, "x", ctx)) < 0 ||
351 (ret = set_expr(&s->y_pexpr, s->y_expr, "y", ctx)) < 0)
354 s->overlay_is_packed_rgb =
355 ff_fill_rgba_map(s->overlay_rgba_map, inlink->format) >= 0;
356 s->overlay_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
358 if (s->eval_mode == EVAL_MODE_INIT) {
360 av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
361 s->var_values[VAR_X], s->x,
362 s->var_values[VAR_Y], s->y);
365 av_log(ctx, AV_LOG_VERBOSE,
366 "main w:%d h:%d fmt:%s overlay w:%d h:%d fmt:%s\n",
367 ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
368 av_get_pix_fmt_name(ctx->inputs[MAIN]->format),
369 ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
370 av_get_pix_fmt_name(ctx->inputs[OVERLAY]->format));
374 static int config_output(AVFilterLink *outlink)
376 AVFilterContext *ctx = outlink->src;
377 OverlayContext *s = ctx->priv;
380 if ((ret = ff_framesync_init_dualinput(&s->fs, ctx)) < 0)
383 outlink->w = ctx->inputs[MAIN]->w;
384 outlink->h = ctx->inputs[MAIN]->h;
385 outlink->time_base = ctx->inputs[MAIN]->time_base;
387 return ff_framesync_configure(&s->fs);
390 // divide by 255 and round to nearest
391 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
392 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
394 // calculate the unpremultiplied alpha, applying the general equation:
395 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
396 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
397 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
398 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
401 * Blend image in src to destination buffer dst at position (x, y).
404 static void blend_image_packed_rgb(AVFilterContext *ctx,
405 AVFrame *dst, const AVFrame *src,
406 int main_has_alpha, int x, int y)
408 OverlayContext *s = ctx->priv;
409 int i, imax, j, jmax;
410 const int src_w = src->width;
411 const int src_h = src->height;
412 const int dst_w = dst->width;
413 const int dst_h = dst->height;
414 uint8_t alpha; ///< the amount of overlay to blend on to main
415 const int dr = s->main_rgba_map[R];
416 const int dg = s->main_rgba_map[G];
417 const int db = s->main_rgba_map[B];
418 const int da = s->main_rgba_map[A];
419 const int dstep = s->main_pix_step[0];
420 const int sr = s->overlay_rgba_map[R];
421 const int sg = s->overlay_rgba_map[G];
422 const int sb = s->overlay_rgba_map[B];
423 const int sa = s->overlay_rgba_map[A];
424 const int sstep = s->overlay_pix_step[0];
425 uint8_t *S, *sp, *d, *dp;
428 sp = src->data[0] + i * src->linesize[0];
429 dp = dst->data[0] + (y+i) * dst->linesize[0];
431 for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
434 d = dp + (x+j) * dstep;
436 for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
439 // if the main channel has an alpha channel, alpha has to be calculated
440 // to create an un-premultiplied (straight) alpha value
441 if (main_has_alpha && alpha != 0 && alpha != 255) {
442 uint8_t alpha_d = d[da];
443 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
455 // main_value = main_value * (1 - alpha) + overlay_value * alpha
456 // since alpha is in the range 0-255, the result must divided by 255
457 d[dr] = FAST_DIV255(d[dr] * (255 - alpha) + S[sr] * alpha);
458 d[dg] = FAST_DIV255(d[dg] * (255 - alpha) + S[sg] * alpha);
459 d[db] = FAST_DIV255(d[db] * (255 - alpha) + S[sb] * alpha);
461 if (main_has_alpha) {
469 // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
470 d[da] += FAST_DIV255((255 - d[da]) * S[sa]);
476 dp += dst->linesize[0];
477 sp += src->linesize[0];
481 static av_always_inline void blend_plane(AVFilterContext *ctx,
482 AVFrame *dst, const AVFrame *src,
483 int src_w, int src_h,
484 int dst_w, int dst_h,
485 int i, int hsub, int vsub,
492 int src_wp = AV_CEIL_RSHIFT(src_w, hsub);
493 int src_hp = AV_CEIL_RSHIFT(src_h, vsub);
494 int dst_wp = AV_CEIL_RSHIFT(dst_w, hsub);
495 int dst_hp = AV_CEIL_RSHIFT(dst_h, vsub);
498 uint8_t *s, *sp, *d, *dp, *dap, *a, *da, *ap;
499 int jmax, j, k, kmax;
502 sp = src->data[i] + j * src->linesize[i];
503 dp = dst->data[dst_plane]
504 + (yp+j) * dst->linesize[dst_plane]
506 ap = src->data[3] + (j<<vsub) * src->linesize[3];
507 dap = dst->data[3] + ((yp+j) << vsub) * dst->linesize[3];
509 for (jmax = FFMIN(-yp + dst_hp, src_hp); j < jmax; j++) {
511 d = dp + (xp+k) * dst_step;
514 da = dap + ((xp+k) << hsub);
516 for (kmax = FFMIN(-xp + dst_wp, src_wp); k < kmax; k++) {
517 int alpha_v, alpha_h, alpha;
519 // average alpha for color components, improve quality
520 if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
521 alpha = (a[0] + a[src->linesize[3]] +
522 a[1] + a[src->linesize[3]+1]) >> 2;
523 } else if (hsub || vsub) {
524 alpha_h = hsub && k+1 < src_wp ?
525 (a[0] + a[1]) >> 1 : a[0];
526 alpha_v = vsub && j+1 < src_hp ?
527 (a[0] + a[src->linesize[3]]) >> 1 : a[0];
528 alpha = (alpha_v + alpha_h) >> 1;
531 // if the main channel has an alpha channel, alpha has to be calculated
532 // to create an un-premultiplied (straight) alpha value
533 if (main_has_alpha && alpha != 0 && alpha != 255) {
534 // average alpha for color components, improve quality
536 if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
537 alpha_d = (da[0] + da[dst->linesize[3]] +
538 da[1] + da[dst->linesize[3]+1]) >> 2;
539 } else if (hsub || vsub) {
540 alpha_h = hsub && k+1 < src_wp ?
541 (da[0] + da[1]) >> 1 : da[0];
542 alpha_v = vsub && j+1 < src_hp ?
543 (da[0] + da[dst->linesize[3]]) >> 1 : da[0];
544 alpha_d = (alpha_v + alpha_h) >> 1;
547 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
549 *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
555 dp += dst->linesize[dst_plane];
556 sp += src->linesize[i];
557 ap += (1 << vsub) * src->linesize[3];
558 dap += (1 << vsub) * dst->linesize[3];
562 static inline void alpha_composite(const AVFrame *src, const AVFrame *dst,
563 int src_w, int src_h,
564 int dst_w, int dst_h,
567 uint8_t alpha; ///< the amount of overlay to blend on to main
568 uint8_t *s, *sa, *d, *da;
569 int i, imax, j, jmax;
572 sa = src->data[3] + i * src->linesize[3];
573 da = dst->data[3] + (y+i) * dst->linesize[3];
575 for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
580 for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
582 if (alpha != 0 && alpha != 255) {
583 uint8_t alpha_d = *d;
584 alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
593 // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
594 *d += FAST_DIV255((255 - *d) * *s);
599 da += dst->linesize[3];
600 sa += src->linesize[3];
604 static av_always_inline void blend_image_yuv(AVFilterContext *ctx,
605 AVFrame *dst, const AVFrame *src,
610 OverlayContext *s = ctx->priv;
611 const int src_w = src->width;
612 const int src_h = src->height;
613 const int dst_w = dst->width;
614 const int dst_h = dst->height;
616 blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 0, 0, 0, x, y, main_has_alpha,
617 s->main_desc->comp[0].plane, s->main_desc->comp[0].offset, s->main_desc->comp[0].step);
618 blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 1, hsub, vsub, x, y, main_has_alpha,
619 s->main_desc->comp[1].plane, s->main_desc->comp[1].offset, s->main_desc->comp[1].step);
620 blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 2, hsub, vsub, x, y, main_has_alpha,
621 s->main_desc->comp[2].plane, s->main_desc->comp[2].offset, s->main_desc->comp[2].step);
624 alpha_composite(src, dst, src_w, src_h, dst_w, dst_h, x, y);
627 static av_always_inline void blend_image_planar_rgb(AVFilterContext *ctx,
628 AVFrame *dst, const AVFrame *src,
633 OverlayContext *s = ctx->priv;
634 const int src_w = src->width;
635 const int src_h = src->height;
636 const int dst_w = dst->width;
637 const int dst_h = dst->height;
639 blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 0, 0, 0, x, y, main_has_alpha,
640 s->main_desc->comp[1].plane, s->main_desc->comp[1].offset, s->main_desc->comp[1].step);
641 blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 1, hsub, vsub, x, y, main_has_alpha,
642 s->main_desc->comp[2].plane, s->main_desc->comp[2].offset, s->main_desc->comp[2].step);
643 blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 2, hsub, vsub, x, y, main_has_alpha,
644 s->main_desc->comp[0].plane, s->main_desc->comp[0].offset, s->main_desc->comp[0].step);
647 alpha_composite(src, dst, src_w, src_h, dst_w, dst_h, x, y);
650 static void blend_image_yuv420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
652 blend_image_yuv(ctx, dst, src, 1, 1, 0, x, y);
655 static void blend_image_yuva420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
657 blend_image_yuv(ctx, dst, src, 1, 1, 1, x, y);
660 static void blend_image_yuv422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
662 blend_image_yuv(ctx, dst, src, 1, 0, 0, x, y);
665 static void blend_image_yuva422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
667 blend_image_yuv(ctx, dst, src, 1, 0, 1, x, y);
670 static void blend_image_yuv444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
672 blend_image_yuv(ctx, dst, src, 0, 0, 0, x, y);
675 static void blend_image_yuva444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
677 blend_image_yuv(ctx, dst, src, 0, 0, 1, x, y);
680 static void blend_image_gbrp(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
682 blend_image_planar_rgb(ctx, dst, src, 0, 0, 0, x, y);
685 static void blend_image_gbrap(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
687 blend_image_planar_rgb(ctx, dst, src, 0, 0, 1, x, y);
690 static void blend_image_rgb(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
692 blend_image_packed_rgb(ctx, dst, src, 0, x, y);
695 static void blend_image_rgba(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
697 blend_image_packed_rgb(ctx, dst, src, 1, x, y);
700 static int config_input_main(AVFilterLink *inlink)
702 OverlayContext *s = inlink->dst->priv;
703 const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
705 av_image_fill_max_pixsteps(s->main_pix_step, NULL, pix_desc);
707 s->hsub = pix_desc->log2_chroma_w;
708 s->vsub = pix_desc->log2_chroma_h;
710 s->main_desc = pix_desc;
712 s->main_is_packed_rgb =
713 ff_fill_rgba_map(s->main_rgba_map, inlink->format) >= 0;
714 s->main_has_alpha = ff_fmt_is_in(inlink->format, alpha_pix_fmts);
716 case OVERLAY_FORMAT_YUV420:
717 s->blend_image = s->main_has_alpha ? blend_image_yuva420 : blend_image_yuv420;
719 case OVERLAY_FORMAT_YUV422:
720 s->blend_image = s->main_has_alpha ? blend_image_yuva422 : blend_image_yuv422;
722 case OVERLAY_FORMAT_YUV444:
723 s->blend_image = s->main_has_alpha ? blend_image_yuva444 : blend_image_yuv444;
725 case OVERLAY_FORMAT_RGB:
726 s->blend_image = s->main_has_alpha ? blend_image_rgba : blend_image_rgb;
728 case OVERLAY_FORMAT_GBRP:
729 s->blend_image = s->main_has_alpha ? blend_image_gbrap : blend_image_gbrp;
731 case OVERLAY_FORMAT_AUTO:
732 switch (inlink->format) {
733 case AV_PIX_FMT_YUVA420P:
734 s->blend_image = blend_image_yuva420;
736 case AV_PIX_FMT_YUVA422P:
737 s->blend_image = blend_image_yuva422;
739 case AV_PIX_FMT_YUVA444P:
740 s->blend_image = blend_image_yuva444;
742 case AV_PIX_FMT_ARGB:
743 case AV_PIX_FMT_RGBA:
744 case AV_PIX_FMT_BGRA:
745 case AV_PIX_FMT_ABGR:
746 s->blend_image = blend_image_rgba;
748 case AV_PIX_FMT_GBRAP:
749 s->blend_image = blend_image_gbrap;
760 static int do_blend(FFFrameSync *fs)
762 AVFilterContext *ctx = fs->parent;
763 AVFrame *mainpic, *second;
764 OverlayContext *s = ctx->priv;
765 AVFilterLink *inlink = ctx->inputs[0];
768 ret = ff_framesync_dualinput_get_writable(fs, &mainpic, &second);
772 return ff_filter_frame(ctx->outputs[0], mainpic);
774 if (s->eval_mode == EVAL_MODE_FRAME) {
775 int64_t pos = mainpic->pkt_pos;
777 s->var_values[VAR_N] = inlink->frame_count_out;
778 s->var_values[VAR_T] = mainpic->pts == AV_NOPTS_VALUE ?
779 NAN : mainpic->pts * av_q2d(inlink->time_base);
780 s->var_values[VAR_POS] = pos == -1 ? NAN : pos;
782 s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = second->width;
783 s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = second->height;
784 s->var_values[VAR_MAIN_W ] = s->var_values[VAR_MW] = mainpic->width;
785 s->var_values[VAR_MAIN_H ] = s->var_values[VAR_MH] = mainpic->height;
788 av_log(ctx, AV_LOG_DEBUG, "n:%f t:%f pos:%f x:%f xi:%d y:%f yi:%d\n",
789 s->var_values[VAR_N], s->var_values[VAR_T], s->var_values[VAR_POS],
790 s->var_values[VAR_X], s->x,
791 s->var_values[VAR_Y], s->y);
794 if (s->x < mainpic->width && s->x + second->width >= 0 ||
795 s->y < mainpic->height && s->y + second->height >= 0)
796 s->blend_image(ctx, mainpic, second, s->x, s->y);
797 return ff_filter_frame(ctx->outputs[0], mainpic);
800 static av_cold int init(AVFilterContext *ctx)
802 OverlayContext *s = ctx->priv;
804 s->fs.on_event = do_blend;
808 static int activate(AVFilterContext *ctx)
810 OverlayContext *s = ctx->priv;
811 return ff_framesync_activate(&s->fs);
814 #define OFFSET(x) offsetof(OverlayContext, x)
815 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
817 static const AVOption overlay_options[] = {
818 { "x", "set the x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
819 { "y", "set the y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
820 { "eof_action", "Action to take when encountering EOF from secondary input ",
821 OFFSET(fs.opt_eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
822 EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
823 { "repeat", "Repeat the previous frame.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
824 { "endall", "End both streams.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
825 { "pass", "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS }, .flags = FLAGS, "eof_action" },
826 { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_FRAME}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
827 { "init", "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT}, .flags = FLAGS, .unit = "eval" },
828 { "frame", "eval expressions per-frame", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
829 { "shortest", "force termination when the shortest input terminates", OFFSET(fs.opt_shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
830 { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=OVERLAY_FORMAT_YUV420}, 0, OVERLAY_FORMAT_NB-1, FLAGS, "format" },
831 { "yuv420", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV420}, .flags = FLAGS, .unit = "format" },
832 { "yuv422", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV422}, .flags = FLAGS, .unit = "format" },
833 { "yuv444", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV444}, .flags = FLAGS, .unit = "format" },
834 { "rgb", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_RGB}, .flags = FLAGS, .unit = "format" },
835 { "gbrp", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_GBRP}, .flags = FLAGS, .unit = "format" },
836 { "auto", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_AUTO}, .flags = FLAGS, .unit = "format" },
837 { "repeatlast", "repeat overlay of the last overlay frame", OFFSET(fs.opt_repeatlast), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
841 FRAMESYNC_DEFINE_CLASS(overlay, OverlayContext, fs);
843 static const AVFilterPad avfilter_vf_overlay_inputs[] = {
846 .type = AVMEDIA_TYPE_VIDEO,
847 .config_props = config_input_main,
851 .type = AVMEDIA_TYPE_VIDEO,
852 .config_props = config_input_overlay,
857 static const AVFilterPad avfilter_vf_overlay_outputs[] = {
860 .type = AVMEDIA_TYPE_VIDEO,
861 .config_props = config_output,
866 AVFilter ff_vf_overlay = {
868 .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
869 .preinit = overlay_framesync_preinit,
872 .priv_size = sizeof(OverlayContext),
873 .priv_class = &overlay_class,
874 .query_formats = query_formats,
875 .activate = activate,
876 .process_command = process_command,
877 .inputs = avfilter_vf_overlay_inputs,
878 .outputs = avfilter_vf_overlay_outputs,
879 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,