git.sesse.net Git - ffmpeg/blob - 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     { "width",       "set the box width",  OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
  55     { "w",           "set the box width",  OFFSET(w), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
  56     { "height",      "set the box height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
  57     { "h",           "set the box height", OFFSET(h), AV_OPT_TYPE_INT, {.i64=0}, 0, INT_MAX, FLAGS },
  58     { "color",       "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
  59     { "c",           "set the box edge color", OFFSET(color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX, FLAGS },
  60     { "thickness",   "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
  61     { "t",           "set the box maximum thickness", OFFSET(thickness), AV_OPT_TYPE_INT, {.i64=4}, 0, INT_MAX, FLAGS },
  62     {NULL},
  63 };
  64
  65 AVFILTER_DEFINE_CLASS(drawbox);
  66
  67 static av_cold int init(AVFilterContext *ctx, const char *args)
  68 {
  69     DrawBoxContext *drawbox = ctx->priv;
  70     uint8_t rgba_color[4];
  71
  72     if (!strcmp(drawbox->color_str, "invert"))
  73         drawbox->invert_color = 1;
  74     else if (av_parse_color(rgba_color, drawbox->color_str, -1, ctx) < 0)
  75         return AVERROR(EINVAL);
  76
  77     if (!drawbox->invert_color) {
  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
  84     return 0;
  85 }
  86
  87 static int query_formats(AVFilterContext *ctx)
  88 {
  89     static const enum AVPixelFormat pix_fmts[] = {
  90         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
  91         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
  92         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
  93         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
  94         AV_PIX_FMT_NONE
  95     };
  96
  97     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
  98     return 0;
  99 }
 100
 101 static int config_input(AVFilterLink *inlink)
 102 {
 103     DrawBoxContext *drawbox = inlink->dst->priv;
 104     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 105
 106     drawbox->hsub = desc->log2_chroma_w;
 107     drawbox->vsub = desc->log2_chroma_h;
 108
 109     if (drawbox->w == 0) drawbox->w = inlink->w;
 110     if (drawbox->h == 0) drawbox->h = inlink->h;
 111
 112     av_log(inlink->dst, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
 113            drawbox->x, drawbox->y, drawbox->w, drawbox->h,
 114            drawbox->yuv_color[Y], drawbox->yuv_color[U], drawbox->yuv_color[V], drawbox->yuv_color[A]);
 115
 116     return 0;
 117 }
 118
 119 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 120 {
 121     DrawBoxContext *drawbox = inlink->dst->priv;
 122     int plane, x, y, xb = drawbox->x, yb = drawbox->y;
 123     unsigned char *row[4];
 124
 125     for (y = FFMAX(yb, 0); y < frame->height && y < (yb + drawbox->h); y++) {
 126         row[0] = frame->data[0] + y * frame->linesize[0];
 127
 128         for (plane = 1; plane < 3; plane++)
 129             row[plane] = frame->data[plane] +
 130                  frame->linesize[plane] * (y >> drawbox->vsub);
 131
 132         if (drawbox->invert_color) {
 133             for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < frame->width; x++)
 134                 if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
 135                     (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness))
 136                     row[0][x] = 0xff - row[0][x];
 137         } else {
 138             for (x = FFMAX(xb, 0); x < xb + drawbox->w && x < frame->width; x++) {
 139                 double alpha = (double)drawbox->yuv_color[A] / 255;
 140
 141                 if ((y - yb < drawbox->thickness-1) || (yb + drawbox->h - y < drawbox->thickness) ||
 142                     (x - xb < drawbox->thickness-1) || (xb + drawbox->w - x < drawbox->thickness)) {
 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
 151     return ff_filter_frame(inlink->dst->outputs[0], frame);
 152 }
 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 static const char *const shorthand[] = { "x", "y", "w", "h", "color", "thickness", NULL };
 175
 176 AVFilter avfilter_vf_drawbox = {
 177     .name      = "drawbox",
 178     .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
 179     .priv_size = sizeof(DrawBoxContext),
 180     .init      = init,
 181
 182     .query_formats   = query_formats,
 183     .inputs    = avfilter_vf_drawbox_inputs,
 184     .outputs   = avfilter_vf_drawbox_outputs,
 185     .priv_class = &drawbox_class,
 186     .shorthand = shorthand,
 187 };