git.sesse.net Git - ffmpeg/blob - libavfilter/vf_median.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  * Redistribution and use in source and binary forms, with or without modification,
  20  * are permitted provided that the following conditions are met:
  21  */
  22
  23 #include "libavutil/avassert.h"
  24 #include "libavutil/imgutils.h"
  25 #include "libavutil/opt.h"
  26 #include "libavutil/pixdesc.h"
  27 #include "avfilter.h"
  28 #include "formats.h"
  29 #include "internal.h"
  30 #include "median.h"
  31 #include "video.h"
  32
  33 #define DEPTH 8
  34 #include "median_template.c"
  35
  36 #undef DEPTH
  37 #define DEPTH 9
  38 #include "median_template.c"
  39
  40 #undef DEPTH
  41 #define DEPTH 10
  42 #include "median_template.c"
  43
  44 #undef DEPTH
  45 #define DEPTH 12
  46 #include "median_template.c"
  47
  48 #undef DEPTH
  49 #define DEPTH 14
  50 #include "median_template.c"
  51
  52 #undef DEPTH
  53 #define DEPTH 16
  54 #include "median_template.c"
  55
  56 #define OFFSET(x) offsetof(MedianContext, x)
  57 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
  58
  59 static const AVOption median_options[] = {
  60     { "radius", "set median radius",    OFFSET(radius), AV_OPT_TYPE_INT,   {.i64=1},     1,  127, FLAGS },
  61     { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT,   {.i64=0xF},   0,  0xF, FLAGS },
  62     { "radiusV", "set median vertical radius", OFFSET(radiusV), AV_OPT_TYPE_INT, {.i64=0},0, 127, FLAGS },
  63     { NULL }
  64 };
  65
  66 AVFILTER_DEFINE_CLASS(median);
  67
  68 static void hadd(htype *dst, const htype *src, int bins)
  69 {
  70     for (int i = 0; i < bins; i++)
  71         dst[i] += src[i];
  72 }
  73
  74 static void hsub(htype *dst, const htype *src, int bins)
  75 {
  76     for (int i = 0; i < bins; i++)
  77         dst[i] -= src[i];
  78 }
  79
  80 static void hmuladd(htype *dst, const htype *src, int f, int bins)
  81 {
  82     for (int i = 0; i < bins; i++)
  83         dst[i] += f * src[i];
  84 }
  85
  86 static int query_formats(AVFilterContext *ctx)
  87 {
  88     static const enum AVPixelFormat pix_fmts[] = {
  89         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
  90         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
  91         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
  92         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
  93         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
  94         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9,
  95         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, AV_PIX_FMT_GBRP9,
  96         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
  97         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
  98         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
  99         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
 100         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
 101         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
 102         AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
 103         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
 104         AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
 105         AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
 106         AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
 107         AV_PIX_FMT_NONE
 108     };
 109
 110     return ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 111 }
 112
 113 static void check_params(MedianContext *s, AVFilterLink *inlink)
 114 {
 115     for (int i = 0; i < s->nb_planes; i++) {
 116         if (!(s->planes & (1 << i)))
 117             continue;
 118
 119         if (s->planewidth[i] < s->radius * 2 + 1) {
 120             av_log(inlink->dst, AV_LOG_WARNING, "The %d plane width %d must be not less than %d, clipping radius.\n", i, s->planewidth[i], s->radius * 2 + 1);
 121             s->radius = (s->planewidth[i] - 1) / 2;
 122         }
 123
 124         if (s->planeheight[i] < s->radiusV * 2 + 1) {
 125             av_log(inlink->dst, AV_LOG_WARNING, "The %d plane height %d must be not less than %d, clipping radiusV.\n", i, s->planeheight[i], s->radiusV * 2 + 1);
 126             s->radiusV = (s->planeheight[i] - 1) / 2;
 127         }
 128     }
 129
 130     s->t = 2 * s->radius * s->radiusV + 2 * s->radius;
 131 }
 132
 133 static int config_input(AVFilterLink *inlink)
 134 {
 135     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 136     MedianContext *s = inlink->dst->priv;
 137
 138     s->depth = desc->comp[0].depth;
 139     s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
 140     s->planewidth[0] = s->planewidth[3] = inlink->w;
 141     s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
 142     s->planeheight[0] = s->planeheight[3] = inlink->h;
 143
 144     s->radiusV = !s->radiusV ? s->radius : s->radiusV;
 145     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
 146
 147     check_params(s, inlink);
 148
 149     s->nb_threads = FFMAX(1, FFMIN(s->planeheight[1] / (s->radiusV + 1), ff_filter_get_nb_threads(inlink->dst)));
 150     s->bins   = 1 << ((s->depth + 1) / 2);
 151     s->fine_size = s->bins * s->bins * inlink->w;
 152     s->coarse_size = s->bins * inlink->w;
 153     s->coarse = av_calloc(s->nb_threads, sizeof(*s->coarse));
 154     s->fine   = av_calloc(s->nb_threads, sizeof(*s->fine));
 155     if (!s->coarse || !s->fine)
 156         return AVERROR(ENOMEM);
 157     for (int i = 0; i < s->nb_threads; i++) {
 158         s->coarse[i] = av_malloc_array(s->coarse_size, sizeof(**s->coarse));
 159         s->fine[i]   = av_malloc_array(s->fine_size, sizeof(**s->fine));
 160         if (!s->coarse[i] || !s->fine[i])
 161             return AVERROR(ENOMEM);
 162     }
 163
 164     s->hadd = hadd;
 165     s->hsub = hsub;
 166     s->hmuladd = hmuladd;
 167
 168     switch (s->depth) {
 169     case  8: s->filter_plane = filter_plane_8;  break;
 170     case  9: s->filter_plane = filter_plane_9;  break;
 171     case 10: s->filter_plane = filter_plane_10; break;
 172     case 12: s->filter_plane = filter_plane_12; break;
 173     case 14: s->filter_plane = filter_plane_14; break;
 174     case 16: s->filter_plane = filter_plane_16; break;
 175     }
 176
 177     return 0;
 178 }
 179
 180 typedef struct ThreadData {
 181     AVFrame *in, *out;
 182 } ThreadData;
 183
 184 static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
 185 {
 186     MedianContext *s = ctx->priv;
 187     ThreadData *td = arg;
 188     AVFrame *in = td->in;
 189     AVFrame *out = td->out;
 190
 191     for (int plane = 0; plane < s->nb_planes; plane++) {
 192         const int h = s->planeheight[plane];
 193         const int w = s->planewidth[plane];
 194         const int slice_h_start = (h * jobnr) / nb_jobs;
 195         const int slice_h_end = (h * (jobnr+1)) / nb_jobs;
 196
 197         if (!(s->planes & (1 << plane))) {
 198             av_image_copy_plane(out->data[plane] + slice_h_start * out->linesize[plane],
 199                                 out->linesize[plane],
 200                                 in->data[plane] + slice_h_start * in->linesize[plane],
 201                                 in->linesize[plane],
 202                                 w * ((s->depth + 7) / 8),
 203                                 slice_h_end - slice_h_start);
 204             continue;
 205         }
 206
 207         s->filter_plane(ctx, in->data[plane],
 208                         in->linesize[plane],
 209                         out->data[plane] + slice_h_start * out->linesize[plane],
 210                         out->linesize[plane], w, h,
 211                         slice_h_start, slice_h_end, jobnr);
 212     }
 213
 214     return 0;
 215 }
 216
 217 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 218 {
 219     AVFilterContext *ctx = inlink->dst;
 220     MedianContext *s = ctx->priv;
 221     AVFilterLink *outlink = ctx->outputs[0];
 222     ThreadData td;
 223     AVFrame *out;
 224
 225     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 226     if (!out) {
 227         av_frame_free(&in);
 228         return AVERROR(ENOMEM);
 229     }
 230     av_frame_copy_props(out, in);
 231
 232     td.in = in; td.out = out;
 233     ctx->internal->execute(ctx, filter_slice, &td, NULL, s->nb_threads);
 234
 235     av_frame_free(&in);
 236     return ff_filter_frame(outlink, out);
 237 }
 238
 239 static av_cold void uninit(AVFilterContext *ctx)
 240 {
 241     MedianContext *s = ctx->priv;
 242
 243     for (int i = 0; i < s->nb_threads && s->coarse && s->fine; i++) {
 244         av_freep(&s->coarse[i]);
 245         av_freep(&s->fine[i]);
 246     }
 247
 248     av_freep(&s->coarse);
 249     av_freep(&s->fine);
 250 }
 251
 252 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
 253                            char *res, int res_len, int flags)
 254 {
 255     MedianContext *s = ctx->priv;
 256     int ret;
 257
 258     ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
 259     if (ret < 0)
 260         return ret;
 261
 262     if (!s->radiusV)
 263         s->radiusV = s->radius;
 264     check_params(s, ctx->inputs[0]);
 265
 266     return 0;
 267 }
 268
 269 static const AVFilterPad median_inputs[] = {
 270     {
 271         .name         = "default",
 272         .type         = AVMEDIA_TYPE_VIDEO,
 273         .config_props = config_input,
 274         .filter_frame = filter_frame,
 275     },
 276     { NULL }
 277 };
 278
 279 static const AVFilterPad median_outputs[] = {
 280     {
 281         .name = "default",
 282         .type = AVMEDIA_TYPE_VIDEO,
 283     },
 284     { NULL }
 285 };
 286
 287 AVFilter ff_vf_median = {
 288     .name          = "median",
 289     .description   = NULL_IF_CONFIG_SMALL("Apply Median filter."),
 290     .priv_size     = sizeof(MedianContext),
 291     .priv_class    = &median_class,
 292     .uninit        = uninit,
 293     .query_formats = query_formats,
 294     .inputs        = median_inputs,
 295     .outputs       = median_outputs,
 296     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
 297     .process_command = process_command,
 298 };