lavfi/curves: fix a spacing weirdness.
[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/eval.h"
23 #include "libavutil/avassert.h"
24 #include "avfilter.h"
25 #include "formats.h"
26 #include "internal.h"
27 #include "video.h"
28
29 struct keypoint {
30     double x, y;
31     struct keypoint *next;
32 };
33
34 #define NB_COMP 3
35
36 enum preset {
37     PRESET_NONE,
38     PRESET_COLOR_NEGATIVE,
39     PRESET_CROSS_PROCESS,
40     PRESET_DARKER,
41     PRESET_INCREASE_CONTRAST,
42     PRESET_LIGHTER,
43     PRESET_LINEAR_CONTRAST,
44     PRESET_MEDIUM_CONTRAST,
45     PRESET_NEGATIVE,
46     PRESET_STRONG_CONTRAST,
47     PRESET_VINTAGE,
48     NB_PRESETS,
49 };
50
51 typedef struct {
52     const AVClass *class;
53     enum preset preset;
54     char *comp_points_str[NB_COMP];
55     char *comp_points_str_all;
56     uint8_t graph[NB_COMP][256];
57 } CurvesContext;
58
59 #define OFFSET(x) offsetof(CurvesContext, x)
60 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
61 static const AVOption curves_options[] = {
62     { "preset", "select a color curves preset", OFFSET(preset), AV_OPT_TYPE_INT, {.i64=PRESET_NONE}, PRESET_NONE, NB_PRESETS-1, FLAGS, "preset_name" },
63         { "none",               NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_NONE},                 INT_MIN, INT_MAX, FLAGS, "preset_name" },
64         { "color_negative",     NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_COLOR_NEGATIVE},       INT_MIN, INT_MAX, FLAGS, "preset_name" },
65         { "cross_process",      NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_CROSS_PROCESS},        INT_MIN, INT_MAX, FLAGS, "preset_name" },
66         { "darker",             NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_DARKER},               INT_MIN, INT_MAX, FLAGS, "preset_name" },
67         { "increase_contrast",  NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_INCREASE_CONTRAST},    INT_MIN, INT_MAX, FLAGS, "preset_name" },
68         { "lighter",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_LIGHTER},              INT_MIN, INT_MAX, FLAGS, "preset_name" },
69         { "linear_contrast",    NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_LINEAR_CONTRAST},      INT_MIN, INT_MAX, FLAGS, "preset_name" },
70         { "medium_contrast",    NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_MEDIUM_CONTRAST},      INT_MIN, INT_MAX, FLAGS, "preset_name" },
71         { "negative",           NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_NEGATIVE},             INT_MIN, INT_MAX, FLAGS, "preset_name" },
72         { "strong_contrast",    NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_STRONG_CONTRAST},      INT_MIN, INT_MAX, FLAGS, "preset_name" },
73         { "vintage",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=PRESET_VINTAGE},              INT_MIN, INT_MAX, FLAGS, "preset_name" },
74     { "red",   "set red points coordinates",   OFFSET(comp_points_str[0]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
75     { "r",     "set red points coordinates",   OFFSET(comp_points_str[0]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
76     { "green", "set green points coordinates", OFFSET(comp_points_str[1]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
77     { "g",     "set green points coordinates", OFFSET(comp_points_str[1]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
78     { "blue",  "set blue points coordinates",  OFFSET(comp_points_str[2]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
79     { "b",     "set blue points coordinates",  OFFSET(comp_points_str[2]), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
80     { "all",   "set points coordinates for all components", OFFSET(comp_points_str_all), AV_OPT_TYPE_STRING, {.str=NULL}, .flags = FLAGS },
81     { NULL }
82 };
83
84 AVFILTER_DEFINE_CLASS(curves);
85
86 static const struct {
87     const char *r;
88     const char *g;
89     const char *b;
90 } curves_presets[] = {
91     [PRESET_COLOR_NEGATIVE] = {
92         "0/1 0.129/1 0.466/0.498 0.725/0 1/0",
93         "0/1 0.109/1 0.301/0.498 0.517/0 1/0",
94         "0/1 0.098/1 0.235/0.498 0.423/0 1/0",
95     },
96     [PRESET_CROSS_PROCESS] = {
97         "0.25/0.156 0.501/0.501 0.686/0.745",
98         "0.25/0.188 0.38/0.501 0.745/0.815 1/0.815",
99         "0.231/0.094 0.709/0.874",
100     },
101     [PRESET_DARKER] = {
102         "0.5/0.4", "0.5/0.4", "0.5/0.4",
103     },
104     [PRESET_INCREASE_CONTRAST] = {
105         "0.149/0.066 0.831/0.905 0.905/0.98",
106         "0.149/0.066 0.831/0.905 0.905/0.98",
107         "0.149/0.066 0.831/0.905 0.905/0.98",
108     },
109     [PRESET_LIGHTER] = {
110         "0.4/0.5", "0.4/0.5", "0.4/0.5",
111     },
112     [PRESET_LINEAR_CONTRAST] = {
113         "0.305/0.286 0.694/0.713",
114         "0.305/0.286 0.694/0.713",
115         "0.305/0.286 0.694/0.713",
116     },
117     [PRESET_MEDIUM_CONTRAST] = {
118         "0.286/0.219 0.639/0.643",
119         "0.286/0.219 0.639/0.643",
120         "0.286/0.219 0.639/0.643",
121     },
122     [PRESET_NEGATIVE] = {
123         "0/1 1/0", "0/1 1/0", "0/1 1/0",
124     },
125     [PRESET_STRONG_CONTRAST] = {
126         "0.301/0.196 0.592/0.6 0.686/0.737",
127         "0.301/0.196 0.592/0.6 0.686/0.737",
128         "0.301/0.196 0.592/0.6 0.686/0.737",
129     },
130     [PRESET_VINTAGE] = {
131         "0/0.11 0.42/0.51 1/0.95",
132         "0.50/0.48",
133         "0/0.22 0.49/0.44 1/0.8",
134     }
135 };
136
137 static struct keypoint *make_point(double x, double y, struct keypoint *next)
138 {
139     struct keypoint *point = av_mallocz(sizeof(*point));
140
141     if (!point)
142         return NULL;
143     point->x = x;
144     point->y = y;
145     point->next = next;
146     return point;
147 }
148
149 static int parse_points_str(AVFilterContext *ctx, struct keypoint **points, const char *s)
150 {
151     char *p = (char *)s; // strtod won't alter the string
152     struct keypoint *last = NULL;
153
154     /* construct a linked list based on the key points string */
155     while (p && *p) {
156         struct keypoint *point = make_point(0, 0, NULL);
157         if (!point)
158             return AVERROR(ENOMEM);
159         point->x = av_strtod(p, &p); if (p && *p) p++;
160         point->y = av_strtod(p, &p); if (p && *p) p++;
161         if (point->x < 0 || point->x > 1 || point->y < 0 || point->y > 1) {
162             av_log(ctx, AV_LOG_ERROR, "Invalid key point coordinates (%f;%f), "
163                    "x and y must be in the [0;1] range.\n", point->x, point->y);
164             return AVERROR(EINVAL);
165         }
166         if (!*points)
167             *points = point;
168         if (last) {
169             if ((int)(last->x * 255) >= (int)(point->x * 255)) {
170                 av_log(ctx, AV_LOG_ERROR, "Key point coordinates (%f;%f) "
171                        "and (%f;%f) are too close from each other or not "
172                        "strictly increasing on the x-axis\n",
173                        last->x, last->y, point->x, point->y);
174                 return AVERROR(EINVAL);
175             }
176             last->next = point;
177         }
178         last = point;
179     }
180
181     /* auto insert first key point if missing at x=0 */
182     if (!*points) {
183         last = make_point(0, 0, NULL);
184         if (!last)
185             return AVERROR(ENOMEM);
186         last->x = last->y = 0;
187         *points = last;
188     } else if ((*points)->x != 0.) {
189         struct keypoint *newfirst = make_point(0, 0, *points);
190         if (!newfirst)
191             return AVERROR(ENOMEM);
192         *points = newfirst;
193     }
194
195     av_assert0(last);
196
197     /* auto insert last key point if missing at x=1 */
198     if (last->x != 1.) {
199         struct keypoint *point = make_point(1, 1, NULL);
200         if (!point)
201             return AVERROR(ENOMEM);
202         last->next = point;
203     }
204
205     return 0;
206 }
207
208 static int get_nb_points(const struct keypoint *d)
209 {
210     int n = 0;
211     while (d) {
212         n++;
213         d = d->next;
214     }
215     return n;
216 }
217
218 /**
219  * Natural cubic spline interpolation
220  * Finding curves using Cubic Splines notes by Steven Rauch and John Stockie.
221  * @see http://people.math.sfu.ca/~stockie/teaching/macm316/notes/splines.pdf
222  */
223 static int interpolate(AVFilterContext *ctx, uint8_t *y, const struct keypoint *points)
224 {
225     int i, ret = 0;
226     const struct keypoint *point;
227     double xprev = 0;
228
229     int n = get_nb_points(points); // number of splines
230
231     double (*matrix)[3] = av_calloc(n, sizeof(*matrix));
232     double *h = av_malloc((n - 1) * sizeof(*h));
233     double *r = av_calloc(n, sizeof(*r));
234
235     if (!matrix || !h || !r) {
236         ret = AVERROR(ENOMEM);
237         goto end;
238     }
239
240     /* h(i) = x(i+1) - x(i) */
241     i = -1;
242     for (point = points; point; point = point->next) {
243         if (i != -1)
244             h[i] = point->x - xprev;
245         xprev = point->x;
246         i++;
247     }
248
249     /* right-side of the polynomials, will be modified to contains the solution */
250     point = points;
251     for (i = 1; i < n - 1; i++) {
252         double yp = point->y,
253                yc = point->next->y,
254                yn = point->next->next->y;
255         r[i] = 6 * ((yn-yc)/h[i] - (yc-yp)/h[i-1]);
256         point = point->next;
257     }
258
259 #define B 0 /* sub  diagonal (below main) */
260 #define M 1 /* main diagonal (center) */
261 #define A 2 /* sup  diagonal (above main) */
262
263     /* left side of the polynomials into a tridiagonal matrix. */
264     matrix[0][M] = matrix[n - 1][M] = 1;
265     for (i = 1; i < n - 1; i++) {
266         matrix[i][B] = h[i-1];
267         matrix[i][M] = 2 * (h[i-1] + h[i]);
268         matrix[i][A] = h[i];
269     }
270
271     /* tridiagonal solving of the linear system */
272     for (i = 1; i < n; i++) {
273         double den = matrix[i][M] - matrix[i][B] * matrix[i-1][A];
274         double k = den ? 1./den : 1.;
275         matrix[i][A] *= k;
276         r[i] = (r[i] - matrix[i][B] * r[i - 1]) * k;
277     }
278     for (i = n - 2; i >= 0; i--)
279         r[i] = r[i] - matrix[i][A] * r[i + 1];
280
281     /* compute the graph with x=[0..255] */
282     i = 0;
283     point = points;
284     av_assert0(point->next); // always at least 2 key points
285     while (point->next) {
286         double yc = point->y;
287         double yn = point->next->y;
288
289         double a = yc;
290         double b = (yn-yc)/h[i] - h[i]*r[i]/2. - h[i]*(r[i+1]-r[i])/6.;
291         double c = r[i] / 2.;
292         double d = (r[i+1] - r[i]) / (6.*h[i]);
293
294         int x;
295         int x_start = point->x       * 255;
296         int x_end   = point->next->x * 255;
297
298         av_assert0(x_start >= 0 && x_start <= 255 &&
299                    x_end   >= 0 && x_end   <= 255);
300
301         for (x = x_start; x <= x_end; x++) {
302             double xx = (x - x_start) * 1/255.;
303             double yy = a + b*xx + c*xx*xx + d*xx*xx*xx;
304             y[x] = av_clipf(yy, 0, 1) * 255;
305             av_log(ctx, AV_LOG_DEBUG, "f(%f)=%f -> y[%d]=%d\n", xx, yy, x, y[x]);
306         }
307
308         point = point->next;
309         i++;
310     }
311
312 end:
313     av_free(matrix);
314     av_free(h);
315     av_free(r);
316     return ret;
317 }
318
319 static av_cold int init(AVFilterContext *ctx, const char *args)
320 {
321     int i, j, ret;
322     CurvesContext *curves = ctx->priv;
323     struct keypoint *comp_points[NB_COMP] = {0};
324     char **pts = curves->comp_points_str;
325
326     if (curves->comp_points_str_all) {
327         for (i = 0; i < NB_COMP; i++) {
328             if (!pts[i])
329                 pts[i] = av_strdup(curves->comp_points_str_all);
330             if (!pts[i])
331                 return AVERROR(ENOMEM);
332         }
333     }
334
335     if (curves->preset != PRESET_NONE) {
336         if (pts[0] || pts[1] || pts[2]) {
337             av_log(ctx, AV_LOG_ERROR, "It is not possible to mix a preset "
338                    "with explicit points placements\n");
339             return AVERROR(EINVAL);
340         }
341         pts[0] = av_strdup(curves_presets[curves->preset].r);
342         pts[1] = av_strdup(curves_presets[curves->preset].g);
343         pts[2] = av_strdup(curves_presets[curves->preset].b);
344         if (!pts[0] || !pts[1] || !pts[2])
345             return AVERROR(ENOMEM);
346     }
347
348     for (i = 0; i < NB_COMP; i++) {
349         ret = parse_points_str(ctx, comp_points + i, curves->comp_points_str[i]);
350         if (ret < 0)
351             return ret;
352         ret = interpolate(ctx, curves->graph[i], comp_points[i]);
353         if (ret < 0)
354             return ret;
355     }
356
357     if (av_log_get_level() >= AV_LOG_VERBOSE) {
358         for (i = 0; i < NB_COMP; i++) {
359             struct keypoint *point = comp_points[i];
360             av_log(ctx, AV_LOG_VERBOSE, "#%d points:", i);
361             while (point) {
362                 av_log(ctx, AV_LOG_VERBOSE, " (%f;%f)", point->x, point->y);
363                 point = point->next;
364             }
365             av_log(ctx, AV_LOG_VERBOSE, "\n");
366             av_log(ctx, AV_LOG_VERBOSE, "#%d values:", i);
367             for (j = 0; j < 256; j++)
368                 av_log(ctx, AV_LOG_VERBOSE, " %02X", curves->graph[i][j]);
369             av_log(ctx, AV_LOG_VERBOSE, "\n");
370         }
371     }
372
373     for (i = 0; i < NB_COMP; i++) {
374         struct keypoint *point = comp_points[i];
375         while (point) {
376             struct keypoint *next = point->next;
377             av_free(point);
378             point = next;
379         }
380     }
381
382     return 0;
383 }
384
385 static int query_formats(AVFilterContext *ctx)
386 {
387     static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_RGB24, AV_PIX_FMT_NONE};
388     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
389     return 0;
390 }
391
392 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
393 {
394     int x, y, i, direct = 0;
395     AVFilterContext *ctx = inlink->dst;
396     CurvesContext *curves = ctx->priv;
397     AVFilterLink *outlink = inlink->dst->outputs[0];
398     AVFrame *out;
399     uint8_t *dst;
400     const uint8_t *src;
401
402     if (av_frame_is_writable(in)) {
403         direct = 1;
404         out = in;
405     } else {
406         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
407         if (!out) {
408             av_frame_free(&in);
409             return AVERROR(ENOMEM);
410         }
411         av_frame_copy_props(out, in);
412     }
413
414     dst = out->data[0];
415     src = in ->data[0];
416
417     for (y = 0; y < inlink->h; y++) {
418         uint8_t *dstp = dst;
419         const uint8_t *srcp = src;
420
421         for (x = 0; x < inlink->w; x++)
422             for (i = 0; i < NB_COMP; i++, dstp++, srcp++)
423                 *dstp = curves->graph[i][*srcp];
424         dst += out->linesize[0];
425         src += in ->linesize[0];
426     }
427
428     if (!direct)
429         av_frame_free(&in);
430
431     return ff_filter_frame(outlink, out);
432 }
433
434 static const AVFilterPad curves_inputs[] = {
435     {
436         .name         = "default",
437         .type         = AVMEDIA_TYPE_VIDEO,
438         .filter_frame = filter_frame,
439     },
440     { NULL }
441 };
442
443 static const AVFilterPad curves_outputs[] = {
444      {
445          .name = "default",
446          .type = AVMEDIA_TYPE_VIDEO,
447      },
448      { NULL }
449 };
450
451 AVFilter avfilter_vf_curves = {
452     .name          = "curves",
453     .description   = NULL_IF_CONFIG_SMALL("Adjust components curves."),
454     .priv_size     = sizeof(CurvesContext),
455     .init          = init,
456     .query_formats = query_formats,
457     .inputs        = curves_inputs,
458     .outputs       = curves_outputs,
459     .priv_class    = &curves_class,
460 };