lavfi/drawbox: add thickness option
[ffmpeg.git] / libavfilter / vf_drawbox.c
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
46 } DrawBoxContext;
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     { "w",           "set the box width",  OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
55     { "h",           "set the box heigth", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
56     { "color",       "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
57     { "c",           "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
58     { "thickness",   "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
59     { "t",           "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
60     {NULL},
61 };
62
63 AVFILTER_DEFINE_CLASS(drawbox);
64
65 static av_cold int init(AVFilterContext *ctx, const char *args)
66 {
67     DrawBoxContext *drawbox = ctx->priv;
68     uint8_t rgba_color[4];
69     static const char *shorthand[] = { "x", "y", "w", "h", "color", "thickness", NULL };
70     int ret;
71
72     drawbox->class = &drawbox_class;
73     av_opt_set_defaults(drawbox);
74
75     if ((ret = av_opt_set_from_string(drawbox, args, shorthand, "=", ":")) < 0)
76         return ret;
77
78     if (!strcmp(drawbox->color_str, "invert"))
79         drawbox->invert_color = 1;
80     else if (av_parse_color(rgba_color, drawbox->color_str, -1, ctx) < 0)
81         return AVERROR(EINVAL);
82
83     drawbox->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
84     drawbox->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
85     drawbox->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
86     drawbox->yuv_color[A] = rgba_color[3];
87
88     return 0;
89 }
90
91 static av_cold void uninit(AVFilterContext *ctx)
92 {
93     DrawBoxContext *drawbox = ctx->priv;
94     av_opt_free(drawbox);
95 }
96
97 static int query_formats(AVFilterContext *ctx)
98 {
99     enum AVPixelFormat pix_fmts[] = {
100         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
101         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
102         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
103         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
104         AV_PIX_FMT_NONE
105     };
106
107     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
108     return 0;
109 }
110
111 static int config_input(AVFilterLink *inlink)
112 {
113     DrawBoxContext *drawbox = inlink->dst->priv;
114     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
115
116     drawbox->hsub = desc->log2_chroma_w;
117     drawbox->vsub = desc->log2_chroma_h;
118
119     if (drawbox->w == 0) drawbox->w = inlink->w;
120     if (drawbox->h == 0) drawbox->h = inlink->h;
121
122     av_log(inlink->dst, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
123            drawbox->x, drawbox->y, drawbox->w, drawbox->h,
124            drawbox->yuv_color[Y], drawbox->yuv_color[U], drawbox->yuv_color[V], drawbox->yuv_color[A]);
125
126     return 0;
127 }
128
129 static int draw_slice(AVFilterLink *inlink, int y0, int h, int slice_dir)
130 {
131     DrawBoxContext *drawbox = inlink->dst->priv;
132     int plane, x, y, xb = drawbox->x, yb = drawbox->y;
133     unsigned char *row[4];
134     AVFilterBufferRef *picref = inlink->cur_buf;
135
136     for (y = FFMAX(yb, y0); y < y0 + h && y < yb + drawbox->h; y++) {
137         row[0] = picref->data[0] + y * picref->linesize[0];
138
139         for (plane = 1; plane < 3; plane++)
140             row[plane] = picref->data[plane] +
141                 picref->linesize[plane] * (y >> drawbox->vsub);
142
143         if (drawbox->invert_color) {
144             for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < picref->video->w; x++)
145                 if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
146                     (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness))
147                     row[0][x] = 0xff - row[0][x];
148         } else {
149             for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < picref->video->w; x++) {
150                 double alpha = (double)drawbox->yuv_color[A] / 255;
151
152                 if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
153                     (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness)) {
154                     row[0][x                 ] = (1 - alpha) * row[0][x                 ] + alpha * drawbox->yuv_color[Y];
155                     row[1][x >> drawbox->hsub] = (1 - alpha) * row[1][x >> drawbox->hsub] + alpha * drawbox->yuv_color[U];
156                     row[2][x >> drawbox->hsub] = (1 - alpha) * row[2][x >> drawbox->hsub] + alpha * drawbox->yuv_color[V];
157                 }
158             }
159         }
160     }
161
162     return ff_draw_slice(inlink->dst->outputs[0], y0, h, 1);
163 }
164
165 static const AVFilterPad avfilter_vf_drawbox_inputs[] = {
166     {
167         .name             = "default",
168         .type             = AVMEDIA_TYPE_VIDEO,
169         .config_props     = config_input,
170         .get_video_buffer = ff_null_get_video_buffer,
171         .start_frame      = ff_null_start_frame,
172         .draw_slice       = draw_slice,
173         .end_frame        = ff_null_end_frame,
174         .min_perms        = AV_PERM_WRITE | AV_PERM_READ,
175     },
176     { NULL }
177 };
178
179 static const AVFilterPad avfilter_vf_drawbox_outputs[] = {
180     {
181         .name = "default",
182         .type = AVMEDIA_TYPE_VIDEO,
183     },
184     { NULL }
185 };
186
187 AVFilter avfilter_vf_drawbox = {
188     .name      = "drawbox",
189     .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
190     .priv_size = sizeof(DrawBoxContext),
191     .init      = init,
192     .uninit    = uninit,
193
194     .query_formats   = query_formats,
195     .inputs    = avfilter_vf_drawbox_inputs,
196     .outputs   = avfilter_vf_drawbox_outputs,
197     .priv_class = &drawbox_class,
198 };