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];
71 int negate_alpha; /* only used by negate */
82 #define OFFSET(x) offsetof(LutContext, x)
83 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
85 static const AVOption options[] = {
86 { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
87 { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
88 { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
89 { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
90 { "y", "set Y expression", OFFSET(comp_expr_str[Y]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
91 { "u", "set U expression", OFFSET(comp_expr_str[U]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
92 { "v", "set V expression", OFFSET(comp_expr_str[V]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
93 { "r", "set R expression", OFFSET(comp_expr_str[R]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
94 { "g", "set G expression", OFFSET(comp_expr_str[G]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
95 { "b", "set B expression", OFFSET(comp_expr_str[B]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
96 { "a", "set A expression", OFFSET(comp_expr_str[A]), AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
100 static av_cold void uninit(AVFilterContext *ctx)
102 LutContext *s = ctx->priv;
105 for (i = 0; i < 4; i++) {
106 av_expr_free(s->comp_expr[i]);
107 s->comp_expr[i] = NULL;
108 av_freep(&s->comp_expr_str[i]);
112 #define YUV_FORMATS \
113 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, \
114 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P, \
115 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P, \
116 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P, \
117 AV_PIX_FMT_YUVJ440P, \
118 AV_PIX_FMT_YUV444P9LE, AV_PIX_FMT_YUV422P9LE, AV_PIX_FMT_YUV420P9LE, \
119 AV_PIX_FMT_YUV444P10LE, AV_PIX_FMT_YUV422P10LE, AV_PIX_FMT_YUV420P10LE, AV_PIX_FMT_YUV440P10LE, \
120 AV_PIX_FMT_YUV444P12LE, AV_PIX_FMT_YUV422P12LE, AV_PIX_FMT_YUV420P12LE, AV_PIX_FMT_YUV440P12LE, \
121 AV_PIX_FMT_YUV444P14LE, AV_PIX_FMT_YUV422P14LE, AV_PIX_FMT_YUV420P14LE, \
122 AV_PIX_FMT_YUV444P16LE, AV_PIX_FMT_YUV422P16LE, AV_PIX_FMT_YUV420P16LE, \
123 AV_PIX_FMT_YUVA444P16LE, AV_PIX_FMT_YUVA422P16LE, AV_PIX_FMT_YUVA420P16LE
125 #define RGB_FORMATS \
126 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA, \
127 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA, \
128 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24
130 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
131 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
132 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
134 static int query_formats(AVFilterContext *ctx)
136 LutContext *s = ctx->priv;
138 const enum AVPixelFormat *pix_fmts = s->is_rgb ? rgb_pix_fmts :
139 s->is_yuv ? yuv_pix_fmts :
141 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
143 return AVERROR(ENOMEM);
144 return ff_set_common_formats(ctx, fmts_list);
148 * Clip value val in the minval - maxval range.
150 static double clip(void *opaque, double val)
152 LutContext *s = opaque;
153 double minval = s->var_values[VAR_MINVAL];
154 double maxval = s->var_values[VAR_MAXVAL];
156 return av_clip(val, minval, maxval);
160 * Compute gamma correction for value val, assuming the minval-maxval
161 * range, val is clipped to a value contained in the same interval.
163 static double compute_gammaval(void *opaque, double gamma)
165 LutContext *s = opaque;
166 double val = s->var_values[VAR_CLIPVAL];
167 double minval = s->var_values[VAR_MINVAL];
168 double maxval = s->var_values[VAR_MAXVAL];
170 return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
174 * Compute ITU Rec.709 gamma correction of value val.
176 static double compute_gammaval709(void *opaque, double gamma)
178 LutContext *s = opaque;
179 double val = s->var_values[VAR_CLIPVAL];
180 double minval = s->var_values[VAR_MINVAL];
181 double maxval = s->var_values[VAR_MAXVAL];
182 double level = (val - minval) / (maxval - minval);
183 level = level < 0.018 ? 4.5 * level
184 : 1.099 * pow(level, 1.0 / gamma) - 0.099;
185 return level * (maxval - minval) + minval;
188 static double (* const funcs1[])(void *, double) = {
190 (void *)compute_gammaval,
191 (void *)compute_gammaval709,
195 static const char * const funcs1_names[] = {
202 static int config_props(AVFilterLink *inlink)
204 AVFilterContext *ctx = inlink->dst;
205 LutContext *s = ctx->priv;
206 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
207 uint8_t rgba_map[4]; /* component index -> RGBA color index map */
211 s->hsub = desc->log2_chroma_w;
212 s->vsub = desc->log2_chroma_h;
214 s->var_values[VAR_W] = inlink->w;
215 s->var_values[VAR_H] = inlink->h;
216 s->is_16bit = desc->comp[0].depth_minus1 > 7;
218 switch (inlink->format) {
219 case AV_PIX_FMT_YUV410P:
220 case AV_PIX_FMT_YUV411P:
221 case AV_PIX_FMT_YUV420P:
222 case AV_PIX_FMT_YUV422P:
223 case AV_PIX_FMT_YUV440P:
224 case AV_PIX_FMT_YUV444P:
225 case AV_PIX_FMT_YUVA420P:
226 case AV_PIX_FMT_YUVA422P:
227 case AV_PIX_FMT_YUVA444P:
228 case AV_PIX_FMT_YUV420P9LE:
229 case AV_PIX_FMT_YUV422P9LE:
230 case AV_PIX_FMT_YUV444P9LE:
231 case AV_PIX_FMT_YUVA420P9LE:
232 case AV_PIX_FMT_YUVA422P9LE:
233 case AV_PIX_FMT_YUVA444P9LE:
234 case AV_PIX_FMT_YUV420P10LE:
235 case AV_PIX_FMT_YUV422P10LE:
236 case AV_PIX_FMT_YUV440P10LE:
237 case AV_PIX_FMT_YUV444P10LE:
238 case AV_PIX_FMT_YUVA420P10LE:
239 case AV_PIX_FMT_YUVA422P10LE:
240 case AV_PIX_FMT_YUVA444P10LE:
241 case AV_PIX_FMT_YUV420P12LE:
242 case AV_PIX_FMT_YUV422P12LE:
243 case AV_PIX_FMT_YUV440P12LE:
244 case AV_PIX_FMT_YUV444P12LE:
245 case AV_PIX_FMT_YUV420P14LE:
246 case AV_PIX_FMT_YUV422P14LE:
247 case AV_PIX_FMT_YUV444P14LE:
248 case AV_PIX_FMT_YUV420P16LE:
249 case AV_PIX_FMT_YUV422P16LE:
250 case AV_PIX_FMT_YUV444P16LE:
251 case AV_PIX_FMT_YUVA420P16LE:
252 case AV_PIX_FMT_YUVA422P16LE:
253 case AV_PIX_FMT_YUVA444P16LE:
254 min[Y] = 16 * (1 << (desc->comp[0].depth_minus1 - 7));
255 min[U] = 16 * (1 << (desc->comp[1].depth_minus1 - 7));
256 min[V] = 16 * (1 << (desc->comp[2].depth_minus1 - 7));
258 max[Y] = 235 * (1 << (desc->comp[0].depth_minus1 - 7));
259 max[U] = 240 * (1 << (desc->comp[1].depth_minus1 - 7));
260 max[V] = 240 * (1 << (desc->comp[2].depth_minus1 - 7));
261 max[A] = (1 << (desc->comp[3].depth_minus1 + 1)) - 1;
264 min[0] = min[1] = min[2] = min[3] = 0;
265 max[0] = max[1] = max[2] = max[3] = 255;
268 s->is_yuv = s->is_rgb = 0;
269 if (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) s->is_yuv = 1;
270 else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) s->is_rgb = 1;
273 ff_fill_rgba_map(rgba_map, inlink->format);
274 s->step = av_get_bits_per_pixel(desc) >> 3;
277 for (color = 0; color < desc->nb_components; color++) {
279 int comp = s->is_rgb ? rgba_map[color] : color;
281 /* create the parsed expression */
282 av_expr_free(s->comp_expr[color]);
283 s->comp_expr[color] = NULL;
284 ret = av_expr_parse(&s->comp_expr[color], s->comp_expr_str[color],
285 var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
287 av_log(ctx, AV_LOG_ERROR,
288 "Error when parsing the expression '%s' for the component %d and color %d.\n",
289 s->comp_expr_str[comp], comp, color);
290 return AVERROR(EINVAL);
293 /* compute the lut */
294 s->var_values[VAR_MAXVAL] = max[color];
295 s->var_values[VAR_MINVAL] = min[color];
297 for (val = 0; val < (1 << (desc->comp[0].depth_minus1 + 1)); val++) {
298 s->var_values[VAR_VAL] = val;
299 s->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
300 s->var_values[VAR_NEGVAL] =
301 av_clip(min[color] + max[color] - s->var_values[VAR_VAL],
302 min[color], max[color]);
304 res = av_expr_eval(s->comp_expr[color], s->var_values, s);
306 av_log(ctx, AV_LOG_ERROR,
307 "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
308 s->comp_expr_str[color], val, comp);
309 return AVERROR(EINVAL);
311 s->lut[comp][val] = av_clip((int)res, min[color], max[color]);
312 av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, s->lut[comp][val]);
319 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
321 AVFilterContext *ctx = inlink->dst;
322 LutContext *s = ctx->priv;
323 AVFilterLink *outlink = ctx->outputs[0];
325 int i, j, plane, direct = 0;
327 if (av_frame_is_writable(in)) {
331 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
334 return AVERROR(ENOMEM);
336 av_frame_copy_props(out, in);
341 uint8_t *inrow, *outrow, *inrow0, *outrow0;
342 const int w = inlink->w;
343 const int h = in->height;
344 const uint16_t (*tab)[256*256] = (const uint16_t (*)[256*256])s->lut;
345 const int in_linesize = in->linesize[0];
346 const int out_linesize = out->linesize[0];
347 const int step = s->step;
349 inrow0 = in ->data[0];
350 outrow0 = out->data[0];
352 for (i = 0; i < h; i ++) {
355 for (j = 0; j < w; j++) {
357 case 4: outrow[3] = tab[3][inrow[3]]; // Fall-through
358 case 3: outrow[2] = tab[2][inrow[2]]; // Fall-through
359 case 2: outrow[1] = tab[1][inrow[1]]; // Fall-through
360 default: outrow[0] = tab[0][inrow[0]];
365 inrow0 += in_linesize;
366 outrow0 += out_linesize;
368 } else if (s->is_16bit) {
369 // planar yuv >8 bit depth
370 uint16_t *inrow, *outrow;
372 for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
373 int vsub = plane == 1 || plane == 2 ? s->vsub : 0;
374 int hsub = plane == 1 || plane == 2 ? s->hsub : 0;
375 int h = FF_CEIL_RSHIFT(inlink->h, vsub);
376 int w = FF_CEIL_RSHIFT(inlink->w, hsub);
377 const uint16_t *tab = s->lut[plane];
378 const int in_linesize = in->linesize[plane] / 2;
379 const int out_linesize = out->linesize[plane] / 2;
381 inrow = (uint16_t *)in ->data[plane];
382 outrow = (uint16_t *)out->data[plane];
384 for (i = 0; i < h; i++) {
385 for (j = 0; j < w; j++) {
387 outrow[j] = av_bswap16(tab[av_bswap16(inrow[j])]);
389 outrow[j] = tab[inrow[j]];
392 inrow += in_linesize;
393 outrow += out_linesize;
397 /* planar 8bit depth */
398 uint8_t *inrow, *outrow;
400 for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
401 int vsub = plane == 1 || plane == 2 ? s->vsub : 0;
402 int hsub = plane == 1 || plane == 2 ? s->hsub : 0;
403 int h = FF_CEIL_RSHIFT(inlink->h, vsub);
404 int w = FF_CEIL_RSHIFT(inlink->w, hsub);
405 const uint16_t *tab = s->lut[plane];
406 const int in_linesize = in->linesize[plane];
407 const int out_linesize = out->linesize[plane];
409 inrow = in ->data[plane];
410 outrow = out->data[plane];
412 for (i = 0; i < h; i++) {
413 for (j = 0; j < w; j++)
414 outrow[j] = tab[inrow[j]];
415 inrow += in_linesize;
416 outrow += out_linesize;
424 return ff_filter_frame(outlink, out);
427 static const AVFilterPad inputs[] = {
429 .type = AVMEDIA_TYPE_VIDEO,
430 .filter_frame = filter_frame,
431 .config_props = config_props,
435 static const AVFilterPad outputs[] = {
437 .type = AVMEDIA_TYPE_VIDEO,
442 #define DEFINE_LUT_FILTER(name_, description_) \
443 AVFilter ff_vf_##name_ = { \
445 .description = NULL_IF_CONFIG_SMALL(description_), \
446 .priv_size = sizeof(LutContext), \
447 .priv_class = &name_ ## _class, \
448 .init = name_##_init, \
450 .query_formats = query_formats, \
452 .outputs = outputs, \
453 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, \
456 #if CONFIG_LUT_FILTER
458 #define lut_options options
459 AVFILTER_DEFINE_CLASS(lut);
461 static int lut_init(AVFilterContext *ctx)
466 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.");
469 #if CONFIG_LUTYUV_FILTER
471 #define lutyuv_options options
472 AVFILTER_DEFINE_CLASS(lutyuv);
474 static av_cold int lutyuv_init(AVFilterContext *ctx)
476 LutContext *s = ctx->priv;
483 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.");
486 #if CONFIG_LUTRGB_FILTER
488 #define lutrgb_options options
489 AVFILTER_DEFINE_CLASS(lutrgb);
491 static av_cold int lutrgb_init(AVFilterContext *ctx)
493 LutContext *s = ctx->priv;
500 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.");
503 #if CONFIG_NEGATE_FILTER
505 static const AVOption negate_options[] = {
506 { "negate_alpha", NULL, OFFSET(negate_alpha), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS },
510 AVFILTER_DEFINE_CLASS(negate);
512 static av_cold int negate_init(AVFilterContext *ctx)
514 LutContext *s = ctx->priv;
517 av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", s->negate_alpha);
519 for (i = 0; i < 4; i++) {
520 s->comp_expr_str[i] = av_strdup((i == 3 && !s->negate_alpha) ?
522 if (!s->comp_expr_str[i]) {
524 return AVERROR(ENOMEM);
531 DEFINE_LUT_FILTER(negate, "Negate input video.");