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 overlaid 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 
135 
136  void (*blend_image)(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y);
138 
140 {
141  OverlayContext *s = ctx->priv;
142 
144  av_expr_free(s->x_pexpr); s->x_pexpr = NULL;
145  av_expr_free(s->y_pexpr); s->y_pexpr = NULL;
146 }
147 
148 static inline int normalize_xy(double d, int chroma_sub)
149 {
150  if (isnan(d))
151  return INT_MAX;
152  return (int)d & ~((1 << chroma_sub) - 1);
153 }
154 
156 {
157  OverlayContext *s = ctx->priv;
158 
162  s->x = normalize_xy(s->var_values[VAR_X], s->hsub);
163  s->y = normalize_xy(s->var_values[VAR_Y], s->vsub);
164 }
165 
166 static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
167 {
168  int ret;
169  AVExpr *old = NULL;
170 
171  if (*pexpr)
172  old = *pexpr;
173  ret = av_expr_parse(pexpr, expr, var_names,
174  NULL, NULL, NULL, NULL, 0, log_ctx);
175  if (ret < 0) {
176  av_log(log_ctx, AV_LOG_ERROR,
177  "Error when evaluating the expression '%s' for %s\n",
178  expr, option);
179  *pexpr = old;
180  return ret;
181  }
182 
183  av_expr_free(old);
184  return 0;
185 }
186 
187 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
188  char *res, int res_len, int flags)
189 {
190  OverlayContext *s = ctx->priv;
191  int ret;
192 
193  if (!strcmp(cmd, "x"))
194  ret = set_expr(&s->x_pexpr, args, cmd, ctx);
195  else if (!strcmp(cmd, "y"))
196  ret = set_expr(&s->y_pexpr, args, cmd, ctx);
197  else
198  ret = AVERROR(ENOSYS);
199 
200  if (ret < 0)
201  return ret;
202 
203  if (s->eval_mode == EVAL_MODE_INIT) {
204  eval_expr(ctx);
205  av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
206  s->var_values[VAR_X], s->x,
207  s->var_values[VAR_Y], s->y);
208  }
209  return ret;
210 }
211 
213 {
214  OverlayContext *s = ctx->priv;
215 
216  /* overlay formats contains alpha, for avoiding conversion with alpha information loss */
217  static const enum AVPixelFormat main_pix_fmts_yuv420[] = {
219  };
220  static const enum AVPixelFormat overlay_pix_fmts_yuv420[] = {
222  };
223 
224  static const enum AVPixelFormat main_pix_fmts_yuv422[] = {
226  };
227  static const enum AVPixelFormat overlay_pix_fmts_yuv422[] = {
229  };
230 
231  static const enum AVPixelFormat main_pix_fmts_yuv444[] = {
233  };
234  static const enum AVPixelFormat overlay_pix_fmts_yuv444[] = {
236  };
237 
238  static const enum AVPixelFormat main_pix_fmts_rgb[] = {
243  };
244  static const enum AVPixelFormat overlay_pix_fmts_rgb[] = {
248  };
249 
250  AVFilterFormats *main_formats = NULL;
251  AVFilterFormats *overlay_formats = NULL;
252  int ret;
253 
254  switch (s->format) {
256  if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv420)) ||
257  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv420))) {
258  ret = AVERROR(ENOMEM);
259  goto fail;
260  }
261  break;
263  if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv422)) ||
264  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv422))) {
265  ret = AVERROR(ENOMEM);
266  goto fail;
267  }
268  break;
270  if (!(main_formats = ff_make_format_list(main_pix_fmts_yuv444)) ||
271  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_yuv444))) {
272  ret = AVERROR(ENOMEM);
273  goto fail;
274  }
275  break;
276  case OVERLAY_FORMAT_RGB:
277  if (!(main_formats = ff_make_format_list(main_pix_fmts_rgb)) ||
278  !(overlay_formats = ff_make_format_list(overlay_pix_fmts_rgb))) {
279  ret = AVERROR(ENOMEM);
280  goto fail;
281  }
282  break;
283  default:
284  av_assert0(0);
285  }
286 
287  if ((ret = ff_formats_ref(main_formats , &ctx->inputs[MAIN]->out_formats )) < 0 ||
288  (ret = ff_formats_ref(overlay_formats, &ctx->inputs[OVERLAY]->out_formats)) < 0 ||
289  (ret = ff_formats_ref(main_formats , &ctx->outputs[MAIN]->in_formats )) < 0)
290  goto fail;
291 
292  return 0;
293 fail:
294  if (main_formats)
295  av_freep(&main_formats->formats);
296  av_freep(&main_formats);
297  if (overlay_formats)
298  av_freep(&overlay_formats->formats);
299  av_freep(&overlay_formats);
300  return ret;
301 }
302 
303 static const enum AVPixelFormat alpha_pix_fmts[] = {
307 };
308 
310 {
311  AVFilterContext *ctx = inlink->dst;
312  OverlayContext *s = inlink->dst->priv;
313  int ret;
314  const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
315 
317 
318  /* Finish the configuration by evaluating the expressions
319  now when both inputs are configured. */
320  s->var_values[VAR_MAIN_W ] = s->var_values[VAR_MW] = ctx->inputs[MAIN ]->w;
321  s->var_values[VAR_MAIN_H ] = s->var_values[VAR_MH] = ctx->inputs[MAIN ]->h;
324  s->var_values[VAR_HSUB] = 1<<pix_desc->log2_chroma_w;
325  s->var_values[VAR_VSUB] = 1<<pix_desc->log2_chroma_h;
326  s->var_values[VAR_X] = NAN;
327  s->var_values[VAR_Y] = NAN;
328  s->var_values[VAR_N] = 0;
329  s->var_values[VAR_T] = NAN;
330  s->var_values[VAR_POS] = NAN;
331 
332  if ((ret = set_expr(&s->x_pexpr, s->x_expr, "x", ctx)) < 0 ||
333  (ret = set_expr(&s->y_pexpr, s->y_expr, "y", ctx)) < 0)
334  return ret;
335 
337  ff_fill_rgba_map(s->overlay_rgba_map, inlink->format) >= 0;
339 
340  if (s->eval_mode == EVAL_MODE_INIT) {
341  eval_expr(ctx);
342  av_log(ctx, AV_LOG_VERBOSE, "x:%f xi:%d y:%f yi:%d\n",
343  s->var_values[VAR_X], s->x,
344  s->var_values[VAR_Y], s->y);
345  }
346 
347  av_log(ctx, AV_LOG_VERBOSE,
348  "main w:%d h:%d fmt:%s overlay w:%d h:%d fmt:%s eof_action:%s\n",
349  ctx->inputs[MAIN]->w, ctx->inputs[MAIN]->h,
351  ctx->inputs[OVERLAY]->w, ctx->inputs[OVERLAY]->h,
354  return 0;
355 }
356 
357 static int config_output(AVFilterLink *outlink)
358 {
359  AVFilterContext *ctx = outlink->src;
360  OverlayContext *s = ctx->priv;
361  int ret;
362 
363  if ((ret = ff_dualinput_init(ctx, &s->dinput)) < 0)
364  return ret;
365 
366  outlink->w = ctx->inputs[MAIN]->w;
367  outlink->h = ctx->inputs[MAIN]->h;
368  outlink->time_base = ctx->inputs[MAIN]->time_base;
369 
370  return 0;
371 }
372 
373 // divide by 255 and round to nearest
374 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
375 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
376 
377 // calculate the unpremultiplied alpha, applying the general equation:
378 // alpha = alpha_overlay / ( (alpha_main + alpha_overlay) - (alpha_main * alpha_overlay) )
379 // (((x) << 16) - ((x) << 9) + (x)) is a faster version of: 255 * 255 * x
380 // ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)) is a faster version of: 255 * (x + y)
381 #define UNPREMULTIPLY_ALPHA(x, y) ((((x) << 16) - ((x) << 9) + (x)) / ((((x) + (y)) << 8) - ((x) + (y)) - (y) * (x)))
382 
383 /**
384  * Blend image in src to destination buffer dst at position (x, y).
385  */
386 
388  AVFrame *dst, const AVFrame *src,
389  int x, int y)
390 {
391  OverlayContext *s = ctx->priv;
392  int i, imax, j, jmax;
393  const int src_w = src->width;
394  const int src_h = src->height;
395  const int dst_w = dst->width;
396  const int dst_h = dst->height;
397  uint8_t alpha; ///< the amount of overlay to blend on to main
398  const int dr = s->main_rgba_map[R];
399  const int dg = s->main_rgba_map[G];
400  const int db = s->main_rgba_map[B];
401  const int da = s->main_rgba_map[A];
402  const int dstep = s->main_pix_step[0];
403  const int sr = s->overlay_rgba_map[R];
404  const int sg = s->overlay_rgba_map[G];
405  const int sb = s->overlay_rgba_map[B];
406  const int sa = s->overlay_rgba_map[A];
407  const int sstep = s->overlay_pix_step[0];
408  const int main_has_alpha = s->main_has_alpha;
409  uint8_t *S, *sp, *d, *dp;
410 
411  i = FFMAX(-y, 0);
412  sp = src->data[0] + i * src->linesize[0];
413  dp = dst->data[0] + (y+i) * dst->linesize[0];
414 
415  for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
416  j = FFMAX(-x, 0);
417  S = sp + j * sstep;
418  d = dp + (x+j) * dstep;
419 
420  for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
421  alpha = S[sa];
422 
423  // if the main channel has an alpha channel, alpha has to be calculated
424  // to create an un-premultiplied (straight) alpha value
425  if (main_has_alpha && alpha != 0 && alpha != 255) {
426  uint8_t alpha_d = d[da];
427  alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
428  }
429 
430  switch (alpha) {
431  case 0:
432  break;
433  case 255:
434  d[dr] = S[sr];
435  d[dg] = S[sg];
436  d[db] = S[sb];
437  break;
438  default:
439  // main_value = main_value * (1 - alpha) + overlay_value * alpha
440  // since alpha is in the range 0-255, the result must divided by 255
441  d[dr] = FAST_DIV255(d[dr] * (255 - alpha) + S[sr] * alpha);
442  d[dg] = FAST_DIV255(d[dg] * (255 - alpha) + S[sg] * alpha);
443  d[db] = FAST_DIV255(d[db] * (255 - alpha) + S[sb] * alpha);
444  }
445  if (main_has_alpha) {
446  switch (alpha) {
447  case 0:
448  break;
449  case 255:
450  d[da] = S[sa];
451  break;
452  default:
453  // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
454  d[da] += FAST_DIV255((255 - d[da]) * S[sa]);
455  }
456  }
457  d += dstep;
458  S += sstep;
459  }
460  dp += dst->linesize[0];
461  sp += src->linesize[0];
462  }
463 }
464 
466  AVFrame *dst, const AVFrame *src,
467  int src_w, int src_h,
468  int dst_w, int dst_h,
469  int i, int hsub, int vsub,
470  int x, int y,
471  int main_has_alpha)
472 {
473  int src_wp = AV_CEIL_RSHIFT(src_w, hsub);
474  int src_hp = AV_CEIL_RSHIFT(src_h, vsub);
475  int dst_wp = AV_CEIL_RSHIFT(dst_w, hsub);
476  int dst_hp = AV_CEIL_RSHIFT(dst_h, vsub);
477  int yp = y>>vsub;
478  int xp = x>>hsub;
479  uint8_t *s, *sp, *d, *dp, *a, *ap;
480  int jmax, j, k, kmax;
481 
482  j = FFMAX(-yp, 0);
483  sp = src->data[i] + j * src->linesize[i];
484  dp = dst->data[i] + (yp+j) * dst->linesize[i];
485  ap = src->data[3] + (j<<vsub) * src->linesize[3];
486 
487  for (jmax = FFMIN(-yp + dst_hp, src_hp); j < jmax; j++) {
488  k = FFMAX(-xp, 0);
489  d = dp + xp+k;
490  s = sp + k;
491  a = ap + (k<<hsub);
492 
493  for (kmax = FFMIN(-xp + dst_wp, src_wp); k < kmax; k++) {
494  int alpha_v, alpha_h, alpha;
495 
496  // average alpha for color components, improve quality
497  if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
498  alpha = (a[0] + a[src->linesize[3]] +
499  a[1] + a[src->linesize[3]+1]) >> 2;
500  } else if (hsub || vsub) {
501  alpha_h = hsub && k+1 < src_wp ?
502  (a[0] + a[1]) >> 1 : a[0];
503  alpha_v = vsub && j+1 < src_hp ?
504  (a[0] + a[src->linesize[3]]) >> 1 : a[0];
505  alpha = (alpha_v + alpha_h) >> 1;
506  } else
507  alpha = a[0];
508  // if the main channel has an alpha channel, alpha has to be calculated
509  // to create an un-premultiplied (straight) alpha value
510  if (main_has_alpha && alpha != 0 && alpha != 255) {
511  // average alpha for color components, improve quality
512  uint8_t alpha_d;
513  if (hsub && vsub && j+1 < src_hp && k+1 < src_wp) {
514  alpha_d = (d[0] + d[src->linesize[3]] +
515  d[1] + d[src->linesize[3]+1]) >> 2;
516  } else if (hsub || vsub) {
517  alpha_h = hsub && k+1 < src_wp ?
518  (d[0] + d[1]) >> 1 : d[0];
519  alpha_v = vsub && j+1 < src_hp ?
520  (d[0] + d[src->linesize[3]]) >> 1 : d[0];
521  alpha_d = (alpha_v + alpha_h) >> 1;
522  } else
523  alpha_d = d[0];
524  alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
525  }
526  *d = FAST_DIV255(*d * (255 - alpha) + *s * alpha);
527  s++;
528  d++;
529  a += 1 << hsub;
530  }
531  dp += dst->linesize[i];
532  sp += src->linesize[i];
533  ap += (1 << vsub) * src->linesize[3];
534  }
535 }
536 
537 static inline void alpha_composite(const AVFrame *src, const AVFrame *dst,
538  int src_w, int src_h,
539  int dst_w, int dst_h,
540  int x, int y)
541 {
542  uint8_t alpha; ///< the amount of overlay to blend on to main
543  uint8_t *s, *sa, *d, *da;
544  int i, imax, j, jmax;
545 
546  i = FFMAX(-y, 0);
547  sa = src->data[3] + i * src->linesize[3];
548  da = dst->data[3] + (y+i) * dst->linesize[3];
549 
550  for (imax = FFMIN(-y + dst_h, src_h); i < imax; i++) {
551  j = FFMAX(-x, 0);
552  s = sa + j;
553  d = da + x+j;
554 
555  for (jmax = FFMIN(-x + dst_w, src_w); j < jmax; j++) {
556  alpha = *s;
557  if (alpha != 0 && alpha != 255) {
558  uint8_t alpha_d = *d;
559  alpha = UNPREMULTIPLY_ALPHA(alpha, alpha_d);
560  }
561  switch (alpha) {
562  case 0:
563  break;
564  case 255:
565  *d = *s;
566  break;
567  default:
568  // apply alpha compositing: main_alpha += (1-main_alpha) * overlay_alpha
569  *d += FAST_DIV255((255 - *d) * *s);
570  }
571  d += 1;
572  s += 1;
573  }
574  da += dst->linesize[3];
575  sa += src->linesize[3];
576  }
577 }
578 
580  AVFrame *dst, const AVFrame *src,
581  int hsub, int vsub,
582  int main_has_alpha,
583  int x, int y)
584 {
585  const int src_w = src->width;
586  const int src_h = src->height;
587  const int dst_w = dst->width;
588  const int dst_h = dst->height;
589 
590  if (main_has_alpha)
591  alpha_composite(src, dst, src_w, src_h, dst_w, dst_h, x, y);
592 
593  blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 0, 0, 0, x, y, main_has_alpha);
594  blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 1, hsub, vsub, x, y, main_has_alpha);
595  blend_plane(ctx, dst, src, src_w, src_h, dst_w, dst_h, 2, hsub, vsub, x, y, main_has_alpha);
596 }
597 
598 static void blend_image_yuv420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
599 {
600  OverlayContext *s = ctx->priv;
601 
602  blend_image_yuv(ctx, dst, src, 1, 1, s->main_has_alpha, x, y);
603 }
604 
605 static void blend_image_yuv422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
606 {
607  OverlayContext *s = ctx->priv;
608 
609  blend_image_yuv(ctx, dst, src, 1, 0, s->main_has_alpha, x, y);
610 }
611 
612 static void blend_image_yuv444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
613 {
614  OverlayContext *s = ctx->priv;
615 
616  blend_image_yuv(ctx, dst, src, 0, 0, s->main_has_alpha, x, y);
617 }
618 
619 static int config_input_main(AVFilterLink *inlink)
620 {
621  OverlayContext *s = inlink->dst->priv;
622  const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
623 
625 
626  s->hsub = pix_desc->log2_chroma_w;
627  s->vsub = pix_desc->log2_chroma_h;
628 
629  s->main_is_packed_rgb =
630  ff_fill_rgba_map(s->main_rgba_map, inlink->format) >= 0;
632  switch (s->format) {
635  break;
638  break;
641  break;
642  case OVERLAY_FORMAT_RGB:
644  break;
645  }
646  return 0;
647 }
648 
650  const AVFrame *second)
651 {
652  OverlayContext *s = ctx->priv;
653  AVFilterLink *inlink = ctx->inputs[0];
654 
655  if (s->eval_mode == EVAL_MODE_FRAME) {
656  int64_t pos = av_frame_get_pkt_pos(mainpic);
657 
658  s->var_values[VAR_N] = inlink->frame_count;
659  s->var_values[VAR_T] = mainpic->pts == AV_NOPTS_VALUE ?
660  NAN : mainpic->pts * av_q2d(inlink->time_base);
661  s->var_values[VAR_POS] = pos == -1 ? NAN : pos;
662 
663  s->var_values[VAR_OVERLAY_W] = s->var_values[VAR_OW] = second->width;
664  s->var_values[VAR_OVERLAY_H] = s->var_values[VAR_OH] = second->height;
665  s->var_values[VAR_MAIN_W ] = s->var_values[VAR_MW] = mainpic->width;
666  s->var_values[VAR_MAIN_H ] = s->var_values[VAR_MH] = mainpic->height;
667 
668  eval_expr(ctx);
669  av_log(ctx, AV_LOG_DEBUG, "n:%f t:%f pos:%f x:%f xi:%d y:%f yi:%d\n",
671  s->var_values[VAR_X], s->x,
672  s->var_values[VAR_Y], s->y);
673  }
674 
675  if (s->x < mainpic->width && s->x + second->width >= 0 ||
676  s->y < mainpic->height && s->y + second->height >= 0)
677  s->blend_image(ctx, mainpic, second, s->x, s->y);
678  return mainpic;
679 }
680 
681 static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
682 {
683  OverlayContext *s = inlink->dst->priv;
684  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));
685  return ff_dualinput_filter_frame(&s->dinput, inlink, inpicref);
686 }
687 
688 static int request_frame(AVFilterLink *outlink)
689 {
690  OverlayContext *s = outlink->src->priv;
691  return ff_dualinput_request_frame(&s->dinput, outlink);
692 }
693 
695 {
696  OverlayContext *s = ctx->priv;
697 
698  if (s->allow_packed_rgb) {
699  av_log(ctx, AV_LOG_WARNING,
700  "The rgb option is deprecated and is overriding the format option, use format instead\n");
702  }
703  if (!s->dinput.repeatlast || s->eof_action == EOF_ACTION_PASS) {
704  s->dinput.repeatlast = 0;
706  }
707  if (s->dinput.shortest || s->eof_action == EOF_ACTION_ENDALL) {
708  s->dinput.shortest = 1;
710  }
711 
712  s->dinput.process = do_blend;
713  return 0;
714 }
715 
716 #define OFFSET(x) offsetof(OverlayContext, x)
717 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
718 
719 static const AVOption overlay_options[] = {
720  { "x", "set the x expression", OFFSET(x_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
721  { "y", "set the y expression", OFFSET(y_expr), AV_OPT_TYPE_STRING, {.str = "0"}, CHAR_MIN, CHAR_MAX, FLAGS },
722  { "eof_action", "Action to take when encountering EOF from secondary input ",
723  OFFSET(eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
724  EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, "eof_action" },
725  { "repeat", "Repeat the previous frame.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, "eof_action" },
726  { "endall", "End both streams.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, "eof_action" },
727  { "pass", "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS }, .flags = FLAGS, "eof_action" },
728  { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_FRAME}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
729  { "init", "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT}, .flags = FLAGS, .unit = "eval" },
730  { "frame", "eval expressions per-frame", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
731  { "rgb", "force packed RGB in input and output (deprecated)", OFFSET(allow_packed_rgb), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
732  { "shortest", "force termination when the shortest input terminates", OFFSET(dinput.shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
733  { "format", "set output format", OFFSET(format), AV_OPT_TYPE_INT, {.i64=OVERLAY_FORMAT_YUV420}, 0, OVERLAY_FORMAT_NB-1, FLAGS, "format" },
734  { "yuv420", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV420}, .flags = FLAGS, .unit = "format" },
735  { "yuv422", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV422}, .flags = FLAGS, .unit = "format" },
736  { "yuv444", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_YUV444}, .flags = FLAGS, .unit = "format" },
737  { "rgb", "", 0, AV_OPT_TYPE_CONST, {.i64=OVERLAY_FORMAT_RGB}, .flags = FLAGS, .unit = "format" },
738  { "repeatlast", "repeat overlay of the last overlay frame", OFFSET(dinput.repeatlast), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, FLAGS },
739  { NULL }
740 };
741 
742 AVFILTER_DEFINE_CLASS(overlay);
743 
745  {
746  .name = "main",
747  .type = AVMEDIA_TYPE_VIDEO,
748  .config_props = config_input_main,
749  .filter_frame = filter_frame,
750  .needs_writable = 1,
751  },
752  {
753  .name = "overlay",
754  .type = AVMEDIA_TYPE_VIDEO,
755  .config_props = config_input_overlay,
756  .filter_frame = filter_frame,
757  },
758  { NULL }
759 };
760 
762  {
763  .name = "default",
764  .type = AVMEDIA_TYPE_VIDEO,
765  .config_props = config_output,
766  .request_frame = request_frame,
767  },
768  { NULL }
769 };
770 
772  .name = "overlay",
773  .description = NULL_IF_CONFIG_SMALL("Overlay a video source on top of the input."),
774  .init = init,
775  .uninit = uninit,
776  .priv_size = sizeof(OverlayContext),
777  .priv_class = &overlay_class,
780  .inputs = avfilter_vf_overlay_inputs,
781  .outputs = avfilter_vf_overlay_outputs,
783 };
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:768
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2263
This structure describes decoded (raw) audio or video data.
Definition: frame.h:184
AVOption.
Definition: opt.h:245
static int request_frame(AVFilterLink *outlink)
Definition: vf_overlay.c:688
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:744
static av_always_inline void blend_image_yuv(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int hsub, int vsub, int main_has_alpha, int x, int y)
Definition: vf_overlay.c:579
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:76
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:315
static void blend_image_yuv422(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
Definition: vf_overlay.c:605
#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:649
AVOptions.
static void blend_image_yuv444(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
Definition: vf_overlay.c:612
timestamp utils, mostly useful for debugging/logging purposes
static const char *const var_names[]
Definition: vf_overlay.c:43
#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:268
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:375
uint8_t overlay_rgba_map[4]
Definition: vf_overlay.c:118
static double av_q2d(AVRational a)
Convert an AVRational to a double.
Definition: rational.h:104
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:75
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:87
#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:236
#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:381
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:101
#define S(s, c, i)
static void alpha_composite(const AVFrame *src, const AVFrame *dst, int src_w, int src_h, int dst_w, int dst_h, int x, int y)
Definition: vf_overlay.c:537
#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:322
#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:309
#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:82
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:761
#define FFMIN(a, b)
Definition: common.h:96
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:74
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
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
OverlayFormat
Definition: vf_overlay.c:101
AVFormatContext * ctx
Definition: movenc.c:48
#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:694
#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:719
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
void(* blend_image)(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
Definition: vf_overlay.c:136
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_overlay.c:139
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:215
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:166
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
#define OFFSET(x)
Definition: vf_overlay.c:716
int y
position of overlaid picture
Definition: vf_overlay.c:111
int repeatlast
repeat last second frame
Definition: dualinput.h:37
static const char * format
Definition: movenc.c:47
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:144
static void blend_image_packed_rgb(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:387
uint8_t overlay_has_alpha
Definition: vf_overlay.c:119
#define FLAGS
Definition: vf_overlay.c:717
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:148
static int query_formats(AVFilterContext *ctx)
Definition: vf_overlay.c:212
#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:133
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:319
static int flags
Definition: cpu.c:47
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:198
#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:148
static int config_input_main(AVFilterLink *inlink)
Definition: vf_overlay.c:619
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:62
common internal and external API header
static void blend_image_yuv420(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int x, int y)
Definition: vf_overlay.c:598
int vsub
chroma subsampling values
Definition: vf_overlay.c:127
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:76
AVFilter ff_vf_overlay
Definition: vf_overlay.c:771
#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:357
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:307
int ff_dualinput_request_frame(FFDualInputContext *s, AVFilterLink *outlink)
Definition: dualinput.c:82
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:187
static int filter_frame(AVFilterLink *inlink, AVFrame *inpicref)
Definition: vf_overlay.c:681
int height
Definition: frame.h:236
#define MAIN
Definition: vf_overlay.c:83
#define av_freep(p)
#define av_always_inline
Definition: attributes.h:39
static void eval_expr(AVFilterContext *ctx)
Definition: vf_overlay.c:155
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:2179
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:242
static enum AVPixelFormat alpha_pix_fmts[]
Definition: vf_overlay.c:303
static av_always_inline void blend_plane(AVFilterContext *ctx, AVFrame *dst, const AVFrame *src, int src_w, int src_h, int dst_w, int dst_h, int i, int hsub, int vsub, int x, int y, int main_has_alpha)
Definition: vf_overlay.c:465
simple arithmetic expression evaluator
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58
int * formats
list of media formats
Definition: formats.h:66