FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_overlay.c
Go to the documentation of this file.
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 #include "avfilter.h"
29 #include "formats.h"
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"
38 #include "internal.h"
39 #include "dualinput.h"
40 #include "drawutils.h"
41 #include "video.h"
42 
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
48  "hsub",
49  "vsub",
50  "x",
51  "y",
52  "n", ///< number of frame
53  "pos", ///< position in the file
54  "t", ///< timestamp expressed in seconds
55  NULL
56 };
57 
58 enum var_name {
71 };
72 
73 enum EOFAction {
77 };
78 
79 static const char * const eof_action_str[] = {
80  "repeat", "endall", "pass"
81 };
82 
83 #define MAIN 0
84 #define OVERLAY 1
85 
86 #define R 0
87 #define G 1
88 #define B 2
89 #define A 3
90 
91 #define Y 0
92 #define U 1
93 #define V 2
94 
95 enum EvalMode {
99 };
100 
107 };
108 
109 typedef struct OverlayContext {
110  const AVClass *class;
111  int x, y; ///< position of overlayed picture
112 
120  int format; ///< OverlayFormat
121  int eval_mode; ///< EvalMode
122 
124 
125  int main_pix_step[4]; ///< steps per pixel for each plane of the main output
126  int overlay_pix_step[4]; ///< steps per pixel for each plane of the overlay
127  int hsub, vsub; ///< chroma subsampling values
128 
130  char *x_expr, *y_expr;
131 
132  int eof_action; ///< action to take on EOF from source
133 
136 
138 {
139  OverlayContext *s = ctx->priv;
140 
142  av_expr_free(s->x_pexpr); s->x_pexpr = NULL;
143  av_expr_free(s->y_pexpr); s->y_pexpr = NULL;
144 }
145 
146 static inline int normalize_xy(double d, int chroma_sub)
147 {
148  if (isnan(d))
149  return INT_MAX;
150  return (int)d & ~((1 << chroma_sub) - 1);
151 }
152 
154 {
155  OverlayContext *s = ctx->priv;
156 
160  s->x = normalize_xy(s->var_values[VAR_X], s->hsub);
161  s->y = normalize_xy(s->var_values[VAR_Y], s->vsub);
162 }
163 
164 static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
165 {
166  int ret;
167  AVExpr *old = NULL;
168 
169  if (*pexpr)
170  old = *pexpr;
171  ret = av_expr_parse(pexpr, expr, var_names,
172  NULL, NULL, NULL, NULL, 0, log_ctx);
173  if (ret < 0) {
174  av_log(log_ctx, AV_LOG_ERROR,
175  "Error when evaluating the expression '%s' for %s\n",
176  expr, option);
177  *pexpr = old;
178  return ret;
179  }
180 
181  av_expr_free(old);
182  return 0;
183 }
184 
185 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
186  char *res, int res_len, int flags)
187 {
188  OverlayContext *s = ctx->priv;
189  int ret;
190 
191  if (!strcmp(cmd, "x"))
192  ret = set_expr(&s->x_pexpr, args, cmd, ctx);
193  else if (!strcmp(cmd, "y"))
194  ret = set_expr(&s->y_pexpr, args, cmd, ctx);
195  else
196  ret = AVERROR(ENOSYS);
197 
198  if (ret < 0)
199  return ret;
200 
201  if (s->eval_mode == EVAL_MODE_INIT) {
202  eval_expr(ctx);
203  av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
204  s->var_values[VAR_X], s->x,
205  s->var_values[VAR_Y], s->y);
206  }
207  return ret;
208 }
209 
211 {
212  OverlayContext *s = ctx->priv;
213 
214  /* overlay formats contains alpha, for avoiding conversion with alpha information loss */
215  static const enum AVPixelFormat main_pix_fmts_yuv420[] = {
217  };
218  static const enum AVPixelFormat overlay_pix_fmts_yuv420[] = {
220  };
221 
222  static const enum AVPixelFormat main_pix_fmts_yuv422[] = {
224  };
225  static const enum AVPixelFormat overlay_pix_fmts_yuv422[] = {
227  };
228 
229  static const enum AVPixelFormat main_pix_fmts_yuv444[] = {
231  };
232  static const enum AVPixelFormat overlay_pix_fmts_yuv444[] = {
234  };
235 
236  static const enum AVPixelFormat main_pix_fmts_rgb[] = {
241  };
242  static const enum AVPixelFormat overlay_pix_fmts_rgb[] = {
246  };
247 
248  AVFilterFormats *main_formats = NULL;
249  AVFilterFormats *overlay_formats = NULL;
250  int ret;
251 
252  switch (s->format) {
254  if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv420)) ||
255  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420))) {
256  ret = AVERROR(ENOMEM);
257  goto fail;
258  }
259  break;
261  if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv422)) ||
262  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv422))) {
263  ret = AVERROR(ENOMEM);
264  goto fail;
265  }
266  break;
268  if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv444)) ||
269  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444))) {
270  ret = AVERROR(ENOMEM);
271  goto fail;
272  }
273  break;
274  case OVERLAY_FORMAT_RGB:
275  if (!(main_formats = ff_make_format_list(main_pix_fmts_rgb)) ||
276  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb))) {
277  ret = AVERROR(ENOMEM);
278  goto fail;
279  }
280  break;
281  default:
282  av_assert0(0);
283  }
284 
285  if ((ret = ff_formats_ref(main_formats , &ctx->inputs[MAIN]->out_formats )) < 0 ||
286  (ret = ff_formats_ref(overlay_formats, &ctx->inputs[OVERLAY]->out_formats)) < 0 ||
287  (ret = ff_formats_ref(main_formats , &ctx->outputs[MAIN]->in_formats )) < 0)
288  goto fail;
289 
290  return 0;
291 fail:
292  if (main_formats)
293  av_freep(&main_formats->formats);
294  av_freep(&main_formats);
295  if (overlay_formats)
296  av_freep(&overlay_formats->formats);
297  av_freep(&overlay_formats);
298  return ret;
299 }
300 
301 static const enum AVPixelFormat alpha_pix_fmts[] = {
305 };
306 
307 static int config_input_main(AVFilterLink *inlink)
308 {
309  OverlayContext *s = inlink->dst->priv;
310  const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
311 
313 
314  s->hsub = pix_desc->log2_chroma_w;
315  s->vsub = pix_desc->log2_chroma_h;
316 
317  s->main_is_packed_rgb =
318  ff_fill_rgba_map(s->main_rgba_map, inlink->format) >= 0;
320  return 0;
321 }
322 
324 {
325  AVFilterContext *ctx = inlink->dst;
326  OverlayContext *s = inlink->dst->priv;
327  int ret;
328  const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
329 
331 
332  /* Finish the configuration by evaluating the expressions
333  now when both inputs are configured. */
334  s->var_values[VAR_MAIN_W ] = s->var_values[VAR_MW] = ctx->inputs[MAIN ]->w;
335  s->var_values[VAR_MAIN_H ] = s->var_values[VAR_MH] = ctx->inputs[MAIN ]->h;
338  s->var_values[VAR_HSUB] = 1<<pix_desc->log2_chroma_w;
339  s->var_values[VAR_VSUB] = 1<<pix_desc->log2_chroma_h;
340  s->var_values[VAR_X] = NAN;
341  s->var_values[VAR_Y] = NAN;
342  s->var_values[VAR_N] = 0;
343  s->var_values[VAR_T] = NAN;
344  s->var_values[VAR_POS] = NAN;
345 
346  if ((ret = set_expr(&s->x_pexpr, s->x_expr, "x", ctx)) < 0 ||
347  (ret = set_expr(&s->y_pexpr, s->y_expr, "y", ctx)) < 0)
348  return ret;
349 
351  ff_fill_rgba_map(s->overlay_rgba_map, inlink->format) >= 0;
353 
354  if (s->eval_mode == EVAL_MODE_INIT) {
355  eval_expr(ctx);
356  av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
357  s->var_values[VAR_X], s->x,
358  s->var_values[VAR_Y], s->y);
359  }
360 
361  av_log(ctx, AV_LOG_VERBOSE,
362  "main w:%d h:%d fmt:%s overlay w:%d h:%d fmt:%s eof_action:%s\n",
363  ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
365  ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
368  return 0;
369 }
370 
371 static int config_output(AVFilterLink *outlink)
372 {
373  AVFilterContext *ctx = outlink->src;
374  OverlayContext *s = ctx->priv;
375  int ret;
376 
377  if ((ret = ff_dualinput_init(ctx, &s->dinput)) < 0)
378  return ret;
379 
380  outlink->w = ctx->inputs[MAIN]->w;
381  outlink->h = ctx->inputs[MAIN]->h;
382  outlink->time_base = ctx->inputs[MAIN]->time_base;
383 
384  return 0;
385 }
386 
387 // divide by 255 and round to nearest
388 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
389 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
390 
391 // calculate the unpremultiplied alpha, applying the general equation:
392 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
393 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
394 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
395 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
396 
397 /**
398  * Blend image in src to destination buffer dst at position (x, y).
399  */
401  AVFrame *dst, const AVFrame *src,
402  int x, int y)
403 {
404  OverlayContext *s = ctx->priv;
405  int i, imax, j, jmax, k, kmax;
406  const int src_w = src->width;
407  const int src_h = src->height;
408  const int dst_w = dst->width;
409  const int dst_h = dst->height;
410 
411  if (x >= dst_w || x+src_w < 0 ||
412  y >= dst_h || y+src_h < 0)
413  return; /* no intersection */
414 
415  if (s->main_is_packed_rgb) {
416  uint8_t alpha; ///< the amount of overlay to blend on to main
417  const int dr = s->main_rgba_map[R];
418  const int dg = s->main_rgba_map[G];
419  const int db = s->main_rgba_map[B];
420  const int da = s->main_rgba_map[A];
421  const int dstep = s->main_pix_step[0];
422  const int sr = s->overlay_rgba_map[R];
423  const int sg = s->overlay_rgba_map[G];
424  const int sb = s->overlay_rgba_map[B];
425  const int sa = s->overlay_rgba_map[A];
426  const int sstep = s->overlay_pix_step[0];
427  const int main_has_alpha = s->main_has_alpha;
428  uint8_t *s, *sp, *d, *dp;
429 
430  i = FFMAX(-y, 0);
431  sp = src->data[0] + i * src->linesize[0];
432  dp = dst->data[0] + (y+i) * dst->linesize[0];
433 
434  for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
435  j = FFMAX(-x, 0);
436  s = sp + j * sstep;
437  d = dp + (x+j) * dstep;
438 
439  for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
440  alpha = s[sa];
441 
442  // if the main channel has an alpha channel, alpha has to be calculated
443  // to create an un-premultiplied (straight) alpha value
444  if (main_has_alpha && alpha != 0 && alpha != 255) {
445  uint8_t alpha_d = d[da];
446  alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
447  }
448 
449  switch (alpha) {
450  case 0:
451  break;
452  case 255:
453  d[dr] = s[sr];
454  d[dg] = s[sg];
455  d[db] = s[sb];
456  break;
457  default:
458  // main_value = main_value * (1 - alpha) + overlay_value * alpha
459  // since alpha is in the range 0-255, the result must divided by 255
460  d[dr] = FAST_DIV255(d[dr] * (255 - alpha) + s[sr] * alpha);
461  d[dg] = FAST_DIV255(d[dg] * (255 - alpha) + s[sg] * alpha);
462  d[db] = FAST_DIV255(d[db] * (255 - alpha) + s[sb] * alpha);
463  }
464  if (main_has_alpha) {
465  switch (alpha) {
466  case 0:
467  break;
468  case 255:
469  d[da] = s[sa];
470  break;
471  default:
472  // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
473  d[da] += FAST_DIV255((255 - d[da]) * s[sa]);
474  }
475  }
476  d += dstep;
477  s += sstep;
478  }
479  dp += dst->linesize[0];
480  sp += src->linesize[0];
481  }
482  } else {
483  const int main_has_alpha = s->main_has_alpha;
484  if (main_has_alpha) {
485  uint8_t alpha; ///< the amount of overlay to blend on to main
486  uint8_t *s, *sa, *d, *da;
487 
488  i = FFMAX(-y, 0);
489  sa = src->data[3] + i * src->linesize[3];
490  da = dst->data[3] + (y+i) * dst->linesize[3];
491 
492  for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
493  j = FFMAX(-x, 0);
494  s = sa + j;
495  d = da + x+j;
496 
497  for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
498  alpha = *s;
499  if (alpha != 0 && alpha != 255) {
500  uint8_t alpha_d = *d;
501  alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
502  }
503  switch (alpha) {
504  case 0:
505  break;
506  case 255:
507  *d = *s;
508  break;
509  default:
510  // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
511  *d += FAST_DIV255((255 - *d) * *s);
512  }
513  d += 1;
514  s += 1;
515  }
516  da += dst->linesize[3];
517  sa += src->linesize[3];
518  }
519  }
520  for (i = 0; i < 3; i++) {
521  int hsub = i ? s->hsub : 0;
522  int vsub = i ? s->vsub : 0;
523  int src_wp = AV_CEIL_RSHIFT(src_w, hsub);
524  int src_hp = AV_CEIL_RSHIFT(src_h, vsub);
525  int dst_wp = AV_CEIL_RSHIFT(dst_w, hsub);
526  int dst_hp = AV_CEIL_RSHIFT(dst_h, vsub);
527  int yp = y>>vsub;
528  int xp = x>>hsub;
529  uint8_t *s, *sp, *d, *dp, *a, *ap;
530 
531  j = FFMAX(-yp, 0);
532  sp = src->data[i] + j * src->linesize[i];
533  dp = dst->data[i] + (yp+j) * dst->linesize[i];
534  ap = src->data[3] + (j<<vsub) * src->linesize[3];
535 
536  for (jmax = FFMIN(-yp + dst_hp, src_hp); j < jmax; j++) {
537  k = FFMAX(-xp, 0);
538  d = dp + xp+k;
539  s = sp + k;
540  a = ap + (k<<hsub);
541 
542  for (kmax = FFMIN(-xp + dst_wp, src_wp); k < kmax; k++) {
543  int alpha_v, alpha_h, alpha;
544 
545  // average alpha for color components, improve quality
546  if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
547  alpha = (a[0] + a[src->linesize[3]] +
548  a[1] + a[src->linesize[3]+1]) >> 2;
549  } else if (hsub || vsub) {
550  alpha_h = hsub && k+1 < src_wp ?
551  (a[0] + a[1]) >> 1 : a[0];
552  alpha_v = vsub && j+1 < src_hp ?
553  (a[0] + a[src->linesize[3]]) >> 1 : a[0];
554  alpha = (alpha_v + alpha_h) >> 1;
555  } else
556  alpha = a[0];
557  // if the main channel has an alpha channel, alpha has to be calculated
558  // to create an un-premultiplied (straight) alpha value
559  if (main_has_alpha && alpha != 0 && alpha != 255) {
560  // average alpha for color components, improve quality
561  uint8_t alpha_d;
562  if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
563  alpha_d = (d[0] + d[src->linesize[3]] +
564  d[1] + d[src->linesize[3]+1]) >> 2;
565  } else if (hsub || vsub) {
566  alpha_h = hsub && k+1 < src_wp ?
567  (d[0] + d[1]) >> 1 : d[0];
568  alpha_v = vsub && j+1 < src_hp ?
569  (d[0] + d[src->linesize[3]]) >> 1 : d[0];
570  alpha_d = (alpha_v + alpha_h) >> 1;
571  } else
572  alpha_d = d[0];
573  alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
574  }
575  *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
576  s++;
577  d++;
578  a += 1 << hsub;
579  }
580  dp += dst->linesize[i];
581  sp += src->linesize[i];
582  ap += (1 << vsub) * src->linesize[3];
583  }
584  }
585  }
586 }
587 
589  const AVFrame *second)
590 {
591  OverlayContext *s = ctx->priv;
592  AVFilterLink *inlink = ctx->inputs[0];
593 
594  if (s->eval_mode == EVAL_MODE_FRAME) {
595  int64_t pos = av_frame_get_pkt_pos(mainpic);
596 
597  s->var_values[VAR_N] = inlink->frame_count;
598  s->var_values[VAR_T] = mainpic->pts == AV_NOPTS_VALUE ?
599  NAN : mainpic->pts * av_q2d(inlink->time_base);
600  s->var_values[VAR_POS] = pos == -1 ? NAN : pos;
601 
602  s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = second->width;
603  s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = second->height;
604  s->var_values[VAR_MAIN_W ] = s->var_values[VAR_MW] = mainpic->width;
605  s->var_values[VAR_MAIN_H ] = s->var_values[VAR_MH] = mainpic->height;
606 
607  eval_expr(ctx);
608  av_log(ctx, AV_LOG_DEBUG, "n:%f t:%f pos:%f x:%f xi:%d y:%f yi:%d\n",
610  s->var_values[VAR_X], s->x,
611  s->var_values[VAR_Y], s->y);
612  }
613 
614  blend_image(ctx, mainpic, second, s->x, s->y);
615  return mainpic;
616 }
617 
618 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
619 {
620  OverlayContext *s = inlink->dst->priv;
621  av_log(inlink->dst, AV_LOG_DEBUG, "Incoming frame (time:%s) from link #%d\n", av_ts2timestr(inpicref->pts, &inlink->time_base), FF_INLINK_IDX(inlink));
622  return ff_dualinput_filter_frame(&s->dinput, inlink, inpicref);
623 }
624 
625 static int request_frame(AVFilterLink *outlink)
626 {
627  OverlayContext *s = outlink->src->priv;
628  return ff_dualinput_request_frame(&s->dinput, outlink);
629 }
630 
632 {
633  OverlayContext *s = ctx->priv;
634 
635  if (s->allow_packed_rgb) {
636  av_log(ctx, AV_LOG_WARNING,
637  "The rgb option is deprecated and is overriding the format option, use format instead\n");
639  }
640  if (!s->dinput.repeatlast || s->eof_action == EOF_ACTION_PASS) {
641  s->dinput.repeatlast = 0;
643  }
644  if (s->dinput.shortest || s->eof_action == EOF_ACTION_ENDALL) {
645  s->dinput.shortest = 1;
647  }
648 
649  s->dinput.process = do_blend;
650  return 0;
651 }
652 
653 #define OFFSET(x) offsetof(OverlayContext, x)
654 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
655 
656 static const AVOption overlay_options[] = {
657  { "x", "set the x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
658  { "y", "set the y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
659  { "eof_action", "Action to take when encountering EOF from secondary input ",
660  OFFSET(eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
661  EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
662  { "repeat", "Repeat the previous frame.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
663  { "endall", "End both streams.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
664  { "pass", "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS }, .flags = FLAGS, "eof_action" },
665  { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_FRAME}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
666  { "init", "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT}, .flags = FLAGS, .unit = "eval" },
667  { "frame", "eval expressions per-frame", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
668  { "rgb", "force packed RGB in input and output (deprecated)", OFFSET(allow_packed_rgb), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
669  { "shortest", "force termination when the shortest input terminates", OFFSET(dinput.shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
670  { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=OVERLAY_FORMAT_YUV420}, 0, OVERLAY_FORMAT_NB-1, FLAGS, "format" },
671  { "yuv420", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV420}, .flags = FLAGS, .unit = "format" },
672  { "yuv422", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV422}, .flags = FLAGS, .unit = "format" },
673  { "yuv444", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV444}, .flags = FLAGS, .unit = "format" },
674  { "rgb", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_RGB}, .flags = FLAGS, .unit = "format" },
675  { "repeatlast", "repeat overlay of the last overlay frame", OFFSET(dinput.repeatlast), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
676  { NULL }
677 };
678 
679 AVFILTER_DEFINE_CLASS(overlay);
680 
682  {
683  .name = "main",
684  .type = AVMEDIA_TYPE_VIDEO,
685  .config_props = config_input_main,
686  .filter_frame = filter_frame,
687  .needs_writable = 1,
688  },
689  {
690  .name = "overlay",
691  .type = AVMEDIA_TYPE_VIDEO,
692  .config_props = config_input_overlay,
693  .filter_frame = filter_frame,
694  },
695  { NULL }
696 };
697 
699  {
700  .name = "default",
701  .type = AVMEDIA_TYPE_VIDEO,
702  .config_props = config_output,
703  .request_frame = request_frame,
704  },
705  { NULL }
706 };
707 
709  .name = "overlay",
710  .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
711  .init = init,
712  .uninit = uninit,
713  .priv_size = sizeof(OverlayContext),
714  .priv_class = &overlay_class,
717  .inputs = avfilter_vf_overlay_inputs,
718  .outputs = avfilter_vf_overlay_outputs,
720 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2193
This structure describes decoded (raw) audio or video data.
Definition: frame.h:180
AVOption.
Definition: opt.h:245
static int request_frame(AVFilterLink *outlink)
Definition: vf_overlay.c:625
AVFormatContext * ctx
Definition: movenc-test.c:48
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:67
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
Main libavfilter public API header.
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:64
static const AVFilterPad avfilter_vf_overlay_inputs[]
Definition: vf_overlay.c:681
int av_expr_parse(AVExpr **expr, const char *s, const char *const *const_names, const char *const *func1_names, double(*const *funcs1)(void *, double), const char *const *func2_names, double(*const *funcs2)(void *, double, double), int log_offset, void *log_ctx)
Parse an expression.
Definition: eval.c:658
static const char *const eof_action_str[]
Definition: vf_overlay.c:79
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:92
int allow_packed_rgb
Definition: vf_overlay.c:113
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:283
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], const AVPixFmtDescriptor *pixdesc)
Compute the max pixel step for each plane of an image with a format described by pixdesc.
Definition: imgutils.c:34
const char * name
Pad name.
Definition: internal.h:59
int ff_dualinput_filter_frame(FFDualInputContext *s, AVFilterLink *inlink, AVFrame *in)
Definition: dualinput.c:73
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:313
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
AVFILTER_DEFINE_CLASS(overlay)
planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
Definition: pixfmt.h:102
uint8_t
#define av_cold
Definition: attributes.h:82
FFDualInputContext dinput
Definition: vf_overlay.c:123
static AVFrame * do_blend(AVFilterContext *ctx, AVFrame *mainpic, const AVFrame *second)
Definition: vf_overlay.c:588
AVOptions.
timestamp utils, mostly useful for debugging/logging purposes
static const char *const var_names[]
Definition: vf_overlay.c:43
static void blend_image(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
Blend image in src to destination buffer dst at position (x, y).
Definition: vf_overlay.c:400
#define G
Definition: vf_overlay.c:87
int shortest
terminate stream when the second input terminates
Definition: dualinput.h:36
double var_values[VAR_VARS_NB]
Definition: vf_overlay.c:129
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:264
Definition: eval.c:149
#define R
Definition: vf_overlay.c:86
packed ABGR 8:8:8:8, 32bpp, ABGRABGR...
Definition: pixfmt.h:95
#define FAST_DIV255(x)
Definition: vf_overlay.c:389
uint8_t overlay_rgba_map[4]
Definition: vf_overlay.c:118
static double av_q2d(AVRational a)
Convert rational to double.
Definition: rational.h:80
AVExpr * y_pexpr
Definition: vf_overlay.c:134
#define sp
Definition: regdef.h:63
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
void ff_dualinput_uninit(FFDualInputContext *s)
Definition: dualinput.c:84
#define OVERLAY
Definition: vf_overlay.c:84
int ff_fmt_is_in(int fmt, const int *fmts)
Tell if an integer is contained in the provided -1-terminated list of integers.
Definition: formats.c:254
#define av_log(a,...)
A filter pad used for either input or output.
Definition: internal.h:53
int eval_mode
EvalMode.
Definition: vf_overlay.c:121
int format
OverlayFormat.
Definition: vf_overlay.c:120
planar YUV 4:2:2 24bpp, (1 Cr & Cb sample per 2x1 Y & A samples)
Definition: pixfmt.h:187
static double alpha(void *priv, double x, double y)
Definition: vf_geq.c:99
int width
width and height of the video frame
Definition: frame.h:232
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define UNPREMULTIPLY_ALPHA(x, y)
Definition: vf_overlay.c:395
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:101
#define AVERROR(e)
Definition: error.h:43
uint8_t main_has_alpha
Definition: vf_overlay.c:116
#define av_ts2timestr(ts, tb)
Convenience macro, the return value should be used only directly in function arguments but never stan...
Definition: timestamp.h:76
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:96
void * priv
private data for use by the filter
Definition: avfilter.h:320
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
static int config_input_overlay(AVFilterLink *inlink)
Definition: vf_overlay.c:323
#define FFMAX(a, b)
Definition: common.h:94
packed ARGB 8:8:8:8, 32bpp, ARGBARGB...
Definition: pixfmt.h:93
#define fail()
Definition: checkasm.h:81
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:94
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:66
var_name
Definition: aeval.c:46
static const AVFilterPad avfilter_vf_overlay_outputs[]
Definition: vf_overlay.c:698
#define FFMIN(a, b)
Definition: common.h:96
uint8_t main_rgba_map[4]
Definition: vf_overlay.c:115
int ff_formats_ref(AVFilterFormats *f, AVFilterFormats **ref)
Add *ref as a new reference to formats.
Definition: formats.c:440
OverlayFormat
Definition: vf_overlay.c:101
#define B
Definition: vf_overlay.c:88
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:65
AVFrame *(* process)(AVFilterContext *ctx, AVFrame *main, const AVFrame *second)
Definition: dualinput.h:35
static const AVFilterPad outputs[]
Definition: af_afftfilt.c:386
static av_cold int init(AVFilterContext *ctx)
Definition: vf_overlay.c:631
#define src
Definition: vp9dsp.c:530
int main_pix_step[4]
steps per pixel for each plane of the main output
Definition: vf_overlay.c:125
EvalMode
Definition: af_volume.h:39
int ff_fill_rgba_map(uint8_t *rgba_map, enum AVPixelFormat pix_fmt)
Definition: drawutils.c:35
static const AVOption overlay_options[]
Definition: vf_overlay.c:656
static const AVFilterPad inputs[]
Definition: af_afftfilt.c:376
misc drawing utilities
void av_expr_free(AVExpr *e)
Free a parsed expression previously created with av_expr_parse().
Definition: eval.c:318
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_overlay.c:137
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:211
planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
Definition: pixfmt.h:188
static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
Definition: vf_overlay.c:164
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
AVExpr * x_pexpr
Definition: vf_overlay.c:134
static const char * format
Definition: movenc-test.c:47
#define OFFSET(x)
Definition: vf_overlay.c:653
int y
position of overlayed picture
Definition: vf_overlay.c:111
int repeatlast
repeat last second frame
Definition: dualinput.h:37
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:142
uint8_t overlay_has_alpha
Definition: vf_overlay.c:119
#define FLAGS
Definition: vf_overlay.c:654
option
Definition: libkvazaar.c:278
#define isnan(x)
Definition: libm.h:340
uint8_t overlay_is_packed_rgb
Definition: vf_overlay.c:117
#define A
Definition: vf_overlay.c:89
const char * name
Filter name.
Definition: avfilter.h:146
static int query_formats(AVFilterContext *ctx)
Definition: vf_overlay.c:210
#define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL
Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will have its filter_frame() c...
Definition: avfilter.h:131
int overlay_pix_step[4]
steps per pixel for each plane of the overlay
Definition: vf_overlay.c:126
int ff_dualinput_init(AVFilterContext *ctx, FFDualInputContext *s)
Definition: dualinput.c:43
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:317
static int flags
Definition: cpu.c:47
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:194
#define FF_INLINK_IDX(link)
Find the index of a link.
Definition: internal.h:353
static int normalize_xy(double d, int chroma_sub)
Definition: vf_overlay.c:146
static int config_input_main(AVFilterLink *inlink)
Definition: vf_overlay.c:307
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:62
common internal and external API header
int vsub
chroma subsampling values
Definition: vf_overlay.c:127
AVFilter ff_vf_overlay
Definition: vf_overlay.c:708
#define NAN
Definition: math.h:28
double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
Evaluate a previously parsed expression.
Definition: eval.c:713
int64_t av_frame_get_pkt_pos(const AVFrame *frame)
Double input streams helper for filters.
static int config_output(AVFilterLink *outlink)
Definition: vf_overlay.c:371
A list of supported formats for one end of a filter link.
Definition: formats.h:64
uint8_t main_is_packed_rgb
Definition: vf_overlay.c:114
An instance of a filter.
Definition: avfilter.h:305
int ff_dualinput_request_frame(FFDualInputContext *s, AVFilterLink *outlink)
Definition: dualinput.c:79
int eof_action
action to take on EOF from source
Definition: vf_overlay.c:132
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
Definition: vf_overlay.c:185
static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
Definition: vf_overlay.c:618
int height
Definition: frame.h:232
#define MAIN
Definition: vf_overlay.c:83
#define av_freep(p)
static void eval_expr(AVFilterContext *ctx)
Definition: vf_overlay.c:153
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:2109
internal API functions
EOFAction
Definition: vf_overlay.c:73
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
for(j=16;j >0;--j)
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:240
static enum AVPixelFormat alpha_pix_fmts[]
Definition: vf_overlay.c:301
simple arithmetic expression evaluator
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58
int * formats
list of media formats
Definition: formats.h:66