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"
34 * Apply a simple delogo algorithm to the image in dst and put the
37 * The algorithm is only applied to the region specified by the logo
40 * @param w width of the input image
41 * @param h height of the input image
42 * @param logo_x x coordinate of the top left corner of the logo region
43 * @param logo_y y coordinate of the top left corner of the logo region
44 * @param logo_w width of the logo
45 * @param logo_h height of the logo
46 * @param band the size of the band around the processed area
47 * @param show show a rectangle around the processed area, useful for
49 * @param direct if non-zero perform in-place processing
51 static void apply_delogo(uint8_t *dst, int dst_linesize,
52 uint8_t *src, int src_linesize,
54 int logo_x, int logo_y, int logo_w, int logo_h,
55 int band, int show, int direct)
61 uint8_t *topleft, *botleft, *topright;
62 int xclipl, xclipr, yclipt, yclipb;
63 int logo_x1, logo_x2, logo_y1, logo_y2;
65 xclipl = FFMAX(-logo_x, 0);
66 xclipr = FFMAX(logo_x+logo_w-w, 0);
67 yclipt = FFMAX(-logo_y, 0);
68 yclipb = FFMAX(logo_y+logo_h-h, 0);
70 logo_x1 = logo_x + xclipl;
71 logo_x2 = logo_x + logo_w - xclipr;
72 logo_y1 = logo_y + yclipt;
73 logo_y2 = logo_y + logo_h - yclipb;
75 topleft = src+logo_y1 * src_linesize+logo_x1;
76 topright = src+logo_y1 * src_linesize+logo_x2-1;
77 botleft = src+(logo_y2-1) * src_linesize+logo_x1;
79 dst += (logo_y1+1)*dst_linesize;
80 src += (logo_y1+1)*src_linesize;
83 av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
85 for (y = logo_y1+1; y < logo_y2-1; y++) {
88 xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
89 interp = (topleft[src_linesize*(y-logo_y -yclipt)] +
90 topleft[src_linesize*(y-logo_y-1-yclipt)] +
91 topleft[src_linesize*(y-logo_y+1-yclipt)]) * (logo_w-(x-logo_x))/logo_w
92 + (topright[src_linesize*(y-logo_y-yclipt)] +
93 topright[src_linesize*(y-logo_y-1-yclipt)] +
94 topright[src_linesize*(y-logo_y+1-yclipt)]) * (x-logo_x)/logo_w
95 + (topleft[x-logo_x-xclipl] +
96 topleft[x-logo_x-1-xclipl] +
97 topleft[x-logo_x+1-xclipl]) * (logo_h-(y-logo_y))/logo_h
98 + (botleft[x-logo_x-xclipl] +
99 botleft[x-logo_x-1-xclipl] +
100 botleft[x-logo_x+1-xclipl]) * (y-logo_y)/logo_h;
103 if (y >= logo_y+band && y < logo_y+logo_h-band &&
104 x >= logo_x+band && x < logo_x+logo_w-band) {
109 dist = FFMAX(dist, logo_x-x+band);
110 else if (x >= logo_x+logo_w-band)
111 dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
114 dist = FFMAX(dist, logo_y-y+band);
115 else if (y >= logo_y+logo_h-band)
116 dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
118 *xdst = (*xsrc*dist + interp*(band-dist))/band;
119 if (show && (dist == band-1))
130 const AVClass *class;
131 int x, y, w, h, band, show;
134 #define OFFSET(x) offsetof(DelogoContext, x)
136 static const AVOption delogo_options[]= {
137 {"x", "set logo x position", OFFSET(x), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
138 {"y", "set logo y position", OFFSET(y), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
139 {"w", "set logo width", OFFSET(w), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
140 {"h", "set logo height", OFFSET(h), FF_OPT_TYPE_INT, {-1}, -1, INT_MAX },
141 {"band", "set delogo area band size", OFFSET(band), FF_OPT_TYPE_INT, { 4}, -1, INT_MAX },
142 {"t", "set delogo area band size", OFFSET(band), FF_OPT_TYPE_INT, { 4}, -1, INT_MAX },
143 {"show", "show delogo area", OFFSET(show), FF_OPT_TYPE_INT, { 0}, 0, 1 },
147 static const char *delogo_get_name(void *ctx)
152 static const AVClass delogo_class = {
153 .class_name = "DelogoContext",
154 .item_name = delogo_get_name,
155 .option = delogo_options,
158 static int query_formats(AVFilterContext *ctx)
160 enum PixelFormat pix_fmts[] = {
161 PIX_FMT_YUV444P, PIX_FMT_YUV422P, PIX_FMT_YUV420P,
162 PIX_FMT_YUV411P, PIX_FMT_YUV410P, PIX_FMT_YUV440P,
163 PIX_FMT_YUVA420P, PIX_FMT_GRAY8,
167 avfilter_set_common_formats(ctx, avfilter_make_format_list(pix_fmts));
171 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
173 DelogoContext *delogo = ctx->priv;
176 delogo->class = &delogo_class;
177 av_opt_set_defaults(delogo);
180 ret = sscanf(args, "%d:%d:%d:%d:%d",
181 &delogo->x, &delogo->y, &delogo->w, &delogo->h, &delogo->band);
183 if (delogo->band < 0)
185 } else if ((ret = (av_set_options_string(delogo, args, "=", ":"))) < 0) {
186 av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
190 #define CHECK_UNSET_OPT(opt) \
191 if (delogo->opt == -1) { \
192 av_log(delogo, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
193 return AVERROR(EINVAL); \
203 av_log(ctx, AV_LOG_DEBUG, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
204 delogo->x, delogo->y, delogo->w, delogo->h, delogo->band, delogo->show);
206 delogo->w += delogo->band*2;
207 delogo->h += delogo->band*2;
208 delogo->x -= delogo->band;
209 delogo->y -= delogo->band;
214 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
216 AVFilterLink *outlink = inlink->dst->outputs[0];
217 AVFilterBufferRef *outpicref;
219 if (inpicref->perms & AV_PERM_PRESERVE) {
220 outpicref = avfilter_get_video_buffer(outlink, AV_PERM_WRITE,
221 outlink->w, outlink->h);
222 avfilter_copy_buffer_ref_props(outpicref, inpicref);
223 outpicref->video->w = outlink->w;
224 outpicref->video->h = outlink->h;
226 outpicref = inpicref;
228 outlink->out_buf = outpicref;
229 avfilter_start_frame(outlink, avfilter_ref_buffer(outpicref, ~0));
232 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
234 static void end_frame(AVFilterLink *inlink)
236 DelogoContext *delogo = inlink->dst->priv;
237 AVFilterLink *outlink = inlink->dst->outputs[0];
238 AVFilterBufferRef *inpicref = inlink ->cur_buf;
239 AVFilterBufferRef *outpicref = outlink->out_buf;
240 int direct = inpicref == outpicref;
241 int hsub0 = av_pix_fmt_descriptors[inlink->format].log2_chroma_w;
242 int vsub0 = av_pix_fmt_descriptors[inlink->format].log2_chroma_h;
245 for (plane = 0; plane < 4 && inpicref->data[plane]; plane++) {
246 int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
247 int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
249 apply_delogo(outpicref->data[plane], outpicref->linesize[plane],
250 inpicref ->data[plane], inpicref ->linesize[plane],
251 inlink->w>>hsub, inlink->h>>vsub,
252 delogo->x>>hsub, delogo->y>>vsub,
253 delogo->w>>hsub, delogo->h>>vsub,
254 delogo->band>>FFMIN(hsub, vsub),
255 delogo->show, direct);
258 avfilter_draw_slice(outlink, 0, inlink->h, 1);
259 avfilter_end_frame(outlink);
260 avfilter_unref_buffer(inpicref);
262 avfilter_unref_buffer(outpicref);
265 AVFilter avfilter_vf_delogo = {
267 .description = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
268 .priv_size = sizeof(DelogoContext),
270 .query_formats = query_formats,
272 .inputs = (AVFilterPad[]) {{ .name = "default",
273 .type = AVMEDIA_TYPE_VIDEO,
274 .get_video_buffer = avfilter_null_get_video_buffer,
275 .start_frame = start_frame,
276 .draw_slice = null_draw_slice,
277 .end_frame = end_frame,
278 .min_perms = AV_PERM_WRITE | AV_PERM_READ,
279 .rej_perms = AV_PERM_PRESERVE },
281 .outputs = (AVFilterPad[]) {{ .name = "default",
282 .type = AVMEDIA_TYPE_VIDEO, },