FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vf_delogo.c
Go to the documentation of this file.
1 /*
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>
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 "avfilter.h"
35 #include "formats.h"
36 #include "internal.h"
37 #include "video.h"
38 
39 /**
40  * Apply a simple delogo algorithm to the image in src and put the
41  * result in dst.
42  *
43  * The algorithm is only applied to the region specified by the logo
44  * parameters.
45  *
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
54  * parameters tweaking
55  * @param direct if non-zero perform in-place processing
56  */
57 static void apply_delogo(uint8_t *dst, int dst_linesize,
58  uint8_t *src, int src_linesize,
59  int w, int h, AVRational sar,
60  int logo_x, int logo_y, int logo_w, int logo_h,
61  int band, int show, int direct)
62 {
63  int x, y, dist;
64  uint64_t interp, weightl, weightr, weightt, weightb;
65  uint8_t *xdst, *xsrc;
66 
67  uint8_t *topleft, *botleft, *topright;
68  unsigned int left_sample, right_sample;
69  int xclipl, xclipr, yclipt, yclipb;
70  int logo_x1, logo_x2, logo_y1, logo_y2;
71 
72  xclipl = FFMAX(-logo_x, 0);
73  xclipr = FFMAX(logo_x+logo_w-w, 0);
74  yclipt = FFMAX(-logo_y, 0);
75  yclipb = FFMAX(logo_y+logo_h-h, 0);
76 
77  logo_x1 = logo_x + xclipl;
78  logo_x2 = logo_x + logo_w - xclipr;
79  logo_y1 = logo_y + yclipt;
80  logo_y2 = logo_y + logo_h - yclipb;
81 
82  topleft = src+logo_y1 * src_linesize+logo_x1;
83  topright = src+logo_y1 * src_linesize+logo_x2-1;
84  botleft = src+(logo_y2-1) * src_linesize+logo_x1;
85 
86  if (!direct)
87  av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
88 
89  dst += (logo_y1 + 1) * dst_linesize;
90  src += (logo_y1 + 1) * src_linesize;
91 
92  for (y = logo_y1+1; y < logo_y2-1; y++) {
93  left_sample = topleft[src_linesize*(y-logo_y1)] +
94  topleft[src_linesize*(y-logo_y1-1)] +
95  topleft[src_linesize*(y-logo_y1+1)];
96  right_sample = topright[src_linesize*(y-logo_y1)] +
97  topright[src_linesize*(y-logo_y1-1)] +
98  topright[src_linesize*(y-logo_y1+1)];
99 
100  for (x = logo_x1+1,
101  xdst = dst+logo_x1+1,
102  xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
103 
104  /* Weighted interpolation based on relative distances, taking SAR into account */
105  weightl = (uint64_t) (logo_x2-1-x) * (y-logo_y1) * (logo_y2-1-y) * sar.den;
106  weightr = (uint64_t)(x-logo_x1) * (y-logo_y1) * (logo_y2-1-y) * sar.den;
107  weightt = (uint64_t)(x-logo_x1) * (logo_x2-1-x) * (logo_y2-1-y) * sar.num;
108  weightb = (uint64_t)(x-logo_x1) * (logo_x2-1-x) * (y-logo_y1) * sar.num;
109 
110  interp =
111  left_sample * weightl
112  +
113  right_sample * weightr
114  +
115  (topleft[x-logo_x1] +
116  topleft[x-logo_x1-1] +
117  topleft[x-logo_x1+1]) * weightt
118  +
119  (botleft[x-logo_x1] +
120  botleft[x-logo_x1-1] +
121  botleft[x-logo_x1+1]) * weightb;
122  interp /= (weightl + weightr + weightt + weightb) * 3U;
123 
124  if (y >= logo_y+band && y < logo_y+logo_h-band &&
125  x >= logo_x+band && x < logo_x+logo_w-band) {
126  *xdst = interp;
127  } else {
128  dist = 0;
129  if (x < logo_x+band)
130  dist = FFMAX(dist, logo_x-x+band);
131  else if (x >= logo_x+logo_w-band)
132  dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
133 
134  if (y < logo_y+band)
135  dist = FFMAX(dist, logo_y-y+band);
136  else if (y >= logo_y+logo_h-band)
137  dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
138 
139  *xdst = (*xsrc*dist + interp*(band-dist))/band;
140  if (show && (dist == band-1))
141  *xdst = 0;
142  }
143  }
144 
145  dst += dst_linesize;
146  src += src_linesize;
147  }
148 }
149 
150 typedef struct {
151  const AVClass *class;
152  int x, y, w, h, band, show;
153 } DelogoContext;
154 
155 #define OFFSET(x) offsetof(DelogoContext, x)
156 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
157 
158 static const AVOption delogo_options[]= {
159  { "x", "set logo x position", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
160  { "y", "set logo y position", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
161  { "w", "set logo width", OFFSET(w), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
162  { "h", "set logo height", OFFSET(h), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, FLAGS },
163  { "band", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 = 4 }, 1, INT_MAX, FLAGS },
164  { "t", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, { .i64 = 4 }, 1, INT_MAX, FLAGS },
165  { "show", "show delogo area", OFFSET(show), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, FLAGS },
166  { NULL },
167 };
168 
169 AVFILTER_DEFINE_CLASS(delogo);
170 
172 {
173  static const enum AVPixelFormat pix_fmts[] = {
178  };
179 
181  return 0;
182 }
183 
184 static av_cold int init(AVFilterContext *ctx)
185 {
186  DelogoContext *s = ctx->priv;
187 
188 #define CHECK_UNSET_OPT(opt) \
189  if (s->opt == -1) { \
190  av_log(s, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
191  return AVERROR(EINVAL); \
192  }
193  CHECK_UNSET_OPT(x);
195  CHECK_UNSET_OPT(w);
196  CHECK_UNSET_OPT(h);
197 
198  av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
199  s->x, s->y, s->w, s->h, s->band, s->show);
200 
201  s->w += s->band*2;
202  s->h += s->band*2;
203  s->x -= s->band;
204  s->y -= s->band;
205 
206  return 0;
207 }
208 
209 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
210 {
211  DelogoContext *s = inlink->dst->priv;
212  AVFilterLink *outlink = inlink->dst->outputs[0];
213  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
214  AVFrame *out;
215  int hsub0 = desc->log2_chroma_w;
216  int vsub0 = desc->log2_chroma_h;
217  int direct = 0;
218  int plane;
219  AVRational sar;
220 
221  if (av_frame_is_writable(in)) {
222  direct = 1;
223  out = in;
224  } else {
225  out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
226  if (!out) {
227  av_frame_free(&in);
228  return AVERROR(ENOMEM);
229  }
230 
231  av_frame_copy_props(out, in);
232  }
233 
234  sar = in->sample_aspect_ratio;
235  /* Assume square pixels if SAR is unknown */
236  if (!sar.num)
237  sar.num = sar.den = 1;
238 
239  for (plane = 0; plane < 4 && in->data[plane]; plane++) {
240  int hsub = plane == 1 || plane == 2 ? hsub0 : 0;
241  int vsub = plane == 1 || plane == 2 ? vsub0 : 0;
242 
243  apply_delogo(out->data[plane], out->linesize[plane],
244  in ->data[plane], in ->linesize[plane],
245  FF_CEIL_RSHIFT(inlink->w, hsub),
246  FF_CEIL_RSHIFT(inlink->h, vsub),
247  sar, s->x>>hsub, s->y>>vsub,
248  /* Up and left borders were rounded down, inject lost bits
249  * into width and height to avoid error accumulation */
250  FF_CEIL_RSHIFT(s->w + (s->x & ((1<<hsub)-1)), hsub),
251  FF_CEIL_RSHIFT(s->h + (s->y & ((1<<vsub)-1)), vsub),
252  s->band>>FFMIN(hsub, vsub),
253  s->show, direct);
254  }
255 
256  if (!direct)
257  av_frame_free(&in);
258 
259  return ff_filter_frame(outlink, out);
260 }
261 
263  {
264  .name = "default",
265  .type = AVMEDIA_TYPE_VIDEO,
266  .get_video_buffer = ff_null_get_video_buffer,
267  .filter_frame = filter_frame,
268  },
269  { NULL }
270 };
271 
273  {
274  .name = "default",
275  .type = AVMEDIA_TYPE_VIDEO,
276  },
277  { NULL }
278 };
279 
281  .name = "delogo",
282  .description = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
283  .priv_size = sizeof(DelogoContext),
284  .priv_class = &delogo_class,
285  .init = init,
287 
288  .inputs = avfilter_vf_delogo_inputs,
289  .outputs = avfilter_vf_delogo_outputs,
291 };