FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_hqdn3d.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2003 Daniel Moreno <comac AT comac DOT darktech DOT org>
3  * Copyright (c) 2010 Baptiste Coudurier
4  * Copyright (c) 2012 Loren Merritt
5  *
6  * This file is part of FFmpeg, ported from MPlayer.
7  *
8  * FFmpeg is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22 
23 /**
24  * @file
25  * high quality 3d video denoiser, ported from MPlayer
26  * libmpcodecs/vf_hqdn3d.c.
27  */
28 
29 #include <float.h>
30 
31 #include "config.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/common.h"
34 #include "libavutil/pixdesc.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/opt.h"
37 
38 #include "avfilter.h"
39 #include "formats.h"
40 #include "internal.h"
41 #include "video.h"
42 #include "vf_hqdn3d.h"
43 
44 #define LUT_BITS (depth==16 ? 8 : 4)
45 #define LOAD(x) (((depth == 8 ? src[x] : AV_RN16A(src + (x) * 2)) << (16 - depth))\
46  + (((1 << (16 - depth)) - 1) >> 1))
47 #define STORE(x,val) (depth == 8 ? dst[x] = (val) >> (16 - depth) : \
48  AV_WN16A(dst + (x) * 2, (val) >> (16 - depth)))
49 
51 static uint32_t lowpass(int prev, int cur, int16_t *coef, int depth)
52 {
53  int d = (prev - cur) >> (8 - LUT_BITS);
54  return cur + coef[d];
55 }
56 
58 static void denoise_temporal(uint8_t *src, uint8_t *dst,
59  uint16_t *frame_ant,
60  int w, int h, int sstride, int dstride,
61  int16_t *temporal, int depth)
62 {
63  long x, y;
64  uint32_t tmp;
65 
66  temporal += 256 << LUT_BITS;
67 
68  for (y = 0; y < h; y++) {
69  for (x = 0; x < w; x++) {
70  frame_ant[x] = tmp = lowpass(frame_ant[x], LOAD(x), temporal, depth);
71  STORE(x, tmp);
72  }
73  src += sstride;
74  dst += dstride;
75  frame_ant += w;
76  }
77 }
78 
81  uint8_t *src, uint8_t *dst,
82  uint16_t *line_ant, uint16_t *frame_ant,
83  int w, int h, int sstride, int dstride,
84  int16_t *spatial, int16_t *temporal, int depth)
85 {
86  long x, y;
87  uint32_t pixel_ant;
88  uint32_t tmp;
89 
90  spatial += 256 << LUT_BITS;
91  temporal += 256 << LUT_BITS;
92 
93  /* First line has no top neighbor. Only left one for each tmp and
94  * last frame */
95  pixel_ant = LOAD(0);
96  for (x = 0; x < w; x++) {
97  line_ant[x] = tmp = pixel_ant = lowpass(pixel_ant, LOAD(x), spatial, depth);
98  frame_ant[x] = tmp = lowpass(frame_ant[x], tmp, temporal, depth);
99  STORE(x, tmp);
100  }
101 
102  for (y = 1; y < h; y++) {
103  src += sstride;
104  dst += dstride;
105  frame_ant += w;
106  if (s->denoise_row[depth]) {
107  s->denoise_row[depth](src, dst, line_ant, frame_ant, w, spatial, temporal);
108  continue;
109  }
110  pixel_ant = LOAD(0);
111  for (x = 0; x < w-1; x++) {
112  line_ant[x] = tmp = lowpass(line_ant[x], pixel_ant, spatial, depth);
113  pixel_ant = lowpass(pixel_ant, LOAD(x+1), spatial, depth);
114  frame_ant[x] = tmp = lowpass(frame_ant[x], tmp, temporal, depth);
115  STORE(x, tmp);
116  }
117  line_ant[x] = tmp = lowpass(line_ant[x], pixel_ant, spatial, depth);
118  frame_ant[x] = tmp = lowpass(frame_ant[x], tmp, temporal, depth);
119  STORE(x, tmp);
120  }
121 }
122 
125  uint8_t *src, uint8_t *dst,
126  uint16_t *line_ant, uint16_t **frame_ant_ptr,
127  int w, int h, int sstride, int dstride,
128  int16_t *spatial, int16_t *temporal, int depth)
129 {
130  // FIXME: For 16bit depth, frame_ant could be a pointer to the previous
131  // filtered frame rather than a separate buffer.
132  long x, y;
133  uint16_t *frame_ant = *frame_ant_ptr;
134  if (!frame_ant) {
135  uint8_t *frame_src = src;
136  *frame_ant_ptr = frame_ant = av_malloc(w*h*sizeof(uint16_t));
137  for (y = 0; y < h; y++, src += sstride, frame_ant += w)
138  for (x = 0; x < w; x++)
139  frame_ant[x] = LOAD(x);
140  src = frame_src;
141  frame_ant = *frame_ant_ptr;
142  }
143 
144  if (spatial[0])
145  denoise_spatial(s, src, dst, line_ant, frame_ant,
146  w, h, sstride, dstride, spatial, temporal, depth);
147  else
148  denoise_temporal(src, dst, frame_ant,
149  w, h, sstride, dstride, temporal, depth);
150 }
151 
152 #define denoise(...) \
153  switch (s->depth) {\
154  case 8: denoise_depth(__VA_ARGS__, 8); break;\
155  case 9: denoise_depth(__VA_ARGS__, 9); break;\
156  case 10: denoise_depth(__VA_ARGS__, 10); break;\
157  case 16: denoise_depth(__VA_ARGS__, 16); break;\
158  }
159 
160 static int16_t *precalc_coefs(double dist25, int depth)
161 {
162  int i;
163  double gamma, simil, C;
164  int16_t *ct = av_malloc((512<<LUT_BITS)*sizeof(int16_t));
165  if (!ct)
166  return NULL;
167 
168  gamma = log(0.25) / log(1.0 - FFMIN(dist25,252.0)/255.0 - 0.00001);
169 
170  for (i = -255<<LUT_BITS; i <= 255<<LUT_BITS; i++) {
171  double f = ((i<<(9-LUT_BITS)) + (1<<(8-LUT_BITS)) - 1) / 512.0; // midpoint of the bin
172  simil = 1.0 - FFABS(f) / 255.0;
173  C = pow(simil, gamma) * 256.0 * f;
174  ct[(256<<LUT_BITS)+i] = lrint(C);
175  }
176 
177  ct[0] = !!dist25;
178  return ct;
179 }
180 
181 #define PARAM1_DEFAULT 4.0
182 #define PARAM2_DEFAULT 3.0
183 #define PARAM3_DEFAULT 6.0
184 
185 static av_cold int init(AVFilterContext *ctx)
186 {
187  HQDN3DContext *s = ctx->priv;
188 
189  if (!s->strength[LUMA_SPATIAL])
191  if (!s->strength[CHROMA_SPATIAL])
193  if (!s->strength[LUMA_TMP])
195  if (!s->strength[CHROMA_TMP])
197 
198  av_log(ctx, AV_LOG_VERBOSE, "ls:%f cs:%f lt:%f ct:%f\n",
201 
202  return 0;
203 }
204 
205 static av_cold void uninit(AVFilterContext *ctx)
206 {
207  HQDN3DContext *s = ctx->priv;
208 
209  av_freep(&s->coefs[0]);
210  av_freep(&s->coefs[1]);
211  av_freep(&s->coefs[2]);
212  av_freep(&s->coefs[3]);
213  av_freep(&s->line);
214  av_freep(&s->frame_prev[0]);
215  av_freep(&s->frame_prev[1]);
216  av_freep(&s->frame_prev[2]);
217 }
218 
220 {
221  static const enum AVPixelFormat pix_fmts[] = {
242  };
243 
245 
246  return 0;
247 }
248 
249 static int config_input(AVFilterLink *inlink)
250 {
251  HQDN3DContext *s = inlink->dst->priv;
252  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
253  int i;
254 
255  uninit(inlink->dst);
256 
257  s->hsub = desc->log2_chroma_w;
258  s->vsub = desc->log2_chroma_h;
259  s->depth = desc->comp[0].depth_minus1+1;
260 
261  s->line = av_malloc(inlink->w * sizeof(*s->line));
262  if (!s->line)
263  return AVERROR(ENOMEM);
264 
265  for (i = 0; i < 4; i++) {
266  s->coefs[i] = precalc_coefs(s->strength[i], s->depth);
267  if (!s->coefs[i])
268  return AVERROR(ENOMEM);
269  }
270 
271  if (ARCH_X86)
273 
274  return 0;
275 }
276 
277 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
278 {
279  AVFilterContext *ctx = inlink->dst;
280  HQDN3DContext *s = ctx->priv;
281  AVFilterLink *outlink = ctx->outputs[0];
282 
283  AVFrame *out;
284  int direct, c;
285 
286  if (av_frame_is_writable(in) && !ctx->is_disabled) {
287  direct = 1;
288  out = in;
289  } else {
290  direct = 0;
291  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
292  if (!out) {
293  av_frame_free(&in);
294  return AVERROR(ENOMEM);
295  }
296 
297  av_frame_copy_props(out, in);
298  }
299 
300  for (c = 0; c < 3; c++) {
301  denoise(s, in->data[c], out->data[c],
302  s->line, &s->frame_prev[c],
303  FF_CEIL_RSHIFT(in->width, (!!c * s->hsub)),
304  FF_CEIL_RSHIFT(in->height, (!!c * s->vsub)),
305  in->linesize[c], out->linesize[c],
307  s->coefs[c ? CHROMA_TMP : LUMA_TMP]);
308  }
309 
310  if (ctx->is_disabled) {
311  av_frame_free(&out);
312  return ff_filter_frame(outlink, in);
313  }
314 
315  if (!direct)
316  av_frame_free(&in);
317 
318  return ff_filter_frame(outlink, out);
319 }
320 
321 #define OFFSET(x) offsetof(HQDN3DContext, x)
322 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
323 static const AVOption hqdn3d_options[] = {
324  { "luma_spatial", "spatial luma strength", OFFSET(strength[LUMA_SPATIAL]), AV_OPT_TYPE_DOUBLE, { .dbl = 0.0 }, 0, DBL_MAX, FLAGS },
325  { "chroma_spatial", "spatial chroma strength", OFFSET(strength[CHROMA_SPATIAL]), AV_OPT_TYPE_DOUBLE, { .dbl = 0.0 }, 0, DBL_MAX, FLAGS },
326  { "luma_tmp", "temporal luma strength", OFFSET(strength[LUMA_TMP]), AV_OPT_TYPE_DOUBLE, { .dbl = 0.0 }, 0, DBL_MAX, FLAGS },
327  { "chroma_tmp", "temporal chroma strength", OFFSET(strength[CHROMA_TMP]), AV_OPT_TYPE_DOUBLE, { .dbl = 0.0 }, 0, DBL_MAX, FLAGS },
328  { NULL }
329 };
330 
331 AVFILTER_DEFINE_CLASS(hqdn3d);
332 
334  {
335  .name = "default",
336  .type = AVMEDIA_TYPE_VIDEO,
337  .config_props = config_input,
338  .filter_frame = filter_frame,
339  },
340  { NULL }
341 };
342 
343 
345  {
346  .name = "default",
347  .type = AVMEDIA_TYPE_VIDEO
348  },
349  { NULL }
350 };
351 
353  .name = "hqdn3d",
354  .description = NULL_IF_CONFIG_SMALL("Apply a High Quality 3D Denoiser."),
355  .priv_size = sizeof(HQDN3DContext),
356  .priv_class = &hqdn3d_class,
357  .init = init,
358  .uninit = uninit,
360  .inputs = avfilter_vf_hqdn3d_inputs,
361  .outputs = avfilter_vf_hqdn3d_outputs,
363 };