FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavfilter/vf_hsvkey.c
Date: 2024-04-19 17:50:32
Exec Total Coverage
Lines: 0 139 0.0%
Functions: 0 8 0.0%
Branches: 0 42 0.0%

Line Branch Exec Source
1 /*
2 * Copyright (c) 2021 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 <float.h>
22
23 #include "libavutil/opt.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/pixdesc.h"
26 #include "avfilter.h"
27 #include "internal.h"
28
29 typedef struct HSVKeyContext {
30 const AVClass *class;
31
32 float hue, hue_opt, sat, val;
33 float similarity;
34 float blend;
35
36 float scale;
37
38 float half;
39
40 int depth;
41 int max;
42
43 int hsub_log2;
44 int vsub_log2;
45
46 int (*do_slice)(AVFilterContext *ctx, void *arg,
47 int jobnr, int nb_jobs);
48 } HSVKeyContext;
49
50 #define SQR(x) ((x)*(x))
51
52 static int do_hsvkey_pixel(HSVKeyContext *s, int y, int u, int v,
53 float hue_key, float sat_key, float val_key)
54 {
55 const float similarity = s->similarity;
56 const float scale = s->scale;
57 const float blend = s->blend;
58 const int imax = s->max;
59 const float max = imax;
60 const float half = s->half;
61 const float uf = u - half;
62 const float vf = v - half;
63 const float hue = hue_key < 0.f ? -hue_key : atan2f(uf, vf) + M_PI;
64 const float sat = sat_key < 0.f ? -sat_key : sqrtf((uf * uf + vf * vf) / (half * half * 2.f));
65 const float val = val_key < 0.f ? -val_key : scale * y;
66 float diff;
67
68 hue_key = fabsf(hue_key);
69 sat_key = fabsf(sat_key);
70 val_key = fabsf(val_key);
71
72 diff = sqrtf(fmaxf(SQR(sat) * SQR(val) +
73 SQR(sat_key) * SQR(val_key) -
74 2.f * sat * val * sat_key * val_key * cosf(hue_key - hue) +
75 SQR(val - val_key), 0.f));
76 if (diff < similarity) {
77 return 0;
78 } else if (blend > FLT_MIN) {
79 return av_clipf((diff - similarity) / blend, 0.f, 1.f) * max;
80 } else {
81 return imax;
82 }
83
84 return 0;
85 }
86
87 static int do_hsvkey_slice(AVFilterContext *avctx, void *arg, int jobnr, int nb_jobs)
88 {
89 HSVKeyContext *s = avctx->priv;
90 AVFrame *frame = arg;
91 const int slice_start = (frame->height * jobnr) / nb_jobs;
92 const int slice_end = (frame->height * (jobnr + 1)) / nb_jobs;
93 const int hsub_log2 = s->hsub_log2;
94 const int vsub_log2 = s->vsub_log2;
95 const float hue = s->hue;
96 const float sat = s->sat;
97 const float val = s->val;
98
99 for (int y = slice_start; y < slice_end; y++) {
100 for (int x = 0; x < frame->width; x++) {
101 int Y = frame->data[0][frame->linesize[0] * y + x];
102 int u = frame->data[1][frame->linesize[1] * (y >> vsub_log2) + (x >> hsub_log2)];
103 int v = frame->data[2][frame->linesize[2] * (y >> vsub_log2) + (x >> hsub_log2)];
104
105 frame->data[3][frame->linesize[3] * y + x] = do_hsvkey_pixel(s, Y, u, v, hue, sat, val);
106 }
107 }
108
109 return 0;
110 }
111
112 static int do_hsvkey16_slice(AVFilterContext *avctx, void *arg, int jobnr, int nb_jobs)
113 {
114 HSVKeyContext *s = avctx->priv;
115 AVFrame *frame = arg;
116 const int slice_start = (frame->height * jobnr) / nb_jobs;
117 const int slice_end = (frame->height * (jobnr + 1)) / nb_jobs;
118 const int hsub_log2 = s->hsub_log2;
119 const int vsub_log2 = s->vsub_log2;
120 const float hue = s->hue;
121 const float sat = s->sat;
122 const float val = s->val;
123
124 for (int y = slice_start; y < slice_end; ++y) {
125 for (int x = 0; x < frame->width; ++x) {
126 uint16_t *dst = (uint16_t *)(frame->data[3] + frame->linesize[3] * y);
127 int Y = AV_RN16(&frame->data[0][frame->linesize[0] * y + 2 * x]);
128 int u = AV_RN16(&frame->data[1][frame->linesize[1] * (y >> vsub_log2) + 2 * (x >> hsub_log2)]);
129 int v = AV_RN16(&frame->data[2][frame->linesize[2] * (y >> vsub_log2) + 2 * (x >> hsub_log2)]);
130
131 dst[x] = do_hsvkey_pixel(s, Y, u, v, hue, sat, val);
132 }
133 }
134
135 return 0;
136 }
137
138 static int do_hsvhold_slice(AVFilterContext *avctx, void *arg, int jobnr, int nb_jobs)
139 {
140 HSVKeyContext *s = avctx->priv;
141 AVFrame *frame = arg;
142 const int hsub_log2 = s->hsub_log2;
143 const int vsub_log2 = s->vsub_log2;
144 const int width = frame->width >> hsub_log2;
145 const int height = frame->height >> vsub_log2;
146 const int slice_start = (height * jobnr) / nb_jobs;
147 const int slice_end = (height * (jobnr + 1)) / nb_jobs;
148 const float scale = s->scale;
149 const float hue = s->hue;
150 const float sat = s->sat;
151 const float val = s->val;
152
153 for (int y = slice_start; y < slice_end; ++y) {
154 for (int x = 0; x < width; ++x) {
155 uint8_t *dstu = frame->data[1] + frame->linesize[1] * y;
156 uint8_t *dstv = frame->data[2] + frame->linesize[2] * y;
157 int Y = frame->data[0][frame->linesize[0] * (y << vsub_log2) + (x << hsub_log2)];
158 int u = frame->data[1][frame->linesize[1] * y + x];
159 int v = frame->data[2][frame->linesize[2] * y + x];
160 int t = do_hsvkey_pixel(s, Y, u, v, hue, sat, val);
161
162 if (t > 0) {
163 float f = 1.f - t * scale;
164
165 dstu[x] = 128 + (u - 128) * f;
166 dstv[x] = 128 + (v - 128) * f;
167 }
168 }
169 }
170
171 return 0;
172 }
173
174 static int do_hsvhold16_slice(AVFilterContext *avctx, void *arg, int jobnr, int nb_jobs)
175 {
176 HSVKeyContext *s = avctx->priv;
177 AVFrame *frame = arg;
178 const int hsub_log2 = s->hsub_log2;
179 const int vsub_log2 = s->vsub_log2;
180 const int width = frame->width >> hsub_log2;
181 const int height = frame->height >> vsub_log2;
182 const int slice_start = (height * jobnr) / nb_jobs;
183 const int slice_end = (height * (jobnr + 1)) / nb_jobs;
184 const float scale = s->scale;
185 const float half = s->half;
186 const float hue = s->hue;
187 const float sat = s->sat;
188 const float val = s->val;
189
190 for (int y = slice_start; y < slice_end; ++y) {
191 for (int x = 0; x < width; ++x) {
192 uint16_t *dstu = (uint16_t *)(frame->data[1] + frame->linesize[1] * y);
193 uint16_t *dstv = (uint16_t *)(frame->data[2] + frame->linesize[2] * y);
194 int Y = AV_RN16(&frame->data[0][frame->linesize[0] * (y << vsub_log2) + 2 * (x << hsub_log2)]);
195 int u = AV_RN16(&frame->data[1][frame->linesize[1] * y + 2 * x]);
196 int v = AV_RN16(&frame->data[2][frame->linesize[2] * y + 2 * x]);
197 int t = do_hsvkey_pixel(s, Y, u, v, hue, sat, val);
198
199 if (t > 0) {
200 float f = 1.f - t * scale;
201
202 dstu[x] = half + (u - half) * f;
203 dstv[x] = half + (v - half) * f;
204 }
205 }
206 }
207
208 return 0;
209 }
210
211 static int filter_frame(AVFilterLink *link, AVFrame *frame)
212 {
213 AVFilterContext *avctx = link->dst;
214 HSVKeyContext *s = avctx->priv;
215 int res;
216
217 s->hue = FFSIGN(s->hue_opt) *M_PI * fmodf(526.f - fabsf(s->hue_opt), 360.f) / 180.f;
218 if (res = ff_filter_execute(avctx, s->do_slice, frame, NULL,
219 FFMIN(frame->height, ff_filter_get_nb_threads(avctx))))
220 return res;
221
222 return ff_filter_frame(avctx->outputs[0], frame);
223 }
224
225 static av_cold int config_output(AVFilterLink *outlink)
226 {
227 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(outlink->format);
228 AVFilterContext *avctx = outlink->src;
229 HSVKeyContext *s = avctx->priv;
230
231 s->depth = desc->comp[0].depth;
232 s->max = (1 << s->depth) - 1;
233 s->half = 0.5f * s->max;
234 s->scale = 1.f / s->max;
235
236 if (!strcmp(avctx->filter->name, "hsvkey")) {
237 s->do_slice = s->depth <= 8 ? do_hsvkey_slice : do_hsvkey16_slice;
238 } else {
239 s->do_slice = s->depth <= 8 ? do_hsvhold_slice: do_hsvhold16_slice;
240 }
241
242 return 0;
243 }
244
245 static av_cold int config_input(AVFilterLink *inlink)
246 {
247 AVFilterContext *avctx = inlink->dst;
248 HSVKeyContext *s = avctx->priv;
249 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
250
251 s->hsub_log2 = desc->log2_chroma_w;
252 s->vsub_log2 = desc->log2_chroma_h;
253
254 return 0;
255 }
256
257 static const enum AVPixelFormat key_pixel_fmts[] = {
258 AV_PIX_FMT_YUVA420P,
259 AV_PIX_FMT_YUVA422P,
260 AV_PIX_FMT_YUVA444P,
261 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
262 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
263 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
264 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
265 AV_PIX_FMT_NONE
266 };
267
268 static const AVFilterPad inputs[] = {
269 {
270 .name = "default",
271 .type = AVMEDIA_TYPE_VIDEO,
272 .flags = AVFILTERPAD_FLAG_NEEDS_WRITABLE,
273 .filter_frame = filter_frame,
274 .config_props = config_input,
275 },
276 };
277
278 static const AVFilterPad outputs[] = {
279 {
280 .name = "default",
281 .type = AVMEDIA_TYPE_VIDEO,
282 .config_props = config_output,
283 },
284 };
285
286 #define OFFSET(x) offsetof(HSVKeyContext, x)
287 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
288
289 static const AVOption hsvkey_options[] = {
290 { "hue", "set the hue value", OFFSET(hue_opt), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -360, 360, FLAGS },
291 { "sat", "set the saturation value", OFFSET(sat), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -1, 1, FLAGS },
292 { "val", "set the value value", OFFSET(val), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -1, 1, FLAGS },
293 { "similarity", "set the hsvkey similarity value", OFFSET(similarity), AV_OPT_TYPE_FLOAT, { .dbl = 0.01}, 0.00001, 1.0, FLAGS },
294 { "blend", "set the hsvkey blend value", OFFSET(blend), AV_OPT_TYPE_FLOAT, { .dbl = 0.0 }, 0.0, 1.0, FLAGS },
295 { NULL }
296 };
297
298 AVFILTER_DEFINE_CLASS(hsvkey);
299
300 const AVFilter ff_vf_hsvkey = {
301 .name = "hsvkey",
302 .description = NULL_IF_CONFIG_SMALL("Turns a certain HSV range into transparency. Operates on YUV colors."),
303 .priv_size = sizeof(HSVKeyContext),
304 .priv_class = &hsvkey_class,
305 FILTER_INPUTS(inputs),
306 FILTER_OUTPUTS(outputs),
307 FILTER_PIXFMTS_ARRAY(key_pixel_fmts),
308 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
309 .process_command = ff_filter_process_command,
310 };
311
312 static const enum AVPixelFormat hold_pixel_fmts[] = {
313 AV_PIX_FMT_YUV420P,
314 AV_PIX_FMT_YUV422P,
315 AV_PIX_FMT_YUV444P,
316 AV_PIX_FMT_YUVA420P,
317 AV_PIX_FMT_YUVA422P,
318 AV_PIX_FMT_YUVA444P,
319 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
320 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
321 AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV420P12,
322 AV_PIX_FMT_YUV444P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV420P14,
323 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
324 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
325 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
326 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
327 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
328 AV_PIX_FMT_NONE
329 };
330
331 static const AVOption hsvhold_options[] = {
332 { "hue", "set the hue value", OFFSET(hue_opt), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -360, 360, FLAGS },
333 { "sat", "set the saturation value", OFFSET(sat), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -1, 1, FLAGS },
334 { "val", "set the value value", OFFSET(val), AV_OPT_TYPE_FLOAT, { .dbl = 0 }, -1, 1, FLAGS },
335 { "similarity", "set the hsvhold similarity value", OFFSET(similarity), AV_OPT_TYPE_FLOAT, { .dbl = 0.01 }, 0.00001, 1.0, FLAGS },
336 { "blend", "set the hsvhold blend value", OFFSET(blend), AV_OPT_TYPE_FLOAT, { .dbl = 0.0 }, 0.0, 1.0, FLAGS },
337 { NULL }
338 };
339
340 AVFILTER_DEFINE_CLASS(hsvhold);
341
342 const AVFilter ff_vf_hsvhold = {
343 .name = "hsvhold",
344 .description = NULL_IF_CONFIG_SMALL("Turns a certain HSV range into gray."),
345 .priv_size = sizeof(HSVKeyContext),
346 .priv_class = &hsvhold_class,
347 FILTER_INPUTS(inputs),
348 FILTER_OUTPUTS(outputs),
349 FILTER_PIXFMTS_ARRAY(hold_pixel_fmts),
350 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
351 .process_command = ff_filter_process_command,
352 };
353