factor identical ff_inplace_start_frame out of two filters
[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/eval.h"
28 #include "libavutil/mathematics.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
31 #include "avfilter.h"
32 #include "formats.h"
33 #include "internal.h"
34 #include "video.h"
35
36 static const char *const var_names[] = {
37     "E",
38     "PHI",
39     "PI",
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
46     "clipval",
47     NULL
48 };
49
50 enum var_name {
51     VAR_E,
52     VAR_PHI,
53     VAR_PI,
54     VAR_W,
55     VAR_H,
56     VAR_VAL,
57     VAR_MAXVAL,
58     VAR_MINVAL,
59     VAR_NEGVAL,
60     VAR_CLIPVAL,
61     VAR_VARS_NB
62 };
63
64 typedef struct {
65     const AVClass *class;
66     uint8_t lut[4][256];  ///< lookup table for each component
67     char   *comp_expr_str[4];
68     AVExpr *comp_expr[4];
69     int hsub, vsub;
70     double var_values[VAR_VARS_NB];
71     int is_rgb, is_yuv;
72     int rgba_map[4];
73     int step;
74     int negate_alpha; /* only used by negate */
75 } LutContext;
76
77 #define Y 0
78 #define U 1
79 #define V 2
80 #define R 0
81 #define G 1
82 #define B 2
83 #define A 3
84
85 #define OFFSET(x) offsetof(LutContext, x)
86
87 static const AVOption lut_options[] = {
88     {"c0", "set component #0 expression", OFFSET(comp_expr_str[0]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
89     {"c1", "set component #1 expression", OFFSET(comp_expr_str[1]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
90     {"c2", "set component #2 expression", OFFSET(comp_expr_str[2]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
91     {"c3", "set component #3 expression", OFFSET(comp_expr_str[3]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
92     {"y",  "set Y expression", OFFSET(comp_expr_str[Y]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
93     {"u",  "set U expression", OFFSET(comp_expr_str[U]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
94     {"v",  "set V expression", OFFSET(comp_expr_str[V]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
95     {"r",  "set R expression", OFFSET(comp_expr_str[R]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
96     {"g",  "set G expression", OFFSET(comp_expr_str[G]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
97     {"b",  "set B expression", OFFSET(comp_expr_str[B]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
98     {"a",  "set A expression", OFFSET(comp_expr_str[A]),  FF_OPT_TYPE_STRING, {.str="val"}, CHAR_MIN, CHAR_MAX},
99     {NULL},
100 };
101
102 static const char *lut_get_name(void *ctx)
103 {
104     return "lut";
105 }
106
107 static const AVClass lut_class = {
108     "LutContext",
109     lut_get_name,
110     lut_options
111 };
112
113 static int init(AVFilterContext *ctx, const char *args)
114 {
115     LutContext *lut = ctx->priv;
116     int ret;
117
118     lut->class = &lut_class;
119     av_opt_set_defaults(lut);
120
121     lut->var_values[VAR_PHI] = M_PHI;
122     lut->var_values[VAR_PI]  = M_PI;
123     lut->var_values[VAR_E ]  = M_E;
124
125     lut->is_rgb = !strcmp(ctx->filter->name, "lutrgb");
126     lut->is_yuv = !strcmp(ctx->filter->name, "lutyuv");
127     if (args && (ret = av_set_options_string(lut, args, "=", ":")) < 0)
128         return ret;
129
130     return 0;
131 }
132
133 static av_cold void uninit(AVFilterContext *ctx)
134 {
135     LutContext *lut = ctx->priv;
136     int i;
137
138     for (i = 0; i < 4; i++) {
139         av_expr_free(lut->comp_expr[i]);
140         lut->comp_expr[i] = NULL;
141         av_freep(&lut->comp_expr_str[i]);
142     }
143 }
144
145 #define YUV_FORMATS                                         \
146     PIX_FMT_YUV444P,  PIX_FMT_YUV422P,  PIX_FMT_YUV420P,    \
147     PIX_FMT_YUV411P,  PIX_FMT_YUV410P,  PIX_FMT_YUV440P,    \
148     PIX_FMT_YUVA420P,                                       \
149     PIX_FMT_YUVJ444P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ420P,   \
150     PIX_FMT_YUVJ440P
151
152 #define RGB_FORMATS                             \
153     PIX_FMT_ARGB,         PIX_FMT_RGBA,         \
154     PIX_FMT_ABGR,         PIX_FMT_BGRA,         \
155     PIX_FMT_RGB24,        PIX_FMT_BGR24
156
157 static enum PixelFormat yuv_pix_fmts[] = { YUV_FORMATS, PIX_FMT_NONE };
158 static enum PixelFormat rgb_pix_fmts[] = { RGB_FORMATS, PIX_FMT_NONE };
159 static enum PixelFormat all_pix_fmts[] = { RGB_FORMATS, YUV_FORMATS, PIX_FMT_NONE };
160
161 static int query_formats(AVFilterContext *ctx)
162 {
163     LutContext *lut = ctx->priv;
164
165     enum PixelFormat *pix_fmts = lut->is_rgb ? rgb_pix_fmts :
166                                  lut->is_yuv ? yuv_pix_fmts : all_pix_fmts;
167
168     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
169     return 0;
170 }
171
172 /**
173  * Clip value val in the minval - maxval range.
174  */
175 static double clip(void *opaque, double val)
176 {
177     LutContext *lut = opaque;
178     double minval = lut->var_values[VAR_MINVAL];
179     double maxval = lut->var_values[VAR_MAXVAL];
180
181     return av_clip(val, minval, maxval);
182 }
183
184 /**
185  * Compute gamma correction for value val, assuming the minval-maxval
186  * range, val is clipped to a value contained in the same interval.
187  */
188 static double compute_gammaval(void *opaque, double gamma)
189 {
190     LutContext *lut = opaque;
191     double val    = lut->var_values[VAR_CLIPVAL];
192     double minval = lut->var_values[VAR_MINVAL];
193     double maxval = lut->var_values[VAR_MAXVAL];
194
195     return pow((val-minval)/(maxval-minval), gamma) * (maxval-minval)+minval;
196 }
197
198 static double (* const funcs1[])(void *, double) = {
199     clip,
200     compute_gammaval,
201     NULL
202 };
203
204 static const char * const funcs1_names[] = {
205     "clip",
206     "gammaval",
207     NULL
208 };
209
210 static int config_props(AVFilterLink *inlink)
211 {
212     AVFilterContext *ctx = inlink->dst;
213     LutContext *lut = ctx->priv;
214     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[inlink->format];
215     int min[4], max[4];
216     int val, comp, ret;
217
218     lut->hsub = desc->log2_chroma_w;
219     lut->vsub = desc->log2_chroma_h;
220
221     lut->var_values[VAR_W] = inlink->w;
222     lut->var_values[VAR_H] = inlink->h;
223
224     switch (inlink->format) {
225     case PIX_FMT_YUV410P:
226     case PIX_FMT_YUV411P:
227     case PIX_FMT_YUV420P:
228     case PIX_FMT_YUV422P:
229     case PIX_FMT_YUV440P:
230     case PIX_FMT_YUV444P:
231     case PIX_FMT_YUVA420P:
232         min[Y] = min[U] = min[V] = 16;
233         max[Y] = 235;
234         max[U] = max[V] = 240;
235         min[A] = 0; max[A] = 255;
236         break;
237     default:
238         min[0] = min[1] = min[2] = min[3] = 0;
239         max[0] = max[1] = max[2] = max[3] = 255;
240     }
241
242     lut->is_yuv = lut->is_rgb = 0;
243     if      (ff_fmt_is_in(inlink->format, yuv_pix_fmts)) lut->is_yuv = 1;
244     else if (ff_fmt_is_in(inlink->format, rgb_pix_fmts)) lut->is_rgb = 1;
245
246     if (lut->is_rgb) {
247         switch (inlink->format) {
248         case PIX_FMT_ARGB:  lut->rgba_map[A] = 0; lut->rgba_map[R] = 1; lut->rgba_map[G] = 2; lut->rgba_map[B] = 3; break;
249         case PIX_FMT_ABGR:  lut->rgba_map[A] = 0; lut->rgba_map[B] = 1; lut->rgba_map[G] = 2; lut->rgba_map[R] = 3; break;
250         case PIX_FMT_RGBA:
251         case PIX_FMT_RGB24: lut->rgba_map[R] = 0; lut->rgba_map[G] = 1; lut->rgba_map[B] = 2; lut->rgba_map[A] = 3; break;
252         case PIX_FMT_BGRA:
253         case PIX_FMT_BGR24: lut->rgba_map[B] = 0; lut->rgba_map[G] = 1; lut->rgba_map[R] = 2; lut->rgba_map[A] = 3; break;
254         }
255         lut->step = av_get_bits_per_pixel(desc) >> 3;
256     }
257
258     for (comp = 0; comp < desc->nb_components; comp++) {
259         double res;
260
261         /* create the parsed expression */
262         ret = av_expr_parse(&lut->comp_expr[comp], lut->comp_expr_str[comp],
263                             var_names, funcs1_names, funcs1, NULL, NULL, 0, ctx);
264         if (ret < 0) {
265             av_log(ctx, AV_LOG_ERROR,
266                    "Error when parsing the expression '%s' for the component %d.\n",
267                    lut->comp_expr_str[comp], comp);
268             return AVERROR(EINVAL);
269         }
270
271         /* compute the lut */
272         lut->var_values[VAR_MAXVAL] = max[comp];
273         lut->var_values[VAR_MINVAL] = min[comp];
274
275         for (val = 0; val < 256; val++) {
276             lut->var_values[VAR_VAL] = val;
277             lut->var_values[VAR_CLIPVAL] = av_clip(val, min[comp], max[comp]);
278             lut->var_values[VAR_NEGVAL] =
279                 av_clip(min[comp] + max[comp] - lut->var_values[VAR_VAL],
280                         min[comp], max[comp]);
281
282             res = av_expr_eval(lut->comp_expr[comp], lut->var_values, lut);
283             if (isnan(res)) {
284                 av_log(ctx, AV_LOG_ERROR,
285                        "Error when evaluating the expression '%s' for the value %d for the component #%d.\n",
286                        lut->comp_expr_str[comp], val, comp);
287                 return AVERROR(EINVAL);
288             }
289             lut->lut[comp][val] = av_clip((int)res, min[comp], max[comp]);
290             av_log(ctx, AV_LOG_DEBUG, "val[%d][%d] = %d\n", comp, val, lut->lut[comp][val]);
291         }
292     }
293
294     return 0;
295 }
296
297 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
298 {
299     AVFilterContext *ctx = inlink->dst;
300     LutContext *lut = ctx->priv;
301     AVFilterLink *outlink = ctx->outputs[0];
302     AVFilterBufferRef *inpic  = inlink ->cur_buf;
303     AVFilterBufferRef *outpic = outlink->out_buf;
304     uint8_t *inrow, *outrow, *inrow0, *outrow0;
305     int i, j, k, plane;
306
307     if (lut->is_rgb) {
308         /* packed */
309         inrow0  = inpic ->data[0] + y * inpic ->linesize[0];
310         outrow0 = outpic->data[0] + y * outpic->linesize[0];
311
312         for (i = 0; i < h; i ++) {
313             inrow  = inrow0;
314             outrow = outrow0;
315             for (j = 0; j < inlink->w; j++) {
316                 for (k = 0; k < lut->step; k++)
317                     outrow[k] = lut->lut[lut->rgba_map[k]][inrow[k]];
318                 outrow += lut->step;
319                 inrow  += lut->step;
320             }
321             inrow0  += inpic ->linesize[0];
322             outrow0 += outpic->linesize[0];
323         }
324     } else {
325         /* planar */
326         for (plane = 0; plane < 4 && inpic->data[plane]; plane++) {
327             int vsub = plane == 1 || plane == 2 ? lut->vsub : 0;
328             int hsub = plane == 1 || plane == 2 ? lut->hsub : 0;
329
330             inrow  = inpic ->data[plane] + (y>>vsub) * inpic ->linesize[plane];
331             outrow = outpic->data[plane] + (y>>vsub) * outpic->linesize[plane];
332
333             for (i = 0; i < h>>vsub; i ++) {
334                 for (j = 0; j < inlink->w>>hsub; j++)
335                     outrow[j] = lut->lut[plane][inrow[j]];
336                 inrow  += inpic ->linesize[plane];
337                 outrow += outpic->linesize[plane];
338             }
339         }
340     }
341
342     return ff_draw_slice(outlink, y, h, slice_dir);
343 }
344
345 static const AVFilterPad inputs[] = {
346     { .name            = "default",
347       .type            = AVMEDIA_TYPE_VIDEO,
348       .draw_slice      = draw_slice,
349       .config_props    = config_props,
350       .min_perms       = AV_PERM_READ, },
351     { .name = NULL}
352 };
353 static const AVFilterPad outputs[] = {
354     { .name            = "default",
355       .type            = AVMEDIA_TYPE_VIDEO, },
356     { .name = NULL}
357 };
358 #define DEFINE_LUT_FILTER(name_, description_, init_)                   \
359     AVFilter avfilter_vf_##name_ = {                                    \
360         .name          = #name_,                                        \
361         .description   = NULL_IF_CONFIG_SMALL(description_),            \
362         .priv_size     = sizeof(LutContext),                            \
363                                                                         \
364         .init          = init_,                                         \
365         .uninit        = uninit,                                        \
366         .query_formats = query_formats,                                 \
367                                                                         \
368         .inputs        = inputs,                                        \
369         .outputs       = outputs,                                       \
370     }
371
372 #if CONFIG_LUT_FILTER
373 DEFINE_LUT_FILTER(lut,    "Compute and apply a lookup table to the RGB/YUV input video.", init);
374 #endif
375 #if CONFIG_LUTYUV_FILTER
376 DEFINE_LUT_FILTER(lutyuv, "Compute and apply a lookup table to the YUV input video.",     init);
377 #endif
378 #if CONFIG_LUTRGB_FILTER
379 DEFINE_LUT_FILTER(lutrgb, "Compute and apply a lookup table to the RGB input video.",     init);
380 #endif
381
382 #if CONFIG_NEGATE_FILTER
383
384 static int negate_init(AVFilterContext *ctx, const char *args)
385 {
386     LutContext *lut = ctx->priv;
387     char lut_params[64];
388
389     if (args)
390         sscanf(args, "%d", &lut->negate_alpha);
391
392     av_log(ctx, AV_LOG_DEBUG, "negate_alpha:%d\n", lut->negate_alpha);
393
394     snprintf(lut_params, sizeof(lut_params), "c0=negval:c1=negval:c2=negval:a=%s",
395              lut->negate_alpha ? "negval" : "val");
396
397     return init(ctx, lut_params);
398 }
399
400 DEFINE_LUT_FILTER(negate, "Negate input video.", negate_init);
401
402 #endif