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
86 static const int NUM_EXPR_EVALS = 5;
88 static av_cold int init(AVFilterContext *ctx)
90 DrawBoxContext *s = ctx->priv;
91 uint8_t rgba_color[4];
93 if (!strcmp(s->color_str, "invert"))
95 else if (av_parse_color(rgba_color, s->color_str, -1, ctx) < 0)
96 return AVERROR(EINVAL);
98 if (!s->invert_color) {
99 s->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
100 s->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
101 s->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
102 s->yuv_color[A] = rgba_color[3];
108 static int query_formats(AVFilterContext *ctx)
110 static const enum AVPixelFormat pix_fmts[] = {
111 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
112 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
113 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
114 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUVJ440P,
115 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
118 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
120 return AVERROR(ENOMEM);
121 return ff_set_common_formats(ctx, fmts_list);
124 static int config_input(AVFilterLink *inlink)
126 AVFilterContext *ctx = inlink->dst;
127 DrawBoxContext *s = ctx->priv;
128 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
129 double var_values[VARS_NB], res;
134 s->hsub = desc->log2_chroma_w;
135 s->vsub = desc->log2_chroma_h;
136 s->have_alpha = desc->flags & AV_PIX_FMT_FLAG_ALPHA;
138 var_values[VAR_IN_H] = var_values[VAR_IH] = inlink->h;
139 var_values[VAR_IN_W] = var_values[VAR_IW] = inlink->w;
140 var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
141 var_values[VAR_DAR] = (double)inlink->w / inlink->h * var_values[VAR_SAR];
142 var_values[VAR_HSUB] = s->hsub;
143 var_values[VAR_VSUB] = s->vsub;
144 var_values[VAR_X] = NAN;
145 var_values[VAR_Y] = NAN;
146 var_values[VAR_H] = NAN;
147 var_values[VAR_W] = NAN;
148 var_values[VAR_T] = NAN;
150 for (i = 0; i <= NUM_EXPR_EVALS; i++) {
151 /* evaluate expressions, fail on last iteration */
152 var_values[VAR_MAX] = inlink->w;
153 if ((ret = av_expr_parse_and_eval(&res, (expr = s->x_expr),
154 var_names, var_values,
155 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
157 s->x = var_values[VAR_X] = res;
159 var_values[VAR_MAX] = inlink->h;
160 if ((ret = av_expr_parse_and_eval(&res, (expr = s->y_expr),
161 var_names, var_values,
162 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
164 s->y = var_values[VAR_Y] = res;
166 var_values[VAR_MAX] = inlink->w - s->x;
167 if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
168 var_names, var_values,
169 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
171 s->w = var_values[VAR_W] = res;
173 var_values[VAR_MAX] = inlink->h - s->y;
174 if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
175 var_names, var_values,
176 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
178 s->h = var_values[VAR_H] = res;
180 var_values[VAR_MAX] = INT_MAX;
181 if ((ret = av_expr_parse_and_eval(&res, (expr = s->t_expr),
182 var_names, var_values,
183 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
185 s->thickness = var_values[VAR_T] = res;
188 /* if w or h are zero, use the input w/h */
189 s->w = (s->w > 0) ? s->w : inlink->w;
190 s->h = (s->h > 0) ? s->h : inlink->h;
192 /* sanity check width and height */
193 if (s->w < 0 || s->h < 0) {
194 av_log(ctx, AV_LOG_ERROR, "Size values less than 0 are not acceptable.\n");
195 return AVERROR(EINVAL);
198 av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
199 s->x, s->y, s->w, s->h,
200 s->yuv_color[Y], s->yuv_color[U], s->yuv_color[V], s->yuv_color[A]);
205 av_log(ctx, AV_LOG_ERROR,
206 "Error when evaluating the expression '%s'.\n",
211 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
213 DrawBoxContext *s = inlink->dst->priv;
214 int plane, x, y, xb = s->x, yb = s->y;
215 unsigned char *row[4];
217 if (s->have_alpha && s->replace) {
218 for (y = FFMAX(yb, 0); y < frame->height && y < (yb + s->h); y++) {
219 row[0] = frame->data[0] + y * frame->linesize[0];
220 row[3] = frame->data[3] + y * frame->linesize[3];
222 for (plane = 1; plane < 3; plane++)
223 row[plane] = frame->data[plane] +
224 frame->linesize[plane] * (y >> s->vsub);
226 if (s->invert_color) {
227 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++)
228 if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
229 (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness))
230 row[0][x] = 0xff - row[0][x];
232 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++) {
233 if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
234 (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness)) {
235 row[0][x ] = s->yuv_color[Y];
236 row[1][x >> s->hsub] = s->yuv_color[U];
237 row[2][x >> s->hsub] = s->yuv_color[V];
238 row[3][x ] = s->yuv_color[A];
244 for (y = FFMAX(yb, 0); y < frame->height && y < (yb + s->h); y++) {
245 row[0] = frame->data[0] + y * frame->linesize[0];
247 for (plane = 1; plane < 3; plane++)
248 row[plane] = frame->data[plane] +
249 frame->linesize[plane] * (y >> s->vsub);
251 if (s->invert_color) {
252 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++)
253 if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
254 (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness))
255 row[0][x] = 0xff - row[0][x];
257 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++) {
258 double alpha = (double)s->yuv_color[A] / 255;
260 if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
261 (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness)) {
262 row[0][x ] = (1 - alpha) * row[0][x ] + alpha * s->yuv_color[Y];
263 row[1][x >> s->hsub] = (1 - alpha) * row[1][x >> s->hsub] + alpha * s->yuv_color[U];
264 row[2][x >> s->hsub] = (1 - alpha) * row[2][x >> s->hsub] + alpha * s->yuv_color[V];
271 return ff_filter_frame(inlink->dst->outputs[0], frame);
274 #define OFFSET(x) offsetof(DrawBoxContext, x)
275 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
277 #if CONFIG_DRAWBOX_FILTER
279 static const AVOption drawbox_options[] = {
280 { "x", "set horizontal position of the left box edge", OFFSET(x_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
281 { "y", "set vertical position of the top box edge", OFFSET(y_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
282 { "width", "set width of the box", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
283 { "w", "set width of the box", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
284 { "height", "set height of the box", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
285 { "h", "set height of the box", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
286 { "color", "set color of the box", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
287 { "c", "set color of the box", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
288 { "thickness", "set the box thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, { .str="3" }, CHAR_MIN, CHAR_MAX, FLAGS },
289 { "t", "set the box thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, { .str="3" }, CHAR_MIN, CHAR_MAX, FLAGS },
290 { "replace", "replace color & alpha", OFFSET(replace), AV_OPT_TYPE_BOOL, { .i64=0 }, 0, 1, FLAGS },
294 AVFILTER_DEFINE_CLASS(drawbox);
296 static const AVFilterPad drawbox_inputs[] = {
299 .type = AVMEDIA_TYPE_VIDEO,
300 .config_props = config_input,
301 .filter_frame = filter_frame,
307 static const AVFilterPad drawbox_outputs[] = {
310 .type = AVMEDIA_TYPE_VIDEO,
315 AVFilter ff_vf_drawbox = {
317 .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
318 .priv_size = sizeof(DrawBoxContext),
319 .priv_class = &drawbox_class,
321 .query_formats = query_formats,
322 .inputs = drawbox_inputs,
323 .outputs = drawbox_outputs,
324 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
326 #endif /* CONFIG_DRAWBOX_FILTER */
328 #if CONFIG_DRAWGRID_FILTER
329 static av_pure av_always_inline int pixel_belongs_to_grid(DrawBoxContext *drawgrid, int x, int y)
331 // x is horizontal (width) coord,
332 // y is vertical (height) coord
336 // Abstract from the offset
340 x_modulo = x % drawgrid->w;
341 y_modulo = y % drawgrid->h;
343 // If x or y got negative, fix values to preserve logics
345 x_modulo += drawgrid->w;
347 y_modulo += drawgrid->h;
349 return x_modulo < drawgrid->thickness // Belongs to vertical line
350 || y_modulo < drawgrid->thickness; // Belongs to horizontal line
353 static int drawgrid_filter_frame(AVFilterLink *inlink, AVFrame *frame)
355 DrawBoxContext *drawgrid = inlink->dst->priv;
359 if (drawgrid->have_alpha && drawgrid->replace) {
360 for (y = 0; y < frame->height; y++) {
361 row[0] = frame->data[0] + y * frame->linesize[0];
362 row[3] = frame->data[3] + y * frame->linesize[3];
364 for (plane = 1; plane < 3; plane++)
365 row[plane] = frame->data[plane] +
366 frame->linesize[plane] * (y >> drawgrid->vsub);
368 if (drawgrid->invert_color) {
369 for (x = 0; x < frame->width; x++)
370 if (pixel_belongs_to_grid(drawgrid, x, y))
371 row[0][x] = 0xff - row[0][x];
373 for (x = 0; x < frame->width; x++) {
374 if (pixel_belongs_to_grid(drawgrid, x, y)) {
375 row[0][x ] = drawgrid->yuv_color[Y];
376 row[1][x >> drawgrid->hsub] = drawgrid->yuv_color[U];
377 row[2][x >> drawgrid->hsub] = drawgrid->yuv_color[V];
378 row[3][x ] = drawgrid->yuv_color[A];
384 for (y = 0; y < frame->height; y++) {
385 row[0] = frame->data[0] + y * frame->linesize[0];
387 for (plane = 1; plane < 3; plane++)
388 row[plane] = frame->data[plane] +
389 frame->linesize[plane] * (y >> drawgrid->vsub);
391 if (drawgrid->invert_color) {
392 for (x = 0; x < frame->width; x++)
393 if (pixel_belongs_to_grid(drawgrid, x, y))
394 row[0][x] = 0xff - row[0][x];
396 for (x = 0; x < frame->width; x++) {
397 double alpha = (double)drawgrid->yuv_color[A] / 255;
399 if (pixel_belongs_to_grid(drawgrid, x, y)) {
400 row[0][x ] = (1 - alpha) * row[0][x ] + alpha * drawgrid->yuv_color[Y];
401 row[1][x >> drawgrid->hsub] = (1 - alpha) * row[1][x >> drawgrid->hsub] + alpha * drawgrid->yuv_color[U];
402 row[2][x >> drawgrid->hsub] = (1 - alpha) * row[2][x >> drawgrid->hsub] + alpha * drawgrid->yuv_color[V];
409 return ff_filter_frame(inlink->dst->outputs[0], frame);
412 static const AVOption drawgrid_options[] = {
413 { "x", "set horizontal offset", OFFSET(x_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
414 { "y", "set vertical offset", OFFSET(y_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
415 { "width", "set width of grid cell", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
416 { "w", "set width of grid cell", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
417 { "height", "set height of grid cell", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
418 { "h", "set height of grid cell", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str="0" }, CHAR_MIN, CHAR_MAX, FLAGS },
419 { "color", "set color of the grid", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
420 { "c", "set color of the grid", OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
421 { "thickness", "set grid line thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX, FLAGS },
422 { "t", "set grid line thickness", OFFSET(t_expr), AV_OPT_TYPE_STRING, {.str="1"}, CHAR_MIN, CHAR_MAX, FLAGS },
423 { "replace", "replace color & alpha", OFFSET(replace), AV_OPT_TYPE_BOOL, { .i64=0 }, 0, 1, FLAGS },
427 AVFILTER_DEFINE_CLASS(drawgrid);
429 static const AVFilterPad drawgrid_inputs[] = {
432 .type = AVMEDIA_TYPE_VIDEO,
433 .config_props = config_input,
434 .filter_frame = drawgrid_filter_frame,
440 static const AVFilterPad drawgrid_outputs[] = {
443 .type = AVMEDIA_TYPE_VIDEO,
448 AVFilter ff_vf_drawgrid = {
450 .description = NULL_IF_CONFIG_SMALL("Draw a colored grid on the input video."),
451 .priv_size = sizeof(DrawBoxContext),
452 .priv_class = &drawgrid_class,
454 .query_formats = query_formats,
455 .inputs = drawgrid_inputs,
456 .outputs = drawgrid_outputs,
457 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
460 #endif /* CONFIG_DRAWGRID_FILTER */