libavfilter/vf_hqdn3d.c
a4dc7aa5
 /*
  * Copyright (c) 2003 Daniel Moreno <comac AT comac DOT darktech DOT org>
  * Copyright (c) 2010 Baptiste Coudurier
85e228c7
  * Copyright (c) 2012 Loren Merritt
a4dc7aa5
  *
  * This file is part of FFmpeg, ported from MPlayer.
  *
  * FFmpeg is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License along
  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 /**
  * @file
  * high quality 3d video denoiser, ported from MPlayer
  * libmpcodecs/vf_hqdn3d.c.
  */
 
1d9c2dc8
 #include "libavutil/common.h"
a4dc7aa5
 #include "libavutil/pixdesc.h"
1ad715db
 #include "libavutil/intreadwrite.h"
a4dc7aa5
 #include "avfilter.h"
b74a1da4
 #include "formats.h"
9d0bfc50
 #include "internal.h"
803391f7
 #include "video.h"
a4dc7aa5
 
 typedef struct {
566858a7
     int16_t *coefs[4];
0f583e6c
     uint16_t *line;
60b97855
     uint16_t *frame_prev[3];
566858a7
     double strength[4];
a4dc7aa5
     int hsub, vsub;
1ad715db
     int depth;
7a1944b9
     void (*denoise_row[17])(uint8_t *src, uint8_t *dst, uint16_t *line_ant, uint16_t *frame_ant, ptrdiff_t w, int16_t *spatial, int16_t *temporal);
a4dc7aa5
 } HQDN3DContext;
 
7a1944b9
 void ff_hqdn3d_row_8_x86(uint8_t *src, uint8_t *dst, uint16_t *line_ant, uint16_t *frame_ant, ptrdiff_t w, int16_t *spatial, int16_t *temporal);
 void ff_hqdn3d_row_9_x86(uint8_t *src, uint8_t *dst, uint16_t *line_ant, uint16_t *frame_ant, ptrdiff_t w, int16_t *spatial, int16_t *temporal);
 void ff_hqdn3d_row_10_x86(uint8_t *src, uint8_t *dst, uint16_t *line_ant, uint16_t *frame_ant, ptrdiff_t w, int16_t *spatial, int16_t *temporal);
 void ff_hqdn3d_row_16_x86(uint8_t *src, uint8_t *dst, uint16_t *line_ant, uint16_t *frame_ant, ptrdiff_t w, int16_t *spatial, int16_t *temporal);
 
566858a7
 #define LUT_BITS (depth==16 ? 8 : 4)
1e7f825a
 #define LOAD(x) (((depth == 8 ? src[x] : AV_RN16A(src + (x) * 2)) << (16 - depth))\
                  + (((1 << (16 - depth)) - 1) >> 1))
 #define STORE(x,val) (depth == 8 ? dst[x] = (val) >> (16 - depth) : \
                                    AV_WN16A(dst + (x) * 2, (val) >> (16 - depth)))
1ad715db
 
566858a7
 av_always_inline
4f92d31a
 static uint32_t lowpass(int prev, int cur, int16_t *coef, int depth)
a4dc7aa5
 {
566858a7
     int d = (prev - cur) >> (8 - LUT_BITS);
60b97855
     return cur + coef[d];
a4dc7aa5
 }
 
1ad715db
 av_always_inline
60b97855
 static void denoise_temporal(uint8_t *src, uint8_t *dst,
                              uint16_t *frame_ant,
                              int w, int h, int sstride, int dstride,
1ad715db
                              int16_t *temporal, int depth)
a4dc7aa5
 {
60b97855
     long x, y;
85e228c7
     uint32_t tmp;
60b97855
 
566858a7
     temporal += 256 << LUT_BITS;
0f583e6c
 
60b97855
     for (y = 0; y < h; y++) {
         for (x = 0; x < w; x++) {
566858a7
             frame_ant[x] = tmp = lowpass(frame_ant[x], LOAD(x), temporal, depth);
1ad715db
             STORE(x, tmp);
a4dc7aa5
         }
60b97855
         src += sstride;
         dst += dstride;
         frame_ant += w;
a4dc7aa5
     }
 }
 
1ad715db
 av_always_inline
7a1944b9
 static void denoise_spatial(HQDN3DContext *hqdn3d,
                             uint8_t *src, uint8_t *dst,
0f583e6c
                             uint16_t *line_ant, uint16_t *frame_ant,
60b97855
                             int w, int h, int sstride, int dstride,
1ad715db
                             int16_t *spatial, int16_t *temporal, int depth)
a4dc7aa5
 {
60b97855
     long x, y;
     uint32_t pixel_ant;
85e228c7
     uint32_t tmp;
a4dc7aa5
 
566858a7
     spatial  += 256 << LUT_BITS;
     temporal += 256 << LUT_BITS;
0f583e6c
 
85e228c7
     /* First line has no top neighbor. Only left one for each tmp and
      * last frame */
1ad715db
     pixel_ant = LOAD(0);
85e228c7
     for (x = 0; x < w; x++) {
566858a7
         line_ant[x] = tmp = pixel_ant = lowpass(pixel_ant, LOAD(x), spatial, depth);
         frame_ant[x] = tmp = lowpass(frame_ant[x], tmp, temporal, depth);
1ad715db
         STORE(x, tmp);
a4dc7aa5
     }
 
60b97855
     for (y = 1; y < h; y++) {
85e228c7
         src += sstride;
         dst += dstride;
         frame_ant += w;
7a1944b9
         if (hqdn3d->denoise_row[depth]) {
             hqdn3d->denoise_row[depth](src, dst, line_ant, frame_ant, w, spatial, temporal);
             continue;
         }
1ad715db
         pixel_ant = LOAD(0);
85e228c7
         for (x = 0; x < w-1; x++) {
566858a7
             line_ant[x] = tmp = lowpass(line_ant[x], pixel_ant, spatial, depth);
             pixel_ant = lowpass(pixel_ant, LOAD(x+1), spatial, depth);
             frame_ant[x] = tmp = lowpass(frame_ant[x], tmp, temporal, depth);
1ad715db
             STORE(x, tmp);
a4dc7aa5
         }
566858a7
         line_ant[x] = tmp = lowpass(line_ant[x], pixel_ant, spatial, depth);
         frame_ant[x] = tmp = lowpass(frame_ant[x], tmp, temporal, depth);
1ad715db
         STORE(x, tmp);
a4dc7aa5
     }
 }
 
1ad715db
 av_always_inline
7a1944b9
 static void denoise_depth(HQDN3DContext *hqdn3d,
                           uint8_t *src, uint8_t *dst,
1ad715db
                           uint16_t *line_ant, uint16_t **frame_ant_ptr,
                           int w, int h, int sstride, int dstride,
                           int16_t *spatial, int16_t *temporal, int depth)
a4dc7aa5
 {
566858a7
     // FIXME: For 16bit depth, frame_ant could be a pointer to the previous
     // filtered frame rather than a separate buffer.
60b97855
     long x, y;
     uint16_t *frame_ant = *frame_ant_ptr;
     if (!frame_ant) {
85e228c7
         uint8_t *frame_src = src;
60b97855
         *frame_ant_ptr = frame_ant = av_malloc(w*h*sizeof(uint16_t));
85e228c7
         for (y = 0; y < h; y++, src += sstride, frame_ant += w)
60b97855
             for (x = 0; x < w; x++)
1ad715db
                 frame_ant[x] = LOAD(x);
85e228c7
         src = frame_src;
         frame_ant = *frame_ant_ptr;
a4dc7aa5
     }
 
85e228c7
     if (spatial[0])
7a1944b9
         denoise_spatial(hqdn3d, src, dst, line_ant, frame_ant,
1ad715db
                         w, h, sstride, dstride, spatial, temporal, depth);
85e228c7
     else
60b97855
         denoise_temporal(src, dst, frame_ant,
1ad715db
                          w, h, sstride, dstride, temporal, depth);
b1432e90
     emms_c();
a4dc7aa5
 }
 
1ad715db
 #define denoise(...) \
     switch (hqdn3d->depth) {\
         case  8: denoise_depth(__VA_ARGS__,  8); break;\
         case  9: denoise_depth(__VA_ARGS__,  9); break;\
         case 10: denoise_depth(__VA_ARGS__, 10); break;\
566858a7
         case 16: denoise_depth(__VA_ARGS__, 16); break;\
a4dc7aa5
     }
 
566858a7
 static int16_t *precalc_coefs(double dist25, int depth)
a4dc7aa5
 {
     int i;
60b97855
     double gamma, simil, C;
566858a7
     int16_t *ct = av_malloc((512<<LUT_BITS)*sizeof(int16_t));
     if (!ct)
         return NULL;
a4dc7aa5
 
0f583e6c
     gamma = log(0.25) / log(1.0 - FFMIN(dist25,252.0)/255.0 - 0.00001);
a4dc7aa5
 
566858a7
     for (i = -255<<LUT_BITS; i <= 255<<LUT_BITS; i++) {
         double f = ((i<<(9-LUT_BITS)) + (1<<(8-LUT_BITS)) - 1) / 512.0; // midpoint of the bin
0f583e6c
         simil = 1.0 - FFABS(f) / 255.0;
         C = pow(simil, gamma) * 256.0 * f;
566858a7
         ct[(256<<LUT_BITS)+i] = lrint(C);
a4dc7aa5
     }
 
60b97855
     ct[0] = !!dist25;
566858a7
     return ct;
a4dc7aa5
 }
 
 #define PARAM1_DEFAULT 4.0
 #define PARAM2_DEFAULT 3.0
 #define PARAM3_DEFAULT 6.0
 
a5e8c41c
 static int init(AVFilterContext *ctx, const char *args)
a4dc7aa5
 {
     HQDN3DContext *hqdn3d = ctx->priv;
60b97855
     double lum_spac, lum_tmp, chrom_spac, chrom_tmp;
     double param1, param2, param3, param4;
a4dc7aa5
 
60b97855
     lum_spac   = PARAM1_DEFAULT;
     chrom_spac = PARAM2_DEFAULT;
     lum_tmp    = PARAM3_DEFAULT;
     chrom_tmp  = lum_tmp * chrom_spac / lum_spac;
a4dc7aa5
 
     if (args) {
         switch (sscanf(args, "%lf:%lf:%lf:%lf",
60b97855
                        &param1, &param2, &param3, &param4)) {
a4dc7aa5
         case 1:
60b97855
             lum_spac   = param1;
             chrom_spac = PARAM2_DEFAULT * param1 / PARAM1_DEFAULT;
             lum_tmp    = PARAM3_DEFAULT * param1 / PARAM1_DEFAULT;
             chrom_tmp  = lum_tmp * chrom_spac / lum_spac;
a4dc7aa5
             break;
         case 2:
60b97855
             lum_spac   = param1;
             chrom_spac = param2;
             lum_tmp    = PARAM3_DEFAULT * param1 / PARAM1_DEFAULT;
             chrom_tmp  = lum_tmp * chrom_spac / lum_spac;
a4dc7aa5
             break;
         case 3:
60b97855
             lum_spac   = param1;
             chrom_spac = param2;
             lum_tmp    = param3;
             chrom_tmp  = lum_tmp * chrom_spac / lum_spac;
a4dc7aa5
             break;
         case 4:
60b97855
             lum_spac   = param1;
             chrom_spac = param2;
             lum_tmp    = param3;
             chrom_tmp  = param4;
a4dc7aa5
             break;
         }
     }
 
566858a7
     hqdn3d->strength[0] = lum_spac;
     hqdn3d->strength[1] = lum_tmp;
     hqdn3d->strength[2] = chrom_spac;
     hqdn3d->strength[3] = chrom_tmp;
 
bcb8d9eb
     av_log(ctx, AV_LOG_VERBOSE, "ls:%f cs:%f lt:%f ct:%f\n",
60b97855
            lum_spac, chrom_spac, lum_tmp, chrom_tmp);
     if (lum_spac < 0 || chrom_spac < 0 || isnan(chrom_tmp)) {
a4dc7aa5
         av_log(ctx, AV_LOG_ERROR,
                "Invalid negative value for luma or chroma spatial strength, "
                "or resulting value for chroma temporal strength is nan.\n");
         return AVERROR(EINVAL);
     }
 
     return 0;
 }
 
 static void uninit(AVFilterContext *ctx)
 {
     HQDN3DContext *hqdn3d = ctx->priv;
 
566858a7
     av_freep(&hqdn3d->coefs[0]);
     av_freep(&hqdn3d->coefs[1]);
     av_freep(&hqdn3d->coefs[2]);
     av_freep(&hqdn3d->coefs[3]);
60b97855
     av_freep(&hqdn3d->line);
     av_freep(&hqdn3d->frame_prev[0]);
     av_freep(&hqdn3d->frame_prev[1]);
     av_freep(&hqdn3d->frame_prev[2]);
a4dc7aa5
 }
 
 static int query_formats(AVFilterContext *ctx)
 {
716d413c
     static const enum AVPixelFormat pix_fmts[] = {
         AV_PIX_FMT_YUV420P,
         AV_PIX_FMT_YUV422P,
         AV_PIX_FMT_YUV444P,
         AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUV411P,
         AV_PIX_FMT_YUV440P,
         AV_PIX_FMT_YUVJ420P,
         AV_PIX_FMT_YUVJ422P,
         AV_PIX_FMT_YUVJ444P,
         AV_PIX_FMT_YUVJ440P,
         AV_NE( AV_PIX_FMT_YUV420P9BE, AV_PIX_FMT_YUV420P9LE ),
         AV_NE( AV_PIX_FMT_YUV422P9BE, AV_PIX_FMT_YUV422P9LE ),
         AV_NE( AV_PIX_FMT_YUV444P9BE, AV_PIX_FMT_YUV444P9LE ),
         AV_NE( AV_PIX_FMT_YUV420P10BE, AV_PIX_FMT_YUV420P10LE ),
         AV_NE( AV_PIX_FMT_YUV422P10BE, AV_PIX_FMT_YUV422P10LE ),
         AV_NE( AV_PIX_FMT_YUV444P10BE, AV_PIX_FMT_YUV444P10LE ),
         AV_NE( AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUV420P16LE ),
         AV_NE( AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUV422P16LE ),
         AV_NE( AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUV444P16LE ),
         AV_PIX_FMT_NONE
a4dc7aa5
     };
 
b74a1da4
     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
a4dc7aa5
 
     return 0;
 }
 
 static int config_input(AVFilterLink *inlink)
 {
     HQDN3DContext *hqdn3d = inlink->dst->priv;
59ee9f78
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
851bac4b
     int i;
a4dc7aa5
 
59ee9f78
     hqdn3d->hsub  = desc->log2_chroma_w;
     hqdn3d->vsub  = desc->log2_chroma_h;
     hqdn3d->depth = desc->comp[0].depth_minus1+1;
a4dc7aa5
 
60b97855
     hqdn3d->line = av_malloc(inlink->w * sizeof(*hqdn3d->line));
     if (!hqdn3d->line)
a4dc7aa5
         return AVERROR(ENOMEM);
 
2bd67175
     for (i = 0; i < 4; i++) {
566858a7
         hqdn3d->coefs[i] = precalc_coefs(hqdn3d->strength[i], hqdn3d->depth);
         if (!hqdn3d->coefs[i])
             return AVERROR(ENOMEM);
     }
 
7a1944b9
 #if HAVE_YASM
     hqdn3d->denoise_row[ 8] = ff_hqdn3d_row_8_x86;
     hqdn3d->denoise_row[ 9] = ff_hqdn3d_row_9_x86;
     hqdn3d->denoise_row[10] = ff_hqdn3d_row_10_x86;
     hqdn3d->denoise_row[16] = ff_hqdn3d_row_16_x86;
 #endif
 
a4dc7aa5
     return 0;
 }
 
1b43fc12
 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *in)
a4dc7aa5
 {
     HQDN3DContext *hqdn3d = inlink->dst->priv;
     AVFilterLink *outlink = inlink->dst->outputs[0];
1b43fc12
 
     AVFilterBufferRef *out;
565e4993
     int direct, c;
1b43fc12
 
ed547e2c
     if (in->perms & AV_PERM_WRITE) {
1b43fc12
         direct = 1;
         out = in;
     } else {
c5024108
         direct = 0;
1b43fc12
         out = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
         if (!out) {
             avfilter_unref_bufferp(&in);
             return AVERROR(ENOMEM);
         }
         avfilter_copy_buffer_ref_props(out, in);
     }
85e228c7
 
     for (c = 0; c < 3; c++) {
1b43fc12
         denoise(hqdn3d, in->data[c], out->data[c],
85e228c7
                 hqdn3d->line, &hqdn3d->frame_prev[c],
1b43fc12
                 in->video->w >> (!!c * hqdn3d->hsub),
                 in->video->h >> (!!c * hqdn3d->vsub),
                 in->linesize[c], out->linesize[c],
85e228c7
                 hqdn3d->coefs[c?2:0], hqdn3d->coefs[c?3:1]);
     }
a4dc7aa5
 
1b43fc12
     if (!direct)
         avfilter_unref_bufferp(&in);
 
     return ff_filter_frame(outlink, out);
a4dc7aa5
 }
 
568c70e7
 static const AVFilterPad avfilter_vf_hqdn3d_inputs[] = {
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .config_props = config_input,
1b43fc12
         .filter_frame = filter_frame,
568c70e7
     },
     { NULL }
 };
 
1b43fc12
 
568c70e7
 static const AVFilterPad avfilter_vf_hqdn3d_outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO
     },
     { NULL }
 };
 
a4dc7aa5
 AVFilter avfilter_vf_hqdn3d = {
     .name          = "hqdn3d",
     .description   = NULL_IF_CONFIG_SMALL("Apply a High Quality 3D Denoiser."),
 
     .priv_size     = sizeof(HQDN3DContext),
     .init          = init,
     .uninit        = uninit,
     .query_formats = query_formats,
 
568c70e7
     .inputs    = avfilter_vf_hqdn3d_inputs,
 
     .outputs   = avfilter_vf_hqdn3d_outputs,
a4dc7aa5
 };