2 * Copyright (c) 2002 Jindrich Makovicka <makovick@gmail.com>
3 * Copyright (c) 2011 Stefano Sabatini
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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/imgutils.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
37 * Apply a simple delogo algorithm to the image in dst and put the
40 * The algorithm is only applied to the region specified by the logo
43 * @param w width of the input image
44 * @param h height of the input image
45 * @param logo_x x coordinate of the top left corner of the logo region
46 * @param logo_y y coordinate of the top left corner of the logo region
47 * @param logo_w width of the logo
48 * @param logo_h height of the logo
49 * @param band the size of the band around the processed area
50 * @param show show a rectangle around the processed area, useful for
52 * @param direct if non-zero perform in-place processing
54 static void apply_delogo(uint8_t *dst, int dst_linesize,
55 uint8_t *src, int src_linesize,
57 int logo_x, int logo_y, int logo_w, int logo_h,
58 int band, int show, int direct)
64 uint8_t *topleft, *botleft, *topright;
65 int xclipl, xclipr, yclipt, yclipb;
66 int logo_x1, logo_x2, logo_y1, logo_y2;
68 xclipl = FFMAX(-logo_x, 0);
69 xclipr = FFMAX(logo_x+logo_w-w, 0);
70 yclipt = FFMAX(-logo_y, 0);
71 yclipb = FFMAX(logo_y+logo_h-h, 0);
73 logo_x1 = logo_x + xclipl;
74 logo_x2 = logo_x + logo_w - xclipr;
75 logo_y1 = logo_y + yclipt;
76 logo_y2 = logo_y + logo_h - yclipb;
78 topleft = src+logo_y1 * src_linesize+logo_x1;
79 topright = src+logo_y1 * src_linesize+logo_x2-1;
80 botleft = src+(logo_y2-1) * src_linesize+logo_x1;
82 dst += (logo_y1+1)*dst_linesize;
83 src += (logo_y1+1)*src_linesize;
86 av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
88 for (y = logo_y1+1; y < logo_y2-1; y++) {
91 xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
92 interp = (topleft[src_linesize*(y-logo_y -yclipt)] +
93 topleft[src_linesize*(y-logo_y-1-yclipt)] +
94 topleft[src_linesize*(y-logo_y+1-yclipt)]) * (logo_w-(x-logo_x))/logo_w
95 + (topright[src_linesize*(y-logo_y-yclipt)] +
96 topright[src_linesize*(y-logo_y-1-yclipt)] +
97 topright[src_linesize*(y-logo_y+1-yclipt)]) * (x-logo_x)/logo_w
98 + (topleft[x-logo_x-xclipl] +
99 topleft[x-logo_x-1-xclipl] +
100 topleft[x-logo_x+1-xclipl]) * (logo_h-(y-logo_y))/logo_h
101 + (botleft[x-logo_x-xclipl] +
102 botleft[x-logo_x-1-xclipl] +
103 botleft[x-logo_x+1-xclipl]) * (y-logo_y)/logo_h;
106 if (y >= logo_y+band && y < logo_y+logo_h-band &&
107 x >= logo_x+band && x < logo_x+logo_w-band) {
112 dist = FFMAX(dist, logo_x-x+band);
113 else if (x >= logo_x+logo_w-band)
114 dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
117 dist = FFMAX(dist, logo_y-y+band);
118 else if (y >= logo_y+logo_h-band)
119 dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
121 *xdst = (*xsrc*dist + interp*(band-dist))/band;
122 if (show && (dist == band-1))
133 const AVClass *class;
134 int x, y, w, h, band, show;
137 #define OFFSET(x) offsetof(DelogoContext, x)
139 static const AVOption delogo_options[]= {
140 {"x", "set logo x position", OFFSET(x), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
141 {"y", "set logo y position", OFFSET(y), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
142 {"w", "set logo width", OFFSET(w), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
143 {"h", "set logo height", OFFSET(h), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
144 {"band", "set delogo area band size", OFFSET(band), FF_OPT_TYPE_INT, { 4}, -1, INT_MAX },
145 {"t", "set delogo area band size", OFFSET(band), FF_OPT_TYPE_INT, { 4}, -1, INT_MAX },
146 {"show", "show delogo area", OFFSET(show), FF_OPT_TYPE_INT, { 0}, 0, 1 },
150 static const char *delogo_get_name(void *ctx)
155 static const AVClass delogo_class = {
156 .class_name = "DelogoContext",
157 .item_name = delogo_get_name,
158 .option = delogo_options,
161 static int query_formats(AVFilterContext *ctx)
163 enum PixelFormat pix_fmts[] = {
164 PIX_FMT_YUV444P, PIX_FMT_YUV422P, PIX_FMT_YUV420P,
165 PIX_FMT_YUV411P, PIX_FMT_YUV410P, PIX_FMT_YUV440P,
166 PIX_FMT_YUVA420P, PIX_FMT_GRAY8,
170 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
174 static av_cold int init(AVFilterContext *ctx, const char *args)
176 DelogoContext *delogo = ctx->priv;
179 delogo->class = &delogo_class;
180 av_opt_set_defaults(delogo);
183 ret = sscanf(args, "%d:%d:%d:%d:%d",
184 &delogo->x, &delogo->y, &delogo->w, &delogo->h, &delogo->band);
186 if (delogo->band < 0)
188 } else if ((ret = (av_set_options_string(delogo, args, "=", ":"))) < 0) {
189 av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
193 #define CHECK_UNSET_OPT(opt) \
194 if (delogo->opt == -1) { \
195 av_log(delogo, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
196 return AVERROR(EINVAL); \
206 av_log(ctx, AV_LOG_DEBUG, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
207 delogo->x, delogo->y, delogo->w, delogo->h, delogo->band, delogo->show);
209 delogo->w += delogo->band*2;
210 delogo->h += delogo->band*2;
211 delogo->x -= delogo->band;
212 delogo->y -= delogo->band;
217 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
219 AVFilterLink *outlink = inlink->dst->outputs[0];
220 AVFilterBufferRef *outpicref;
222 if (inpicref->perms & AV_PERM_PRESERVE) {
223 outpicref = ff_get_video_buffer(outlink, AV_PERM_WRITE,
224 outlink->w, outlink->h);
225 avfilter_copy_buffer_ref_props(outpicref, inpicref);
226 outpicref->video->w = outlink->w;
227 outpicref->video->h = outlink->h;
229 outpicref = inpicref;
231 outlink->out_buf = outpicref;
232 ff_start_frame(outlink, avfilter_ref_buffer(outpicref, ~0));
235 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
237 static void end_frame(AVFilterLink *inlink)
239 DelogoContext *delogo = inlink->dst->priv;
240 AVFilterLink *outlink = inlink->dst->outputs[0];
241 AVFilterBufferRef *inpicref = inlink ->cur_buf;
242 AVFilterBufferRef *outpicref = outlink->out_buf;
243 int direct = inpicref == outpicref;
244 int hsub0 = av_pix_fmt_descriptors[inlink->format].log2_chroma_w;
245 int vsub0 = av_pix_fmt_descriptors[inlink->format].log2_chroma_h;
248 for (plane = 0; plane < 4 && inpicref->data[plane]; plane++) {
249 int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
250 int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
252 apply_delogo(outpicref->data[plane], outpicref->linesize[plane],
253 inpicref ->data[plane], inpicref ->linesize[plane],
254 inlink->w>>hsub, inlink->h>>vsub,
255 delogo->x>>hsub, delogo->y>>vsub,
256 delogo->w>>hsub, delogo->h>>vsub,
257 delogo->band>>FFMIN(hsub, vsub),
258 delogo->show, direct);
261 ff_draw_slice(outlink, 0, inlink->h, 1);
262 ff_end_frame(outlink);
263 avfilter_unref_buffer(inpicref);
265 avfilter_unref_buffer(outpicref);
268 AVFilter avfilter_vf_delogo = {
270 .description = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
271 .priv_size = sizeof(DelogoContext),
273 .query_formats = query_formats,
275 .inputs = (AVFilterPad[]) {{ .name = "default",
276 .type = AVMEDIA_TYPE_VIDEO,
277 .get_video_buffer = ff_null_get_video_buffer,
278 .start_frame = start_frame,
279 .draw_slice = null_draw_slice,
280 .end_frame = end_frame,
281 .min_perms = AV_PERM_WRITE | AV_PERM_READ,
282 .rej_perms = AV_PERM_PRESERVE },
284 .outputs = (AVFilterPad[]) {{ .name = "default",
285 .type = AVMEDIA_TYPE_VIDEO, },