avfilter: add mergeplanes filter

Signed-off-by: Paul B Mahol <onemda@gmail.com>

Changelog

@@ -44,6 +44,7 @@ version <next>
 - Enhanced Low Delay AAC (ER AAC ELD) decoding (no LD SBR support)
 - Linux framebuffer output device
 - HEVC decoder, raw HEVC demuxer, HEVC demuxing in TS, Matroska and MP4
+- mergeplanes filter
 
 
 version 2.0:

MAINTAINERS

@@ -334,6 +334,7 @@ Filters:
   vf_extractplanes.c                    Paul B Mahol
   vf_histogram.c                        Paul B Mahol
   vf_il.c                               Paul B Mahol
+  vf_mergeplanes.c                      Paul B Mahol
   vf_psnr.c                             Paul B Mahol
   vf_scale.c                            Michael Niedermayer
   vf_separatefields.c                   Paul B Mahol

doc/filters.texi

@@ -5260,6 +5260,65 @@ lutyuv=y='bitand(val, 128+64+32)'
 @end example
 @end itemize
 
+@section mergeplanes
+
+Merge color channel components from several video streams.
+
+The filter accepts up to 4 input streams, and merge selected input
+planes to the output video.
+
+This filter accepts the following options:
+@table @option
+@item mapping
+Set input to output plane mapping. Default is @code{0}.
+
+The mappings is specified as a bitmap. It should be specified as a
+hexadecimal number in the form 0xAa[Bb[Cc[Dd]]]. 'Aa' describes the
+mapping for the first plane of the output stream. 'A' sets the number of
+the input stream to use (from 0 to 3), and 'a' the plane number of the
+corresponding input to use (from 0 to 3). The rest of the mappings is
+similar, 'Bb' describes the mapping for the output stream second
+plane, 'Cc' describes the mapping for the output stream third plane and
+'Dd' describes the mapping for the output stream fourth plane.
+
+@item format
+Set output pixel format. Default is @code{yuva444p}.
+@end table
+
+@subsection Examples
+
+@itemize
+@item
+Merge three gray video streams of same width and height into single video stream:
+@example
+[a0][a1][a2]mergeplanes=0x001020:yuv444p
+@end example
+
+@item
+Merge 1st yuv444p stream and 2nd gray video stream into yuva444p video stream:
+@example
+[a0][a1]mergeplanes=0x00010210:yuva444p
+@end example
+
+@item
+Swap Y and A plane in yuva444p stream:
+@example
+format=yuva444p,mergeplanes=0x03010200:yuva444p
+@end example
+
+@item
+Swap U and V plane in yuv420p stream:
+@example
+format=yuv420p,mergeplanes=0x000201:yuv420p
+@end example
+
+@item
+Cast a rgb24 clip to yuv444p:
+@example
+format=rgb24,mergeplanes=0x000102:yuv444p
+@end example
+@end itemize
+
 @section mcdeint
 
 Apply motion-compensation deinterlacing.

libavfilter/Makefile

@@ -158,6 +158,7 @@ OBJS-$(CONFIG_LUT_FILTER)                    += vf_lut.o
 OBJS-$(CONFIG_LUTRGB_FILTER)                 += vf_lut.o
 OBJS-$(CONFIG_LUTYUV_FILTER)                 += vf_lut.o
 OBJS-$(CONFIG_MCDEINT_FILTER)                += vf_mcdeint.o
+OBJS-$(CONFIG_MERGEPLANES_FILTER)            += vf_mergeplanes.o framesync.o
 OBJS-$(CONFIG_MP_FILTER)                     += vf_mp.o
 OBJS-$(CONFIG_MPDECIMATE_FILTER)             += vf_mpdecimate.o
 OBJS-$(CONFIG_NEGATE_FILTER)                 += vf_lut.o

libavfilter/allfilters.c

@@ -154,6 +154,7 @@ void avfilter_register_all(void)
     REGISTER_FILTER(LUTRGB,         lutrgb,         vf);
     REGISTER_FILTER(LUTYUV,         lutyuv,         vf);
     REGISTER_FILTER(MCDEINT,        mcdeint,        vf);
+    REGISTER_FILTER(MERGEPLANES,    mergeplanes,    vf);
     REGISTER_FILTER(MP,             mp,             vf);
     REGISTER_FILTER(MPDECIMATE,     mpdecimate,     vf);
     REGISTER_FILTER(NEGATE,         negate,         vf);

libavfilter/version.h

@@ -30,7 +30,7 @@
 #include "libavutil/avutil.h"
 
 #define LIBAVFILTER_VERSION_MAJOR  3
-#define LIBAVFILTER_VERSION_MINOR  89
+#define LIBAVFILTER_VERSION_MINOR  90
 #define LIBAVFILTER_VERSION_MICRO 100
 
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \

libavfilter/vf_mergeplanes.c

+/*
+ * Copyright (c) 2013 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/avassert.h"
+#include "libavutil/avstring.h"
+#include "libavutil/imgutils.h"
+#include "libavutil/opt.h"
+#include "libavutil/pixdesc.h"
+#include "avfilter.h"
+#include "internal.h"
+#include "framesync.h"
+
+typedef struct InputParam {
+    int depth[4];
+    int nb_planes;
+    int planewidth[4];
+    int planeheight[4];
+} InputParam;
+
+typedef struct MergePlanesContext {
+    const AVClass *class;
+    int64_t mapping;
+    const enum AVPixelFormat out_fmt;
+    int nb_inputs;
+    int nb_planes;
+    int planewidth[4];
+    int planeheight[4];
+    int map[4][2];
+    const AVPixFmtDescriptor *outdesc;
+
+    FFFrameSync fs;
+    FFFrameSyncIn fsin[3]; /* must be immediately after fs */
+} MergePlanesContext;
+
+#define OFFSET(x) offsetof(MergePlanesContext, x)
+#define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
+static const AVOption mergeplanes_options[] = {
+    { "mapping", "set input to output plane mapping", OFFSET(mapping), AV_OPT_TYPE_INT, {.i64=0}, 0, 0x33333333, FLAGS },
+    { "format", "set output pixel format", OFFSET(out_fmt), AV_OPT_TYPE_PIXEL_FMT, {.i64=AV_PIX_FMT_YUVA444P}, .flags=FLAGS },
+    { NULL }
+};
+
+AVFILTER_DEFINE_CLASS(mergeplanes);
+
+static int filter_frame(AVFilterLink *inlink, AVFrame *in)
+{
+    MergePlanesContext *s = inlink->dst->priv;
+    return ff_framesync_filter_frame(&s->fs, inlink, in);
+}
+
+static av_cold int init(AVFilterContext *ctx)
+{
+    MergePlanesContext *s = ctx->priv;
+    int64_t m = s->mapping;
+    int i, ret;
+
+    s->outdesc = av_pix_fmt_desc_get(s->out_fmt);
+    if (!(s->outdesc->flags & AV_PIX_FMT_FLAG_PLANAR) ||
+        s->outdesc->nb_components < 2) {
+        av_log(ctx, AV_LOG_ERROR, "Only planar formats with more than one component are supported.\n");
+        return AVERROR(EINVAL);
+    }
+    s->nb_planes = av_pix_fmt_count_planes(s->out_fmt);
+
+    for (i = s->nb_planes - 1; i >= 0; i--) {
+        s->map[i][0] = m & 0xf;
+        m >>= 4;
+        s->map[i][1] = m & 0xf;
+        m >>= 4;
+
+        if (s->map[i][0] > 3 || s->map[i][1] > 3) {
+            av_log(ctx, AV_LOG_ERROR, "Mapping with out of range input and/or plane number.\n");
+            return AVERROR(EINVAL);
+        }
+
+        s->nb_inputs = FFMAX(s->nb_inputs, s->map[i][1] + 1);
+    }
+
+    av_assert0(s->nb_inputs && s->nb_inputs <= 4);
+
+    for (i = 0; i < s->nb_inputs; i++) {
+        AVFilterPad pad = { 0 };
+
+        pad.type = AVMEDIA_TYPE_VIDEO;
+        pad.name = av_asprintf("in%d", i);
+        if (!pad.name)
+            return AVERROR(ENOMEM);
+        pad.filter_frame = filter_frame;
+
+        if ((ret = ff_insert_inpad(ctx, i, &pad)) < 0){
+            av_freep(&pad.name);
+            return ret;
+        }
+    }
+
+    return 0;
+}
+
+static int query_formats(AVFilterContext *ctx)
+{
+    MergePlanesContext *s = ctx->priv;
+    AVFilterFormats *formats = NULL;
+    int i;
+
+    s->outdesc = av_pix_fmt_desc_get(s->out_fmt);
+    for (i = 0; i < AV_PIX_FMT_NB; i++) {
+        const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(i);
+        if (desc->comp[0].depth_minus1 == s->outdesc->comp[0].depth_minus1 &&
+            av_pix_fmt_count_planes(i) == desc->nb_components)
+            ff_add_format(&formats, i);
+    }
+
+    for (i = 0; i < s->nb_inputs; i++)
+        ff_formats_ref(formats, &ctx->inputs[i]->out_formats);
+
+    formats = NULL;
+    ff_add_format(&formats, s->out_fmt);
+    ff_formats_ref(formats, &ctx->outputs[0]->in_formats);
+
+    return 0;
+}
+
+static int process_frame(FFFrameSync *fs)
+{
+    AVFilterContext *ctx = fs->parent;
+    AVFilterLink *outlink = ctx->outputs[0];
+    MergePlanesContext *s = fs->opaque;
+    AVFrame *in[4] = { NULL };
+    AVFrame *out;
+    int i, ret;
+
+    for (i = 0; i < s->nb_inputs; i++) {
+        if ((ret = ff_framesync_get_frame(&s->fs, i, &in[i], 0)) < 0)
+            return ret;
+    }
+
+    out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
+    if (!out)
+        return AVERROR(ENOMEM);
+    out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
+
+    for (i = 0; i < s->nb_planes; i++) {
+        const int input = s->map[i][1];
+        const int plane = s->map[i][0];
+
+        av_image_copy_plane(out->data[i], out->linesize[i],
+                            in[input]->data[plane], in[input]->linesize[plane],
+                            s->planewidth[i], s->planeheight[i]);
+    }
+
+    return ff_filter_frame(outlink, out);
+}
+
+static int config_output(AVFilterLink *outlink)
+{
+    AVFilterContext *ctx = outlink->src;
+    MergePlanesContext *s = ctx->priv;
+    InputParam inputsp[4];
+    FFFrameSyncIn *in;
+    int i;
+
+    ff_framesync_init(&s->fs, ctx, s->nb_inputs);
+    in = s->fs.in;
+    s->fs.opaque = s;
+    s->fs.on_event = process_frame;
+
+    outlink->w = ctx->inputs[0]->w;
+    outlink->h = ctx->inputs[0]->h;
+    outlink->time_base = ctx->inputs[0]->time_base;
+    outlink->frame_rate = ctx->inputs[0]->frame_rate;
+    outlink->sample_aspect_ratio = ctx->inputs[0]->sample_aspect_ratio;
+
+    s->planewidth[1]  =
+    s->planewidth[2]  = FF_CEIL_RSHIFT(outlink->w, s->outdesc->log2_chroma_w);
+    s->planewidth[0]  =
+    s->planewidth[3]  = outlink->w;
+    s->planeheight[1] =
+    s->planeheight[2] = FF_CEIL_RSHIFT(outlink->h, s->outdesc->log2_chroma_h);
+    s->planeheight[0] =
+    s->planeheight[3] = outlink->h;
+
+    for (i = 0; i < s->nb_inputs; i++) {
+        InputParam *inputp = &inputsp[i];
+        AVFilterLink *inlink = ctx->inputs[i];
+        const AVPixFmtDescriptor *indesc = av_pix_fmt_desc_get(inlink->format);
+        int j;
+
+        if (outlink->sample_aspect_ratio.num != inlink->sample_aspect_ratio.num ||
+            outlink->sample_aspect_ratio.den != inlink->sample_aspect_ratio.den) {
+            av_log(ctx, AV_LOG_ERROR, "input #%d link %s SAR %d:%d "
+                                      "does not match output link %s SAR %d:%d\n",
+                                      i, ctx->input_pads[i].name,
+                                      inlink->sample_aspect_ratio.num,
+                                      inlink->sample_aspect_ratio.den,
+                                      ctx->output_pads[0].name,
+                                      outlink->sample_aspect_ratio.num,
+                                      outlink->sample_aspect_ratio.den);
+            return AVERROR(EINVAL);
+        }
+
+        inputp->planewidth[1]  =
+        inputp->planewidth[2]  = FF_CEIL_RSHIFT(inlink->w, indesc->log2_chroma_w);
+        inputp->planewidth[0]  =
+        inputp->planewidth[3]  = inlink->w;
+        inputp->planeheight[1] =
+        inputp->planeheight[2] = FF_CEIL_RSHIFT(inlink->h, indesc->log2_chroma_h);
+        inputp->planeheight[0] =
+        inputp->planeheight[3] = inlink->h;
+        inputp->nb_planes = av_pix_fmt_count_planes(inlink->format);
+
+        for (j = 0; j < inputp->nb_planes; j++)
+            inputp->depth[j] = indesc->comp[j].depth_minus1 + 1;
+
+        in[i].time_base = inlink->time_base;
+        in[i].sync   = 1;
+        in[i].before = EXT_STOP;
+        in[i].after  = EXT_STOP;
+    }
+
+    for (i = 0; i < s->nb_planes; i++) {
+        const int input = s->map[i][1];
+        const int plane = s->map[i][0];
+        InputParam *inputp = &inputsp[input];
+
+        if (plane + 1 > inputp->nb_planes) {
+            av_log(ctx, AV_LOG_ERROR, "input %d does not have %d plane\n",
+                                      input, plane);
+            goto fail;
+        }
+        if (s->outdesc->comp[i].depth_minus1 + 1 != inputp->depth[plane]) {
+            av_log(ctx, AV_LOG_ERROR, "output plane %d depth %d does not "
+                                      "match input %d plane %d depth %d\n",
+                                      i, s->outdesc->comp[i].depth_minus1 + 1,
+                                      input, plane, inputp->depth[plane]);
+            goto fail;
+        }
+        if (s->planewidth[i] != inputp->planewidth[plane]) {
+            av_log(ctx, AV_LOG_ERROR, "output plane %d width %d does not "
+                                      "match input %d plane %d width %d\n",
+                                      i, s->planewidth[i],
+                                      input, plane, inputp->planewidth[plane]);
+            goto fail;
+        }
+        if (s->planeheight[i] != inputp->planeheight[plane]) {
+            av_log(ctx, AV_LOG_ERROR, "output plane %d height %d does not "
+                                      "match input %d plane %d height %d\n",
+                                      i, s->planeheight[i],
+                                      input, plane, inputp->planeheight[plane]);
+            goto fail;
+        }
+    }
+
+    return ff_framesync_configure(&s->fs);
+fail:
+    return AVERROR(EINVAL);
+}
+
+static int request_frame(AVFilterLink *outlink)
+{
+    MergePlanesContext *s = outlink->src->priv;
+    return ff_framesync_request_frame(&s->fs, outlink);
+}
+
+static av_cold void uninit(AVFilterContext *ctx)
+{
+    MergePlanesContext *s = ctx->priv;
+    int i;
+
+    ff_framesync_uninit(&s->fs);
+
+    for (i = 0; i < ctx->nb_inputs; i++)
+        av_freep(&ctx->input_pads[i].name);
+}
+
+static const AVFilterPad mergeplanes_outputs[] = {
+    {
+        .name          = "default",
+        .type          = AVMEDIA_TYPE_VIDEO,
+        .config_props  = config_output,
+        .request_frame = request_frame,
+    },
+    { NULL }
+};
+
+AVFilter avfilter_vf_mergeplanes = {
+    .name          = "mergeplanes",
+    .description   = NULL_IF_CONFIG_SMALL("Merge planes."),
+    .priv_size     = sizeof(MergePlanesContext),
+    .priv_class    = &mergeplanes_class,
+    .init          = init,
+    .uninit        = uninit,
+    .query_formats = query_formats,
+    .inputs        = NULL,
+    .outputs       = mergeplanes_outputs,
+    .flags         = AVFILTER_FLAG_DYNAMIC_INPUTS,
+};