2 * Copyright (c) 2015 Clément Bœsch <u pkh me>
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
23 * - use integers so it can be made bitexact and a FATE test can be added
27 #include "libavutil/avassert.h"
28 #include "libavutil/file.h"
29 #include "libavutil/intreadwrite.h"
30 #include "libavutil/opt.h"
37 // WARNING: do NOT reorder (see parse_psfile())
50 enum correction_method {
51 CORRECTION_METHOD_ABSOLUTE,
52 CORRECTION_METHOD_RELATIVE,
53 NB_CORRECTION_METHODS,
56 static const char *color_names[NB_RANGES] = {
57 "red", "yellow", "green", "cyan", "blue", "magenta", "white", "neutral", "black"
60 typedef int (*get_adjust_range_func)(int r, int g, int b, int min_val, int max_val);
62 struct process_range {
65 get_adjust_range_func get_adjust_range;
68 typedef struct ThreadData {
74 int correction_method;
75 char *opt_cmyk_adjust[NB_RANGES];
76 float cmyk_adjust[NB_RANGES][4];
77 struct process_range process_ranges[NB_RANGES]; // color ranges to process
78 int nb_process_ranges;
80 } SelectiveColorContext;
82 #define OFFSET(x) offsetof(SelectiveColorContext, x)
83 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
84 #define RANGE_OPTION(color_name, range) \
85 { color_name"s", "adjust "color_name" regions", OFFSET(opt_cmyk_adjust[range]), AV_OPT_TYPE_STRING, {.str=NULL}, CHAR_MIN, CHAR_MAX, FLAGS }
87 static const AVOption selectivecolor_options[] = {
88 { "correction_method", "select correction method", OFFSET(correction_method), AV_OPT_TYPE_INT, {.i64 = CORRECTION_METHOD_ABSOLUTE}, 0, NB_CORRECTION_METHODS-1, FLAGS, "correction_method" },
89 { "absolute", NULL, 0, AV_OPT_TYPE_CONST, {.i64=CORRECTION_METHOD_ABSOLUTE}, INT_MIN, INT_MAX, FLAGS, "correction_method" },
90 { "relative", NULL, 0, AV_OPT_TYPE_CONST, {.i64=CORRECTION_METHOD_RELATIVE}, INT_MIN, INT_MAX, FLAGS, "correction_method" },
91 RANGE_OPTION("red", RANGE_REDS),
92 RANGE_OPTION("yellow", RANGE_YELLOWS),
93 RANGE_OPTION("green", RANGE_GREENS),
94 RANGE_OPTION("cyan", RANGE_CYANS),
95 RANGE_OPTION("blue", RANGE_BLUES),
96 RANGE_OPTION("magenta", RANGE_MAGENTAS),
97 RANGE_OPTION("white", RANGE_WHITES),
98 RANGE_OPTION("neutral", RANGE_NEUTRALS),
99 RANGE_OPTION("black", RANGE_BLACKS),
100 { "psfile", "set Photoshop selectivecolor file name", OFFSET(psfile), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
104 AVFILTER_DEFINE_CLASS(selectivecolor);
106 static inline int get_mid_val(int r, int g, int b)
108 if ((r < g && r > b) || (r < b && r > g)) return r;
109 if ((g < r && g > b) || (g < b && g > r)) return g;
110 if ((b < r && b > g) || (b < g && b > r)) return b;
114 static int get_rgb_adjust_range(int r, int g, int b, int min_val, int max_val)
117 const int mid_val = get_mid_val(r, g, b);
119 // XXX: can be simplified
120 if ((r != min_val && g == min_val && b == min_val) ||
121 (r == min_val && g != min_val && b == min_val) ||
122 (r == min_val && g == min_val && b != min_val))
123 return max_val - min_val;
126 return max_val - mid_val;
129 static int get_cmy_adjust_range(int r, int g, int b, int min_val, int max_val)
132 const int mid_val = get_mid_val(r, g, b);
134 // XXX: refactor with rgb
135 if ((r != max_val && g == max_val && b == max_val) ||
136 (r == max_val && g != max_val && b == max_val) ||
137 (r == max_val && g == max_val && b != max_val))
138 return max_val - min_val;
141 return mid_val - min_val;
144 static int get_neutrals_adjust_range(int r, int g, int b, int min_val, int max_val)
146 // 1 - (|max-0.5| + |min-0.5|)
147 return (255*2 - (abs((max_val<<1) - 255) + abs((min_val<<1) - 255)) + 1) >> 1;
150 static int get_whites_adjust_range(int r, int g, int b, int min_val, int max_val)
153 return (min_val<<1) - 255;
156 static int get_blacks_adjust_range(int r, int g, int b, int min_val, int max_val)
159 return 255 - (max_val<<1);
162 static int register_range(SelectiveColorContext *s, int range_id)
164 const float *cmyk = s->cmyk_adjust[range_id];
166 /* If the color range has user settings, register the color range
167 * as "to be processed" */
168 if (cmyk[0] || cmyk[1] || cmyk[2] || cmyk[3]) {
169 struct process_range *pr = &s->process_ranges[s->nb_process_ranges++];
171 if (cmyk[0] < -1.0 || cmyk[0] > 1.0 ||
172 cmyk[1] < -1.0 || cmyk[1] > 1.0 ||
173 cmyk[2] < -1.0 || cmyk[2] > 1.0 ||
174 cmyk[3] < -1.0 || cmyk[3] > 1.0) {
175 av_log(s, AV_LOG_ERROR, "Invalid %s adjustments (%g %g %g %g). "
176 "Settings must be set in [-1;1] range\n",
177 color_names[range_id], cmyk[0], cmyk[1], cmyk[2], cmyk[3]);
178 return AVERROR(EINVAL);
181 pr->range_id = range_id;
182 pr->mask = 1 << range_id;
183 if (pr->mask & (1<<RANGE_REDS | 1<<RANGE_GREENS | 1<<RANGE_BLUES)) pr->get_adjust_range = get_rgb_adjust_range;
184 else if (pr->mask & (1<<RANGE_CYANS | 1<<RANGE_MAGENTAS | 1<<RANGE_YELLOWS)) pr->get_adjust_range = get_cmy_adjust_range;
185 else if (pr->mask & 1<<RANGE_WHITES) pr->get_adjust_range = get_whites_adjust_range;
186 else if (pr->mask & 1<<RANGE_NEUTRALS) pr->get_adjust_range = get_neutrals_adjust_range;
187 else if (pr->mask & 1<<RANGE_BLACKS) pr->get_adjust_range = get_blacks_adjust_range;
194 static int parse_psfile(AVFilterContext *ctx, const char *fname)
200 SelectiveColorContext *s = ctx->priv;
202 ret = av_file_map(fname, &buf, &size, 0, NULL);
206 #define READ16(dst) do { \
208 ret = AVERROR_INVALIDDATA; \
211 dst = AV_RB16(buf); \
218 av_log(s, AV_LOG_WARNING, "Unsupported selective color file version %d, "
219 "the settings might not be loaded properly\n", version);
221 READ16(s->correction_method);
223 // 1st CMYK entry is reserved/unused
224 for (i = 0; i < FF_ARRAY_ELEMS(s->cmyk_adjust[0]); i++) {
227 av_log(s, AV_LOG_WARNING, "%c value of first CMYK entry is not 0 "
228 "but %d\n", "CMYK"[i], val);
231 for (i = 0; i < FF_ARRAY_ELEMS(s->cmyk_adjust); i++) {
233 for (k = 0; k < FF_ARRAY_ELEMS(s->cmyk_adjust[0]); k++) {
235 s->cmyk_adjust[i][k] = val / 100.;
237 ret = register_range(s, i);
243 av_file_unmap(buf, size);
247 static av_cold int init(AVFilterContext *ctx)
250 SelectiveColorContext *s = ctx->priv;
252 /* If the following conditions are not met, it will cause trouble while
253 * parsing the PS file */
254 av_assert0(FF_ARRAY_ELEMS(s->cmyk_adjust) == 10 - 1);
255 av_assert0(FF_ARRAY_ELEMS(s->cmyk_adjust[0]) == 4);
258 ret = parse_psfile(ctx, s->psfile);
262 for (i = 0; i < FF_ARRAY_ELEMS(s->opt_cmyk_adjust); i++) {
263 const char *opt_cmyk_adjust = s->opt_cmyk_adjust[i];
265 if (opt_cmyk_adjust) {
266 float *cmyk = s->cmyk_adjust[i];
268 sscanf(s->opt_cmyk_adjust[i], "%f %f %f %f", cmyk, cmyk+1, cmyk+2, cmyk+3);
269 ret = register_range(s, i);
276 av_log(s, AV_LOG_VERBOSE, "Adjustments:%s\n", s->nb_process_ranges ? "" : " none");
277 for (i = 0; i < s->nb_process_ranges; i++) {
278 const struct process_range *pr = &s->process_ranges[i];
279 const float *cmyk = s->cmyk_adjust[pr->range_id];
281 av_log(s, AV_LOG_VERBOSE, "%8ss: C=%6g M=%6g Y=%6g K=%6g\n",
282 color_names[pr->range_id], cmyk[0], cmyk[1], cmyk[2], cmyk[3]);
288 static int query_formats(AVFilterContext *ctx)
290 static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_RGB32, AV_PIX_FMT_0RGB32, AV_PIX_FMT_NONE};
291 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
293 return AVERROR(ENOMEM);
294 return ff_set_common_formats(ctx, fmts_list);
297 static inline int comp_adjust(int adjust_range, float value, float adjust, float k, int correction_method)
299 const float min = -value;
300 const float max = 1. - value;
301 float res = (-1. - adjust) * k - adjust;
302 if (correction_method == CORRECTION_METHOD_RELATIVE)
304 return lrint(av_clipf(res, min, max) * adjust_range);
307 static inline int selective_color(AVFilterContext *ctx, ThreadData *td,
308 int jobnr, int nb_jobs, int direct, int correction_method)
311 const AVFrame *in = td->in;
312 AVFrame *out = td->out;
313 const SelectiveColorContext *s = ctx->priv;
314 const int height = in->height;
315 const int width = in->width;
316 const int slice_start = (height * jobnr ) / nb_jobs;
317 const int slice_end = (height * (jobnr+1)) / nb_jobs;
318 const int dst_linesize = out->linesize[0];
319 const int src_linesize = in->linesize[0];
320 uint8_t *dst = out->data[0] + slice_start * dst_linesize;
321 const uint8_t *src = in->data[0] + slice_start * src_linesize;
323 for (y = slice_start; y < slice_end; y++) {
324 const uint32_t *src32 = (const uint32_t *)src;
325 uint32_t *dst32 = (uint32_t *)dst;
327 for (x = 0; x < width; x++) {
328 const uint32_t color = *src32++;
329 const int r = color >> 16 & 0xff;
330 const int g = color >> 8 & 0xff;
331 const int b = color & 0xff;
332 const int min_color = FFMIN3(r, g, b);
333 const int max_color = FFMAX3(r, g, b);
334 const uint32_t range_flag = (r == max_color) << RANGE_REDS
335 | (r == min_color) << RANGE_CYANS
336 | (g == max_color) << RANGE_GREENS
337 | (g == min_color) << RANGE_MAGENTAS
338 | (b == max_color) << RANGE_BLUES
339 | (b == min_color) << RANGE_YELLOWS
340 | (r > 128 && g > 128 && b > 128) << RANGE_WHITES
341 | (color && (color & 0xffffff) != 0xffffff) << RANGE_NEUTRALS
342 | (r < 128 && g < 128 && b < 128) << RANGE_BLACKS;
344 const float rnorm = r / 255.;
345 const float gnorm = g / 255.;
346 const float bnorm = b / 255.;
347 int adjust_r = 0, adjust_g = 0, adjust_b = 0;
349 for (i = 0; i < s->nb_process_ranges; i++) {
350 const struct process_range *pr = &s->process_ranges[i];
352 if (range_flag & pr->mask) {
353 const int adjust_range = pr->get_adjust_range(r, g, b, min_color, max_color);
355 if (adjust_range > 0) {
356 const float *cmyk_adjust = s->cmyk_adjust[pr->range_id];
357 const float adj_c = cmyk_adjust[0];
358 const float adj_m = cmyk_adjust[1];
359 const float adj_y = cmyk_adjust[2];
360 const float k = cmyk_adjust[3];
362 adjust_r += comp_adjust(adjust_range, rnorm, adj_c, k, correction_method);
363 adjust_g += comp_adjust(adjust_range, gnorm, adj_m, k, correction_method);
364 adjust_b += comp_adjust(adjust_range, bnorm, adj_y, k, correction_method);
369 if (!direct || adjust_r || adjust_g || adjust_b)
370 *dst32 = (color & 0xff000000)
371 | av_clip_uint8(r + adjust_r) << 16
372 | av_clip_uint8(g + adjust_g) << 8
373 | av_clip_uint8(b + adjust_b);
382 #define DEF_SELECTIVE_COLOR_FUNC(name, direct, correction_method) \
383 static int selective_color_##name(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs) \
385 return selective_color(ctx, arg, jobnr, nb_jobs, direct, correction_method); \
388 DEF_SELECTIVE_COLOR_FUNC(indirect_absolute, 0, CORRECTION_METHOD_ABSOLUTE)
389 DEF_SELECTIVE_COLOR_FUNC(indirect_relative, 0, CORRECTION_METHOD_RELATIVE)
390 DEF_SELECTIVE_COLOR_FUNC( direct_absolute, 1, CORRECTION_METHOD_ABSOLUTE)
391 DEF_SELECTIVE_COLOR_FUNC( direct_relative, 1, CORRECTION_METHOD_RELATIVE)
393 typedef int (*selective_color_func_type)(AVFilterContext *ctx, void *td, int jobnr, int nb_jobs);
395 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
397 AVFilterContext *ctx = inlink->dst;
398 AVFilterLink *outlink = ctx->outputs[0];
402 const SelectiveColorContext *s = ctx->priv;
403 static const selective_color_func_type funcs[2][2] = {
404 {selective_color_indirect_absolute, selective_color_indirect_relative},
405 {selective_color_direct_absolute, selective_color_direct_relative},
408 if (av_frame_is_writable(in)) {
413 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
416 return AVERROR(ENOMEM);
418 av_frame_copy_props(out, in);
423 ctx->internal->execute(ctx, funcs[direct][s->correction_method], &td, NULL,
424 FFMIN(inlink->h, ctx->graph->nb_threads));
428 return ff_filter_frame(outlink, out);
431 static const AVFilterPad selectivecolor_inputs[] = {
434 .type = AVMEDIA_TYPE_VIDEO,
435 .filter_frame = filter_frame,
440 static const AVFilterPad selectivecolor_outputs[] = {
443 .type = AVMEDIA_TYPE_VIDEO,
448 AVFilter ff_vf_selectivecolor = {
449 .name = "selectivecolor",
450 .description = NULL_IF_CONFIG_SMALL("Apply CMYK adjustments to specific color ranges."),
451 .priv_size = sizeof(SelectiveColorContext),
453 .query_formats = query_formats,
454 .inputs = selectivecolor_inputs,
455 .outputs = selectivecolor_outputs,
456 .priv_class = &selectivecolor_class,
457 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,