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