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

   1 /*
   2  * Copyright (c) 2011 Stefano Sabatini
   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  * Compute a look-up table for binding the input value to the output
  24  * value, and apply it to input video.
  25  */
  26
  27 #include "libavutil/common.h"
  28 #include "libavutil/eval.h"
  29 #include "libavutil/opt.h"
  30 #include "libavutil/pixdesc.h"
  31 #include "avfilter.h"
  32 #include "drawutils.h"
  33 #include "formats.h"
  34 #include "internal.h"
  35 #include "video.h"
  36
  37 static const char *const var_names[] = {
  38     "w",        ///< width of the input video
  39     "h",        ///< height of the input video
  40     "val",      ///< input value for the pixel
  41     "maxval",   ///< max value for the pixel
  42     "minval",   ///< min value for the pixel
  43     "negval",   ///< negated value
  44     "clipval",
  45     NULL
  46 };
  47
  48 enum var_name {
  49     VAR_W,
  50     VAR_H,
  51     VAR_VAL,
  52     VAR_MAXVAL,
  53     VAR_MINVAL,
  54     VAR_NEGVAL,
  55     VAR_CLIPVAL,
  56     VAR_VARS_NB
  57 };
  58
  59 typedef struct {
  60     const AVClass *class;
  61     uint8_t lut[4][256];  ///< lookup table for each component
  62     char   *comp_expr_str[4];
  63     AVExpr *comp_expr[4];
  64     int hsub, vsub;
  65     double var_values[VAR_VARS_NB];
  66     int is_rgb, is_yuv;
  67     int step;
  68     int negate_alpha; /* only used by negate */
  69 } LutContext;
  70
  71 #define Y 0
  72 #define U 1
  73 #define V 2
  74 #define R 0
  75 #define G 1
  76 #define B 2
  77 #define A 3
  78
  79 #define OFFSET(x) offsetof(LutContext, x)
  80 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
  81
  82 static const AVOption options[] = {
  83     { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  84     { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  85     { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  86     { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  87     { "y",  "set Y expression",            OFFSET(comp_expr_str[Y]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  88     { "u",  "set U expression",            OFFSET(comp_expr_str[U]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  89     { "v",  "set V expression",            OFFSET(comp_expr_str[V]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  90     { "r",  "set R expression",            OFFSET(comp_expr_str[R]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  91     { "g",  "set G expression",            OFFSET(comp_expr_str[G]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  92     { "b",  "set B expression",            OFFSET(comp_expr_str[B]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  93     { "a",  "set A expression",            OFFSET(comp_expr_str[A]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
  94     { NULL },
  95 };
  96
  97 static av_cold void uninit(AVFilterContext *ctx)
  98 {
  99     LutContext *lut = ctx->priv;
 100     int i;
 101
 102     for (i = 0; i < 4; i++) {
 103         av_expr_free(lut->comp_expr[i]);
 104         lut->comp_expr[i] = NULL;
 105         av_freep(&lut->comp_expr_str[i]);
 106     }
 107 }
 108
 109 #define YUV_FORMATS                                         \
 110     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,    \
 111     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUV440P,    \
 112     AV_PIX_FMT_YUVA420P,                                       \
 113     AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,   \
 114     AV_PIX_FMT_YUVJ440P
 115
 116 #define RGB_FORMATS                             \
 117     AV_PIX_FMT_ARGB,         AV_PIX_FMT_RGBA,         \
 118     AV_PIX_FMT_ABGR,         AV_PIX_FMT_BGRA,         \
 119     AV_PIX_FMT_RGB24,        AV_PIX_FMT_BGR24
 120
 121 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
 122 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
 123 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
 124
 125 static int query_formats(AVFilterContext *ctx)
 126 {
 127     LutContext *lut = ctx->priv;
 128
 129     const enum AVPixelFormat *pix_fmts = lut->is_rgb ? rgb_pix_fmts :
 130                                        lut->is_yuv ? yuv_pix_fmts : all_pix_fmts;
 131
 132     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 133     return 0;
 134 }
 135
 136 /**
 137  * Clip value val in the minval - maxval range.
 138  */
 139 static double clip(void *opaque, double val)
 140 {
 141     LutContext *lut = opaque;
 142     double minval = lut->var_values[VAR_MINVAL];
 143     double maxval = lut->var_values[VAR_MAXVAL];
 144
 145     return av_clip(val, minval, maxval);
 146 }
 147
 148 /**
 149  * Compute gamma correction for value val, assuming the minval-maxval
 150  * range, val is clipped to a value contained in the same interval.
 151  */
 152 static double compute_gammaval(void *opaque, double gamma)
 153 {
 154     LutContext *lut = opaque;
 155     double val    = lut->var_values[VAR_CLIPVAL];
 156     double minval = lut->var_values[VAR_MINVAL];
 157     double maxval = lut->var_values[VAR_MAXVAL];
 158
 159     return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
 160 }
 161
 162 static double (* const funcs1[])(void *, double) = {
 163     (void *)clip,
 164     (void *)compute_gammaval,
 165     NULL
 166 };
 167
 168 static const char * const funcs1_names[] = {
 169     "clip",
 170     "gammaval",
 171     NULL
 172 };
 173
 174 static int config_props(AVFilterLink *inlink)
 175 {
 176     AVFilterContext *ctx = inlink->dst;
 177     LutContext *lut = ctx->priv;
 178     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 179     uint8_t rgba_map[4]; /* component index -> RGBA color index map */
 180     int min[4], max[4];
 181     int val, color, ret;
 182
 183     lut->hsub = desc->log2_chroma_w;
 184     lut->vsub = desc->log2_chroma_h;
 185
 186     lut->var_values[VAR_W] = inlink->w;
 187     lut->var_values[VAR_H] = inlink->h;
 188
 189     switch (inlink->format) {
 190     case AV_PIX_FMT_YUV410P:
 191     case AV_PIX_FMT_YUV411P:
 192     case AV_PIX_FMT_YUV420P:
 193     case AV_PIX_FMT_YUV422P:
 194     case AV_PIX_FMT_YUV440P:
 195     case AV_PIX_FMT_YUV444P:
 196     case AV_PIX_FMT_YUVA420P:
 197         min[Y] = min[U] = min[V] = 16;
 198         max[Y] = 235;
 199         max[U] = max[V] = 240;
 200         min[A] = 0; max[A] = 255;
 201         break;
 202     default:
 203         min[0] = min[1] = min[2] = min[3] = 0;
 204         max[0] = max[1] = max[2] = max[3] = 255;
 205     }
 206
 207     lut->is_yuv = lut->is_rgb = 0;
 208     if      (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) lut->is_yuv = 1;
 209     else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) lut->is_rgb = 1;
 210
 211     if (lut->is_rgb) {
 212         ff_fill_rgba_map(rgba_map, inlink->format);
 213         lut->step = av_get_bits_per_pixel(desc) >> 3;
 214     }
 215
 216     for (color = 0; color < desc->nb_components; color++) {
 217         double res;
 218         int comp = lut->is_rgb ? rgba_map[color] : color;
 219
 220         /* create the parsed expression */
 221         ret = av_expr_parse(&lut->comp_expr[color], lut->comp_expr_str[color],
 222                             var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
 223         if (ret < 0) {
 224             av_log(ctx, AV_LOG_ERROR,
 225                    "Error when parsing the expression '%s' for the component %d and color %d.\n",
 226                    lut->comp_expr_str[comp], comp, color);
 227             return AVERROR(EINVAL);
 228         }
 229
 230         /* compute the lut */
 231         lut->var_values[VAR_MAXVAL] = max[color];
 232         lut->var_values[VAR_MINVAL] = min[color];
 233
 234         for (val = 0; val < 256; val++) {
 235             lut->var_values[VAR_VAL] = val;
 236             lut->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
 237             lut->var_values[VAR_NEGVAL] =
 238                 av_clip(min[color] + max[color] - lut->var_values[VAR_VAL],
 239                         min[color], max[color]);
 240
 241             res = av_expr_eval(lut->comp_expr[color], lut->var_values, lut);
 242             if (isnan(res)) {
 243                 av_log(ctx, AV_LOG_ERROR,
 244                        "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
 245                        lut->comp_expr_str[color], val, comp);
 246                 return AVERROR(EINVAL);
 247             }
 248             lut->lut[comp][val] = av_clip((int)res, min[color], max[color]);
 249             av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, lut->lut[comp][val]);
 250         }
 251     }
 252
 253     return 0;
 254 }
 255
 256 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 257 {
 258     AVFilterContext *ctx = inlink->dst;
 259     LutContext *lut = ctx->priv;
 260     AVFilterLink *outlink = ctx->outputs[0];
 261     AVFrame *out;
 262     uint8_t *inrow, *outrow, *inrow0, *outrow0;
 263     int i, j, plane, direct = 0;
 264
 265     if (av_frame_is_writable(in)) {
 266         direct = 1;
 267         out = in;
 268     } else {
 269         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 270         if (!out) {
 271             av_frame_free(&in);
 272             return AVERROR(ENOMEM);
 273         }
 274         av_frame_copy_props(out, in);
 275     }
 276
 277     if (lut->is_rgb) {
 278         /* packed */
 279         inrow0  = in ->data[0];
 280         outrow0 = out->data[0];
 281
 282         for (i = 0; i < in->height; i ++) {
 283             int w = inlink->w;
 284             const uint8_t (*tab)[256] = (const uint8_t (*)[256])lut->lut;
 285             inrow  = inrow0;
 286             outrow = outrow0;
 287             for (j = 0; j < w; j++) {
 288                 switch (lut->step) {
 289                 case 4:  outrow[3] = tab[3][inrow[3]]; // Fall-through
 290                 case 3:  outrow[2] = tab[2][inrow[2]]; // Fall-through
 291                 case 2:  outrow[1] = tab[1][inrow[1]]; // Fall-through
 292                 default: outrow[0] = tab[0][inrow[0]];
 293                 }
 294                 outrow += lut->step;
 295                 inrow  += lut->step;
 296             }
 297             inrow0  += in ->linesize[0];
 298             outrow0 += out->linesize[0];
 299         }
 300     } else {
 301         /* planar */
 302         for (plane = 0; plane < 4 && in->data[plane]; plane++) {
 303             int vsub = plane == 1 || plane == 2 ? lut->vsub : 0;
 304             int hsub = plane == 1 || plane == 2 ? lut->hsub : 0;
 305
 306             inrow  = in ->data[plane];
 307             outrow = out->data[plane];
 308
 309             for (i = 0; i < (in->height + (1<<vsub) - 1)>>vsub; i ++) {
 310                 const uint8_t *tab = lut->lut[plane];
 311                 int w = (inlink->w + (1<<hsub) - 1)>>hsub;
 312                 for (j = 0; j < w; j++)
 313                     outrow[j] = tab[inrow[j]];
 314                 inrow  += in ->linesize[plane];
 315                 outrow += out->linesize[plane];
 316             }
 317         }
 318     }
 319
 320     if (!direct)
 321         av_frame_free(&in);
 322
 323     return ff_filter_frame(outlink, out);
 324 }
 325
 326 static const AVFilterPad inputs[] = {
 327     { .name            = "default",
 328       .type            = AVMEDIA_TYPE_VIDEO,
 329       .filter_frame    = filter_frame,
 330       .config_props    = config_props,
 331     },
 332     { .name = NULL}
 333 };
 334 static const AVFilterPad outputs[] = {
 335     { .name            = "default",
 336       .type            = AVMEDIA_TYPE_VIDEO, },
 337     { .name = NULL}
 338 };
 339
 340 #define DEFINE_LUT_FILTER(name_, description_)                          \
 341     AVFilter avfilter_vf_##name_ = {                                    \
 342         .name          = #name_,                                        \
 343         .description   = NULL_IF_CONFIG_SMALL(description_),            \
 344         .priv_size     = sizeof(LutContext),                            \
 345         .priv_class    = &name_ ## _class,                              \
 346                                                                         \
 347         .init          = name_##_init,                                  \
 348         .uninit        = uninit,                                        \
 349         .query_formats = query_formats,                                 \
 350                                                                         \
 351         .inputs        = inputs,                                        \
 352         .outputs       = outputs,                                       \
 353     }
 354
 355 #if CONFIG_LUT_FILTER
 356
 357 #define lut_options options
 358 AVFILTER_DEFINE_CLASS(lut);
 359
 360 static int lut_init(AVFilterContext *ctx)
 361 {
 362     return 0;
 363 }
 364
 365 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.");
 366 #endif
 367
 368 #if CONFIG_LUTYUV_FILTER
 369
 370 #define lutyuv_options options
 371 AVFILTER_DEFINE_CLASS(lutyuv);
 372
 373 static int lutyuv_init(AVFilterContext *ctx)
 374 {
 375     LutContext *lut = ctx->priv;
 376
 377     lut->is_yuv = 1;
 378
 379     return 0;
 380 }
 381
 382 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.");
 383 #endif
 384
 385 #if CONFIG_LUTRGB_FILTER
 386
 387 #define lutrgb_options options
 388 AVFILTER_DEFINE_CLASS(lutrgb);
 389
 390 static int lutrgb_init(AVFilterContext *ctx)
 391 {
 392     LutContext *lut = ctx->priv;
 393
 394     lut->is_rgb = 1;
 395
 396     return 0;
 397 }
 398
 399 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.");
 400 #endif
 401
 402 #if CONFIG_NEGATE_FILTER
 403
 404 static const AVOption negate_options[] = {
 405     { "negate_alpha", NULL, OFFSET(negate_alpha), AV_OPT_TYPE_INT, { .i64 = 0 }, .flags = FLAGS },
 406     { NULL },
 407 };
 408
 409 AVFILTER_DEFINE_CLASS(negate);
 410
 411 static int negate_init(AVFilterContext *ctx)
 412 {
 413     LutContext *lut = ctx->priv;
 414     int i;
 415
 416     av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", lut->negate_alpha);
 417
 418     for (i = 0; i < 4; i++) {
 419         lut->comp_expr_str[i] = av_strdup((i == 3 && !lut->negate_alpha) ?
 420                                           "val" : "negval");
 421         if (!lut->comp_expr_str[i]) {
 422             uninit(ctx);
 423             return AVERROR(ENOMEM);
 424         }
 425     }
 426
 427     return 0;
 428 }
 429
 430 DEFINE_LUT_FILTER(negate, "Negate input video.");
 431
 432 #endif