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