libavfilter/vf_drawbox.c
e40032e2
 /*
3fa77bde
  * Copyright (c) 2008 Affine Systems, Inc (Michael Sullivan, Bobby Impollonia)
e40032e2
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * Box drawing filter. Also a nice template for a filter that needs to
  * write in the input frame.
  */
 
 #include "libavutil/colorspace.h"
1d9c2dc8
 #include "libavutil/common.h"
2ed7e6cc
 #include "libavutil/opt.h"
e40032e2
 #include "libavutil/pixdesc.h"
7ffe76e5
 #include "libavutil/parseutils.h"
e40032e2
 #include "avfilter.h"
b74a1da4
 #include "formats.h"
9d0bfc50
 #include "internal.h"
c04c533f
 #include "video.h"
e40032e2
 
 enum { Y, U, V, A };
 
 typedef struct {
2ed7e6cc
     const AVClass *class;
93399e93
     int x, y, w, h, thickness;
2ed7e6cc
     char *color_str;
e40032e2
     unsigned char yuv_color[4];
1b3fdd97
     int invert_color; ///< invert luma color
02494787
     int vsub, hsub;   ///< chroma subsampling
e40032e2
 } DrawBoxContext;
 
2ed7e6cc
 #define OFFSET(x) offsetof(DrawBoxContext, x)
 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 
 static const AVOption drawbox_options[] = {
     { "x",           "set the box top-left corner x position", OFFSET(x), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX, FLAGS },
     { "y",           "set the box top-left corner y position", OFFSET(y), AV_OPT_TYPE_INT, {.i64=0}, INT_MIN, INT_MAX, FLAGS },
9d478f38
     { "width",       "set the box width",  OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
2ed7e6cc
     { "w",           "set the box width",  OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
9d478f38
     { "height",      "set the box height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
     { "h",           "set the box height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
2ed7e6cc
     { "color",       "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
     { "c",           "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
93399e93
     { "thickness",   "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
     { "t",           "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
2ed7e6cc
     {NULL},
 };
 
 AVFILTER_DEFINE_CLASS(drawbox);
 
a5e8c41c
 static av_cold int init(AVFilterContext *ctx, const char *args)
e40032e2
 {
2ed7e6cc
     DrawBoxContext *drawbox = ctx->priv;
e40032e2
     uint8_t rgba_color[4];
93399e93
     static const char *shorthand[] = { "x", "y", "w", "h", "color", "thickness", NULL };
2ed7e6cc
     int ret;
e40032e2
 
2ed7e6cc
     drawbox->class = &drawbox_class;
     av_opt_set_defaults(drawbox);
e40032e2
 
2ed7e6cc
     if ((ret = av_opt_set_from_string(drawbox, args, shorthand, "=", ":")) < 0)
         return ret;
e40032e2
 
1b3fdd97
     if (!strcmp(drawbox->color_str, "invert"))
         drawbox->invert_color = 1;
     else if (av_parse_color(rgba_color, drawbox->color_str, -1, ctx) < 0)
e40032e2
         return AVERROR(EINVAL);
 
44e9d7f1
     if (!drawbox->invert_color) {
         drawbox->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
         drawbox->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
         drawbox->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
         drawbox->yuv_color[A] = rgba_color[3];
     }
e40032e2
 
     return 0;
 }
 
2ed7e6cc
 static av_cold void uninit(AVFilterContext *ctx)
 {
     DrawBoxContext *drawbox = ctx->priv;
     av_opt_free(drawbox);
 }
 
e40032e2
 static int query_formats(AVFilterContext *ctx)
 {
185d1f3b
     static const enum AVPixelFormat pix_fmts[] = {
716d413c
         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
         AV_PIX_FMT_NONE
e40032e2
     };
 
b74a1da4
     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
e40032e2
     return 0;
 }
 
 static int config_input(AVFilterLink *inlink)
 {
     DrawBoxContext *drawbox = inlink->dst->priv;
59ee9f78
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
e40032e2
 
59ee9f78
     drawbox->hsub = desc->log2_chroma_w;
     drawbox->vsub = desc->log2_chroma_h;
e40032e2
 
     if (drawbox->w == 0) drawbox->w = inlink->w;
     if (drawbox->h == 0) drawbox->h = inlink->h;
 
1a49a169
     av_log(inlink->dst, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
3f80546d
            drawbox->x, drawbox->y, drawbox->w, drawbox->h,
e40032e2
            drawbox->yuv_color[Y], drawbox->yuv_color[U], drawbox->yuv_color[V], drawbox->yuv_color[A]);
 
     return 0;
 }
 
a42b8991
 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *frame)
e40032e2
 {
     DrawBoxContext *drawbox = inlink->dst->priv;
     int plane, x, y, xb = drawbox->x, yb = drawbox->y;
     unsigned char *row[4];
 
a42b8991
     for (y = FFMAX(yb, 0); y < frame->video->h && y < (yb + drawbox->h); y++) {
         row[0] = frame->data[0] + y * frame->linesize[0];
e40032e2
 
         for (plane = 1; plane < 3; plane++)
a42b8991
             row[plane] = frame->data[plane] +
                  frame->linesize[plane] * (y >> drawbox->vsub);
e40032e2
 
1b3fdd97
         if (drawbox->invert_color) {
a42b8991
             for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < frame->video->w; x++)
93399e93
                 if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
                     (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness))
1b3fdd97
                     row[0][x] = 0xff - row[0][x];
         } else {
a42b8991
             for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < frame->video->w; x++) {
003bd88d
                 double alpha = (double)drawbox->yuv_color[A] / 255;
 
93399e93
                 if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
                     (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness)) {
003bd88d
                     row[0][x                 ] = (1 - alpha) * row[0][x                 ] + alpha * drawbox->yuv_color[Y];
                     row[1][x >> drawbox->hsub] = (1 - alpha) * row[1][x >> drawbox->hsub] + alpha * drawbox->yuv_color[U];
                     row[2][x >> drawbox->hsub] = (1 - alpha) * row[2][x >> drawbox->hsub] + alpha * drawbox->yuv_color[V];
                 }
e40032e2
             }
         }
     }
 
a42b8991
     return ff_filter_frame(inlink->dst->outputs[0], frame);
e40032e2
 }
 
568c70e7
 static const AVFilterPad avfilter_vf_drawbox_inputs[] = {
     {
         .name             = "default",
         .type             = AVMEDIA_TYPE_VIDEO,
         .config_props     = config_input,
         .get_video_buffer = ff_null_get_video_buffer,
a42b8991
         .filter_frame     = filter_frame,
568c70e7
         .min_perms        = AV_PERM_WRITE | AV_PERM_READ,
     },
     { NULL }
 };
 
 static const AVFilterPad avfilter_vf_drawbox_outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO,
     },
     { NULL }
 };
 
e40032e2
 AVFilter avfilter_vf_drawbox = {
     .name      = "drawbox",
     .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
     .priv_size = sizeof(DrawBoxContext),
     .init      = init,
2ed7e6cc
     .uninit    = uninit,
e40032e2
 
     .query_formats   = query_formats,
568c70e7
     .inputs    = avfilter_vf_drawbox_inputs,
     .outputs   = avfilter_vf_drawbox_outputs,
2ed7e6cc
     .priv_class = &drawbox_class,
e40032e2
 };