lavfi/curves: do not automatically insert points at x=0 and x=1
[ffmpeg.git] / libavfilter / vf_curves.c
1 /*
2  * Copyright (c) 2013 Clément Bœsch
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
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"
27 #include "libavutil/pixdesc.h"
28 #include "avfilter.h"
29 #include "drawutils.h"
30 #include "formats.h"
31 #include "internal.h"
32 #include "video.h"
33
34 #define R 0
35 #define G 1
36 #define B 2
37 #define A 3
38
39 struct keypoint {
40     double x, y;
41     struct keypoint *next;
42 };
43
44 #define NB_COMP 3
45
46 enum preset {
47     PRESET_NONE,
48     PRESET_COLOR_NEGATIVE,
49     PRESET_CROSS_PROCESS,
50     PRESET_DARKER,
51     PRESET_INCREASE_CONTRAST,
52     PRESET_LIGHTER,
53     PRESET_LINEAR_CONTRAST,
54     PRESET_MEDIUM_CONTRAST,
55     PRESET_NEGATIVE,
56     PRESET_STRONG_CONTRAST,
57     PRESET_VINTAGE,
58     NB_PRESETS,
59 };
60
61 typedef struct {
62     const AVClass *class;
63     int preset;
64     char *comp_points_str[NB_COMP + 1];
65     char *comp_points_str_all;
66     uint8_t graph[NB_COMP + 1][256];
67     char *psfile;
68     uint8_t rgba_map[4];
69     int step;
70 } CurvesContext;
71
72 typedef struct ThreadData {
73     AVFrame *in, *out;
74 } ThreadData;
75
76 #define OFFSET(x) offsetof(CurvesContext, x)
77 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
78 static const AVOption curves_options[] = {
79     { "preset", "select a color curves preset", OFFSET(preset), AV_OPT_TYPE_INT, {.i64=PRESET_NONE}, PRESET_NONE, NB_PRESETS-1, FLAGS, "preset_name" },
80         { "none",               NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_NONE},                 INT_MIN, INT_MAX, FLAGS, "preset_name" },
81         { "color_negative",     NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_COLOR_NEGATIVE},       INT_MIN, INT_MAX, FLAGS, "preset_name" },
82         { "cross_process",      NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_CROSS_PROCESS},        INT_MIN, INT_MAX, FLAGS, "preset_name" },
83         { "darker",             NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_DARKER},               INT_MIN, INT_MAX, FLAGS, "preset_name" },
84         { "increase_contrast",  NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_INCREASE_CONTRAST},    INT_MIN, INT_MAX, FLAGS, "preset_name" },
85         { "lighter",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_LIGHTER},              INT_MIN, INT_MAX, FLAGS, "preset_name" },
86         { "linear_contrast",    NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_LINEAR_CONTRAST},      INT_MIN, INT_MAX, FLAGS, "preset_name" },
87         { "medium_contrast",    NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_MEDIUM_CONTRAST},      INT_MIN, INT_MAX, FLAGS, "preset_name" },
88         { "negative",           NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_NEGATIVE},             INT_MIN, INT_MAX, FLAGS, "preset_name" },
89         { "strong_contrast",    NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_STRONG_CONTRAST},      INT_MIN, INT_MAX, FLAGS, "preset_name" },
90         { "vintage",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_VINTAGE},              INT_MIN, INT_MAX, FLAGS, "preset_name" },
91     { "master","set master points coordinates",OFFSET(comp_points_str[NB_COMP]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
92     { "m",     "set master points coordinates",OFFSET(comp_points_str[NB_COMP]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
93     { "red",   "set red points coordinates",   OFFSET(comp_points_str[0]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
94     { "r",     "set red points coordinates",   OFFSET(comp_points_str[0]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
95     { "green", "set green points coordinates", OFFSET(comp_points_str[1]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
96     { "g",     "set green points coordinates", OFFSET(comp_points_str[1]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
97     { "blue",  "set blue points coordinates",  OFFSET(comp_points_str[2]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
98     { "b",     "set blue points coordinates",  OFFSET(comp_points_str[2]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
99     { "all",   "set points coordinates for all components", OFFSET(comp_points_str_all), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
100     { "psfile", "set Photoshop curves file name", OFFSET(psfile), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
101     { NULL }
102 };
103
104 AVFILTER_DEFINE_CLASS(curves);
105
106 static const struct {
107     const char *r;
108     const char *g;
109     const char *b;
110     const char *master;
111 } curves_presets[] = {
112     [PRESET_COLOR_NEGATIVE] = {
113         "0.129/1 0.466/0.498 0.725/0",
114         "0.109/1 0.301/0.498 0.517/0",
115         "0.098/1 0.235/0.498 0.423/0",
116     },
117     [PRESET_CROSS_PROCESS] = {
118         "0/0 0.25/0.156 0.501/0.501 0.686/0.745 1/1",
119         "0/0 0.25/0.188 0.38/0.501 0.745/0.815 1/0.815",
120         "0/0 0.231/0.094 0.709/0.874 1/1",
121     },
122     [PRESET_DARKER]             = { .master = "0/0 0.5/0.4 1/1" },
123     [PRESET_INCREASE_CONTRAST]  = { .master = "0/0 0.149/0.066 0.831/0.905 0.905/0.98 1/1" },
124     [PRESET_LIGHTER]            = { .master = "0/0 0.4/0.5 1/1" },
125     [PRESET_LINEAR_CONTRAST]    = { .master = "0/0 0.305/0.286 0.694/0.713 1/1" },
126     [PRESET_MEDIUM_CONTRAST]    = { .master = "0/0 0.286/0.219 0.639/0.643 1/1" },
127     [PRESET_NEGATIVE]           = { .master = "0/1 1/0" },
128     [PRESET_STRONG_CONTRAST]    = { .master = "0/0 0.301/0.196 0.592/0.6 0.686/0.737 1/1" },
129     [PRESET_VINTAGE] = {
130         "0/0.11 0.42/0.51 1/0.95",
131         "0/0 0.50/0.48 1/1",
132         "0/0.22 0.49/0.44 1/0.8",
133     }
134 };
135
136 static struct keypoint *make_point(double x, double y, struct keypoint *next)
137 {
138     struct keypoint *point = av_mallocz(sizeof(*point));
139
140     if (!point)
141         return NULL;
142     point->x = x;
143     point->y = y;
144     point->next = next;
145     return point;
146 }
147
148 static int parse_points_str(AVFilterContext *ctx, struct keypoint **points, const char *s)
149 {
150     char *p = (char *)s; // strtod won't alter the string
151     struct keypoint *last = NULL;
152
153     /* construct a linked list based on the key points string */
154     while (p && *p) {
155         struct keypoint *point = make_point(0, 0, NULL);
156         if (!point)
157             return AVERROR(ENOMEM);
158         point->x = av_strtod(p, &p); if (p && *p) p++;
159         point->y = av_strtod(p, &p); if (p && *p) p++;
160         if (point->x < 0 || point->x > 1 || point->y < 0 || point->y > 1) {
161             av_log(ctx, AV_LOG_ERROR, "Invalid key point coordinates (%f;%f), "
162                    "x and y must be in the [0;1] range.\n", point->x, point->y);
163             return AVERROR(EINVAL);
164         }
165         if (!*points)
166             *points = point;
167         if (last) {
168             if ((int)(last->x * 255) >= (int)(point->x * 255)) {
169                 av_log(ctx, AV_LOG_ERROR, "Key point coordinates (%f;%f) "
170                        "and (%f;%f) are too close from each other or not "
171                        "strictly increasing on the x-axis\n",
172                        last->x, last->y, point->x, point->y);
173                 return AVERROR(EINVAL);
174             }
175             last->next = point;
176         }
177         last = point;
178     }
179
180     if (*points && !(*points)->next) {
181         av_log(ctx, AV_LOG_WARNING, "Only one point (at (%f;%f)) is defined, "
182                "this is unlikely to behave as you expect. You probably want"
183                "at least 2 points.",
184                (*points)->x, (*points)->y);
185     }
186
187     return 0;
188 }
189
190 static int get_nb_points(const struct keypoint *d)
191 {
192     int n = 0;
193     while (d) {
194         n++;
195         d = d->next;
196     }
197     return n;
198 }
199
200 /**
201  * Natural cubic spline interpolation
202  * Finding curves using Cubic Splines notes by Steven Rauch and John Stockie.
203  * @see http://people.math.sfu.ca/~stockie/teaching/macm316/notes/splines.pdf
204  */
205 static int interpolate(AVFilterContext *ctx, uint8_t *y, const struct keypoint *points)
206 {
207     int i, ret = 0;
208     const struct keypoint *point = points;
209     double xprev = 0;
210
211     double (*matrix)[3];
212     double *h, *r;
213     int n = get_nb_points(points); // number of splines
214
215     if (n == 0) {
216         for (i = 0; i < 256; i++)
217             y[i] = i;
218         return 0;
219     }
220
221     if (n == 1) {
222         for (i = 0; i < 256; i++)
223             y[i] = av_clip_uint8(point->y * 255);
224         return 0;
225     }
226
227     matrix = av_calloc(n, sizeof(*matrix));
228     h = av_malloc((n - 1) * sizeof(*h));
229     r = av_calloc(n, sizeof(*r));
230
231     if (!matrix || !h || !r) {
232         ret = AVERROR(ENOMEM);
233         goto end;
234     }
235
236     /* h(i) = x(i+1) - x(i) */
237     i = -1;
238     for (point = points; point; point = point->next) {
239         if (i != -1)
240             h[i] = point->x - xprev;
241         xprev = point->x;
242         i++;
243     }
244
245     /* right-side of the polynomials, will be modified to contains the solution */
246     point = points;
247     for (i = 1; i < n - 1; i++) {
248         double yp = point->y,
249                yc = point->next->y,
250                yn = point->next->next->y;
251         r[i] = 6 * ((yn-yc)/h[i] - (yc-yp)/h[i-1]);
252         point = point->next;
253     }
254
255 #define BD 0 /* sub  diagonal (below main) */
256 #define MD 1 /* main diagonal (center) */
257 #define AD 2 /* sup  diagonal (above main) */
258
259     /* left side of the polynomials into a tridiagonal matrix. */
260     matrix[0][MD] = matrix[n - 1][MD] = 1;
261     for (i = 1; i < n - 1; i++) {
262         matrix[i][BD] = h[i-1];
263         matrix[i][MD] = 2 * (h[i-1] + h[i]);
264         matrix[i][AD] = h[i];
265     }
266
267     /* tridiagonal solving of the linear system */
268     for (i = 1; i < n; i++) {
269         double den = matrix[i][MD] - matrix[i][BD] * matrix[i-1][AD];
270         double k = den ? 1./den : 1.;
271         matrix[i][AD] *= k;
272         r[i] = (r[i] - matrix[i][BD] * r[i - 1]) * k;
273     }
274     for (i = n - 2; i >= 0; i--)
275         r[i] = r[i] - matrix[i][AD] * r[i + 1];
276
277     point = points;
278
279     /* left padding */
280     for (i = 0; i < (int)(point->x * 255); i++)
281         y[i] = av_clip_uint8(point->y * 255);
282
283     /* compute the graph with x=[x0..xN] */
284     i = 0;
285     av_assert0(point->next); // always at least 2 key points
286     while (point->next) {
287         double yc = point->y;
288         double yn = point->next->y;
289
290         double a = yc;
291         double b = (yn-yc)/h[i] - h[i]*r[i]/2. - h[i]*(r[i+1]-r[i])/6.;
292         double c = r[i] / 2.;
293         double d = (r[i+1] - r[i]) / (6.*h[i]);
294
295         int x;
296         int x_start = point->x       * 255;
297         int x_end   = point->next->x * 255;
298
299         av_assert0(x_start >= 0 && x_start <= 255 &&
300                    x_end   >= 0 && x_end   <= 255);
301
302         for (x = x_start; x <= x_end; x++) {
303             double xx = (x - x_start) * 1/255.;
304             double yy = a + b*xx + c*xx*xx + d*xx*xx*xx;
305             y[x] = av_clip_uint8(yy * 255);
306             av_log(ctx, AV_LOG_DEBUG, "f(%f)=%f -> y[%d]=%d\n", xx, yy, x, y[x]);
307         }
308
309         point = point->next;
310         i++;
311     }
312
313     /* right padding */
314     for (i = (int)(point->x * 255); i <= 255; i++)
315         y[i] = av_clip_uint8(point->y * 255);
316
317 end:
318     av_free(matrix);
319     av_free(h);
320     av_free(r);
321     return ret;
322 }
323
324 static int parse_psfile(AVFilterContext *ctx, const char *fname)
325 {
326     CurvesContext *curves = ctx->priv;
327     uint8_t *buf;
328     size_t size;
329     int i, ret, av_unused(version), nb_curves;
330     AVBPrint ptstr;
331     static const int comp_ids[] = {3, 0, 1, 2};
332
333     av_bprint_init(&ptstr, 0, AV_BPRINT_SIZE_AUTOMATIC);
334
335     ret = av_file_map(fname, &buf, &size, 0, NULL);
336     if (ret < 0)
337         return ret;
338
339 #define READ16(dst) do {                \
340     if (size < 2) {                     \
341         ret = AVERROR_INVALIDDATA;      \
342         goto end;                       \
343     }                                   \
344     dst = AV_RB16(buf);                 \
345     buf  += 2;                          \
346     size -= 2;                          \
347 } while (0)
348
349     READ16(version);
350     READ16(nb_curves);
351     for (i = 0; i < FFMIN(nb_curves, FF_ARRAY_ELEMS(comp_ids)); i++) {
352         int nb_points, n;
353         av_bprint_clear(&ptstr);
354         READ16(nb_points);
355         for (n = 0; n < nb_points; n++) {
356             int y, x;
357             READ16(y);
358             READ16(x);
359             av_bprintf(&ptstr, "%f/%f ", x / 255., y / 255.);
360         }
361         if (*ptstr.str) {
362             char **pts = &curves->comp_points_str[comp_ids[i]];
363             if (!*pts) {
364                 *pts = av_strdup(ptstr.str);
365                 av_log(ctx, AV_LOG_DEBUG, "curves %d (intid=%d) [%d points]: [%s]\n",
366                        i, comp_ids[i], nb_points, *pts);
367                 if (!*pts) {
368                     ret = AVERROR(ENOMEM);
369                     goto end;
370                 }
371             }
372         }
373     }
374 end:
375     av_bprint_finalize(&ptstr, NULL);
376     av_file_unmap(buf, size);
377     return ret;
378 }
379
380 static av_cold int init(AVFilterContext *ctx)
381 {
382     int i, j, ret;
383     CurvesContext *curves = ctx->priv;
384     struct keypoint *comp_points[NB_COMP + 1] = {0};
385     char **pts = curves->comp_points_str;
386     const char *allp = curves->comp_points_str_all;
387
388     //if (!allp && curves->preset != PRESET_NONE && curves_presets[curves->preset].all)
389     //    allp = curves_presets[curves->preset].all;
390
391     if (allp) {
392         for (i = 0; i < NB_COMP; i++) {
393             if (!pts[i])
394                 pts[i] = av_strdup(allp);
395             if (!pts[i])
396                 return AVERROR(ENOMEM);
397         }
398     }
399
400     if (curves->psfile) {
401         ret = parse_psfile(ctx, curves->psfile);
402         if (ret < 0)
403             return ret;
404     }
405
406     if (curves->preset != PRESET_NONE) {
407 #define SET_COMP_IF_NOT_SET(n, name) do {                           \
408     if (!pts[n] && curves_presets[curves->preset].name) {           \
409         pts[n] = av_strdup(curves_presets[curves->preset].name);    \
410         if (!pts[n])                                                \
411             return AVERROR(ENOMEM);                                 \
412     }                                                               \
413 } while (0)
414         SET_COMP_IF_NOT_SET(0, r);
415         SET_COMP_IF_NOT_SET(1, g);
416         SET_COMP_IF_NOT_SET(2, b);
417         SET_COMP_IF_NOT_SET(3, master);
418     }
419
420     for (i = 0; i < NB_COMP + 1; i++) {
421         ret = parse_points_str(ctx, comp_points + i, curves->comp_points_str[i]);
422         if (ret < 0)
423             return ret;
424         ret = interpolate(ctx, curves->graph[i], comp_points[i]);
425         if (ret < 0)
426             return ret;
427     }
428
429     if (pts[NB_COMP]) {
430         for (i = 0; i < NB_COMP; i++)
431             for (j = 0; j < 256; j++)
432                 curves->graph[i][j] = curves->graph[NB_COMP][curves->graph[i][j]];
433     }
434
435     if (av_log_get_level() >= AV_LOG_VERBOSE) {
436         for (i = 0; i < NB_COMP; i++) {
437             struct keypoint *point = comp_points[i];
438             av_log(ctx, AV_LOG_VERBOSE, "#%d points:", i);
439             while (point) {
440                 av_log(ctx, AV_LOG_VERBOSE, " (%f;%f)", point->x, point->y);
441                 point = point->next;
442             }
443             av_log(ctx, AV_LOG_VERBOSE, "\n");
444             av_log(ctx, AV_LOG_VERBOSE, "#%d values:", i);
445             for (j = 0; j < 256; j++)
446                 av_log(ctx, AV_LOG_VERBOSE, " %02X", curves->graph[i][j]);
447             av_log(ctx, AV_LOG_VERBOSE, "\n");
448         }
449     }
450
451     for (i = 0; i < NB_COMP + 1; i++) {
452         struct keypoint *point = comp_points[i];
453         while (point) {
454             struct keypoint *next = point->next;
455             av_free(point);
456             point = next;
457         }
458     }
459
460     return 0;
461 }
462
463 static int query_formats(AVFilterContext *ctx)
464 {
465     static const enum AVPixelFormat pix_fmts[] = {
466         AV_PIX_FMT_RGB24,  AV_PIX_FMT_BGR24,
467         AV_PIX_FMT_RGBA,   AV_PIX_FMT_BGRA,
468         AV_PIX_FMT_ARGB,   AV_PIX_FMT_ABGR,
469         AV_PIX_FMT_0RGB,   AV_PIX_FMT_0BGR,
470         AV_PIX_FMT_RGB0,   AV_PIX_FMT_BGR0,
471         AV_PIX_FMT_NONE
472     };
473     AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
474     if (!fmts_list)
475         return AVERROR(ENOMEM);
476     return ff_set_common_formats(ctx, fmts_list);
477 }
478
479 static int config_input(AVFilterLink *inlink)
480 {
481     CurvesContext *curves = inlink->dst->priv;
482     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
483
484     ff_fill_rgba_map(curves->rgba_map, inlink->format);
485     curves->step = av_get_padded_bits_per_pixel(desc) >> 3;
486
487     return 0;
488 }
489
490 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
491 {
492     int x, y;
493     const CurvesContext *curves = ctx->priv;
494     const ThreadData *td = arg;
495     const AVFrame *in  = td->in;
496     const AVFrame *out = td->out;
497     const int direct = out == in;
498     const int step = curves->step;
499     const uint8_t r = curves->rgba_map[R];
500     const uint8_t g = curves->rgba_map[G];
501     const uint8_t b = curves->rgba_map[B];
502     const uint8_t a = curves->rgba_map[A];
503     const int slice_start = (in->height *  jobnr   ) / nb_jobs;
504     const int slice_end   = (in->height * (jobnr+1)) / nb_jobs;
505     uint8_t       *dst = out->data[0] + slice_start * out->linesize[0];
506     const uint8_t *src =  in->data[0] + slice_start *  in->linesize[0];
507
508     for (y = slice_start; y < slice_end; y++) {
509         for (x = 0; x < in->width * step; x += step) {
510             dst[x + r] = curves->graph[R][src[x + r]];
511             dst[x + g] = curves->graph[G][src[x + g]];
512             dst[x + b] = curves->graph[B][src[x + b]];
513             if (!direct && step == 4)
514                 dst[x + a] = src[x + a];
515         }
516         dst += out->linesize[0];
517         src += in ->linesize[0];
518     }
519     return 0;
520 }
521
522 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
523 {
524     AVFilterContext *ctx = inlink->dst;
525     AVFilterLink *outlink = ctx->outputs[0];
526     AVFrame *out;
527     ThreadData td;
528
529     if (av_frame_is_writable(in)) {
530         out = in;
531     } else {
532         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
533         if (!out) {
534             av_frame_free(&in);
535             return AVERROR(ENOMEM);
536         }
537         av_frame_copy_props(out, in);
538     }
539
540     td.in  = in;
541     td.out = out;
542     ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(outlink->h, ctx->graph->nb_threads));
543
544     if (out != in)
545         av_frame_free(&in);
546
547     return ff_filter_frame(outlink, out);
548 }
549
550 static const AVFilterPad curves_inputs[] = {
551     {
552         .name         = "default",
553         .type         = AVMEDIA_TYPE_VIDEO,
554         .filter_frame = filter_frame,
555         .config_props = config_input,
556     },
557     { NULL }
558 };
559
560 static const AVFilterPad curves_outputs[] = {
561     {
562         .name = "default",
563         .type = AVMEDIA_TYPE_VIDEO,
564     },
565     { NULL }
566 };
567
568 AVFilter ff_vf_curves = {
569     .name          = "curves",
570     .description   = NULL_IF_CONFIG_SMALL("Adjust components curves."),
571     .priv_size     = sizeof(CurvesContext),
572     .init          = init,
573     .query_formats = query_formats,
574     .inputs        = curves_inputs,
575     .outputs       = curves_outputs,
576     .priv_class    = &curves_class,
577     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
578 };