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