2 * Copyright (c) 2016 Paul B Mahol
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
21 #include "libavutil/attributes.h"
22 #include "libavutil/common.h"
23 #include "libavutil/eval.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
27 #include "drawutils.h"
31 #include "framesync.h"
33 static const char *const var_names[] = {
34 "w", ///< width of the input video
35 "h", ///< height of the input video
36 "x", ///< input value for the pixel from input #1
37 "y", ///< input value for the pixel from input #2
38 "bdx", ///< input #1 video bitdepth
39 "bdy", ///< input #2 video bitdepth
53 typedef struct LUT2Context {
58 char *comp_expr_str[4];
61 double var_values[VAR_VARS_NB];
62 uint16_t *lut[4]; ///< lookup table for each component
63 int width[4], height[4];
64 int widthx[4], heightx[4];
65 int widthy[4], heighty[4];
69 int depth, depthx, depthy;
71 AVFrame *prev_frame; /* only used with tlut2 */
73 int (*lut2)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
76 typedef struct ThreadData {
77 AVFrame *out, *srcx, *srcy;
80 #define OFFSET(x) offsetof(LUT2Context, x)
81 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
83 static const AVOption options[] = {
84 { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
85 { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
86 { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
87 { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
88 { "d", "set output depth", OFFSET(odepth), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 16, .flags = FLAGS },
92 static av_cold void uninit(AVFilterContext *ctx)
94 LUT2Context *s = ctx->priv;
97 ff_framesync_uninit(&s->fs);
98 av_frame_free(&s->prev_frame);
100 for (i = 0; i < 4; i++) {
101 av_expr_free(s->comp_expr[i]);
102 s->comp_expr[i] = NULL;
103 av_freep(&s->comp_expr_str[i]);
104 av_freep(&s->lut[i]);
109 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P, \
110 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P, \
111 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P, \
112 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P, \
113 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, \
114 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
117 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GRAY9, \
118 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
119 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
122 AV_PIX_FMT_GRAY10, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10, \
123 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
124 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
127 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12, \
128 AV_PIX_FMT_GRAY12, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRP12,
131 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
132 AV_PIX_FMT_GRAY12, AV_PIX_FMT_GBRP14,
135 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
136 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16, \
137 AV_PIX_FMT_GBRP16, AV_PIX_FMT_GBRAP16, AV_PIX_FMT_GRAY16,
139 static int query_formats(AVFilterContext *ctx)
141 LUT2Context *s = ctx->priv;
142 static const enum AVPixelFormat all_pix_fmts[] = {
149 static const enum AVPixelFormat bit8_pix_fmts[] = {
153 static const enum AVPixelFormat bit9_pix_fmts[] = {
157 static const enum AVPixelFormat bit10_pix_fmts[] = {
161 static const enum AVPixelFormat bit12_pix_fmts[] = {
165 static const enum AVPixelFormat bit14_pix_fmts[] = {
169 static const enum AVPixelFormat bit16_pix_fmts[] = {
173 const enum AVPixelFormat *pix_fmts;
176 if (s->tlut2 || !s->odepth)
177 return ff_set_common_formats(ctx, ff_make_format_list(all_pix_fmts));
179 ret = ff_formats_ref(ff_make_format_list(all_pix_fmts), &ctx->inputs[0]->out_formats);
184 case 8: pix_fmts = bit8_pix_fmts; break;
185 case 9: pix_fmts = bit9_pix_fmts; break;
186 case 10: pix_fmts = bit10_pix_fmts; break;
187 case 12: pix_fmts = bit12_pix_fmts; break;
188 case 14: pix_fmts = bit14_pix_fmts; break;
189 case 16: pix_fmts = bit16_pix_fmts; break;
190 default: av_log(ctx, AV_LOG_ERROR, "Unsupported output bit depth %d.\n", s->odepth);
191 return AVERROR(EINVAL);
194 return ff_formats_ref(ff_make_format_list(pix_fmts), &ctx->outputs[0]->in_formats);
197 static int config_inputx(AVFilterLink *inlink)
199 AVFilterContext *ctx = inlink->dst;
200 LUT2Context *s = ctx->priv;
201 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
202 int hsub = desc->log2_chroma_w;
203 int vsub = desc->log2_chroma_h;
205 s->nb_planesx = av_pix_fmt_count_planes(inlink->format);
206 s->heightx[1] = s->heightx[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
207 s->heightx[0] = s->heightx[3] = inlink->h;
208 s->widthx[1] = s->widthx[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
209 s->widthx[0] = s->widthx[3] = inlink->w;
211 s->var_values[VAR_W] = inlink->w;
212 s->var_values[VAR_H] = inlink->h;
213 s->depthx = desc->comp[0].depth;
214 s->var_values[VAR_BITDEPTHX] = s->depthx;
217 s->depthy = desc->comp[0].depth;
218 s->var_values[VAR_BITDEPTHY] = s->depthy;
224 static int config_inputy(AVFilterLink *inlink)
226 AVFilterContext *ctx = inlink->dst;
227 LUT2Context *s = ctx->priv;
228 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
229 int hsub = desc->log2_chroma_w;
230 int vsub = desc->log2_chroma_h;
232 s->nb_planesy = av_pix_fmt_count_planes(inlink->format);
233 s->depthy = desc->comp[0].depth;
234 s->var_values[VAR_BITDEPTHY] = s->depthy;
235 s->heighty[1] = s->heighty[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
236 s->heighty[0] = s->heighty[3] = inlink->h;
237 s->widthy[1] = s->widthy[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
238 s->widthy[0] = s->widthy[3] = inlink->w;
243 #define DEFINE_LUT2(zname, xname, yname, ztype, xtype, ytype, zdiv, xdiv, ydiv) \
244 static int lut2_##zname##_##xname##_##yname(AVFilterContext *ctx, \
246 int jobnr, int nb_jobs) \
248 LUT2Context *s = ctx->priv; \
249 ThreadData *td = arg; \
250 AVFrame *out = td->out; \
251 AVFrame *srcx = td->srcx; \
252 AVFrame *srcy = td->srcy; \
253 const int odepth = s->odepth; \
256 for (p = 0; p < s->nb_planes; p++) { \
257 const int slice_start = (s->heightx[p] * jobnr) / nb_jobs; \
258 const int slice_end = (s->heightx[p] * (jobnr+1)) / nb_jobs; \
259 const uint16_t *lut = s->lut[p]; \
260 const xtype *srcxx; \
261 const ytype *srcyy; \
264 dst = (ztype *)(out->data[p] + slice_start * out->linesize[p]); \
265 srcxx = (const xtype *)(srcx->data[p] + slice_start * srcx->linesize[p]);\
266 srcyy = (const ytype *)(srcy->data[p] + slice_start * srcy->linesize[p]);\
268 for (y = slice_start; y < slice_end; y++) { \
269 for (x = 0; x < s->widthx[p]; x++) { \
270 dst[x] = av_clip_uintp2_c(lut[(srcyy[x] << s->depthx) | srcxx[x]], odepth); \
273 dst += out->linesize[p] / zdiv; \
274 srcxx += srcx->linesize[p] / xdiv; \
275 srcyy += srcy->linesize[p] / ydiv; \
281 DEFINE_LUT2(8, 8, 8, uint8_t, uint8_t, uint8_t, 1, 1, 1)
282 DEFINE_LUT2(8, 8, 16, uint8_t, uint8_t, uint16_t, 1, 1, 2)
283 DEFINE_LUT2(8, 16, 8, uint8_t, uint16_t, uint8_t, 1, 2, 1)
284 DEFINE_LUT2(8, 16, 16, uint8_t, uint16_t, uint16_t, 1, 2, 2)
285 DEFINE_LUT2(16, 8, 8, uint16_t, uint8_t, uint8_t, 2, 1, 1)
286 DEFINE_LUT2(16, 8, 16, uint16_t, uint8_t, uint16_t, 2, 1, 2)
287 DEFINE_LUT2(16, 16, 8, uint16_t, uint16_t, uint8_t, 2, 2, 1)
288 DEFINE_LUT2(16, 16, 16, uint16_t, uint16_t, uint16_t, 2, 2, 2)
290 static int process_frame(FFFrameSync *fs)
292 AVFilterContext *ctx = fs->parent;
293 LUT2Context *s = fs->opaque;
294 AVFilterLink *outlink = ctx->outputs[0];
295 AVFrame *out, *srcx = NULL, *srcy = NULL;
298 if ((ret = ff_framesync_get_frame(&s->fs, 0, &srcx, 0)) < 0 ||
299 (ret = ff_framesync_get_frame(&s->fs, 1, &srcy, 0)) < 0)
302 if (ctx->is_disabled || !srcy) {
303 out = av_frame_clone(srcx);
305 return AVERROR(ENOMEM);
309 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
311 return AVERROR(ENOMEM);
312 av_frame_copy_props(out, srcx);
317 ctx->internal->execute(ctx, s->lut2, &td, NULL, FFMIN(s->heightx[1], ff_filter_get_nb_threads(ctx)));
320 out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
322 return ff_filter_frame(outlink, out);
325 static int config_output(AVFilterLink *outlink)
327 AVFilterContext *ctx = outlink->src;
328 LUT2Context *s = ctx->priv;
331 s->depth = s->depthx + s->depthy;
332 s->nb_planes = s->nb_planesx;
334 s->lut2 = s->depth > 16 ? lut2_16_16_16 : lut2_8_8_8;
336 if (s->depthx == 8 && s->depthy == 8 && s->odepth > 8)
337 s->lut2 = lut2_16_8_8;
338 if (s->depthx > 8 && s->depthy == 8 && s->odepth > 8)
339 s->lut2 = lut2_16_16_8;
340 if (s->depthx == 8 && s->depthy > 8 && s->odepth > 8)
341 s->lut2 = lut2_16_8_16;
342 if (s->depthx == 8 && s->depthy == 8 && s->odepth == 8)
343 s->lut2 = lut2_8_8_8;
344 if (s->depthx > 8 && s->depthy == 8 && s->odepth == 8)
345 s->lut2 = lut2_8_16_8;
346 if (s->depthx == 8 && s->depthy > 8 && s->odepth == 8)
347 s->lut2 = lut2_8_8_16;
348 if (s->depthx > 8 && s->depthy > 8 && s->odepth == 8)
349 s->lut2 = lut2_8_16_16;
351 s->odepth = s->depthx;
354 for (p = 0; p < s->nb_planes; p++) {
355 s->lut[p] = av_malloc_array(1 << s->depth, sizeof(uint16_t));
357 return AVERROR(ENOMEM);
360 for (p = 0; p < s->nb_planes; p++) {
364 /* create the parsed expression */
365 av_expr_free(s->comp_expr[p]);
366 s->comp_expr[p] = NULL;
367 ret = av_expr_parse(&s->comp_expr[p], s->comp_expr_str[p],
368 var_names, NULL, NULL, NULL, NULL, 0, ctx);
370 av_log(ctx, AV_LOG_ERROR,
371 "Error when parsing the expression '%s' for the component %d.\n",
372 s->comp_expr_str[p], p);
373 return AVERROR(EINVAL);
376 /* compute the lut */
377 for (y = 0; y < (1 << s->depthy); y++) {
378 s->var_values[VAR_Y] = y;
379 for (x = 0; x < (1 << s->depthx); x++) {
380 s->var_values[VAR_X] = x;
381 res = av_expr_eval(s->comp_expr[p], s->var_values, s);
383 av_log(ctx, AV_LOG_ERROR,
384 "Error when evaluating the expression '%s' for the values %d and %d for the component %d.\n",
385 s->comp_expr_str[p], x, y, p);
386 return AVERROR(EINVAL);
389 s->lut[p][(y << s->depthx) + x] = res;
397 static int lut2_config_output(AVFilterLink *outlink)
399 AVFilterContext *ctx = outlink->src;
400 LUT2Context *s = ctx->priv;
401 AVFilterLink *srcx = ctx->inputs[0];
402 AVFilterLink *srcy = ctx->inputs[1];
404 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(outlink->format);
405 int hsub = desc->log2_chroma_w;
406 int vsub = desc->log2_chroma_h;
409 outlink->w = srcx->w;
410 outlink->h = srcx->h;
411 outlink->time_base = srcx->time_base;
412 outlink->sample_aspect_ratio = srcx->sample_aspect_ratio;
413 outlink->frame_rate = srcx->frame_rate;
415 s->nb_planes = av_pix_fmt_count_planes(outlink->format);
416 s->height[1] = s->height[2] = AV_CEIL_RSHIFT(outlink->h, vsub);
417 s->height[0] = s->height[3] = outlink->h;
418 s->width[1] = s->width[2] = AV_CEIL_RSHIFT(outlink->w, hsub);
419 s->width[0] = s->width[3] = outlink->w;
421 if (!s->odepth && srcx->format != srcy->format) {
422 av_log(ctx, AV_LOG_ERROR, "inputs must be of same pixel format\n");
423 return AVERROR(EINVAL);
426 if (srcx->w != srcy->w || srcx->h != srcy->h) {
427 av_log(ctx, AV_LOG_ERROR, "First input link %s parameters "
428 "(size %dx%d) do not match the corresponding "
429 "second input link %s parameters (size %dx%d)\n",
430 ctx->input_pads[0].name, srcx->w, srcx->h,
431 ctx->input_pads[1].name,
433 return AVERROR(EINVAL);
436 if (s->nb_planesx != s->nb_planesy) {
437 av_log(ctx, AV_LOG_ERROR, "First input link %s number of planes "
438 "(%d) do not match the corresponding "
439 "second input link %s number of planes (%d)\n",
440 ctx->input_pads[0].name, s->nb_planesx,
441 ctx->input_pads[1].name, s->nb_planesy);
442 return AVERROR(EINVAL);
445 if (s->nb_planesx != s->nb_planes) {
446 av_log(ctx, AV_LOG_ERROR, "First input link %s number of planes "
447 "(%d) do not match the corresponding "
448 "output link %s number of planes (%d)\n",
449 ctx->input_pads[0].name, s->nb_planesx,
450 ctx->output_pads[0].name, s->nb_planes);
451 return AVERROR(EINVAL);
454 if (s->widthx[1] != s->widthy[1] || s->heightx[1] != s->heighty[1]) {
455 av_log(ctx, AV_LOG_ERROR, "First input link %s 2nd plane "
456 "(size %dx%d) do not match the corresponding "
457 "second input link %s 2nd plane (size %dx%d)\n",
458 ctx->input_pads[0].name, s->widthx[1], s->heightx[1],
459 ctx->input_pads[1].name,
460 s->widthy[1], s->heighty[1]);
461 return AVERROR(EINVAL);
464 if (s->widthx[2] != s->widthy[2] || s->heightx[2] != s->heighty[2]) {
465 av_log(ctx, AV_LOG_ERROR, "First input link %s 3rd plane "
466 "(size %dx%d) do not match the corresponding "
467 "second input link %s 3rd plane (size %dx%d)\n",
468 ctx->input_pads[0].name, s->widthx[2], s->heightx[2],
469 ctx->input_pads[1].name,
470 s->widthy[2], s->heighty[2]);
471 return AVERROR(EINVAL);
474 if (s->widthx[1] != s->width[1] || s->heightx[1] != s->height[1]) {
475 av_log(ctx, AV_LOG_ERROR, "First input link %s 2nd plane "
476 "(size %dx%d) do not match the corresponding "
477 "output link %s 2nd plane (size %dx%d)\n",
478 ctx->input_pads[0].name, s->widthx[1], s->heightx[1],
479 ctx->output_pads[0].name, s->width[1], s->height[1]);
480 return AVERROR(EINVAL);
483 if (s->widthx[2] != s->width[2] || s->heightx[2] != s->height[2]) {
484 av_log(ctx, AV_LOG_ERROR, "First input link %s 3rd plane "
485 "(size %dx%d) do not match the corresponding "
486 "output link %s 3rd plane (size %dx%d)\n",
487 ctx->input_pads[0].name, s->widthx[2], s->heightx[2],
488 ctx->output_pads[0].name, s->width[2], s->height[2]);
489 return AVERROR(EINVAL);
492 if ((ret = ff_framesync_init(&s->fs, ctx, 2)) < 0)
496 in[0].time_base = srcx->time_base;
497 in[1].time_base = srcy->time_base;
499 in[0].before = EXT_STOP;
500 in[0].after = EXT_INFINITY;
502 in[1].before = EXT_STOP;
503 in[1].after = EXT_INFINITY;
505 s->fs.on_event = process_frame;
507 if ((ret = config_output(outlink)) < 0)
510 return ff_framesync_configure(&s->fs);
513 static int activate(AVFilterContext *ctx)
515 LUT2Context *s = ctx->priv;
516 return ff_framesync_activate(&s->fs);
519 static const AVFilterPad inputs[] = {
522 .type = AVMEDIA_TYPE_VIDEO,
523 .config_props = config_inputx,
527 .type = AVMEDIA_TYPE_VIDEO,
528 .config_props = config_inputy,
533 static const AVFilterPad outputs[] = {
536 .type = AVMEDIA_TYPE_VIDEO,
537 .config_props = lut2_config_output,
542 #define lut2_options options
544 FRAMESYNC_DEFINE_CLASS(lut2, LUT2Context, fs);
546 AVFilter ff_vf_lut2 = {
548 .description = NULL_IF_CONFIG_SMALL("Compute and apply a lookup table from two video inputs."),
549 .preinit = lut2_framesync_preinit,
550 .priv_size = sizeof(LUT2Context),
551 .priv_class = &lut2_class,
553 .query_formats = query_formats,
554 .activate = activate,
557 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL |
558 AVFILTER_FLAG_SLICE_THREADS,
561 #if CONFIG_TLUT2_FILTER
563 static av_cold int init(AVFilterContext *ctx)
565 LUT2Context *s = ctx->priv;
567 s->tlut2 = !strcmp(ctx->filter->name, "tlut2");
572 static int tlut2_filter_frame(AVFilterLink *inlink, AVFrame *frame)
574 AVFilterContext *ctx = inlink->dst;
575 LUT2Context *s = ctx->priv;
576 AVFilterLink *outlink = ctx->outputs[0];
581 if (ctx->is_disabled) {
582 out = av_frame_clone(frame);
586 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
588 av_frame_free(&s->prev_frame);
589 s->prev_frame = frame;
590 return AVERROR(ENOMEM);
593 av_frame_copy_props(out, frame);
597 td.srcy = s->prev_frame;
598 ctx->internal->execute(ctx, s->lut2, &td, NULL, FFMIN(s->heightx[1], ff_filter_get_nb_threads(ctx)));
600 av_frame_free(&s->prev_frame);
601 s->prev_frame = frame;
602 return ff_filter_frame(outlink, out);
604 s->prev_frame = frame;
608 static const AVOption tlut2_options[] = {
609 { "c0", "set component #0 expression", OFFSET(comp_expr_str[0]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
610 { "c1", "set component #1 expression", OFFSET(comp_expr_str[1]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
611 { "c2", "set component #2 expression", OFFSET(comp_expr_str[2]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
612 { "c3", "set component #3 expression", OFFSET(comp_expr_str[3]), AV_OPT_TYPE_STRING, { .str = "x" }, .flags = FLAGS },
616 AVFILTER_DEFINE_CLASS(tlut2);
618 static const AVFilterPad tlut2_inputs[] = {
621 .type = AVMEDIA_TYPE_VIDEO,
622 .filter_frame = tlut2_filter_frame,
623 .config_props = config_inputx,
628 static const AVFilterPad tlut2_outputs[] = {
631 .type = AVMEDIA_TYPE_VIDEO,
632 .config_props = config_output,
637 AVFilter ff_vf_tlut2 = {
639 .description = NULL_IF_CONFIG_SMALL("Compute and apply a lookup table from two successive frames."),
640 .priv_size = sizeof(LUT2Context),
641 .priv_class = &tlut2_class,
642 .query_formats = query_formats,
645 .inputs = tlut2_inputs,
646 .outputs = tlut2_outputs,
647 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL |
648 AVFILTER_FLAG_SLICE_THREADS,