395a089b6f299893b7d1c6dff66ee38a41fd8723
[ffmpeg.git] / libavfilter / vf_extractplanes.c
1 /*
2  * Copyright (c) 2013 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include "libavutil/avstring.h"
22 #include "libavutil/imgutils.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 #include "avfilter.h"
26 #include "drawutils.h"
27 #include "internal.h"
28
29 #define PLANE_R 0x01
30 #define PLANE_G 0x02
31 #define PLANE_B 0x04
32 #define PLANE_A 0x08
33 #define PLANE_Y 0x10
34 #define PLANE_U 0x20
35 #define PLANE_V 0x40
36
37 typedef struct {
38     const AVClass *class;
39     int requested_planes;
40     int map[4];
41     int linesize[4];
42     int is_packed;
43     int depth;
44     int step;
45 } ExtractPlanesContext;
46
47 #define OFFSET(x) offsetof(ExtractPlanesContext, x)
48 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
49 static const AVOption extractplanes_options[] = {
50     { "planes", "set planes",  OFFSET(requested_planes), AV_OPT_TYPE_FLAGS, {.i64=1}, 1, 0xff, FLAGS, "flags"},
51     {      "y", "set luma plane",  0, AV_OPT_TYPE_CONST, {.i64=PLANE_Y}, 0, 0, FLAGS, "flags"},
52     {      "u", "set u plane",     0, AV_OPT_TYPE_CONST, {.i64=PLANE_U}, 0, 0, FLAGS, "flags"},
53     {      "v", "set v plane",     0, AV_OPT_TYPE_CONST, {.i64=PLANE_V}, 0, 0, FLAGS, "flags"},
54     {      "r", "set red plane",   0, AV_OPT_TYPE_CONST, {.i64=PLANE_R}, 0, 0, FLAGS, "flags"},
55     {      "g", "set green plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_G}, 0, 0, FLAGS, "flags"},
56     {      "b", "set blue plane",  0, AV_OPT_TYPE_CONST, {.i64=PLANE_B}, 0, 0, FLAGS, "flags"},
57     {      "a", "set alpha plane", 0, AV_OPT_TYPE_CONST, {.i64=PLANE_A}, 0, 0, FLAGS, "flags"},
58     { NULL }
59 };
60
61 AVFILTER_DEFINE_CLASS(extractplanes);
62
63 static int query_formats(AVFilterContext *ctx)
64 {
65     static const enum AVPixelFormat in_pixfmts[] = {
66         AV_PIX_FMT_YUV410P,
67         AV_PIX_FMT_YUV411P,
68         AV_PIX_FMT_YUV440P,
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_YUV420P16LE, AV_PIX_FMT_YUVA420P16LE,
76         AV_PIX_FMT_YUV420P16BE, AV_PIX_FMT_YUVA420P16BE,
77         AV_PIX_FMT_YUV422P16LE, AV_PIX_FMT_YUVA422P16LE,
78         AV_PIX_FMT_YUV422P16BE, AV_PIX_FMT_YUVA422P16BE,
79         AV_PIX_FMT_YUV444P16LE, AV_PIX_FMT_YUVA444P16LE,
80         AV_PIX_FMT_YUV444P16BE, AV_PIX_FMT_YUVA444P16BE,
81         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A,
82         AV_PIX_FMT_YA16LE, AV_PIX_FMT_YA16BE,
83         AV_PIX_FMT_GRAY16LE, AV_PIX_FMT_GRAY16BE,
84         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24,
85         AV_PIX_FMT_RGBA, AV_PIX_FMT_BGRA,
86         AV_PIX_FMT_ARGB, AV_PIX_FMT_ABGR,
87         AV_PIX_FMT_RGB48LE, AV_PIX_FMT_BGR48LE,
88         AV_PIX_FMT_RGB48BE, AV_PIX_FMT_BGR48BE,
89         AV_PIX_FMT_RGBA64LE, AV_PIX_FMT_BGRA64LE,
90         AV_PIX_FMT_RGBA64BE, AV_PIX_FMT_BGRA64BE,
91         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP,
92         AV_PIX_FMT_GBRP16LE, AV_PIX_FMT_GBRP16BE,
93         AV_PIX_FMT_GBRAP16LE, AV_PIX_FMT_GBRAP16BE,
94         AV_PIX_FMT_NONE,
95     };
96     static const enum AVPixelFormat out8_pixfmts[] = { AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE };
97     static const enum AVPixelFormat out16le_pixfmts[] = { AV_PIX_FMT_GRAY16LE, AV_PIX_FMT_NONE };
98     static const enum AVPixelFormat out16be_pixfmts[] = { AV_PIX_FMT_GRAY16BE, AV_PIX_FMT_NONE };
99     const enum AVPixelFormat *out_pixfmts;
100     const AVPixFmtDescriptor *desc;
101     AVFilterFormats *avff;
102     int i, depth = 0, be = 0;
103
104     if (!ctx->inputs[0]->in_formats ||
105         !ctx->inputs[0]->in_formats->nb_formats) {
106         return AVERROR(EAGAIN);
107     }
108
109     if (!ctx->inputs[0]->out_formats)
110         ff_formats_ref(ff_make_format_list(in_pixfmts), &ctx->inputs[0]->out_formats);
111
112     avff = ctx->inputs[0]->in_formats;
113     desc = av_pix_fmt_desc_get(avff->formats[0]);
114     depth = desc->comp[0].depth_minus1;
115     be = desc->flags & AV_PIX_FMT_FLAG_BE;
116     for (i = 1; i < avff->nb_formats; i++) {
117         desc = av_pix_fmt_desc_get(avff->formats[i]);
118         if (depth != desc->comp[0].depth_minus1 ||
119             be    != (desc->flags & AV_PIX_FMT_FLAG_BE)) {
120             return AVERROR(EAGAIN);
121         }
122     }
123
124     if (depth == 7)
125         out_pixfmts = out8_pixfmts;
126     else if (be)
127         out_pixfmts = out16be_pixfmts;
128     else
129         out_pixfmts = out16le_pixfmts;
130
131     for (i = 0; i < ctx->nb_outputs; i++)
132         ff_formats_ref(ff_make_format_list(out_pixfmts), &ctx->outputs[i]->in_formats);
133     return 0;
134 }
135
136 static int config_input(AVFilterLink *inlink)
137 {
138     AVFilterContext *ctx = inlink->dst;
139     ExtractPlanesContext *s = ctx->priv;
140     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
141     int plane_avail, ret, i;
142     uint8_t rgba_map[4];
143
144     plane_avail = ((desc->flags & AV_PIX_FMT_FLAG_RGB) ? PLANE_R|PLANE_G|PLANE_B :
145                                                  PLANE_Y |
146                                 ((desc->nb_components > 2) ? PLANE_U|PLANE_V : 0)) |
147                   ((desc->flags & AV_PIX_FMT_FLAG_ALPHA) ? PLANE_A : 0);
148     if (s->requested_planes & ~plane_avail) {
149         av_log(ctx, AV_LOG_ERROR, "Requested planes not available.\n");
150         return AVERROR(EINVAL);
151     }
152     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
153         return ret;
154
155     s->depth = (desc->comp[0].depth_minus1 + 1) >> 3;
156     s->step = av_get_padded_bits_per_pixel(desc) >> 3;
157     s->is_packed = !(desc->flags & AV_PIX_FMT_FLAG_PLANAR);
158     if (desc->flags & AV_PIX_FMT_FLAG_RGB) {
159         ff_fill_rgba_map(rgba_map, inlink->format);
160         for (i = 0; i < 4; i++)
161             s->map[i] = rgba_map[s->map[i]];
162     }
163
164     return 0;
165 }
166
167 static int config_output(AVFilterLink *outlink)
168 {
169     AVFilterContext *ctx = outlink->src;
170     AVFilterLink *inlink = ctx->inputs[0];
171     ExtractPlanesContext *s = ctx->priv;
172     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
173     const int output = outlink->srcpad - ctx->output_pads;
174
175     if (s->map[output] == 1 || s->map[output] == 2) {
176         outlink->h = FF_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
177         outlink->w = FF_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
178     }
179
180     return 0;
181 }
182
183 static void extract_from_packed(uint8_t *dst, int dst_linesize,
184                                 const uint8_t *src, int src_linesize,
185                                 int width, int height,
186                                 int depth, int step, int comp)
187 {
188     int x, y;
189
190     for (y = 0; y < height; y++) {
191         switch (depth) {
192         case 1:
193             for (x = 0; x < width; x++)
194                 dst[x] = src[x * step + comp];
195             break;
196         case 2:
197             for (x = 0; x < width; x++) {
198                 dst[x * 2    ] = src[x * step + comp * 2    ];
199                 dst[x * 2 + 1] = src[x * step + comp * 2 + 1];
200             }
201             break;
202         }
203         dst += dst_linesize;
204         src += src_linesize;
205     }
206 }
207
208 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
209 {
210     AVFilterContext *ctx = inlink->dst;
211     ExtractPlanesContext *s = ctx->priv;
212     int i, eof = 0, ret = 0;
213
214     for (i = 0; i < ctx->nb_outputs; i++) {
215         AVFilterLink *outlink = ctx->outputs[i];
216         const int idx = s->map[i];
217         AVFrame *out;
218
219         if (outlink->closed)
220             continue;
221
222         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
223         if (!out) {
224             ret = AVERROR(ENOMEM);
225             break;
226         }
227         av_frame_copy_props(out, frame);
228
229         if (s->is_packed) {
230             extract_from_packed(out->data[0], out->linesize[0],
231                                 frame->data[0], frame->linesize[0],
232                                 outlink->w, outlink->h,
233                                 s->depth,
234                                 s->step, idx);
235         } else {
236             av_image_copy_plane(out->data[0], out->linesize[0],
237                                 frame->data[idx], frame->linesize[idx],
238                                 s->linesize[idx], outlink->h);
239         }
240
241         ret = ff_filter_frame(outlink, out);
242         if (ret == AVERROR_EOF)
243             eof++;
244         else if (ret < 0)
245             break;
246     }
247     av_frame_free(&frame);
248
249     if (eof == ctx->nb_outputs)
250         ret = AVERROR_EOF;
251     else if (ret == AVERROR_EOF)
252         ret = 0;
253     return ret;
254 }
255
256 static av_cold int init(AVFilterContext *ctx)
257 {
258     ExtractPlanesContext *s = ctx->priv;
259     int planes = (s->requested_planes & 0xf) | (s->requested_planes >> 4);
260     int i;
261
262     for (i = 0; i < 4; i++) {
263         char *name;
264         AVFilterPad pad = { 0 };
265
266         if (!(planes & (1 << i)))
267             continue;
268
269         name = av_asprintf("out%d", ctx->nb_outputs);
270         if (!name)
271             return AVERROR(ENOMEM);
272         s->map[ctx->nb_outputs] = i;
273         pad.name = name;
274         pad.type = AVMEDIA_TYPE_VIDEO;
275         pad.config_props = config_output;
276
277         ff_insert_outpad(ctx, ctx->nb_outputs, &pad);
278     }
279
280     return 0;
281 }
282
283 static av_cold void uninit(AVFilterContext *ctx)
284 {
285     int i;
286
287     for (i = 0; i < ctx->nb_outputs; i++)
288         av_freep(&ctx->output_pads[i].name);
289 }
290
291 static const AVFilterPad extractplanes_inputs[] = {
292     {
293         .name         = "default",
294         .type         = AVMEDIA_TYPE_VIDEO,
295         .filter_frame = filter_frame,
296         .config_props = config_input,
297     },
298     { NULL }
299 };
300
301 AVFilter ff_vf_extractplanes = {
302     .name          = "extractplanes",
303     .description   = NULL_IF_CONFIG_SMALL("Extract planes as grayscale frames."),
304     .priv_size     = sizeof(ExtractPlanesContext),
305     .priv_class    = &extractplanes_class,
306     .init          = init,
307     .uninit        = uninit,
308     .query_formats = query_formats,
309     .inputs        = extractplanes_inputs,
310     .outputs       = NULL,
311     .flags         = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
312 };
313
314 #if CONFIG_ALPHAEXTRACT_FILTER
315
316 static av_cold int init_alphaextract(AVFilterContext *ctx)
317 {
318     ExtractPlanesContext *s = ctx->priv;
319
320     s->requested_planes = PLANE_A;
321
322     return init(ctx);
323 }
324
325 AVFilter ff_vf_alphaextract = {
326     .name           = "alphaextract",
327     .description    = NULL_IF_CONFIG_SMALL("Extract an alpha channel as a "
328                       "grayscale image component."),
329     .priv_size      = sizeof(ExtractPlanesContext),
330     .init           = init_alphaextract,
331     .uninit         = uninit,
332     .query_formats  = query_formats,
333     .inputs         = extractplanes_inputs,
334     .outputs        = NULL,
335     .flags          = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
336 };
337 #endif  /* CONFIG_ALPHAEXTRACT_FILTER */