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

   1 /*
   2  * Copyright (c) 2012 Jeremy Tran
   3  * Copyright (c) 2001 Donald A. Graft
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 /**
  23  * @file
  24  * Histogram equalization filter, based on the VirtualDub filter by
  25  * Donald A. Graft  <neuron2 AT home DOT com>.
  26  * Implements global automatic contrast adjustment by means of
  27  * histogram equalization.
  28  */
  29
  30 #include "libavutil/common.h"
  31 #include "libavutil/opt.h"
  32 #include "libavutil/pixdesc.h"
  33
  34 #include "avfilter.h"
  35 #include "drawutils.h"
  36 #include "formats.h"
  37 #include "internal.h"
  38 #include "video.h"
  39
  40 // #define DEBUG
  41
  42 // Linear Congruential Generator, see "Numerical Recipes"
  43 #define LCG_A 4096
  44 #define LCG_C 150889
  45 #define LCG_M 714025
  46 #define LCG(x) (((x) * LCG_A + LCG_C) % LCG_M)
  47 #define LCG_SEED 739187
  48
  49 enum HisteqAntibanding {
  50     HISTEQ_ANTIBANDING_NONE   = 0,
  51     HISTEQ_ANTIBANDING_WEAK   = 1,
  52     HISTEQ_ANTIBANDING_STRONG = 2,
  53     HISTEQ_ANTIBANDING_NB,
  54 };
  55
  56 typedef struct {
  57     const AVClass *class;
  58     float strength;
  59     float intensity;
  60     int antibanding;               ///< HisteqAntibanding
  61     int in_histogram [256];        ///< input histogram
  62     int out_histogram[256];        ///< output histogram
  63     int LUT[256];                  ///< lookup table derived from histogram[]
  64     uint8_t rgba_map[4];           ///< components position
  65     int bpp;                       ///< bytes per pixel
  66 } HisteqContext;
  67
  68 #define OFFSET(x) offsetof(HisteqContext, x)
  69 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  70 #define CONST(name, help, val, unit) { name, help, 0, AV_OPT_TYPE_CONST, {.i64=val}, INT_MIN, INT_MAX, FLAGS, unit }
  71
  72 static const AVOption histeq_options[] = {
  73     { "strength",    "set the strength", OFFSET(strength), AV_OPT_TYPE_FLOAT, {.dbl=0.2}, 0, 1, FLAGS },
  74     { "intensity",   "set the intensity", OFFSET(intensity), AV_OPT_TYPE_FLOAT, {.dbl=0.21}, 0, 1, FLAGS },
  75     { "antibanding", "set the antibanding level", OFFSET(antibanding), AV_OPT_TYPE_INT, {.i64=HISTEQ_ANTIBANDING_NONE}, 0, HISTEQ_ANTIBANDING_NB-1, FLAGS, "antibanding" },
  76     CONST("none",    "apply no antibanding",     HISTEQ_ANTIBANDING_NONE,   "antibanding"),
  77     CONST("weak",    "apply weak antibanding",   HISTEQ_ANTIBANDING_WEAK,   "antibanding"),
  78     CONST("strong",  "apply strong antibanding", HISTEQ_ANTIBANDING_STRONG, "antibanding"),
  79     { NULL }
  80 };
  81
  82 AVFILTER_DEFINE_CLASS(histeq);
  83
  84 static av_cold int init(AVFilterContext *ctx)
  85 {
  86     HisteqContext *histeq = ctx->priv;
  87
  88     av_log(ctx, AV_LOG_VERBOSE,
  89            "strength:%0.3f intensity:%0.3f antibanding:%d\n",
  90            histeq->strength, histeq->intensity, histeq->antibanding);
  91
  92     return 0;
  93 }
  94
  95 static int query_formats(AVFilterContext *ctx)
  96 {
  97     static const enum AVPixelFormat pix_fmts[] = {
  98         AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA, AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA,
  99         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
 100         AV_PIX_FMT_NONE
 101     };
 102     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
 103     if (!fmts_list)
 104         return AVERROR(ENOMEM);
 105     return ff_set_common_formats(ctx, fmts_list);
 106 }
 107
 108 static int config_input(AVFilterLink *inlink)
 109 {
 110     AVFilterContext *ctx = inlink->dst;
 111     HisteqContext *histeq = ctx->priv;
 112     const AVPixFmtDescriptor *pix_desc = av_pix_fmt_desc_get(inlink->format);
 113
 114     histeq->bpp = av_get_bits_per_pixel(pix_desc) / 8;
 115     ff_fill_rgba_map(histeq->rgba_map, inlink->format);
 116
 117     return 0;
 118 }
 119
 120 #define R 0
 121 #define G 1
 122 #define B 2
 123 #define A 3
 124
 125 #define GET_RGB_VALUES(r, g, b, src, map) do { \
 126     r = src[x + map[R]];                       \
 127     g = src[x + map[G]];                       \
 128     b = src[x + map[B]];                       \
 129 } while (0)
 130
 131 static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
 132 {
 133     AVFilterContext   *ctx     = inlink->dst;
 134     HisteqContext     *histeq  = ctx->priv;
 135     AVFilterLink      *outlink = ctx->outputs[0];
 136     int strength  = histeq->strength  * 1000;
 137     int intensity = histeq->intensity * 1000;
 138     int x, y, i, luthi, lutlo, lut, luma, oluma, m;
 139     AVFrame *outpic;
 140     unsigned int r, g, b, jran;
 141     uint8_t *src, *dst;
 142
 143     outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 144     if (!outpic) {
 145         av_frame_free(&inpic);
 146         return AVERROR(ENOMEM);
 147     }
 148     av_frame_copy_props(outpic, inpic);
 149
 150     /* Seed random generator for antibanding. */
 151     jran = LCG_SEED;
 152
 153     /* Calculate and store the luminance and calculate the global histogram
 154        based on the luminance. */
 155     memset(histeq->in_histogram, 0, sizeof(histeq->in_histogram));
 156     src = inpic->data[0];
 157     dst = outpic->data[0];
 158     for (y = 0; y < inlink->h; y++) {
 159         for (x = 0; x < inlink->w * histeq->bpp; x += histeq->bpp) {
 160             GET_RGB_VALUES(r, g, b, src, histeq->rgba_map);
 161             luma = (55 * r + 182 * g + 19 * b) >> 8;
 162             dst[x + histeq->rgba_map[A]] = luma;
 163             histeq->in_histogram[luma]++;
 164         }
 165         src += inpic->linesize[0];
 166         dst += outpic->linesize[0];
 167     }
 168
 169 #ifdef DEBUG
 170     for (x = 0; x < 256; x++)
 171         av_dlog(ctx, "in[%d]: %u\n", x, histeq->in_histogram[x]);
 172 #endif
 173
 174     /* Calculate the lookup table. */
 175     histeq->LUT[0] = histeq->in_histogram[0];
 176     /* Accumulate */
 177     for (x = 1; x < 256; x++)
 178         histeq->LUT[x] = histeq->LUT[x-1] + histeq->in_histogram[x];
 179
 180     /* Normalize */
 181     for (x = 0; x < 256; x++)
 182         histeq->LUT[x] = (histeq->LUT[x] * intensity) / (inlink->h * inlink->w);
 183
 184     /* Adjust the LUT based on the selected strength. This is an alpha
 185        mix of the calculated LUT and a linear LUT with gain 1. */
 186     for (x = 0; x < 256; x++)
 187         histeq->LUT[x] = (strength * histeq->LUT[x]) / 255 +
 188                          ((255 - strength) * x)      / 255;
 189
 190     /* Output the equalized frame. */
 191     memset(histeq->out_histogram, 0, sizeof(histeq->out_histogram));
 192
 193     src = inpic->data[0];
 194     dst = outpic->data[0];
 195     for (y = 0; y < inlink->h; y++) {
 196         for (x = 0; x < inlink->w * histeq->bpp; x += histeq->bpp) {
 197             luma = dst[x + histeq->rgba_map[A]];
 198             if (luma == 0) {
 199                 for (i = 0; i < histeq->bpp; ++i)
 200                     dst[x + i] = 0;
 201                 histeq->out_histogram[0]++;
 202             } else {
 203                 lut = histeq->LUT[luma];
 204                 if (histeq->antibanding != HISTEQ_ANTIBANDING_NONE) {
 205                     if (luma > 0) {
 206                         lutlo = histeq->antibanding == HISTEQ_ANTIBANDING_WEAK ?
 207                                 (histeq->LUT[luma] + histeq->LUT[luma - 1]) / 2 :
 208                                  histeq->LUT[luma - 1];
 209                     } else
 210                         lutlo = lut;
 211
 212                     if (luma < 255) {
 213                         luthi = (histeq->antibanding == HISTEQ_ANTIBANDING_WEAK) ?
 214                             (histeq->LUT[luma] + histeq->LUT[luma + 1]) / 2 :
 215                              histeq->LUT[luma + 1];
 216                     } else
 217                         luthi = lut;
 218
 219                     if (lutlo != luthi) {
 220                         jran = LCG(jran);
 221                         lut = lutlo + ((luthi - lutlo + 1) * jran) / LCG_M;
 222                     }
 223                 }
 224
 225                 GET_RGB_VALUES(r, g, b, src, histeq->rgba_map);
 226                 if (((m = FFMAX3(r, g, b)) * lut) / luma > 255) {
 227                     r = (r * 255) / m;
 228                     g = (g * 255) / m;
 229                     b = (b * 255) / m;
 230                 } else {
 231                     r = (r * lut) / luma;
 232                     g = (g * lut) / luma;
 233                     b = (b * lut) / luma;
 234                 }
 235                 dst[x + histeq->rgba_map[R]] = r;
 236                 dst[x + histeq->rgba_map[G]] = g;
 237                 dst[x + histeq->rgba_map[B]] = b;
 238                 oluma = av_clip_uint8((55 * r + 182 * g + 19 * b) >> 8);
 239                 histeq->out_histogram[oluma]++;
 240             }
 241         }
 242         src += inpic->linesize[0];
 243         dst += outpic->linesize[0];
 244     }
 245 #ifdef DEBUG
 246     for (x = 0; x < 256; x++)
 247         av_dlog(ctx, "out[%d]: %u\n", x, histeq->out_histogram[x]);
 248 #endif
 249
 250     av_frame_free(&inpic);
 251     return ff_filter_frame(outlink, outpic);
 252 }
 253
 254 static const AVFilterPad histeq_inputs[] = {
 255     {
 256         .name         = "default",
 257         .type         = AVMEDIA_TYPE_VIDEO,
 258         .config_props = config_input,
 259         .filter_frame = filter_frame,
 260     },
 261     { NULL }
 262 };
 263
 264 static const AVFilterPad histeq_outputs[] = {
 265     {
 266         .name = "default",
 267         .type = AVMEDIA_TYPE_VIDEO,
 268     },
 269     { NULL }
 270 };
 271
 272 AVFilter ff_vf_histeq = {
 273     .name          = "histeq",
 274     .description   = NULL_IF_CONFIG_SMALL("Apply global color histogram equalization."),
 275     .priv_size     = sizeof(HisteqContext),
 276     .init          = init,
 277     .query_formats = query_formats,
 278     .inputs        = histeq_inputs,
 279     .outputs       = histeq_outputs,
 280     .priv_class    = &histeq_class,
 281     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 282 };