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 "config_components.h"
29 #include "libavutil/attributes.h"
30 #include "libavutil/bswap.h"
31 #include "libavutil/common.h"
32 #include "libavutil/eval.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/pixdesc.h"
36 #include "drawutils.h"
41 static const char *const var_names[] = {
42 "w", ///< width of the input video
43 "h", ///< height of the input video
44 "val", ///< input value for the pixel
45 "maxval", ///< max value for the pixel
46 "minval", ///< min value for the pixel
47 "negval", ///< negated value
63 typedef struct LutContext {
65 uint16_t lut[4][256 * 256]; ///< lookup table for each component
66 char *comp_expr_str[4];
69 double var_values[VAR_VARS_NB];
84 #define OFFSET(x) offsetof(LutContext, x)
85 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
87 static const AVOption options[] = {
88 { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
89 { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
90 { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
91 { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
92 { "y", "set Y expression", OFFSET(comp_expr_str[Y]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
93 { "u", "set U expression", OFFSET(comp_expr_str[U]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
94 { "v", "set V expression", OFFSET(comp_expr_str[V]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
95 { "r", "set R expression", OFFSET(comp_expr_str[R]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
96 { "g", "set G expression", OFFSET(comp_expr_str[G]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
97 { "b", "set B expression", OFFSET(comp_expr_str[B]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
98 { "a", "set A expression", OFFSET(comp_expr_str[A]), AV_OPT_TYPE_STRING, { .str = "clipval" }, .flags = FLAGS },
102 static av_cold void uninit(AVFilterContext *ctx)
104 LutContext *s = ctx->priv;
107 for (i = 0; i < 4; i++) {
108 av_expr_free(s->comp_expr[i]);
109 s->comp_expr[i] = NULL;
110 av_freep(&s->comp_expr_str[i]);
114 #define YUV_FORMATS \
115 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, \
116 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P, \
117 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA444P, \
118 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P, \
119 AV_PIX_FMT_YUVJ440P, \
120 AV_PIX_FMT_YUV444P9LE, AV_PIX_FMT_YUV422P9LE, AV_PIX_FMT_YUV420P9LE, \
121 AV_PIX_FMT_YUV444P10LE, AV_PIX_FMT_YUV422P10LE, AV_PIX_FMT_YUV420P10LE, AV_PIX_FMT_YUV440P10LE, \
122 AV_PIX_FMT_YUV444P12LE, AV_PIX_FMT_YUV422P12LE, AV_PIX_FMT_YUV420P12LE, AV_PIX_FMT_YUV440P12LE, \
123 AV_PIX_FMT_YUV444P14LE, AV_PIX_FMT_YUV422P14LE, AV_PIX_FMT_YUV420P14LE, \
124 AV_PIX_FMT_YUV444P16LE, AV_PIX_FMT_YUV422P16LE, AV_PIX_FMT_YUV420P16LE, \
125 AV_PIX_FMT_YUVA444P16LE, AV_PIX_FMT_YUVA422P16LE, AV_PIX_FMT_YUVA420P16LE
127 #define RGB_FORMATS \
128 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA, \
129 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA, \
130 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24, \
131 AV_PIX_FMT_RGB48LE, AV_PIX_FMT_RGBA64LE, \
132 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, \
133 AV_PIX_FMT_GBRP9LE, AV_PIX_FMT_GBRP10LE, \
134 AV_PIX_FMT_GBRAP10LE, \
135 AV_PIX_FMT_GBRP12LE, AV_PIX_FMT_GBRP14LE, \
136 AV_PIX_FMT_GBRP16LE, AV_PIX_FMT_GBRAP12LE, \
139 #define GRAY_FORMATS \
140 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9LE, AV_PIX_FMT_GRAY10LE, \
141 AV_PIX_FMT_GRAY12LE, AV_PIX_FMT_GRAY14LE, AV_PIX_FMT_GRAY16LE
143 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
144 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
145 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, GRAY_FORMATS, AV_PIX_FMT_NONE };
147 static int query_formats(AVFilterContext *ctx)
149 LutContext *s = ctx->priv;
151 const enum AVPixelFormat *pix_fmts = s->is_rgb ? rgb_pix_fmts :
152 s->is_yuv ? yuv_pix_fmts :
154 return ff_set_common_formats_from_list(ctx, pix_fmts);
158 * Clip value val in the minval - maxval range.
160 static double clip(void *opaque, double val)
162 LutContext *s = opaque;
163 double minval = s->var_values[VAR_MINVAL];
164 double maxval = s->var_values[VAR_MAXVAL];
166 return av_clip(val, minval, maxval);
170 * Compute gamma correction for value val, assuming the minval-maxval
171 * range, val is clipped to a value contained in the same interval.
173 static double compute_gammaval(void *opaque, double gamma)
175 LutContext *s = opaque;
176 double val = s->var_values[VAR_CLIPVAL];
177 double minval = s->var_values[VAR_MINVAL];
178 double maxval = s->var_values[VAR_MAXVAL];
180 return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
184 * Compute ITU Rec.709 gamma correction of value val.
186 static double compute_gammaval709(void *opaque, double gamma)
188 LutContext *s = opaque;
189 double val = s->var_values[VAR_CLIPVAL];
190 double minval = s->var_values[VAR_MINVAL];
191 double maxval = s->var_values[VAR_MAXVAL];
192 double level = (val - minval) / (maxval - minval);
193 level = level < 0.018 ? 4.5 * level
194 : 1.099 * pow(level, 1.0 / gamma) - 0.099;
195 return level * (maxval - minval) + minval;
198 static double (* const funcs1[])(void *, double) = {
205 static const char * const funcs1_names[] = {
212 static int config_props(AVFilterLink *inlink)
214 AVFilterContext *ctx = inlink->dst;
215 LutContext *s = ctx->priv;
216 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
217 uint8_t rgba_map[4]; /* component index -> RGBA color index map */
221 s->hsub = desc->log2_chroma_w;
222 s->vsub = desc->log2_chroma_h;
224 s->var_values[VAR_W] = inlink->w;
225 s->var_values[VAR_H] = inlink->h;
226 s->is_16bit = desc->comp[0].depth > 8;
228 switch (inlink->format) {
229 case AV_PIX_FMT_YUV410P:
230 case AV_PIX_FMT_YUV411P:
231 case AV_PIX_FMT_YUV420P:
232 case AV_PIX_FMT_YUV422P:
233 case AV_PIX_FMT_YUV440P:
234 case AV_PIX_FMT_YUV444P:
235 case AV_PIX_FMT_YUVA420P:
236 case AV_PIX_FMT_YUVA422P:
237 case AV_PIX_FMT_YUVA444P:
238 case AV_PIX_FMT_YUV420P9LE:
239 case AV_PIX_FMT_YUV422P9LE:
240 case AV_PIX_FMT_YUV444P9LE:
241 case AV_PIX_FMT_YUVA420P9LE:
242 case AV_PIX_FMT_YUVA422P9LE:
243 case AV_PIX_FMT_YUVA444P9LE:
244 case AV_PIX_FMT_YUV420P10LE:
245 case AV_PIX_FMT_YUV422P10LE:
246 case AV_PIX_FMT_YUV440P10LE:
247 case AV_PIX_FMT_YUV444P10LE:
248 case AV_PIX_FMT_YUVA420P10LE:
249 case AV_PIX_FMT_YUVA422P10LE:
250 case AV_PIX_FMT_YUVA444P10LE:
251 case AV_PIX_FMT_YUV420P12LE:
252 case AV_PIX_FMT_YUV422P12LE:
253 case AV_PIX_FMT_YUV440P12LE:
254 case AV_PIX_FMT_YUV444P12LE:
255 case AV_PIX_FMT_YUV420P14LE:
256 case AV_PIX_FMT_YUV422P14LE:
257 case AV_PIX_FMT_YUV444P14LE:
258 case AV_PIX_FMT_YUV420P16LE:
259 case AV_PIX_FMT_YUV422P16LE:
260 case AV_PIX_FMT_YUV444P16LE:
261 case AV_PIX_FMT_YUVA420P16LE:
262 case AV_PIX_FMT_YUVA422P16LE:
263 case AV_PIX_FMT_YUVA444P16LE:
264 min[Y] = 16 * (1 << (desc->comp[0].depth - 8));
265 min[U] = 16 * (1 << (desc->comp[1].depth - 8));
266 min[V] = 16 * (1 << (desc->comp[2].depth - 8));
268 max[Y] = 235 * (1 << (desc->comp[0].depth - 8));
269 max[U] = 240 * (1 << (desc->comp[1].depth - 8));
270 max[V] = 240 * (1 << (desc->comp[2].depth - 8));
271 max[A] = (1 << desc->comp[0].depth) - 1;
273 case AV_PIX_FMT_RGB48LE:
274 case AV_PIX_FMT_RGBA64LE:
275 min[0] = min[1] = min[2] = min[3] = 0;
276 max[0] = max[1] = max[2] = max[3] = 65535;
279 min[0] = min[1] = min[2] = min[3] = 0;
280 max[0] = max[1] = max[2] = max[3] = 255 * (1 << (desc->comp[0].depth - 8));
283 s->is_yuv = s->is_rgb = 0;
284 s->is_planar = desc->flags & AV_PIX_FMT_FLAG_PLANAR;
285 if (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) s->is_yuv = 1;
286 else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) s->is_rgb = 1;
289 ff_fill_rgba_map(rgba_map, inlink->format);
290 s->step = av_get_bits_per_pixel(desc) >> 3;
292 s->step = s->step >> 1;
296 for (color = 0; color < desc->nb_components; color++) {
298 int comp = s->is_rgb ? rgba_map[color] : color;
300 /* create the parsed expression */
301 av_expr_free(s->comp_expr[color]);
302 s->comp_expr[color] = NULL;
303 ret = av_expr_parse(&s->comp_expr[color], s->comp_expr_str[color],
304 var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
306 av_log(ctx, AV_LOG_ERROR,
307 "Error when parsing the expression '%s' for the component %d and color %d.\n",
308 s->comp_expr_str[comp], comp, color);
309 return AVERROR(EINVAL);
312 /* compute the lut */
313 s->var_values[VAR_MAXVAL] = max[color];
314 s->var_values[VAR_MINVAL] = min[color];
316 for (val = 0; val < FF_ARRAY_ELEMS(s->lut[comp]); val++) {
317 s->var_values[VAR_VAL] = val;
318 s->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
319 s->var_values[VAR_NEGVAL] =
320 av_clip(min[color] + max[color] - s->var_values[VAR_VAL],
321 min[color], max[color]);
323 res = av_expr_eval(s->comp_expr[color], s->var_values, s);
325 av_log(ctx, AV_LOG_ERROR,
326 "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
327 s->comp_expr_str[color], val, comp);
328 return AVERROR(EINVAL);
330 s->lut[comp][val] = av_clip((int)res, 0, max[A]);
331 av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, s->lut[comp][val]);
346 #define LOAD_PACKED_COMMON\
347 LutContext *s = ctx->priv;\
348 const struct thread_data *td = arg;\
351 const int w = td->w;\
352 const int h = td->h;\
353 AVFrame *in = td->in;\
354 AVFrame *out = td->out;\
355 const uint16_t (*tab)[256*256] = (const uint16_t (*)[256*256])s->lut;\
356 const int step = s->step;\
358 const int slice_start = (h * jobnr ) / nb_jobs;\
359 const int slice_end = (h * (jobnr+1)) / nb_jobs;\
362 static int lut_packed_16bits(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
366 uint16_t *inrow, *outrow, *inrow0, *outrow0;
367 const int in_linesize = in->linesize[0] / 2;
368 const int out_linesize = out->linesize[0] / 2;
369 inrow0 = (uint16_t *)in ->data[0];
370 outrow0 = (uint16_t *)out->data[0];
372 for (i = slice_start; i < slice_end; i++) {
373 inrow = inrow0 + i * in_linesize;
374 outrow = outrow0 + i * out_linesize;
375 for (j = 0; j < w; j++) {
379 case 4: outrow[3] = av_bswap16(tab[3][av_bswap16(inrow[3])]); // Fall-through
380 case 3: outrow[2] = av_bswap16(tab[2][av_bswap16(inrow[2])]); // Fall-through
381 case 2: outrow[1] = av_bswap16(tab[1][av_bswap16(inrow[1])]); // Fall-through
382 default: outrow[0] = av_bswap16(tab[0][av_bswap16(inrow[0])]);
384 case 4: outrow[3] = tab[3][inrow[3]]; // Fall-through
385 case 3: outrow[2] = tab[2][inrow[2]]; // Fall-through
386 case 2: outrow[1] = tab[1][inrow[1]]; // Fall-through
387 default: outrow[0] = tab[0][inrow[0]];
399 static int lut_packed_8bits(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
403 uint8_t *inrow, *outrow, *inrow0, *outrow0;
404 const int in_linesize = in->linesize[0];
405 const int out_linesize = out->linesize[0];
406 inrow0 = in ->data[0];
407 outrow0 = out->data[0];
409 for (i = slice_start; i < slice_end; i++) {
410 inrow = inrow0 + i * in_linesize;
411 outrow = outrow0 + i * out_linesize;
412 for (j = 0; j < w; j++) {
414 case 4: outrow[3] = tab[3][inrow[3]]; // Fall-through
415 case 3: outrow[2] = tab[2][inrow[2]]; // Fall-through
416 case 2: outrow[1] = tab[1][inrow[1]]; // Fall-through
417 default: outrow[0] = tab[0][inrow[0]];
427 #define LOAD_PLANAR_COMMON\
428 LutContext *s = ctx->priv;\
429 const struct thread_data *td = arg;\
431 AVFrame *in = td->in;\
432 AVFrame *out = td->out;\
434 #define PLANAR_COMMON\
435 int vsub = plane == 1 || plane == 2 ? s->vsub : 0;\
436 int hsub = plane == 1 || plane == 2 ? s->hsub : 0;\
437 int h = AV_CEIL_RSHIFT(td->h, vsub);\
438 int w = AV_CEIL_RSHIFT(td->w, hsub);\
439 const uint16_t *tab = s->lut[plane];\
441 const int slice_start = (h * jobnr ) / nb_jobs;\
442 const int slice_end = (h * (jobnr+1)) / nb_jobs;\
444 /* planar >8 bit depth */
445 static int lut_planar_16bits(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
449 uint16_t *inrow, *outrow;
451 for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
454 const int in_linesize = in->linesize[plane] / 2;
455 const int out_linesize = out->linesize[plane] / 2;
457 inrow = (uint16_t *)in ->data[plane] + slice_start * in_linesize;
458 outrow = (uint16_t *)out->data[plane] + slice_start * out_linesize;
460 for (i = slice_start; i < slice_end; i++) {
461 for (j = 0; j < w; j++) {
463 outrow[j] = av_bswap16(tab[av_bswap16(inrow[j])]);
465 outrow[j] = tab[inrow[j]];
468 inrow += in_linesize;
469 outrow += out_linesize;
476 /* planar 8bit depth */
477 static int lut_planar_8bits(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
481 uint8_t *inrow, *outrow;
483 for (plane = 0; plane < 4 && in->data[plane] && in->linesize[plane]; plane++) {
486 const int in_linesize = in->linesize[plane];
487 const int out_linesize = out->linesize[plane];
489 inrow = in ->data[plane] + slice_start * in_linesize;
490 outrow = out->data[plane] + slice_start * out_linesize;
492 for (i = slice_start; i < slice_end; i++) {
493 for (j = 0; j < w; j++)
494 outrow[j] = tab[inrow[j]];
495 inrow += in_linesize;
496 outrow += out_linesize;
503 #define PACKED_THREAD_DATA\
504 struct thread_data td = {\
511 #define PLANAR_THREAD_DATA\
512 struct thread_data td = {\
519 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
521 AVFilterContext *ctx = inlink->dst;
522 LutContext *s = ctx->priv;
523 AVFilterLink *outlink = ctx->outputs[0];
527 if (av_frame_is_writable(in)) {
531 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
534 return AVERROR(ENOMEM);
536 av_frame_copy_props(out, in);
539 if (s->is_rgb && s->is_16bit && !s->is_planar) {
542 ff_filter_execute(ctx, lut_packed_16bits, &td, NULL,
543 FFMIN(in->height, ff_filter_get_nb_threads(ctx)));
544 } else if (s->is_rgb && !s->is_planar) {
547 ff_filter_execute(ctx, lut_packed_8bits, &td, NULL,
548 FFMIN(in->height, ff_filter_get_nb_threads(ctx)));
549 } else if (s->is_16bit) {
550 /* planar >8 bit depth */
552 ff_filter_execute(ctx, lut_planar_16bits, &td, NULL,
553 FFMIN(in->height, ff_filter_get_nb_threads(ctx)));
555 /* planar 8bit depth */
557 ff_filter_execute(ctx, lut_planar_8bits, &td, NULL,
558 FFMIN(in->height, ff_filter_get_nb_threads(ctx)));
564 return ff_filter_frame(outlink, out);
567 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
568 char *res, int res_len, int flags)
570 int ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
575 return config_props(ctx->inputs[0]);
578 static const AVFilterPad inputs[] = {
580 .type = AVMEDIA_TYPE_VIDEO,
581 .filter_frame = filter_frame,
582 .config_props = config_props,
586 #define DEFINE_LUT_FILTER(name_, description_, priv_class_) \
587 const AVFilter ff_vf_##name_ = { \
589 .description = NULL_IF_CONFIG_SMALL(description_), \
590 .priv_class = &priv_class_ ## _class, \
591 .priv_size = sizeof(LutContext), \
592 .init = name_##_init, \
594 FILTER_INPUTS(inputs), \
595 FILTER_OUTPUTS(ff_video_default_filterpad), \
596 FILTER_QUERY_FUNC(query_formats), \
597 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | \
598 AVFILTER_FLAG_SLICE_THREADS, \
599 .process_command = process_command, \
602 AVFILTER_DEFINE_CLASS_EXT(lut, "lut/lutyuv/lutrgb", options);
604 #if CONFIG_LUT_FILTER
606 #define lut_init NULL
607 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.",
612 #if CONFIG_LUTYUV_FILTER
614 static av_cold int lutyuv_init(AVFilterContext *ctx)
616 LutContext *s = ctx->priv;
623 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.",
627 #if CONFIG_LUTRGB_FILTER
629 static av_cold int lutrgb_init(AVFilterContext *ctx)
631 LutContext *s = ctx->priv;
638 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.",