libavfilter/vf_maskedmerge.c
691a7df3
 /*
  * Copyright (c) 2015 Paul B Mahol
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include "libavutil/imgutils.h"
 #include "libavutil/pixdesc.h"
 #include "libavutil/opt.h"
 #include "avfilter.h"
 #include "formats.h"
 #include "internal.h"
 #include "video.h"
160556c9
 #include "maskedmerge.h"
691a7df3
 
 #define OFFSET(x) offsetof(MaskedMergeContext, x)
 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 
 static const AVOption maskedmerge_options[] = {
     { "planes", "set planes", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=0xF}, 0, 0xF, FLAGS },
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(maskedmerge);
 
 static int query_formats(AVFilterContext *ctx)
 {
     static const enum AVPixelFormat pix_fmts[] = {
         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
68dc0c13
         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
691a7df3
         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
bac508fe
         AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY16,
691a7df3
         AV_PIX_FMT_NONE
     };
 
6aaac24d
     return ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
691a7df3
 }
 
 static int process_frame(FFFrameSync *fs)
 {
     AVFilterContext *ctx = fs->parent;
     MaskedMergeContext *s = fs->opaque;
     AVFilterLink *outlink = ctx->outputs[0];
     AVFrame *out, *base, *overlay, *mask;
     int ret;
 
5f5dcf44
     if ((ret = ff_framesync_get_frame(&s->fs, 0, &base,    0)) < 0 ||
         (ret = ff_framesync_get_frame(&s->fs, 1, &overlay, 0)) < 0 ||
         (ret = ff_framesync_get_frame(&s->fs, 2, &mask,    0)) < 0)
691a7df3
         return ret;
 
     if (ctx->is_disabled) {
         out = av_frame_clone(base);
         if (!out)
             return AVERROR(ENOMEM);
     } else {
1da15740
         int p;
 
691a7df3
         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
         if (!out)
             return AVERROR(ENOMEM);
         av_frame_copy_props(out, base);
 
1da15740
         for (p = 0; p < s->nb_planes; p++) {
             if (!((1 << p) & s->planes)) {
                 av_image_copy_plane(out->data[p], out->linesize[p], base->data[p], base->linesize[p],
f4218d93
                                     s->linesize[p], s->height[p]);
1da15740
                 continue;
             }
 
160556c9
             s->maskedmerge(base->data[p], overlay->data[p],
                            mask->data[p], out->data[p],
                            base->linesize[p], overlay->linesize[p],
                            mask->linesize[p], out->linesize[p],
30ce6fd1
                            s->width[p], s->height[p],
160556c9
                            s->half, s->depth);
1da15740
         }
691a7df3
     }
     out->pts = av_rescale_q(base->pts, s->fs.time_base, outlink->time_base);
 
     return ff_filter_frame(outlink, out);
 }
 
160556c9
 static void maskedmerge8(const uint8_t *bsrc, const uint8_t *osrc,
                          const uint8_t *msrc, uint8_t *dst,
                          ptrdiff_t blinesize, ptrdiff_t olinesize,
                          ptrdiff_t mlinesize, ptrdiff_t dlinesize,
                          int w, int h,
                          int half, int shift)
691a7df3
 {
1da15740
     int x, y;
691a7df3
 
1da15740
     for (y = 0; y < h; y++) {
         for (x = 0; x < w; x++) {
160556c9
             dst[x] = bsrc[x] + ((msrc[x] * (osrc[x] - bsrc[x]) + 128) >> 8);
691a7df3
         }
1da15740
 
         dst  += dlinesize;
         bsrc += blinesize;
         osrc += olinesize;
         msrc += mlinesize;
691a7df3
     }
 }
 
160556c9
 static void maskedmerge16(const uint8_t *bbsrc, const uint8_t *oosrc,
                           const uint8_t *mmsrc, uint8_t *ddst,
                           ptrdiff_t blinesize, ptrdiff_t olinesize,
                           ptrdiff_t mlinesize, ptrdiff_t dlinesize,
                           int w, int h,
                           int half, int shift)
691a7df3
 {
1da15740
     const uint16_t *bsrc = (const uint16_t *)bbsrc;
     const uint16_t *osrc = (const uint16_t *)oosrc;
     const uint16_t *msrc = (const uint16_t *)mmsrc;
     uint16_t *dst = (uint16_t *)ddst;
     int x, y;
 
     for (y = 0; y < h; y++) {
         for (x = 0; x < w; x++) {
160556c9
             dst[x] = bsrc[x] + ((msrc[x] * (osrc[x] - bsrc[x]) + half) >> shift);
691a7df3
         }
 
1da15740
         dst  += dlinesize / 2;
         bsrc += blinesize / 2;
         osrc += olinesize / 2;
         msrc += mlinesize / 2;
691a7df3
     }
 }
 
 static int config_input(AVFilterLink *inlink)
 {
     AVFilterContext *ctx = inlink->dst;
     MaskedMergeContext *s = ctx->priv;
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
     int vsub, hsub;
 
     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
 
     hsub = desc->log2_chroma_w;
     vsub = desc->log2_chroma_h;
21f94684
     s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
691a7df3
     s->height[0] = s->height[3] = inlink->h;
21f94684
     s->width[1]  = s->width[2]  = AV_CEIL_RSHIFT(inlink->w, hsub);
691a7df3
     s->width[0]  = s->width[3]  = inlink->w;
 
     s->depth = desc->comp[0].depth;
160556c9
     s->half = (1 << s->depth) / 2;
691a7df3
 
     if (desc->comp[0].depth == 8)
         s->maskedmerge = maskedmerge8;
     else
         s->maskedmerge = maskedmerge16;
 
160556c9
     if (ARCH_X86)
         ff_maskedmerge_init_x86(s);
 
691a7df3
     return 0;
 }
 
 static int config_output(AVFilterLink *outlink)
 {
     AVFilterContext *ctx = outlink->src;
     MaskedMergeContext *s = ctx->priv;
     AVFilterLink *base = ctx->inputs[0];
     AVFilterLink *overlay = ctx->inputs[1];
     AVFilterLink *mask = ctx->inputs[2];
     FFFrameSyncIn *in;
     int ret;
 
     if (base->format != overlay->format ||
         base->format != mask->format) {
         av_log(ctx, AV_LOG_ERROR, "inputs must be of same pixel format\n");
         return AVERROR(EINVAL);
     }
789731af
     if (base->w != overlay->w || base->h != overlay->h ||
         base->w != mask->w    || base->h != mask->h) {
691a7df3
         av_log(ctx, AV_LOG_ERROR, "First input link %s parameters "
789731af
                "(size %dx%d) do not match the corresponding "
                "second input link %s parameters (size %dx%d) "
                "and/or third input link %s parameters (size %dx%d)\n",
691a7df3
                ctx->input_pads[0].name, base->w, base->h,
                ctx->input_pads[1].name, overlay->w, overlay->h,
789731af
                ctx->input_pads[2].name, mask->w, mask->h);
691a7df3
         return AVERROR(EINVAL);
     }
 
     outlink->w = base->w;
     outlink->h = base->h;
     outlink->time_base = base->time_base;
     outlink->sample_aspect_ratio = base->sample_aspect_ratio;
     outlink->frame_rate = base->frame_rate;
 
f4218d93
     if ((ret = av_image_fill_linesizes(s->linesize, outlink->format, outlink->w)) < 0)
         return ret;
 
5f5dcf44
     if ((ret = ff_framesync_init(&s->fs, ctx, 3)) < 0)
691a7df3
         return ret;
 
     in = s->fs.in;
     in[0].time_base = base->time_base;
     in[1].time_base = overlay->time_base;
     in[2].time_base = mask->time_base;
     in[0].sync   = 1;
     in[0].before = EXT_STOP;
     in[0].after  = EXT_INFINITY;
     in[1].sync   = 1;
     in[1].before = EXT_STOP;
     in[1].after  = EXT_INFINITY;
     in[2].sync   = 1;
     in[2].before = EXT_STOP;
     in[2].after  = EXT_INFINITY;
     s->fs.opaque   = s;
     s->fs.on_event = process_frame;
 
5f5dcf44
     return ff_framesync_configure(&s->fs);
691a7df3
 }
 
a5e3b0c1
 static int activate(AVFilterContext *ctx)
691a7df3
 {
a5e3b0c1
     MaskedMergeContext *s = ctx->priv;
5f5dcf44
     return ff_framesync_activate(&s->fs);
691a7df3
 }
 
 static av_cold void uninit(AVFilterContext *ctx)
 {
     MaskedMergeContext *s = ctx->priv;
 
5f5dcf44
     ff_framesync_uninit(&s->fs);
691a7df3
 }
 
 static const AVFilterPad maskedmerge_inputs[] = {
     {
         .name         = "base",
         .type         = AVMEDIA_TYPE_VIDEO,
         .config_props = config_input,
     },
     {
         .name         = "overlay",
         .type         = AVMEDIA_TYPE_VIDEO,
     },
     {
         .name         = "mask",
         .type         = AVMEDIA_TYPE_VIDEO,
     },
     { NULL }
 };
 
 static const AVFilterPad maskedmerge_outputs[] = {
     {
         .name          = "default",
         .type          = AVMEDIA_TYPE_VIDEO,
         .config_props  = config_output,
     },
     { NULL }
 };
 
 AVFilter ff_vf_maskedmerge = {
     .name          = "maskedmerge",
     .description   = NULL_IF_CONFIG_SMALL("Merge first stream with second stream using third stream as mask."),
     .priv_size     = sizeof(MaskedMergeContext),
     .uninit        = uninit,
     .query_formats = query_formats,
a5e3b0c1
     .activate      = activate,
691a7df3
     .inputs        = maskedmerge_inputs,
     .outputs       = maskedmerge_outputs,
     .priv_class    = &maskedmerge_class,
     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
 };