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