git.sesse.net Git - ffmpeg/blob - libavfilter/vf_delogo.c

   1 /*
   2  * Copyright (c) 2002 Jindrich Makovicka <makovick@gmail.com>
   3  * Copyright (c) 2011 Stefano Sabatini
   4  *
   5  * This file is part of FFmpeg.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 /**
  23  * @file
  24  * A very simple tv station logo remover
  25  * Ported from MPlayer libmpcodecs/vf_delogo.c.
  26  */
  27
  28 #include "libavutil/common.h"
  29 #include "libavutil/imgutils.h"
  30 #include "libavutil/opt.h"
  31 #include "libavutil/pixdesc.h"
  32 #include "avfilter.h"
  33 #include "formats.h"
  34 #include "internal.h"
  35 #include "video.h"
  36
  37 /**
  38  * Apply a simple delogo algorithm to the image in src and put the
  39  * result in dst.
  40  *
  41  * The algorithm is only applied to the region specified by the logo
  42  * parameters.
  43  *
  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
  52  *               parameters tweaking
  53  * @param direct if non-zero perform in-place processing
  54  */
  55 static void apply_delogo(uint8_t *dst, int dst_linesize,
  56                          uint8_t *src, int src_linesize,
  57                          int w, int h,
  58                          int logo_x, int logo_y, int logo_w, int logo_h,
  59                          int band, int show, int direct)
  60 {
  61     int x, y;
  62     int interp, dist;
  63     uint8_t *xdst, *xsrc;
  64
  65     uint8_t *topleft, *botleft, *topright;
  66     int xclipl, xclipr, yclipt, yclipb;
  67     int logo_x1, logo_x2, logo_y1, logo_y2;
  68
  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);
  73
  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;
  78
  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;
  82
  83     if (!direct)
  84         av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
  85
  86     dst += (logo_y1 + 1) * dst_linesize;
  87     src += (logo_y1 + 1) * src_linesize;
  88
  89     for (y = logo_y1+1; y < logo_y2-1; y++) {
  90         for (x = logo_x1+1,
  91              xdst = dst+logo_x1+1,
  92              xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
  93             interp =
  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
  97                 +
  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
 101                 +
 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
 105                 +
 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;
 109             interp /= 6;
 110
 111             if (y >= logo_y+band && y < logo_y+logo_h-band &&
 112                 x >= logo_x+band && x < logo_x+logo_w-band) {
 113                 *xdst = interp;
 114             } else {
 115                 dist = 0;
 116                 if      (x < logo_x+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));
 120
 121                 if      (y < logo_y+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));
 125
 126                 *xdst = (*xsrc*dist + interp*(band-dist))/band;
 127                 if (show && (dist == band-1))
 128                     *xdst = 0;
 129             }
 130         }
 131
 132         dst += dst_linesize;
 133         src += src_linesize;
 134     }
 135 }
 136
 137 typedef struct {
 138     const AVClass *class;
 139     int x, y, w, h, band, show;
 140 }  DelogoContext;
 141
 142 #define OFFSET(x) offsetof(DelogoContext, x)
 143 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 144
 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 },
 153     { NULL },
 154 };
 155
 156 AVFILTER_DEFINE_CLASS(delogo);
 157
 158 static int query_formats(AVFilterContext *ctx)
 159 {
 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,
 164         AV_PIX_FMT_NONE
 165     };
 166
 167     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 168     return 0;
 169 }
 170
 171 static av_cold int init(AVFilterContext *ctx)
 172 {
 173     DelogoContext *s = ctx->priv;
 174
 175 #define CHECK_UNSET_OPT(opt)                                            \
 176     if (s->opt == -1) {                                            \
 177         av_log(s, AV_LOG_ERROR, "Option %s was not set.\n", #opt); \
 178         return AVERROR(EINVAL);                                         \
 179     }
 180     CHECK_UNSET_OPT(x);
 181     CHECK_UNSET_OPT(y);
 182     CHECK_UNSET_OPT(w);
 183     CHECK_UNSET_OPT(h);
 184
 185     if (s->band < 0 || s->show) {
 186         s->show = 1;
 187         s->band = 4;
 188     }
 189
 190     av_log(ctx, AV_LOG_VERBOSE, "x:%d y:%d, w:%d h:%d band:%d show:%d\n",
 191            s->x, s->y, s->w, s->h, s->band, s->show);
 192
 193     s->w += s->band*2;
 194     s->h += s->band*2;
 195     s->x -= s->band;
 196     s->y -= s->band;
 197
 198     return 0;
 199 }
 200
 201 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
 202 {
 203     DelogoContext *s = inlink->dst->priv;
 204     AVFilterLink *outlink = inlink->dst->outputs[0];
 205     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 206     AVFrame *out;
 207     int hsub0 = desc->log2_chroma_w;
 208     int vsub0 = desc->log2_chroma_h;
 209     int direct = 0;
 210     int plane;
 211
 212     if (av_frame_is_writable(in)) {
 213         direct = 1;
 214         out = in;
 215     } else {
 216         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
 217         if (!out) {
 218             av_frame_free(&in);
 219             return AVERROR(ENOMEM);
 220         }
 221
 222         av_frame_copy_props(out, in);
 223     }
 224
 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;
 228
 229         apply_delogo(out->data[plane], out->linesize[plane],
 230                      in ->data[plane], in ->linesize[plane],
 231                      FF_CEIL_RSHIFT(inlink->w, hsub),
 232                      FF_CEIL_RSHIFT(inlink->h, vsub),
 233                      s->x>>hsub, s->y>>vsub,
 234                      FF_CEIL_RSHIFT(s->w, hsub),
 235                      FF_CEIL_RSHIFT(s->h, vsub),
 236                      s->band>>FFMIN(hsub, vsub),
 237                      s->show, direct);
 238     }
 239
 240     if (!direct)
 241         av_frame_free(&in);
 242
 243     return ff_filter_frame(outlink, out);
 244 }
 245
 246 static const AVFilterPad avfilter_vf_delogo_inputs[] = {
 247     {
 248         .name             = "default",
 249         .type             = AVMEDIA_TYPE_VIDEO,
 250         .get_video_buffer = ff_null_get_video_buffer,
 251         .filter_frame     = filter_frame,
 252     },
 253     { NULL }
 254 };
 255
 256 static const AVFilterPad avfilter_vf_delogo_outputs[] = {
 257     {
 258         .name = "default",
 259         .type = AVMEDIA_TYPE_VIDEO,
 260     },
 261     { NULL }
 262 };
 263
 264 AVFilter avfilter_vf_delogo = {
 265     .name          = "delogo",
 266     .description   = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
 267     .priv_size     = sizeof(DelogoContext),
 268     .priv_class    = &delogo_class,
 269     .init          = init,
 270     .query_formats = query_formats,
 271
 272     .inputs    = avfilter_vf_delogo_inputs,
 273     .outputs   = avfilter_vf_delogo_outputs,
 274     .flags     = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
 275 };