avfilter/curves: support slice threading.
[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     enum preset 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/1 0.129/1 0.466/0.498 0.725/0 1/0",
114         "0/1 0.109/1 0.301/0.498 0.517/0 1/0",
115         "0/1 0.098/1 0.235/0.498 0.423/0 1/0",
116     },
117     [PRESET_CROSS_PROCESS] = {
118         "0.25/0.156 0.501/0.501 0.686/0.745",
119         "0.25/0.188 0.38/0.501 0.745/0.815 1/0.815",
120         "0.231/0.094 0.709/0.874",
121     },
122     [PRESET_DARKER]             = { .master = "0.5/0.4" },
123     [PRESET_INCREASE_CONTRAST]  = { .master = "0.149/0.066 0.831/0.905 0.905/0.98" },
124     [PRESET_LIGHTER]            = { .master = "0.4/0.5" },
125     [PRESET_LINEAR_CONTRAST]    = { .master = "0.305/0.286 0.694/0.713" },
126     [PRESET_MEDIUM_CONTRAST]    = { .master = "0.286/0.219 0.639/0.643" },
127     [PRESET_NEGATIVE]           = { .master = "0/1 1/0" },
128     [PRESET_STRONG_CONTRAST]    = { .master = "0.301/0.196 0.592/0.6 0.686/0.737" },
129     [PRESET_VINTAGE] = {
130         "0/0.11 0.42/0.51 1/0.95",
131         "0.50/0.48",
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     /* auto insert first key point if missing at x=0 */
181     if (!*points) {
182         last = make_point(0, 0, NULL);
183         if (!last)
184             return AVERROR(ENOMEM);
185         last->x = last->y = 0;
186         *points = last;
187     } else if ((*points)->x != 0.) {
188         struct keypoint *newfirst = make_point(0, 0, *points);
189         if (!newfirst)
190             return AVERROR(ENOMEM);
191         *points = newfirst;
192     }
193
194     av_assert0(last);
195
196     /* auto insert last key point if missing at x=1 */
197     if (last->x != 1.) {
198         struct keypoint *point = make_point(1, 1, NULL);
199         if (!point)
200             return AVERROR(ENOMEM);
201         last->next = point;
202     }
203
204     return 0;
205 }
206
207 static int get_nb_points(const struct keypoint *d)
208 {
209     int n = 0;
210     while (d) {
211         n++;
212         d = d->next;
213     }
214     return n;
215 }
216
217 /**
218  * Natural cubic spline interpolation
219  * Finding curves using Cubic Splines notes by Steven Rauch and John Stockie.
220  * @see http://people.math.sfu.ca/~stockie/teaching/macm316/notes/splines.pdf
221  */
222 static int interpolate(AVFilterContext *ctx, uint8_t *y, const struct keypoint *points)
223 {
224     int i, ret = 0;
225     const struct keypoint *point;
226     double xprev = 0;
227
228     int n = get_nb_points(points); // number of splines
229
230     double (*matrix)[3] = av_calloc(n, sizeof(*matrix));
231     double *h = av_malloc((n - 1) * sizeof(*h));
232     double *r = av_calloc(n, sizeof(*r));
233
234     if (!matrix || !h || !r) {
235         ret = AVERROR(ENOMEM);
236         goto end;
237     }
238
239     /* h(i) = x(i+1) - x(i) */
240     i = -1;
241     for (point = points; point; point = point->next) {
242         if (i != -1)
243             h[i] = point->x - xprev;
244         xprev = point->x;
245         i++;
246     }
247
248     /* right-side of the polynomials, will be modified to contains the solution */
249     point = points;
250     for (i = 1; i < n - 1; i++) {
251         double yp = point->y,
252                yc = point->next->y,
253                yn = point->next->next->y;
254         r[i] = 6 * ((yn-yc)/h[i] - (yc-yp)/h[i-1]);
255         point = point->next;
256     }
257
258 #define BD 0 /* sub  diagonal (below main) */
259 #define MD 1 /* main diagonal (center) */
260 #define AD 2 /* sup  diagonal (above main) */
261
262     /* left side of the polynomials into a tridiagonal matrix. */
263     matrix[0][MD] = matrix[n - 1][MD] = 1;
264     for (i = 1; i < n - 1; i++) {
265         matrix[i][BD] = h[i-1];
266         matrix[i][MD] = 2 * (h[i-1] + h[i]);
267         matrix[i][AD] = h[i];
268     }
269
270     /* tridiagonal solving of the linear system */
271     for (i = 1; i < n; i++) {
272         double den = matrix[i][MD] - matrix[i][BD] * matrix[i-1][AD];
273         double k = den ? 1./den : 1.;
274         matrix[i][AD] *= k;
275         r[i] = (r[i] - matrix[i][BD] * r[i - 1]) * k;
276     }
277     for (i = n - 2; i >= 0; i--)
278         r[i] = r[i] - matrix[i][AD] * r[i + 1];
279
280     /* compute the graph with x=[0..255] */
281     i = 0;
282     point = points;
283     av_assert0(point->next); // always at least 2 key points
284     while (point->next) {
285         double yc = point->y;
286         double yn = point->next->y;
287
288         double a = yc;
289         double b = (yn-yc)/h[i] - h[i]*r[i]/2. - h[i]*(r[i+1]-r[i])/6.;
290         double c = r[i] / 2.;
291         double d = (r[i+1] - r[i]) / (6.*h[i]);
292
293         int x;
294         int x_start = point->x       * 255;
295         int x_end   = point->next->x * 255;
296
297         av_assert0(x_start >= 0 && x_start <= 255 &&
298                    x_end   >= 0 && x_end   <= 255);
299
300         for (x = x_start; x <= x_end; x++) {
301             double xx = (x - x_start) * 1/255.;
302             double yy = a + b*xx + c*xx*xx + d*xx*xx*xx;
303             y[x] = av_clipf(yy, 0, 1) * 255;
304             av_log(ctx, AV_LOG_DEBUG, "f(%f)=%f -> y[%d]=%d\n", xx, yy, x, y[x]);
305         }
306
307         point = point->next;
308         i++;
309     }
310
311 end:
312     av_free(matrix);
313     av_free(h);
314     av_free(r);
315     return ret;
316 }
317
318 static int parse_psfile(AVFilterContext *ctx, const char *fname)
319 {
320     CurvesContext *curves = ctx->priv;
321     uint8_t *buf;
322     size_t size;
323     int i, ret, av_unused(version), nb_curves;
324     AVBPrint ptstr;
325     static const int comp_ids[] = {3, 0, 1, 2};
326
327     av_bprint_init(&ptstr, 0, AV_BPRINT_SIZE_AUTOMATIC);
328
329     ret = av_file_map(fname, &buf, &size, 0, NULL);
330     if (ret < 0)
331         return ret;
332
333 #define READ16(dst) do {                \
334     if (size < 2)                       \
335         return AVERROR_INVALIDDATA;     \
336     dst = AV_RB16(buf);                 \
337     buf  += 2;                          \
338     size -= 2;                          \
339 } while (0)
340
341     READ16(version);
342     READ16(nb_curves);
343     for (i = 0; i < FFMIN(nb_curves, FF_ARRAY_ELEMS(comp_ids)); i++) {
344         int nb_points, n;
345         av_bprint_clear(&ptstr);
346         READ16(nb_points);
347         for (n = 0; n < nb_points; n++) {
348             int y, x;
349             READ16(y);
350             READ16(x);
351             av_bprintf(&ptstr, "%f/%f ", x / 255., y / 255.);
352         }
353         if (*ptstr.str) {
354             char **pts = &curves->comp_points_str[comp_ids[i]];
355             if (!*pts) {
356                 *pts = av_strdup(ptstr.str);
357                 av_log(ctx, AV_LOG_DEBUG, "curves %d (intid=%d) [%d points]: [%s]\n",
358                        i, comp_ids[i], nb_points, *pts);
359                 if (!*pts) {
360                     ret = AVERROR(ENOMEM);
361                     goto end;
362                 }
363             }
364         }
365     }
366 end:
367     av_bprint_finalize(&ptstr, NULL);
368     av_file_unmap(buf, size);
369     return ret;
370 }
371
372 static av_cold int init(AVFilterContext *ctx)
373 {
374     int i, j, ret;
375     CurvesContext *curves = ctx->priv;
376     struct keypoint *comp_points[NB_COMP + 1] = {0};
377     char **pts = curves->comp_points_str;
378     const char *allp = curves->comp_points_str_all;
379
380     //if (!allp && curves->preset != PRESET_NONE && curves_presets[curves->preset].all)
381     //    allp = curves_presets[curves->preset].all;
382
383     if (allp) {
384         for (i = 0; i < NB_COMP; i++) {
385             if (!pts[i])
386                 pts[i] = av_strdup(allp);
387             if (!pts[i])
388                 return AVERROR(ENOMEM);
389         }
390     }
391
392     if (curves->psfile) {
393         ret = parse_psfile(ctx, curves->psfile);
394         if (ret < 0)
395             return ret;
396     }
397
398     if (curves->preset != PRESET_NONE) {
399 #define SET_COMP_IF_NOT_SET(n, name) do {                           \
400     if (!pts[n] && curves_presets[curves->preset].name) {           \
401         pts[n] = av_strdup(curves_presets[curves->preset].name);    \
402         if (!pts[n])                                                \
403             return AVERROR(ENOMEM);                                 \
404     }                                                               \
405 } while (0)
406         SET_COMP_IF_NOT_SET(0, r);
407         SET_COMP_IF_NOT_SET(1, g);
408         SET_COMP_IF_NOT_SET(2, b);
409         SET_COMP_IF_NOT_SET(3, master);
410     }
411
412     for (i = 0; i < NB_COMP + 1; i++) {
413         ret = parse_points_str(ctx, comp_points + i, curves->comp_points_str[i]);
414         if (ret < 0)
415             return ret;
416         ret = interpolate(ctx, curves->graph[i], comp_points[i]);
417         if (ret < 0)
418             return ret;
419     }
420
421     if (pts[NB_COMP]) {
422         for (i = 0; i < NB_COMP; i++)
423             for (j = 0; j < 256; j++)
424                 curves->graph[i][j] = curves->graph[NB_COMP][curves->graph[i][j]];
425     }
426
427     if (av_log_get_level() >= AV_LOG_VERBOSE) {
428         for (i = 0; i < NB_COMP; i++) {
429             struct keypoint *point = comp_points[i];
430             av_log(ctx, AV_LOG_VERBOSE, "#%d points:", i);
431             while (point) {
432                 av_log(ctx, AV_LOG_VERBOSE, " (%f;%f)", point->x, point->y);
433                 point = point->next;
434             }
435             av_log(ctx, AV_LOG_VERBOSE, "\n");
436             av_log(ctx, AV_LOG_VERBOSE, "#%d values:", i);
437             for (j = 0; j < 256; j++)
438                 av_log(ctx, AV_LOG_VERBOSE, " %02X", curves->graph[i][j]);
439             av_log(ctx, AV_LOG_VERBOSE, "\n");
440         }
441     }
442
443     for (i = 0; i < NB_COMP + 1; i++) {
444         struct keypoint *point = comp_points[i];
445         while (point) {
446             struct keypoint *next = point->next;
447             av_free(point);
448             point = next;
449         }
450     }
451
452     return 0;
453 }
454
455 static int query_formats(AVFilterContext *ctx)
456 {
457     static const enum AVPixelFormat pix_fmts[] = {
458         AV_PIX_FMT_RGB24,  AV_PIX_FMT_BGR24,
459         AV_PIX_FMT_RGBA,   AV_PIX_FMT_BGRA,
460         AV_PIX_FMT_ARGB,   AV_PIX_FMT_ABGR,
461         AV_PIX_FMT_0RGB,   AV_PIX_FMT_0BGR,
462         AV_PIX_FMT_RGB0,   AV_PIX_FMT_BGR0,
463         AV_PIX_FMT_NONE
464     };
465     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
466     return 0;
467 }
468
469 static int config_input(AVFilterLink *inlink)
470 {
471     CurvesContext *curves = inlink->dst->priv;
472     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
473
474     ff_fill_rgba_map(curves->rgba_map, inlink->format);
475     curves->step = av_get_padded_bits_per_pixel(desc) >> 3;
476
477     return 0;
478 }
479
480 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
481 {
482     int x, y;
483     const CurvesContext *curves = ctx->priv;
484     const ThreadData *td = arg;
485     const AVFrame *in  = td->in;
486     const AVFrame *out = td->out;
487     const int direct = out == in;
488     const int step = curves->step;
489     const uint8_t r = curves->rgba_map[R];
490     const uint8_t g = curves->rgba_map[G];
491     const uint8_t b = curves->rgba_map[B];
492     const uint8_t a = curves->rgba_map[A];
493     const int slice_start = (in->height *  jobnr   ) / nb_jobs;
494     const int slice_end   = (in->height * (jobnr+1)) / nb_jobs;
495     uint8_t       *dst = out->data[0] + slice_start * out->linesize[0];
496     const uint8_t *src =  in->data[0] + slice_start *  in->linesize[0];
497
498     for (y = slice_start; y < slice_end; y++) {
499         for (x = 0; x < in->width * step; x += step) {
500             dst[x + r] = curves->graph[R][src[x + r]];
501             dst[x + g] = curves->graph[G][src[x + g]];
502             dst[x + b] = curves->graph[B][src[x + b]];
503             if (!direct && step == 4)
504                 dst[x + a] = src[x + a];
505         }
506         dst += out->linesize[0];
507         src += in ->linesize[0];
508     }
509     return 0;
510 }
511
512 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
513 {
514     AVFilterContext *ctx = inlink->dst;
515     AVFilterLink *outlink = ctx->outputs[0];
516     AVFrame *out;
517     ThreadData td;
518
519     if (av_frame_is_writable(in)) {
520         out = in;
521     } else {
522         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
523         if (!out) {
524             av_frame_free(&in);
525             return AVERROR(ENOMEM);
526         }
527         av_frame_copy_props(out, in);
528     }
529
530     td.in  = in;
531     td.out = out;
532     ctx->internal->execute(ctx, filter_slice, &td, NULL, FFMIN(outlink->h, ctx->graph->nb_threads));
533
534     if (out != in)
535         av_frame_free(&in);
536
537     return ff_filter_frame(outlink, out);
538 }
539
540 static const AVFilterPad curves_inputs[] = {
541     {
542         .name         = "default",
543         .type         = AVMEDIA_TYPE_VIDEO,
544         .filter_frame = filter_frame,
545         .config_props = config_input,
546     },
547     { NULL }
548 };
549
550 static const AVFilterPad curves_outputs[] = {
551     {
552         .name = "default",
553         .type = AVMEDIA_TYPE_VIDEO,
554     },
555     { NULL }
556 };
557
558 AVFilter ff_vf_curves = {
559     .name          = "curves",
560     .description   = NULL_IF_CONFIG_SMALL("Adjust components curves."),
561     .priv_size     = sizeof(CurvesContext),
562     .init          = init,
563     .query_formats = query_formats,
564     .inputs        = curves_inputs,
565     .outputs       = curves_outputs,
566     .priv_class    = &curves_class,
567     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
568 };