FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_drawbox.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008 Affine Systems, Inc (Michael Sullivan, Bobby Impollonia)
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /**
22  * @file
23  * Box drawing filter. Also a nice template for a filter that needs to
24  * write in the input frame.
25  */
26 
27 #include "libavutil/colorspace.h"
28 #include "libavutil/common.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
31 #include "libavutil/parseutils.h"
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "internal.h"
35 #include "video.h"
36 
37 enum { Y, U, V, A };
38 
39 typedef struct {
40  const AVClass *class;
41  int x, y, w, h, thickness;
42  char *color_str;
43  unsigned char yuv_color[4];
44  int invert_color; ///< invert luma color
45  int vsub, hsub; ///< chroma subsampling
47 
48 #define OFFSET(x) offsetof(DrawBoxContext, x)
49 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
50 
51 static const AVOption drawbox_options[] = {
52  { "x", "set the box top-left corner x position", OFFSET(x), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX, FLAGS },
53  { "y", "set the box top-left corner y position", OFFSET(y), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX, FLAGS },
54  { "width", "set the box width", OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
55  { "w", "set the box width", OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
56  { "height", "set the box height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
57  { "h", "set the box height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
58  { "color", "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
59  { "c", "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
60  { "thickness", "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
61  { "t", "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
62  {NULL},
63 };
64 
65 AVFILTER_DEFINE_CLASS(drawbox);
66 
67 static av_cold int init(AVFilterContext *ctx, const char *args)
68 {
69  DrawBoxContext *drawbox = ctx->priv;
70  uint8_t rgba_color[4];
71  static const char *shorthand[] = { "x", "y", "w", "h", "color", "thickness", NULL };
72  int ret;
73 
74  drawbox->class = &drawbox_class;
75  av_opt_set_defaults(drawbox);
76 
77  if ((ret = av_opt_set_from_string(drawbox, args, shorthand, "=", ":")) < 0)
78  return ret;
79 
80  if (!strcmp(drawbox->color_str, "invert"))
81  drawbox->invert_color = 1;
82  else if (av_parse_color(rgba_color, drawbox->color_str, -1, ctx) < 0)
83  return AVERROR(EINVAL);
84 
85  if (!drawbox->invert_color) {
86  drawbox->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
87  drawbox->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
88  drawbox->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
89  drawbox->yuv_color[A] = rgba_color[3];
90  }
91 
92  return 0;
93 }
94 
95 static av_cold void uninit(AVFilterContext *ctx)
96 {
97  DrawBoxContext *drawbox = ctx->priv;
98  av_opt_free(drawbox);
99 }
100 
102 {
103  static const enum AVPixelFormat pix_fmts[] = {
109  };
110 
112  return 0;
113 }
114 
115 static int config_input(AVFilterLink *inlink)
116 {
117  DrawBoxContext *drawbox = inlink->dst->priv;
118  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
119 
120  drawbox->hsub = desc->log2_chroma_w;
121  drawbox->vsub = desc->log2_chroma_h;
122 
123  if (drawbox->w == 0) drawbox->w = inlink->w;
124  if (drawbox->h == 0) drawbox->h = inlink->h;
125 
126  av_log(inlink->dst, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
127  drawbox->x, drawbox->y, drawbox->w, drawbox->h,
128  drawbox->yuv_color[Y], drawbox->yuv_color[U], drawbox->yuv_color[V], drawbox->yuv_color[A]);
129 
130  return 0;
131 }
132 
134 {
135  DrawBoxContext *drawbox = inlink->dst->priv;
136  int plane, x, y, xb = drawbox->x, yb = drawbox->y;
137  unsigned char *row[4];
138 
139  for (y = FFMAX(yb, 0); y < frame->video->h && y < (yb + drawbox->h); y++) {
140  row[0] = frame->data[0] + y * frame->linesize[0];
141 
142  for (plane = 1; plane < 3; plane++)
143  row[plane] = frame->data[plane] +
144  frame->linesize[plane] * (y >> drawbox->vsub);
145 
146  if (drawbox->invert_color) {
147  for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < frame->video->w; x++)
148  if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
149  (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness))
150  row[0][x] = 0xff - row[0][x];
151  } else {
152  for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < frame->video->w; x++) {
153  double alpha = (double)drawbox->yuv_color[A] / 255;
154 
155  if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
156  (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness)) {
157  row[0][x ] = (1 - alpha) * row[0][x ] + alpha * drawbox->yuv_color[Y];
158  row[1][x >> drawbox->hsub] = (1 - alpha) * row[1][x >> drawbox->hsub] + alpha * drawbox->yuv_color[U];
159  row[2][x >> drawbox->hsub] = (1 - alpha) * row[2][x >> drawbox->hsub] + alpha * drawbox->yuv_color[V];
160  }
161  }
162  }
163  }
164 
165  return ff_filter_frame(inlink->dst->outputs[0], frame);
166 }
167 
169  {
170  .name = "default",
171  .type = AVMEDIA_TYPE_VIDEO,
172  .config_props = config_input,
173  .get_video_buffer = ff_null_get_video_buffer,
174  .filter_frame = filter_frame,
175  .min_perms = AV_PERM_WRITE | AV_PERM_READ,
176  },
177  { NULL }
178 };
179 
181  {
182  .name = "default",
183  .type = AVMEDIA_TYPE_VIDEO,
184  },
185  { NULL }
186 };
187 
189  .name = "drawbox",
190  .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
191  .priv_size = sizeof(DrawBoxContext),
192  .init = init,
193  .uninit = uninit,
194 
196  .inputs = avfilter_vf_drawbox_inputs,
197  .outputs = avfilter_vf_drawbox_outputs,
198  .priv_class = &drawbox_class,
199 };