]> git.sesse.net Git - ffmpeg/blob - libavfilter/vf_xmedian.c
avfilter/vf_xmedian: implement percentile option
[ffmpeg] / libavfilter / vf_xmedian.c
1 /*
2  * Copyright (c) 2019 Paul B Mahol
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 #include "libavutil/avstring.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/intreadwrite.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/pixdesc.h"
26 #include "libavutil/qsort.h"
27
28 #include "avfilter.h"
29 #include "formats.h"
30 #include "internal.h"
31 #include "framesync.h"
32 #include "video.h"
33
34 typedef struct XMedianContext {
35     const AVClass *class;
36     const AVPixFmtDescriptor *desc;
37     int nb_inputs;
38     int planes;
39     float percentile;
40
41     int radius;
42     int index;
43     int depth;
44     int max;
45     int nb_planes;
46     int linesize[4];
47     int width[4];
48     int height[4];
49
50     AVFrame **frames;
51     FFFrameSync fs;
52
53     int (*median_frames)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
54 } XMedianContext;
55
56 static int query_formats(AVFilterContext *ctx)
57 {
58     static const enum AVPixelFormat pixel_fmts[] = {
59         AV_PIX_FMT_GRAY8,
60         AV_PIX_FMT_GRAY9,
61         AV_PIX_FMT_GRAY10,
62         AV_PIX_FMT_GRAY12,
63         AV_PIX_FMT_GRAY14,
64         AV_PIX_FMT_GRAY16,
65         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
66         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P,
67         AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
68         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
69         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
70         AV_PIX_FMT_YUVJ411P,
71         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
72         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
73         AV_PIX_FMT_YUV440P10,
74         AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
75         AV_PIX_FMT_YUV440P12,
76         AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
77         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
78         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
79         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
80         AV_PIX_FMT_YUVA420P,  AV_PIX_FMT_YUVA422P,   AV_PIX_FMT_YUVA444P,
81         AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUVA444P12, AV_PIX_FMT_YUVA444P16,
82         AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA422P16,
83         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA420P16,
84         AV_PIX_FMT_GBRAP,     AV_PIX_FMT_GBRAP10,    AV_PIX_FMT_GBRAP12,    AV_PIX_FMT_GBRAP16,
85         AV_PIX_FMT_NONE
86     };
87     AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
88     if (!formats)
89         return AVERROR(ENOMEM);
90     return ff_set_common_formats(ctx, formats);
91 }
92
93 static av_cold int init(AVFilterContext *ctx)
94 {
95     XMedianContext *s = ctx->priv;
96     int ret;
97
98     s->radius = s->nb_inputs / 2;
99     if (s->nb_inputs & 1)
100         s->index = s->radius * 2.f * s->percentile;
101     else
102         s->index = av_clip(s->radius * 2.f * s->percentile, 1, s->nb_inputs - 1);
103     s->frames = av_calloc(s->nb_inputs, sizeof(*s->frames));
104     if (!s->frames)
105         return AVERROR(ENOMEM);
106
107     for (int i = 0; i < s->nb_inputs; i++) {
108         AVFilterPad pad = { 0 };
109
110         pad.type = AVMEDIA_TYPE_VIDEO;
111         pad.name = av_asprintf("input%d", i);
112         if (!pad.name)
113             return AVERROR(ENOMEM);
114
115         if ((ret = ff_insert_inpad(ctx, i, &pad)) < 0) {
116             av_freep(&pad.name);
117             return ret;
118         }
119     }
120
121     return 0;
122 }
123
124 typedef struct ThreadData {
125     AVFrame **in, *out;
126 } ThreadData;
127
128 static int comparei(const void *p1, const void *p2)
129 {
130     int left  = *(const int *)p1;
131     int right = *(const int *)p2;
132     return FFDIFFSIGN(left, right);
133 }
134
135 static int median_frames16(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
136 {
137     XMedianContext *s = ctx->priv;
138     ThreadData *td = arg;
139     AVFrame **in = td->in;
140     AVFrame *out = td->out;
141     const int nb_inputs = s->nb_inputs;
142     const int radius = s->radius;
143     const int index = s->index;
144     int values[256];
145
146     for (int p = 0; p < s->nb_planes; p++) {
147         const int slice_start = (s->height[p] * jobnr) / nb_jobs;
148         const int slice_end = (s->height[p] * (jobnr+1)) / nb_jobs;
149         uint16_t *dst = (uint16_t *)(out->data[p] + slice_start * out->linesize[p]);
150
151         if (!((1 << p) & s->planes)) {
152             av_image_copy_plane((uint8_t *)dst, out->linesize[p],
153                                 in[radius]->data[p] + slice_start * in[radius]->linesize[p],
154                                 in[radius]->linesize[p],
155                                 s->linesize[p], slice_end - slice_start);
156             continue;
157         }
158
159         for (int y = slice_start; y < slice_end; y++) {
160             for (int x = 0; x < s->width[p]; x++) {
161                 for (int i = 0; i < nb_inputs; i++) {
162                     const uint16_t *src = (const uint16_t *)(in[i]->data[p] + y * in[i]->linesize[p]);
163                     values[i] = src[x];
164                 }
165
166                 AV_QSORT(values, nb_inputs, int, comparei);
167                 if (nb_inputs & 1)
168                     dst[x] = values[index];
169                 else
170                     dst[x] = (values[index] + values[index - 1]) >> 1;
171             }
172
173             dst += out->linesize[p] / 2;
174         }
175     }
176
177     return 0;
178 }
179
180 static int median_frames8(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
181 {
182     XMedianContext *s = ctx->priv;
183     ThreadData *td = arg;
184     AVFrame **in = td->in;
185     AVFrame *out = td->out;
186     const int nb_inputs = s->nb_inputs;
187     const int radius = s->radius;
188     const int index = s->index;
189     int values[256];
190
191     for (int p = 0; p < s->nb_planes; p++) {
192         const int slice_start = (s->height[p] * jobnr) / nb_jobs;
193         const int slice_end = (s->height[p] * (jobnr+1)) / nb_jobs;
194         uint8_t *dst = out->data[p] + slice_start * out->linesize[p];
195
196         if (!((1 << p) & s->planes)) {
197             av_image_copy_plane(dst, out->linesize[p],
198                                 in[radius]->data[p] + slice_start * in[radius]->linesize[p],
199                                 in[radius]->linesize[p],
200                                 s->linesize[p], slice_end - slice_start);
201             continue;
202         }
203
204         for (int y = slice_start; y < slice_end; y++) {
205             for (int x = 0; x < s->width[p]; x++) {
206                 for (int i = 0; i < nb_inputs; i++)
207                     values[i] = in[i]->data[p][y * in[i]->linesize[p] + x];
208
209                 AV_QSORT(values, nb_inputs, int, comparei);
210                 if (nb_inputs & 1)
211                     dst[x] = values[index];
212                 else
213                     dst[x] = (values[index] + values[index - 1]) >> 1;
214             }
215
216             dst += out->linesize[p];
217         }
218     }
219
220     return 0;
221 }
222
223 static int process_frame(FFFrameSync *fs)
224 {
225     AVFilterContext *ctx = fs->parent;
226     AVFilterLink *outlink = ctx->outputs[0];
227     XMedianContext *s = fs->opaque;
228     AVFrame **in = s->frames;
229     AVFrame *out;
230     ThreadData td;
231     int i, ret;
232
233     for (i = 0; i < s->nb_inputs; i++) {
234         if ((ret = ff_framesync_get_frame(&s->fs, i, &in[i], 0)) < 0)
235             return ret;
236     }
237
238     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
239     if (!out)
240         return AVERROR(ENOMEM);
241     out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
242
243     td.in = in;
244     td.out = out;
245     ctx->internal->execute(ctx, s->median_frames, &td, NULL, FFMIN(s->height[1], ff_filter_get_nb_threads(ctx)));
246
247     return ff_filter_frame(outlink, out);
248 }
249
250 static int config_output(AVFilterLink *outlink)
251 {
252     AVFilterContext *ctx = outlink->src;
253     XMedianContext *s = ctx->priv;
254     AVRational frame_rate = ctx->inputs[0]->frame_rate;
255     AVRational sar = ctx->inputs[0]->sample_aspect_ratio;
256     AVFilterLink *inlink = ctx->inputs[0];
257     int height = ctx->inputs[0]->h;
258     int width = ctx->inputs[0]->w;
259     FFFrameSyncIn *in;
260     int i, ret;
261
262     for (int i = 1; i < s->nb_inputs; i++) {
263         if (ctx->inputs[i]->h != height || ctx->inputs[i]->w != width) {
264             av_log(ctx, AV_LOG_ERROR, "Input %d size (%dx%d) does not match input %d size (%dx%d).\n", i, ctx->inputs[i]->w, ctx->inputs[i]->h, 0, width, height);
265             return AVERROR(EINVAL);
266         }
267     }
268
269     s->desc = av_pix_fmt_desc_get(outlink->format);
270     if (!s->desc)
271         return AVERROR_BUG;
272     s->nb_planes = av_pix_fmt_count_planes(outlink->format);
273     s->depth = s->desc->comp[0].depth;
274     s->max = (1 << s->depth) - 1;
275
276     if (s->depth <= 8)
277         s->median_frames = median_frames8;
278     else
279         s->median_frames = median_frames16;
280
281     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
282         return ret;
283
284     s->width[1] = s->width[2] = AV_CEIL_RSHIFT(inlink->w, s->desc->log2_chroma_w);
285     s->width[0] = s->width[3] = inlink->w;
286     s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, s->desc->log2_chroma_h);
287     s->height[0] = s->height[3] = inlink->h;
288
289     outlink->w          = width;
290     outlink->h          = height;
291     outlink->frame_rate = frame_rate;
292     outlink->sample_aspect_ratio = sar;
293
294     if ((ret = ff_framesync_init(&s->fs, ctx, s->nb_inputs)) < 0)
295         return ret;
296
297     in = s->fs.in;
298     s->fs.opaque = s;
299     s->fs.on_event = process_frame;
300
301     for (i = 0; i < s->nb_inputs; i++) {
302         AVFilterLink *inlink = ctx->inputs[i];
303
304         in[i].time_base = inlink->time_base;
305         in[i].sync   = 1;
306         in[i].before = EXT_STOP;
307         in[i].after  = EXT_STOP;
308     }
309
310     ret = ff_framesync_configure(&s->fs);
311     outlink->time_base = s->fs.time_base;
312
313     return ret;
314 }
315
316 static av_cold void uninit(AVFilterContext *ctx)
317 {
318     XMedianContext *s = ctx->priv;
319
320     ff_framesync_uninit(&s->fs);
321     av_freep(&s->frames);
322
323     for (int i = 0; i < ctx->nb_inputs; i++)
324         av_freep(&ctx->input_pads[i].name);
325 }
326
327 static int activate(AVFilterContext *ctx)
328 {
329     XMedianContext *s = ctx->priv;
330     return ff_framesync_activate(&s->fs);
331 }
332
333 #define OFFSET(x) offsetof(XMedianContext, x)
334 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
335
336 static const AVOption xmedian_options[] = {
337     { "inputs", "set number of inputs", OFFSET(nb_inputs), AV_OPT_TYPE_INT, {.i64=3},  3, 255, .flags = FLAGS },
338     { "planes", "set planes to filter", OFFSET(planes),    AV_OPT_TYPE_INT, {.i64=15}, 0,  15, .flags = FLAGS },
339     { "percentile", "set percentile",   OFFSET(percentile),AV_OPT_TYPE_FLOAT,{.dbl=0.5}, 0, 1, .flags = FLAGS },
340     { NULL },
341 };
342
343 static const AVFilterPad outputs[] = {
344     {
345         .name          = "default",
346         .type          = AVMEDIA_TYPE_VIDEO,
347         .config_props  = config_output,
348     },
349     { NULL }
350 };
351
352 AVFILTER_DEFINE_CLASS(xmedian);
353
354 AVFilter ff_vf_xmedian = {
355     .name          = "xmedian",
356     .description   = NULL_IF_CONFIG_SMALL("Pick median pixels from several video inputs."),
357     .priv_size     = sizeof(XMedianContext),
358     .priv_class    = &xmedian_class,
359     .query_formats = query_formats,
360     .outputs       = outputs,
361     .init          = init,
362     .uninit        = uninit,
363     .activate      = activate,
364     .flags         = AVFILTER_FLAG_DYNAMIC_INPUTS | AVFILTER_FLAG_SLICE_THREADS,
365 };