2 * Copyright (c) 2013 Paul B Mahol
4 * This file is part of FFmpeg.
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.
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.
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
21 #include "libavutil/opt.h"
22 #include "libavutil/pixdesc.h"
24 #include "drawutils.h"
34 typedef struct ThreadData {
38 typedef struct Range {
44 typedef struct ColorBalanceContext {
49 int preserve_lightness;
56 int (*color_balance)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
57 } ColorBalanceContext;
59 #define OFFSET(x) offsetof(ColorBalanceContext, x)
60 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
61 static const AVOption colorbalance_options[] = {
62 { "rs", "set red shadows", OFFSET(cyan_red.shadows), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
63 { "gs", "set green shadows", OFFSET(magenta_green.shadows), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
64 { "bs", "set blue shadows", OFFSET(yellow_blue.shadows), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
65 { "rm", "set red midtones", OFFSET(cyan_red.midtones), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
66 { "gm", "set green midtones", OFFSET(magenta_green.midtones), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
67 { "bm", "set blue midtones", OFFSET(yellow_blue.midtones), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
68 { "rh", "set red highlights", OFFSET(cyan_red.highlights), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
69 { "gh", "set green highlights", OFFSET(magenta_green.highlights), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
70 { "bh", "set blue highlights", OFFSET(yellow_blue.highlights), AV_OPT_TYPE_FLOAT, {.dbl=0}, -1, 1, FLAGS },
71 { "pl", "preserve lightness", OFFSET(preserve_lightness), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
75 AVFILTER_DEFINE_CLASS(colorbalance);
77 static int query_formats(AVFilterContext *ctx)
79 static const enum AVPixelFormat pix_fmts[] = {
80 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
81 AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
82 AV_PIX_FMT_ABGR, AV_PIX_FMT_ARGB,
83 AV_PIX_FMT_0BGR, AV_PIX_FMT_0RGB,
84 AV_PIX_FMT_RGB0, AV_PIX_FMT_BGR0,
85 AV_PIX_FMT_RGB48, AV_PIX_FMT_BGR48,
86 AV_PIX_FMT_RGBA64, AV_PIX_FMT_BGRA64,
87 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
89 AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
90 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
92 AV_PIX_FMT_GBRP16, AV_PIX_FMT_GBRAP16,
95 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
97 return AVERROR(ENOMEM);
98 return ff_set_common_formats(ctx, fmts_list);
101 static float get_component(float v, float l,
102 float s, float m, float h)
104 const float a = 4.f, b = 0.333f, scale = 0.7f;
106 s *= av_clipf((b - l) * a + 0.5f, 0, 1) * scale;
107 m *= av_clipf((l - b) * a + 0.5f, 0, 1) * av_clipf((1.0 - l - b) * a + 0.5f, 0, 1) * scale;
108 h *= av_clipf((l + b - 1) * a + 0.5f, 0, 1) * scale;
114 return av_clipf(v, 0, 1);
117 static float hfun(float n, float h, float s, float l)
119 float a = s * FFMIN(l, 1. - l);
120 float k = fmodf(n + h / 30.f, 12.f);
122 return av_clipf(l - a * FFMAX(FFMIN3(k - 3.f, 9.f - k, 1), -1.f), 0, 1);
125 static void preservel(float *r, float *g, float *b, float l)
127 float max = FFMAX3(*r, *g, *b);
128 float min = FFMIN3(*r, *g, *b);
133 if (*r == *g && *g == *b) {
135 } else if (max == *r) {
136 h = 60. * (0. + (*g - *b) / (max - min));
137 } else if (max == *g) {
138 h = 60. * (2. + (*b - *r) / (max - min));
139 } else if (max == *b) {
140 h = 60. * (4. + (*r - *g) / (max - min));
147 if (max == 0. || min == 1.) {
150 s = (max - min) / (1. - FFABS(2. * l - 1));
153 *r = hfun(0, h, s, l);
154 *g = hfun(8, h, s, l);
155 *b = hfun(4, h, s, l);
158 static int color_balance8_p(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
160 ColorBalanceContext *s = ctx->priv;
161 ThreadData *td = arg;
162 AVFrame *in = td->in;
163 AVFrame *out = td->out;
164 const int slice_start = (out->height * jobnr) / nb_jobs;
165 const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
166 const uint8_t *srcg = in->data[0] + slice_start * in->linesize[0];
167 const uint8_t *srcb = in->data[1] + slice_start * in->linesize[1];
168 const uint8_t *srcr = in->data[2] + slice_start * in->linesize[2];
169 const uint8_t *srca = in->data[3] + slice_start * in->linesize[3];
170 uint8_t *dstg = out->data[0] + slice_start * out->linesize[0];
171 uint8_t *dstb = out->data[1] + slice_start * out->linesize[1];
172 uint8_t *dstr = out->data[2] + slice_start * out->linesize[2];
173 uint8_t *dsta = out->data[3] + slice_start * out->linesize[3];
174 const float max = s->max;
177 for (i = slice_start; i < slice_end; i++) {
178 for (j = 0; j < out->width; j++) {
179 float r = srcr[j] / max;
180 float g = srcg[j] / max;
181 float b = srcb[j] / max;
182 const float l = FFMAX3(r, g, b) + FFMIN3(r, g, b);
184 r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
185 g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
186 b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
188 if (s->preserve_lightness)
189 preservel(&r, &g, &b, l);
191 dstr[j] = av_clip_uint8(lrintf(r * max));
192 dstg[j] = av_clip_uint8(lrintf(g * max));
193 dstb[j] = av_clip_uint8(lrintf(b * max));
194 if (in != out && out->linesize[3])
198 srcg += in->linesize[0];
199 srcb += in->linesize[1];
200 srcr += in->linesize[2];
201 srca += in->linesize[3];
202 dstg += out->linesize[0];
203 dstb += out->linesize[1];
204 dstr += out->linesize[2];
205 dsta += out->linesize[3];
211 static int color_balance16_p(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
213 ColorBalanceContext *s = ctx->priv;
214 ThreadData *td = arg;
215 AVFrame *in = td->in;
216 AVFrame *out = td->out;
217 const int slice_start = (out->height * jobnr) / nb_jobs;
218 const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
219 const uint16_t *srcg = (const uint16_t *)in->data[0] + slice_start * in->linesize[0] / 2;
220 const uint16_t *srcb = (const uint16_t *)in->data[1] + slice_start * in->linesize[1] / 2;
221 const uint16_t *srcr = (const uint16_t *)in->data[2] + slice_start * in->linesize[2] / 2;
222 const uint16_t *srca = (const uint16_t *)in->data[3] + slice_start * in->linesize[3] / 2;
223 uint16_t *dstg = (uint16_t *)out->data[0] + slice_start * out->linesize[0] / 2;
224 uint16_t *dstb = (uint16_t *)out->data[1] + slice_start * out->linesize[1] / 2;
225 uint16_t *dstr = (uint16_t *)out->data[2] + slice_start * out->linesize[2] / 2;
226 uint16_t *dsta = (uint16_t *)out->data[3] + slice_start * out->linesize[3] / 2;
227 const int depth = s->depth;
228 const float max = s->max;
231 for (i = slice_start; i < slice_end; i++) {
232 for (j = 0; j < out->width; j++) {
233 float r = srcr[j] / max;
234 float g = srcg[j] / max;
235 float b = srcb[j] / max;
236 const float l = (FFMAX3(r, g, b) + FFMIN3(r, g, b));
238 r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
239 g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
240 b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
242 if (s->preserve_lightness)
243 preservel(&r, &g, &b, l);
245 dstr[j] = av_clip_uintp2_c(lrintf(r * max), depth);
246 dstg[j] = av_clip_uintp2_c(lrintf(g * max), depth);
247 dstb[j] = av_clip_uintp2_c(lrintf(b * max), depth);
248 if (in != out && out->linesize[3])
252 srcg += in->linesize[0] / 2;
253 srcb += in->linesize[1] / 2;
254 srcr += in->linesize[2] / 2;
255 srca += in->linesize[3] / 2;
256 dstg += out->linesize[0] / 2;
257 dstb += out->linesize[1] / 2;
258 dstr += out->linesize[2] / 2;
259 dsta += out->linesize[3] / 2;
265 static int color_balance8(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
267 ColorBalanceContext *s = ctx->priv;
268 ThreadData *td = arg;
269 AVFrame *in = td->in;
270 AVFrame *out = td->out;
271 AVFilterLink *outlink = ctx->outputs[0];
272 const int slice_start = (out->height * jobnr) / nb_jobs;
273 const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
274 const uint8_t *srcrow = in->data[0] + slice_start * in->linesize[0];
275 const uint8_t roffset = s->rgba_map[R];
276 const uint8_t goffset = s->rgba_map[G];
277 const uint8_t boffset = s->rgba_map[B];
278 const uint8_t aoffset = s->rgba_map[A];
279 const float max = s->max;
280 const int step = s->step;
284 dstrow = out->data[0] + slice_start * out->linesize[0];
285 for (i = slice_start; i < slice_end; i++) {
286 const uint8_t *src = srcrow;
287 uint8_t *dst = dstrow;
289 for (j = 0; j < outlink->w * step; j += step) {
290 float r = src[j + roffset] / max;
291 float g = src[j + goffset] / max;
292 float b = src[j + boffset] / max;
293 const float l = (FFMAX3(r, g, b) + FFMIN3(r, g, b));
295 r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
296 g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
297 b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
299 if (s->preserve_lightness)
300 preservel(&r, &g, &b, l);
302 dst[j + roffset] = av_clip_uint8(lrintf(r * max));
303 dst[j + goffset] = av_clip_uint8(lrintf(g * max));
304 dst[j + boffset] = av_clip_uint8(lrintf(b * max));
305 if (in != out && step == 4)
306 dst[j + aoffset] = src[j + aoffset];
309 srcrow += in->linesize[0];
310 dstrow += out->linesize[0];
316 static int color_balance16(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
318 ColorBalanceContext *s = ctx->priv;
319 ThreadData *td = arg;
320 AVFrame *in = td->in;
321 AVFrame *out = td->out;
322 AVFilterLink *outlink = ctx->outputs[0];
323 const int slice_start = (out->height * jobnr) / nb_jobs;
324 const int slice_end = (out->height * (jobnr+1)) / nb_jobs;
325 const uint16_t *srcrow = (const uint16_t *)in->data[0] + slice_start * in->linesize[0] / 2;
326 const uint8_t roffset = s->rgba_map[R];
327 const uint8_t goffset = s->rgba_map[G];
328 const uint8_t boffset = s->rgba_map[B];
329 const uint8_t aoffset = s->rgba_map[A];
330 const int step = s->step / 2;
331 const int depth = s->depth;
332 const float max = s->max;
336 dstrow = (uint16_t *)out->data[0] + slice_start * out->linesize[0] / 2;
337 for (i = slice_start; i < slice_end; i++) {
338 const uint16_t *src = srcrow;
339 uint16_t *dst = dstrow;
341 for (j = 0; j < outlink->w * step; j += step) {
342 float r = src[j + roffset] / max;
343 float g = src[j + goffset] / max;
344 float b = src[j + boffset] / max;
345 const float l = (FFMAX3(r, g, b) + FFMIN3(r, g, b));
347 r = get_component(r, l, s->cyan_red.shadows, s->cyan_red.midtones, s->cyan_red.highlights);
348 g = get_component(g, l, s->magenta_green.shadows, s->magenta_green.midtones, s->magenta_green.highlights);
349 b = get_component(b, l, s->yellow_blue.shadows, s->yellow_blue.midtones, s->yellow_blue.highlights);
351 if (s->preserve_lightness)
352 preservel(&r, &g, &b, l);
354 dst[j + roffset] = av_clip_uintp2_c(lrintf(r * max), depth);
355 dst[j + goffset] = av_clip_uintp2_c(lrintf(g * max), depth);
356 dst[j + boffset] = av_clip_uintp2_c(lrintf(b * max), depth);
357 if (in != out && step == 4)
358 dst[j + aoffset] = src[j + aoffset];
361 srcrow += in->linesize[0] / 2;
362 dstrow += out->linesize[0] / 2;
368 static int config_output(AVFilterLink *outlink)
370 AVFilterContext *ctx = outlink->src;
371 ColorBalanceContext *s = ctx->priv;
372 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(outlink->format);
373 const int depth = desc->comp[0].depth;
374 const int max = (1 << depth) - 1;
375 const int planar = av_pix_fmt_count_planes(outlink->format) > 1;
380 if (max == 255 && planar) {
381 s->color_balance = color_balance8_p;
383 s->color_balance = color_balance16_p;
384 } else if (max == 255) {
385 s->color_balance = color_balance8;
387 s->color_balance = color_balance16;
390 ff_fill_rgba_map(s->rgba_map, outlink->format);
391 s->step = av_get_padded_bits_per_pixel(desc) >> 3;
396 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
398 AVFilterContext *ctx = inlink->dst;
399 ColorBalanceContext *s = ctx->priv;
400 AVFilterLink *outlink = ctx->outputs[0];
404 if (av_frame_is_writable(in)) {
407 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
410 return AVERROR(ENOMEM);
412 av_frame_copy_props(out, in);
417 ctx->internal->execute(ctx, s->color_balance, &td, NULL, FFMIN(outlink->h, ff_filter_get_nb_threads(ctx)));
421 return ff_filter_frame(outlink, out);
424 static const AVFilterPad colorbalance_inputs[] = {
427 .type = AVMEDIA_TYPE_VIDEO,
428 .filter_frame = filter_frame,
433 static const AVFilterPad colorbalance_outputs[] = {
436 .type = AVMEDIA_TYPE_VIDEO,
437 .config_props = config_output,
442 AVFilter ff_vf_colorbalance = {
443 .name = "colorbalance",
444 .description = NULL_IF_CONFIG_SMALL("Adjust the color balance."),
445 .priv_size = sizeof(ColorBalanceContext),
446 .priv_class = &colorbalance_class,
447 .query_formats = query_formats,
448 .inputs = colorbalance_inputs,
449 .outputs = colorbalance_outputs,
450 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
451 .process_command = ff_filter_process_command,