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"
26 #define FF_INTERNAL_FIELDS 1
27 #include "libavfilter/framequeue.h"
30 #include "drawutils.h"
41 typedef struct ExtractPlanesContext {
49 } ExtractPlanesContext;
51 #define OFFSET(x) offsetof(ExtractPlanesContext, x)
52 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
53 static const AVOption extractplanes_options[] = {
54 { "planes", "set planes", OFFSET(requested_planes), AV_OPT_TYPE_FLAGS, {.i64=1}, 1, 0xff, FLAGS, "flags"},
55 { "y", "set luma plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_Y}, 0, 0, FLAGS, "flags"},
56 { "u", "set u plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_U}, 0, 0, FLAGS, "flags"},
57 { "v", "set v plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_V}, 0, 0, FLAGS, "flags"},
58 { "r", "set red plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_R}, 0, 0, FLAGS, "flags"},
59 { "g", "set green plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_G}, 0, 0, FLAGS, "flags"},
60 { "b", "set blue plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_B}, 0, 0, FLAGS, "flags"},
61 { "a", "set alpha plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_A}, 0, 0, FLAGS, "flags"},
65 AVFILTER_DEFINE_CLASS(extractplanes);
67 #define EIGHTBIT_FORMATS \
71 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVA420P, \
72 AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
73 AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P, \
74 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P, \
75 AV_PIX_FMT_YUVJ411P, \
76 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
77 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A, \
78 AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24, \
79 AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA, \
80 AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR, \
81 AV_PIX_FMT_RGB0, AV_PIX_FMT_BGR0, \
82 AV_PIX_FMT_0RGB, AV_PIX_FMT_0BGR, \
83 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP
85 static int query_formats(AVFilterContext *ctx)
87 static const enum AVPixelFormat in_pixfmts_le[] = {
89 AV_PIX_FMT_YA16LE, AV_PIX_FMT_GRAY16LE,
90 AV_PIX_FMT_YUV420P16LE, AV_PIX_FMT_YUVA420P16LE,
91 AV_PIX_FMT_YUV422P16LE, AV_PIX_FMT_YUVA422P16LE,
92 AV_PIX_FMT_YUV444P16LE, AV_PIX_FMT_YUVA444P16LE,
93 AV_PIX_FMT_RGB48LE, AV_PIX_FMT_BGR48LE,
94 AV_PIX_FMT_RGBA64LE, AV_PIX_FMT_BGRA64LE,
95 AV_PIX_FMT_GBRP16LE, AV_PIX_FMT_GBRAP16LE,
96 AV_PIX_FMT_YUV420P10LE,
97 AV_PIX_FMT_YUV422P10LE,
98 AV_PIX_FMT_YUV444P10LE,
99 AV_PIX_FMT_YUV440P10LE,
100 AV_PIX_FMT_YUVA420P10LE,
101 AV_PIX_FMT_YUVA422P10LE,
102 AV_PIX_FMT_YUVA444P10LE,
103 AV_PIX_FMT_YUV420P12LE,
104 AV_PIX_FMT_YUV422P12LE,
105 AV_PIX_FMT_YUV444P12LE,
106 AV_PIX_FMT_YUV440P12LE,
107 AV_PIX_FMT_GBRP10LE, AV_PIX_FMT_GBRAP10LE,
108 AV_PIX_FMT_GBRP12LE, AV_PIX_FMT_GBRAP12LE,
109 AV_PIX_FMT_YUV420P9LE,
110 AV_PIX_FMT_YUV422P9LE,
111 AV_PIX_FMT_YUV444P9LE,
112 AV_PIX_FMT_YUVA420P9LE,
113 AV_PIX_FMT_YUVA422P9LE,
114 AV_PIX_FMT_YUVA444P9LE,
117 AV_PIX_FMT_YUV420P14LE,
118 AV_PIX_FMT_YUV422P14LE,
119 AV_PIX_FMT_YUV444P14LE,
122 static const enum AVPixelFormat in_pixfmts_be[] = {
124 AV_PIX_FMT_YA16BE, AV_PIX_FMT_GRAY16BE,
125 AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUVA420P16BE,
126 AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUVA422P16BE,
127 AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUVA444P16BE,
128 AV_PIX_FMT_RGB48BE, AV_PIX_FMT_BGR48BE,
129 AV_PIX_FMT_RGBA64BE, AV_PIX_FMT_BGRA64BE,
130 AV_PIX_FMT_GBRP16BE, AV_PIX_FMT_GBRAP16BE,
131 AV_PIX_FMT_YUV420P10BE,
132 AV_PIX_FMT_YUV422P10BE,
133 AV_PIX_FMT_YUV444P10BE,
134 AV_PIX_FMT_YUV440P10BE,
135 AV_PIX_FMT_YUVA420P10BE,
136 AV_PIX_FMT_YUVA422P10BE,
137 AV_PIX_FMT_YUVA444P10BE,
138 AV_PIX_FMT_YUV420P12BE,
139 AV_PIX_FMT_YUV422P12BE,
140 AV_PIX_FMT_YUV444P12BE,
141 AV_PIX_FMT_YUV440P12BE,
142 AV_PIX_FMT_GBRP10BE, AV_PIX_FMT_GBRAP10BE,
143 AV_PIX_FMT_GBRP12BE, AV_PIX_FMT_GBRAP12BE,
144 AV_PIX_FMT_YUV420P9BE,
145 AV_PIX_FMT_YUV422P9BE,
146 AV_PIX_FMT_YUV444P9BE,
147 AV_PIX_FMT_YUVA420P9BE,
148 AV_PIX_FMT_YUVA422P9BE,
149 AV_PIX_FMT_YUVA444P9BE,
152 AV_PIX_FMT_YUV420P14BE,
153 AV_PIX_FMT_YUV422P14BE,
154 AV_PIX_FMT_YUV444P14BE,
157 static const enum AVPixelFormat out8_pixfmts[] = { AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE };
158 static const enum AVPixelFormat out9le_pixfmts[] = { AV_PIX_FMT_GRAY9LE, AV_PIX_FMT_NONE };
159 static const enum AVPixelFormat out9be_pixfmts[] = { AV_PIX_FMT_GRAY9BE, AV_PIX_FMT_NONE };
160 static const enum AVPixelFormat out10le_pixfmts[] = { AV_PIX_FMT_GRAY10LE, AV_PIX_FMT_NONE };
161 static const enum AVPixelFormat out10be_pixfmts[] = { AV_PIX_FMT_GRAY10BE, AV_PIX_FMT_NONE };
162 static const enum AVPixelFormat out12le_pixfmts[] = { AV_PIX_FMT_GRAY12LE, AV_PIX_FMT_NONE };
163 static const enum AVPixelFormat out12be_pixfmts[] = { AV_PIX_FMT_GRAY12BE, AV_PIX_FMT_NONE };
164 static const enum AVPixelFormat out14le_pixfmts[] = { AV_PIX_FMT_GRAY14LE, AV_PIX_FMT_NONE };
165 static const enum AVPixelFormat out14be_pixfmts[] = { AV_PIX_FMT_GRAY14BE, AV_PIX_FMT_NONE };
166 static const enum AVPixelFormat out16le_pixfmts[] = { AV_PIX_FMT_GRAY16LE, AV_PIX_FMT_NONE };
167 static const enum AVPixelFormat out16be_pixfmts[] = { AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_NONE };
168 const enum AVPixelFormat *out_pixfmts, *in_pixfmts;
169 const AVPixFmtDescriptor *desc;
170 AVFilterFormats *avff;
171 int i, ret, depth = 0, be = 0;
173 if (!ctx->inputs[0]->in_formats ||
174 !ctx->inputs[0]->in_formats->nb_formats) {
175 return AVERROR(EAGAIN);
178 avff = ctx->inputs[0]->in_formats;
179 desc = av_pix_fmt_desc_get(avff->formats[0]);
180 depth = desc->comp[0].depth;
181 be = desc->flags & AV_PIX_FMT_FLAG_BE;
183 in_pixfmts = in_pixfmts_be;
185 in_pixfmts = in_pixfmts_le;
187 if (!ctx->inputs[0]->out_formats)
188 if ((ret = ff_formats_ref(ff_make_format_list(in_pixfmts), &ctx->inputs[0]->out_formats)) < 0)
191 for (i = 1; i < avff->nb_formats; i++) {
192 desc = av_pix_fmt_desc_get(avff->formats[i]);
193 if (depth != desc->comp[0].depth ||
194 be != (desc->flags & AV_PIX_FMT_FLAG_BE)) {
195 return AVERROR(EAGAIN);
200 out_pixfmts = out8_pixfmts;
201 else if (!be && depth == 9)
202 out_pixfmts = out9le_pixfmts;
203 else if (be && depth == 9)
204 out_pixfmts = out9be_pixfmts;
205 else if (!be && depth == 10)
206 out_pixfmts = out10le_pixfmts;
207 else if (be && depth == 10)
208 out_pixfmts = out10be_pixfmts;
209 else if (!be && depth == 12)
210 out_pixfmts = out12le_pixfmts;
211 else if (be && depth == 12)
212 out_pixfmts = out12be_pixfmts;
213 else if (!be && depth == 14)
214 out_pixfmts = out14le_pixfmts;
215 else if (be && depth == 14)
216 out_pixfmts = out14be_pixfmts;
218 out_pixfmts = out16be_pixfmts;
220 out_pixfmts = out16le_pixfmts;
222 for (i = 0; i < ctx->nb_outputs; i++)
223 if ((ret = ff_formats_ref(ff_make_format_list(out_pixfmts), &ctx->outputs[i]->in_formats)) < 0)
228 static int config_input(AVFilterLink *inlink)
230 AVFilterContext *ctx = inlink->dst;
231 ExtractPlanesContext *s = ctx->priv;
232 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
233 int plane_avail, ret, i;
236 plane_avail = ((desc->flags & AV_PIX_FMT_FLAG_RGB) ? PLANE_R|PLANE_G|PLANE_B :
238 ((desc->nb_components > 2) ? PLANE_U|PLANE_V : 0)) |
239 ((desc->flags & AV_PIX_FMT_FLAG_ALPHA) ? PLANE_A : 0);
240 if (s->requested_planes & ~plane_avail) {
241 av_log(ctx, AV_LOG_ERROR, "Requested planes not available.\n");
242 return AVERROR(EINVAL);
244 if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
247 s->depth = desc->comp[0].depth >> 3;
248 s->step = av_get_padded_bits_per_pixel(desc) >> 3;
249 s->is_packed = !(desc->flags & AV_PIX_FMT_FLAG_PLANAR) &&
250 (desc->nb_components > 1);
251 if (desc->flags & AV_PIX_FMT_FLAG_RGB) {
252 ff_fill_rgba_map(rgba_map, inlink->format);
253 for (i = 0; i < 4; i++)
254 s->map[i] = rgba_map[s->map[i]];
260 static int config_output(AVFilterLink *outlink)
262 AVFilterContext *ctx = outlink->src;
263 AVFilterLink *inlink = ctx->inputs[0];
264 ExtractPlanesContext *s = ctx->priv;
265 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
266 const int output = outlink->srcpad - ctx->output_pads;
268 if (s->map[output] == 1 || s->map[output] == 2) {
269 outlink->h = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
270 outlink->w = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
276 static void extract_from_packed(uint8_t *dst, int dst_linesize,
277 const uint8_t *src, int src_linesize,
278 int width, int height,
279 int depth, int step, int comp)
283 for (y = 0; y < height; y++) {
286 for (x = 0; x < width; x++)
287 dst[x] = src[x * step + comp];
290 for (x = 0; x < width; x++) {
291 dst[x * 2 ] = src[x * step + comp * 2 ];
292 dst[x * 2 + 1] = src[x * step + comp * 2 + 1];
301 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
303 AVFilterContext *ctx = inlink->dst;
304 ExtractPlanesContext *s = ctx->priv;
305 int i, eof = 0, ret = 0;
307 for (i = 0; i < ctx->nb_outputs; i++) {
308 AVFilterLink *outlink = ctx->outputs[i];
309 const int idx = s->map[i];
312 if (outlink->status_in)
315 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
317 ret = AVERROR(ENOMEM);
320 av_frame_copy_props(out, frame);
323 extract_from_packed(out->data[0], out->linesize[0],
324 frame->data[0], frame->linesize[0],
325 outlink->w, outlink->h,
329 av_image_copy_plane(out->data[0], out->linesize[0],
330 frame->data[idx], frame->linesize[idx],
331 s->linesize[idx], outlink->h);
334 ret = ff_filter_frame(outlink, out);
335 if (ret == AVERROR_EOF)
340 av_frame_free(&frame);
342 if (eof == ctx->nb_outputs)
344 else if (ret == AVERROR_EOF)
349 static av_cold int init(AVFilterContext *ctx)
351 ExtractPlanesContext *s = ctx->priv;
352 int planes = (s->requested_planes & 0xf) | (s->requested_planes >> 4);
355 for (i = 0; i < 4; i++) {
357 AVFilterPad pad = { 0 };
359 if (!(planes & (1 << i)))
362 name = av_asprintf("out%d", ctx->nb_outputs);
364 return AVERROR(ENOMEM);
365 s->map[ctx->nb_outputs] = i;
367 pad.type = AVMEDIA_TYPE_VIDEO;
368 pad.config_props = config_output;
370 if ((ret = ff_insert_outpad(ctx, ctx->nb_outputs, &pad)) < 0) {
379 static av_cold void uninit(AVFilterContext *ctx)
383 for (i = 0; i < ctx->nb_outputs; i++)
384 av_freep(&ctx->output_pads[i].name);
387 static const AVFilterPad extractplanes_inputs[] = {
390 .type = AVMEDIA_TYPE_VIDEO,
391 .filter_frame = filter_frame,
392 .config_props = config_input,
397 AVFilter ff_vf_extractplanes = {
398 .name = "extractplanes",
399 .description = NULL_IF_CONFIG_SMALL("Extract planes as grayscale frames."),
400 .priv_size = sizeof(ExtractPlanesContext),
401 .priv_class = &extractplanes_class,
404 .query_formats = query_formats,
405 .inputs = extractplanes_inputs,
407 .flags = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
410 #if CONFIG_ALPHAEXTRACT_FILTER
412 static av_cold int init_alphaextract(AVFilterContext *ctx)
414 ExtractPlanesContext *s = ctx->priv;
416 s->requested_planes = PLANE_A;
421 AVFilter ff_vf_alphaextract = {
422 .name = "alphaextract",
423 .description = NULL_IF_CONFIG_SMALL("Extract an alpha channel as a "
424 "grayscale image component."),
425 .priv_size = sizeof(ExtractPlanesContext),
426 .init = init_alphaextract,
428 .query_formats = query_formats,
429 .inputs = extractplanes_inputs,
431 .flags = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
433 #endif /* CONFIG_ALPHAEXTRACT_FILTER */