libavfilter/vf_drawbox.c

   1 /*
   2  * Copyright (c) 2008 Affine Systems, Inc (Michael Sullivan, Bobby Impollonia)
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; 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 DrawBoxContext {
  40     const AVClass *class;
  41     int x, y, w_opt, h_opt, w, h;
  42     char *color_str;
  43     unsigned char yuv_color[4];
  44     int vsub, hsub;   ///< chroma subsampling
  45 } DrawBoxContext;
  46
  47 static av_cold int init(AVFilterContext *ctx)
  48 {
  49     DrawBoxContext *s = ctx->priv;
  50     uint8_t rgba_color[4];
  51
  52     if (av_parse_color(rgba_color, s->color_str, -1, ctx) < 0)
  53         return AVERROR(EINVAL);
  54
  55     s->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
  56     s->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
  57     s->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
  58     s->yuv_color[A] = rgba_color[3];
  59
  60     return 0;
  61 }
  62
  63 static int query_formats(AVFilterContext *ctx)
  64 {
  65     enum AVPixelFormat pix_fmts[] = {
  66         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
  67         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
  68         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
  69         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_YUVJ440P,
  70         AV_PIX_FMT_NONE
  71     };
  72
  73     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
  74     return 0;
  75 }
  76
  77 static int config_input(AVFilterLink *inlink)
  78 {
  79     DrawBoxContext *s = inlink->dst->priv;
  80     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
  81
  82     s->hsub = desc->log2_chroma_w;
  83     s->vsub = desc->log2_chroma_h;
  84
  85     s->w = (s->w_opt > 0) ? s->w_opt : inlink->w;
  86     s->h = (s->h_opt > 0) ? s->h_opt : inlink->h;
  87
  88     av_log(inlink->dst, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
  89            s->w, s->y, s->w, s->h,
  90            s->yuv_color[Y], s->yuv_color[U], s->yuv_color[V], s->yuv_color[A]);
  91
  92     return 0;
  93 }
  94
  95 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
  96 {
  97     DrawBoxContext *s = inlink->dst->priv;
  98     int plane, x, y, xb = s->x, yb = s->y;
  99     unsigned char *row[4];
 100
 101     for (y = FFMAX(yb, 0); y < frame->height && y < (yb + s->h); y++) {
 102         row[0] = frame->data[0] + y * frame->linesize[0];
 103
 104         for (plane = 1; plane < 3; plane++)
 105             row[plane] = frame->data[plane] +
 106                  frame->linesize[plane] * (y >> s->vsub);
 107
 108         for (x = FFMAX(xb, 0); x < (xb + s->w) && x < frame->width; x++) {
 109             double alpha = (double)s->yuv_color[A] / 255;
 110
 111             if ((y - yb < 3) || (yb + s->h - y < 4) ||
 112                 (x - xb < 3) || (xb + s->w - x < 4)) {
 113                 row[0][x                 ] = (1 - alpha) * row[0][x                 ] + alpha * s->yuv_color[Y];
 114                 row[1][x >> s->hsub] = (1 - alpha) * row[1][x >> s->hsub] + alpha * s->yuv_color[U];
 115                 row[2][x >> s->hsub] = (1 - alpha) * row[2][x >> s->hsub] + alpha * s->yuv_color[V];
 116             }
 117         }
 118     }
 119
 120     return ff_filter_frame(inlink->dst->outputs[0], frame);
 121 }
 122
 123 #define OFFSET(x) offsetof(DrawBoxContext, x)
 124 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
 125 static const AVOption options[] = {
 126     { "x",      "Horizontal position of the left box edge", OFFSET(x),         AV_OPT_TYPE_INT,    { .i64 = 0 }, INT_MIN, INT_MAX, FLAGS },
 127     { "y",      "Vertical position of the top box edge",    OFFSET(y),         AV_OPT_TYPE_INT,    { .i64 = 0 }, INT_MIN, INT_MAX, FLAGS },
 128     { "width",  "Width of the box",                         OFFSET(w_opt),     AV_OPT_TYPE_INT,    { .i64 = 0 }, 0,       INT_MAX, FLAGS },
 129     { "height", "Height of the box",                        OFFSET(h_opt),     AV_OPT_TYPE_INT,    { .i64 = 0 }, 0,       INT_MAX, FLAGS },
 130     { "color",  "Color of the box",                         OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" },    .flags = FLAGS },
 131     { NULL },
 132 };
 133
 134 static const AVClass drawbox_class = {
 135     .class_name = "drawbox",
 136     .item_name  = av_default_item_name,
 137     .option     = options,
 138     .version    = LIBAVUTIL_VERSION_INT,
 139 };
 140
 141 static const AVFilterPad avfilter_vf_drawbox_inputs[] = {
 142     {
 143         .name             = "default",
 144         .type             = AVMEDIA_TYPE_VIDEO,
 145         .config_props     = config_input,
 146         .get_video_buffer = ff_null_get_video_buffer,
 147         .filter_frame     = filter_frame,
 148         .needs_writable   = 1,
 149     },
 150     { NULL }
 151 };
 152
 153 static const AVFilterPad avfilter_vf_drawbox_outputs[] = {
 154     {
 155         .name = "default",
 156         .type = AVMEDIA_TYPE_VIDEO,
 157     },
 158     { NULL }
 159 };
 160
 161 AVFilter ff_vf_drawbox = {
 162     .name      = "drawbox",
 163     .description = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
 164     .priv_size = sizeof(DrawBoxContext),
 165     .priv_class = &drawbox_class,
 166     .init      = init,
 167
 168     .query_formats   = query_formats,
 169     .inputs    = avfilter_vf_drawbox_inputs,
 170     .outputs   = avfilter_vf_drawbox_outputs,
 171 };