2 * Copyright (c) 2002 Jindrich Makovicka <makovick@gmail.com>
3 * Copyright (c) 2011 Stefano Sabatini
4 * Copyright (c) 2013 Jean Delvare <khali@linux-fr.org>
6 * This file is part of FFmpeg.
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.
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.
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.
25 * A very simple tv station logo remover
26 * Originally imported from MPlayer libmpcodecs/vf_delogo.c,
27 * the algorithm was later improved.
30 #include "libavutil/common.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
40 * Apply a simple delogo algorithm to the image in src and put the
43 * The algorithm is only applied to the region specified by the logo
46 * @param w width of the input image
47 * @param h height of the input image
48 * @param logo_x x coordinate of the top left corner of the logo region
49 * @param logo_y y coordinate of the top left corner of the logo region
50 * @param logo_w width of the logo
51 * @param logo_h height of the logo
52 * @param band the size of the band around the processed area
53 * @param show show a rectangle around the processed area, useful for
55 * @param direct if non-zero perform in-place processing
57 static void apply_delogo(uint8_t *dst, int dst_linesize,
58 uint8_t *src, int src_linesize,
60 int logo_x, int logo_y, int logo_w, int logo_h,
61 int band, int show, int direct)
64 uint64_t interp, weightl, weightr, weightt, weightb;
67 uint8_t *topleft, *botleft, *topright;
68 int xclipl, xclipr, yclipt, yclipb;
69 int logo_x1, logo_x2, logo_y1, logo_y2;
71 xclipl = FFMAX(-logo_x, 0);
72 xclipr = FFMAX(logo_x+logo_w-w, 0);
73 yclipt = FFMAX(-logo_y, 0);
74 yclipb = FFMAX(logo_y+logo_h-h, 0);
76 logo_x1 = logo_x + xclipl;
77 logo_x2 = logo_x + logo_w - xclipr;
78 logo_y1 = logo_y + yclipt;
79 logo_y2 = logo_y + logo_h - yclipb;
81 topleft = src+logo_y1 * src_linesize+logo_x1;
82 topright = src+logo_y1 * src_linesize+logo_x2-1;
83 botleft = src+(logo_y2-1) * src_linesize+logo_x1;
86 av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
88 dst += (logo_y1 + 1) * dst_linesize;
89 src += (logo_y1 + 1) * src_linesize;
91 for (y = logo_y1+1; y < logo_y2-1; y++) {
94 xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
96 /* Weighted interpolation based on relative distances */
97 weightl = (uint64_t) (logo_x2-1-x) * (y-logo_y1) * (logo_y2-1-y);
98 weightr = (uint64_t)(x-logo_x1) * (y-logo_y1) * (logo_y2-1-y);
99 weightt = (uint64_t)(x-logo_x1) * (logo_x2-1-x) * (logo_y2-1-y);
100 weightb = (uint64_t)(x-logo_x1) * (logo_x2-1-x) * (y-logo_y1);
103 (topleft[src_linesize*(y-logo_y -yclipt)] +
104 topleft[src_linesize*(y-logo_y-1-yclipt)] +
105 topleft[src_linesize*(y-logo_y+1-yclipt)]) * weightl
107 (topright[src_linesize*(y-logo_y-yclipt)] +
108 topright[src_linesize*(y-logo_y-1-yclipt)] +
109 topright[src_linesize*(y-logo_y+1-yclipt)]) * weightr
111 (topleft[x-logo_x-xclipl] +
112 topleft[x-logo_x-1-xclipl] +
113 topleft[x-logo_x+1-xclipl]) * weightt
115 (botleft[x-logo_x-xclipl] +
116 botleft[x-logo_x-1-xclipl] +
117 botleft[x-logo_x+1-xclipl]) * weightb;
118 interp /= (weightl + weightr + weightt + weightb) * 3U;
120 if (y >= logo_y+band && y < logo_y+logo_h-band &&
121 x >= logo_x+band && x < logo_x+logo_w-band) {
126 dist = FFMAX(dist, logo_x-x+band);
127 else if (x >= logo_x+logo_w-band)
128 dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
131 dist = FFMAX(dist, logo_y-y+band);
132 else if (y >= logo_y+logo_h-band)
133 dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
135 *xdst = (*xsrc*dist + interp*(band-dist))/band;
136 if (show && (dist == band-1))
147 const AVClass *class;
148 int x, y, w, h, band, show;
151 #define OFFSET(x) offsetof(DelogoContext, x)
152 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
154 static const AVOption delogo_options[]= {
155 { "x", "set logo x position", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
156 { "y", "set logo y position", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
157 { "w", "set logo width", OFFSET(w), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
158 { "h", "set logo height", OFFSET(h), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
159 { "band", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 = 4 }, -1, INT_MAX, FLAGS },
160 { "t", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 = 4 }, -1, INT_MAX, FLAGS },
161 { "show", "show delogo area", OFFSET(show), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS },
165 AVFILTER_DEFINE_CLASS(delogo);
167 static int query_formats(AVFilterContext *ctx)
169 static const enum AVPixelFormat pix_fmts[] = {
170 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
171 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
172 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_GRAY8,
176 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
180 static av_cold int init(AVFilterContext *ctx)
182 DelogoContext *s = ctx->priv;
184 #define CHECK_UNSET_OPT(opt) \
185 if (s->opt == -1) { \
186 av_log(s, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
187 return AVERROR(EINVAL); \
194 if (s->band < 0 || s->show) {
199 av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
200 s->x, s->y, s->w, s->h, s->band, s->show);
210 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
212 DelogoContext *s = inlink->dst->priv;
213 AVFilterLink *outlink = inlink->dst->outputs[0];
214 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
216 int hsub0 = desc->log2_chroma_w;
217 int vsub0 = desc->log2_chroma_h;
221 if (av_frame_is_writable(in)) {
225 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
228 return AVERROR(ENOMEM);
231 av_frame_copy_props(out, in);
234 for (plane = 0; plane < 4 && in->data[plane]; plane++) {
235 int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
236 int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
238 apply_delogo(out->data[plane], out->linesize[plane],
239 in ->data[plane], in ->linesize[plane],
240 FF_CEIL_RSHIFT(inlink->w, hsub),
241 FF_CEIL_RSHIFT(inlink->h, vsub),
242 s->x>>hsub, s->y>>vsub,
243 FF_CEIL_RSHIFT(s->w, hsub),
244 FF_CEIL_RSHIFT(s->h, vsub),
245 s->band>>FFMIN(hsub, vsub),
252 return ff_filter_frame(outlink, out);
255 static const AVFilterPad avfilter_vf_delogo_inputs[] = {
258 .type = AVMEDIA_TYPE_VIDEO,
259 .get_video_buffer = ff_null_get_video_buffer,
260 .filter_frame = filter_frame,
265 static const AVFilterPad avfilter_vf_delogo_outputs[] = {
268 .type = AVMEDIA_TYPE_VIDEO,
273 AVFilter avfilter_vf_delogo = {
275 .description = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
276 .priv_size = sizeof(DelogoContext),
277 .priv_class = &delogo_class,
279 .query_formats = query_formats,
281 .inputs = avfilter_vf_delogo_inputs,
282 .outputs = avfilter_vf_delogo_outputs,
283 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,