2 * Copyright (c) 2013 Paul B Mahol
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "libavutil/avstring.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
27 #include "drawutils.h"
39 typedef struct ExtractPlanesContext {
47 } ExtractPlanesContext;
49 #define OFFSET(x) offsetof(ExtractPlanesContext, x)
50 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
51 static const AVOption extractplanes_options[] = {
52 { "planes", "set planes", OFFSET(requested_planes), AV_OPT_TYPE_FLAGS, {.i64=1}, 1, 0xff, FLAGS, "flags"},
53 { "y", "set luma plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_Y}, 0, 0, FLAGS, "flags"},
54 { "u", "set u plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_U}, 0, 0, FLAGS, "flags"},
55 { "v", "set v plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_V}, 0, 0, FLAGS, "flags"},
56 { "r", "set red plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_R}, 0, 0, FLAGS, "flags"},
57 { "g", "set green plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_G}, 0, 0, FLAGS, "flags"},
58 { "b", "set blue plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_B}, 0, 0, FLAGS, "flags"},
59 { "a", "set alpha plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_A}, 0, 0, FLAGS, "flags"},
63 AVFILTER_DEFINE_CLASS(extractplanes);
65 #define EIGHTBIT_FORMATS \
69 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVA420P, \
70 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
71 AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P, \
72 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P, \
73 AV_PIX_FMT_YUVJ411P, \
74 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
75 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A, \
76 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24, \
77 AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA, \
78 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, \
79 AV_PIX_FMT_RGB0, AV_PIX_FMT_BGR0, \
80 AV_PIX_FMT_0RGB, AV_PIX_FMT_0BGR, \
81 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP
83 #define HIGHDEPTH_FORMATS(suf) \
84 AV_PIX_FMT_YA16##suf, AV_PIX_FMT_GRAY16##suf, \
85 AV_PIX_FMT_YUV420P16##suf, AV_PIX_FMT_YUVA420P16##suf, \
86 AV_PIX_FMT_YUV422P16##suf, AV_PIX_FMT_YUVA422P16##suf, \
87 AV_PIX_FMT_YUV444P16##suf, AV_PIX_FMT_YUVA444P16##suf, \
88 AV_PIX_FMT_RGB48##suf, AV_PIX_FMT_BGR48##suf, \
89 AV_PIX_FMT_RGBA64##suf, AV_PIX_FMT_BGRA64##suf, \
90 AV_PIX_FMT_GBRP16##suf, AV_PIX_FMT_GBRAP16##suf, \
91 AV_PIX_FMT_YUV420P10##suf, \
92 AV_PIX_FMT_YUV422P10##suf, \
93 AV_PIX_FMT_YUV444P10##suf, \
94 AV_PIX_FMT_YUV440P10##suf, \
95 AV_PIX_FMT_YUVA420P10##suf, \
96 AV_PIX_FMT_YUVA422P10##suf, \
97 AV_PIX_FMT_YUVA444P10##suf, \
98 AV_PIX_FMT_YUV420P12##suf, \
99 AV_PIX_FMT_YUV422P12##suf, \
100 AV_PIX_FMT_YUV444P12##suf, \
101 AV_PIX_FMT_YUV440P12##suf, \
102 AV_PIX_FMT_YUVA422P12##suf, \
103 AV_PIX_FMT_YUVA444P12##suf, \
104 AV_PIX_FMT_GBRP10##suf, AV_PIX_FMT_GBRAP10##suf, \
105 AV_PIX_FMT_GBRP12##suf, AV_PIX_FMT_GBRAP12##suf, \
106 AV_PIX_FMT_YUV420P9##suf, \
107 AV_PIX_FMT_YUV422P9##suf, \
108 AV_PIX_FMT_YUV444P9##suf, \
109 AV_PIX_FMT_YUVA420P9##suf, \
110 AV_PIX_FMT_YUVA422P9##suf, \
111 AV_PIX_FMT_YUVA444P9##suf, \
112 AV_PIX_FMT_GBRP9##suf, \
113 AV_PIX_FMT_GBRP14##suf, \
114 AV_PIX_FMT_YUV420P14##suf, \
115 AV_PIX_FMT_YUV422P14##suf, \
116 AV_PIX_FMT_YUV444P14##suf
118 #define FLOAT_FORMATS(suf) \
119 AV_PIX_FMT_GRAYF32##suf, \
120 AV_PIX_FMT_GBRPF32##suf, AV_PIX_FMT_GBRAPF32##suf \
122 static int query_formats(AVFilterContext *ctx)
124 static const enum AVPixelFormat in_pixfmts_le[] = {
126 HIGHDEPTH_FORMATS(LE),
130 static const enum AVPixelFormat in_pixfmts_be[] = {
132 HIGHDEPTH_FORMATS(BE),
136 static const enum AVPixelFormat out8_pixfmts[] = { AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE };
137 static const enum AVPixelFormat out9le_pixfmts[] = { AV_PIX_FMT_GRAY9LE, AV_PIX_FMT_NONE };
138 static const enum AVPixelFormat out9be_pixfmts[] = { AV_PIX_FMT_GRAY9BE, AV_PIX_FMT_NONE };
139 static const enum AVPixelFormat out10le_pixfmts[] = { AV_PIX_FMT_GRAY10LE, AV_PIX_FMT_NONE };
140 static const enum AVPixelFormat out10be_pixfmts[] = { AV_PIX_FMT_GRAY10BE, AV_PIX_FMT_NONE };
141 static const enum AVPixelFormat out12le_pixfmts[] = { AV_PIX_FMT_GRAY12LE, AV_PIX_FMT_NONE };
142 static const enum AVPixelFormat out12be_pixfmts[] = { AV_PIX_FMT_GRAY12BE, AV_PIX_FMT_NONE };
143 static const enum AVPixelFormat out14le_pixfmts[] = { AV_PIX_FMT_GRAY14LE, AV_PIX_FMT_NONE };
144 static const enum AVPixelFormat out14be_pixfmts[] = { AV_PIX_FMT_GRAY14BE, AV_PIX_FMT_NONE };
145 static const enum AVPixelFormat out16le_pixfmts[] = { AV_PIX_FMT_GRAY16LE, AV_PIX_FMT_NONE };
146 static const enum AVPixelFormat out16be_pixfmts[] = { AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_NONE };
147 static const enum AVPixelFormat out32le_pixfmts[] = { AV_PIX_FMT_GRAYF32LE, AV_PIX_FMT_NONE };
148 static const enum AVPixelFormat out32be_pixfmts[] = { AV_PIX_FMT_GRAYF32BE, AV_PIX_FMT_NONE };
149 const enum AVPixelFormat *out_pixfmts, *in_pixfmts;
150 const AVPixFmtDescriptor *desc;
151 AVFilterFormats *avff;
152 int i, ret, depth = 0, be = 0;
154 if (!ctx->inputs[0]->incfg.formats ||
155 !ctx->inputs[0]->incfg.formats->nb_formats) {
156 return AVERROR(EAGAIN);
159 avff = ctx->inputs[0]->incfg.formats;
160 desc = av_pix_fmt_desc_get(avff->formats[0]);
161 depth = desc->comp[0].depth;
162 be = desc->flags & AV_PIX_FMT_FLAG_BE;
164 in_pixfmts = in_pixfmts_be;
166 in_pixfmts = in_pixfmts_le;
168 if (!ctx->inputs[0]->outcfg.formats)
169 if ((ret = ff_formats_ref(ff_make_format_list(in_pixfmts), &ctx->inputs[0]->outcfg.formats)) < 0)
172 for (i = 1; i < avff->nb_formats; i++) {
173 desc = av_pix_fmt_desc_get(avff->formats[i]);
174 if (depth != desc->comp[0].depth ||
175 be != (desc->flags & AV_PIX_FMT_FLAG_BE)) {
176 return AVERROR(EAGAIN);
181 out_pixfmts = out8_pixfmts;
182 else if (!be && depth == 9)
183 out_pixfmts = out9le_pixfmts;
184 else if (be && depth == 9)
185 out_pixfmts = out9be_pixfmts;
186 else if (!be && depth == 10)
187 out_pixfmts = out10le_pixfmts;
188 else if (be && depth == 10)
189 out_pixfmts = out10be_pixfmts;
190 else if (!be && depth == 12)
191 out_pixfmts = out12le_pixfmts;
192 else if (be && depth == 12)
193 out_pixfmts = out12be_pixfmts;
194 else if (!be && depth == 14)
195 out_pixfmts = out14le_pixfmts;
196 else if (be && depth == 14)
197 out_pixfmts = out14be_pixfmts;
198 else if (be && depth == 16)
199 out_pixfmts = out16be_pixfmts;
200 else if (!be && depth == 16)
201 out_pixfmts = out16le_pixfmts;
202 else if (be && depth == 32)
203 out_pixfmts = out32be_pixfmts;
205 out_pixfmts = out32le_pixfmts;
207 for (i = 0; i < ctx->nb_outputs; i++)
208 if ((ret = ff_formats_ref(ff_make_format_list(out_pixfmts), &ctx->outputs[i]->incfg.formats)) < 0)
213 static int config_input(AVFilterLink *inlink)
215 AVFilterContext *ctx = inlink->dst;
216 ExtractPlanesContext *s = ctx->priv;
217 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
218 int plane_avail, ret, i;
221 plane_avail = ((desc->flags & AV_PIX_FMT_FLAG_RGB) ? PLANE_R|PLANE_G|PLANE_B :
223 ((desc->nb_components > 2) ? PLANE_U|PLANE_V : 0)) |
224 ((desc->flags & AV_PIX_FMT_FLAG_ALPHA) ? PLANE_A : 0);
225 if (s->requested_planes & ~plane_avail) {
226 av_log(ctx, AV_LOG_ERROR, "Requested planes not available.\n");
227 return AVERROR(EINVAL);
229 if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
232 s->depth = desc->comp[0].depth >> 3;
233 s->step = av_get_padded_bits_per_pixel(desc) >> 3;
234 s->is_packed = !(desc->flags & AV_PIX_FMT_FLAG_PLANAR) &&
235 (desc->nb_components > 1);
236 if (desc->flags & AV_PIX_FMT_FLAG_RGB) {
237 ff_fill_rgba_map(rgba_map, inlink->format);
238 for (i = 0; i < 4; i++)
239 s->map[i] = rgba_map[s->map[i]];
245 static int config_output(AVFilterLink *outlink)
247 AVFilterContext *ctx = outlink->src;
248 AVFilterLink *inlink = ctx->inputs[0];
249 ExtractPlanesContext *s = ctx->priv;
250 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
251 const int output = outlink->srcpad - ctx->output_pads;
253 if (s->map[output] == 1 || s->map[output] == 2) {
254 outlink->h = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
255 outlink->w = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
261 static void extract_from_packed(uint8_t *dst, int dst_linesize,
262 const uint8_t *src, int src_linesize,
263 int width, int height,
264 int depth, int step, int comp)
268 for (y = 0; y < height; y++) {
271 for (x = 0; x < width; x++)
272 dst[x] = src[x * step + comp];
275 for (x = 0; x < width; x++) {
276 dst[x * 2 ] = src[x * step + comp * 2 ];
277 dst[x * 2 + 1] = src[x * step + comp * 2 + 1];
286 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
288 AVFilterContext *ctx = inlink->dst;
289 ExtractPlanesContext *s = ctx->priv;
290 int i, eof = 0, ret = 0;
292 for (i = 0; i < ctx->nb_outputs; i++) {
293 AVFilterLink *outlink = ctx->outputs[i];
294 const int idx = s->map[i];
297 if (ff_outlink_get_status(outlink))
300 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
302 ret = AVERROR(ENOMEM);
305 av_frame_copy_props(out, frame);
308 extract_from_packed(out->data[0], out->linesize[0],
309 frame->data[0], frame->linesize[0],
310 outlink->w, outlink->h,
314 av_image_copy_plane(out->data[0], out->linesize[0],
315 frame->data[idx], frame->linesize[idx],
316 s->linesize[idx], outlink->h);
319 ret = ff_filter_frame(outlink, out);
320 if (ret == AVERROR_EOF)
325 av_frame_free(&frame);
327 if (eof == ctx->nb_outputs)
329 else if (ret == AVERROR_EOF)
334 static av_cold int init(AVFilterContext *ctx)
336 ExtractPlanesContext *s = ctx->priv;
337 int planes = (s->requested_planes & 0xf) | (s->requested_planes >> 4);
340 for (i = 0; i < 4; i++) {
342 AVFilterPad pad = { 0 };
344 if (!(planes & (1 << i)))
347 name = av_asprintf("out%d", ctx->nb_outputs);
349 return AVERROR(ENOMEM);
350 s->map[ctx->nb_outputs] = i;
352 pad.type = AVMEDIA_TYPE_VIDEO;
353 pad.config_props = config_output;
355 if ((ret = ff_insert_outpad(ctx, ctx->nb_outputs, &pad)) < 0) {
364 static av_cold void uninit(AVFilterContext *ctx)
368 for (i = 0; i < ctx->nb_outputs; i++)
369 av_freep(&ctx->output_pads[i].name);
372 static const AVFilterPad extractplanes_inputs[] = {
375 .type = AVMEDIA_TYPE_VIDEO,
376 .filter_frame = filter_frame,
377 .config_props = config_input,
382 AVFilter ff_vf_extractplanes = {
383 .name = "extractplanes",
384 .description = NULL_IF_CONFIG_SMALL("Extract planes as grayscale frames."),
385 .priv_size = sizeof(ExtractPlanesContext),
386 .priv_class = &extractplanes_class,
389 .query_formats = query_formats,
390 .inputs = extractplanes_inputs,
392 .flags = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
395 #if CONFIG_ALPHAEXTRACT_FILTER
397 static av_cold int init_alphaextract(AVFilterContext *ctx)
399 ExtractPlanesContext *s = ctx->priv;
401 s->requested_planes = PLANE_A;
406 AVFilter ff_vf_alphaextract = {
407 .name = "alphaextract",
408 .description = NULL_IF_CONFIG_SMALL("Extract an alpha channel as a "
409 "grayscale image component."),
410 .priv_size = sizeof(ExtractPlanesContext),
411 .init = init_alphaextract,
413 .query_formats = query_formats,
414 .inputs = extractplanes_inputs,
416 .flags = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
418 #endif /* CONFIG_ALPHAEXTRACT_FILTER */