avfilter/vf_fftfilt: simplify bits/len calculation
[ffmpeg.git] / libavfilter / vf_fftfilt.c
1 /*
2  * Copyright (c) 2015 Arwa Arif <arwaarif1994@gmail.com>
3  * Copyright (c) 2017 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as published
9  * by the Free Software Foundation; either version 2.1 of the License,
10  * or (at your option) any later version.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * FFT domain filtering.
25  */
26
27 #include "libavfilter/internal.h"
28 #include "libavutil/common.h"
29 #include "libavutil/imgutils.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
32 #include "libavcodec/avfft.h"
33 #include "libavutil/eval.h"
34
35 #define MAX_PLANES 4
36
37 enum EvalMode {
38     EVAL_MODE_INIT,
39     EVAL_MODE_FRAME,
40     EVAL_MODE_NB
41 };
42
43 typedef struct FFTFILTContext {
44     const AVClass *class;
45
46     int eval_mode;
47     int depth;
48     int nb_planes;
49     int planewidth[MAX_PLANES];
50     int planeheight[MAX_PLANES];
51
52     RDFTContext *hrdft[MAX_PLANES];
53     RDFTContext *vrdft[MAX_PLANES];
54     RDFTContext *ihrdft[MAX_PLANES];
55     RDFTContext *ivrdft[MAX_PLANES];
56     int rdft_hbits[MAX_PLANES];
57     int rdft_vbits[MAX_PLANES];
58     size_t rdft_hlen[MAX_PLANES];
59     size_t rdft_vlen[MAX_PLANES];
60     FFTSample *rdft_hdata[MAX_PLANES];
61     FFTSample *rdft_vdata[MAX_PLANES];
62
63     int dc[MAX_PLANES];
64     char *weight_str[MAX_PLANES];
65     AVExpr *weight_expr[MAX_PLANES];
66     double *weight[MAX_PLANES];
67
68     void (*rdft_horizontal)(struct FFTFILTContext *s, AVFrame *in, int w, int h, int plane);
69     void (*irdft_horizontal)(struct FFTFILTContext *s, AVFrame *out, int w, int h, int plane);
70 } FFTFILTContext;
71
72 static const char *const var_names[] = {   "X",   "Y",   "W",   "H",   "N", NULL        };
73 enum                                   { VAR_X, VAR_Y, VAR_W, VAR_H, VAR_N, VAR_VARS_NB };
74
75 enum { Y = 0, U, V };
76
77 #define OFFSET(x) offsetof(FFTFILTContext, x)
78 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
79
80 static const AVOption fftfilt_options[] = {
81     { "dc_Y",  "adjust gain in Y plane",              OFFSET(dc[Y]),      AV_OPT_TYPE_INT,    {.i64 = 0},      0,     1000,     FLAGS },
82     { "dc_U",  "adjust gain in U plane",              OFFSET(dc[U]),      AV_OPT_TYPE_INT,    {.i64 = 0},      0,     1000,     FLAGS },
83     { "dc_V",  "adjust gain in V plane",              OFFSET(dc[V]),      AV_OPT_TYPE_INT,    {.i64 = 0},      0,     1000,     FLAGS },
84     { "weight_Y", "set luminance expression in Y plane",   OFFSET(weight_str[Y]), AV_OPT_TYPE_STRING, {.str = "1"}, 0, 0, FLAGS },
85     { "weight_U", "set chrominance expression in U plane", OFFSET(weight_str[U]), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
86     { "weight_V", "set chrominance expression in V plane", OFFSET(weight_str[V]), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
87     { "eval", "specify when to evaluate expressions", OFFSET(eval_mode), AV_OPT_TYPE_INT, {.i64 = EVAL_MODE_INIT}, 0, EVAL_MODE_NB-1, FLAGS, "eval" },
88          { "init",  "eval expressions once during initialization", 0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_INIT},  .flags = FLAGS, .unit = "eval" },
89          { "frame", "eval expressions per-frame",                  0, AV_OPT_TYPE_CONST, {.i64=EVAL_MODE_FRAME}, .flags = FLAGS, .unit = "eval" },
90     {NULL},
91 };
92
93 AVFILTER_DEFINE_CLASS(fftfilt);
94
95 static inline double lum(void *priv, double x, double y, int plane)
96 {
97     FFTFILTContext *s = priv;
98     return s->rdft_vdata[plane][(int)x * s->rdft_vlen[plane] + (int)y];
99 }
100
101 static double weight_Y(void *priv, double x, double y) { return lum(priv, x, y, Y); }
102 static double weight_U(void *priv, double x, double y) { return lum(priv, x, y, U); }
103 static double weight_V(void *priv, double x, double y) { return lum(priv, x, y, V); }
104
105 static void copy_rev (FFTSample *dest, int w, int w2)
106 {
107     int i;
108
109     for (i = w; i < w + (w2-w)/2; i++)
110         dest[i] = dest[2*w - i - 1];
111
112     for (; i < w2; i++)
113         dest[i] = dest[w2 - i];
114 }
115
116 /*Horizontal pass - RDFT*/
117 static void rdft_horizontal8(FFTFILTContext *s, AVFrame *in, int w, int h, int plane)
118 {
119     int i, j;
120
121     for (i = 0; i < h; i++) {
122         for (j = 0; j < w; j++)
123             s->rdft_hdata[plane][i * s->rdft_hlen[plane] + j] = *(in->data[plane] + in->linesize[plane] * i + j);
124
125         copy_rev(s->rdft_hdata[plane] + i * s->rdft_hlen[plane], w, s->rdft_hlen[plane]);
126     }
127
128     for (i = 0; i < h; i++)
129         av_rdft_calc(s->hrdft[plane], s->rdft_hdata[plane] + i * s->rdft_hlen[plane]);
130 }
131
132 static void rdft_horizontal16(FFTFILTContext *s, AVFrame *in, int w, int h, int plane)
133 {
134     const uint16_t *src = (const uint16_t *)in->data[plane];
135     int linesize = in->linesize[plane] / 2;
136     int i, j;
137
138     for (i = 0; i < h; i++) {
139         for (j = 0; j < w; j++)
140             s->rdft_hdata[plane][i * s->rdft_hlen[plane] + j] = *(src + linesize * i + j);
141
142         copy_rev(s->rdft_hdata[plane] + i * s->rdft_hlen[plane], w, s->rdft_hlen[plane]);
143     }
144
145     for (i = 0; i < h; i++)
146         av_rdft_calc(s->hrdft[plane], s->rdft_hdata[plane] + i * s->rdft_hlen[plane]);
147 }
148
149 /*Vertical pass - RDFT*/
150 static void rdft_vertical(FFTFILTContext *s, int h, int plane)
151 {
152     int i, j;
153
154     for (i = 0; i < s->rdft_hlen[plane]; i++) {
155         for (j = 0; j < h; j++)
156             s->rdft_vdata[plane][i * s->rdft_vlen[plane] + j] =
157             s->rdft_hdata[plane][j * s->rdft_hlen[plane] + i];
158         copy_rev(s->rdft_vdata[plane] + i * s->rdft_vlen[plane], h, s->rdft_vlen[plane]);
159     }
160
161     for (i = 0; i < s->rdft_hlen[plane]; i++)
162         av_rdft_calc(s->vrdft[plane], s->rdft_vdata[plane] + i * s->rdft_vlen[plane]);
163 }
164 /*Vertical pass - IRDFT*/
165 static void irdft_vertical(FFTFILTContext *s, int h, int plane)
166 {
167     int i, j;
168
169     for (i = 0; i < s->rdft_hlen[plane]; i++)
170         av_rdft_calc(s->ivrdft[plane], s->rdft_vdata[plane] + i * s->rdft_vlen[plane]);
171
172     for (i = 0; i < s->rdft_hlen[plane]; i++)
173         for (j = 0; j < h; j++)
174             s->rdft_hdata[plane][j * s->rdft_hlen[plane] + i] =
175             s->rdft_vdata[plane][i * s->rdft_vlen[plane] + j];
176 }
177
178 /*Horizontal pass - IRDFT*/
179 static void irdft_horizontal8(FFTFILTContext *s, AVFrame *out, int w, int h, int plane)
180 {
181     int i, j;
182
183     for (i = 0; i < h; i++)
184         av_rdft_calc(s->ihrdft[plane], s->rdft_hdata[plane] + i * s->rdft_hlen[plane]);
185
186     for (i = 0; i < h; i++)
187         for (j = 0; j < w; j++)
188             *(out->data[plane] + out->linesize[plane] * i + j) = av_clip(s->rdft_hdata[plane][i
189                                                                          *s->rdft_hlen[plane] + j] * 4 /
190                                                                          (s->rdft_hlen[plane] *
191                                                                           s->rdft_vlen[plane]), 0, 255);
192 }
193
194 static void irdft_horizontal16(FFTFILTContext *s, AVFrame *out, int w, int h, int plane)
195 {
196     uint16_t *dst = (uint16_t *)out->data[plane];
197     int linesize = out->linesize[plane] / 2;
198     int max = (1 << s->depth) - 1;
199     int i, j;
200
201     for (i = 0; i < h; i++)
202         av_rdft_calc(s->ihrdft[plane], s->rdft_hdata[plane] + i * s->rdft_hlen[plane]);
203
204     for (i = 0; i < h; i++)
205         for (j = 0; j < w; j++)
206             *(dst + linesize * i + j) = av_clip(s->rdft_hdata[plane][i
207                                                 *s->rdft_hlen[plane] + j] * 4 /
208                                                 (s->rdft_hlen[plane] *
209                                                 s->rdft_vlen[plane]), 0, max);
210 }
211
212 static av_cold int initialize(AVFilterContext *ctx)
213 {
214     FFTFILTContext *s = ctx->priv;
215     int ret = 0, plane;
216
217     if (!s->dc[U] && !s->dc[V]) {
218         s->dc[U] = s->dc[Y];
219         s->dc[V] = s->dc[Y];
220     } else {
221         if (!s->dc[U]) s->dc[U] = s->dc[V];
222         if (!s->dc[V]) s->dc[V] = s->dc[U];
223     }
224
225     if (!s->weight_str[U] && !s->weight_str[V]) {
226         s->weight_str[U] = av_strdup(s->weight_str[Y]);
227         s->weight_str[V] = av_strdup(s->weight_str[Y]);
228     } else {
229         if (!s->weight_str[U]) s->weight_str[U] = av_strdup(s->weight_str[V]);
230         if (!s->weight_str[V]) s->weight_str[V] = av_strdup(s->weight_str[U]);
231     }
232
233     for (plane = 0; plane < 3; plane++) {
234         static double (*p[])(void *, double, double) = { weight_Y, weight_U, weight_V };
235         const char *const func2_names[] = {"weight_Y", "weight_U", "weight_V", NULL };
236         double (*func2[])(void *, double, double) = { weight_Y, weight_U, weight_V, p[plane], NULL };
237
238         ret = av_expr_parse(&s->weight_expr[plane], s->weight_str[plane], var_names,
239                             NULL, NULL, func2_names, func2, 0, ctx);
240         if (ret < 0)
241             break;
242     }
243     return ret;
244 }
245
246 static void do_eval(FFTFILTContext *s, AVFilterLink *inlink, int plane)
247 {
248     double values[VAR_VARS_NB];
249     int i, j;
250
251     values[VAR_N] = inlink->frame_count_out;
252     values[VAR_W] = s->planewidth[plane];
253     values[VAR_H] = s->planeheight[plane];
254
255     for (i = 0; i < s->rdft_hlen[plane]; i++) {
256         values[VAR_X] = i;
257         for (j = 0; j < s->rdft_vlen[plane]; j++) {
258             values[VAR_Y] = j;
259             s->weight[plane][i * s->rdft_vlen[plane] + j] =
260             av_expr_eval(s->weight_expr[plane], values, s);
261         }
262     }
263 }
264
265 static int config_props(AVFilterLink *inlink)
266 {
267     FFTFILTContext *s = inlink->dst->priv;
268     const AVPixFmtDescriptor *desc;
269     int i, plane;
270
271     desc = av_pix_fmt_desc_get(inlink->format);
272     s->depth = desc->comp[0].depth;
273     s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
274     s->planewidth[0] = s->planewidth[3] = inlink->w;
275     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
276     s->planeheight[0] = s->planeheight[3] = inlink->h;
277
278     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
279
280     for (i = 0; i < desc->nb_components; i++) {
281         int w = s->planewidth[i];
282         int h = s->planeheight[i];
283
284         /* RDFT - Array initialization for Horizontal pass*/
285         s->rdft_hlen[i] = 1 << (32 - ff_clz(w));
286         s->rdft_hbits[i] = av_log2(s->rdft_hlen[i]);
287         if (!(s->rdft_hdata[i] = av_malloc_array(h, s->rdft_hlen[i] * sizeof(FFTSample))))
288             return AVERROR(ENOMEM);
289
290         if (!(s->hrdft[i] = av_rdft_init(s->rdft_hbits[i], DFT_R2C)))
291             return AVERROR(ENOMEM);
292         if (!(s->ihrdft[i] = av_rdft_init(s->rdft_hbits[i], IDFT_C2R)))
293             return AVERROR(ENOMEM);
294
295         /* RDFT - Array initialization for Vertical pass*/
296         s->rdft_vlen[i] = 1 << (32 - ff_clz(h));
297         s->rdft_vbits[i] = av_log2(s->rdft_vlen[i]);
298         if (!(s->rdft_vdata[i] = av_malloc_array(s->rdft_hlen[i], s->rdft_vlen[i] * sizeof(FFTSample))))
299             return AVERROR(ENOMEM);
300
301         if (!(s->vrdft[i] = av_rdft_init(s->rdft_vbits[i], DFT_R2C)))
302             return AVERROR(ENOMEM);
303         if (!(s->ivrdft[i] = av_rdft_init(s->rdft_vbits[i], IDFT_C2R)))
304             return AVERROR(ENOMEM);
305     }
306
307     /*Luminance value - Array initialization*/
308     for (plane = 0; plane < 3; plane++) {
309         if(!(s->weight[plane] = av_malloc_array(s->rdft_hlen[plane], s->rdft_vlen[plane] * sizeof(double))))
310             return AVERROR(ENOMEM);
311
312         if (s->eval_mode == EVAL_MODE_INIT)
313             do_eval(s, inlink, plane);
314     }
315
316     if (s->depth <= 8) {
317         s->rdft_horizontal = rdft_horizontal8;
318         s->irdft_horizontal = irdft_horizontal8;
319     } else if (s->depth > 8) {
320         s->rdft_horizontal = rdft_horizontal16;
321         s->irdft_horizontal = irdft_horizontal16;
322     } else {
323         return AVERROR_BUG;
324     }
325     return 0;
326 }
327
328 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
329 {
330     AVFilterContext *ctx = inlink->dst;
331     AVFilterLink *outlink = inlink->dst->outputs[0];
332     FFTFILTContext *s = ctx->priv;
333     AVFrame *out;
334     int i, j, plane;
335
336     out = ff_get_video_buffer(outlink, inlink->w, inlink->h);
337     if (!out) {
338         av_frame_free(&in);
339         return AVERROR(ENOMEM);
340     }
341
342     av_frame_copy_props(out, in);
343
344     for (plane = 0; plane < s->nb_planes; plane++) {
345         int w = s->planewidth[plane];
346         int h = s->planeheight[plane];
347
348         if (s->eval_mode == EVAL_MODE_FRAME)
349             do_eval(s, inlink, plane);
350
351         s->rdft_horizontal(s, in, w, h, plane);
352         rdft_vertical(s, h, plane);
353
354         /*Change user defined parameters*/
355         for (i = 0; i < s->rdft_hlen[plane]; i++)
356             for (j = 0; j < s->rdft_vlen[plane]; j++)
357                 s->rdft_vdata[plane][i * s->rdft_vlen[plane] + j] *=
358                   s->weight[plane][i * s->rdft_vlen[plane] + j];
359
360         s->rdft_vdata[plane][0] += s->rdft_hlen[plane] * s->rdft_vlen[plane] * s->dc[plane];
361
362         irdft_vertical(s, h, plane);
363         s->irdft_horizontal(s, out, w, h, plane);
364     }
365
366     av_frame_free(&in);
367     return ff_filter_frame(outlink, out);
368 }
369
370 static av_cold void uninit(AVFilterContext *ctx)
371 {
372     FFTFILTContext *s = ctx->priv;
373     int i;
374     for (i = 0; i < MAX_PLANES; i++) {
375         av_free(s->rdft_hdata[i]);
376         av_free(s->rdft_vdata[i]);
377         av_expr_free(s->weight_expr[i]);
378         av_free(s->weight[i]);
379         av_rdft_end(s->hrdft[i]);
380         av_rdft_end(s->ihrdft[i]);
381         av_rdft_end(s->vrdft[i]);
382         av_rdft_end(s->ivrdft[i]);
383     }
384 }
385
386 static const enum AVPixelFormat pixel_fmts_fftfilt[] = {
387     AV_PIX_FMT_GRAY8,
388     AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
389     AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P,
390     AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P,
391     AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV420P10,
392     AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV420P14,
393     AV_PIX_FMT_YUV420P16,
394     AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV422P10,
395     AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV422P14,
396     AV_PIX_FMT_YUV422P16,
397     AV_PIX_FMT_YUV444P9, AV_PIX_FMT_YUV444P10,
398     AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV444P14,
399     AV_PIX_FMT_YUV444P16,
400     AV_PIX_FMT_NONE
401 };
402
403 static const AVFilterPad fftfilt_inputs[] = {
404     {
405         .name = "default",
406         .type = AVMEDIA_TYPE_VIDEO,
407         .config_props = config_props,
408         .filter_frame = filter_frame,
409     },
410 };
411
412 static const AVFilterPad fftfilt_outputs[] = {
413     {
414         .name = "default",
415         .type = AVMEDIA_TYPE_VIDEO,
416     },
417 };
418
419 const AVFilter ff_vf_fftfilt = {
420     .name            = "fftfilt",
421     .description     = NULL_IF_CONFIG_SMALL("Apply arbitrary expressions to pixels in frequency domain."),
422     .priv_size       = sizeof(FFTFILTContext),
423     .priv_class      = &fftfilt_class,
424     FILTER_INPUTS(fftfilt_inputs),
425     FILTER_OUTPUTS(fftfilt_outputs),
426     FILTER_PIXFMTS_ARRAY(pixel_fmts_fftfilt),
427     .init            = initialize,
428     .uninit          = uninit,
429     .flags           = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
430 };