2 * Copyright (c) 2013 Clément Bœsch
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/bprint.h"
23 #include "libavutil/eval.h"
24 #include "libavutil/file.h"
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/avassert.h"
34 struct keypoint *next;
41 PRESET_COLOR_NEGATIVE,
44 PRESET_INCREASE_CONTRAST,
46 PRESET_LINEAR_CONTRAST,
47 PRESET_MEDIUM_CONTRAST,
49 PRESET_STRONG_CONTRAST,
57 char *comp_points_str[NB_COMP + 1];
58 char *comp_points_str_all;
59 uint8_t graph[NB_COMP + 1][256];
63 #define OFFSET(x) offsetof(CurvesContext, x)
64 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
65 static const AVOption curves_options[] = {
66 { "preset", "select a color curves preset", OFFSET(preset), AV_OPT_TYPE_INT, {.i64=PRESET_NONE}, PRESET_NONE, NB_PRESETS-1, FLAGS, "preset_name" },
67 { "none", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_NONE}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
68 { "color_negative", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_COLOR_NEGATIVE}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
69 { "cross_process", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_CROSS_PROCESS}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
70 { "darker", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_DARKER}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
71 { "increase_contrast", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_INCREASE_CONTRAST}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
72 { "lighter", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_LIGHTER}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
73 { "linear_contrast", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_LINEAR_CONTRAST}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
74 { "medium_contrast", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_MEDIUM_CONTRAST}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
75 { "negative", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_NEGATIVE}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
76 { "strong_contrast", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_STRONG_CONTRAST}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
77 { "vintage", NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_VINTAGE}, INT_MIN, INT_MAX, FLAGS, "preset_name" },
78 { "master","set master points coordinates",OFFSET(comp_points_str[NB_COMP]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
79 { "m", "set master points coordinates",OFFSET(comp_points_str[NB_COMP]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
80 { "red", "set red points coordinates", OFFSET(comp_points_str[0]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
81 { "r", "set red points coordinates", OFFSET(comp_points_str[0]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
82 { "green", "set green points coordinates", OFFSET(comp_points_str[1]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
83 { "g", "set green points coordinates", OFFSET(comp_points_str[1]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
84 { "blue", "set blue points coordinates", OFFSET(comp_points_str[2]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
85 { "b", "set blue points coordinates", OFFSET(comp_points_str[2]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
86 { "all", "set points coordinates for all components", OFFSET(comp_points_str_all), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
87 { "psfile", "set Photoshop curves file name", OFFSET(psfile), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
91 AVFILTER_DEFINE_CLASS(curves);
98 } curves_presets[] = {
99 [PRESET_COLOR_NEGATIVE] = {
100 "0/1 0.129/1 0.466/0.498 0.725/0 1/0",
101 "0/1 0.109/1 0.301/0.498 0.517/0 1/0",
102 "0/1 0.098/1 0.235/0.498 0.423/0 1/0",
104 [PRESET_CROSS_PROCESS] = {
105 "0.25/0.156 0.501/0.501 0.686/0.745",
106 "0.25/0.188 0.38/0.501 0.745/0.815 1/0.815",
107 "0.231/0.094 0.709/0.874",
109 [PRESET_DARKER] = { .master = "0.5/0.4" },
110 [PRESET_INCREASE_CONTRAST] = { .master = "0.149/0.066 0.831/0.905 0.905/0.98" },
111 [PRESET_LIGHTER] = { .master = "0.4/0.5" },
112 [PRESET_LINEAR_CONTRAST] = { .master = "0.305/0.286 0.694/0.713" },
113 [PRESET_MEDIUM_CONTRAST] = { .master = "0.286/0.219 0.639/0.643" },
114 [PRESET_NEGATIVE] = { .master = "0/1 1/0" },
115 [PRESET_STRONG_CONTRAST] = { .master = "0.301/0.196 0.592/0.6 0.686/0.737" },
117 "0/0.11 0.42/0.51 1/0.95",
119 "0/0.22 0.49/0.44 1/0.8",
123 static struct keypoint *make_point(double x, double y, struct keypoint *next)
125 struct keypoint *point = av_mallocz(sizeof(*point));
135 static int parse_points_str(AVFilterContext *ctx, struct keypoint **points, const char *s)
137 char *p = (char *)s; // strtod won't alter the string
138 struct keypoint *last = NULL;
140 /* construct a linked list based on the key points string */
142 struct keypoint *point = make_point(0, 0, NULL);
144 return AVERROR(ENOMEM);
145 point->x = av_strtod(p, &p); if (p && *p) p++;
146 point->y = av_strtod(p, &p); if (p && *p) p++;
147 if (point->x < 0 || point->x > 1 || point->y < 0 || point->y > 1) {
148 av_log(ctx, AV_LOG_ERROR, "Invalid key point coordinates (%f;%f), "
149 "x and y must be in the [0;1] range.\n", point->x, point->y);
150 return AVERROR(EINVAL);
155 if ((int)(last->x * 255) >= (int)(point->x * 255)) {
156 av_log(ctx, AV_LOG_ERROR, "Key point coordinates (%f;%f) "
157 "and (%f;%f) are too close from each other or not "
158 "strictly increasing on the x-axis\n",
159 last->x, last->y, point->x, point->y);
160 return AVERROR(EINVAL);
167 /* auto insert first key point if missing at x=0 */
169 last = make_point(0, 0, NULL);
171 return AVERROR(ENOMEM);
172 last->x = last->y = 0;
174 } else if ((*points)->x != 0.) {
175 struct keypoint *newfirst = make_point(0, 0, *points);
177 return AVERROR(ENOMEM);
183 /* auto insert last key point if missing at x=1 */
185 struct keypoint *point = make_point(1, 1, NULL);
187 return AVERROR(ENOMEM);
194 static int get_nb_points(const struct keypoint *d)
205 * Natural cubic spline interpolation
206 * Finding curves using Cubic Splines notes by Steven Rauch and John Stockie.
207 * @see http://people.math.sfu.ca/~stockie/teaching/macm316/notes/splines.pdf
209 static int interpolate(AVFilterContext *ctx, uint8_t *y, const struct keypoint *points)
212 const struct keypoint *point;
215 int n = get_nb_points(points); // number of splines
217 double (*matrix)[3] = av_calloc(n, sizeof(*matrix));
218 double *h = av_malloc((n - 1) * sizeof(*h));
219 double *r = av_calloc(n, sizeof(*r));
221 if (!matrix || !h || !r) {
222 ret = AVERROR(ENOMEM);
226 /* h(i) = x(i+1) - x(i) */
228 for (point = points; point; point = point->next) {
230 h[i] = point->x - xprev;
235 /* right-side of the polynomials, will be modified to contains the solution */
237 for (i = 1; i < n - 1; i++) {
238 double yp = point->y,
240 yn = point->next->next->y;
241 r[i] = 6 * ((yn-yc)/h[i] - (yc-yp)/h[i-1]);
245 #define B 0 /* sub diagonal (below main) */
246 #define M 1 /* main diagonal (center) */
247 #define A 2 /* sup diagonal (above main) */
249 /* left side of the polynomials into a tridiagonal matrix. */
250 matrix[0][M] = matrix[n - 1][M] = 1;
251 for (i = 1; i < n - 1; i++) {
252 matrix[i][B] = h[i-1];
253 matrix[i][M] = 2 * (h[i-1] + h[i]);
257 /* tridiagonal solving of the linear system */
258 for (i = 1; i < n; i++) {
259 double den = matrix[i][M] - matrix[i][B] * matrix[i-1][A];
260 double k = den ? 1./den : 1.;
262 r[i] = (r[i] - matrix[i][B] * r[i - 1]) * k;
264 for (i = n - 2; i >= 0; i--)
265 r[i] = r[i] - matrix[i][A] * r[i + 1];
267 /* compute the graph with x=[0..255] */
270 av_assert0(point->next); // always at least 2 key points
271 while (point->next) {
272 double yc = point->y;
273 double yn = point->next->y;
276 double b = (yn-yc)/h[i] - h[i]*r[i]/2. - h[i]*(r[i+1]-r[i])/6.;
277 double c = r[i] / 2.;
278 double d = (r[i+1] - r[i]) / (6.*h[i]);
281 int x_start = point->x * 255;
282 int x_end = point->next->x * 255;
284 av_assert0(x_start >= 0 && x_start <= 255 &&
285 x_end >= 0 && x_end <= 255);
287 for (x = x_start; x <= x_end; x++) {
288 double xx = (x - x_start) * 1/255.;
289 double yy = a + b*xx + c*xx*xx + d*xx*xx*xx;
290 y[x] = av_clipf(yy, 0, 1) * 255;
291 av_log(ctx, AV_LOG_DEBUG, "f(%f)=%f -> y[%d]=%d\n", xx, yy, x, y[x]);
305 static int parse_psfile(AVFilterContext *ctx, const char *fname)
307 CurvesContext *curves = ctx->priv;
310 int i, ret, av_unused(version), nb_curves;
312 static const int comp_ids[] = {3, 0, 1, 2};
314 av_bprint_init(&ptstr, 0, AV_BPRINT_SIZE_AUTOMATIC);
316 ret = av_file_map(fname, &buf, &size, 0, NULL);
320 #define READ16(dst) do { \
322 return AVERROR_INVALIDDATA; \
323 dst = AV_RB16(buf); \
330 for (i = 0; i < FFMIN(nb_curves, FF_ARRAY_ELEMS(comp_ids)); i++) {
332 av_bprint_clear(&ptstr);
334 for (n = 0; n < nb_points; n++) {
338 av_bprintf(&ptstr, "%f/%f ", x / 255., y / 255.);
341 char **pts = &curves->comp_points_str[comp_ids[i]];
343 *pts = av_strdup(ptstr.str);
344 av_log(ctx, AV_LOG_DEBUG, "curves %d (intid=%d) [%d points]: [%s]\n",
345 i, comp_ids[i], nb_points, *pts);
347 ret = AVERROR(ENOMEM);
354 av_bprint_finalize(&ptstr, NULL);
355 av_file_unmap(buf, size);
359 static av_cold int init(AVFilterContext *ctx)
362 CurvesContext *curves = ctx->priv;
363 struct keypoint *comp_points[NB_COMP + 1] = {0};
364 char **pts = curves->comp_points_str;
365 const char *allp = curves->comp_points_str_all;
367 //if (!allp && curves->preset != PRESET_NONE && curves_presets[curves->preset].all)
368 // allp = curves_presets[curves->preset].all;
371 for (i = 0; i < NB_COMP; i++) {
373 pts[i] = av_strdup(allp);
375 return AVERROR(ENOMEM);
379 if (curves->psfile) {
380 ret = parse_psfile(ctx, curves->psfile);
385 if (curves->preset != PRESET_NONE) {
386 #define SET_COMP_IF_NOT_SET(n, name) do { \
387 if (!pts[n] && curves_presets[curves->preset].name) { \
388 pts[n] = av_strdup(curves_presets[curves->preset].name); \
390 return AVERROR(ENOMEM); \
393 SET_COMP_IF_NOT_SET(0, r);
394 SET_COMP_IF_NOT_SET(1, g);
395 SET_COMP_IF_NOT_SET(2, b);
396 SET_COMP_IF_NOT_SET(3, master);
399 for (i = 0; i < NB_COMP + 1; i++) {
400 ret = parse_points_str(ctx, comp_points + i, curves->comp_points_str[i]);
403 ret = interpolate(ctx, curves->graph[i], comp_points[i]);
409 for (i = 0; i < NB_COMP; i++)
410 for (j = 0; j < 256; j++)
411 curves->graph[i][j] = curves->graph[NB_COMP][curves->graph[i][j]];
414 if (av_log_get_level() >= AV_LOG_VERBOSE) {
415 for (i = 0; i < NB_COMP; i++) {
416 struct keypoint *point = comp_points[i];
417 av_log(ctx, AV_LOG_VERBOSE, "#%d points:", i);
419 av_log(ctx, AV_LOG_VERBOSE, " (%f;%f)", point->x, point->y);
422 av_log(ctx, AV_LOG_VERBOSE, "\n");
423 av_log(ctx, AV_LOG_VERBOSE, "#%d values:", i);
424 for (j = 0; j < 256; j++)
425 av_log(ctx, AV_LOG_VERBOSE, " %02X", curves->graph[i][j]);
426 av_log(ctx, AV_LOG_VERBOSE, "\n");
430 for (i = 0; i < NB_COMP + 1; i++) {
431 struct keypoint *point = comp_points[i];
433 struct keypoint *next = point->next;
442 static int query_formats(AVFilterContext *ctx)
444 static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_RGB24, AV_PIX_FMT_NONE};
445 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
449 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
451 int x, y, i, direct = 0;
452 AVFilterContext *ctx = inlink->dst;
453 CurvesContext *curves = ctx->priv;
454 AVFilterLink *outlink = inlink->dst->outputs[0];
459 if (av_frame_is_writable(in)) {
463 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
466 return AVERROR(ENOMEM);
468 av_frame_copy_props(out, in);
474 for (y = 0; y < inlink->h; y++) {
476 const uint8_t *srcp = src;
478 for (x = 0; x < inlink->w; x++)
479 for (i = 0; i < NB_COMP; i++, dstp++, srcp++)
480 *dstp = curves->graph[i][*srcp];
481 dst += out->linesize[0];
482 src += in ->linesize[0];
488 return ff_filter_frame(outlink, out);
491 static const AVFilterPad curves_inputs[] = {
494 .type = AVMEDIA_TYPE_VIDEO,
495 .filter_frame = filter_frame,
500 static const AVFilterPad curves_outputs[] = {
503 .type = AVMEDIA_TYPE_VIDEO,
508 AVFilter avfilter_vf_curves = {
510 .description = NULL_IF_CONFIG_SMALL("Adjust components curves."),
511 .priv_size = sizeof(CurvesContext),
513 .query_formats = query_formats,
514 .inputs = curves_inputs,
515 .outputs = curves_outputs,
516 .priv_class = &curves_class,