libavfilter/vf_extractplanes.c
ce322f4c
 /*
  * 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/avstring.h"
 #include "libavutil/imgutils.h"
 #include "libavutil/opt.h"
 #include "libavutil/pixdesc.h"
02aa0701
 
 #define FF_INTERNAL_FIELDS 1
 #include "libavfilter/framequeue.h"
 
ce322f4c
 #include "avfilter.h"
c4a5499d
 #include "drawutils.h"
ce322f4c
 #include "internal.h"
 
 #define PLANE_R 0x01
 #define PLANE_G 0x02
 #define PLANE_B 0x04
 #define PLANE_A 0x08
 #define PLANE_Y 0x10
 #define PLANE_U 0x20
 #define PLANE_V 0x40
 
ed93ed5e
 typedef struct ExtractPlanesContext {
ce322f4c
     const AVClass *class;
     int requested_planes;
     int map[4];
     int linesize[4];
fc40cdbf
     int is_packed;
c4a5499d
     int depth;
     int step;
ce322f4c
 } ExtractPlanesContext;
 
 #define OFFSET(x) offsetof(ExtractPlanesContext, x)
 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 static const AVOption extractplanes_options[] = {
     { "planes", "set planes",  OFFSET(requested_planes), AV_OPT_TYPE_FLAGS, {.i64=1}, 1, 0xff, FLAGS, "flags"},
     {      "y", "set luma plane",  0, AV_OPT_TYPE_CONST, {.i64=PLANE_Y}, 0, 0, FLAGS, "flags"},
     {      "u", "set u plane",     0, AV_OPT_TYPE_CONST, {.i64=PLANE_U}, 0, 0, FLAGS, "flags"},
     {      "v", "set v plane",     0, AV_OPT_TYPE_CONST, {.i64=PLANE_V}, 0, 0, FLAGS, "flags"},
     {      "r", "set red plane",   0, AV_OPT_TYPE_CONST, {.i64=PLANE_R}, 0, 0, FLAGS, "flags"},
c4a5499d
     {      "g", "set green plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_G}, 0, 0, FLAGS, "flags"},
ce322f4c
     {      "b", "set blue plane",  0, AV_OPT_TYPE_CONST, {.i64=PLANE_B}, 0, 0, FLAGS, "flags"},
     {      "a", "set alpha plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_A}, 0, 0, FLAGS, "flags"},
     { NULL }
 };
 
 AVFILTER_DEFINE_CLASS(extractplanes);
 
 static int query_formats(AVFilterContext *ctx)
 {
0ba844a0
     static const enum AVPixelFormat in_pixfmts_le[] = {
ce322f4c
         AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUV411P,
         AV_PIX_FMT_YUV440P,
         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVA420P,
         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P,
         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
be35b8b9
         AV_PIX_FMT_YUVJ411P,
ce322f4c
         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P,
         AV_PIX_FMT_YUV420P16LE, AV_PIX_FMT_YUVA420P16LE,
         AV_PIX_FMT_YUV422P16LE, AV_PIX_FMT_YUVA422P16LE,
         AV_PIX_FMT_YUV444P16LE, AV_PIX_FMT_YUVA444P16LE,
         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A,
0ba844a0
         AV_PIX_FMT_YA16LE, AV_PIX_FMT_GRAY16LE,
c4a5499d
         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
         AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
         AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
bba9bed3
         AV_PIX_FMT_RGB0, AV_PIX_FMT_BGR0,
         AV_PIX_FMT_0RGB, AV_PIX_FMT_0BGR,
c4a5499d
         AV_PIX_FMT_RGB48LE, AV_PIX_FMT_BGR48LE,
         AV_PIX_FMT_RGBA64LE, AV_PIX_FMT_BGRA64LE,
0ba844a0
         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
         AV_PIX_FMT_GBRP16LE, AV_PIX_FMT_GBRAP16LE,
46752d6b
         AV_PIX_FMT_YUV420P10LE,
         AV_PIX_FMT_YUV422P10LE,
         AV_PIX_FMT_YUV444P10LE,
         AV_PIX_FMT_YUV440P10LE,
         AV_PIX_FMT_YUVA420P10LE,
         AV_PIX_FMT_YUVA422P10LE,
         AV_PIX_FMT_YUVA444P10LE,
         AV_PIX_FMT_YUV420P12LE,
         AV_PIX_FMT_YUV422P12LE,
         AV_PIX_FMT_YUV444P12LE,
         AV_PIX_FMT_YUV440P12LE,
         AV_PIX_FMT_GBRP10LE, AV_PIX_FMT_GBRAP10LE,
         AV_PIX_FMT_GBRP12LE, AV_PIX_FMT_GBRAP12LE,
7bfbc2d7
         AV_PIX_FMT_YUV420P9LE,
         AV_PIX_FMT_YUV422P9LE,
         AV_PIX_FMT_YUV444P9LE,
         AV_PIX_FMT_YUVA420P9LE,
         AV_PIX_FMT_YUVA422P9LE,
         AV_PIX_FMT_YUVA444P9LE,
         AV_PIX_FMT_GBRP9LE,
0ba844a0
         AV_PIX_FMT_NONE,
     };
     static const enum AVPixelFormat in_pixfmts_be[] = {
         AV_PIX_FMT_YUV410P,
         AV_PIX_FMT_YUV411P,
         AV_PIX_FMT_YUV440P,
         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVA420P,
         AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P,
         AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
         AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
         AV_PIX_FMT_YUVJ411P,
         AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P,
         AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUVA420P16BE,
         AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUVA422P16BE,
         AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUVA444P16BE,
         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A,
         AV_PIX_FMT_YA16BE, AV_PIX_FMT_GRAY16BE,
         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
         AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
         AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
bba9bed3
         AV_PIX_FMT_RGB0, AV_PIX_FMT_BGR0,
         AV_PIX_FMT_0RGB, AV_PIX_FMT_0BGR,
0ba844a0
         AV_PIX_FMT_RGB48BE, AV_PIX_FMT_BGR48BE,
c4a5499d
         AV_PIX_FMT_RGBA64BE, AV_PIX_FMT_BGRA64BE,
1f2baec7
         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
0ba844a0
         AV_PIX_FMT_GBRP16BE, AV_PIX_FMT_GBRAP16BE,
46752d6b
         AV_PIX_FMT_YUV420P10BE,
         AV_PIX_FMT_YUV422P10BE,
         AV_PIX_FMT_YUV444P10BE,
         AV_PIX_FMT_YUV440P10BE,
         AV_PIX_FMT_YUVA420P10BE,
         AV_PIX_FMT_YUVA422P10BE,
         AV_PIX_FMT_YUVA444P10BE,
         AV_PIX_FMT_YUV420P12BE,
         AV_PIX_FMT_YUV422P12BE,
         AV_PIX_FMT_YUV444P12BE,
         AV_PIX_FMT_YUV440P12BE,
         AV_PIX_FMT_GBRP10BE, AV_PIX_FMT_GBRAP10BE,
         AV_PIX_FMT_GBRP12BE, AV_PIX_FMT_GBRAP12BE,
7bfbc2d7
         AV_PIX_FMT_YUV420P9BE,
         AV_PIX_FMT_YUV422P9BE,
         AV_PIX_FMT_YUV444P9BE,
         AV_PIX_FMT_YUVA420P9BE,
         AV_PIX_FMT_YUVA422P9BE,
         AV_PIX_FMT_YUVA444P9BE,
         AV_PIX_FMT_GBRP9BE,
ce322f4c
         AV_PIX_FMT_NONE,
     };
     static const enum AVPixelFormat out8_pixfmts[] = { AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE };
7bfbc2d7
     static const enum AVPixelFormat out9le_pixfmts[] = { AV_PIX_FMT_GRAY9LE, AV_PIX_FMT_NONE };
     static const enum AVPixelFormat out9be_pixfmts[] = { AV_PIX_FMT_GRAY9BE, AV_PIX_FMT_NONE };
46752d6b
     static const enum AVPixelFormat out10le_pixfmts[] = { AV_PIX_FMT_GRAY10LE, AV_PIX_FMT_NONE };
     static const enum AVPixelFormat out10be_pixfmts[] = { AV_PIX_FMT_GRAY10BE, AV_PIX_FMT_NONE };
     static const enum AVPixelFormat out12le_pixfmts[] = { AV_PIX_FMT_GRAY12LE, AV_PIX_FMT_NONE };
     static const enum AVPixelFormat out12be_pixfmts[] = { AV_PIX_FMT_GRAY12BE, AV_PIX_FMT_NONE };
ce322f4c
     static const enum AVPixelFormat out16le_pixfmts[] = { AV_PIX_FMT_GRAY16LE, AV_PIX_FMT_NONE };
     static const enum AVPixelFormat out16be_pixfmts[] = { AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_NONE };
0ba844a0
     const enum AVPixelFormat *out_pixfmts, *in_pixfmts;
ce322f4c
     const AVPixFmtDescriptor *desc;
     AVFilterFormats *avff;
6aaac24d
     int i, ret, depth = 0, be = 0;
ce322f4c
 
     if (!ctx->inputs[0]->in_formats ||
74cb7ef8
         !ctx->inputs[0]->in_formats->nb_formats) {
ce322f4c
         return AVERROR(EAGAIN);
     }
 
     avff = ctx->inputs[0]->in_formats;
     desc = av_pix_fmt_desc_get(avff->formats[0]);
5d8e836d
     depth = desc->comp[0].depth;
c7c71f95
     be = desc->flags & AV_PIX_FMT_FLAG_BE;
0ba844a0
     if (be) {
         in_pixfmts = in_pixfmts_be;
     } else {
         in_pixfmts = in_pixfmts_le;
     }
b872b98b
     if (!ctx->inputs[0]->out_formats)
         if ((ret = ff_formats_ref(ff_make_format_list(in_pixfmts), &ctx->inputs[0]->out_formats)) < 0)
             return ret;
 
74cb7ef8
     for (i = 1; i < avff->nb_formats; i++) {
ce322f4c
         desc = av_pix_fmt_desc_get(avff->formats[i]);
5d8e836d
         if (depth != desc->comp[0].depth ||
c7c71f95
             be    != (desc->flags & AV_PIX_FMT_FLAG_BE)) {
ce322f4c
             return AVERROR(EAGAIN);
         }
     }
 
5d8e836d
     if (depth == 8)
ce322f4c
         out_pixfmts = out8_pixfmts;
7bfbc2d7
     else if (!be && depth == 9)
         out_pixfmts = out9le_pixfmts;
     else if (be && depth == 9)
         out_pixfmts = out9be_pixfmts;
46752d6b
     else if (!be && depth == 10)
         out_pixfmts = out10le_pixfmts;
     else if (be && depth == 10)
         out_pixfmts = out10be_pixfmts;
     else if (!be && depth == 12)
         out_pixfmts = out12le_pixfmts;
     else if (be && depth == 12)
         out_pixfmts = out12be_pixfmts;
ce322f4c
     else if (be)
         out_pixfmts = out16be_pixfmts;
     else
         out_pixfmts = out16le_pixfmts;
 
     for (i = 0; i < ctx->nb_outputs; i++)
6aaac24d
         if ((ret = ff_formats_ref(ff_make_format_list(out_pixfmts), &ctx->outputs[i]->in_formats)) < 0)
             return ret;
ce322f4c
     return 0;
 }
 
 static int config_input(AVFilterLink *inlink)
 {
     AVFilterContext *ctx = inlink->dst;
f27cda48
     ExtractPlanesContext *s = ctx->priv;
ce322f4c
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
c4a5499d
     int plane_avail, ret, i;
     uint8_t rgba_map[4];
ce322f4c
 
c7c71f95
     plane_avail = ((desc->flags & AV_PIX_FMT_FLAG_RGB) ? PLANE_R|PLANE_G|PLANE_B :
ce322f4c
                                                  PLANE_Y |
                                 ((desc->nb_components > 2) ? PLANE_U|PLANE_V : 0)) |
c7c71f95
                   ((desc->flags & AV_PIX_FMT_FLAG_ALPHA) ? PLANE_A : 0);
f27cda48
     if (s->requested_planes & ~plane_avail) {
ce322f4c
         av_log(ctx, AV_LOG_ERROR, "Requested planes not available.\n");
         return AVERROR(EINVAL);
     }
f27cda48
     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
ce322f4c
         return ret;
 
5d8e836d
     s->depth = desc->comp[0].depth >> 3;
f27cda48
     s->step = av_get_padded_bits_per_pixel(desc) >> 3;
17e6d7b4
     s->is_packed = !(desc->flags & AV_PIX_FMT_FLAG_PLANAR) &&
                     (desc->nb_components > 1);
c7c71f95
     if (desc->flags & AV_PIX_FMT_FLAG_RGB) {
c4a5499d
         ff_fill_rgba_map(rgba_map, inlink->format);
         for (i = 0; i < 4; i++)
f27cda48
             s->map[i] = rgba_map[s->map[i]];
c4a5499d
     }
 
ce322f4c
     return 0;
 }
 
 static int config_output(AVFilterLink *outlink)
 {
     AVFilterContext *ctx = outlink->src;
     AVFilterLink *inlink = ctx->inputs[0];
f27cda48
     ExtractPlanesContext *s = ctx->priv;
ce322f4c
     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
     const int output = outlink->srcpad - ctx->output_pads;
 
f27cda48
     if (s->map[output] == 1 || s->map[output] == 2) {
21f94684
         outlink->h = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
         outlink->w = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
ce322f4c
     }
 
     return 0;
 }
 
c4a5499d
 static void extract_from_packed(uint8_t *dst, int dst_linesize,
                                 const uint8_t *src, int src_linesize,
                                 int width, int height,
                                 int depth, int step, int comp)
 {
     int x, y;
 
     for (y = 0; y < height; y++) {
         switch (depth) {
         case 1:
             for (x = 0; x < width; x++)
                 dst[x] = src[x * step + comp];
             break;
         case 2:
             for (x = 0; x < width; x++) {
                 dst[x * 2    ] = src[x * step + comp * 2    ];
                 dst[x * 2 + 1] = src[x * step + comp * 2 + 1];
             }
             break;
         }
         dst += dst_linesize;
         src += src_linesize;
     }
 }
 
ce322f4c
 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 {
     AVFilterContext *ctx = inlink->dst;
f27cda48
     ExtractPlanesContext *s = ctx->priv;
ce322f4c
     int i, eof = 0, ret = 0;
 
     for (i = 0; i < ctx->nb_outputs; i++) {
         AVFilterLink *outlink = ctx->outputs[i];
f27cda48
         const int idx = s->map[i];
ce322f4c
         AVFrame *out;
 
02aa0701
         if (outlink->status_in)
ce322f4c
             continue;
 
         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
         if (!out) {
             ret = AVERROR(ENOMEM);
             break;
         }
         av_frame_copy_props(out, frame);
 
fc40cdbf
         if (s->is_packed) {
c4a5499d
             extract_from_packed(out->data[0], out->linesize[0],
                                 frame->data[0], frame->linesize[0],
                                 outlink->w, outlink->h,
f27cda48
                                 s->depth,
                                 s->step, idx);
c4a5499d
         } else {
             av_image_copy_plane(out->data[0], out->linesize[0],
                                 frame->data[idx], frame->linesize[idx],
f27cda48
                                 s->linesize[idx], outlink->h);
c4a5499d
         }
 
ce322f4c
         ret = ff_filter_frame(outlink, out);
         if (ret == AVERROR_EOF)
             eof++;
         else if (ret < 0)
             break;
     }
     av_frame_free(&frame);
 
     if (eof == ctx->nb_outputs)
         ret = AVERROR_EOF;
     else if (ret == AVERROR_EOF)
         ret = 0;
     return ret;
 }
 
b890198b
 static av_cold int init(AVFilterContext *ctx)
ce322f4c
 {
f27cda48
     ExtractPlanesContext *s = ctx->priv;
     int planes = (s->requested_planes & 0xf) | (s->requested_planes >> 4);
99dd47a6
     int i, ret;
ce322f4c
 
     for (i = 0; i < 4; i++) {
         char *name;
         AVFilterPad pad = { 0 };
 
         if (!(planes & (1 << i)))
             continue;
 
         name = av_asprintf("out%d", ctx->nb_outputs);
         if (!name)
             return AVERROR(ENOMEM);
f27cda48
         s->map[ctx->nb_outputs] = i;
ce322f4c
         pad.name = name;
         pad.type = AVMEDIA_TYPE_VIDEO;
         pad.config_props = config_output;
 
99dd47a6
         if ((ret = ff_insert_outpad(ctx, ctx->nb_outputs, &pad)) < 0) {
             av_freep(&pad.name);
             return ret;
         }
ce322f4c
     }
 
     return 0;
 }
 
f4341c64
 static av_cold void uninit(AVFilterContext *ctx)
ce322f4c
 {
     int i;
 
     for (i = 0; i < ctx->nb_outputs; i++)
         av_freep(&ctx->output_pads[i].name);
 }
 
 static const AVFilterPad extractplanes_inputs[] = {
     {
         .name         = "default",
         .type         = AVMEDIA_TYPE_VIDEO,
         .filter_frame = filter_frame,
         .config_props = config_input,
     },
     { NULL }
 };
 
325f6e0a
 AVFilter ff_vf_extractplanes = {
ce322f4c
     .name          = "extractplanes",
     .description   = NULL_IF_CONFIG_SMALL("Extract planes as grayscale frames."),
     .priv_size     = sizeof(ExtractPlanesContext),
     .priv_class    = &extractplanes_class,
     .init          = init,
     .uninit        = uninit,
     .query_formats = query_formats,
     .inputs        = extractplanes_inputs,
     .outputs       = NULL,
     .flags         = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
 };
88e0e205
 
 #if CONFIG_ALPHAEXTRACT_FILTER
 
b890198b
 static av_cold int init_alphaextract(AVFilterContext *ctx)
88e0e205
 {
f27cda48
     ExtractPlanesContext *s = ctx->priv;
88e0e205
 
f27cda48
     s->requested_planes = PLANE_A;
88e0e205
 
     return init(ctx);
 }
 
325f6e0a
 AVFilter ff_vf_alphaextract = {
88e0e205
     .name           = "alphaextract",
     .description    = NULL_IF_CONFIG_SMALL("Extract an alpha channel as a "
                       "grayscale image component."),
     .priv_size      = sizeof(ExtractPlanesContext),
     .init           = init_alphaextract,
     .uninit         = uninit,
     .query_formats  = query_formats,
     .inputs         = extractplanes_inputs,
     .outputs        = NULL,
     .flags          = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
 };
 #endif  /* CONFIG_ALPHAEXTRACT_FILTER */