avfilter/vf_overlay: Restore shorthand option order
[ffmpeg.git] / libavfilter / vf_maskedclamp.c
1 /*
2  * Copyright (c) 2016 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/imgutils.h"
22 #include "libavutil/pixdesc.h"
23 #include "libavutil/opt.h"
24 #include "avfilter.h"
25 #include "formats.h"
26 #include "internal.h"
27 #include "video.h"
28 #include "framesync2.h"
29
30 #define OFFSET(x) offsetof(MaskedClampContext, x)
31 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
32
33 typedef struct MaskedClampContext {
34     const AVClass *class;
35
36     int planes;
37     int undershoot;
38     int overshoot;
39
40     int linesize[4];
41     int width[4], height[4];
42     int nb_planes;
43     int depth;
44     FFFrameSync fs;
45
46     void (*maskedclamp)(const uint8_t *bsrc, const uint8_t *osrc,
47                         const uint8_t *msrc, uint8_t *dst,
48                         ptrdiff_t blinesize, ptrdiff_t darklinesize,
49                         ptrdiff_t brightlinesize, ptrdiff_t destlinesize,
50                         int w, int h, int undershoot, int overshoot);
51 } MaskedClampContext;
52
53 static const AVOption maskedclamp_options[] = {
54     { "undershoot", "set undershoot", OFFSET(undershoot), AV_OPT_TYPE_INT, {.i64=0},   0, UINT16_MAX, FLAGS },
55     { "overshoot",  "set overshoot",  OFFSET(overshoot),  AV_OPT_TYPE_INT, {.i64=0},   0, UINT16_MAX, FLAGS },
56     { "planes",     "set planes",     OFFSET(planes),     AV_OPT_TYPE_INT, {.i64=0xF}, 0, 0xF,        FLAGS },
57     { NULL }
58 };
59
60 AVFILTER_DEFINE_CLASS(maskedclamp);
61
62 static int query_formats(AVFilterContext *ctx)
63 {
64     static const enum AVPixelFormat pix_fmts[] = {
65         AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
66         AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
67         AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
68         AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
69         AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
70         AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
71         AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
72         AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
73         AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
74         AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
75         AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
76         AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
77         AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
78         AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
79         AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
80         AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
81         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY16,
82         AV_PIX_FMT_NONE
83     };
84
85     return ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
86 }
87
88 static int process_frame(FFFrameSync *fs)
89 {
90     AVFilterContext *ctx = fs->parent;
91     MaskedClampContext *s = fs->opaque;
92     AVFilterLink *outlink = ctx->outputs[0];
93     AVFrame *out, *base, *dark, *bright;
94     int ret;
95
96     if ((ret = ff_framesync2_get_frame(&s->fs, 0, &base,   0)) < 0 ||
97         (ret = ff_framesync2_get_frame(&s->fs, 1, &dark,   0)) < 0 ||
98         (ret = ff_framesync2_get_frame(&s->fs, 2, &bright, 0)) < 0)
99         return ret;
100
101     if (ctx->is_disabled) {
102         out = av_frame_clone(base);
103         if (!out)
104             return AVERROR(ENOMEM);
105     } else {
106         int p;
107
108         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
109         if (!out)
110             return AVERROR(ENOMEM);
111         av_frame_copy_props(out, base);
112
113         for (p = 0; p < s->nb_planes; p++) {
114             if (!((1 << p) & s->planes)) {
115                 av_image_copy_plane(out->data[p], out->linesize[p], base->data[p], base->linesize[p],
116                                     s->linesize[p], s->height[p]);
117                 continue;
118             }
119
120             s->maskedclamp(base->data[p], dark->data[p],
121                            bright->data[p], out->data[p],
122                            base->linesize[p], dark->linesize[p],
123                            bright->linesize[p], out->linesize[p],
124                            s->width[p], s->height[p],
125                            s->undershoot, s->overshoot);
126         }
127     }
128     out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
129
130     return ff_filter_frame(outlink, out);
131 }
132
133 static void maskedclamp8(const uint8_t *bsrc, const uint8_t *darksrc,
134                          const uint8_t *brightsrc, uint8_t *dst,
135                          ptrdiff_t blinesize, ptrdiff_t darklinesize,
136                          ptrdiff_t brightlinesize, ptrdiff_t dlinesize,
137                          int w, int h,
138                          int undershoot, int overshoot)
139 {
140     int x, y;
141
142     for (y = 0; y < h; y++) {
143         for (x = 0; x < w; x++) {
144             if (bsrc[x] < darksrc[x] - undershoot)
145                 dst[x] = darksrc[x] - undershoot;
146             else if (bsrc[x] > brightsrc[x] + overshoot)
147                 dst[x] = brightsrc[x] + overshoot;
148             else
149                 dst[x] = bsrc[x];
150         }
151
152         dst  += dlinesize;
153         bsrc += blinesize;
154         darksrc += darklinesize;
155         brightsrc += brightlinesize;
156     }
157 }
158
159 static void maskedclamp16(const uint8_t *bbsrc, const uint8_t *oosrc,
160                           const uint8_t *mmsrc, uint8_t *ddst,
161                           ptrdiff_t blinesize, ptrdiff_t darklinesize,
162                           ptrdiff_t brightlinesize, ptrdiff_t dlinesize,
163                           int w, int h,
164                           int undershoot, int overshoot)
165 {
166     const uint16_t *bsrc = (const uint16_t *)bbsrc;
167     const uint16_t *darksrc = (const uint16_t *)oosrc;
168     const uint16_t *brightsrc = (const uint16_t *)mmsrc;
169     uint16_t *dst = (uint16_t *)ddst;
170     int x, y;
171
172     dlinesize /= 2;
173     blinesize /= 2;
174     darklinesize /= 2;
175     brightlinesize /= 2;
176
177     for (y = 0; y < h; y++) {
178         for (x = 0; x < w; x++) {
179             if (bsrc[x] < darksrc[x] - undershoot)
180                 dst[x] = darksrc[x] - undershoot;
181             else if (bsrc[x] > brightsrc[x] + overshoot)
182                 dst[x] = brightsrc[x] + overshoot;
183             else
184                 dst[x] = bsrc[x];
185         }
186
187         dst  += dlinesize;
188         bsrc += blinesize;
189         darksrc += darklinesize;
190         brightsrc += brightlinesize;
191     }
192 }
193
194 static int config_input(AVFilterLink *inlink)
195 {
196     AVFilterContext *ctx = inlink->dst;
197     MaskedClampContext *s = ctx->priv;
198     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
199     int vsub, hsub, ret;
200
201     s->nb_planes = av_pix_fmt_count_planes(inlink->format);
202
203     if ((ret = av_image_fill_linesizes(s->linesize, inlink->format, inlink->w)) < 0)
204         return ret;
205
206     hsub = desc->log2_chroma_w;
207     vsub = desc->log2_chroma_h;
208     s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
209     s->height[0] = s->height[3] = inlink->h;
210     s->width[1]  = s->width[2]  = AV_CEIL_RSHIFT(inlink->w, hsub);
211     s->width[0]  = s->width[3]  = inlink->w;
212
213     s->depth = desc->comp[0].depth;
214
215     if (desc->comp[0].depth == 8)
216         s->maskedclamp = maskedclamp8;
217     else
218         s->maskedclamp = maskedclamp16;
219
220     return 0;
221 }
222
223 static int config_output(AVFilterLink *outlink)
224 {
225     AVFilterContext *ctx = outlink->src;
226     MaskedClampContext *s = ctx->priv;
227     AVFilterLink *base = ctx->inputs[0];
228     AVFilterLink *dark = ctx->inputs[1];
229     AVFilterLink *bright = ctx->inputs[2];
230     FFFrameSyncIn *in;
231     int ret;
232
233     if (base->format != dark->format ||
234         base->format != bright->format) {
235         av_log(ctx, AV_LOG_ERROR, "inputs must be of same pixel format\n");
236         return AVERROR(EINVAL);
237     }
238     if (base->w                       != dark->w ||
239         base->h                       != dark->h ||
240         base->sample_aspect_ratio.num != dark->sample_aspect_ratio.num ||
241         base->sample_aspect_ratio.den != dark->sample_aspect_ratio.den ||
242         base->w                       != bright->w ||
243         base->h                       != bright->h ||
244         base->sample_aspect_ratio.num != bright->sample_aspect_ratio.num ||
245         base->sample_aspect_ratio.den != bright->sample_aspect_ratio.den) {
246         av_log(ctx, AV_LOG_ERROR, "First input link %s parameters "
247                "(size %dx%d, SAR %d:%d) do not match the corresponding "
248                "second input link %s parameters (%dx%d, SAR %d:%d) "
249                "and/or third input link %s parameters (%dx%d, SAR %d:%d)\n",
250                ctx->input_pads[0].name, base->w, base->h,
251                base->sample_aspect_ratio.num,
252                base->sample_aspect_ratio.den,
253                ctx->input_pads[1].name, dark->w, dark->h,
254                dark->sample_aspect_ratio.num,
255                dark->sample_aspect_ratio.den,
256                ctx->input_pads[2].name, bright->w, bright->h,
257                bright->sample_aspect_ratio.num,
258                bright->sample_aspect_ratio.den);
259         return AVERROR(EINVAL);
260     }
261
262     outlink->w = base->w;
263     outlink->h = base->h;
264     outlink->time_base = base->time_base;
265     outlink->sample_aspect_ratio = base->sample_aspect_ratio;
266     outlink->frame_rate = base->frame_rate;
267
268     if ((ret = ff_framesync2_init(&s->fs, ctx, 3)) < 0)
269         return ret;
270
271     in = s->fs.in;
272     in[0].time_base = base->time_base;
273     in[1].time_base = dark->time_base;
274     in[2].time_base = bright->time_base;
275     in[0].sync   = 1;
276     in[0].before = EXT_STOP;
277     in[0].after  = EXT_INFINITY;
278     in[1].sync   = 1;
279     in[1].before = EXT_STOP;
280     in[1].after  = EXT_INFINITY;
281     in[2].sync   = 1;
282     in[2].before = EXT_STOP;
283     in[2].after  = EXT_INFINITY;
284     s->fs.opaque   = s;
285     s->fs.on_event = process_frame;
286
287     return ff_framesync2_configure(&s->fs);
288 }
289
290 static int activate(AVFilterContext *ctx)
291 {
292     MaskedClampContext *s = ctx->priv;
293     return ff_framesync2_activate(&s->fs);
294 }
295
296 static av_cold void uninit(AVFilterContext *ctx)
297 {
298     MaskedClampContext *s = ctx->priv;
299
300     ff_framesync2_uninit(&s->fs);
301 }
302
303 static const AVFilterPad maskedclamp_inputs[] = {
304     {
305         .name         = "base",
306         .type         = AVMEDIA_TYPE_VIDEO,
307         .config_props = config_input,
308     },
309     {
310         .name         = "dark",
311         .type         = AVMEDIA_TYPE_VIDEO,
312     },
313     {
314         .name         = "bright",
315         .type         = AVMEDIA_TYPE_VIDEO,
316     },
317     { NULL }
318 };
319
320 static const AVFilterPad maskedclamp_outputs[] = {
321     {
322         .name          = "default",
323         .type          = AVMEDIA_TYPE_VIDEO,
324         .config_props  = config_output,
325     },
326     { NULL }
327 };
328
329 AVFilter ff_vf_maskedclamp = {
330     .name          = "maskedclamp",
331     .description   = NULL_IF_CONFIG_SMALL("Clamp first stream with second stream and third stream."),
332     .priv_size     = sizeof(MaskedClampContext),
333     .uninit        = uninit,
334     .activate      = activate,
335     .query_formats = query_formats,
336     .inputs        = maskedclamp_inputs,
337     .outputs       = maskedclamp_outputs,
338     .priv_class    = &maskedclamp_class,
339     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL,
340 };