lavfi: remove now unused args parameter from AVFilter.init
[ffmpeg.git] / libavfilter / vf_lut.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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.
10  *
11  * Libav 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.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * Compute a look-up table for binding the input value to the output
24  * value, and apply it to input video.
25  */
26
27 #include "libavutil/common.h"
28 #include "libavutil/eval.h"
29 #include "libavutil/mathematics.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "internal.h"
35 #include "video.h"
36
37 static const char *const var_names[] = {
38     "E",
39     "PHI",
40     "PI",
41     "w",        ///< width of the input video
42     "h",        ///< height of the input video
43     "val",      ///< input value for the pixel
44     "maxval",   ///< max value for the pixel
45     "minval",   ///< min value for the pixel
46     "negval",   ///< negated value
47     "clipval",
48     NULL
49 };
50
51 enum var_name {
52     VAR_E,
53     VAR_PHI,
54     VAR_PI,
55     VAR_W,
56     VAR_H,
57     VAR_VAL,
58     VAR_MAXVAL,
59     VAR_MINVAL,
60     VAR_NEGVAL,
61     VAR_CLIPVAL,
62     VAR_VARS_NB
63 };
64
65 typedef struct {
66     const AVClass *class;
67     uint8_t lut[4][256];  ///< lookup table for each component
68     char   *comp_expr_str[4];
69     AVExpr *comp_expr[4];
70     int hsub, vsub;
71     double var_values[VAR_VARS_NB];
72     int is_rgb, is_yuv;
73     int rgba_map[4];
74     int step;
75     int negate_alpha; /* only used by negate */
76 } LutContext;
77
78 #define Y 0
79 #define U 1
80 #define V 2
81 #define R 0
82 #define G 1
83 #define B 2
84 #define A 3
85
86 #define OFFSET(x) offsetof(LutContext, x)
87 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
88
89 static const AVOption lut_options[] = {
90     { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
91     { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
92     { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
93     { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
94     { "y",  "set Y expression",            OFFSET(comp_expr_str[Y]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
95     { "u",  "set U expression",            OFFSET(comp_expr_str[U]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
96     { "v",  "set V expression",            OFFSET(comp_expr_str[V]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
97     { "r",  "set R expression",            OFFSET(comp_expr_str[R]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
98     { "g",  "set G expression",            OFFSET(comp_expr_str[G]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
99     { "b",  "set B expression",            OFFSET(comp_expr_str[B]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
100     { "a",  "set A expression",            OFFSET(comp_expr_str[A]),  AV_OPT_TYPE_STRING, { .str = "val" }, .flags = FLAGS },
101     { NULL },
102 };
103
104 static int init(AVFilterContext *ctx)
105 {
106     LutContext *lut = ctx->priv;
107
108     lut->var_values[VAR_PHI] = M_PHI;
109     lut->var_values[VAR_PI]  = M_PI;
110     lut->var_values[VAR_E ]  = M_E;
111
112     lut->is_rgb = !strcmp(ctx->filter->name, "lutrgb");
113     lut->is_yuv = !strcmp(ctx->filter->name, "lutyuv");
114
115     return 0;
116 }
117
118 static av_cold void uninit(AVFilterContext *ctx)
119 {
120     LutContext *lut = ctx->priv;
121     int i;
122
123     for (i = 0; i < 4; i++) {
124         av_expr_free(lut->comp_expr[i]);
125         lut->comp_expr[i] = NULL;
126         av_freep(&lut->comp_expr_str[i]);
127     }
128 }
129
130 #define YUV_FORMATS                                         \
131     AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,    \
132     AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,  AV_PIX_FMT_YUV440P,    \
133     AV_PIX_FMT_YUVA420P,                                       \
134     AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,   \
135     AV_PIX_FMT_YUVJ440P
136
137 #define RGB_FORMATS                             \
138     AV_PIX_FMT_ARGB,         AV_PIX_FMT_RGBA,         \
139     AV_PIX_FMT_ABGR,         AV_PIX_FMT_BGRA,         \
140     AV_PIX_FMT_RGB24,        AV_PIX_FMT_BGR24
141
142 static enum AVPixelFormat yuv_pix_fmts[] = { YUV_FORMATS, AV_PIX_FMT_NONE };
143 static enum AVPixelFormat rgb_pix_fmts[] = { RGB_FORMATS, AV_PIX_FMT_NONE };
144 static enum AVPixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, AV_PIX_FMT_NONE };
145
146 static int query_formats(AVFilterContext *ctx)
147 {
148     LutContext *lut = ctx->priv;
149
150     enum AVPixelFormat *pix_fmts = lut->is_rgb ? rgb_pix_fmts :
151                                  lut->is_yuv ? yuv_pix_fmts : all_pix_fmts;
152
153     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
154     return 0;
155 }
156
157 /**
158  * Clip value val in the minval - maxval range.
159  */
160 static double clip(void *opaque, double val)
161 {
162     LutContext *lut = opaque;
163     double minval = lut->var_values[VAR_MINVAL];
164     double maxval = lut->var_values[VAR_MAXVAL];
165
166     return av_clip(val, minval, maxval);
167 }
168
169 /**
170  * Compute gamma correction for value val, assuming the minval-maxval
171  * range, val is clipped to a value contained in the same interval.
172  */
173 static double compute_gammaval(void *opaque, double gamma)
174 {
175     LutContext *lut = opaque;
176     double val    = lut->var_values[VAR_CLIPVAL];
177     double minval = lut->var_values[VAR_MINVAL];
178     double maxval = lut->var_values[VAR_MAXVAL];
179
180     return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
181 }
182
183 static double (* const funcs1[])(void *, double) = {
184     clip,
185     compute_gammaval,
186     NULL
187 };
188
189 static const char * const funcs1_names[] = {
190     "clip",
191     "gammaval",
192     NULL
193 };
194
195 static int config_props(AVFilterLink *inlink)
196 {
197     AVFilterContext *ctx = inlink->dst;
198     LutContext *lut = ctx->priv;
199     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
200     int min[4], max[4];
201     int val, comp, ret;
202
203     lut->hsub = desc->log2_chroma_w;
204     lut->vsub = desc->log2_chroma_h;
205
206     lut->var_values[VAR_W] = inlink->w;
207     lut->var_values[VAR_H] = inlink->h;
208
209     switch (inlink->format) {
210     case AV_PIX_FMT_YUV410P:
211     case AV_PIX_FMT_YUV411P:
212     case AV_PIX_FMT_YUV420P:
213     case AV_PIX_FMT_YUV422P:
214     case AV_PIX_FMT_YUV440P:
215     case AV_PIX_FMT_YUV444P:
216     case AV_PIX_FMT_YUVA420P:
217         min[Y] = min[U] = min[V] = 16;
218         max[Y] = 235;
219         max[U] = max[V] = 240;
220         min[A] = 0; max[A] = 255;
221         break;
222     default:
223         min[0] = min[1] = min[2] = min[3] = 0;
224         max[0] = max[1] = max[2] = max[3] = 255;
225     }
226
227     lut->is_yuv = lut->is_rgb = 0;
228     if      (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) lut->is_yuv = 1;
229     else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) lut->is_rgb = 1;
230
231     if (lut->is_rgb) {
232         switch (inlink->format) {
233         case AV_PIX_FMT_ARGB:  lut->rgba_map[A] = 0; lut->rgba_map[R] = 1; lut->rgba_map[G] = 2; lut->rgba_map[B] = 3; break;
234         case AV_PIX_FMT_ABGR:  lut->rgba_map[A] = 0; lut->rgba_map[B] = 1; lut->rgba_map[G] = 2; lut->rgba_map[R] = 3; break;
235         case AV_PIX_FMT_RGBA:
236         case AV_PIX_FMT_RGB24: lut->rgba_map[R] = 0; lut->rgba_map[G] = 1; lut->rgba_map[B] = 2; lut->rgba_map[A] = 3; break;
237         case AV_PIX_FMT_BGRA:
238         case AV_PIX_FMT_BGR24: lut->rgba_map[B] = 0; lut->rgba_map[G] = 1; lut->rgba_map[R] = 2; lut->rgba_map[A] = 3; break;
239         }
240         lut->step = av_get_bits_per_pixel(desc) >> 3;
241     }
242
243     for (comp = 0; comp < desc->nb_components; comp++) {
244         double res;
245
246         /* create the parsed expression */
247         ret = av_expr_parse(&lut->comp_expr[comp], lut->comp_expr_str[comp],
248                             var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
249         if (ret < 0) {
250             av_log(ctx, AV_LOG_ERROR,
251                    "Error when parsing the expression '%s' for the component %d.\n",
252                    lut->comp_expr_str[comp], comp);
253             return AVERROR(EINVAL);
254         }
255
256         /* compute the lut */
257         lut->var_values[VAR_MAXVAL] = max[comp];
258         lut->var_values[VAR_MINVAL] = min[comp];
259
260         for (val = 0; val < 256; val++) {
261             lut->var_values[VAR_VAL] = val;
262             lut->var_values[VAR_CLIPVAL] = av_clip(val, min[comp], max[comp]);
263             lut->var_values[VAR_NEGVAL] =
264                 av_clip(min[comp] + max[comp] - lut->var_values[VAR_VAL],
265                         min[comp], max[comp]);
266
267             res = av_expr_eval(lut->comp_expr[comp], lut->var_values, lut);
268             if (isnan(res)) {
269                 av_log(ctx, AV_LOG_ERROR,
270                        "Error when evaluating the expression '%s' for the value %d for the component #%d.\n",
271                        lut->comp_expr_str[comp], val, comp);
272                 return AVERROR(EINVAL);
273             }
274             lut->lut[comp][val] = av_clip((int)res, min[comp], max[comp]);
275             av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, lut->lut[comp][val]);
276         }
277     }
278
279     return 0;
280 }
281
282 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
283 {
284     AVFilterContext *ctx = inlink->dst;
285     LutContext *lut = ctx->priv;
286     AVFilterLink *outlink = ctx->outputs[0];
287     AVFrame *out;
288     uint8_t *inrow, *outrow, *inrow0, *outrow0;
289     int i, j, k, plane;
290
291     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
292     if (!out) {
293         av_frame_free(&in);
294         return AVERROR(ENOMEM);
295     }
296     av_frame_copy_props(out, in);
297
298     if (lut->is_rgb) {
299         /* packed */
300         inrow0  = in ->data[0];
301         outrow0 = out->data[0];
302
303         for (i = 0; i < in->height; i ++) {
304             inrow  = inrow0;
305             outrow = outrow0;
306             for (j = 0; j < inlink->w; j++) {
307                 for (k = 0; k < lut->step; k++)
308                     outrow[k] = lut->lut[lut->rgba_map[k]][inrow[k]];
309                 outrow += lut->step;
310                 inrow  += lut->step;
311             }
312             inrow0  += in ->linesize[0];
313             outrow0 += out->linesize[0];
314         }
315     } else {
316         /* planar */
317         for (plane = 0; plane < 4 && in->data[plane]; plane++) {
318             int vsub = plane == 1 || plane == 2 ? lut->vsub : 0;
319             int hsub = plane == 1 || plane == 2 ? lut->hsub : 0;
320
321             inrow  = in ->data[plane];
322             outrow = out->data[plane];
323
324             for (i = 0; i < in->height >> vsub; i ++) {
325                 for (j = 0; j < inlink->w>>hsub; j++)
326                     outrow[j] = lut->lut[plane][inrow[j]];
327                 inrow  += in ->linesize[plane];
328                 outrow += out->linesize[plane];
329             }
330         }
331     }
332
333     av_frame_free(&in);
334     return ff_filter_frame(outlink, out);
335 }
336
337 static const AVFilterPad inputs[] = {
338     { .name            = "default",
339       .type            = AVMEDIA_TYPE_VIDEO,
340       .filter_frame    = filter_frame,
341       .config_props    = config_props,
342     },
343     { .name = NULL}
344 };
345 static const AVFilterPad outputs[] = {
346     { .name            = "default",
347       .type            = AVMEDIA_TYPE_VIDEO, },
348     { .name = NULL}
349 };
350 #define DEFINE_LUT_FILTER(name_, description_, init_, options)          \
351     static const AVClass name_ ## _class = {                            \
352         .class_name = #name_,                                           \
353         .item_name  = av_default_item_name,                             \
354         .option     = options,                                          \
355         .version    = LIBAVUTIL_VERSION_INT,                            \
356     };                                                                  \
357     AVFilter avfilter_vf_##name_ = {                                    \
358         .name          = #name_,                                        \
359         .description   = NULL_IF_CONFIG_SMALL(description_),            \
360         .priv_size     = sizeof(LutContext),                            \
361         .priv_class    = &name_ ## _class,                              \
362                                                                         \
363         .init          = init_,                                         \
364         .uninit        = uninit,                                        \
365         .query_formats = query_formats,                                 \
366                                                                         \
367         .inputs        = inputs,                                        \
368         .outputs       = outputs,                                       \
369     }
370
371 #if CONFIG_LUT_FILTER
372 DEFINE_LUT_FILTER(lut,    "Compute and apply a lookup table to the RGB/YUV input video.", init, lut_options);
373 #endif
374 #if CONFIG_LUTYUV_FILTER
375 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.",     init, lut_options);
376 #endif
377 #if CONFIG_LUTRGB_FILTER
378 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.",     init, lut_options);
379 #endif
380
381 #if CONFIG_NEGATE_FILTER
382
383 static const AVOption negate_options[] = {
384     { "negate_alpha", NULL, OFFSET(negate_alpha), AV_OPT_TYPE_INT, { .i64 = 0 }, .flags = FLAGS },
385     { NULL },
386 };
387
388 static int negate_init(AVFilterContext *ctx)
389 {
390     LutContext *lut = ctx->priv;
391     int i;
392
393     av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", lut->negate_alpha);
394
395     for (i = 0; i < 4; i++) {
396         lut->comp_expr_str[i] = av_strdup((i == 3 && lut->negate_alpha) ?
397                                           "val" : "negval");
398         if (!lut->comp_expr_str[i]) {
399             uninit(ctx);
400             return AVERROR(ENOMEM);
401         }
402     }
403
404     return init(ctx);
405 }
406
407 DEFINE_LUT_FILTER(negate, "Negate input video.", negate_init, negate_options);
408
409 #endif