2 * Copyright (c) 2002 Jindrich Makovicka <makovick@gmail.com>
3 * Copyright (c) 2011 Stefano Sabatini
5 * This file is part of FFmpeg.
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.
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.
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.
24 * A very simple tv station logo remover
25 * Ported from MPlayer libmpcodecs/vf_delogo.c.
28 #include "libavutil/common.h"
29 #include "libavutil/imgutils.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
38 * Apply a simple delogo algorithm to the image in dst and put the
41 * The algorithm is only applied to the region specified by the logo
44 * @param w width of the input image
45 * @param h height of the input image
46 * @param logo_x x coordinate of the top left corner of the logo region
47 * @param logo_y y coordinate of the top left corner of the logo region
48 * @param logo_w width of the logo
49 * @param logo_h height of the logo
50 * @param band the size of the band around the processed area
51 * @param show show a rectangle around the processed area, useful for
53 * @param direct if non-zero perform in-place processing
55 static void apply_delogo(uint8_t *dst, int dst_linesize,
56 uint8_t *src, int src_linesize,
58 int logo_x, int logo_y, int logo_w, int logo_h,
59 int band, int show, int direct)
65 uint8_t *topleft, *botleft, *topright;
66 int xclipl, xclipr, yclipt, yclipb;
67 int logo_x1, logo_x2, logo_y1, logo_y2;
69 xclipl = FFMAX(-logo_x, 0);
70 xclipr = FFMAX(logo_x+logo_w-w, 0);
71 yclipt = FFMAX(-logo_y, 0);
72 yclipb = FFMAX(logo_y+logo_h-h, 0);
74 logo_x1 = logo_x + xclipl;
75 logo_x2 = logo_x + logo_w - xclipr;
76 logo_y1 = logo_y + yclipt;
77 logo_y2 = logo_y + logo_h - yclipb;
79 topleft = src+logo_y1 * src_linesize+logo_x1;
80 topright = src+logo_y1 * src_linesize+logo_x2-1;
81 botleft = src+(logo_y2-1) * src_linesize+logo_x1;
84 av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
86 dst += (logo_y1 + 1) * dst_linesize;
87 src += (logo_y1 + 1) * src_linesize;
89 for (y = logo_y1+1; y < logo_y2-1; y++) {
92 xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
94 (topleft[src_linesize*(y-logo_y -yclipt)] +
95 topleft[src_linesize*(y-logo_y-1-yclipt)] +
96 topleft[src_linesize*(y-logo_y+1-yclipt)]) * (logo_w-(x-logo_x))/logo_w
98 (topright[src_linesize*(y-logo_y-yclipt)] +
99 topright[src_linesize*(y-logo_y-1-yclipt)] +
100 topright[src_linesize*(y-logo_y+1-yclipt)]) * (x-logo_x)/logo_w
102 (topleft[x-logo_x-xclipl] +
103 topleft[x-logo_x-1-xclipl] +
104 topleft[x-logo_x+1-xclipl]) * (logo_h-(y-logo_y))/logo_h
106 (botleft[x-logo_x-xclipl] +
107 botleft[x-logo_x-1-xclipl] +
108 botleft[x-logo_x+1-xclipl]) * (y-logo_y)/logo_h;
111 if (y >= logo_y+band && y < logo_y+logo_h-band &&
112 x >= logo_x+band && x < logo_x+logo_w-band) {
117 dist = FFMAX(dist, logo_x-x+band);
118 else if (x >= logo_x+logo_w-band)
119 dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
122 dist = FFMAX(dist, logo_y-y+band);
123 else if (y >= logo_y+logo_h-band)
124 dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
126 *xdst = (*xsrc*dist + interp*(band-dist))/band;
127 if (show && (dist == band-1))
138 const AVClass *class;
139 int x, y, w, h, band, show;
142 #define OFFSET(x) offsetof(DelogoContext, x)
143 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
145 static const AVOption delogo_options[]= {
146 { "x", "set logo x position", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
147 { "y", "set logo y position", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
148 { "w", "set logo width", OFFSET(w), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
149 { "h", "set logo height", OFFSET(h), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
150 { "band", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 = 4 }, -1, INT_MAX, FLAGS },
151 { "t", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 = 4 }, -1, INT_MAX, FLAGS },
152 { "show", "show delogo area", OFFSET(show), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS },
156 AVFILTER_DEFINE_CLASS(delogo);
158 static int query_formats(AVFilterContext *ctx)
160 static const enum AVPixelFormat pix_fmts[] = {
161 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
162 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
163 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_GRAY8,
167 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
171 static av_cold int init(AVFilterContext *ctx, const char *args)
173 DelogoContext *delogo = ctx->priv;
175 #define CHECK_UNSET_OPT(opt) \
176 if (delogo->opt == -1) { \
177 av_log(delogo, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
178 return AVERROR(EINVAL); \
185 if (delogo->band < 0 || delogo->show) {
190 av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
191 delogo->x, delogo->y, delogo->w, delogo->h, delogo->band, delogo->show);
193 delogo->w += delogo->band*2;
194 delogo->h += delogo->band*2;
195 delogo->x -= delogo->band;
196 delogo->y -= delogo->band;
201 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
203 DelogoContext *delogo = inlink->dst->priv;
204 AVFilterLink *outlink = inlink->dst->outputs[0];
205 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
207 int hsub0 = desc->log2_chroma_w;
208 int vsub0 = desc->log2_chroma_h;
212 if (av_frame_is_writable(in)) {
216 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
219 return AVERROR(ENOMEM);
222 av_frame_copy_props(out, in);
225 for (plane = 0; plane < 4 && in->data[plane]; plane++) {
226 int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
227 int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
229 apply_delogo(out->data[plane], out->linesize[plane],
230 in ->data[plane], in ->linesize[plane],
231 inlink->w>>hsub, inlink->h>>vsub,
232 delogo->x>>hsub, delogo->y>>vsub,
233 delogo->w>>hsub, delogo->h>>vsub,
234 delogo->band>>FFMIN(hsub, vsub),
235 delogo->show, direct);
241 return ff_filter_frame(outlink, out);
244 static const AVFilterPad avfilter_vf_delogo_inputs[] = {
247 .type = AVMEDIA_TYPE_VIDEO,
248 .get_video_buffer = ff_null_get_video_buffer,
249 .filter_frame = filter_frame,
254 static const AVFilterPad avfilter_vf_delogo_outputs[] = {
257 .type = AVMEDIA_TYPE_VIDEO,
262 AVFilter avfilter_vf_delogo = {
264 .description = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
265 .priv_size = sizeof(DelogoContext),
266 .priv_class = &delogo_class,
268 .query_formats = query_formats,
270 .inputs = avfilter_vf_delogo_inputs,
271 .outputs = avfilter_vf_delogo_outputs,