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