FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavfilter/vf_maskedmerge.c
Date: 2026-09-27 18:38:33
Exec Total Coverage
Lines: 0 118 0.0%
Functions: 0 9 0.0%
Branches: 0 46 0.0%

Line Branch Exec Source
1 /*
2 * Copyright (c) 2015 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 "filters.h"
26 #include "video.h"
27 #include "maskedmerge.h"
28
29 #define OFFSET(x) offsetof(MaskedMergeContext, x)
30 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
31
32 static const AVOption maskedmerge_options[] = {
33 { "planes", "set planes", OFFSET(planes), AV_OPT_TYPE_INT, {.i64=0xF}, 0, 0xF, FLAGS },
34 { NULL }
35 };
36
37 AVFILTER_DEFINE_CLASS(maskedmerge);
38
39 static const enum AVPixelFormat pix_fmts[] = {
40 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
41 AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
42 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
43 AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
44 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
45 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
46 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, AV_PIX_FMT_YUV440P10,
47 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
48 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
49 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
50 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
51 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
52 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
53 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
54 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
55 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
56 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
57 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
58 AV_PIX_FMT_GRAYF32, AV_PIX_FMT_GBRPF32, AV_PIX_FMT_GBRAPF32,
59 AV_PIX_FMT_NONE
60 };
61
62 typedef struct ThreadData {
63 AVFrame *base, *overlay, *mask;
64 AVFrame *out;
65 } ThreadData;
66
67 ✗ static int filter_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
68 {
69 ✗ MaskedMergeContext *s = ctx->priv;
70 ✗ ThreadData *td = arg;
71 ✗ AVFrame *base = td->base;
72 ✗ AVFrame *overlay = td->overlay;
73 ✗ AVFrame *mask = td->mask;
74 ✗ AVFrame *out = td->out;
75 int p;
76
77 ✗ for (p = 0; p < s->nb_planes; p++) {
78 ✗ const int h = s->height[p];
79 ✗ const int slice_start = ff_slice_pos(h, jobnr, nb_jobs);
80 ✗ const int slice_end = ff_slice_pos(h, jobnr + 1, nb_jobs);
81
82 ✗ if (!((1 << p) & s->planes)) {
83 ✗ av_image_copy_plane(out->data[p] + slice_start * out->linesize[p],
84 out->linesize[p],
85 ✗ base->data[p] + slice_start * base->linesize[p],
86 base->linesize[p],
87 s->linesize[p], slice_end - slice_start);
88 ✗ continue;
89 }
90
91 ✗ s->maskedmerge(base->data[p] + slice_start * base->linesize[p],
92 ✗ overlay->data[p] + slice_start * overlay->linesize[p],
93 ✗ mask->data[p] + slice_start * mask->linesize[p],
94 ✗ out->data[p] + slice_start * out->linesize[p],
95 ✗ base->linesize[p], overlay->linesize[p],
96 ✗ mask->linesize[p], out->linesize[p],
97 s->width[p], slice_end - slice_start,
98 s->half, s->max);
99 }
100
101 ✗ return 0;
102 }
103
104 ✗ static int process_frame(FFFrameSync *fs)
105 {
106 ✗ AVFilterContext *ctx = fs->parent;
107 ✗ MaskedMergeContext *s = fs->opaque;
108 ✗ AVFilterLink *outlink = ctx->outputs[0];
109 AVFrame *out, *base, *overlay, *mask;
110 ThreadData td;
111 int ret;
112
113 ✗ if ((ret = ff_framesync_get_frame(&s->fs, 0, &base, 0)) < 0 ||
114 ✗ (ret = ff_framesync_get_frame(&s->fs, 1, &overlay, 0)) < 0 ||
115 ✗ (ret = ff_framesync_get_frame(&s->fs, 2, &mask, 0)) < 0)
116 ✗ return ret;
117
118 ✗ if (ctx->is_disabled) {
119 ✗ out = av_frame_clone(base);
120 ✗ if (!out)
121 ✗ return AVERROR(ENOMEM);
122 } else {
123 ✗ out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
124 ✗ if (!out)
125 ✗ return AVERROR(ENOMEM);
126 ✗ av_frame_copy_props(out, base);
127
128 ✗ td.out = out;
129 ✗ td.base = base;
130 ✗ td.overlay = overlay;
131 ✗ td.mask = mask;
132 ✗ ff_filter_execute(ctx, filter_slice, &td, NULL,
133 ✗ FFMIN(s->height[2], ff_filter_get_nb_threads(ctx)));
134 }
135 ✗ out->pts = av_rescale_q(s->fs.pts, s->fs.time_base, outlink->time_base);
136
137 ✗ return ff_filter_frame(outlink, out);
138 }
139
140 #define MASKEDMERGE(n, type, ctype, half, max, div) \
141 static void maskedmerge##n(const uint8_t *bbsrc, const uint8_t *oosrc, \
142 const uint8_t *mmsrc, uint8_t *ddst, \
143 ptrdiff_t blinesize, ptrdiff_t olinesize, \
144 ptrdiff_t mlinesize, ptrdiff_t dlinesize, \
145 int w, int h, \
146 int hhalf, int mmax) \
147 { \
148 const type *bsrc = (const type *)bbsrc; \
149 const type *osrc = (const type *)oosrc; \
150 const type *msrc = (const type *)mmsrc; \
151 type *dst = (type *)ddst; \
152 \
153 dlinesize /= sizeof(type); \
154 blinesize /= sizeof(type); \
155 olinesize /= sizeof(type); \
156 mlinesize /= sizeof(type); \
157 \
158 for (int y = 0; y < h; y++) { \
159 for (int x = 0; x < w; x++) { \
160 const type invm = max - msrc[x]; \
161 const ctype r = ((ctype)(bsrc[x] * invm) + \
162 (ctype)(msrc[x] * osrc[x] + half)) div; \
163 dst[x] = r; \
164 } \
165 \
166 dst += dlinesize; \
167 bsrc += blinesize; \
168 osrc += olinesize; \
169 msrc += mlinesize; \
170 } \
171 }
172
173 ✗ MASKEDMERGE(8, uint8_t, uint16_t, 127, 255, / 255)
174 ✗ MASKEDMERGE(16, uint16_t, uint32_t, hhalf, mmax, / mmax)
175 ✗ MASKEDMERGE(32, float, float, 0.f, 1.f, + 0.f)
176
177 ✗ static int config_input(AVFilterLink *inlink)
178 {
179 ✗ AVFilterContext *ctx = inlink->dst;
180 ✗ MaskedMergeContext *s = ctx->priv;
181 ✗ const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
182 int vsub, hsub;
183
184 ✗ s->nb_planes = av_pix_fmt_count_planes(inlink->format);
185
186 ✗ hsub = desc->log2_chroma_w;
187 ✗ vsub = desc->log2_chroma_h;
188 ✗ s->height[1] = s->height[2] = AV_CEIL_RSHIFT(inlink->h, vsub);
189 ✗ s->height[0] = s->height[3] = inlink->h;
190 ✗ s->width[1] = s->width[2] = AV_CEIL_RSHIFT(inlink->w, hsub);
191 ✗ s->width[0] = s->width[3] = inlink->w;
192
193 ✗ s->depth = desc->comp[0].depth;
194 ✗ s->max = (1 << s->depth) - 1;
195 ✗ s->half = s->max / 2;
196
197 ✗ if (s->depth == 8)
198 ✗ s->maskedmerge = maskedmerge8;
199 ✗ else if (s->depth <= 16)
200 ✗ s->maskedmerge = maskedmerge16;
201 else
202 ✗ s->maskedmerge = maskedmerge32;
203
204 #if ARCH_X86 && HAVE_X86ASM
205 ✗ ff_maskedmerge_init_x86(s);
206 #endif
207
208 ✗ return 0;
209 }
210
211 ✗ static int config_output(AVFilterLink *outlink)
212 {
213 ✗ AVFilterContext *ctx = outlink->src;
214 ✗ MaskedMergeContext *s = ctx->priv;
215 ✗ AVFilterLink *base = ctx->inputs[0];
216 ✗ AVFilterLink *overlay = ctx->inputs[1];
217 ✗ AVFilterLink *mask = ctx->inputs[2];
218 ✗ FilterLink *il = ff_filter_link(base);
219 ✗ FilterLink *ol = ff_filter_link(outlink);
220 FFFrameSyncIn *in;
221 int ret;
222
223 ✗ if (base->w != overlay->w || base->h != overlay->h ||
224 ✗ base->w != mask->w || base->h != mask->h) {
225 ✗ av_log(ctx, AV_LOG_ERROR, "First input link %s parameters "
226 "(size %dx%d) do not match the corresponding "
227 "second input link %s parameters (size %dx%d) "
228 "and/or third input link %s parameters (size %dx%d)\n",
229 ✗ ctx->input_pads[0].name, base->w, base->h,
230 ✗ ctx->input_pads[1].name, overlay->w, overlay->h,
231 ✗ ctx->input_pads[2].name, mask->w, mask->h);
232 ✗ return AVERROR(EINVAL);
233 }
234
235 ✗ outlink->w = base->w;
236 ✗ outlink->h = base->h;
237 ✗ outlink->sample_aspect_ratio = base->sample_aspect_ratio;
238 ✗ ol->frame_rate = il->frame_rate;
239
240 ✗ if ((ret = av_image_fill_linesizes(s->linesize, outlink->format, outlink->w)) < 0)
241 ✗ return ret;
242
243 ✗ if ((ret = ff_framesync_init(&s->fs, ctx, 3)) < 0)
244 ✗ return ret;
245
246 ✗ in = s->fs.in;
247 ✗ in[0].time_base = base->time_base;
248 ✗ in[1].time_base = overlay->time_base;
249 ✗ in[2].time_base = mask->time_base;
250 ✗ in[0].sync = 1;
251 ✗ in[0].before = EXT_STOP;
252 ✗ in[0].after = EXT_INFINITY;
253 ✗ in[1].sync = 1;
254 ✗ in[1].before = EXT_STOP;
255 ✗ in[1].after = EXT_INFINITY;
256 ✗ in[2].sync = 1;
257 ✗ in[2].before = EXT_STOP;
258 ✗ in[2].after = EXT_INFINITY;
259 ✗ s->fs.opaque = s;
260 ✗ s->fs.on_event = process_frame;
261
262 ✗ ret = ff_framesync_configure(&s->fs);
263 ✗ outlink->time_base = s->fs.time_base;
264
265 ✗ return ret;
266 }
267
268 ✗ static int activate(AVFilterContext *ctx)
269 {
270 ✗ MaskedMergeContext *s = ctx->priv;
271 ✗ return ff_framesync_activate(&s->fs);
272 }
273
274 ✗ static av_cold void uninit(AVFilterContext *ctx)
275 {
276 ✗ MaskedMergeContext *s = ctx->priv;
277
278 ✗ ff_framesync_uninit(&s->fs);
279 ✗ }
280
281 static const AVFilterPad maskedmerge_inputs[] = {
282 {
283 .name = "base",
284 .type = AVMEDIA_TYPE_VIDEO,
285 .config_props = config_input,
286 },
287 {
288 .name = "overlay",
289 .type = AVMEDIA_TYPE_VIDEO,
290 },
291 {
292 .name = "mask",
293 .type = AVMEDIA_TYPE_VIDEO,
294 },
295 };
296
297 static const AVFilterPad maskedmerge_outputs[] = {
298 {
299 .name = "default",
300 .type = AVMEDIA_TYPE_VIDEO,
301 .config_props = config_output,
302 },
303 };
304
305 const FFFilter ff_vf_maskedmerge = {
306 .p.name = "maskedmerge",
307 .p.description = NULL_IF_CONFIG_SMALL("Merge first stream with second stream using third stream as mask."),
308 .p.priv_class = &maskedmerge_class,
309 .p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL |
310 AVFILTER_FLAG_SLICE_THREADS,
311 .priv_size = sizeof(MaskedMergeContext),
312 .uninit = uninit,
313 .activate = activate,
314 FILTER_INPUTS(maskedmerge_inputs),
315 FILTER_OUTPUTS(maskedmerge_outputs),
316 FILTER_PIXFMTS_ARRAY(pix_fmts),
317 .process_command = ff_filter_process_command,
318 };
319