lavfi/il: simplify/generalize linesize computation
[ffmpeg.git] / libavfilter / vf_il.c
1 /*
2  * Copyright (c) 2002 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (c) 2013 Paul B Mahol
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * (de)interleave fields filter
25  */
26
27 #include "libavutil/opt.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/pixdesc.h"
30 #include "avfilter.h"
31 #include "internal.h"
32
33 enum FilterMode {
34     MODE_NONE,
35     MODE_INTERLEAVE,
36     MODE_DEINTERLEAVE
37 };
38
39 typedef struct {
40     const AVClass *class;
41     enum FilterMode luma_mode, chroma_mode, alpha_mode;
42     int luma_swap, chroma_swap, alpha_swap;
43     int nb_planes;
44     int linesize[4], chroma_height;
45     int has_alpha;
46 } IlContext;
47
48 #define OFFSET(x) offsetof(IlContext, x)
49 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
50
51 static const AVOption il_options[] = {
52     {"luma_mode",   "select luma mode", OFFSET(luma_mode), AV_OPT_TYPE_INT, {.i64=MODE_NONE}, MODE_NONE, MODE_DEINTERLEAVE, FLAGS, "luma_mode"},
53     {"l",           "select luma mode", OFFSET(luma_mode), AV_OPT_TYPE_INT, {.i64=MODE_NONE}, MODE_NONE, MODE_DEINTERLEAVE, FLAGS, "luma_mode"},
54     {"none",         NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_NONE},         0, 0, FLAGS, "luma_mode"},
55     {"interleave",   NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE},   0, 0, FLAGS, "luma_mode"},
56     {"i",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE},   0, 0, FLAGS, "luma_mode"},
57     {"deinterleave", NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_DEINTERLEAVE}, 0, 0, FLAGS, "luma_mode"},
58     {"d",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_DEINTERLEAVE}, 0, 0, FLAGS, "luma_mode"},
59     {"chroma_mode", "select chroma mode", OFFSET(chroma_mode), AV_OPT_TYPE_INT, {.i64=MODE_NONE}, MODE_NONE, MODE_DEINTERLEAVE, FLAGS, "chroma_mode"},
60     {"c",           "select chroma mode", OFFSET(chroma_mode), AV_OPT_TYPE_INT, {.i64=MODE_NONE}, MODE_NONE, MODE_DEINTERLEAVE, FLAGS, "chroma_mode"},
61     {"none",         NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_NONE},         0, 0, FLAGS, "chroma_mode"},
62     {"interleave",   NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE},   0, 0, FLAGS, "chroma_mode"},
63     {"i",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE},   0, 0, FLAGS, "chroma_mode"},
64     {"deinterleave", NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_DEINTERLEAVE}, 0, 0, FLAGS, "chroma_mode"},
65     {"d",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_DEINTERLEAVE}, 0, 0, FLAGS, "chroma_mode"},
66     {"alpha_mode", "select alpha mode", OFFSET(alpha_mode), AV_OPT_TYPE_INT, {.i64=MODE_NONE}, MODE_NONE, MODE_DEINTERLEAVE, FLAGS, "alpha_mode"},
67     {"a",          "select alpha mode", OFFSET(alpha_mode), AV_OPT_TYPE_INT, {.i64=MODE_NONE}, MODE_NONE, MODE_DEINTERLEAVE, FLAGS, "alpha_mode"},
68     {"none",         NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_NONE},         0, 0, FLAGS, "alpha_mode"},
69     {"interleave",   NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE},   0, 0, FLAGS, "alpha_mode"},
70     {"i",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_INTERLEAVE},   0, 0, FLAGS, "alpha_mode"},
71     {"deinterleave", NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_DEINTERLEAVE}, 0, 0, FLAGS, "alpha_mode"},
72     {"d",            NULL, 0, AV_OPT_TYPE_CONST, {.i64=MODE_DEINTERLEAVE}, 0, 0, FLAGS, "alpha_mode"},
73     {"luma_swap",   "swap luma fields",   OFFSET(luma_swap),   AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
74     {"ls",          "swap luma fields",   OFFSET(luma_swap),   AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
75     {"chroma_swap", "swap chroma fields", OFFSET(chroma_swap), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
76     {"cs",          "swap chroma fields", OFFSET(chroma_swap), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
77     {"alpha_swap",  "swap alpha fields",  OFFSET(alpha_swap),  AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
78     {"as",          "swap alpha fields",  OFFSET(alpha_swap),  AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS},
79     {NULL}
80 };
81
82 AVFILTER_DEFINE_CLASS(il);
83
84 static av_cold int init(AVFilterContext *ctx, const char *args)
85 {
86     IlContext *il = ctx->priv;
87     int ret;
88
89     il->class = &il_class;
90     av_opt_set_defaults(il);
91
92     if ((ret = av_set_options_string(il, args, "=", ":")) < 0)
93         return ret;
94
95     return 0;
96 }
97
98 static int config_input(AVFilterLink *inlink)
99 {
100     IlContext *il = inlink->dst->priv;
101     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
102     int i, ret;
103
104     for (i = 0; i < desc->nb_components; i++)
105         il->nb_planes = FFMAX(il->nb_planes, desc->comp[i].plane);
106     il->nb_planes++;
107
108     il->has_alpha = !!(desc->flags & PIX_FMT_ALPHA);
109     if ((ret = av_image_fill_linesizes(il->linesize, inlink->format, inlink->w)) < 0)
110         return ret;
111
112     il->chroma_height = inlink->h >> desc->log2_chroma_h;
113
114     return 0;
115 }
116
117 static void interleave(uint8_t *dst, uint8_t *src, int w, int h,
118                        int dst_linesize, int src_linesize,
119                        enum FilterMode mode, int swap)
120 {
121     const int a = swap;
122     const int b = 1 - a;
123     const int m = h >> 1;
124     int y;
125
126     switch (mode) {
127     case MODE_DEINTERLEAVE:
128         for (y = 0; y < m; y++) {
129             memcpy(dst + dst_linesize *  y     , src + src_linesize * (y * 2 + a), w);
130             memcpy(dst + dst_linesize * (y + m), src + src_linesize * (y * 2 + b), w);
131         }
132         break;
133     case MODE_NONE:
134         for (y = 0; y < m; y++) {
135             memcpy(dst + dst_linesize *  y * 2     , src + src_linesize * (y * 2 + a), w);
136             memcpy(dst + dst_linesize * (y * 2 + 1), src + src_linesize * (y * 2 + b), w);
137         }
138         break;
139     case MODE_INTERLEAVE:
140         for (y = 0; y < m; y++) {
141             memcpy(dst + dst_linesize * (y * 2 + a), src + src_linesize *  y     , w);
142             memcpy(dst + dst_linesize * (y * 2 + b), src + src_linesize * (y + m), w);
143         }
144         break;
145     }
146 }
147
148 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *inpicref)
149 {
150     IlContext *il = inlink->dst->priv;
151     AVFilterLink *outlink = inlink->dst->outputs[0];
152     AVFilterBufferRef *out;
153     int ret, comp;
154
155     out = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
156     if (!out) {
157         avfilter_unref_bufferp(&inpicref);
158         return AVERROR(ENOMEM);
159     }
160     avfilter_copy_buffer_ref_props(out, inpicref);
161
162     interleave(out->data[0], inpicref->data[0],
163                il->linesize[0], inlink->h,
164                out->linesize[0], inpicref->linesize[0],
165                il->luma_mode, il->luma_swap);
166
167     for (comp = 1; comp < (il->nb_planes - il->has_alpha); comp++) {
168         interleave(out->data[comp], inpicref->data[comp],
169                    il->linesize[comp], il->chroma_height,
170                    out->linesize[comp], inpicref->linesize[comp],
171                    il->chroma_mode, il->chroma_swap);
172     }
173
174     if (il->has_alpha) {
175         int comp = il->nb_planes - 1;
176         interleave(out->data[comp], inpicref->data[comp],
177                    il->linesize[comp], inlink->h,
178                    out->linesize[comp], inpicref->linesize[comp],
179                    il->alpha_mode, il->alpha_swap);
180     }
181
182     ret = ff_filter_frame(outlink, out);
183     avfilter_unref_bufferp(&inpicref);
184     return ret;
185 }
186
187 static int query_formats(AVFilterContext *ctx)
188 {
189     AVFilterFormats *formats = NULL;
190     int fmt;
191
192     for (fmt = 0; fmt < AV_PIX_FMT_NB; fmt++) {
193         const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(fmt);
194         if (!(desc->flags & PIX_FMT_PAL))
195             ff_add_format(&formats, fmt);
196     }
197
198     ff_set_common_formats(ctx, formats);
199     return 0;
200 }
201
202 static const AVFilterPad inputs[] = {
203     {
204         .name             = "default",
205         .type             = AVMEDIA_TYPE_VIDEO,
206         .get_video_buffer = ff_null_get_video_buffer,
207         .filter_frame     = filter_frame,
208         .config_props     = config_input,
209     },
210     { NULL }
211 };
212
213 static const AVFilterPad outputs[] = {
214     {
215         .name          = "default",
216         .type          = AVMEDIA_TYPE_VIDEO,
217     },
218     { NULL }
219 };
220
221 AVFilter avfilter_vf_il = {
222     .name          = "il",
223     .description   = NULL_IF_CONFIG_SMALL("Deinterleave or interleave fields."),
224     .priv_size     = sizeof(IlContext),
225     .init          = init,
226     .query_formats = query_formats,
227     .inputs        = inputs,
228     .outputs       = outputs,
229     .priv_class    = &il_class,
230 };