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