libavfilter/vf_drawbox.c
e40032e2
 /*
3fa77bde
  * Copyright (c) 2008 Affine Systems, Inc (Michael Sullivan, Bobby Impollonia)
0aa013fa
  * Copyright (c) 2013 Andrey Utkin <andrey.krieger.utkin gmail com>
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
0aa013fa
  * Box and grid drawing filters. Also a nice template for a filter
  * that needs to write in the input frame.
e40032e2
  */
 
 #include "libavutil/colorspace.h"
1d9c2dc8
 #include "libavutil/common.h"
2ed7e6cc
 #include "libavutil/opt.h"
84f571e3
 #include "libavutil/eval.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
 
84f571e3
 static const char *const var_names[] = {
     "dar",
     "hsub", "vsub",
     "in_h", "ih",      ///< height of the input video
     "in_w", "iw",      ///< width  of the input video
     "sar",
     "x",
     "y",
     "h",              ///< height of the rendered box
     "w",              ///< width  of the rendered box
     "t",
b3cb9bd4
     "fill",
84f571e3
     NULL
 };
 
e40032e2
 enum { Y, U, V, A };
 
84f571e3
 enum var_name {
     VAR_DAR,
     VAR_HSUB, VAR_VSUB,
     VAR_IN_H, VAR_IH,
     VAR_IN_W, VAR_IW,
     VAR_SAR,
     VAR_X,
     VAR_Y,
     VAR_H,
     VAR_W,
     VAR_T,
047fd986
     VAR_MAX,
84f571e3
     VARS_NB
 };
 
58400ac1
 typedef struct DrawBoxContext {
2ed7e6cc
     const AVClass *class;
84f571e3
     int x, y, w, h;
c7078f49
     int thickness;
2ed7e6cc
     char *color_str;
e40032e2
     unsigned char yuv_color[4];
1b3fdd97
     int invert_color; ///< invert luma color
02494787
     int vsub, hsub;   ///< chroma subsampling
84f571e3
     char *x_expr, *y_expr; ///< expression for x and y
     char *w_expr, *h_expr; ///< expression for width and height
     char *t_expr;          ///< expression for thickness
5589698e
     int have_alpha;
e40032e2
 } DrawBoxContext;
 
84f571e3
 static const int NUM_EXPR_EVALS = 5;
 
d69a4177
 static av_cold int init(AVFilterContext *ctx)
e40032e2
 {
20e2794e
     DrawBoxContext *s = ctx->priv;
e40032e2
     uint8_t rgba_color[4];
 
04dd5dde
     if (!strcmp(s->color_str, "invert"))
         s->invert_color = 1;
     else if (av_parse_color(rgba_color, s->color_str, -1, ctx) < 0)
e40032e2
         return AVERROR(EINVAL);
 
04dd5dde
     if (!s->invert_color) {
         s->yuv_color[Y] = RGB_TO_Y_CCIR(rgba_color[0], rgba_color[1], rgba_color[2]);
         s->yuv_color[U] = RGB_TO_U_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
         s->yuv_color[V] = RGB_TO_V_CCIR(rgba_color[0], rgba_color[1], rgba_color[2], 0);
         s->yuv_color[A] = rgba_color[3];
44e9d7f1
     }
e40032e2
 
     return 0;
 }
 
 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,
5589698e
         AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,
716d413c
         AV_PIX_FMT_NONE
e40032e2
     };
fd682b18
     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
     if (!fmts_list)
         return AVERROR(ENOMEM);
     return ff_set_common_formats(ctx, fmts_list);
e40032e2
 }
 
 static int config_input(AVFilterLink *inlink)
 {
84f571e3
     AVFilterContext *ctx = inlink->dst;
     DrawBoxContext *s = ctx->priv;
59ee9f78
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
84f571e3
     double var_values[VARS_NB], res;
     char *expr;
     int ret;
47da9b2c
     int i;
e40032e2
 
20e2794e
     s->hsub = desc->log2_chroma_w;
     s->vsub = desc->log2_chroma_h;
5589698e
     s->have_alpha = desc->flags & AV_PIX_FMT_FLAG_ALPHA;
e40032e2
 
84f571e3
     var_values[VAR_IN_H] = var_values[VAR_IH] = inlink->h;
     var_values[VAR_IN_W] = var_values[VAR_IW] = inlink->w;
     var_values[VAR_SAR]  = inlink->sample_aspect_ratio.num ? av_q2d(inlink->sample_aspect_ratio) : 1;
     var_values[VAR_DAR]  = (double)inlink->w / inlink->h * var_values[VAR_SAR];
     var_values[VAR_HSUB] = s->hsub;
     var_values[VAR_VSUB] = s->vsub;
     var_values[VAR_X] = NAN;
     var_values[VAR_Y] = NAN;
     var_values[VAR_H] = NAN;
     var_values[VAR_W] = NAN;
     var_values[VAR_T] = NAN;
 
47da9b2c
     for (i = 0; i <= NUM_EXPR_EVALS; i++) {
84f571e3
         /* evaluate expressions, fail on last iteration */
047fd986
         var_values[VAR_MAX] = inlink->w;
84f571e3
         if ((ret = av_expr_parse_and_eval(&res, (expr = s->x_expr),
                                           var_names, var_values,
                                           NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
             goto fail;
         s->x = var_values[VAR_X] = res;
 
047fd986
         var_values[VAR_MAX] = inlink->h;
84f571e3
         if ((ret = av_expr_parse_and_eval(&res, (expr = s->y_expr),
                                           var_names, var_values,
                                           NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
             goto fail;
         s->y = var_values[VAR_Y] = res;
 
047fd986
         var_values[VAR_MAX] = inlink->w - s->x;
84f571e3
         if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
                                           var_names, var_values,
                                           NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
             goto fail;
         s->w = var_values[VAR_W] = res;
 
047fd986
         var_values[VAR_MAX] = inlink->h - s->y;
84f571e3
         if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
                                           var_names, var_values,
                                           NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
             goto fail;
         s->h = var_values[VAR_H] = res;
 
047fd986
         var_values[VAR_MAX] = INT_MAX;
84f571e3
         if ((ret = av_expr_parse_and_eval(&res, (expr = s->t_expr),
                                           var_names, var_values,
                                           NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0 && i == NUM_EXPR_EVALS)
             goto fail;
         s->thickness = var_values[VAR_T] = res;
     }
 
     /* if w or h are zero, use the input w/h */
     s->w = (s->w > 0) ? s->w : inlink->w;
     s->h = (s->h > 0) ? s->h : inlink->h;
 
     /* sanity check width and height */
     if (s->w <  0 || s->h <  0) {
         av_log(ctx, AV_LOG_ERROR, "Size values less than 0 are not acceptable.\n");
         return AVERROR(EINVAL);
     }
e40032e2
 
84f571e3
     av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d w:%d h:%d color:0x%02X%02X%02X%02X\n",
04dd5dde
            s->x, s->y, s->w, s->h,
20e2794e
            s->yuv_color[Y], s->yuv_color[U], s->yuv_color[V], s->yuv_color[A]);
e40032e2
 
     return 0;
84f571e3
 
 fail:
73215fe3
     av_log(ctx, AV_LOG_ERROR,
84f571e3
            "Error when evaluating the expression '%s'.\n",
            expr);
     return ret;
e40032e2
 }
 
7e350379
 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
e40032e2
 {
20e2794e
     DrawBoxContext *s = inlink->dst->priv;
     int plane, x, y, xb = s->x, yb = s->y;
e40032e2
     unsigned char *row[4];
 
5589698e
     if (s->have_alpha) {
         for (y = FFMAX(yb, 0); y < frame->height && y < (yb + s->h); y++) {
             row[0] = frame->data[0] + y * frame->linesize[0];
             row[3] = frame->data[3] + y * frame->linesize[3];
 
             for (plane = 1; plane < 3; plane++)
                 row[plane] = frame->data[plane] +
                      frame->linesize[plane] * (y >> s->vsub);
 
             if (s->invert_color) {
                 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++)
                     if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
                         (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness))
                         row[0][x] = 0xff - row[0][x];
             } else {
                 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++) {
                     if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
                         (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness)) {
                         row[0][x           ] = s->yuv_color[Y];
                         row[1][x >> s->hsub] = s->yuv_color[U];
                         row[2][x >> s->hsub] = s->yuv_color[V];
                         row[3][x           ] = s->yuv_color[A];
                     }
                 }
             }
         }
     } else {
4dc58803
         for (y = FFMAX(yb, 0); y < frame->height && y < (yb + s->h); y++) {
             row[0] = frame->data[0] + y * frame->linesize[0];
 
             for (plane = 1; plane < 3; plane++)
                 row[plane] = frame->data[plane] +
                      frame->linesize[plane] * (y >> s->vsub);
 
             if (s->invert_color) {
                 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++)
                     if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
                         (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness))
                         row[0][x] = 0xff - row[0][x];
             } else {
                 for (x = FFMAX(xb, 0); x < xb + s->w && x < frame->width; x++) {
                     double alpha = (double)s->yuv_color[A] / 255;
 
                     if ((y - yb < s->thickness) || (yb + s->h - 1 - y < s->thickness) ||
                         (x - xb < s->thickness) || (xb + s->w - 1 - x < s->thickness)) {
                         row[0][x                 ] = (1 - alpha) * row[0][x                 ] + alpha * s->yuv_color[Y];
                         row[1][x >> s->hsub] = (1 - alpha) * row[1][x >> s->hsub] + alpha * s->yuv_color[U];
                         row[2][x >> s->hsub] = (1 - alpha) * row[2][x >> s->hsub] + alpha * s->yuv_color[V];
                     }
003bd88d
                 }
e40032e2
             }
         }
     }
 
a42b8991
     return ff_filter_frame(inlink->dst->outputs[0], frame);
e40032e2
 }
 
335c3129
 #define OFFSET(x) offsetof(DrawBoxContext, x)
0726d516
 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
 
0aa013fa
 #if CONFIG_DRAWBOX_FILTER
 
0726d516
 static const AVOption drawbox_options[] = {
84f571e3
     { "x",         "set horizontal position of the left box edge", OFFSET(x_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "y",         "set vertical position of the top box edge",    OFFSET(y_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "width",     "set width of the box",                         OFFSET(w_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "w",         "set width of the box",                         OFFSET(w_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "height",    "set height of the box",                        OFFSET(h_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "h",         "set height of the box",                        OFFSET(h_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
cb0b0266
     { "color",     "set color of the box",                         OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
     { "c",         "set color of the box",                         OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
84f571e3
     { "thickness", "set the box thickness",                        OFFSET(t_expr),    AV_OPT_TYPE_STRING, { .str="3" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "t",         "set the box thickness",                        OFFSET(t_expr),    AV_OPT_TYPE_STRING, { .str="3" },       CHAR_MIN, CHAR_MAX, FLAGS },
cb0b0266
     { NULL }
335c3129
 };
 
0726d516
 AVFILTER_DEFINE_CLASS(drawbox);
335c3129
 
0aa013fa
 static const AVFilterPad drawbox_inputs[] = {
568c70e7
     {
b211607b
         .name           = "default",
         .type           = AVMEDIA_TYPE_VIDEO,
         .config_props   = config_input,
         .filter_frame   = filter_frame,
         .needs_writable = 1,
568c70e7
     },
     { NULL }
 };
 
0aa013fa
 static const AVFilterPad drawbox_outputs[] = {
568c70e7
     {
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO,
     },
     { NULL }
 };
 
cd43ca04
 AVFilter ff_vf_drawbox = {
b211607b
     .name          = "drawbox",
     .description   = NULL_IF_CONFIG_SMALL("Draw a colored box on the input video."),
     .priv_size     = sizeof(DrawBoxContext),
     .priv_class    = &drawbox_class,
     .init          = init,
     .query_formats = query_formats,
     .inputs        = drawbox_inputs,
     .outputs       = drawbox_outputs,
     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
e40032e2
 };
0aa013fa
 #endif /* CONFIG_DRAWBOX_FILTER */
 
 #if CONFIG_DRAWGRID_FILTER
 static av_pure av_always_inline int pixel_belongs_to_grid(DrawBoxContext *drawgrid, int x, int y)
 {
     // x is horizontal (width) coord,
     // y is vertical (height) coord
     int x_modulo;
     int y_modulo;
 
     // Abstract from the offset
     x -= drawgrid->x;
     y -= drawgrid->y;
 
     x_modulo = x % drawgrid->w;
     y_modulo = y % drawgrid->h;
 
     // If x or y got negative, fix values to preserve logics
     if (x_modulo < 0)
         x_modulo += drawgrid->w;
     if (y_modulo < 0)
         y_modulo += drawgrid->h;
 
     return x_modulo < drawgrid->thickness  // Belongs to vertical line
         || y_modulo < drawgrid->thickness;  // Belongs to horizontal line
 }
 
 static int drawgrid_filter_frame(AVFilterLink *inlink, AVFrame *frame)
 {
     DrawBoxContext *drawgrid = inlink->dst->priv;
     int plane, x, y;
     uint8_t *row[4];
 
5589698e
     if (drawgrid->have_alpha) {
         for (y = 0; y < frame->height; y++) {
             row[0] = frame->data[0] + y * frame->linesize[0];
             row[3] = frame->data[3] + y * frame->linesize[3];
 
             for (plane = 1; plane < 3; plane++)
                 row[plane] = frame->data[plane] +
                      frame->linesize[plane] * (y >> drawgrid->vsub);
 
             if (drawgrid->invert_color) {
                 for (x = 0; x < frame->width; x++)
                     if (pixel_belongs_to_grid(drawgrid, x, y))
                         row[0][x] = 0xff - row[0][x];
             } else {
                 for (x = 0; x < frame->width; x++) {
                     if (pixel_belongs_to_grid(drawgrid, x, y)) {
                         row[0][x                  ] = drawgrid->yuv_color[Y];
                         row[1][x >> drawgrid->hsub] = drawgrid->yuv_color[U];
                         row[2][x >> drawgrid->hsub] = drawgrid->yuv_color[V];
                         row[3][x                  ] = drawgrid->yuv_color[A];
                     }
                 }
             }
         }
     } else {
4dc58803
         for (y = 0; y < frame->height; y++) {
             row[0] = frame->data[0] + y * frame->linesize[0];
 
             for (plane = 1; plane < 3; plane++)
                 row[plane] = frame->data[plane] +
                      frame->linesize[plane] * (y >> drawgrid->vsub);
 
             if (drawgrid->invert_color) {
                 for (x = 0; x < frame->width; x++)
                     if (pixel_belongs_to_grid(drawgrid, x, y))
                         row[0][x] = 0xff - row[0][x];
             } else {
                 for (x = 0; x < frame->width; x++) {
                     double alpha = (double)drawgrid->yuv_color[A] / 255;
 
                     if (pixel_belongs_to_grid(drawgrid, x, y)) {
                         row[0][x                  ] = (1 - alpha) * row[0][x                  ] + alpha * drawgrid->yuv_color[Y];
                         row[1][x >> drawgrid->hsub] = (1 - alpha) * row[1][x >> drawgrid->hsub] + alpha * drawgrid->yuv_color[U];
                         row[2][x >> drawgrid->hsub] = (1 - alpha) * row[2][x >> drawgrid->hsub] + alpha * drawgrid->yuv_color[V];
                     }
0aa013fa
                 }
             }
         }
     }
 
     return ff_filter_frame(inlink->dst->outputs[0], frame);
 }
 
 static const AVOption drawgrid_options[] = {
84f571e3
     { "x",         "set horizontal offset",   OFFSET(x_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "y",         "set vertical offset",     OFFSET(y_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "width",     "set width of grid cell",  OFFSET(w_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "w",         "set width of grid cell",  OFFSET(w_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "height",    "set height of grid cell", OFFSET(h_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
     { "h",         "set height of grid cell", OFFSET(h_expr),    AV_OPT_TYPE_STRING, { .str="0" },       CHAR_MIN, CHAR_MAX, FLAGS },
0aa013fa
     { "color",     "set color of the grid",   OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
     { "c",         "set color of the grid",   OFFSET(color_str), AV_OPT_TYPE_STRING, { .str = "black" }, CHAR_MIN, CHAR_MAX, FLAGS },
84f571e3
     { "thickness", "set grid line thickness", OFFSET(t_expr),    AV_OPT_TYPE_STRING, {.str="1"},         CHAR_MIN, CHAR_MAX, FLAGS },
     { "t",         "set grid line thickness", OFFSET(t_expr),    AV_OPT_TYPE_STRING, {.str="1"},         CHAR_MIN, CHAR_MAX, FLAGS },
0aa013fa
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(drawgrid);
 
 static const AVFilterPad drawgrid_inputs[] = {
     {
         .name           = "default",
         .type           = AVMEDIA_TYPE_VIDEO,
         .config_props   = config_input,
         .filter_frame   = drawgrid_filter_frame,
         .needs_writable = 1,
     },
     { NULL }
 };
 
 static const AVFilterPad drawgrid_outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO,
     },
     { NULL }
 };
 
325f6e0a
 AVFilter ff_vf_drawgrid = {
0aa013fa
     .name          = "drawgrid",
     .description   = NULL_IF_CONFIG_SMALL("Draw a colored grid on the input video."),
     .priv_size     = sizeof(DrawBoxContext),
     .priv_class    = &drawgrid_class,
     .init          = init,
     .query_formats = query_formats,
     .inputs        = drawgrid_inputs,
     .outputs       = drawgrid_outputs,
     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 };
 
 #endif  /* CONFIG_DRAWGRID_FILTER */