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/common.h"
28 #include "libavutil/eval.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
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
60 uint8_t lut[4][256]; ///< lookup table for each component
61 char *comp_expr_str[4];
64 double var_values[VAR_VARS_NB];
67 int negate_alpha; /* only used by negate */
78 #define OFFSET(x) offsetof(LutContext, x)
79 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
81 static const AVOption options[] = {
82 {"c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
83 {"c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
84 {"c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
85 {"c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
86 {"y", "set Y expression", OFFSET(comp_expr_str[Y]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
87 {"u", "set U expression", OFFSET(comp_expr_str[U]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
88 {"v", "set V expression", OFFSET(comp_expr_str[V]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
89 {"r", "set R expression", OFFSET(comp_expr_str[R]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
90 {"g", "set G expression", OFFSET(comp_expr_str[G]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
91 {"b", "set B expression", OFFSET(comp_expr_str[B]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
92 {"a", "set A expression", OFFSET(comp_expr_str[A]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
96 static av_cold void uninit(AVFilterContext *ctx)
98 LutContext *lut = ctx->priv;
101 for (i = 0; i < 4; i++) {
102 av_expr_free(lut->comp_expr[i]);
103 lut->comp_expr[i] = NULL;
104 av_freep(&lut->comp_expr_str[i]);
108 #define YUV_FORMATS \
109 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, \
110 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P, \
111 AV_PIX_FMT_YUVA420P, \
112 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P, \
115 #define RGB_FORMATS \
116 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA, \
117 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA, \
118 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24
120 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
121 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
122 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
124 static int query_formats(AVFilterContext *ctx)
126 LutContext *lut = ctx->priv;
128 const enum AVPixelFormat *pix_fmts = lut->is_rgb ? rgb_pix_fmts :
129 lut->is_yuv ? yuv_pix_fmts : all_pix_fmts;
131 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
136 * Clip value val in the minval - maxval range.
138 static double clip(void *opaque, double val)
140 LutContext *lut = opaque;
141 double minval = lut->var_values[VAR_MINVAL];
142 double maxval = lut->var_values[VAR_MAXVAL];
144 return av_clip(val, minval, maxval);
148 * Compute gamma correction for value val, assuming the minval-maxval
149 * range, val is clipped to a value contained in the same interval.
151 static double compute_gammaval(void *opaque, double gamma)
153 LutContext *lut = opaque;
154 double val = lut->var_values[VAR_CLIPVAL];
155 double minval = lut->var_values[VAR_MINVAL];
156 double maxval = lut->var_values[VAR_MAXVAL];
158 return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
161 static double (* const funcs1[])(void *, double) = {
163 (void *)compute_gammaval,
167 static const char * const funcs1_names[] = {
173 static int config_props(AVFilterLink *inlink)
175 AVFilterContext *ctx = inlink->dst;
176 LutContext *lut = ctx->priv;
177 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
178 int rgba_map[4]; /* component index -> RGBA color index map */
182 lut->hsub = desc->log2_chroma_w;
183 lut->vsub = desc->log2_chroma_h;
185 lut->var_values[VAR_W] = inlink->w;
186 lut->var_values[VAR_H] = inlink->h;
188 switch (inlink->format) {
189 case AV_PIX_FMT_YUV410P:
190 case AV_PIX_FMT_YUV411P:
191 case AV_PIX_FMT_YUV420P:
192 case AV_PIX_FMT_YUV422P:
193 case AV_PIX_FMT_YUV440P:
194 case AV_PIX_FMT_YUV444P:
195 case AV_PIX_FMT_YUVA420P:
196 min[Y] = min[U] = min[V] = 16;
198 max[U] = max[V] = 240;
199 min[A] = 0; max[A] = 255;
202 min[0] = min[1] = min[2] = min[3] = 0;
203 max[0] = max[1] = max[2] = max[3] = 255;
206 lut->is_yuv = lut->is_rgb = 0;
207 if (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) lut->is_yuv = 1;
208 else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) lut->is_rgb = 1;
211 switch (inlink->format) {
212 case AV_PIX_FMT_ARGB: rgba_map[0] = A; rgba_map[1] = R; rgba_map[2] = G; rgba_map[3] = B; break;
213 case AV_PIX_FMT_ABGR: rgba_map[0] = A; rgba_map[1] = B; rgba_map[2] = G; rgba_map[3] = R; break;
214 case AV_PIX_FMT_RGBA:
215 case AV_PIX_FMT_RGB24: rgba_map[0] = R; rgba_map[1] = G; rgba_map[2] = B; rgba_map[3] = A; break;
216 case AV_PIX_FMT_BGRA:
217 case AV_PIX_FMT_BGR24: rgba_map[0] = B; rgba_map[1] = G; rgba_map[2] = R; rgba_map[3] = A; break;
219 lut->step = av_get_bits_per_pixel(desc) >> 3;
222 for (comp = 0; comp < desc->nb_components; comp++) {
224 int color = lut->is_rgb ? rgba_map[comp] : comp;
226 /* create the parsed expression */
227 ret = av_expr_parse(&lut->comp_expr[color], lut->comp_expr_str[color],
228 var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
230 av_log(ctx, AV_LOG_ERROR,
231 "Error when parsing the expression '%s' for the component %d and color %d.\n",
232 lut->comp_expr_str[comp], comp, color);
233 return AVERROR(EINVAL);
236 /* compute the lut */
237 lut->var_values[VAR_MAXVAL] = max[color];
238 lut->var_values[VAR_MINVAL] = min[color];
240 for (val = 0; val < 256; val++) {
241 lut->var_values[VAR_VAL] = val;
242 lut->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
243 lut->var_values[VAR_NEGVAL] =
244 av_clip(min[color] + max[color] - lut->var_values[VAR_VAL],
245 min[color], max[color]);
247 res = av_expr_eval(lut->comp_expr[color], lut->var_values, lut);
249 av_log(ctx, AV_LOG_ERROR,
250 "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
251 lut->comp_expr_str[color], val, comp);
252 return AVERROR(EINVAL);
254 lut->lut[comp][val] = av_clip((int)res, min[color], max[color]);
255 av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, lut->lut[comp][val]);
262 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *in)
264 AVFilterContext *ctx = inlink->dst;
265 LutContext *lut = ctx->priv;
266 AVFilterLink *outlink = ctx->outputs[0];
267 AVFilterBufferRef *out;
268 uint8_t *inrow, *outrow, *inrow0, *outrow0;
271 out = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
273 avfilter_unref_bufferp(&in);
274 return AVERROR(ENOMEM);
276 avfilter_copy_buffer_ref_props(out, in);
280 inrow0 = in ->data[0];
281 outrow0 = out->data[0];
283 for (i = 0; i < in->video->h; i ++) {
285 const uint8_t (*tab)[256] = (const uint8_t (*)[256])lut->lut;
288 for (j = 0; j < w; j++) {
289 outrow[0] = tab[0][inrow[0]];
291 outrow[1] = tab[1][inrow[1]];
293 outrow[2] = tab[2][inrow[2]];
295 outrow[3] = tab[3][inrow[3]];
302 inrow0 += in ->linesize[0];
303 outrow0 += out->linesize[0];
307 for (plane = 0; plane < 4 && in->data[plane]; plane++) {
308 int vsub = plane == 1 || plane == 2 ? lut->vsub : 0;
309 int hsub = plane == 1 || plane == 2 ? lut->hsub : 0;
311 inrow = in ->data[plane];
312 outrow = out->data[plane];
314 for (i = 0; i < (in->video->h + (1<<vsub) - 1)>>vsub; i ++) {
315 const uint8_t *tab = lut->lut[plane];
316 int w = (inlink->w + (1<<hsub) - 1)>>hsub;
317 for (j = 0; j < w; j++)
318 outrow[j] = tab[inrow[j]];
319 inrow += in ->linesize[plane];
320 outrow += out->linesize[plane];
325 avfilter_unref_bufferp(&in);
326 return ff_filter_frame(outlink, out);
329 static const AVFilterPad inputs[] = {
331 .type = AVMEDIA_TYPE_VIDEO,
332 .filter_frame = filter_frame,
333 .config_props = config_props,
334 .min_perms = AV_PERM_READ, },
337 static const AVFilterPad outputs[] = {
339 .type = AVMEDIA_TYPE_VIDEO, },
342 #define DEFINE_LUT_FILTER(name_, description_) \
343 AVFilter avfilter_vf_##name_ = { \
345 .description = NULL_IF_CONFIG_SMALL(description_), \
346 .priv_size = sizeof(LutContext), \
348 .init = name_##_init, \
350 .query_formats = query_formats, \
353 .outputs = outputs, \
354 .priv_class = &name_##_class, \
357 #if CONFIG_LUT_FILTER
359 #define lut_options options
360 AVFILTER_DEFINE_CLASS(lut);
362 static int lut_init(AVFilterContext *ctx, const char *args)
364 LutContext *lut = ctx->priv;
367 lut->class = &lut_class;
368 av_opt_set_defaults(lut);
370 if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
376 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.");
379 #if CONFIG_LUTYUV_FILTER
381 #define lutyuv_options options
382 AVFILTER_DEFINE_CLASS(lutyuv);
384 static int lutyuv_init(AVFilterContext *ctx, const char *args)
386 LutContext *lut = ctx->priv;
389 lut->class = &lutyuv_class;
391 av_opt_set_defaults(lut);
393 if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
399 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.");
402 #if CONFIG_LUTRGB_FILTER
404 #define lutrgb_options options
405 AVFILTER_DEFINE_CLASS(lutrgb);
407 static int lutrgb_init(AVFilterContext *ctx, const char *args)
409 LutContext *lut = ctx->priv;
412 lut->class = &lutrgb_class;
414 av_opt_set_defaults(lut);
416 if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
422 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.");
425 #if CONFIG_NEGATE_FILTER
427 #define negate_options options
428 AVFILTER_DEFINE_CLASS(negate);
430 static int negate_init(AVFilterContext *ctx, const char *args)
432 LutContext *lut = ctx->priv;
436 sscanf(args, "%d", &lut->negate_alpha);
438 av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", lut->negate_alpha);
440 snprintf(lut_params, sizeof(lut_params), "c0=negval:c1=negval:c2=negval:a=%s",
441 lut->negate_alpha ? "negval" : "val");
443 lut->class = &negate_class;
444 av_opt_set_defaults(lut);
446 return av_set_options_string(lut, lut_params, "=", ":");
449 DEFINE_LUT_FILTER(negate, "Negate input video.");