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