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