git.sesse.net Git - ffmpeg/blob - libavfilter/vf_vignette.c

   1 /*
   2  * Copyright (c) 2013 Clément Bœsch
   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 #include <float.h>  /* DBL_MAX */
  22
  23 #include "libavutil/opt.h"
  24 #include "libavutil/eval.h"
  25 #include "libavutil/avassert.h"
  26 #include "libavutil/pixdesc.h"
  27 #include "avfilter.h"
  28 #include "formats.h"
  29 #include "internal.h"
  30 #include "video.h"
  31
  32 static const char *const var_names[] = {
  33     "w",    // stream width
  34     "h",    // stream height
  35     "n",    // frame count
  36     "pts",  // presentation timestamp expressed in AV_TIME_BASE units
  37     "r",    // frame rate
  38     "t",    // timestamp expressed in seconds
  39     "tb",   // timebase
  40     NULL
  41 };
  42
  43 enum var_name {
  44     VAR_W,
  45     VAR_H,
  46     VAR_N,
  47     VAR_PTS,
  48     VAR_R,
  49     VAR_T,
  50     VAR_TB,
  51     VAR_NB
  52 };
  53
  54 enum EvalMode {
  55     EVAL_MODE_INIT,
  56     EVAL_MODE_FRAME,
  57     EVAL_MODE_NB
  58 };
  59
  60 typedef struct VignetteContext {
  61     const AVClass *class;
  62     const AVPixFmtDescriptor *desc;
  63     int backward;
  64     int eval_mode;                      ///< EvalMode
  65 #define DEF_EXPR_FIELDS(name) AVExpr *name##_pexpr; char *name##_expr; double name
  66     DEF_EXPR_FIELDS(angle);
  67     DEF_EXPR_FIELDS(x0);
  68     DEF_EXPR_FIELDS(y0);
  69     double var_values[VAR_NB];
  70     float *fmap;
  71     int fmap_linesize;
  72     double dmax;
  73     float xscale, yscale;
  74     uint32_t dither;
  75     int do_dither;
  76     AVRational aspect;
  77     AVRational scale;
  78 } VignetteContext;
  79
  80 #define OFFSET(x) offsetof(VignetteContext, x)
  81 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
  82 static const AVOption vignette_options[] = {
  83     { "angle", "set lens angle", OFFSET(angle_expr), AV_OPT_TYPE_STRING, {.str="PI/5"}, .flags = FLAGS },
  84     { "a",     "set lens angle", OFFSET(angle_expr), AV_OPT_TYPE_STRING, {.str="PI/5"}, .flags = FLAGS },
  85     { "x0", "set circle center position on x-axis", OFFSET(x0_expr), AV_OPT_TYPE_STRING, {.str="w/2"}, .flags = FLAGS },
  86     { "y0", "set circle center position on y-axis", OFFSET(y0_expr), AV_OPT_TYPE_STRING, {.str="h/2"}, .flags = FLAGS },
  87     { "mode", "set forward/backward mode", OFFSET(backward), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, FLAGS, "mode" },
  88         { "forward",  NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 0}, INT_MIN, INT_MAX, FLAGS, "mode"},
  89         { "backward", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = 1}, INT_MIN, INT_MAX, FLAGS, "mode"},
  90     { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_INIT}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
  91          { "init",  "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT},  .flags = FLAGS, .unit = "eval" },
  92          { "frame", "eval expressions for each frame",             0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
  93     { "dither", "set dithering", OFFSET(do_dither), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, FLAGS },
  94     { "aspect", "set aspect ratio", OFFSET(aspect), AV_OPT_TYPE_RATIONAL, {.dbl = 1}, 0, DBL_MAX, .flags = FLAGS },
  95     { NULL }
  96 };
  97
  98 AVFILTER_DEFINE_CLASS(vignette);
  99
 100 static av_cold int init(AVFilterContext *ctx)
 101 {
 102     VignetteContext *s = ctx->priv;
 103
 104 #define PARSE_EXPR(name) do {                                               \
 105     int ret = av_expr_parse(&s->name##_pexpr,  s->name##_expr, var_names,   \
 106                             NULL, NULL, NULL, NULL, 0, ctx);                \
 107     if (ret < 0) {                                                          \
 108         av_log(ctx, AV_LOG_ERROR, "Unable to parse expression for '"        \
 109                AV_STRINGIFY(name) "'\n");                                   \
 110         return ret;                                                         \
 111     }                                                                       \
 112 } while (0)
 113
 114     PARSE_EXPR(angle);
 115     PARSE_EXPR(x0);
 116     PARSE_EXPR(y0);
 117     return 0;
 118 }
 119
 120 static av_cold void uninit(AVFilterContext *ctx)
 121 {
 122     VignetteContext *s = ctx->priv;
 123     av_freep(&s->fmap);
 124     av_expr_free(s->angle_pexpr);
 125     av_expr_free(s->x0_pexpr);
 126     av_expr_free(s->y0_pexpr);
 127 }
 128
 129 static int query_formats(AVFilterContext *ctx)
 130 {
 131     static const enum AVPixelFormat pix_fmts[] = {
 132         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P,
 133         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV411P,
 134         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
 135         AV_PIX_FMT_RGB24,   AV_PIX_FMT_BGR24,
 136         AV_PIX_FMT_GRAY8,
 137         AV_PIX_FMT_NONE
 138     };
 139     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
 140     if (!fmts_list)
 141         return AVERROR(ENOMEM);
 142     return ff_set_common_formats(ctx, fmts_list);
 143 }
 144
 145 static double get_natural_factor(const VignetteContext *s, int x, int y)
 146 {
 147     const int xx = (x - s->x0) * s->xscale;
 148     const int yy = (y - s->y0) * s->yscale;
 149     const double dnorm = hypot(xx, yy) / s->dmax;
 150     if (dnorm > 1) {
 151         return 0;
 152     } else {
 153         const double c = cos(s->angle * dnorm);
 154         return (c*c)*(c*c); // do not remove braces, it helps compilers
 155     }
 156 }
 157
 158 static void update_context(VignetteContext *s, AVFilterLink *inlink, AVFrame *frame)
 159 {
 160     int x, y;
 161     float *dst = s->fmap;
 162     int dst_linesize = s->fmap_linesize;
 163
 164     if (frame) {
 165         s->var_values[VAR_N]   = inlink->frame_count_out;
 166         s->var_values[VAR_T]   = TS2T(frame->pts, inlink->time_base);
 167         s->var_values[VAR_PTS] = TS2D(frame->pts);
 168     } else {
 169         s->var_values[VAR_N]   = NAN;
 170         s->var_values[VAR_T]   = NAN;
 171         s->var_values[VAR_PTS] = NAN;
 172     }
 173
 174     s->angle = av_expr_eval(s->angle_pexpr, s->var_values, NULL);
 175     s->x0 = av_expr_eval(s->x0_pexpr, s->var_values, NULL);
 176     s->y0 = av_expr_eval(s->y0_pexpr, s->var_values, NULL);
 177
 178     if (isnan(s->x0) || isnan(s->y0) || isnan(s->angle))
 179         s->eval_mode = EVAL_MODE_FRAME;
 180
 181     s->angle = av_clipf(s->angle, 0, M_PI_2);
 182
 183     if (s->backward) {
 184         for (y = 0; y < inlink->h; y++) {
 185             for (x = 0; x < inlink->w; x++)
 186                 dst[x] = 1. / get_natural_factor(s, x, y);
 187             dst += dst_linesize;
 188         }
 189     } else {
 190         for (y = 0; y < inlink->h; y++) {
 191             for (x = 0; x < inlink->w; x++)
 192                 dst[x] = get_natural_factor(s, x, y);
 193             dst += dst_linesize;
 194         }
 195     }
 196 }
 197
 198 static inline double get_dither_value(VignetteContext *s)
 199 {
 200     double dv = 0;
 201     if (s->do_dither) {
 202         dv = s->dither / (double)(1LL<<32);
 203         s->dither = s->dither * 1664525 + 1013904223;
 204     }
 205     return dv;
 206 }
 207
 208 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 209 {
 210     unsigned x, y, direct = 0;
 211     AVFilterContext *ctx = inlink->dst;
 212     VignetteContext *s = ctx->priv;
 213     AVFilterLink *outlink = ctx->outputs[0];
 214     AVFrame *out;
 215
 216     if (av_frame_is_writable(in)) {
 217         direct = 1;
 218         out = in;
 219     } else {
 220         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 221         if (!out) {
 222             av_frame_free(&in);
 223             return AVERROR(ENOMEM);
 224         }
 225         av_frame_copy_props(out, in);
 226     }
 227
 228     if (s->eval_mode == EVAL_MODE_FRAME)
 229         update_context(s, inlink, in);
 230
 231     if (s->desc->flags & AV_PIX_FMT_FLAG_RGB) {
 232         uint8_t       *dst = out->data[0];
 233         const uint8_t *src = in ->data[0];
 234         const float *fmap = s->fmap;
 235         const int dst_linesize = out->linesize[0];
 236         const int src_linesize = in ->linesize[0];
 237         const int fmap_linesize = s->fmap_linesize;
 238
 239         for (y = 0; y < inlink->h; y++) {
 240             uint8_t       *dstp = dst;
 241             const uint8_t *srcp = src;
 242
 243             for (x = 0; x < inlink->w; x++, dstp += 3, srcp += 3) {
 244                 const float f = fmap[x];
 245
 246                 dstp[0] = av_clip_uint8(srcp[0] * f + get_dither_value(s));
 247                 dstp[1] = av_clip_uint8(srcp[1] * f + get_dither_value(s));
 248                 dstp[2] = av_clip_uint8(srcp[2] * f + get_dither_value(s));
 249             }
 250             dst += dst_linesize;
 251             src += src_linesize;
 252             fmap += fmap_linesize;
 253         }
 254     } else {
 255         int plane;
 256
 257         for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
 258             uint8_t       *dst = out->data[plane];
 259             const uint8_t *src = in ->data[plane];
 260             const float *fmap = s->fmap;
 261             const int dst_linesize = out->linesize[plane];
 262             const int src_linesize = in ->linesize[plane];
 263             const int fmap_linesize = s->fmap_linesize;
 264             const int chroma = plane == 1 || plane == 2;
 265             const int hsub = chroma ? s->desc->log2_chroma_w : 0;
 266             const int vsub = chroma ? s->desc->log2_chroma_h : 0;
 267             const int w = AV_CEIL_RSHIFT(inlink->w, hsub);
 268             const int h = AV_CEIL_RSHIFT(inlink->h, vsub);
 269
 270             for (y = 0; y < h; y++) {
 271                 uint8_t *dstp = dst;
 272                 const uint8_t *srcp = src;
 273
 274                 for (x = 0; x < w; x++) {
 275                     const double dv = get_dither_value(s);
 276                     if (chroma) *dstp++ = av_clip_uint8(fmap[x << hsub] * (*srcp++ - 127) + 127 + dv);
 277                     else        *dstp++ = av_clip_uint8(fmap[x        ] *  *srcp++              + dv);
 278                 }
 279                 dst += dst_linesize;
 280                 src += src_linesize;
 281                 fmap += fmap_linesize << vsub;
 282             }
 283         }
 284     }
 285
 286     if (!direct)
 287         av_frame_free(&in);
 288     return ff_filter_frame(outlink, out);
 289 }
 290
 291 static int config_props(AVFilterLink *inlink)
 292 {
 293     VignetteContext *s = inlink->dst->priv;
 294     AVRational sar = inlink->sample_aspect_ratio;
 295
 296     s->desc = av_pix_fmt_desc_get(inlink->format);
 297     s->var_values[VAR_W]  = inlink->w;
 298     s->var_values[VAR_H]  = inlink->h;
 299     s->var_values[VAR_TB] = av_q2d(inlink->time_base);
 300     s->var_values[VAR_R]  = inlink->frame_rate.num == 0 || inlink->frame_rate.den == 0 ?
 301         NAN : av_q2d(inlink->frame_rate);
 302
 303     if (!sar.num || !sar.den)
 304         sar.num = sar.den = 1;
 305     if (sar.num > sar.den) {
 306         s->xscale = av_q2d(av_div_q(sar, s->aspect));
 307         s->yscale = 1;
 308     } else {
 309         s->yscale = av_q2d(av_div_q(s->aspect, sar));
 310         s->xscale = 1;
 311     }
 312     s->dmax = hypot(inlink->w / 2., inlink->h / 2.);
 313     av_log(s, AV_LOG_DEBUG, "xscale=%f yscale=%f dmax=%f\n",
 314            s->xscale, s->yscale, s->dmax);
 315
 316     s->fmap_linesize = FFALIGN(inlink->w, 32);
 317     s->fmap = av_malloc_array(s->fmap_linesize, inlink->h * sizeof(*s->fmap));
 318     if (!s->fmap)
 319         return AVERROR(ENOMEM);
 320
 321     if (s->eval_mode == EVAL_MODE_INIT)
 322         update_context(s, inlink, NULL);
 323
 324     return 0;
 325 }
 326
 327 static const AVFilterPad vignette_inputs[] = {
 328     {
 329         .name         = "default",
 330         .type         = AVMEDIA_TYPE_VIDEO,
 331         .filter_frame = filter_frame,
 332         .config_props = config_props,
 333     },
 334     { NULL }
 335 };
 336
 337 static const AVFilterPad vignette_outputs[] = {
 338     {
 339         .name = "default",
 340         .type = AVMEDIA_TYPE_VIDEO,
 341     },
 342     { NULL }
 343 };
 344
 345 const AVFilter ff_vf_vignette = {
 346     .name          = "vignette",
 347     .description   = NULL_IF_CONFIG_SMALL("Make or reverse a vignette effect."),
 348     .priv_size     = sizeof(VignetteContext),
 349     .init          = init,
 350     .uninit        = uninit,
 351     .query_formats = query_formats,
 352     .inputs        = vignette_inputs,
 353     .outputs       = vignette_outputs,
 354     .priv_class    = &vignette_class,
 355     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 356 };