libavfilter/vf_colorbalance.c
449cdd54
 /*
  * Copyright (c) 2013 Paul B Mahol
  *
  * 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
  */
 
 #include "libavutil/opt.h"
 #include "libavutil/pixdesc.h"
 #include "avfilter.h"
 #include "drawutils.h"
 #include "formats.h"
 #include "internal.h"
 #include "video.h"
 
 #define R 0
 #define G 1
 #define B 2
 #define A 3
 
0ef7a451
 typedef struct ThreadData {
     AVFrame *in, *out;
 } ThreadData;
 
ed93ed5e
 typedef struct Range {
bffd0f7b
     float shadows;
     float midtones;
     float highlights;
449cdd54
 } Range;
 
ed93ed5e
 typedef struct ColorBalanceContext {
449cdd54
     const AVClass *class;
     Range cyan_red;
     Range magenta_green;
     Range yellow_blue;
d19fdc83
     int preserve_lightness;
449cdd54
 
     uint8_t rgba_map[4];
08c46e40
     int depth;
d19fdc83
     int max;
449cdd54
     int step;
c2fd69ba
 
08c46e40
     int (*color_balance)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
449cdd54
 } ColorBalanceContext;
 
 #define OFFSET(x) offsetof(ColorBalanceContext, x)
45f03cdd
 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
449cdd54
 static const AVOption colorbalance_options[] = {
bffd0f7b
     { "rs", "set red shadows",      OFFSET(cyan_red.shadows),         AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "gs", "set green shadows",    OFFSET(magenta_green.shadows),    AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "bs", "set blue shadows",     OFFSET(yellow_blue.shadows),      AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "rm", "set red midtones",     OFFSET(cyan_red.midtones),        AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "gm", "set green midtones",   OFFSET(magenta_green.midtones),   AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "bm", "set blue midtones",    OFFSET(yellow_blue.midtones),     AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "rh", "set red highlights",   OFFSET(cyan_red.highlights),      AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "gh", "set green highlights", OFFSET(magenta_green.highlights), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "bh", "set blue highlights",  OFFSET(yellow_blue.highlights),   AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
     { "pl", "preserve lightness",   OFFSET(preserve_lightness),       AV_OPT_TYPE_BOOL,  {.i64=0},  0, 1, FLAGS },
449cdd54
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(colorbalance);
 
 static int query_formats(AVFilterContext *ctx)
 {
     static const enum AVPixelFormat pix_fmts[] = {
         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
         AV_PIX_FMT_RGBA,  AV_PIX_FMT_BGRA,
         AV_PIX_FMT_ABGR,  AV_PIX_FMT_ARGB,
         AV_PIX_FMT_0BGR,  AV_PIX_FMT_0RGB,
         AV_PIX_FMT_RGB0,  AV_PIX_FMT_BGR0,
c2fd69ba
         AV_PIX_FMT_RGB48,  AV_PIX_FMT_BGR48,
         AV_PIX_FMT_RGBA64, AV_PIX_FMT_BGRA64,
db8777ce
         AV_PIX_FMT_GBRP,   AV_PIX_FMT_GBRAP,
         AV_PIX_FMT_GBRP9,
         AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
         AV_PIX_FMT_GBRP14,
         AV_PIX_FMT_GBRP16, AV_PIX_FMT_GBRAP16,
449cdd54
         AV_PIX_FMT_NONE
     };
fd682b18
     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
     if (!fmts_list)
         return AVERROR(ENOMEM);
     return ff_set_common_formats(ctx, fmts_list);
449cdd54
 }
 
bffd0f7b
 static float get_component(float v, float l,
                            float s, float m, float h)
08c46e40
 {
bffd0f7b
     const float a = 4.f, b = 0.333f, scale = 0.7f;
08c46e40
 
bffd0f7b
     s *= av_clipf((b - l) * a + 0.5f, 0, 1) * scale;
     m *= av_clipf((l - b) * a + 0.5f, 0, 1) * av_clipf((1.0 - l - b) * a + 0.5f, 0, 1) * scale;
     h *= av_clipf((l + b - 1) * a + 0.5f, 0, 1) * scale;
08c46e40
 
     v += s;
     v += m;
     v += h;
 
5ed20a74
     return av_clipf(v + 0.5f, 0, 1);
d19fdc83
 }
 
bffd0f7b
 static float hfun(float n, float h, float s, float l)
d19fdc83
 {
bffd0f7b
     float a = s * FFMIN(l, 1. - l);
     float k = fmodf(n + h / 30.f, 12.f);
d19fdc83
 
bffd0f7b
     return av_clipf(l - a * FFMAX(FFMIN3(k - 3.f, 9.f - k, 1), -1.f), 0, 1);
d19fdc83
 }
 
bffd0f7b
 static void preservel(float *r, float *g, float *b, float l)
d19fdc83
 {
bffd0f7b
     float max = FFMAX3(*r, *g, *b);
     float min = FFMIN3(*r, *g, *b);
     float h, s;
d19fdc83
 
     l *= 0.5;
 
     if (*r == *g && *g == *b) {
         h = 0.;
     } else if (max == *r) {
         h = 60. * (0. + (*g - *b) / (max - min));
     } else if (max == *g) {
         h = 60. * (2. + (*b - *r) / (max - min));
     } else if (max == *b) {
         h = 60. * (4. + (*r - *g) / (max - min));
     } else {
         h = 0.;
     }
     if (h < 0.)
         h += 360.;
 
     if (max == 0. || min == 1.) {
         s = 0.;
     } else {
         s = (max - min) / (1. - FFABS(2. * l - 1));
     }
 
     *r = hfun(0, h, s, l);
     *g = hfun(8, h, s, l);
     *b = hfun(4, h, s, l);
08c46e40
 }
 
 static int color_balance8_p(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
db8777ce
 {
     ColorBalanceContext *s = ctx->priv;
0ef7a451
     ThreadData *td = arg;
     AVFrame *in = td->in;
     AVFrame *out = td->out;
     const int slice_start = (out->height * jobnr) / nb_jobs;
     const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
     const uint8_t *srcg = in->data[0] + slice_start * in->linesize[0];
     const uint8_t *srcb = in->data[1] + slice_start * in->linesize[1];
     const uint8_t *srcr = in->data[2] + slice_start * in->linesize[2];
     const uint8_t *srca = in->data[3] + slice_start * in->linesize[3];
     uint8_t *dstg = out->data[0] + slice_start * out->linesize[0];
     uint8_t *dstb = out->data[1] + slice_start * out->linesize[1];
     uint8_t *dstr = out->data[2] + slice_start * out->linesize[2];
     uint8_t *dsta = out->data[3] + slice_start * out->linesize[3];
bffd0f7b
     const float max = s->max;
db8777ce
     int i, j;
 
0ef7a451
     for (i = slice_start; i < slice_end; i++) {
db8777ce
         for (j = 0; j < out->width; j++) {
bffd0f7b
             float r = srcr[j] / max;
             float g = srcg[j] / max;
             float b = srcb[j] / max;
             const float l = FFMAX3(r, g, b) + FFMIN3(r, g, b);
d19fdc83
 
             r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
             g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
             b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
 
             if (s->preserve_lightness)
                 preservel(&r, &g, &b, l);
 
             dstr[j] = av_clip_uint8(r * max);
             dstg[j] = av_clip_uint8(g * max);
             dstb[j] = av_clip_uint8(b * max);
db8777ce
             if (in != out && out->linesize[3])
                 dsta[j] = srca[j];
         }
 
         srcg += in->linesize[0];
         srcb += in->linesize[1];
         srcr += in->linesize[2];
         srca += in->linesize[3];
         dstg += out->linesize[0];
         dstb += out->linesize[1];
         dstr += out->linesize[2];
         dsta += out->linesize[3];
     }
0ef7a451
 
     return 0;
db8777ce
 }
 
08c46e40
 static int color_balance16_p(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
db8777ce
 {
     ColorBalanceContext *s = ctx->priv;
0ef7a451
     ThreadData *td = arg;
     AVFrame *in = td->in;
     AVFrame *out = td->out;
     const int slice_start = (out->height * jobnr) / nb_jobs;
     const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
     const uint16_t *srcg = (const uint16_t *)in->data[0] + slice_start * in->linesize[0] / 2;
     const uint16_t *srcb = (const uint16_t *)in->data[1] + slice_start * in->linesize[1] / 2;
     const uint16_t *srcr = (const uint16_t *)in->data[2] + slice_start * in->linesize[2] / 2;
     const uint16_t *srca = (const uint16_t *)in->data[3] + slice_start * in->linesize[3] / 2;
     uint16_t *dstg = (uint16_t *)out->data[0] + slice_start * out->linesize[0] / 2;
     uint16_t *dstb = (uint16_t *)out->data[1] + slice_start * out->linesize[1] / 2;
     uint16_t *dstr = (uint16_t *)out->data[2] + slice_start * out->linesize[2] / 2;
     uint16_t *dsta = (uint16_t *)out->data[3] + slice_start * out->linesize[3] / 2;
08c46e40
     const int depth = s->depth;
bffd0f7b
     const float max = s->max;
db8777ce
     int i, j;
 
0ef7a451
     for (i = slice_start; i < slice_end; i++) {
db8777ce
         for (j = 0; j < out->width; j++) {
bffd0f7b
             float r = srcr[j] / max;
             float g = srcg[j] / max;
             float b = srcb[j] / max;
             const float l = (FFMAX3(r, g, b) + FFMIN3(r, g, b));
d19fdc83
 
             r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
             g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
             b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
 
             if (s->preserve_lightness)
                 preservel(&r, &g, &b, l);
 
             dstr[j] = av_clip_uintp2_c(r * max, depth);
             dstg[j] = av_clip_uintp2_c(g * max, depth);
             dstb[j] = av_clip_uintp2_c(b * max, depth);
db8777ce
             if (in != out && out->linesize[3])
                 dsta[j] = srca[j];
         }
 
         srcg += in->linesize[0] / 2;
         srcb += in->linesize[1] / 2;
         srcr += in->linesize[2] / 2;
         srca += in->linesize[3] / 2;
         dstg += out->linesize[0] / 2;
         dstb += out->linesize[1] / 2;
         dstr += out->linesize[2] / 2;
         dsta += out->linesize[3] / 2;
     }
0ef7a451
 
     return 0;
db8777ce
 }
 
08c46e40
 static int color_balance8(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
c2fd69ba
 {
     ColorBalanceContext *s = ctx->priv;
0ef7a451
     ThreadData *td = arg;
     AVFrame *in = td->in;
     AVFrame *out = td->out;
c2fd69ba
     AVFilterLink *outlink = ctx->outputs[0];
0ef7a451
     const int slice_start = (out->height * jobnr) / nb_jobs;
     const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
     const uint8_t *srcrow = in->data[0] + slice_start * in->linesize[0];
c2fd69ba
     const uint8_t roffset = s->rgba_map[R];
     const uint8_t goffset = s->rgba_map[G];
     const uint8_t boffset = s->rgba_map[B];
     const uint8_t aoffset = s->rgba_map[A];
bffd0f7b
     const float max = s->max;
c2fd69ba
     const int step = s->step;
     uint8_t *dstrow;
     int i, j;
 
0ef7a451
     dstrow = out->data[0] + slice_start * out->linesize[0];
     for (i = slice_start; i < slice_end; i++) {
c2fd69ba
         const uint8_t *src = srcrow;
         uint8_t *dst = dstrow;
 
         for (j = 0; j < outlink->w * step; j += step) {
bffd0f7b
             float r = src[j + roffset] / max;
             float g = src[j + goffset] / max;
             float b = src[j + boffset] / max;
             const float l = (FFMAX3(r, g, b) + FFMIN3(r, g, b));
d19fdc83
 
             r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
             g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
             b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
 
             if (s->preserve_lightness)
                 preservel(&r, &g, &b, l);
 
             dst[j + roffset] = av_clip_uint8(r * max);
             dst[j + goffset] = av_clip_uint8(g * max);
             dst[j + boffset] = av_clip_uint8(b * max);
c2fd69ba
             if (in != out && step == 4)
                 dst[j + aoffset] = src[j + aoffset];
         }
 
         srcrow += in->linesize[0];
         dstrow += out->linesize[0];
     }
0ef7a451
 
     return 0;
c2fd69ba
 }
 
08c46e40
 static int color_balance16(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
c2fd69ba
 {
     ColorBalanceContext *s = ctx->priv;
0ef7a451
     ThreadData *td = arg;
     AVFrame *in = td->in;
     AVFrame *out = td->out;
c2fd69ba
     AVFilterLink *outlink = ctx->outputs[0];
0ef7a451
     const int slice_start = (out->height * jobnr) / nb_jobs;
     const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
     const uint16_t *srcrow = (const uint16_t *)in->data[0] + slice_start * in->linesize[0] / 2;
c2fd69ba
     const uint8_t roffset = s->rgba_map[R];
     const uint8_t goffset = s->rgba_map[G];
     const uint8_t boffset = s->rgba_map[B];
     const uint8_t aoffset = s->rgba_map[A];
     const int step = s->step / 2;
08c46e40
     const int depth = s->depth;
bffd0f7b
     const float max = s->max;
c2fd69ba
     uint16_t *dstrow;
     int i, j;
 
0ef7a451
     dstrow = (uint16_t *)out->data[0] + slice_start * out->linesize[0] / 2;
     for (i = slice_start; i < slice_end; i++) {
c2fd69ba
         const uint16_t *src = srcrow;
         uint16_t *dst = dstrow;
 
         for (j = 0; j < outlink->w * step; j += step) {
bffd0f7b
             float r = src[j + roffset] / max;
             float g = src[j + goffset] / max;
             float b = src[j + boffset] / max;
             const float l = (FFMAX3(r, g, b) + FFMIN3(r, g, b));
d19fdc83
 
             r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
             g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
             b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
 
             if (s->preserve_lightness)
                 preservel(&r, &g, &b, l);
 
             dst[j + roffset] = av_clip_uintp2_c(r * max, depth);
             dst[j + goffset] = av_clip_uintp2_c(g * max, depth);
             dst[j + boffset] = av_clip_uintp2_c(b * max, depth);
c2fd69ba
             if (in != out && step == 4)
                 dst[j + aoffset] = src[j + aoffset];
         }
 
         srcrow += in->linesize[0] / 2;
         dstrow += out->linesize[0] / 2;
     }
0ef7a451
 
     return 0;
c2fd69ba
 }
 
449cdd54
 static int config_output(AVFilterLink *outlink)
 {
     AVFilterContext *ctx = outlink->src;
231bf4d1
     ColorBalanceContext *s = ctx->priv;
449cdd54
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(outlink->format);
c2fd69ba
     const int depth = desc->comp[0].depth;
d19fdc83
     const int max = (1 << depth) - 1;
db8777ce
     const int planar = av_pix_fmt_count_planes(outlink->format) > 1;
08c46e40
 
     s->depth = depth;
d19fdc83
     s->max = max;
449cdd54
 
d19fdc83
     if (max == 255 && planar) {
08c46e40
         s->color_balance = color_balance8_p;
db8777ce
     } else if (planar) {
08c46e40
         s->color_balance = color_balance16_p;
d19fdc83
     } else if (max == 255) {
08c46e40
         s->color_balance = color_balance8;
c2fd69ba
     } else {
08c46e40
         s->color_balance = color_balance16;
449cdd54
     }
 
231bf4d1
     ff_fill_rgba_map(s->rgba_map, outlink->format);
     s->step = av_get_padded_bits_per_pixel(desc) >> 3;
449cdd54
 
     return 0;
 }
 
 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 {
     AVFilterContext *ctx = inlink->dst;
231bf4d1
     ColorBalanceContext *s = ctx->priv;
449cdd54
     AVFilterLink *outlink = ctx->outputs[0];
0ef7a451
     ThreadData td;
449cdd54
     AVFrame *out;
 
     if (av_frame_is_writable(in)) {
         out = in;
     } else {
         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
         if (!out) {
             av_frame_free(&in);
             return AVERROR(ENOMEM);
         }
         av_frame_copy_props(out, in);
     }
 
0ef7a451
     td.in = in;
     td.out = out;
08c46e40
     ctx->internal->execute(ctx, s->color_balance, &td, NULL, FFMIN(outlink->h, ff_filter_get_nb_threads(ctx)));
449cdd54
 
     if (in != out)
         av_frame_free(&in);
c2fd69ba
     return ff_filter_frame(outlink, out);
449cdd54
 }
 
 static const AVFilterPad colorbalance_inputs[] = {
     {
811b17fb
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .filter_frame = filter_frame,
449cdd54
     },
     { NULL }
 };
 
 static const AVFilterPad colorbalance_outputs[] = {
811b17fb
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .config_props = config_output,
     },
     { NULL }
449cdd54
 };
 
325f6e0a
 AVFilter ff_vf_colorbalance = {
449cdd54
     .name          = "colorbalance",
     .description   = NULL_IF_CONFIG_SMALL("Adjust the color balance."),
     .priv_size     = sizeof(ColorBalanceContext),
     .priv_class    = &colorbalance_class,
     .query_formats = query_formats,
     .inputs        = colorbalance_inputs,
     .outputs       = colorbalance_outputs,
0ef7a451
     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
45f03cdd
     .process_command = ff_filter_process_command,
449cdd54
 };