1 /*
2 * Copyright (c) 2002 Jindrich Makovicka <makovick@gmail.com>
3 * Copyright (c) 2011 Stefano Sabatini
4 * Copyright (c) 2013, 2015 Jean Delvare <jdelvare@suse.com>
5 *
6 * This file is part of FFmpeg.
7 *
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.
12 *
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.
17 *
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.
21 */
22
23 /**
24 * @file
25 * A very simple tv station logo remover
26 * Originally imported from MPlayer libmpcodecs/vf_delogo.c,
27 * the algorithm was later improved.
28 */
29
30 #include "libavutil/common.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
34 #include "libavutil/eval.h"
35 #include "avfilter.h"
36 #include "formats.h"
37 #include "internal.h"
38 #include "video.h"
39 static const char * const var_names[] = {
40 "x",
41 "y",
42 "w",
43 "h",
44 "n", ///< number of frame
45 "t", ///< timestamp expressed in seconds
46 NULL
47 };
48
49 enum var_name {
50 VAR_X,
51 VAR_Y,
52 VAR_W,
53 VAR_H,
54 VAR_N,
55 VAR_T,
56 VAR_VARS_NB
57 };
58
set_expr(AVExpr ** pexpr,const char * expr,const char * option,void * log_ctx)59 static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
60 {
61 int ret;
62 AVExpr *old = NULL;
63
64 if (*pexpr)
65 old = *pexpr;
66 ret = av_expr_parse(pexpr, expr, var_names, NULL, NULL, NULL, NULL, 0, log_ctx);
67 if (ret < 0) {
68 av_log(log_ctx, AV_LOG_ERROR,
69 "Error when parsing the expression '%s' for %s\n",
70 expr, option);
71 *pexpr = old;
72 return ret;
73 }
74
75 av_expr_free(old);
76 return 0;
77 }
78
79
80 /**
81 * Apply a simple delogo algorithm to the image in src and put the
82 * result in dst.
83 *
84 * The algorithm is only applied to the region specified by the logo
85 * parameters.
86 *
87 * @param w width of the input image
88 * @param h height of the input image
89 * @param logo_x x coordinate of the top left corner of the logo region
90 * @param logo_y y coordinate of the top left corner of the logo region
91 * @param logo_w width of the logo
92 * @param logo_h height of the logo
93 * @param band the size of the band around the processed area
94 * @param show show a rectangle around the processed area, useful for
95 * parameters tweaking
96 * @param direct if non-zero perform in-place processing
97 */
apply_delogo(uint8_t * dst,int dst_linesize,uint8_t * src,int src_linesize,int w,int h,AVRational sar,int logo_x,int logo_y,int logo_w,int logo_h,unsigned int band,int show,int direct)98 static void apply_delogo(uint8_t *dst, int dst_linesize,
99 uint8_t *src, int src_linesize,
100 int w, int h, AVRational sar,
101 int logo_x, int logo_y, int logo_w, int logo_h,
102 unsigned int band, int show, int direct)
103 {
104 int x, y;
105 uint64_t interp, weightl, weightr, weightt, weightb, weight;
106 uint8_t *xdst, *xsrc;
107
108 uint8_t *topleft, *botleft, *topright;
109 unsigned int left_sample, right_sample;
110 int xclipl, xclipr, yclipt, yclipb;
111 int logo_x1, logo_x2, logo_y1, logo_y2;
112
113 xclipl = FFMAX(-logo_x, 0);
114 xclipr = FFMAX(logo_x+logo_w-w, 0);
115 yclipt = FFMAX(-logo_y, 0);
116 yclipb = FFMAX(logo_y+logo_h-h, 0);
117
118 logo_x1 = logo_x + xclipl;
119 logo_x2 = logo_x + logo_w - xclipr - 1;
120 logo_y1 = logo_y + yclipt;
121 logo_y2 = logo_y + logo_h - yclipb - 1;
122
123 topleft = src+logo_y1 * src_linesize+logo_x1;
124 topright = src+logo_y1 * src_linesize+logo_x2;
125 botleft = src+logo_y2 * src_linesize+logo_x1;
126
127 if (!direct)
128 av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
129
130 dst += (logo_y1 + 1) * dst_linesize;
131 src += (logo_y1 + 1) * src_linesize;
132
133 for (y = logo_y1+1; y < logo_y2; y++) {
134 left_sample = topleft[src_linesize*(y-logo_y1)] +
135 topleft[src_linesize*(y-logo_y1-1)] +
136 topleft[src_linesize*(y-logo_y1+1)];
137 right_sample = topright[src_linesize*(y-logo_y1)] +
138 topright[src_linesize*(y-logo_y1-1)] +
139 topright[src_linesize*(y-logo_y1+1)];
140
141 for (x = logo_x1+1,
142 xdst = dst+logo_x1+1,
143 xsrc = src+logo_x1+1; x < logo_x2; x++, xdst++, xsrc++) {
144
145 if (show && (y == logo_y1+1 || y == logo_y2-1 ||
146 x == logo_x1+1 || x == logo_x2-1)) {
147 *xdst = 0;
148 continue;
149 }
150
151 /* Weighted interpolation based on relative distances, taking SAR into account */
152 weightl = (uint64_t) (logo_x2-x) * (y-logo_y1) * (logo_y2-y) * sar.den;
153 weightr = (uint64_t)(x-logo_x1) * (y-logo_y1) * (logo_y2-y) * sar.den;
154 weightt = (uint64_t)(x-logo_x1) * (logo_x2-x) * (logo_y2-y) * sar.num;
155 weightb = (uint64_t)(x-logo_x1) * (logo_x2-x) * (y-logo_y1) * sar.num;
156
157 interp =
158 left_sample * weightl
159 +
160 right_sample * weightr
161 +
162 (topleft[x-logo_x1] +
163 topleft[x-logo_x1-1] +
164 topleft[x-logo_x1+1]) * weightt
165 +
166 (botleft[x-logo_x1] +
167 botleft[x-logo_x1-1] +
168 botleft[x-logo_x1+1]) * weightb;
169 weight = (weightl + weightr + weightt + weightb) * 3U;
170 interp = (interp + (weight >> 1)) / weight;
171
172 if (y >= logo_y+band && y < logo_y+logo_h-band &&
173 x >= logo_x+band && x < logo_x+logo_w-band) {
174 *xdst = interp;
175 } else {
176 unsigned dist = 0;
177
178 if (x < logo_x+band)
179 dist = FFMAX(dist, logo_x-x+band);
180 else if (x >= logo_x+logo_w-band)
181 dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
182
183 if (y < logo_y+band)
184 dist = FFMAX(dist, logo_y-y+band);
185 else if (y >= logo_y+logo_h-band)
186 dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
187
188 *xdst = (*xsrc*dist + interp*(band-dist))/band;
189 }
190 }
191
192 dst += dst_linesize;
193 src += src_linesize;
194 }
195 }
196
197 typedef struct DelogoContext {
198 const AVClass *class;
199 int x, y, w, h, band, show;
200 char *x_expr, *y_expr, *w_expr, *h_expr;
201 AVExpr *x_pexpr, *y_pexpr, *w_pexpr, *h_pexpr;
202 double var_values[VAR_VARS_NB];
203 } DelogoContext;
204
205 #define OFFSET(x) offsetof(DelogoContext, x)
206 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
207
208 static const AVOption delogo_options[]= {
209 { "x", "set logo x position", OFFSET(x_expr), AV_OPT_TYPE_STRING, { .str = "-1" }, 0, 0, FLAGS },
210 { "y", "set logo y position", OFFSET(y_expr), AV_OPT_TYPE_STRING, { .str = "-1" }, 0, 0, FLAGS },
211 { "w", "set logo width", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str = "-1" }, 0, 0, FLAGS },
212 { "h", "set logo height", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str = "-1" }, 0, 0, FLAGS },
213 { "show", "show delogo area", OFFSET(show), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
214 { NULL }
215 };
216
217 AVFILTER_DEFINE_CLASS(delogo);
uninit(AVFilterContext * ctx)218 static av_cold void uninit(AVFilterContext *ctx)
219 {
220 DelogoContext *s = ctx->priv;
221
222 av_expr_free(s->x_pexpr); s->x_pexpr = NULL;
223 av_expr_free(s->y_pexpr); s->y_pexpr = NULL;
224 av_expr_free(s->w_pexpr); s->w_pexpr = NULL;
225 av_expr_free(s->h_pexpr); s->h_pexpr = NULL;
226 }
227
228
query_formats(AVFilterContext * ctx)229 static int query_formats(AVFilterContext *ctx)
230 {
231 static const enum AVPixelFormat pix_fmts[] = {
232 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
233 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
234 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_GRAY8,
235 AV_PIX_FMT_NONE
236 };
237 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
238 if (!fmts_list)
239 return AVERROR(ENOMEM);
240 return ff_set_common_formats(ctx, fmts_list);
241 }
242
init(AVFilterContext * ctx)243 static av_cold int init(AVFilterContext *ctx)
244 {
245 DelogoContext *s = ctx->priv;
246 int ret = 0;
247
248 if ((ret = set_expr(&s->x_pexpr, s->x_expr, "x", ctx)) < 0 ||
249 (ret = set_expr(&s->y_pexpr, s->y_expr, "y", ctx)) < 0 ||
250 (ret = set_expr(&s->w_pexpr, s->w_expr, "w", ctx)) < 0 ||
251 (ret = set_expr(&s->h_pexpr, s->h_expr, "h", ctx)) < 0 )
252 return ret;
253
254 s->x = av_expr_eval(s->x_pexpr, s->var_values, s);
255 s->y = av_expr_eval(s->y_pexpr, s->var_values, s);
256 s->w = av_expr_eval(s->w_pexpr, s->var_values, s);
257 s->h = av_expr_eval(s->h_pexpr, s->var_values, s);
258
259 #define CHECK_UNSET_OPT(opt) \
260 if (s->opt == -1) { \
261 av_log(s, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
262 return AVERROR(EINVAL); \
263 }
264 CHECK_UNSET_OPT(x);
265 CHECK_UNSET_OPT(y);
266 CHECK_UNSET_OPT(w);
267 CHECK_UNSET_OPT(h);
268
269 s->band = 1;
270
271 av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
272 s->x, s->y, s->w, s->h, s->band, s->show);
273
274 s->w += s->band*2;
275 s->h += s->band*2;
276 s->x -= s->band;
277 s->y -= s->band;
278
279 return 0;
280 }
281
config_input(AVFilterLink * inlink)282 static int config_input(AVFilterLink *inlink)
283 {
284 DelogoContext *s = inlink->dst->priv;
285
286 /* Check whether the logo area fits in the frame */
287 if (s->x + (s->band - 1) < 0 || s->x + s->w - (s->band*2 - 2) > inlink->w ||
288 s->y + (s->band - 1) < 0 || s->y + s->h - (s->band*2 - 2) > inlink->h) {
289 av_log(s, AV_LOG_ERROR, "Logo area is outside of the frame.\n");
290 return AVERROR(EINVAL);
291 }
292
293 return 0;
294 }
295
filter_frame(AVFilterLink * inlink,AVFrame * in)296 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
297 {
298 DelogoContext *s = inlink->dst->priv;
299 AVFilterLink *outlink = inlink->dst->outputs[0];
300 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
301 AVFrame *out;
302 int hsub0 = desc->log2_chroma_w;
303 int vsub0 = desc->log2_chroma_h;
304 int direct = 0;
305 int plane;
306 AVRational sar;
307 int ret;
308
309 s->var_values[VAR_N] = inlink->frame_count_out;
310 s->var_values[VAR_T] = TS2T(in->pts, inlink->time_base);
311 s->x = av_expr_eval(s->x_pexpr, s->var_values, s);
312 s->y = av_expr_eval(s->y_pexpr, s->var_values, s);
313 s->w = av_expr_eval(s->w_pexpr, s->var_values, s);
314 s->h = av_expr_eval(s->h_pexpr, s->var_values, s);
315
316 if (s->x + (s->band - 1) <= 0 || s->x + s->w - (s->band*2 - 2) > inlink->w ||
317 s->y + (s->band - 1) <= 0 || s->y + s->h - (s->band*2 - 2) > inlink->h) {
318 av_log(s, AV_LOG_WARNING, "Logo area is outside of the frame,"
319 " auto set the area inside of the frame\n");
320 }
321
322 if (s->x + (s->band - 1) <= 0)
323 s->x = 1 + s->band;
324 if (s->y + (s->band - 1) <= 0)
325 s->y = 1 + s->band;
326 if (s->x + s->w - (s->band*2 - 2) > inlink->w)
327 s->w = inlink->w - s->x - (s->band*2 - 2);
328 if (s->y + s->h - (s->band*2 - 2) > inlink->h)
329 s->h = inlink->h - s->y - (s->band*2 - 2);
330
331 ret = config_input(inlink);
332 if (ret < 0) {
333 av_frame_free(&in);
334 return ret;
335 }
336
337 s->w += s->band*2;
338 s->h += s->band*2;
339 s->x -= s->band;
340 s->y -= s->band;
341
342 if (av_frame_is_writable(in)) {
343 direct = 1;
344 out = in;
345 } else {
346 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
347 if (!out) {
348 av_frame_free(&in);
349 return AVERROR(ENOMEM);
350 }
351
352 av_frame_copy_props(out, in);
353 }
354
355 sar = in->sample_aspect_ratio;
356 /* Assume square pixels if SAR is unknown */
357 if (!sar.num)
358 sar.num = sar.den = 1;
359
360 for (plane = 0; plane < desc->nb_components; plane++) {
361 int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
362 int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
363
364 apply_delogo(out->data[plane], out->linesize[plane],
365 in ->data[plane], in ->linesize[plane],
366 AV_CEIL_RSHIFT(inlink->w, hsub),
367 AV_CEIL_RSHIFT(inlink->h, vsub),
368 sar, s->x>>hsub, s->y>>vsub,
369 /* Up and left borders were rounded down, inject lost bits
370 * into width and height to avoid error accumulation */
371 AV_CEIL_RSHIFT(s->w + (s->x & ((1<<hsub)-1)), hsub),
372 AV_CEIL_RSHIFT(s->h + (s->y & ((1<<vsub)-1)), vsub),
373 s->band>>FFMIN(hsub, vsub),
374 s->show, direct);
375 }
376
377 if (!direct)
378 av_frame_free(&in);
379
380 return ff_filter_frame(outlink, out);
381 }
382
383 static const AVFilterPad avfilter_vf_delogo_inputs[] = {
384 {
385 .name = "default",
386 .type = AVMEDIA_TYPE_VIDEO,
387 .filter_frame = filter_frame,
388 .config_props = config_input,
389 },
390 { NULL }
391 };
392
393 static const AVFilterPad avfilter_vf_delogo_outputs[] = {
394 {
395 .name = "default",
396 .type = AVMEDIA_TYPE_VIDEO,
397 },
398 { NULL }
399 };
400
401 AVFilter ff_vf_delogo = {
402 .name = "delogo",
403 .description = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
404 .priv_size = sizeof(DelogoContext),
405 .priv_class = &delogo_class,
406 .init = init,
407 .uninit = uninit,
408 .query_formats = query_formats,
409 .inputs = avfilter_vf_delogo_inputs,
410 .outputs = avfilter_vf_delogo_outputs,
411 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
412 };
413