FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_sab.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20 
21 /**
22  * @file
23  * Shape Adaptive Blur filter, ported from MPlayer libmpcodecs/vf_sab.c
24  */
25 
26 #include "libavutil/opt.h"
27 #include "libavutil/pixdesc.h"
28 #include "libswscale/swscale.h"
29 
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "internal.h"
33 
34 typedef struct {
35  float radius;
37  float strength;
38  float quality;
44  int *dist_coeff;
45 #define COLOR_DIFF_COEFF_SIZE 512
46  int color_diff_coeff[COLOR_DIFF_COEFF_SIZE];
47 } FilterParam;
48 
49 typedef struct {
50  const AVClass *class;
53  int hsub;
54  int vsub;
55  unsigned int sws_flags;
56 } SabContext;
57 
59 {
60  static const enum AVPixelFormat pix_fmts[] = {
67  };
68  AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
69  if (!fmts_list)
70  return AVERROR(ENOMEM);
71  return ff_set_common_formats(ctx, fmts_list);
72 }
73 
74 #define RADIUS_MIN 0.1
75 #define RADIUS_MAX 4.0
76 
77 #define PRE_FILTER_RADIUS_MIN 0.1
78 #define PRE_FILTER_RADIUS_MAX 2.0
79 
80 #define STRENGTH_MIN 0.1
81 #define STRENGTH_MAX 100.0
82 
83 #define OFFSET(x) offsetof(SabContext, x)
84 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
85 
86 static const AVOption sab_options[] = {
87  { "luma_radius", "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
88  { "lr" , "set luma radius", OFFSET(luma.radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, RADIUS_MIN, RADIUS_MAX, .flags=FLAGS },
89  { "luma_pre_filter_radius", "set luma pre-filter radius", OFFSET(luma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, PRE_FILTER_RADIUS_MIN, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
90  { "lpfr", "set luma pre-filter radius", OFFSET(luma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, PRE_FILTER_RADIUS_MIN, PRE_FILTER_RADIUS_MAX, .flags=FLAGS },
91  { "luma_strength", "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
92  { "ls", "set luma strength", OFFSET(luma.strength), AV_OPT_TYPE_FLOAT, {.dbl=1.0}, STRENGTH_MIN, STRENGTH_MAX, .flags=FLAGS },
93 
94  { "chroma_radius", "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
95  { "cr", "set chroma radius", OFFSET(chroma.radius), AV_OPT_TYPE_FLOAT, {.dbl=RADIUS_MIN-1}, RADIUS_MIN-1, RADIUS_MAX, .flags=FLAGS },
96  { "chroma_pre_filter_radius", "set chroma pre-filter radius", OFFSET(chroma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=PRE_FILTER_RADIUS_MIN-1},
98  { "cpfr", "set chroma pre-filter radius", OFFSET(chroma.pre_filter_radius), AV_OPT_TYPE_FLOAT, {.dbl=PRE_FILTER_RADIUS_MIN-1},
100  { "chroma_strength", "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
101  { "cs", "set chroma strength", OFFSET(chroma.strength), AV_OPT_TYPE_FLOAT, {.dbl=STRENGTH_MIN-1}, STRENGTH_MIN-1, STRENGTH_MAX, .flags=FLAGS },
102 
103  { NULL }
104 };
105 
107 
109 {
110  SabContext *s = ctx->priv;
111 
112  /* make chroma default to luma values, if not explicitly set */
113  if (s->chroma.radius < RADIUS_MIN)
114  s->chroma.radius = s->luma.radius;
117  if (s->chroma.strength < STRENGTH_MIN)
118  s->chroma.strength = s->luma.strength;
119 
120  s->luma.quality = s->chroma.quality = 3.0;
121  s->sws_flags = SWS_POINT;
122 
123  av_log(ctx, AV_LOG_VERBOSE,
124  "luma_radius:%f luma_pre_filter_radius::%f luma_strength:%f "
125  "chroma_radius:%f chroma_pre_filter_radius:%f chroma_strength:%f\n",
128  return 0;
129 }
130 
132 {
133  if (f->pre_filter_context) {
136  }
138  av_freep(&f->dist_coeff);
139 }
140 
142 {
143  SabContext *s = ctx->priv;
144 
147 }
148 
149 static int open_filter_param(FilterParam *f, int width, int height, unsigned int sws_flags)
150 {
151  SwsVector *vec;
152  SwsFilter sws_f;
153  int i, x, y;
154  int linesize = FFALIGN(width, 8);
155 
156  f->pre_filter_buf = av_malloc(linesize * height);
157  if (!f->pre_filter_buf)
158  return AVERROR(ENOMEM);
159 
160  f->pre_filter_linesize = linesize;
162  sws_f.lumH = sws_f.lumV = vec;
163  sws_f.chrH = sws_f.chrV = NULL;
165  width, height, AV_PIX_FMT_GRAY8,
166  sws_flags, &sws_f, NULL, NULL);
167  sws_freeVec(vec);
168 
169  vec = sws_getGaussianVec(f->strength, 5.0);
170  for (i = 0; i < COLOR_DIFF_COEFF_SIZE; i++) {
171  double d;
172  int index = i-COLOR_DIFF_COEFF_SIZE/2 + vec->length/2;
173 
174  if (index < 0 || index >= vec->length) d = 0.0;
175  else d = vec->coeff[index];
176 
177  f->color_diff_coeff[i] = (int)(d/vec->coeff[vec->length/2]*(1<<12) + 0.5);
178  }
179  sws_freeVec(vec);
180 
181  vec = sws_getGaussianVec(f->radius, f->quality);
182  f->dist_width = vec->length;
183  f->dist_linesize = FFALIGN(vec->length, 8);
184  f->dist_coeff = av_malloc_array(f->dist_width, f->dist_linesize * sizeof(*f->dist_coeff));
185  if (!f->dist_coeff) {
186  sws_freeVec(vec);
187  return AVERROR(ENOMEM);
188  }
189 
190  for (y = 0; y < vec->length; y++) {
191  for (x = 0; x < vec->length; x++) {
192  double d = vec->coeff[x] * vec->coeff[y];
193  f->dist_coeff[x + y*f->dist_linesize] = (int)(d*(1<<10) + 0.5);
194  }
195  }
196  sws_freeVec(vec);
197 
198  return 0;
199 }
200 
201 static int config_props(AVFilterLink *inlink)
202 {
203  SabContext *s = inlink->dst->priv;
205  int ret;
206 
207  s->hsub = desc->log2_chroma_w;
208  s->vsub = desc->log2_chroma_h;
209 
211  ret = open_filter_param(&s->luma, inlink->w, inlink->h, s->sws_flags);
212  if (ret < 0)
213  return ret;
214 
216  ret = open_filter_param(&s->chroma,
217  AV_CEIL_RSHIFT(inlink->w, s->hsub),
218  AV_CEIL_RSHIFT(inlink->h, s->vsub), s->sws_flags);
219  return ret;
220 }
221 
222 #define NB_PLANES 4
223 
224 static void blur(uint8_t *dst, const int dst_linesize,
225  const uint8_t *src, const int src_linesize,
226  const int w, const int h, FilterParam *fp)
227 {
228  int x, y;
229  FilterParam f = *fp;
230  const int radius = f.dist_width/2;
231 
232  const uint8_t * const src2[NB_PLANES] = { src };
233  int src2_linesize[NB_PLANES] = { src_linesize };
234  uint8_t *dst2[NB_PLANES] = { f.pre_filter_buf };
235  int dst2_linesize[NB_PLANES] = { f.pre_filter_linesize };
236 
237  sws_scale(f.pre_filter_context, src2, src2_linesize, 0, h, dst2, dst2_linesize);
238 
239 #define UPDATE_FACTOR do { \
240  int factor; \
241  factor = f.color_diff_coeff[COLOR_DIFF_COEFF_SIZE/2 + pre_val - \
242  f.pre_filter_buf[ix + iy*f.pre_filter_linesize]] * f.dist_coeff[dx + dy*f.dist_linesize]; \
243  sum += src[ix + iy*src_linesize] * factor; \
244  div += factor; \
245  } while (0)
246 
247  for (y = 0; y < h; y++) {
248  for (x = 0; x < w; x++) {
249  int sum = 0;
250  int div = 0;
251  int dy;
252  const int pre_val = f.pre_filter_buf[x + y*f.pre_filter_linesize];
253  if (x >= radius && x < w - radius) {
254  for (dy = 0; dy < radius*2 + 1; dy++) {
255  int dx;
256  int iy = y+dy - radius;
257  iy = avpriv_mirror(iy, h-1);
258 
259  for (dx = 0; dx < radius*2 + 1; dx++) {
260  const int ix = x+dx - radius;
262  }
263  }
264  } else {
265  for (dy = 0; dy < radius*2+1; dy++) {
266  int dx;
267  int iy = y+dy - radius;
268  iy = avpriv_mirror(iy, h-1);
269 
270  for (dx = 0; dx < radius*2 + 1; dx++) {
271  int ix = x+dx - radius;
272  ix = avpriv_mirror(ix, w-1);
274  }
275  }
276  }
277  dst[x + y*dst_linesize] = (sum + div/2) / div;
278  }
279  }
280 }
281 
282 static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
283 {
284  SabContext *s = inlink->dst->priv;
285  AVFilterLink *outlink = inlink->dst->outputs[0];
286  AVFrame *outpic;
287 
288  outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
289  if (!outpic) {
290  av_frame_free(&inpic);
291  return AVERROR(ENOMEM);
292  }
293  av_frame_copy_props(outpic, inpic);
294 
295  blur(outpic->data[0], outpic->linesize[0], inpic->data[0], inpic->linesize[0],
296  inlink->w, inlink->h, &s->luma);
297  if (inpic->data[2]) {
298  int cw = AV_CEIL_RSHIFT(inlink->w, s->hsub);
299  int ch = AV_CEIL_RSHIFT(inlink->h, s->vsub);
300  blur(outpic->data[1], outpic->linesize[1], inpic->data[1], inpic->linesize[1], cw, ch, &s->chroma);
301  blur(outpic->data[2], outpic->linesize[2], inpic->data[2], inpic->linesize[2], cw, ch, &s->chroma);
302  }
303 
304  av_frame_free(&inpic);
305  return ff_filter_frame(outlink, outpic);
306 }
307 
308 static const AVFilterPad sab_inputs[] = {
309  {
310  .name = "default",
311  .type = AVMEDIA_TYPE_VIDEO,
312  .filter_frame = filter_frame,
313  .config_props = config_props,
314  },
315  { NULL }
316 };
317 
318 static const AVFilterPad sab_outputs[] = {
319  {
320  .name = "default",
321  .type = AVMEDIA_TYPE_VIDEO,
322  },
323  { NULL }
324 };
325 
327  .name = "sab",
328  .description = NULL_IF_CONFIG_SMALL("Apply shape adaptive blur."),
329  .priv_size = sizeof(SabContext),
330  .init = init,
331  .uninit = uninit,
333  .inputs = sab_inputs,
334  .outputs = sab_outputs,
335  .priv_class = &sab_class,
337 };
SwsVector * chrV
Definition: swscale.h:117
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:631
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2193
static av_always_inline void chroma(WaveformContext *s, AVFrame *in, AVFrame *out, int component, int intensity, int offset_y, int offset_x, int column, int mirror)
Definition: vf_waveform.c:1318
float radius
Definition: vf_sab.c:35
This structure describes decoded (raw) audio or video data.
Definition: frame.h:180
AVOption.
Definition: opt.h:245
AVFILTER_DEFINE_CLASS(sab)
AVFormatContext * ctx
Definition: movenc-test.c:48
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:67
static const AVFilterPad sab_outputs[]
Definition: vf_sab.c:318
SwsVector * lumV
Definition: swscale.h:115
Main libavfilter public API header.
const char * desc
Definition: nvenc.c:237
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:1985
static unsigned sws_flags
Definition: ffplay.c:108
static const AVOption sab_options[]
Definition: vf_sab.c:86
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:76
unsigned int sws_flags
Definition: vf_sab.c:55
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:92
int dist_linesize
Definition: vf_sab.c:43
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:283
static void blur(uint8_t *dst, const int dst_linesize, const uint8_t *src, const int src_linesize, const int w, const int h, FilterParam *fp)
Definition: vf_sab.c:224
#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:123
float strength
Definition: vf_sab.c:37
const char * name
Pad name.
Definition: internal.h:59
int pre_filter_linesize
Definition: vf_sab.c:41
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1180
uint8_t
#define av_cold
Definition: attributes.h:82
#define av_malloc(s)
int length
number of coefficients in the vector
Definition: swscale.h:109
#define PRE_FILTER_RADIUS_MIN
Definition: vf_sab.c:77
AVOptions.
int vsub
Definition: vf_sab.c:54
av_frame_free & inpic
Definition: vf_mcdeint.c:281
#define COLOR_DIFF_COEFF_SIZE
Definition: vf_sab.c:45
float pre_filter_radius
Definition: vf_sab.c:36
struct SwsContext * sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat, int dstW, int dstH, enum AVPixelFormat dstFormat, int flags, SwsFilter *srcFilter, SwsFilter *dstFilter, const double *param)
Allocate and return an SwsContext.
Definition: utils.c:1848
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
external API header
#define FFALIGN(x, a)
Definition: macros.h:48
#define av_log(a,...)
#define FLAGS
Definition: vf_sab.c:84
A filter pad used for either input or output.
Definition: internal.h:53
static void close_filter_param(FilterParam *f)
Definition: vf_sab.c:131
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:568
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:101
#define AVERROR(e)
Definition: error.h:43
int hsub
Definition: vf_sab.c:53
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:153
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
void * priv
private data for use by the filter
Definition: avfilter.h:320
static int query_formats(AVFilterContext *ctx)
Definition: vf_sab.c:58
int color_diff_coeff[COLOR_DIFF_COEFF_SIZE]
Definition: vf_sab.c:46
SwsVector * lumH
Definition: swscale.h:114
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:66
static const AVFilterPad sab_inputs[]
Definition: vf_sab.c:308
#define UPDATE_FACTOR
#define RADIUS_MIN
Definition: vf_sab.c:74
float quality
Definition: vf_sab.c:38
SwsVector * chrH
Definition: swscale.h:116
#define RADIUS_MAX
Definition: vf_sab.c:75
#define width
void sws_freeContext(struct SwsContext *swsContext)
Free the swscaler context swsContext.
Definition: utils.c:2268
static int config_props(AVFilterLink *inlink)
Definition: vf_sab.c:201
FilterParam chroma
Definition: vf_sab.c:52
static const AVFilterPad outputs[]
Definition: af_afftfilt.c:386
#define src
Definition: vp9dsp.c:530
static av_always_inline av_const int avpriv_mirror(int x, int w)
Definition: internal.h:318
double * coeff
pointer to the list of coefficients
Definition: swscale.h:108
static const AVFilterPad inputs[]
Definition: af_afftfilt.c:376
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:211
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
void sws_freeVec(SwsVector *a)
Definition: utils.c:2247
#define fp
Definition: regdef.h:44
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:751
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:68
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:142
int index
Definition: gxfenc.c:89
static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
Definition: vf_sab.c:282
const char * name
Filter name.
Definition: avfilter.h:146
#define SWS_POINT
Definition: swscale.h:60
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:317
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:262
#define STRENGTH_MAX
Definition: vf_sab.c:81
static int flags
Definition: cpu.c:47
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:194
AVFilter ff_vf_sab
Definition: vf_sab.c:326
uint8_t * pre_filter_buf
Definition: vf_sab.c:40
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:62
Y , 8bpp.
Definition: pixfmt.h:70
struct SwsContext * pre_filter_context
Definition: vf_sab.c:39
#define PRE_FILTER_RADIUS_MAX
Definition: vf_sab.c:78
FilterParam luma
Definition: vf_sab.c:51
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:69
#define STRENGTH_MIN
Definition: vf_sab.c:80
int dist_width
Definition: vf_sab.c:42
A list of supported formats for one end of a filter link.
Definition: formats.h:64
An instance of a filter.
Definition: avfilter.h:305
static int open_filter_param(FilterParam *f, int width, int height, unsigned int sws_flags)
Definition: vf_sab.c:149
static av_cold int init(AVFilterContext *ctx)
Definition: vf_sab.c:108
#define av_freep(p)
int * dist_coeff
Definition: vf_sab.c:44
#define av_malloc_array(a, b)
#define OFFSET(x)
Definition: vf_sab.c:83
#define height
internal API functions
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_sab.c:141
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:574
#define NB_PLANES
Definition: vf_sab.c:222
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58