2 * Copyright (C) 2006 Michael Niedermayer <michaelni@gmx.at>
3 * Copyright (C) 2012 Clément Bœsch <u pkh me>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Generic equation change filter
25 * Originally written by Michael Niedermayer for the MPlayer project, and
26 * ported by Clément Bœsch for FFmpeg.
29 #include "libavutil/avassert.h"
30 #include "libavutil/avstring.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
36 #define MAX_NB_THREADS 32
39 enum InterpolationMethods {
45 static const char *const var_names[] = { "X", "Y", "W", "H", "N", "SW", "SH", "T", NULL };
46 enum { VAR_X, VAR_Y, VAR_W, VAR_H, VAR_N, VAR_SW, VAR_SH, VAR_T, VAR_VARS_NB };
48 typedef struct GEQContext {
50 AVExpr *e[NB_PLANES][MAX_NB_THREADS]; ///< expressions for each plane and thread
51 char *expr_str[4+3]; ///< expression strings for each plane
52 AVFrame *picref; ///< current input buffer
53 uint8_t *dst; ///< reference pointer to the 8bits output
54 uint16_t *dst16; ///< reference pointer to the 16bits output
55 double values[VAR_VARS_NB]; ///< expression values
56 int hsub, vsub; ///< chroma subsampling
57 int planes; ///< number of planes
62 double *pixel_sums[NB_PLANES];
63 int needs_sum[NB_PLANES];
66 enum { Y = 0, U, V, A, G, B, R };
68 #define OFFSET(x) offsetof(GEQContext, x)
69 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
71 static const AVOption geq_options[] = {
72 { "lum_expr", "set luminance expression", OFFSET(expr_str[Y]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
73 { "lum", "set luminance expression", OFFSET(expr_str[Y]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
74 { "cb_expr", "set chroma blue expression", OFFSET(expr_str[U]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
75 { "cb", "set chroma blue expression", OFFSET(expr_str[U]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
76 { "cr_expr", "set chroma red expression", OFFSET(expr_str[V]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
77 { "cr", "set chroma red expression", OFFSET(expr_str[V]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
78 { "alpha_expr", "set alpha expression", OFFSET(expr_str[A]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
79 { "a", "set alpha expression", OFFSET(expr_str[A]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
80 { "red_expr", "set red expression", OFFSET(expr_str[R]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
81 { "r", "set red expression", OFFSET(expr_str[R]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
82 { "green_expr", "set green expression", OFFSET(expr_str[G]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
83 { "g", "set green expression", OFFSET(expr_str[G]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
84 { "blue_expr", "set blue expression", OFFSET(expr_str[B]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
85 { "b", "set blue expression", OFFSET(expr_str[B]), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
86 { "interpolation","set interpolation method", OFFSET(interpolation), AV_OPT_TYPE_INT, {.i64=INTERP_BILINEAR}, 0, NB_INTERP-1, FLAGS, "interp" },
87 { "i", "set interpolation method", OFFSET(interpolation), AV_OPT_TYPE_INT, {.i64=INTERP_BILINEAR}, 0, NB_INTERP-1, FLAGS, "interp" },
88 { "nearest", "nearest interpolation", 0, AV_OPT_TYPE_CONST, {.i64=INTERP_NEAREST}, 0, 0, FLAGS, "interp" },
89 { "n", "nearest interpolation", 0, AV_OPT_TYPE_CONST, {.i64=INTERP_NEAREST}, 0, 0, FLAGS, "interp" },
90 { "bilinear", "bilinear interpolation", 0, AV_OPT_TYPE_CONST, {.i64=INTERP_BILINEAR}, 0, 0, FLAGS, "interp" },
91 { "b", "bilinear interpolation", 0, AV_OPT_TYPE_CONST, {.i64=INTERP_BILINEAR}, 0, 0, FLAGS, "interp" },
95 AVFILTER_DEFINE_CLASS(geq);
97 static inline double getpix(void *priv, double x, double y, int plane)
100 GEQContext *geq = priv;
101 AVFrame *picref = geq->picref;
102 const uint8_t *src = picref->data[plane];
103 int linesize = picref->linesize[plane];
104 const int w = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(picref->width, geq->hsub) : picref->width;
105 const int h = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(picref->height, geq->vsub) : picref->height;
110 if (geq->interpolation == INTERP_BILINEAR) {
111 xi = x = av_clipd(x, 0, w - 2);
112 yi = y = av_clipd(y, 0, h - 2);
118 const uint16_t *src16 = (const uint16_t*)src;
121 return (1-y)*((1-x)*src16[xi + yi * linesize] + x*src16[xi + 1 + yi * linesize])
122 + y *((1-x)*src16[xi + (yi+1) * linesize] + x*src16[xi + 1 + (yi+1) * linesize]);
124 return (1-y)*((1-x)*src[xi + yi * linesize] + x*src[xi + 1 + yi * linesize])
125 + y *((1-x)*src[xi + (yi+1) * linesize] + x*src[xi + 1 + (yi+1) * linesize]);
128 xi = av_clipd(x, 0, w - 1);
129 yi = av_clipd(y, 0, h - 1);
132 const uint16_t *src16 = (const uint16_t*)src;
135 return src16[xi + yi * linesize];
137 return src[xi + yi * linesize];
142 static int calculate_sums(GEQContext *geq, int plane, int w, int h)
145 AVFrame *picref = geq->picref;
146 const uint8_t *src = picref->data[plane];
147 int linesize = picref->linesize[plane];
149 if (!geq->pixel_sums[plane])
150 geq->pixel_sums[plane] = av_malloc_array(w, h * sizeof (*geq->pixel_sums[plane]));
151 if (!geq->pixel_sums[plane])
152 return AVERROR(ENOMEM);
155 for (yi = 0; yi < h; yi ++) {
157 const uint16_t *src16 = (const uint16_t*)src;
160 for (xi = 0; xi < w; xi ++) {
161 linesum += src16[xi + yi * linesize];
162 geq->pixel_sums[plane][xi + yi * w] = linesum;
167 for (xi = 0; xi < w; xi ++) {
168 linesum += src[xi + yi * linesize];
169 geq->pixel_sums[plane][xi + yi * w] = linesum;
173 for (xi = 0; xi < w; xi ++) {
174 geq->pixel_sums[plane][xi + yi * w] += geq->pixel_sums[plane][xi + yi * w - w];
180 static inline double getpix_integrate_internal(GEQContext *geq, int x, int y, int plane, int w, int h)
183 double boundary = getpix_integrate_internal(geq, w - 1, y, plane, w, h);
184 return 2*boundary - getpix_integrate_internal(geq, 2*(w - 1) - x, y, plane, w, h);
185 } else if (y > h - 1) {
186 double boundary = getpix_integrate_internal(geq, x, h - 1, plane, w, h);
187 return 2*boundary - getpix_integrate_internal(geq, x, 2*(h - 1) - y, plane, w, h);
189 if (x == -1) return 0;
190 return - getpix_integrate_internal(geq, -x-2, y, plane, w, h);
192 if (y == -1) return 0;
193 return - getpix_integrate_internal(geq, x, -y-2, plane, w, h);
196 return geq->pixel_sums[plane][x + y * w];
199 static inline double getpix_integrate(void *priv, double x, double y, int plane) {
200 GEQContext *geq = priv;
201 AVFrame *picref = geq->picref;
202 const uint8_t *src = picref->data[plane];
203 const int w = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(picref->width, geq->hsub) : picref->width;
204 const int h = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(picref->height, geq->vsub) : picref->height;
209 return getpix_integrate_internal(geq, lrint(av_clipd(x, -w, 2*w)), lrint(av_clipd(y, -h, 2*h)), plane, w, h);
212 //TODO: cubic interpolate
213 //TODO: keep the last few frames
214 static double lum(void *priv, double x, double y) { return getpix(priv, x, y, 0); }
215 static double cb(void *priv, double x, double y) { return getpix(priv, x, y, 1); }
216 static double cr(void *priv, double x, double y) { return getpix(priv, x, y, 2); }
217 static double alpha(void *priv, double x, double y) { return getpix(priv, x, y, 3); }
219 static double lumsum(void *priv, double x, double y) { return getpix_integrate(priv, x, y, 0); }
220 static double cbsum(void *priv, double x, double y) { return getpix_integrate(priv, x, y, 1); }
221 static double crsub(void *priv, double x, double y) { return getpix_integrate(priv, x, y, 2); }
222 static double alphasum(void *priv, double x, double y) { return getpix_integrate(priv, x, y, 3); }
224 static av_cold int geq_init(AVFilterContext *ctx)
226 GEQContext *geq = ctx->priv;
229 if (!geq->expr_str[Y] && !geq->expr_str[G] && !geq->expr_str[B] && !geq->expr_str[R]) {
230 av_log(ctx, AV_LOG_ERROR, "A luminance or RGB expression is mandatory\n");
231 ret = AVERROR(EINVAL);
234 geq->is_rgb = !geq->expr_str[Y];
236 if ((geq->expr_str[Y] || geq->expr_str[U] || geq->expr_str[V]) && (geq->expr_str[G] || geq->expr_str[B] || geq->expr_str[R])) {
237 av_log(ctx, AV_LOG_ERROR, "Either YCbCr or RGB but not both must be specified\n");
238 ret = AVERROR(EINVAL);
242 if (!geq->expr_str[U] && !geq->expr_str[V]) {
243 /* No chroma at all: fallback on luma */
244 geq->expr_str[U] = av_strdup(geq->expr_str[Y]);
245 geq->expr_str[V] = av_strdup(geq->expr_str[Y]);
247 /* One chroma unspecified, fallback on the other */
248 if (!geq->expr_str[U]) geq->expr_str[U] = av_strdup(geq->expr_str[V]);
249 if (!geq->expr_str[V]) geq->expr_str[V] = av_strdup(geq->expr_str[U]);
252 if (!geq->expr_str[A]) {
254 snprintf(bps_string, sizeof(bps_string), "%d", (1<<geq->bps) - 1);
255 geq->expr_str[A] = av_strdup(bps_string);
257 if (!geq->expr_str[G])
258 geq->expr_str[G] = av_strdup("g(X,Y)");
259 if (!geq->expr_str[B])
260 geq->expr_str[B] = av_strdup("b(X,Y)");
261 if (!geq->expr_str[R])
262 geq->expr_str[R] = av_strdup("r(X,Y)");
265 (!geq->expr_str[G] || !geq->expr_str[B] || !geq->expr_str[R])
267 (!geq->expr_str[U] || !geq->expr_str[V] || !geq->expr_str[A])) {
268 ret = AVERROR(ENOMEM);
272 for (plane = 0; plane < NB_PLANES; plane++) {
273 static double (*const p[])(void *, double, double) = {
274 lum , cb , cr , alpha ,
275 lumsum, cbsum, crsub, alphasum,
277 static const char *const func2_yuv_names[] = {
278 "lum" , "cb" , "cr" , "alpha" , "p",
279 "lumsum", "cbsum", "crsum", "alphasum", "psum",
281 static const char *const func2_rgb_names[] = {
282 "g" , "b" , "r" , "alpha" , "p",
283 "gsum", "bsum", "rsum", "alphasum", "psum",
285 const char *const *func2_names = geq->is_rgb ? func2_rgb_names : func2_yuv_names;
286 double (*const func2[])(void *, double, double) = {
287 lum , cb , cr , alpha , p[plane],
288 lumsum, cbsum, crsub, alphasum, p[plane + 4],
290 int counter[10] = {0};
292 for (int i = 0; i < MAX_NB_THREADS; i++) {
293 ret = av_expr_parse(&geq->e[plane][i], geq->expr_str[plane < 3 && geq->is_rgb ? plane+4 : plane], var_names,
294 NULL, NULL, func2_names, func2, 0, ctx);
299 av_expr_count_func(geq->e[plane][0], counter, FF_ARRAY_ELEMS(counter), 2);
300 geq->needs_sum[plane] = counter[5] + counter[6] + counter[7] + counter[8] + counter[9];
307 static int geq_query_formats(AVFilterContext *ctx)
309 GEQContext *geq = ctx->priv;
310 static const enum AVPixelFormat yuv_pix_fmts[] = {
311 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
312 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
313 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA420P,
315 AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV420P9,
316 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA420P9,
317 AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV420P10,
318 AV_PIX_FMT_YUV440P10,
319 AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA420P10,
320 AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10,
321 AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
322 AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14,
323 AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
324 AV_PIX_FMT_YUV444P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV420P16,
325 AV_PIX_FMT_YUVA444P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA420P16,
329 static const enum AVPixelFormat rgb_pix_fmts[] = {
330 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
332 AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
333 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
335 AV_PIX_FMT_GBRP16, AV_PIX_FMT_GBRAP16,
338 AVFilterFormats *fmts_list;
341 fmts_list = ff_make_format_list(rgb_pix_fmts);
343 fmts_list = ff_make_format_list(yuv_pix_fmts);
345 return AVERROR(ENOMEM);
346 return ff_set_common_formats(ctx, fmts_list);
349 static int geq_config_props(AVFilterLink *inlink)
351 GEQContext *geq = inlink->dst->priv;
352 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
356 geq->hsub = desc->log2_chroma_w;
357 geq->vsub = desc->log2_chroma_h;
358 geq->bps = desc->comp[0].depth;
359 geq->planes = desc->nb_components;
363 typedef struct ThreadData {
370 static int slice_geq_filter(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
372 GEQContext *geq = ctx->priv;
373 ThreadData *td = arg;
374 const int height = td->height;
375 const int width = td->width;
376 const int plane = td->plane;
377 const int linesize = td->linesize;
378 const int slice_start = (height * jobnr) / nb_jobs;
379 const int slice_end = (height * (jobnr+1)) / nb_jobs;
382 double values[VAR_VARS_NB];
383 values[VAR_W] = geq->values[VAR_W];
384 values[VAR_H] = geq->values[VAR_H];
385 values[VAR_N] = geq->values[VAR_N];
386 values[VAR_SW] = geq->values[VAR_SW];
387 values[VAR_SH] = geq->values[VAR_SH];
388 values[VAR_T] = geq->values[VAR_T];
391 uint8_t *ptr = geq->dst + linesize * slice_start;
392 for (y = slice_start; y < slice_end; y++) {
395 for (x = 0; x < width; x++) {
397 ptr[x] = av_expr_eval(geq->e[plane][jobnr], values, geq);
402 uint16_t *ptr16 = geq->dst16 + (linesize/2) * slice_start;
403 for (y = slice_start; y < slice_end; y++) {
405 for (x = 0; x < width; x++) {
407 ptr16[x] = av_expr_eval(geq->e[plane][jobnr], values, geq);
416 static int geq_filter_frame(AVFilterLink *inlink, AVFrame *in)
419 AVFilterContext *ctx = inlink->dst;
420 const int nb_threads = FFMIN(MAX_NB_THREADS, ff_filter_get_nb_threads(ctx));
421 GEQContext *geq = ctx->priv;
422 AVFilterLink *outlink = inlink->dst->outputs[0];
425 geq->values[VAR_N] = inlink->frame_count_out,
426 geq->values[VAR_T] = in->pts == AV_NOPTS_VALUE ? NAN : in->pts * av_q2d(inlink->time_base),
429 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
432 return AVERROR(ENOMEM);
434 av_frame_copy_props(out, in);
436 for (plane = 0; plane < geq->planes && out->data[plane]; plane++) {
437 const int width = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(inlink->w, geq->hsub) : inlink->w;
438 const int height = (plane == 1 || plane == 2) ? AV_CEIL_RSHIFT(inlink->h, geq->vsub) : inlink->h;
439 const int linesize = out->linesize[plane];
442 geq->dst = out->data[plane];
443 geq->dst16 = (uint16_t*)out->data[plane];
445 geq->values[VAR_W] = width;
446 geq->values[VAR_H] = height;
447 geq->values[VAR_SW] = width / (double)inlink->w;
448 geq->values[VAR_SH] = height / (double)inlink->h;
453 td.linesize = linesize;
455 if (geq->needs_sum[plane])
456 calculate_sums(geq, plane, width, height);
458 ctx->internal->execute(ctx, slice_geq_filter, &td, NULL, FFMIN(height, nb_threads));
461 av_frame_free(&geq->picref);
462 return ff_filter_frame(outlink, out);
465 static av_cold void geq_uninit(AVFilterContext *ctx)
468 GEQContext *geq = ctx->priv;
470 for (i = 0; i < NB_PLANES; i++)
471 for (int j = 0; j < MAX_NB_THREADS; j++)
472 av_expr_free(geq->e[i][j]);
473 for (i = 0; i < NB_PLANES; i++)
474 av_freep(&geq->pixel_sums);
477 static const AVFilterPad geq_inputs[] = {
480 .type = AVMEDIA_TYPE_VIDEO,
481 .config_props = geq_config_props,
482 .filter_frame = geq_filter_frame,
487 static const AVFilterPad geq_outputs[] = {
490 .type = AVMEDIA_TYPE_VIDEO,
495 AVFilter ff_vf_geq = {
497 .description = NULL_IF_CONFIG_SMALL("Apply generic equation to each pixel."),
498 .priv_size = sizeof(GEQContext),
500 .uninit = geq_uninit,
501 .query_formats = geq_query_formats,
502 .inputs = geq_inputs,
503 .outputs = geq_outputs,
504 .priv_class = &geq_class,
505 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,