2 * Copyright (c) 2011 Stefano Sabatini
4 * This file is part of FFmpeg.
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.
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.
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
23 * Compute a look-up table for binding the input value to the output
24 * value, and apply it to input video.
27 #include "libavutil/attributes.h"
28 #include "libavutil/bswap.h"
29 #include "libavutil/common.h"
30 #include "libavutil/eval.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
34 #include "drawutils.h"
39 static const char *const var_names[] = {
40 "w", ///< width of the input video
41 "h", ///< height of the input video
42 "val", ///< input value for the pixel
43 "maxval", ///< max value for the pixel
44 "minval", ///< min value for the pixel
45 "negval", ///< negated value
61 typedef struct LutContext {
63 uint16_t lut[4][256 * 256]; ///< lookup table for each component
64 char *comp_expr_str[4];
67 double var_values[VAR_VARS_NB];
72 int negate_alpha; /* only used by negate */
83 #define OFFSET(x) offsetof(LutContext, x)
84 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
86 static const AVOption options[] = {
87 { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
88 { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
89 { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
90 { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
91 { "y", "set Y expression", OFFSET(comp_expr_str[Y]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
92 { "u", "set U expression", OFFSET(comp_expr_str[U]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
93 { "v", "set V expression", OFFSET(comp_expr_str[V]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
94 { "r", "set R expression", OFFSET(comp_expr_str[R]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
95 { "g", "set G expression", OFFSET(comp_expr_str[G]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
96 { "b", "set B expression", OFFSET(comp_expr_str[B]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
97 { "a", "set A expression", OFFSET(comp_expr_str[A]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
101 static av_cold void uninit(AVFilterContext *ctx)
103 LutContext *s = ctx->priv;
106 for (i = 0; i < 4; i++) {
107 av_expr_free(s->comp_expr[i]);
108 s->comp_expr[i] = NULL;
109 av_freep(&s->comp_expr_str[i]);
113 #define YUV_FORMATS \
114 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, \
115 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P, \
116 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P, \
117 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P, \
118 AV_PIX_FMT_YUVJ440P, \
119 AV_PIX_FMT_YUV444P9LE, AV_PIX_FMT_YUV422P9LE, AV_PIX_FMT_YUV420P9LE, \
120 AV_PIX_FMT_YUV444P10LE, AV_PIX_FMT_YUV422P10LE, AV_PIX_FMT_YUV420P10LE, AV_PIX_FMT_YUV440P10LE, \
121 AV_PIX_FMT_YUV444P12LE, AV_PIX_FMT_YUV422P12LE, AV_PIX_FMT_YUV420P12LE, AV_PIX_FMT_YUV440P12LE, \
122 AV_PIX_FMT_YUV444P14LE, AV_PIX_FMT_YUV422P14LE, AV_PIX_FMT_YUV420P14LE, \
123 AV_PIX_FMT_YUV444P16LE, AV_PIX_FMT_YUV422P16LE, AV_PIX_FMT_YUV420P16LE, \
124 AV_PIX_FMT_YUVA444P16LE, AV_PIX_FMT_YUVA422P16LE, AV_PIX_FMT_YUVA420P16LE
126 #define RGB_FORMATS \
127 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA, \
128 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA, \
129 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24, \
130 AV_PIX_FMT_RGB48LE, AV_PIX_FMT_RGBA64LE, \
131 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, \
132 AV_PIX_FMT_GBRP9LE, AV_PIX_FMT_GBRP10LE, \
133 AV_PIX_FMT_GBRAP10LE, \
134 AV_PIX_FMT_GBRP12LE, AV_PIX_FMT_GBRP14LE, \
135 AV_PIX_FMT_GBRP16LE, AV_PIX_FMT_GBRAP12LE, \
138 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
139 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
140 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
142 static int query_formats(AVFilterContext *ctx)
144 LutContext *s = ctx->priv;
146 const enum AVPixelFormat *pix_fmts = s->is_rgb ? rgb_pix_fmts :
147 s->is_yuv ? yuv_pix_fmts :
149 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
151 return AVERROR(ENOMEM);
152 return ff_set_common_formats(ctx, fmts_list);
156 * Clip value val in the minval - maxval range.
158 static double clip(void *opaque, double val)
160 LutContext *s = opaque;
161 double minval = s->var_values[VAR_MINVAL];
162 double maxval = s->var_values[VAR_MAXVAL];
164 return av_clip(val, minval, maxval);
168 * Compute gamma correction for value val, assuming the minval-maxval
169 * range, val is clipped to a value contained in the same interval.
171 static double compute_gammaval(void *opaque, double gamma)
173 LutContext *s = opaque;
174 double val = s->var_values[VAR_CLIPVAL];
175 double minval = s->var_values[VAR_MINVAL];
176 double maxval = s->var_values[VAR_MAXVAL];
178 return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
182 * Compute ITU Rec.709 gamma correction of value val.
184 static double compute_gammaval709(void *opaque, double gamma)
186 LutContext *s = opaque;
187 double val = s->var_values[VAR_CLIPVAL];
188 double minval = s->var_values[VAR_MINVAL];
189 double maxval = s->var_values[VAR_MAXVAL];
190 double level = (val - minval) / (maxval - minval);
191 level = level < 0.018 ? 4.5 * level
192 : 1.099 * pow(level, 1.0 / gamma) - 0.099;
193 return level * (maxval - minval) + minval;
196 static double (* const funcs1[])(void *, double) = {
203 static const char * const funcs1_names[] = {
210 static int config_props(AVFilterLink *inlink)
212 AVFilterContext *ctx = inlink->dst;
213 LutContext *s = ctx->priv;
214 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
215 uint8_t rgba_map[4]; /* component index -> RGBA color index map */
219 s->hsub = desc->log2_chroma_w;
220 s->vsub = desc->log2_chroma_h;
222 s->var_values[VAR_W] = inlink->w;
223 s->var_values[VAR_H] = inlink->h;
224 s->is_16bit = desc->comp[0].depth > 8;
226 switch (inlink->format) {
227 case AV_PIX_FMT_YUV410P:
228 case AV_PIX_FMT_YUV411P:
229 case AV_PIX_FMT_YUV420P:
230 case AV_PIX_FMT_YUV422P:
231 case AV_PIX_FMT_YUV440P:
232 case AV_PIX_FMT_YUV444P:
233 case AV_PIX_FMT_YUVA420P:
234 case AV_PIX_FMT_YUVA422P:
235 case AV_PIX_FMT_YUVA444P:
236 case AV_PIX_FMT_YUV420P9LE:
237 case AV_PIX_FMT_YUV422P9LE:
238 case AV_PIX_FMT_YUV444P9LE:
239 case AV_PIX_FMT_YUVA420P9LE:
240 case AV_PIX_FMT_YUVA422P9LE:
241 case AV_PIX_FMT_YUVA444P9LE:
242 case AV_PIX_FMT_YUV420P10LE:
243 case AV_PIX_FMT_YUV422P10LE:
244 case AV_PIX_FMT_YUV440P10LE:
245 case AV_PIX_FMT_YUV444P10LE:
246 case AV_PIX_FMT_YUVA420P10LE:
247 case AV_PIX_FMT_YUVA422P10LE:
248 case AV_PIX_FMT_YUVA444P10LE:
249 case AV_PIX_FMT_YUV420P12LE:
250 case AV_PIX_FMT_YUV422P12LE:
251 case AV_PIX_FMT_YUV440P12LE:
252 case AV_PIX_FMT_YUV444P12LE:
253 case AV_PIX_FMT_YUV420P14LE:
254 case AV_PIX_FMT_YUV422P14LE:
255 case AV_PIX_FMT_YUV444P14LE:
256 case AV_PIX_FMT_YUV420P16LE:
257 case AV_PIX_FMT_YUV422P16LE:
258 case AV_PIX_FMT_YUV444P16LE:
259 case AV_PIX_FMT_YUVA420P16LE:
260 case AV_PIX_FMT_YUVA422P16LE:
261 case AV_PIX_FMT_YUVA444P16LE:
262 min[Y] = 16 * (1 << (desc->comp[0].depth - 8));
263 min[U] = 16 * (1 << (desc->comp[1].depth - 8));
264 min[V] = 16 * (1 << (desc->comp[2].depth - 8));
266 max[Y] = 235 * (1 << (desc->comp[0].depth - 8));
267 max[U] = 240 * (1 << (desc->comp[1].depth - 8));
268 max[V] = 240 * (1 << (desc->comp[2].depth - 8));
269 max[A] = (1 << desc->comp[0].depth) - 1;
271 case AV_PIX_FMT_RGB48LE:
272 case AV_PIX_FMT_RGBA64LE:
273 min[0] = min[1] = min[2] = min[3] = 0;
274 max[0] = max[1] = max[2] = max[3] = 65535;
277 min[0] = min[1] = min[2] = min[3] = 0;
278 max[0] = max[1] = max[2] = max[3] = 255 * (1 << (desc->comp[0].depth - 8));
281 s->is_yuv = s->is_rgb = 0;
282 s->is_planar = desc->flags & AV_PIX_FMT_FLAG_PLANAR;
283 if (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) s->is_yuv = 1;
284 else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) s->is_rgb = 1;
287 ff_fill_rgba_map(rgba_map, inlink->format);
288 s->step = av_get_bits_per_pixel(desc) >> 3;
290 s->step = s->step >> 1;
294 for (color = 0; color < desc->nb_components; color++) {
296 int comp = s->is_rgb ? rgba_map[color] : color;
298 /* create the parsed expression */
299 av_expr_free(s->comp_expr[color]);
300 s->comp_expr[color] = NULL;
301 ret = av_expr_parse(&s->comp_expr[color], s->comp_expr_str[color],
302 var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
304 av_log(ctx, AV_LOG_ERROR,
305 "Error when parsing the expression '%s' for the component %d and color %d.\n",
306 s->comp_expr_str[comp], comp, color);
307 return AVERROR(EINVAL);
310 /* compute the lut */
311 s->var_values[VAR_MAXVAL] = max[color];
312 s->var_values[VAR_MINVAL] = min[color];
314 for (val = 0; val < FF_ARRAY_ELEMS(s->lut[comp]); val++) {
315 s->var_values[VAR_VAL] = val;
316 s->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
317 s->var_values[VAR_NEGVAL] =
318 av_clip(min[color] + max[color] - s->var_values[VAR_VAL],
319 min[color], max[color]);
321 res = av_expr_eval(s->comp_expr[color], s->var_values, s);
323 av_log(ctx, AV_LOG_ERROR,
324 "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
325 s->comp_expr_str[color], val, comp);
326 return AVERROR(EINVAL);
328 s->lut[comp][val] = av_clip((int)res, 0, max[A]);
329 av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, s->lut[comp][val]);
336 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
338 AVFilterContext *ctx = inlink->dst;
339 LutContext *s = ctx->priv;
340 AVFilterLink *outlink = ctx->outputs[0];
342 int i, j, plane, direct = 0;
344 if (av_frame_is_writable(in)) {
348 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
351 return AVERROR(ENOMEM);
353 av_frame_copy_props(out, in);
356 if (s->is_rgb && s->is_16bit && !s->is_planar) {
358 uint16_t *inrow, *outrow, *inrow0, *outrow0;
359 const int w = inlink->w;
360 const int h = in->height;
361 const uint16_t (*tab)[256*256] = (const uint16_t (*)[256*256])s->lut;
362 const int in_linesize = in->linesize[0] / 2;
363 const int out_linesize = out->linesize[0] / 2;
364 const int step = s->step;
366 inrow0 = (uint16_t*) in ->data[0];
367 outrow0 = (uint16_t*) out->data[0];
369 for (i = 0; i < h; i ++) {
372 for (j = 0; j < w; j++) {
376 case 4: outrow[3] = av_bswap16(tab[3][av_bswap16(inrow[3])]); // Fall-through
377 case 3: outrow[2] = av_bswap16(tab[2][av_bswap16(inrow[2])]); // Fall-through
378 case 2: outrow[1] = av_bswap16(tab[1][av_bswap16(inrow[1])]); // Fall-through
379 default: outrow[0] = av_bswap16(tab[0][av_bswap16(inrow[0])]);
381 case 4: outrow[3] = tab[3][inrow[3]]; // Fall-through
382 case 3: outrow[2] = tab[2][inrow[2]]; // Fall-through
383 case 2: outrow[1] = tab[1][inrow[1]]; // Fall-through
384 default: outrow[0] = tab[0][inrow[0]];
390 inrow0 += in_linesize;
391 outrow0 += out_linesize;
393 } else if (s->is_rgb && !s->is_planar) {
395 uint8_t *inrow, *outrow, *inrow0, *outrow0;
396 const int w = inlink->w;
397 const int h = in->height;
398 const uint16_t (*tab)[256*256] = (const uint16_t (*)[256*256])s->lut;
399 const int in_linesize = in->linesize[0];
400 const int out_linesize = out->linesize[0];
401 const int step = s->step;
403 inrow0 = in ->data[0];
404 outrow0 = out->data[0];
406 for (i = 0; i < h; i ++) {
409 for (j = 0; j < w; j++) {
411 case 4: outrow[3] = tab[3][inrow[3]]; // Fall-through
412 case 3: outrow[2] = tab[2][inrow[2]]; // Fall-through
413 case 2: outrow[1] = tab[1][inrow[1]]; // Fall-through
414 default: outrow[0] = tab[0][inrow[0]];
419 inrow0 += in_linesize;
420 outrow0 += out_linesize;
422 } else if (s->is_16bit) {
423 // planar >8 bit depth
424 uint16_t *inrow, *outrow;
426 for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
427 int vsub = plane == 1 || plane == 2 ? s->vsub : 0;
428 int hsub = plane == 1 || plane == 2 ? s->hsub : 0;
429 int h = AV_CEIL_RSHIFT(inlink->h, vsub);
430 int w = AV_CEIL_RSHIFT(inlink->w, hsub);
431 const uint16_t *tab = s->lut[plane];
432 const int in_linesize = in->linesize[plane] / 2;
433 const int out_linesize = out->linesize[plane] / 2;
435 inrow = (uint16_t *)in ->data[plane];
436 outrow = (uint16_t *)out->data[plane];
438 for (i = 0; i < h; i++) {
439 for (j = 0; j < w; j++) {
441 outrow[j] = av_bswap16(tab[av_bswap16(inrow[j])]);
443 outrow[j] = tab[inrow[j]];
446 inrow += in_linesize;
447 outrow += out_linesize;
451 /* planar 8bit depth */
452 uint8_t *inrow, *outrow;
454 for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
455 int vsub = plane == 1 || plane == 2 ? s->vsub : 0;
456 int hsub = plane == 1 || plane == 2 ? s->hsub : 0;
457 int h = AV_CEIL_RSHIFT(inlink->h, vsub);
458 int w = AV_CEIL_RSHIFT(inlink->w, hsub);
459 const uint16_t *tab = s->lut[plane];
460 const int in_linesize = in->linesize[plane];
461 const int out_linesize = out->linesize[plane];
463 inrow = in ->data[plane];
464 outrow = out->data[plane];
466 for (i = 0; i < h; i++) {
467 for (j = 0; j < w; j++)
468 outrow[j] = tab[inrow[j]];
469 inrow += in_linesize;
470 outrow += out_linesize;
478 return ff_filter_frame(outlink, out);
481 static const AVFilterPad inputs[] = {
483 .type = AVMEDIA_TYPE_VIDEO,
484 .filter_frame = filter_frame,
485 .config_props = config_props,
489 static const AVFilterPad outputs[] = {
491 .type = AVMEDIA_TYPE_VIDEO,
496 #define DEFINE_LUT_FILTER(name_, description_) \
497 AVFilter ff_vf_##name_ = { \
499 .description = NULL_IF_CONFIG_SMALL(description_), \
500 .priv_size = sizeof(LutContext), \
501 .priv_class = &name_ ## _class, \
502 .init = name_##_init, \
504 .query_formats = query_formats, \
506 .outputs = outputs, \
507 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, \
510 #if CONFIG_LUT_FILTER
512 #define lut_options options
513 AVFILTER_DEFINE_CLASS(lut);
515 static int lut_init(AVFilterContext *ctx)
520 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.");
523 #if CONFIG_LUTYUV_FILTER
525 #define lutyuv_options options
526 AVFILTER_DEFINE_CLASS(lutyuv);
528 static av_cold int lutyuv_init(AVFilterContext *ctx)
530 LutContext *s = ctx->priv;
537 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.");
540 #if CONFIG_LUTRGB_FILTER
542 #define lutrgb_options options
543 AVFILTER_DEFINE_CLASS(lutrgb);
545 static av_cold int lutrgb_init(AVFilterContext *ctx)
547 LutContext *s = ctx->priv;
554 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.");
557 #if CONFIG_NEGATE_FILTER
559 static const AVOption negate_options[] = {
560 { "negate_alpha", NULL, OFFSET(negate_alpha), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
564 AVFILTER_DEFINE_CLASS(negate);
566 static av_cold int negate_init(AVFilterContext *ctx)
568 LutContext *s = ctx->priv;
571 av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", s->negate_alpha);
573 for (i = 0; i < 4; i++) {
574 s->comp_expr_str[i] = av_strdup((i == 3 && !s->negate_alpha) ?
576 if (!s->comp_expr_str[i]) {
578 return AVERROR(ENOMEM);
585 DEFINE_LUT_FILTER(negate, "Negate input video.");