Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavfilter / vf_lut.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
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 /**
22  * @file
23  * Compute a look-up table for binding the input value to the output
24  * value, and apply it to input video.
25  */
26
27 #include "libavutil/attributes.h"
28 #include "libavutil/common.h"
29 #include "libavutil/eval.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "avfilter.h"
33 #include "drawutils.h"
34 #include "formats.h"
35 #include "internal.h"
36 #include "video.h"
37
38 static const char *const var_names[] = {
39     "w",        ///< width of the input video
40     "h",        ///< height of the input video
41     "val",      ///< input value for the pixel
42     "maxval",   ///< max value for the pixel
43     "minval",   ///< min value for the pixel
44     "negval",   ///< negated value
45     "clipval",
46     NULL
47 };
48
49 enum var_name {
50     VAR_W,
51     VAR_H,
52     VAR_VAL,
53     VAR_MAXVAL,
54     VAR_MINVAL,
55     VAR_NEGVAL,
56     VAR_CLIPVAL,
57     VAR_VARS_NB
58 };
59
60 typedef struct {
61     const AVClass *class;
62     uint8_t lut[4][256];  ///< lookup table for each component
63     char   *comp_expr_str[4];
64     AVExpr *comp_expr[4];
65     int hsub, vsub;
66     double var_values[VAR_VARS_NB];
67     int is_rgb, is_yuv;
68     int step;
69     int negate_alpha; /* only used by negate */
70 } LutContext;
71
72 #define Y 0
73 #define U 1
74 #define V 2
75 #define R 0
76 #define G 1
77 #define B 2
78 #define A 3
79
80 #define OFFSET(x) offsetof(LutContext, x)
81 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
82
83 static const AVOption options[] = {
84     { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
85     { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
86     { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
87     { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
88     { "y",  "set Y expression",            OFFSET(comp_expr_str[Y]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
89     { "u",  "set U expression",            OFFSET(comp_expr_str[U]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
90     { "v",  "set V expression",            OFFSET(comp_expr_str[V]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
91     { "r",  "set R expression",            OFFSET(comp_expr_str[R]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
92     { "g",  "set G expression",            OFFSET(comp_expr_str[G]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
93     { "b",  "set B expression",            OFFSET(comp_expr_str[B]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
94     { "a",  "set A expression",            OFFSET(comp_expr_str[A]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
95     { NULL },
96 };
97
98 static av_cold void uninit(AVFilterContext *ctx)
99 {
100     LutContext *s = ctx->priv;
101     int i;
102
103     for (i = 0; i < 4; i++) {
104         av_expr_free(s->comp_expr[i]);
105         s->comp_expr[i] = NULL;
106         av_freep(&s->comp_expr_str[i]);
107     }
108 }
109
110 #define YUV_FORMATS                                         \
111     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,    \
112     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUV440P,    \
113     AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P,   \
114     AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,   \
115     AV_PIX_FMT_YUVJ440P
116
117 #define RGB_FORMATS                             \
118     AV_PIX_FMT_ARGB,         AV_PIX_FMT_RGBA,         \
119     AV_PIX_FMT_ABGR,         AV_PIX_FMT_BGRA,         \
120     AV_PIX_FMT_RGB24,        AV_PIX_FMT_BGR24
121
122 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
123 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
124 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
125
126 static int query_formats(AVFilterContext *ctx)
127 {
128     LutContext *s = ctx->priv;
129
130     const enum AVPixelFormat *pix_fmts = s->is_rgb ? rgb_pix_fmts :
131                                        s->is_yuv ? yuv_pix_fmts : all_pix_fmts;
132
133     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
134     return 0;
135 }
136
137 /**
138  * Clip value val in the minval - maxval range.
139  */
140 static double clip(void *opaque, double val)
141 {
142     LutContext *s = opaque;
143     double minval = s->var_values[VAR_MINVAL];
144     double maxval = s->var_values[VAR_MAXVAL];
145
146     return av_clip(val, minval, maxval);
147 }
148
149 /**
150  * Compute gamma correction for value val, assuming the minval-maxval
151  * range, val is clipped to a value contained in the same interval.
152  */
153 static double compute_gammaval(void *opaque, double gamma)
154 {
155     LutContext *s = opaque;
156     double val    = s->var_values[VAR_CLIPVAL];
157     double minval = s->var_values[VAR_MINVAL];
158     double maxval = s->var_values[VAR_MAXVAL];
159
160     return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
161 }
162
163 static double (* const funcs1[])(void *, double) = {
164     (void *)clip,
165     (void *)compute_gammaval,
166     NULL
167 };
168
169 static const char * const funcs1_names[] = {
170     "clip",
171     "gammaval",
172     NULL
173 };
174
175 static int config_props(AVFilterLink *inlink)
176 {
177     AVFilterContext *ctx = inlink->dst;
178     LutContext *s = ctx->priv;
179     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
180     uint8_t rgba_map[4]; /* component index -> RGBA color index map */
181     int min[4], max[4];
182     int val, color, ret;
183
184     s->hsub = desc->log2_chroma_w;
185     s->vsub = desc->log2_chroma_h;
186
187     s->var_values[VAR_W] = inlink->w;
188     s->var_values[VAR_H] = inlink->h;
189
190     switch (inlink->format) {
191     case AV_PIX_FMT_YUV410P:
192     case AV_PIX_FMT_YUV411P:
193     case AV_PIX_FMT_YUV420P:
194     case AV_PIX_FMT_YUV422P:
195     case AV_PIX_FMT_YUV440P:
196     case AV_PIX_FMT_YUV444P:
197     case AV_PIX_FMT_YUVA420P:
198     case AV_PIX_FMT_YUVA422P:
199     case AV_PIX_FMT_YUVA444P:
200         min[Y] = min[U] = min[V] = 16;
201         max[Y] = 235;
202         max[U] = max[V] = 240;
203         min[A] = 0; max[A] = 255;
204         break;
205     default:
206         min[0] = min[1] = min[2] = min[3] = 0;
207         max[0] = max[1] = max[2] = max[3] = 255;
208     }
209
210     s->is_yuv = s->is_rgb = 0;
211     if      (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) s->is_yuv = 1;
212     else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) s->is_rgb = 1;
213
214     if (s->is_rgb) {
215         ff_fill_rgba_map(rgba_map, inlink->format);
216         s->step = av_get_bits_per_pixel(desc) >> 3;
217     }
218
219     for (color = 0; color < desc->nb_components; color++) {
220         double res;
221         int comp = s->is_rgb ? rgba_map[color] : color;
222
223         /* create the parsed expression */
224         ret = av_expr_parse(&s->comp_expr[color], s->comp_expr_str[color],
225                             var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
226         if (ret < 0) {
227             av_log(ctx, AV_LOG_ERROR,
228                    "Error when parsing the expression '%s' for the component %d and color %d.\n",
229                    s->comp_expr_str[comp], comp, color);
230             return AVERROR(EINVAL);
231         }
232
233         /* compute the lut */
234         s->var_values[VAR_MAXVAL] = max[color];
235         s->var_values[VAR_MINVAL] = min[color];
236
237         for (val = 0; val < 256; val++) {
238             s->var_values[VAR_VAL] = val;
239             s->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
240             s->var_values[VAR_NEGVAL] =
241                 av_clip(min[color] + max[color] - s->var_values[VAR_VAL],
242                         min[color], max[color]);
243
244             res = av_expr_eval(s->comp_expr[color], s->var_values, s);
245             if (isnan(res)) {
246                 av_log(ctx, AV_LOG_ERROR,
247                        "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
248                        s->comp_expr_str[color], val, comp);
249                 return AVERROR(EINVAL);
250             }
251             s->lut[comp][val] = av_clip((int)res, min[color], max[color]);
252             av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, s->lut[comp][val]);
253         }
254     }
255
256     return 0;
257 }
258
259 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
260 {
261     AVFilterContext *ctx = inlink->dst;
262     LutContext *s = ctx->priv;
263     AVFilterLink *outlink = ctx->outputs[0];
264     AVFrame *out;
265     uint8_t *inrow, *outrow, *inrow0, *outrow0;
266     int i, j, plane, direct = 0;
267
268     if (av_frame_is_writable(in)) {
269         direct = 1;
270         out = in;
271     } else {
272         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
273         if (!out) {
274             av_frame_free(&in);
275             return AVERROR(ENOMEM);
276         }
277         av_frame_copy_props(out, in);
278     }
279
280     if (s->is_rgb) {
281         /* packed */
282         inrow0  = in ->data[0];
283         outrow0 = out->data[0];
284
285         for (i = 0; i < in->height; i ++) {
286             int w = inlink->w;
287             const uint8_t (*tab)[256] = (const uint8_t (*)[256])s->lut;
288             inrow  = inrow0;
289             outrow = outrow0;
290             for (j = 0; j < w; j++) {
291                 switch (s->step) {
292                 case 4:  outrow[3] = tab[3][inrow[3]]; // Fall-through
293                 case 3:  outrow[2] = tab[2][inrow[2]]; // Fall-through
294                 case 2:  outrow[1] = tab[1][inrow[1]]; // Fall-through
295                 default: outrow[0] = tab[0][inrow[0]];
296                 }
297                 outrow += s->step;
298                 inrow  += s->step;
299             }
300             inrow0  += in ->linesize[0];
301             outrow0 += out->linesize[0];
302         }
303     } else {
304         /* planar */
305         for (plane = 0; plane < 4 && in->data[plane]; plane++) {
306             int vsub = plane == 1 || plane == 2 ? s->vsub : 0;
307             int hsub = plane == 1 || plane == 2 ? s->hsub : 0;
308             int h = FF_CEIL_RSHIFT(inlink->h, vsub);
309             int w = FF_CEIL_RSHIFT(inlink->w, hsub);
310
311             inrow  = in ->data[plane];
312             outrow = out->data[plane];
313
314             for (i = 0; i < h; i++) {
315                 const uint8_t *tab = s->lut[plane];
316                 for (j = 0; j < w; j++)
317                     outrow[j] = tab[inrow[j]];
318                 inrow  += in ->linesize[plane];
319                 outrow += out->linesize[plane];
320             }
321         }
322     }
323
324     if (!direct)
325         av_frame_free(&in);
326
327     return ff_filter_frame(outlink, out);
328 }
329
330 static const AVFilterPad inputs[] = {
331     { .name            = "default",
332       .type            = AVMEDIA_TYPE_VIDEO,
333       .filter_frame    = filter_frame,
334       .config_props    = config_props,
335     },
336     { .name = NULL}
337 };
338 static const AVFilterPad outputs[] = {
339     { .name            = "default",
340       .type            = AVMEDIA_TYPE_VIDEO, },
341     { .name = NULL}
342 };
343
344 #define DEFINE_LUT_FILTER(name_, description_)                          \
345     AVFilter avfilter_vf_##name_ = {                                    \
346         .name          = #name_,                                        \
347         .description   = NULL_IF_CONFIG_SMALL(description_),            \
348         .priv_size     = sizeof(LutContext),                            \
349         .priv_class    = &name_ ## _class,                              \
350                                                                         \
351         .init          = name_##_init,                                  \
352         .uninit        = uninit,                                        \
353         .query_formats = query_formats,                                 \
354                                                                         \
355         .inputs        = inputs,                                        \
356         .outputs       = outputs,                                       \
357         .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,        \
358     }
359
360 #if CONFIG_LUT_FILTER
361
362 #define lut_options options
363 AVFILTER_DEFINE_CLASS(lut);
364
365 static int lut_init(AVFilterContext *ctx)
366 {
367     return 0;
368 }
369
370 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.");
371 #endif
372
373 #if CONFIG_LUTYUV_FILTER
374
375 #define lutyuv_options options
376 AVFILTER_DEFINE_CLASS(lutyuv);
377
378 static av_cold int lutyuv_init(AVFilterContext *ctx)
379 {
380     LutContext *s = ctx->priv;
381
382     s->is_yuv = 1;
383
384     return 0;
385 }
386
387 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.");
388 #endif
389
390 #if CONFIG_LUTRGB_FILTER
391
392 #define lutrgb_options options
393 AVFILTER_DEFINE_CLASS(lutrgb);
394
395 static av_cold int lutrgb_init(AVFilterContext *ctx)
396 {
397     LutContext *s = ctx->priv;
398
399     s->is_rgb = 1;
400
401     return 0;
402 }
403
404 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.");
405 #endif
406
407 #if CONFIG_NEGATE_FILTER
408
409 static const AVOption negate_options[] = {
410     { "negate_alpha", NULL, OFFSET(negate_alpha), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS },
411     { NULL },
412 };
413
414 AVFILTER_DEFINE_CLASS(negate);
415
416 static av_cold int negate_init(AVFilterContext *ctx)
417 {
418     LutContext *s = ctx->priv;
419     int i;
420
421     av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", s->negate_alpha);
422
423     for (i = 0; i < 4; i++) {
424         s->comp_expr_str[i] = av_strdup((i == 3 && !s->negate_alpha) ?
425                                           "val" : "negval");
426         if (!s->comp_expr_str[i]) {
427             uninit(ctx);
428             return AVERROR(ENOMEM);
429         }
430     }
431
432     return 0;
433 }
434
435 DEFINE_LUT_FILTER(negate, "Negate input video.");
436
437 #endif