2 * Copyright (c) 2008 Affine Systems, Inc (Michael Sullivan, Bobby Impollonia)
3 * Copyright (c) 2013 Andrey Utkin <andrey.krieger.utkin gmail com>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Box and grid drawing filters. Also a nice template for a filter
25 * that needs to write in the input frame.
28 #include "libavutil/colorspace.h"
29 #include "libavutil/common.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavutil/parseutils.h"
39 static const char *const var_names[] = {
42 "in_h", "ih", ///< height of the input video
43 "in_w", "iw", ///< width of the input video
47 "h", ///< height of the rendered box
48 "w", ///< width of the rendered box
71 typedef struct DrawBoxContext {
76 unsigned char yuv_color[4];
77 int invert_color; ///< invert luma color
78 int vsub, hsub; ///< chroma subsampling
79 char *x_expr, *y_expr; ///< expression for x and y
80 char *w_expr, *h_expr; ///< expression for width and height
81 char *t_expr; ///< expression for thickness
84 static const int NUM_EXPR_EVALS = 5;
86 static av_cold int init(AVFilterContext *ctx)
88 DrawBoxContext *s = ctx->priv;
89 uint8_t rgba_color[4];
91 if (!strcmp(s->color_str, "invert"))
93 else if (av_parse_color(rgba_color, s->color_str, -1, ctx) < 0)
94 return AVERROR(EINVAL);
96 if (!s->invert_color) {
97 s->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
98 s->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
99 s->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
100 s->yuv_color[A] = rgba_color[3];
106 static int query_formats(AVFilterContext *ctx)
108 static const enum AVPixelFormat pix_fmts[] = {
109 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
110 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
111 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
112 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ440P,
115 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
117 return AVERROR(ENOMEM);
118 return ff_set_common_formats(ctx, fmts_list);
121 static int config_input(AVFilterLink *inlink)
123 AVFilterContext *ctx = inlink->dst;
124 DrawBoxContext *s = ctx->priv;
125 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
126 double var_values[VARS_NB], res;
131 s->hsub = desc->log2_chroma_w;
132 s->vsub = desc->log2_chroma_h;
134 var_values[VAR_IN_H] = var_values[VAR_IH] = inlink->h;
135 var_values[VAR_IN_W] = var_values[VAR_IW] = inlink->w;
136 var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
137 var_values[VAR_DAR] = (double)inlink->w / inlink->h * var_values[VAR_SAR];
138 var_values[VAR_HSUB] = s->hsub;
139 var_values[VAR_VSUB] = s->vsub;
140 var_values[VAR_X] = NAN;
141 var_values[VAR_Y] = NAN;
142 var_values[VAR_H] = NAN;
143 var_values[VAR_W] = NAN;
144 var_values[VAR_T] = NAN;
146 for (i = 0; i <= NUM_EXPR_EVALS; i++) {
147 /* evaluate expressions, fail on last iteration */
148 var_values[VAR_MAX] = inlink->w;
149 if ((ret = av_expr_parse_and_eval(&res, (expr = s->x_expr),
150 var_names, var_values,
151 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
153 s->x = var_values[VAR_X] = res;
155 var_values[VAR_MAX] = inlink->h;
156 if ((ret = av_expr_parse_and_eval(&res, (expr = s->y_expr),
157 var_names, var_values,
158 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
160 s->y = var_values[VAR_Y] = res;
162 var_values[VAR_MAX] = inlink->w - s->x;
163 if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
164 var_names, var_values,
165 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
167 s->w = var_values[VAR_W] = res;
169 var_values[VAR_MAX] = inlink->h - s->y;
170 if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
171 var_names, var_values,
172 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
174 s->h = var_values[VAR_H] = res;
176 var_values[VAR_MAX] = INT_MAX;
177 if ((ret = av_expr_parse_and_eval(&res, (expr = s->t_expr),
178 var_names, var_values,
179 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
181 s->thickness = var_values[VAR_T] = res;
184 /* if w or h are zero, use the input w/h */
185 s->w = (s->w > 0) ? s->w : inlink->w;
186 s->h = (s->h > 0) ? s->h : inlink->h;
188 /* sanity check width and height */
189 if (s->w < 0 || s->h < 0) {
190 av_log(ctx, AV_LOG_ERROR, "Size values less than 0 are not acceptable.\n");
191 return AVERROR(EINVAL);
194 av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
195 s->x, s->y, s->w, s->h,
196 s->yuv_color[Y], s->yuv_color[U], s->yuv_color[V], s->yuv_color[A]);
201 av_log(ctx, AV_LOG_ERROR,
202 "Error when evaluating the expression '%s'.\n",
207 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
209 DrawBoxContext *s = inlink->dst->priv;
210 int plane, x, y, xb = s->x, yb = s->y;
211 unsigned char *row[4];
213 for (y = FFMAX(yb, 0); y < frame->height && y < (yb + s->h); y++) {
214 row[0] = frame->data[0] + y * frame->linesize[0];
216 for (plane = 1; plane < 3; plane++)
217 row[plane] = frame->data[plane] +
218 frame->linesize[plane] * (y >> s->vsub);
220 if (s->invert_color) {
221 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++)
222 if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
223 (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness))
224 row[0][x] = 0xff - row[0][x];
226 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++) {
227 double alpha = (double)s->yuv_color[A] / 255;
229 if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
230 (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness)) {
231 row[0][x ] = (1 - alpha) * row[0][x ] + alpha * s->yuv_color[Y];
232 row[1][x >> s->hsub] = (1 - alpha) * row[1][x >> s->hsub] + alpha * s->yuv_color[U];
233 row[2][x >> s->hsub] = (1 - alpha) * row[2][x >> s->hsub] + alpha * s->yuv_color[V];
239 return ff_filter_frame(inlink->dst->outputs[0], frame);
242 #define OFFSET(x) offsetof(DrawBoxContext, x)
243 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
245 #if CONFIG_DRAWBOX_FILTER
247 static const AVOption drawbox_options[] = {
248 { "x", "set horizontal position of the left box edge", OFFSET(x_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
249 { "y", "set vertical position of the top box edge", OFFSET(y_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
250 { "width", "set width of the box", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
251 { "w", "set width of the box", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
252 { "height", "set height of the box", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
253 { "h", "set height of the box", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
254 { "color", "set color of the box", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
255 { "c", "set color of the box", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
256 { "thickness", "set the box thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, { .str="3" }, CHAR_MIN, CHAR_MAX, FLAGS },
257 { "t", "set the box thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, { .str="3" }, CHAR_MIN, CHAR_MAX, FLAGS },
261 AVFILTER_DEFINE_CLASS(drawbox);
263 static const AVFilterPad drawbox_inputs[] = {
266 .type = AVMEDIA_TYPE_VIDEO,
267 .config_props = config_input,
268 .filter_frame = filter_frame,
274 static const AVFilterPad drawbox_outputs[] = {
277 .type = AVMEDIA_TYPE_VIDEO,
282 AVFilter ff_vf_drawbox = {
284 .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
285 .priv_size = sizeof(DrawBoxContext),
286 .priv_class = &drawbox_class,
288 .query_formats = query_formats,
289 .inputs = drawbox_inputs,
290 .outputs = drawbox_outputs,
291 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
293 #endif /* CONFIG_DRAWBOX_FILTER */
295 #if CONFIG_DRAWGRID_FILTER
296 static av_pure av_always_inline int pixel_belongs_to_grid(DrawBoxContext *drawgrid, int x, int y)
298 // x is horizontal (width) coord,
299 // y is vertical (height) coord
303 // Abstract from the offset
307 x_modulo = x % drawgrid->w;
308 y_modulo = y % drawgrid->h;
310 // If x or y got negative, fix values to preserve logics
312 x_modulo += drawgrid->w;
314 y_modulo += drawgrid->h;
316 return x_modulo < drawgrid->thickness // Belongs to vertical line
317 || y_modulo < drawgrid->thickness; // Belongs to horizontal line
320 static int drawgrid_filter_frame(AVFilterLink *inlink, AVFrame *frame)
322 DrawBoxContext *drawgrid = inlink->dst->priv;
326 for (y = 0; y < frame->height; y++) {
327 row[0] = frame->data[0] + y * frame->linesize[0];
329 for (plane = 1; plane < 3; plane++)
330 row[plane] = frame->data[plane] +
331 frame->linesize[plane] * (y >> drawgrid->vsub);
333 if (drawgrid->invert_color) {
334 for (x = 0; x < frame->width; x++)
335 if (pixel_belongs_to_grid(drawgrid, x, y))
336 row[0][x] = 0xff - row[0][x];
338 for (x = 0; x < frame->width; x++) {
339 double alpha = (double)drawgrid->yuv_color[A] / 255;
341 if (pixel_belongs_to_grid(drawgrid, x, y)) {
342 row[0][x ] = (1 - alpha) * row[0][x ] + alpha * drawgrid->yuv_color[Y];
343 row[1][x >> drawgrid->hsub] = (1 - alpha) * row[1][x >> drawgrid->hsub] + alpha * drawgrid->yuv_color[U];
344 row[2][x >> drawgrid->hsub] = (1 - alpha) * row[2][x >> drawgrid->hsub] + alpha * drawgrid->yuv_color[V];
350 return ff_filter_frame(inlink->dst->outputs[0], frame);
353 static const AVOption drawgrid_options[] = {
354 { "x", "set horizontal offset", OFFSET(x_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
355 { "y", "set vertical offset", OFFSET(y_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
356 { "width", "set width of grid cell", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
357 { "w", "set width of grid cell", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
358 { "height", "set height of grid cell", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
359 { "h", "set height of grid cell", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
360 { "color", "set color of the grid", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
361 { "c", "set color of the grid", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
362 { "thickness", "set grid line thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX, FLAGS },
363 { "t", "set grid line thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX, FLAGS },
367 AVFILTER_DEFINE_CLASS(drawgrid);
369 static const AVFilterPad drawgrid_inputs[] = {
372 .type = AVMEDIA_TYPE_VIDEO,
373 .config_props = config_input,
374 .filter_frame = drawgrid_filter_frame,
380 static const AVFilterPad drawgrid_outputs[] = {
383 .type = AVMEDIA_TYPE_VIDEO,
388 AVFilter ff_vf_drawgrid = {
390 .description = NULL_IF_CONFIG_SMALL("Draw a colored grid on the input video."),
391 .priv_size = sizeof(DrawBoxContext),
392 .priv_class = &drawgrid_class,
394 .query_formats = query_formats,
395 .inputs = drawgrid_inputs,
396 .outputs = drawgrid_outputs,
397 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
400 #endif /* CONFIG_DRAWGRID_FILTER */