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/imgutils.h"
  29 #include "libavutil/opt.h"
  30 #include "libavutil/pixdesc.h"
  31 #include "avfilter.h"
  32 #include "video.h"
  33
  34 /**
  35  * Apply a simple delogo algorithm to the image in dst and put the
  36  * result in src.
  37  *
  38  * The algorithm is only applied to the region specified by the logo
  39  * parameters.
  40  *
  41  * @param w      width of the input image
  42  * @param h      height of the input image
  43  * @param logo_x x coordinate of the top left corner of the logo region
  44  * @param logo_y y coordinate of the top left corner of the logo region
  45  * @param logo_w width of the logo
  46  * @param logo_h height of the logo
  47  * @param band   the size of the band around the processed area
  48  * @param show   show a rectangle around the processed area, useful for
  49  *               parameters tweaking
  50  * @param direct if non-zero perform in-place processing
  51  */
  52 static void apply_delogo(uint8_t *dst, int dst_linesize,
  53                          uint8_t *src, int src_linesize,
  54                          int w, int h,
  55                          int logo_x, int logo_y, int logo_w, int logo_h,
  56                          int band, int show, int direct)
  57 {
  58     int x, y;
  59     int interp, dist;
  60     uint8_t *xdst, *xsrc;
  61
  62     uint8_t *topleft, *botleft, *topright;
  63     int xclipl, xclipr, yclipt, yclipb;
  64     int logo_x1, logo_x2, logo_y1, logo_y2;
  65
  66     xclipl = FFMAX(-logo_x, 0);
  67     xclipr = FFMAX(logo_x+logo_w-w, 0);
  68     yclipt = FFMAX(-logo_y, 0);
  69     yclipb = FFMAX(logo_y+logo_h-h, 0);
  70
  71     logo_x1 = logo_x + xclipl;
  72     logo_x2 = logo_x + logo_w - xclipr;
  73     logo_y1 = logo_y + yclipt;
  74     logo_y2 = logo_y + logo_h - yclipb;
  75
  76     topleft  = src+logo_y1     * src_linesize+logo_x1;
  77     topright = src+logo_y1     * src_linesize+logo_x2-1;
  78     botleft  = src+(logo_y2-1) * src_linesize+logo_x1;
  79
  80     dst += (logo_y1+1)*dst_linesize;
  81     src += (logo_y1+1)*src_linesize;
  82
  83     if (!direct)
  84         av_image_copy_plane(dst, dst_linesize, src, src_linesize, w, h);
  85
  86     for (y = logo_y1+1; y < logo_y2-1; y++) {
  87         for (x = logo_x1+1,
  88              xdst = dst+logo_x1+1,
  89              xsrc = src+logo_x1+1; x < logo_x2-1; x++, xdst++, xsrc++) {
  90             interp =
  91                 (topleft[src_linesize*(y-logo_y  -yclipt)]   +
  92                  topleft[src_linesize*(y-logo_y-1-yclipt)]   +
  93                  topleft[src_linesize*(y-logo_y+1-yclipt)])  * (logo_w-(x-logo_x))/logo_w
  94                 +
  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                 +
  99                 (topleft[x-logo_x-xclipl]    +
 100                  topleft[x-logo_x-1-xclipl]  +
 101                  topleft[x-logo_x+1-xclipl]) * (logo_h-(y-logo_y))/logo_h
 102                 +
 103                 (botleft[x-logo_x-xclipl]    +
 104                  botleft[x-logo_x-1-xclipl]  +
 105                  botleft[x-logo_x+1-xclipl]) * (y-logo_y)/logo_h;
 106             interp /= 6;
 107
 108             if (y >= logo_y+band && y < logo_y+logo_h-band &&
 109                 x >= logo_x+band && x < logo_x+logo_w-band) {
 110                 *xdst = interp;
 111             } else {
 112                 dist = 0;
 113                 if      (x < logo_x+band)
 114                     dist = FFMAX(dist, logo_x-x+band);
 115                 else if (x >= logo_x+logo_w-band)
 116                     dist = FFMAX(dist, x-(logo_x+logo_w-1-band));
 117
 118                 if      (y < logo_y+band)
 119                     dist = FFMAX(dist, logo_y-y+band);
 120                 else if (y >= logo_y+logo_h-band)
 121                     dist = FFMAX(dist, y-(logo_y+logo_h-1-band));
 122
 123                 *xdst = (*xsrc*dist + interp*(band-dist))/band;
 124                 if (show && (dist == band-1))
 125                     *xdst = 0;
 126             }
 127         }
 128
 129         dst += dst_linesize;
 130         src += src_linesize;
 131     }
 132 }
 133
 134 typedef struct {
 135     const AVClass *class;
 136     int x, y, w, h, band, show;
 137 }  DelogoContext;
 138
 139 #define OFFSET(x) offsetof(DelogoContext, x)
 140
 141 static const AVOption delogo_options[]= {
 142     {"x",    "set logo x position",       OFFSET(x),    AV_OPT_TYPE_INT, {.dbl=-1}, -1, INT_MAX },
 143     {"y",    "set logo y position",       OFFSET(y),    AV_OPT_TYPE_INT, {.dbl=-1}, -1, INT_MAX },
 144     {"w",    "set logo width",            OFFSET(w),    AV_OPT_TYPE_INT, {.dbl=-1}, -1, INT_MAX },
 145     {"h",    "set logo height",           OFFSET(h),    AV_OPT_TYPE_INT, {.dbl=-1}, -1, INT_MAX },
 146     {"band", "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, {.dbl= 4}, -1, INT_MAX },
 147     {"t",    "set delogo area band size", OFFSET(band), AV_OPT_TYPE_INT, {.dbl= 4}, -1, INT_MAX },
 148     {"show", "show delogo area",          OFFSET(show), AV_OPT_TYPE_INT, {.dbl= 0},  0, 1       },
 149     {NULL},
 150 };
 151
 152 static const AVClass delogo_class = {
 153     .class_name = "DelogoContext",
 154     .item_name  = av_default_item_name,
 155     .option     = delogo_options,
 156 };
 157
 158 static int query_formats(AVFilterContext *ctx)
 159 {
 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,
 164         PIX_FMT_NONE
 165     };
 166
 167     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
 168     return 0;
 169 }
 170
 171 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
 172 {
 173     DelogoContext *delogo = ctx->priv;
 174     int ret = 0;
 175
 176     delogo->class = &delogo_class;
 177     av_opt_set_defaults(delogo);
 178
 179     if (args)
 180         ret = sscanf(args, "%d:%d:%d:%d:%d",
 181                      &delogo->x, &delogo->y, &delogo->w, &delogo->h, &delogo->band);
 182     if (ret == 5) {
 183         if (delogo->band < 0)
 184             delogo->show = 1;
 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);
 187         return ret;
 188     }
 189
 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);                                         \
 194     }
 195     CHECK_UNSET_OPT(x);
 196     CHECK_UNSET_OPT(y);
 197     CHECK_UNSET_OPT(w);
 198     CHECK_UNSET_OPT(h);
 199
 200     if (delogo->show)
 201         delogo->band = 4;
 202
 203     av_log(ctx, AV_LOG_INFO, "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);
 205
 206     delogo->w += delogo->band*2;
 207     delogo->h += delogo->band*2;
 208     delogo->x -= delogo->band;
 209     delogo->y -= delogo->band;
 210
 211     return 0;
 212 }
 213
 214 static void start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
 215 {
 216     AVFilterLink *outlink = inlink->dst->outputs[0];
 217     AVFilterBufferRef *outpicref;
 218
 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;
 225     } else
 226         outpicref = inpicref;
 227
 228     outlink->out_buf = outpicref;
 229     avfilter_start_frame(outlink, avfilter_ref_buffer(outpicref, ~0));
 230 }
 231
 232 static void null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir) { }
 233
 234 static void end_frame(AVFilterLink *inlink)
 235 {
 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;
 243     int plane;
 244
 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;
 248
 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);
 256     }
 257
 258     avfilter_draw_slice(outlink, 0, inlink->h, 1);
 259     avfilter_end_frame(outlink);
 260     avfilter_unref_buffer(inpicref);
 261     if (!direct)
 262         avfilter_unref_buffer(outpicref);
 263 }
 264
 265 AVFilter avfilter_vf_delogo = {
 266     .name          = "delogo",
 267     .description   = NULL_IF_CONFIG_SMALL("Remove logo from input video."),
 268     .priv_size     = sizeof(DelogoContext),
 269     .init          = init,
 270     .query_formats = query_formats,
 271
 272     .inputs    = (const AVFilterPad[]) {{ .name       = "default",
 273                                     .type             = AVMEDIA_TYPE_VIDEO,
 274                                     .get_video_buffer = ff_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 },
 280                                   { .name = NULL}},
 281     .outputs   = (const AVFilterPad[]) {{ .name       = "default",
 282                                     .type             = AVMEDIA_TYPE_VIDEO, },
 283                                   { .name = NULL}},
 284 };