avfilter: Port mp=eq/eq2 to lavfi

Code adapted from James Darnley's port
Some fixes from Paul B Mahol <onemda@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

configure

@@ -2581,6 +2581,7 @@ delogo_filter_deps="gpl"
 deshake_filter_select="pixelutils"
 drawtext_filter_deps="libfreetype"
 ebur128_filter_deps="gpl"
+eq_filter_deps="gpl"
 flite_filter_deps="libflite"
 frei0r_filter_deps="frei0r dlopen"
 frei0r_src_filter_deps="frei0r dlopen"

doc/filters.texi

@@ -4335,6 +4335,49 @@ edgedetect=mode=colormix:high=0
 @end example
 @end itemize
 
+@section eq
+Set brightness, contrast, saturation and approximate gamma adjustment.
+
+The filter accepts the following options:
+
+@table @option
+@item contrast
+Set the contrast value. It accepts a float value in range @code{-2.0} to
+@code{2.0}. The default value is @code{0.0}.
+
+@item brightness
+Set the brightness value. It accepts a float value in range @code{-1.0} to
+@code{1.0}. The default value is @code{0.0}.
+
+@item saturation
+Set the saturation value. It accepts a float value in range @code{0.0} to
+@code{3.0}. The default value is @code{1.0}.
+
+@item gamma
+Set the gamma value. It accepts a float value in range @code{0.1} to @code{10.0}.
+The default value is @code{1.0}.
+
+@item gamma_r
+Set the gamma value for red. It accepts a float value in range
+@code{0.1} to @code{10.0}. The default value is @code{1.0}.
+
+@item gamma_g
+Set the gamma value for green. It accepts a float value in range
+@code{0.1} to @code{10.0}. The default value is @code{1.0}.
+
+@item gamma_b
+Set the gamma value for blue. It accepts a float value in range
+@code{0.1} to @code{10.0}. The default value is @code{1.0}.
+
+@item gamma_weight
+Can be used to reduce the effect of a high gamma value on bright image areas,
+e.g. keep them from getting overamplified and just plain white. It accepts a
+float value in range @code{0.0} to @code{1.0}.A value of @code{0.0} turns the
+gamma correction all the way down while @code{1.0} leaves it at its full strength.
+Default is @code{1.0}.
+
+@end table
+
 @section extractplanes
 
 Extract color channel components from input video stream into

libavfilter/Makefile

@@ -116,6 +116,7 @@ OBJS-$(CONFIG_DRAWGRID_FILTER)               += vf_drawbox.o
 OBJS-$(CONFIG_DRAWTEXT_FILTER)               += vf_drawtext.o
 OBJS-$(CONFIG_ELBG_FILTER)                   += vf_elbg.o
 OBJS-$(CONFIG_EDGEDETECT_FILTER)             += vf_edgedetect.o
+OBJS-$(CONFIG_EQ_FILTER)                     += vf_eq.o
 OBJS-$(CONFIG_EXTRACTPLANES_FILTER)          += vf_extractplanes.o
 OBJS-$(CONFIG_FADE_FILTER)                   += vf_fade.o
 OBJS-$(CONFIG_FIELD_FILTER)                  += vf_field.o

libavfilter/allfilters.c

@@ -132,6 +132,7 @@ void avfilter_register_all(void)
     REGISTER_FILTER(DRAWTEXT,       drawtext,       vf);
     REGISTER_FILTER(EDGEDETECT,     edgedetect,     vf);
     REGISTER_FILTER(ELBG,           elbg,           vf);
+    REGISTER_FILTER(EQ,             eq,             vf);
     REGISTER_FILTER(EXTRACTPLANES,  extractplanes,  vf);
     REGISTER_FILTER(FADE,           fade,           vf);
     REGISTER_FILTER(FIELD,          field,          vf);

libavfilter/version.h

@@ -30,8 +30,8 @@
 #include "libavutil/version.h"
 
 #define LIBAVFILTER_VERSION_MAJOR  5
-#define LIBAVFILTER_VERSION_MINOR  8
-#define LIBAVFILTER_VERSION_MICRO 101
+#define LIBAVFILTER_VERSION_MINOR  9
+#define LIBAVFILTER_VERSION_MICRO 100
 
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
                                                LIBAVFILTER_VERSION_MINOR, \

libavfilter/vf_eq.c

+/*
+ * Original MPlayer filters by Richard Felker, Hampa Hug, Daniel Moreno,
+ * and Michael Niedermeyer.
+ *
+ * Copyright (c) 2014 James Darnley <james.darnley@gmail.com>
+ * Copyright (c) 2015 Arwa Arif <arwaarif1994@gmail.com>
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU 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
+ * very simple video equalizer
+ */
+
+/**
+ * TODO:
+ * - Add support to process_command
+ */
+
+#include "libavfilter/internal.h"
+#include "libavutil/common.h"
+#include "libavutil/imgutils.h"
+#include "libavutil/opt.h"
+#include "libavutil/pixdesc.h"
+#include "vf_eq.h"
+
+static void create_lut(EQParameters *param)
+{
+    int i;
+    double   g  = 1.0 / param->gamma;
+    double   lw = 1.0 - param->gamma_weight;
+
+    for (i = 0; i < 256; i++) {
+        double v = i / 255.0;
+        v = param->contrast * (v - 0.5) + 0.5 + param->brightness;
+
+        if (v <= 0.0) {
+            param->lut[i] = 0;
+        } else {
+            v = v * lw + pow(v, g) * param->gamma_weight;
+
+            if (v >= 1.0)
+                param->lut[i] = 255;
+            else
+                param->lut[i] = 256.0 * v;
+        }
+    }
+
+    param->lut_clean = 1;
+}
+
+static void apply_lut(EQParameters *param, uint8_t *dst, int dst_stride,
+                      uint8_t *src, int src_stride, int w, int h)
+{
+    int x, y;
+
+    if (!param->lut_clean)
+        create_lut(param);
+
+    for (y = 0; y < h; y++) {
+        for (x = 0; x < w; x++) {
+            dst[y * dst_stride + x] = param->lut[src[y * src_stride + x]];
+        }
+    }
+}
+
+static void process_c(EQParameters *param, uint8_t *dst, int dst_stride,
+                      uint8_t *src, int src_stride, int w, int h)
+{
+    int x, y, pel;
+
+    int contrast = (int) (param->contrast * 256 * 16);
+    int brightness = ((int) (100.0 * param->brightness + 100.0) * 511) / 200 - 128 - contrast / 32;
+
+    for (y = 0; y < h; y++) {
+        for (x = 0; x < w; x++) {
+            pel = ((src[y * src_stride + x] * contrast) >> 12) + brightness;
+
+            if (pel & 768)
+                pel = (-pel) >> 31;
+
+            dst[y * dst_stride + x] = pel;
+        }
+    }
+}
+
+static void check_values(EQParameters *param, EQContext *eq)
+{
+    if (param->contrast == 1.0 && param->brightness == 0.0 && param->gamma == 1.0)
+        param->adjust = NULL;
+    else if (param->gamma == 1.0)
+        param->adjust = eq->process;
+    else
+        param->adjust = apply_lut;
+}
+
+static void set_contrast(EQContext *eq)
+{
+    eq->param[0].contrast = eq->contrast;
+    eq->param[0].lut_clean = 0;
+    check_values(&eq->param[0], eq);
+}
+
+static void set_brightness(EQContext *eq)
+{
+    eq->param[0].brightness = eq->brightness;
+    eq->param[0].lut_clean = 0;
+    check_values(&eq->param[0], eq);
+}
+
+static void set_gamma(EQContext *eq)
+{
+    int i;
+    eq->param[0].gamma = eq->gamma * eq->gamma_g;
+    eq->param[1].gamma = sqrt(eq->gamma_b / eq->gamma_g);
+    eq->param[2].gamma = sqrt(eq->gamma_r / eq->gamma_g);
+
+    for (i = 0; i < 3; i++) {
+        eq->param[i].gamma_weight = eq->gamma_weight;
+        eq->param[i].lut_clean = 0;
+        check_values(&eq->param[i], eq);
+    }
+}
+
+static void set_saturation(EQContext *eq)
+{
+    int i;
+    for (i = 1; i < 3; i++) {
+        eq->param[i].contrast = eq->saturation;
+        eq->param[i].lut_clean = 0;
+        check_values(&eq->param[i], eq);
+    }
+}
+
+static int initialize(AVFilterContext *ctx)
+{
+    EQContext *eq = ctx->priv;
+
+    eq->process = process_c;
+
+    if (ARCH_X86)
+        ff_eq_init_x86(eq);
+
+    set_gamma(eq);
+    set_contrast(eq);
+    set_brightness(eq);
+    set_saturation(eq);
+
+    return 0;
+}
+
+static int query_formats(AVFilterContext *ctx)
+{
+    static const enum AVPixelFormat pixel_fmts_eq[] = {
+        AV_PIX_FMT_GRAY8,
+        AV_PIX_FMT_YUV410P,
+        AV_PIX_FMT_YUV411P,
+        AV_PIX_FMT_YUV420P,
+        AV_PIX_FMT_YUV422P,
+        AV_PIX_FMT_YUV444P,
+        AV_PIX_FMT_NONE
+    };
+
+    ff_set_common_formats(ctx, ff_make_format_list(pixel_fmts_eq));
+
+    return 0;
+}
+
+static int filter_frame(AVFilterLink *inlink, AVFrame *in)
+{
+    AVFilterContext *ctx = inlink->dst;
+    AVFilterLink *outlink = inlink->dst->outputs[0];
+    EQContext *eq = ctx->priv;
+    AVFrame *out;
+    const AVPixFmtDescriptor *desc;
+    int i;
+
+    out = ff_get_video_buffer(outlink, inlink->w, inlink->h);
+    if (!out)
+        return AVERROR(ENOMEM);
+
+    av_frame_copy_props(out, in);
+    desc = av_pix_fmt_desc_get(inlink->format);
+
+    for (i = 0; i < desc->nb_components; i++) {
+        int w = inlink->w;
+        int h = inlink->h;
+
+        if (i == 1 || i == 2) {
+            w = FF_CEIL_RSHIFT(w, desc->log2_chroma_w);
+            h = FF_CEIL_RSHIFT(h, desc->log2_chroma_h);
+        }
+
+        if (eq->param[i].adjust)
+            eq->param[i].adjust(&eq->param[i], out->data[i], out->linesize[i],
+                                 in->data[i], in->linesize[i], w, h);
+        else
+            av_image_copy_plane(out->data[i], out->linesize[i],
+                                in->data[i], in->linesize[i], w, h);
+    }
+
+    return ff_filter_frame(outlink, out);
+}
+static const AVFilterPad eq_inputs[] = {
+    {
+        .name = "default",
+        .type = AVMEDIA_TYPE_VIDEO,
+        .filter_frame = filter_frame,
+    },
+    { NULL }
+};
+
+static const AVFilterPad eq_outputs[] = {
+    {
+        .name = "default",
+        .type = AVMEDIA_TYPE_VIDEO,
+    },
+    { NULL }
+};
+
+#define OFFSET(x) offsetof(EQContext, x)
+#define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
+
+static const AVOption eq_options[] = {
+    { "contrast",     "set the contrast adjustment, negative values give a negative image",
+        OFFSET(contrast),     AV_OPT_TYPE_DOUBLE, {.dbl = 1.0}, -2.0, 2.0, FLAGS },
+    { "brightness",   "set the brightness adjustment",
+        OFFSET(brightness),   AV_OPT_TYPE_DOUBLE, {.dbl = 0.0}, -1.0, 1.0, FLAGS },
+    { "saturation",   "set the saturation adjustment",
+        OFFSET(saturation),   AV_OPT_TYPE_DOUBLE, {.dbl = 1.0},  0.0, 3.0, FLAGS },
+    { "gamma",        "set the initial gamma value",
+        OFFSET(gamma),        AV_OPT_TYPE_DOUBLE, {.dbl = 1.0},  0.1, 10.0, FLAGS },
+    { "gamma_r",      "gamma value for red",
+        OFFSET(gamma_r),      AV_OPT_TYPE_DOUBLE, {.dbl = 1.0},  0.1, 10.0, FLAGS },
+    { "gamma_g",      "gamma value for green",
+        OFFSET(gamma_g),      AV_OPT_TYPE_DOUBLE, {.dbl = 1.0},  0.1, 10.0, FLAGS },
+    { "gamma_b",      "gamma value for blue",
+        OFFSET(gamma_b),      AV_OPT_TYPE_DOUBLE, {.dbl = 1.0},  0.1, 10.0, FLAGS },
+    { "gamma_weight", "set the gamma weight which reduces the effect of gamma on bright areas",
+        OFFSET(gamma_weight), AV_OPT_TYPE_DOUBLE, {.dbl = 1.0},  0.0, 1.0, FLAGS },
+    { NULL }
+};
+
+AVFILTER_DEFINE_CLASS(eq);
+
+AVFilter ff_vf_eq = {
+    .name          = "eq",
+    .description   = NULL_IF_CONFIG_SMALL("Adjust brightness, contrast, gamma, and saturation."),
+    .priv_size     = sizeof(EQContext),
+    .priv_class    = &eq_class,
+    .inputs        = eq_inputs,
+    .outputs       = eq_outputs,
+    .query_formats = query_formats,
+    .init          = initialize,
+};

libavfilter/vf_eq.h

+/*
+ * Original MPlayer filters by Richard Felker, Hampa Hug, Daniel Moreno,
+ * and Michael Niedermeyer.
+ *
+ * Copyright (c) 2014 James Darnley <james.darnley@gmail.com>
+ * Copyright (c) 2015 Arwa Arif <arwaarif1994@gmail.com>
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU 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.
+ */
+
+#ifndef AVFILTER_EQ_H
+#define AVFILTER_EQ_H
+
+#include "avfilter.h"
+
+typedef struct EQParameters {
+    void (*adjust)(struct EQParameters *eq, uint8_t *dst, int dst_stride,
+                   uint8_t *src, int src_stride, int w, int h);
+
+    uint8_t lut[256];
+
+    double brightness, contrast, gamma, gamma_weight;
+    int lut_clean;
+} EQParameters;
+
+typedef struct {
+    const AVClass *class;
+
+    EQParameters param[3];
+
+    double contrast;
+    double brightness;
+    double saturation;
+
+    double gamma;
+    double gamma_weight;
+    double gamma_r, gamma_g, gamma_b;
+
+    void (*process)(struct EQParameters *par, uint8_t *dst, int dst_stride,
+                    uint8_t *src, int src_stride, int w, int h);
+
+} EQContext;
+
+void ff_eq_init_x86(EQContext *eq);
+
+#endif /* AVFILTER_EQ_H */

libavfilter/x86/Makefile

+OBJS-$(CONFIG_EQ_FILTER)                     += x86/vf_eq.o
 OBJS-$(CONFIG_FSPP_FILTER)                   += x86/vf_fspp_init.o
 OBJS-$(CONFIG_GRADFUN_FILTER)                += x86/vf_gradfun_init.o
 OBJS-$(CONFIG_HQDN3D_FILTER)                 += x86/vf_hqdn3d_init.o

libavfilter/x86/vf_eq.c

+/*
+ *
+ * Original MPlayer filters by Richard Felker.
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU 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.
+ */
+
+#include "libavutil/attributes.h"
+#include "libavutil/cpu.h"
+#include "libavutil/mem.h"
+#include "libavutil/x86/asm.h"
+#include "libavfilter/vf_eq.h"
+
+#if HAVE_MMX_INLINE && HAVE_6REGS
+static void process_MMX(EQParameters *param, uint8_t *dst, int dst_stride,
+                        uint8_t *src, int src_stride, int w, int h)
+{
+        int i;
+        int pel;
+        int dstep = dst_stride - w;
+        int sstep = src_stride - w;
+        short brvec[4];
+        short contvec[4];
+        int contrast = (int) (param->contrast * 256 * 16);
+        int brightness = ((int) (100.0 * param->brightness + 100.0) * 511) / 200 - 128 - contrast / 32;
+
+        brvec[0] = brvec[1] = brvec[2] = brvec[3] = brightness;
+        contvec[0] = contvec[1] = contvec[2] = contvec[3] = contrast;
+
+        while (h--) {
+                __asm__ volatile (
+                        "movq (%5), %%mm3      \n\t"
+                        "movq (%6), %%mm4      \n\t"
+                        "pxor %%mm0, %%mm0     \n\t"
+                        "movl %4, %%eax        \n\t"
+                        ".p2align 4 \n\t"
+                        "1:                    \n\t"
+                        "movq (%0), %%mm1      \n\t"
+                        "movq (%0), %%mm2      \n\t"
+                        "punpcklbw %%mm0, %%mm1\n\t"
+                        "punpckhbw %%mm0, %%mm2\n\t"
+                        "psllw $4, %%mm1       \n\t"
+                        "psllw $4, %%mm2       \n\t"
+                        "pmulhw %%mm4, %%mm1   \n\t"
+                        "pmulhw %%mm4, %%mm2   \n\t"
+                        "paddw %%mm3, %%mm1    \n\t"
+                        "paddw %%mm3, %%mm2    \n\t"
+                        "packuswb %%mm2, %%mm1 \n\t"
+                        "add $8, %0            \n\t"
+                        "movq %%mm1, (%1)      \n\t"
+                        "add $8, %1            \n\t"
+                        "decl %%eax            \n\t"
+                        "jnz 1b                \n\t"
+                        : "=r" (src), "=r" (dst)
+                        : "0" (src), "1" (dst), "r" (w>>3), "r" (brvec), "r" (contvec)
+                        : "%eax"
+                );
+
+                for (i = w&7; i; i--) {
+                        pel = ((*src++ * contrast) >> 12) + brightness;
+                        if (pel & 768)
+                            pel = (-pel) >> 31;
+                        *dst++ = pel;
+                }
+
+                src += sstep;
+                dst += dstep;
+        }
+        __asm__ volatile ( "emms \n\t" ::: "memory" );
+}
+#endif
+
+av_cold void ff_eq_init_x86(EQContext *eq)
+{
+#if HAVE_MMX_INLINE && HAVE_6REGS
+    int cpu_flags = av_get_cpu_flags();
+
+    if (cpu_flags & AV_CPU_FLAG_MMX) {
+        eq->process = process_MMX;
+    }
+#endif
+}