FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_smartblur.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (c) 2012 Jeremy Tran
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (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
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 
22 /**
23  * @file
24  * Apply a smartblur filter to the input video
25  * Ported from MPlayer libmpcodecs/vf_smartblur.c by Michael Niedermayer.
26  */
27 
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
30 #include "libswscale/swscale.h"
31 
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "internal.h"
35 
36 #define RADIUS_MIN 0.1
37 #define RADIUS_MAX 5.0
38 
39 #define STRENGTH_MIN -1.0
40 #define STRENGTH_MAX 1.0
41 
42 #define THRESHOLD_MIN -30
43 #define THRESHOLD_MAX 30
44 
45 typedef struct {
46  float radius;
47  float strength;
48  int threshold;
49  float quality;
51 } FilterParam;
52 
53 typedef struct {
54  const AVClass *class;
57  int hsub;
58  int vsub;
59  unsigned int sws_flags;
61 
62 #define OFFSET(x) offsetof(SmartblurContext, x)
63 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
64 
65 static const AVOption smartblur_options[] = {
66  { "luma_radius", "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
67  { "lr" , "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
68  { "luma_strength", "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
69  { "ls", "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
70  { "luma_threshold", "set luma threshold", OFFSET(luma.threshold), AV_OPT_TYPE_INT, {.i64=0}, THRESHOLD_MIN, THRESHOLD_MAX, .flags=FLAGS },
71  { "lt", "set luma threshold", OFFSET(luma.threshold), AV_OPT_TYPE_INT, {.i64=0}, THRESHOLD_MIN, THRESHOLD_MAX, .flags=FLAGS },
72 
73  { "chroma_radius", "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
74  { "cr", "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
75  { "chroma_strength", "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
76  { "cs", "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
77  { "chroma_threshold", "set chroma threshold", OFFSET(chroma.threshold), AV_OPT_TYPE_INT, {.i64=THRESHOLD_MIN-1}, THRESHOLD_MIN-1, THRESHOLD_MAX, .flags=FLAGS },
78  { "ct", "set chroma threshold", OFFSET(chroma.threshold), AV_OPT_TYPE_INT, {.i64=THRESHOLD_MIN-1}, THRESHOLD_MIN-1, THRESHOLD_MAX, .flags=FLAGS },
79 
80  { NULL }
81 };
82 
83 AVFILTER_DEFINE_CLASS(smartblur);
84 
85 static av_cold int init(AVFilterContext *ctx)
86 {
87  SmartblurContext *sblur = ctx->priv;
88 
89  /* make chroma default to luma values, if not explicitly set */
90  if (sblur->chroma.radius < RADIUS_MIN)
91  sblur->chroma.radius = sblur->luma.radius;
92  if (sblur->chroma.strength < STRENGTH_MIN)
93  sblur->chroma.strength = sblur->luma.strength;
94  if (sblur->chroma.threshold < THRESHOLD_MIN)
95  sblur->chroma.threshold = sblur->luma.threshold;
96 
97  sblur->luma.quality = sblur->chroma.quality = 3.0;
98  sblur->sws_flags = SWS_BICUBIC;
99 
100  av_log(ctx, AV_LOG_VERBOSE,
101  "luma_radius:%f luma_strength:%f luma_threshold:%d "
102  "chroma_radius:%f chroma_strength:%f chroma_threshold:%d\n",
103  sblur->luma.radius, sblur->luma.strength, sblur->luma.threshold,
104  sblur->chroma.radius, sblur->chroma.strength, sblur->chroma.threshold);
105 
106  return 0;
107 }
108 
109 static av_cold void uninit(AVFilterContext *ctx)
110 {
111  SmartblurContext *sblur = ctx->priv;
112 
115 }
116 
118 {
119  static const enum AVPixelFormat pix_fmts[] = {
125  };
126 
127  AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
128  if (!fmts_list)
129  return AVERROR(ENOMEM);
130  return ff_set_common_formats(ctx, fmts_list);
131 }
132 
133 static int alloc_sws_context(FilterParam *f, int width, int height, unsigned int flags)
134 {
135  SwsVector *vec;
136  SwsFilter sws_filter;
137 
138  vec = sws_getGaussianVec(f->radius, f->quality);
139 
140  if (!vec)
141  return AVERROR(EINVAL);
142 
143  sws_scaleVec(vec, f->strength);
144  vec->coeff[vec->length / 2] += 1.0 - f->strength;
145  sws_filter.lumH = sws_filter.lumV = vec;
146  sws_filter.chrH = sws_filter.chrV = NULL;
148  width, height, AV_PIX_FMT_GRAY8,
149  width, height, AV_PIX_FMT_GRAY8,
150  flags, &sws_filter, NULL, NULL);
151 
152  sws_freeVec(vec);
153 
154  if (!f->filter_context)
155  return AVERROR(EINVAL);
156 
157  return 0;
158 }
159 
160 static int config_props(AVFilterLink *inlink)
161 {
162  SmartblurContext *sblur = inlink->dst->priv;
163  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
164 
165  sblur->hsub = desc->log2_chroma_w;
166  sblur->vsub = desc->log2_chroma_h;
167 
168  alloc_sws_context(&sblur->luma, inlink->w, inlink->h, sblur->sws_flags);
169  alloc_sws_context(&sblur->chroma,
170  FF_CEIL_RSHIFT(inlink->w, sblur->hsub),
171  FF_CEIL_RSHIFT(inlink->h, sblur->vsub),
172  sblur->sws_flags);
173 
174  return 0;
175 }
176 
177 static void blur(uint8_t *dst, const int dst_linesize,
178  const uint8_t *src, const int src_linesize,
179  const int w, const int h, const int threshold,
180  struct SwsContext *filter_context)
181 {
182  int x, y;
183  int orig, filtered;
184  int diff;
185  /* Declare arrays of 4 to get aligned data */
186  const uint8_t* const src_array[4] = {src};
187  uint8_t *dst_array[4] = {dst};
188  int src_linesize_array[4] = {src_linesize};
189  int dst_linesize_array[4] = {dst_linesize};
190 
191  sws_scale(filter_context, src_array, src_linesize_array,
192  0, h, dst_array, dst_linesize_array);
193 
194  if (threshold > 0) {
195  for (y = 0; y < h; ++y) {
196  for (x = 0; x < w; ++x) {
197  orig = src[x + y * src_linesize];
198  filtered = dst[x + y * dst_linesize];
199  diff = orig - filtered;
200 
201  if (diff > 0) {
202  if (diff > 2 * threshold)
203  dst[x + y * dst_linesize] = orig;
204  else if (diff > threshold)
205  /* add 'diff' and subtract 'threshold' from 'filtered' */
206  dst[x + y * dst_linesize] = orig - threshold;
207  } else {
208  if (-diff > 2 * threshold)
209  dst[x + y * dst_linesize] = orig;
210  else if (-diff > threshold)
211  /* add 'diff' and 'threshold' to 'filtered' */
212  dst[x + y * dst_linesize] = orig + threshold;
213  }
214  }
215  }
216  } else if (threshold < 0) {
217  for (y = 0; y < h; ++y) {
218  for (x = 0; x < w; ++x) {
219  orig = src[x + y * src_linesize];
220  filtered = dst[x + y * dst_linesize];
221  diff = orig - filtered;
222 
223  if (diff > 0) {
224  if (diff <= -threshold)
225  dst[x + y * dst_linesize] = orig;
226  else if (diff <= -2 * threshold)
227  /* subtract 'diff' and 'threshold' from 'orig' */
228  dst[x + y * dst_linesize] = filtered - threshold;
229  } else {
230  if (diff >= threshold)
231  dst[x + y * dst_linesize] = orig;
232  else if (diff >= 2 * threshold)
233  /* add 'threshold' and subtract 'diff' from 'orig' */
234  dst[x + y * dst_linesize] = filtered + threshold;
235  }
236  }
237  }
238  }
239 }
240 
241 static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
242 {
243  SmartblurContext *sblur = inlink->dst->priv;
244  AVFilterLink *outlink = inlink->dst->outputs[0];
245  AVFrame *outpic;
246  int cw = FF_CEIL_RSHIFT(inlink->w, sblur->hsub);
247  int ch = FF_CEIL_RSHIFT(inlink->h, sblur->vsub);
248 
249  outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
250  if (!outpic) {
251  av_frame_free(&inpic);
252  return AVERROR(ENOMEM);
253  }
254  av_frame_copy_props(outpic, inpic);
255 
256  blur(outpic->data[0], outpic->linesize[0],
257  inpic->data[0], inpic->linesize[0],
258  inlink->w, inlink->h, sblur->luma.threshold,
259  sblur->luma.filter_context);
260 
261  if (inpic->data[2]) {
262  blur(outpic->data[1], outpic->linesize[1],
263  inpic->data[1], inpic->linesize[1],
264  cw, ch, sblur->chroma.threshold,
265  sblur->chroma.filter_context);
266  blur(outpic->data[2], outpic->linesize[2],
267  inpic->data[2], inpic->linesize[2],
268  cw, ch, sblur->chroma.threshold,
269  sblur->chroma.filter_context);
270  }
271 
272  av_frame_free(&inpic);
273  return ff_filter_frame(outlink, outpic);
274 }
275 
276 static const AVFilterPad smartblur_inputs[] = {
277  {
278  .name = "default",
279  .type = AVMEDIA_TYPE_VIDEO,
280  .filter_frame = filter_frame,
281  .config_props = config_props,
282  },
283  { NULL }
284 };
285 
286 static const AVFilterPad smartblur_outputs[] = {
287  {
288  .name = "default",
289  .type = AVMEDIA_TYPE_VIDEO,
290  },
291  { NULL }
292 };
293 
295  .name = "smartblur",
296  .description = NULL_IF_CONFIG_SMALL("Blur the input video without impacting the outlines."),
297  .priv_size = sizeof(SmartblurContext),
298  .init = init,
299  .uninit = uninit,
301  .inputs = smartblur_inputs,
302  .outputs = smartblur_outputs,
303  .priv_class = &smartblur_class,
305 };
#define OFFSET(x)
Definition: vf_smartblur.c:62
SwsVector * chrV
Definition: swscale.h:132
#define NULL
Definition: coverity.c:32
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2090
This structure describes decoded (raw) audio or video data.
Definition: frame.h:171
#define SWS_BICUBIC
Definition: swscale.h:58
AVOption.
Definition: opt.h:255
AVFILTER_DEFINE_CLASS(smartblur)
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:68
static const AVFilterPad outputs[]
Definition: af_ashowinfo.c:248
SwsVector * lumV
Definition: swscale.h:130
Main libavfilter public API header.
SwsVector * sws_getGaussianVec(double variance, double quality)
Return a normalized Gaussian curve used to filter stuff quality = 3 is high quality, lower is lower quality.
Definition: utils.c:1781
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:109
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:80
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:283
#define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC
Some filters support a generic "enable" expression option that can be used to enable or disable a fil...
Definition: avfilter.h:451
float strength
Definition: vf_sab.c:37
#define FLAGS
Definition: vf_smartblur.c:63
const char * name
Pad name.
Definition: internal.h:67
FilterParam chroma
Definition: vf_smartblur.c:56
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1145
uint8_t
#define av_cold
Definition: attributes.h:74
int length
number of coefficients in the vector
Definition: swscale.h:124
AVOptions.
av_frame_free & inpic
Definition: vf_mcdeint.c:279
#define THRESHOLD_MIN
Definition: vf_smartblur.c:42
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
external API header
unsigned int sws_flags
Definition: vf_smartblur.c:59
#define av_log(a,...)
struct SwsContext * filter_context
Definition: vf_smartblur.c:50
A filter pad used for either input or output.
Definition: internal.h:61
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:542
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:89
static int config_props(AVFilterLink *inlink)
Definition: vf_smartblur.c:160
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:148
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:175
void * priv
private data for use by the filter
Definition: avfilter.h:654
void sws_scaleVec(SwsVector *a, double scalar)
Scale all the coefficients of a by the scalar value.
Definition: utils.c:1837
SwsVector * lumH
Definition: swscale.h:129
struct SwsContext * sws_getCachedContext(struct SwsContext *context, int srcW, int srcH, enum AVPixelFormat srcFormat, int dstW, int dstH, enum AVPixelFormat dstFormat, int flags, SwsFilter *srcFilter, SwsFilter *dstFilter, const double *param)
Check if context can be reused, otherwise reallocate a new one.
Definition: utils.c:2109
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:67
static int alloc_sws_context(FilterParam *f, int width, int height, unsigned int flags)
Definition: vf_smartblur.c:133
#define STRENGTH_MAX
Definition: vf_smartblur.c:40
float y
float quality
Definition: vf_sab.c:38
SwsVector * chrH
Definition: swscale.h:131
#define FF_CEIL_RSHIFT(a, b)
Definition: common.h:57
void sws_freeContext(struct SwsContext *swsContext)
Free the swscaler context swsContext.
Definition: utils.c:2031
static int query_formats(AVFilterContext *ctx)
Definition: vf_smartblur.c:117
static const AVOption smartblur_options[]
Definition: vf_smartblur.c:65
#define RADIUS_MIN
Definition: vf_smartblur.c:36
FilterParam luma
Definition: vf_smartblur.c:55
double * coeff
pointer to the list of coefficients
Definition: swscale.h:123
AVS_Value src
Definition: avisynth_c.h:482
#define THRESHOLD_MAX
Definition: vf_smartblur.c:43
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:199
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
static const AVFilterPad smartblur_inputs[]
Definition: vf_smartblur.c:276
void sws_freeVec(SwsVector *a)
Definition: utils.c:2010
int attribute_align_arg sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[], const int srcStride[], int srcSliceY, int srcSliceH, uint8_t *const dst[], const int dstStride[])
swscale wrapper, so we don't need to export the SwsContext.
Definition: swscale.c:914
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_smartblur.c:109
BYTE int const BYTE int int int height
Definition: avisynth_c.h:676
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:69
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:470
static const AVFilterPad inputs[]
Definition: af_ashowinfo.c:239
const char * name
Filter name.
Definition: avfilter.h:474
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:648
static int flags
Definition: cpu.c:47
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:182
AVFilter ff_vf_smartblur
Definition: vf_smartblur.c:294
#define RADIUS_MAX
Definition: vf_smartblur.c:37
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:63
Y , 8bpp.
Definition: pixfmt.h:71
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:70
static void blur(uint8_t *dst, const int dst_linesize, const uint8_t *src, const int src_linesize, const int w, const int h, const int threshold, struct SwsContext *filter_context)
Definition: vf_smartblur.c:177
static av_always_inline int diff(const uint32_t a, const uint32_t b)
A list of supported formats for one end of a filter link.
Definition: formats.h:64
#define STRENGTH_MIN
Definition: vf_smartblur.c:39
An instance of a filter.
Definition: avfilter.h:633
planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
Definition: pixfmt.h:101
static const AVFilterPad smartblur_outputs[]
Definition: vf_smartblur.c:286
static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
Definition: vf_smartblur.c:241
internal API functions
AVPixelFormat
Pixel format.
Definition: pixfmt.h:61
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:548
static int width
static av_cold int init(AVFilterContext *ctx)
Definition: vf_smartblur.c:85