2 * Copyright (c) 2018 Paul B Mahol
4 * This file is part of FFmpeg.
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.
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.
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
22 * Based on paper: A Simple and Efficient Deblocking Algorithm for Low Bit-Rate Video Coding.
25 #include "libavutil/imgutils.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/pixdesc.h"
34 enum FilterType { WEAK, STRONG, NB_FILTER };
36 typedef struct DeblockContext {
38 const AVPixFmtDescriptor *desc;
58 void (*deblockh)(uint8_t *dst, ptrdiff_t dst_linesize, int block,
59 int ath, int bth, int gth, int dth, int max);
60 void (*deblockv)(uint8_t *dst, ptrdiff_t dst_linesize, int block,
61 int ath, int bth, int gth, int dth, int max);
64 static int query_formats(AVFilterContext *ctx)
66 static const enum AVPixelFormat pixel_fmts[] = {
67 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
68 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
69 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
70 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
71 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
72 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
73 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
74 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
75 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
76 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
77 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
78 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
79 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
80 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
81 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
82 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
83 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
84 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
87 AVFilterFormats *formats = ff_make_format_list(pixel_fmts);
89 return AVERROR(ENOMEM);
90 return ff_set_common_formats(ctx, formats);
93 #define WEAK_HFILTER(name, type, ldiv) \
94 static void deblockh##name##_weak(uint8_t *dstp, ptrdiff_t dst_linesize, int block, \
95 int ath, int bth, int gth, int dth, int max) \
100 dst = (type *)dstp; \
101 dst_linesize /= ldiv; \
103 for (x = 0; x < block; x++) { \
104 int delta = dst[x] - dst[x - dst_linesize]; \
105 int A, B, C, D, a, b, c, d; \
107 if (FFABS(delta) >= ath || \
108 FFABS(dst[x - 1 * dst_linesize] - dst[x - 2 * dst_linesize]) >= bth || \
109 FFABS(dst[x + 0 * dst_linesize] - dst[x + 1 * dst_linesize]) >= gth) \
112 A = dst[x - 2 * dst_linesize]; \
113 B = dst[x - 1 * dst_linesize]; \
114 C = dst[x + 0 * dst_linesize]; \
115 D = dst[x + 1 * dst_linesize]; \
122 dst[x - 2 * dst_linesize] = av_clip(a, 0, max); \
123 dst[x - 1 * dst_linesize] = av_clip(b, 0, max); \
124 dst[x + 0 * dst_linesize] = av_clip(c, 0, max); \
125 dst[x + 1 * dst_linesize] = av_clip(d, 0, max); \
129 WEAK_HFILTER(8, uint8_t, 1)
130 WEAK_HFILTER(16, uint16_t, 2)
132 #define WEAK_VFILTER(name, type, ldiv) \
133 static void deblockv##name##_weak(uint8_t *dstp, ptrdiff_t dst_linesize, int block, \
134 int ath, int bth, int gth, int dth, int max) \
139 dst = (type *)dstp; \
140 dst_linesize /= ldiv; \
142 for (y = 0; y < block; y++) { \
143 int delta = dst[0] - dst[-1]; \
144 int A, B, C, D, a, b, c, d; \
146 if (FFABS(delta) >= ath || \
147 FFABS(dst[-1] - dst[-2]) >= bth || \
148 FFABS(dst[0] - dst[1]) >= gth) \
161 dst[-2] = av_clip(a, 0, max); \
162 dst[-1] = av_clip(b, 0, max); \
163 dst[+0] = av_clip(c, 0, max); \
164 dst[+1] = av_clip(d, 0, max); \
166 dst += dst_linesize; \
170 WEAK_VFILTER(8, uint8_t, 1)
171 WEAK_VFILTER(16, uint16_t, 2)
173 #define STRONG_HFILTER(name, type, ldiv) \
174 static void deblockh##name##_strong(uint8_t *dstp, ptrdiff_t dst_linesize, int block,\
175 int ath, int bth, int gth, int dth, int max) \
180 dst = (type *)dstp; \
181 dst_linesize /= ldiv; \
183 for (x = 0; x < block; x++) { \
184 int A, B, C, D, E, F, a, b, c, d, e, f; \
185 int delta = dst[x] - dst[x - dst_linesize]; \
187 if (FFABS(delta) >= ath || \
188 FFABS(dst[x - 1 * dst_linesize] - dst[x - 2 * dst_linesize]) >= bth || \
189 FFABS(dst[x + 1 * dst_linesize] - dst[x + 2 * dst_linesize]) >= gth || \
190 FFABS(dst[x + 0 * dst_linesize] - dst[x + 1 * dst_linesize]) >= dth) \
193 A = dst[x - 3 * dst_linesize]; \
194 B = dst[x - 2 * dst_linesize]; \
195 C = dst[x - 1 * dst_linesize]; \
196 D = dst[x + 0 * dst_linesize]; \
197 E = dst[x + 1 * dst_linesize]; \
198 F = dst[x + 2 * dst_linesize]; \
207 dst[x - 3 * dst_linesize] = av_clip(a, 0, max); \
208 dst[x - 2 * dst_linesize] = av_clip(b, 0, max); \
209 dst[x - 1 * dst_linesize] = av_clip(c, 0, max); \
210 dst[x + 0 * dst_linesize] = av_clip(d, 0, max); \
211 dst[x + 1 * dst_linesize] = av_clip(e, 0, max); \
212 dst[x + 2 * dst_linesize] = av_clip(f, 0, max); \
216 STRONG_HFILTER(8, uint8_t, 1)
217 STRONG_HFILTER(16, uint16_t, 2)
219 #define STRONG_VFILTER(name, type, ldiv) \
220 static void deblockv##name##_strong(uint8_t *dstp, ptrdiff_t dst_linesize, int block,\
221 int ath, int bth, int gth, int dth, int max) \
226 dst = (type *)dstp; \
227 dst_linesize /= ldiv; \
229 for (y = 0; y < block; y++) { \
230 int A, B, C, D, E, F, a, b, c, d, e, f; \
231 int delta = dst[0] - dst[-1]; \
233 if (FFABS(delta) >= ath || \
234 FFABS(dst[-1] - dst[-2]) >= bth || \
235 FFABS(dst[+1] - dst[+2]) >= gth || \
236 FFABS(dst[+0] - dst[+1]) >= dth) \
253 dst[-3] = av_clip(a, 0, max); \
254 dst[-2] = av_clip(b, 0, max); \
255 dst[-1] = av_clip(c, 0, max); \
256 dst[+0] = av_clip(d, 0, max); \
257 dst[+1] = av_clip(e, 0, max); \
258 dst[+2] = av_clip(f, 0, max); \
260 dst += dst_linesize; \
264 STRONG_VFILTER(8, uint8_t, 1)
265 STRONG_VFILTER(16, uint16_t, 2)
267 static int config_output(AVFilterLink *outlink)
269 AVFilterContext *ctx = outlink->src;
270 DeblockContext *s = ctx->priv;
271 AVFilterLink *inlink = ctx->inputs[0];
273 s->desc = av_pix_fmt_desc_get(outlink->format);
276 s->nb_planes = av_pix_fmt_count_planes(outlink->format);
277 s->depth = s->desc->comp[0].depth;
278 s->bpc = (s->depth + 7) / 8;
279 s->max = (1 << s->depth) - 1;
280 s->ath = s->alpha * s->max;
281 s->bth = s->beta * s->max;
282 s->gth = s->gamma * s->max;
283 s->dth = s->delta * s->max;
285 if (s->depth <= 8 && s->filter == WEAK) {
286 s->deblockh = deblockh8_weak;
287 s->deblockv = deblockv8_weak;
288 } else if (s->depth > 8 && s->filter == WEAK) {
289 s->deblockh = deblockh16_weak;
290 s->deblockv = deblockv16_weak;
292 if (s->depth <= 8 && s->filter == STRONG) {
293 s->deblockh = deblockh8_strong;
294 s->deblockv = deblockv8_strong;
295 } else if (s->depth > 8 && s->filter == STRONG) {
296 s->deblockh = deblockh16_strong;
297 s->deblockv = deblockv16_strong;
300 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, s->desc->log2_chroma_w);
301 s->planewidth[0] = s->planewidth[3] = inlink->w;
303 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, s->desc->log2_chroma_h);
304 s->planeheight[0] = s->planeheight[3] = inlink->h;
309 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
311 AVFilterContext *ctx = inlink->dst;
312 AVFilterLink *outlink = ctx->outputs[0];
313 DeblockContext *s = ctx->priv;
314 const int block = s->block;
318 if (av_frame_is_writable(in)) {
321 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
324 return AVERROR(ENOMEM);
326 av_frame_copy_props(out, in);
329 for (plane = 0; plane < s->nb_planes; plane++) {
330 const int width = s->planewidth[plane];
331 const int height = s->planeheight[plane];
332 const uint8_t *src = (const uint8_t *)in->data[plane];
333 uint8_t *dst = (uint8_t *)out->data[plane];
336 av_image_copy_plane(dst, out->linesize[plane],
337 src, in->linesize[plane],
338 width * s->bpc, height);
340 if (!((1 << plane) & s->planes))
343 for (x = block; x < width; x += block)
344 s->deblockv(dst + x * s->bpc, out->linesize[plane],
345 FFMIN(block, height), s->ath, s->bth, s->gth, s->dth, s->max);
347 for (y = block; y < height; y += block) {
348 dst += out->linesize[plane] * block;
350 s->deblockh(dst, out->linesize[plane],
352 s->ath, s->bth, s->gth, s->dth, s->max);
354 for (x = block; x < width; x += block) {
355 s->deblockh(dst + x * s->bpc, out->linesize[plane],
356 FFMIN(block, width - x),
357 s->ath, s->bth, s->gth, s->dth, s->max);
358 s->deblockv(dst + x * s->bpc, out->linesize[plane],
359 FFMIN(block, height - y),
360 s->ath, s->bth, s->gth, s->dth, s->max);
367 return ff_filter_frame(outlink, out);
370 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
371 char *res, int res_len, int flags)
375 ret = ff_filter_process_command(ctx, cmd, args, res, res_len, flags);
379 return config_output(ctx->outputs[0]);
382 #define OFFSET(x) offsetof(DeblockContext, x)
383 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
385 static const AVOption deblock_options[] = {
386 { "filter", "set type of filter", OFFSET(filter), AV_OPT_TYPE_INT, {.i64=STRONG},0, 1, FLAGS, "filter" },
387 { "weak", 0, 0, AV_OPT_TYPE_CONST, {.i64=WEAK}, 0, 0, FLAGS, "filter" },
388 { "strong", 0, 0, AV_OPT_TYPE_CONST, {.i64=STRONG},0, 0, FLAGS, "filter" },
389 { "block", "set size of block", OFFSET(block), AV_OPT_TYPE_INT, {.i64=8}, 4, 512, FLAGS },
390 { "alpha", "set 1st detection threshold", OFFSET(alpha), AV_OPT_TYPE_FLOAT, {.dbl=.098}, 0, 1, FLAGS },
391 { "beta", "set 2nd detection threshold", OFFSET(beta), AV_OPT_TYPE_FLOAT, {.dbl=.05}, 0, 1, FLAGS },
392 { "gamma", "set 3rd detection threshold", OFFSET(gamma), AV_OPT_TYPE_FLOAT, {.dbl=.05}, 0, 1, FLAGS },
393 { "delta", "set 4th detection threshold", OFFSET(delta), AV_OPT_TYPE_FLOAT, {.dbl=.05}, 0, 1, FLAGS },
394 { "planes", "set planes to filter", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=15}, 0, 15, FLAGS },
398 static const AVFilterPad inputs[] = {
401 .type = AVMEDIA_TYPE_VIDEO,
402 .filter_frame = filter_frame,
407 static const AVFilterPad outputs[] = {
410 .type = AVMEDIA_TYPE_VIDEO,
411 .config_props = config_output,
416 AVFILTER_DEFINE_CLASS(deblock);
418 const AVFilter ff_vf_deblock = {
420 .description = NULL_IF_CONFIG_SMALL("Deblock video."),
421 .priv_size = sizeof(DeblockContext),
422 .priv_class = &deblock_class,
423 .query_formats = query_formats,
426 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
427 .process_command = process_command,