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"
32 #include "drawutils.h"
37 static const char *const var_names[] = {
38 "w", ///< width of the input video
39 "h", ///< height of the input video
40 "val", ///< input value for the pixel
41 "maxval", ///< max value for the pixel
42 "minval", ///< min value for the pixel
43 "negval", ///< negated value
61 uint8_t lut[4][256]; ///< lookup table for each component
62 char *comp_expr_str[4];
65 double var_values[VAR_VARS_NB];
68 int negate_alpha; /* only used by negate */
79 #define OFFSET(x) offsetof(LutContext, x)
80 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
82 static const AVOption options[] = {
83 {"c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
84 {"c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
85 {"c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
86 {"c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
87 {"y", "set Y expression", OFFSET(comp_expr_str[Y]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
88 {"u", "set U expression", OFFSET(comp_expr_str[U]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
89 {"v", "set V expression", OFFSET(comp_expr_str[V]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
90 {"r", "set R expression", OFFSET(comp_expr_str[R]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
91 {"g", "set G expression", OFFSET(comp_expr_str[G]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
92 {"b", "set B expression", OFFSET(comp_expr_str[B]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
93 {"a", "set A expression", OFFSET(comp_expr_str[A]), AV_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX, FLAGS},
97 static av_cold void uninit(AVFilterContext *ctx)
99 LutContext *lut = ctx->priv;
102 for (i = 0; i < 4; i++) {
103 av_expr_free(lut->comp_expr[i]);
104 lut->comp_expr[i] = NULL;
105 av_freep(&lut->comp_expr_str[i]);
109 #define YUV_FORMATS \
110 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P, \
111 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P, \
112 AV_PIX_FMT_YUVA420P, \
113 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P, \
116 #define RGB_FORMATS \
117 AV_PIX_FMT_ARGB, AV_PIX_FMT_RGBA, \
118 AV_PIX_FMT_ABGR, AV_PIX_FMT_BGRA, \
119 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24
121 static const enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
122 static const enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
123 static const enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
125 static int query_formats(AVFilterContext *ctx)
127 LutContext *lut = ctx->priv;
129 const enum AVPixelFormat *pix_fmts = lut->is_rgb ? rgb_pix_fmts :
130 lut->is_yuv ? yuv_pix_fmts : all_pix_fmts;
132 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
137 * Clip value val in the minval - maxval range.
139 static double clip(void *opaque, double val)
141 LutContext *lut = opaque;
142 double minval = lut->var_values[VAR_MINVAL];
143 double maxval = lut->var_values[VAR_MAXVAL];
145 return av_clip(val, minval, maxval);
149 * Compute gamma correction for value val, assuming the minval-maxval
150 * range, val is clipped to a value contained in the same interval.
152 static double compute_gammaval(void *opaque, double gamma)
154 LutContext *lut = opaque;
155 double val = lut->var_values[VAR_CLIPVAL];
156 double minval = lut->var_values[VAR_MINVAL];
157 double maxval = lut->var_values[VAR_MAXVAL];
159 return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
162 static double (* const funcs1[])(void *, double) = {
164 (void *)compute_gammaval,
168 static const char * const funcs1_names[] = {
174 static int config_props(AVFilterLink *inlink)
176 AVFilterContext *ctx = inlink->dst;
177 LutContext *lut = ctx->priv;
178 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
179 uint8_t rgba_map[4]; /* component index -> RGBA color index map */
183 lut->hsub = desc->log2_chroma_w;
184 lut->vsub = desc->log2_chroma_h;
186 lut->var_values[VAR_W] = inlink->w;
187 lut->var_values[VAR_H] = inlink->h;
189 switch (inlink->format) {
190 case AV_PIX_FMT_YUV410P:
191 case AV_PIX_FMT_YUV411P:
192 case AV_PIX_FMT_YUV420P:
193 case AV_PIX_FMT_YUV422P:
194 case AV_PIX_FMT_YUV440P:
195 case AV_PIX_FMT_YUV444P:
196 case AV_PIX_FMT_YUVA420P:
197 min[Y] = min[U] = min[V] = 16;
199 max[U] = max[V] = 240;
200 min[A] = 0; max[A] = 255;
203 min[0] = min[1] = min[2] = min[3] = 0;
204 max[0] = max[1] = max[2] = max[3] = 255;
207 lut->is_yuv = lut->is_rgb = 0;
208 if (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) lut->is_yuv = 1;
209 else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) lut->is_rgb = 1;
212 ff_fill_rgba_map(rgba_map, inlink->format);
213 lut->step = av_get_bits_per_pixel(desc) >> 3;
216 for (color = 0; color < desc->nb_components; color++) {
218 int comp = lut->is_rgb ? rgba_map[color] : color;
220 /* create the parsed expression */
221 ret = av_expr_parse(&lut->comp_expr[color], lut->comp_expr_str[color],
222 var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
224 av_log(ctx, AV_LOG_ERROR,
225 "Error when parsing the expression '%s' for the component %d and color %d.\n",
226 lut->comp_expr_str[comp], comp, color);
227 return AVERROR(EINVAL);
230 /* compute the lut */
231 lut->var_values[VAR_MAXVAL] = max[color];
232 lut->var_values[VAR_MINVAL] = min[color];
234 for (val = 0; val < 256; val++) {
235 lut->var_values[VAR_VAL] = val;
236 lut->var_values[VAR_CLIPVAL] = av_clip(val, min[color], max[color]);
237 lut->var_values[VAR_NEGVAL] =
238 av_clip(min[color] + max[color] - lut->var_values[VAR_VAL],
239 min[color], max[color]);
241 res = av_expr_eval(lut->comp_expr[color], lut->var_values, lut);
243 av_log(ctx, AV_LOG_ERROR,
244 "Error when evaluating the expression '%s' for the value %d for the component %d.\n",
245 lut->comp_expr_str[color], val, comp);
246 return AVERROR(EINVAL);
248 lut->lut[comp][val] = av_clip((int)res, min[color], max[color]);
249 av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, lut->lut[comp][val]);
256 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
258 AVFilterContext *ctx = inlink->dst;
259 LutContext *lut = ctx->priv;
260 AVFilterLink *outlink = ctx->outputs[0];
262 uint8_t *inrow, *outrow, *inrow0, *outrow0;
265 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
268 return AVERROR(ENOMEM);
270 av_frame_copy_props(out, in);
274 inrow0 = in ->data[0];
275 outrow0 = out->data[0];
277 for (i = 0; i < in->height; i ++) {
279 const uint8_t (*tab)[256] = (const uint8_t (*)[256])lut->lut;
282 for (j = 0; j < w; j++) {
283 outrow[0] = tab[0][inrow[0]];
285 outrow[1] = tab[1][inrow[1]];
287 outrow[2] = tab[2][inrow[2]];
289 outrow[3] = tab[3][inrow[3]];
296 inrow0 += in ->linesize[0];
297 outrow0 += out->linesize[0];
301 for (plane = 0; plane < 4 && in->data[plane]; plane++) {
302 int vsub = plane == 1 || plane == 2 ? lut->vsub : 0;
303 int hsub = plane == 1 || plane == 2 ? lut->hsub : 0;
305 inrow = in ->data[plane];
306 outrow = out->data[plane];
308 for (i = 0; i < (in->height + (1<<vsub) - 1)>>vsub; i ++) {
309 const uint8_t *tab = lut->lut[plane];
310 int w = (inlink->w + (1<<hsub) - 1)>>hsub;
311 for (j = 0; j < w; j++)
312 outrow[j] = tab[inrow[j]];
313 inrow += in ->linesize[plane];
314 outrow += out->linesize[plane];
320 return ff_filter_frame(outlink, out);
323 static const AVFilterPad inputs[] = {
325 .type = AVMEDIA_TYPE_VIDEO,
326 .filter_frame = filter_frame,
327 .config_props = config_props,
331 static const AVFilterPad outputs[] = {
333 .type = AVMEDIA_TYPE_VIDEO, },
336 #define DEFINE_LUT_FILTER(name_, description_) \
337 AVFilter avfilter_vf_##name_ = { \
339 .description = NULL_IF_CONFIG_SMALL(description_), \
340 .priv_size = sizeof(LutContext), \
342 .init = name_##_init, \
344 .query_formats = query_formats, \
347 .outputs = outputs, \
348 .priv_class = &name_##_class, \
351 #if CONFIG_LUT_FILTER
353 #define lut_options options
354 AVFILTER_DEFINE_CLASS(lut);
356 static int lut_init(AVFilterContext *ctx, const char *args)
358 LutContext *lut = ctx->priv;
361 lut->class = &lut_class;
362 av_opt_set_defaults(lut);
364 if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
370 DEFINE_LUT_FILTER(lut, "Compute and apply a lookup table to the RGB/YUV input video.");
373 #if CONFIG_LUTYUV_FILTER
375 #define lutyuv_options options
376 AVFILTER_DEFINE_CLASS(lutyuv);
378 static int lutyuv_init(AVFilterContext *ctx, const char *args)
380 LutContext *lut = ctx->priv;
383 lut->class = &lutyuv_class;
385 av_opt_set_defaults(lut);
387 if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
393 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.");
396 #if CONFIG_LUTRGB_FILTER
398 #define lutrgb_options options
399 AVFILTER_DEFINE_CLASS(lutrgb);
401 static int lutrgb_init(AVFilterContext *ctx, const char *args)
403 LutContext *lut = ctx->priv;
406 lut->class = &lutrgb_class;
408 av_opt_set_defaults(lut);
410 if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
416 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.");
419 #if CONFIG_NEGATE_FILTER
421 #define negate_options options
422 AVFILTER_DEFINE_CLASS(negate);
424 static int negate_init(AVFilterContext *ctx, const char *args)
426 LutContext *lut = ctx->priv;
430 sscanf(args, "%d", &lut->negate_alpha);
432 av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", lut->negate_alpha);
434 snprintf(lut_params, sizeof(lut_params), "c0=negval:c1=negval:c2=negval:a=%s",
435 lut->negate_alpha ? "negval" : "val");
437 lut->class = &negate_class;
438 av_opt_set_defaults(lut);
440 return av_set_options_string(lut, lut_params, "=", ":");
443 DEFINE_LUT_FILTER(negate, "Negate input video.");