2 * Copyright (c) 2003 Michael Niedermayer
3 * Copyright (c) 2012 Jeremy Tran
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
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
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * Apply a hue/saturation filter to the input video
25 * Ported from MPlayer libmpcodecs/vf_hue.c.
29 #include "libavutil/eval.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
39 #define HUE_DEFAULT_VAL 0
40 #define SAT_DEFAULT_VAL 1
42 #define HUE_DEFAULT_VAL_STRING AV_STRINGIFY(HUE_DEFAULT_VAL)
43 #define SAT_DEFAULT_VAL_STRING AV_STRINGIFY(SAT_DEFAULT_VAL)
45 #define SAT_MIN_VAL -10
46 #define SAT_MAX_VAL 10
48 static const char *const var_names[] = {
50 "pts", // presentation timestamp expressed in AV_TIME_BASE units
52 "t", // timestamp expressed in seconds
68 float hue_deg; /* hue expressed in degrees */
69 float hue; /* hue expressed in radians */
72 AVExpr *hue_deg_pexpr;
75 char *saturation_expr;
76 AVExpr *saturation_pexpr;
82 double var_values[VAR_NB];
85 #define OFFSET(x) offsetof(HueContext, x)
86 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
87 static const AVOption hue_options[] = {
88 { "h", "set the hue angle degrees expression", OFFSET(hue_deg_expr), AV_OPT_TYPE_STRING,
89 { .str = NULL }, .flags = FLAGS },
90 { "H", "set the hue angle radians expression", OFFSET(hue_expr), AV_OPT_TYPE_STRING,
91 { .str = NULL }, .flags = FLAGS },
92 { "s", "set the saturation expression", OFFSET(saturation_expr), AV_OPT_TYPE_STRING,
93 { .str = NULL }, .flags = FLAGS },
97 AVFILTER_DEFINE_CLASS(hue);
99 static inline void compute_sin_and_cos(HueContext *hue)
102 * Scale the value to the norm of the resulting (U,V) vector, that is
104 * This will be useful in the process_chrominance function.
106 hue->hue_sin = rint(sin(hue->hue) * (1 << 16) * hue->saturation);
107 hue->hue_cos = rint(cos(hue->hue) * (1 << 16) * hue->saturation);
110 #define SET_EXPRESSION(attr, name) do { \
111 if (hue->attr##_expr) { \
112 if ((ret = av_expr_parse(&hue->attr##_pexpr, hue->attr##_expr, var_names, \
113 NULL, NULL, NULL, NULL, 0, ctx)) < 0) { \
114 av_log(ctx, AV_LOG_ERROR, \
115 "Parsing failed for expression " #name "='%s'", \
117 hue->attr##_expr = old_##attr##_expr; \
118 hue->attr##_pexpr = old_##attr##_pexpr; \
119 return AVERROR(EINVAL); \
120 } else if (old_##attr##_pexpr) { \
121 av_freep(&old_##attr##_expr); \
122 av_expr_free(old_##attr##_pexpr); \
123 old_##attr##_pexpr = NULL; \
126 hue->attr##_expr = old_##attr##_expr; \
130 static inline int set_options(AVFilterContext *ctx, const char *args)
132 HueContext *hue = ctx->priv;
135 char *old_hue_expr, *old_hue_deg_expr, *old_saturation_expr;
136 AVExpr *old_hue_pexpr, *old_hue_deg_pexpr, *old_saturation_pexpr;
139 /* named options syntax */
140 if (strchr(args, '=')) {
141 old_hue_expr = hue->hue_expr;
142 old_hue_deg_expr = hue->hue_deg_expr;
143 old_saturation_expr = hue->saturation_expr;
145 old_hue_pexpr = hue->hue_pexpr;
146 old_hue_deg_pexpr = hue->hue_deg_pexpr;
147 old_saturation_pexpr = hue->saturation_pexpr;
149 hue->hue_expr = NULL;
150 hue->hue_deg_expr = NULL;
151 hue->saturation_expr = NULL;
153 if ((ret = av_set_options_string(hue, args, "=", ":")) < 0)
155 if (hue->hue_expr && hue->hue_deg_expr) {
156 av_log(ctx, AV_LOG_ERROR,
157 "H and h options are incompatible and cannot be specified "
158 "at the same time\n");
159 hue->hue_expr = old_hue_expr;
160 hue->hue_deg_expr = old_hue_deg_expr;
162 return AVERROR(EINVAL);
165 SET_EXPRESSION(hue_deg, h);
166 SET_EXPRESSION(hue, H);
167 SET_EXPRESSION(saturation, s);
169 hue->flat_syntax = 0;
171 av_log(ctx, AV_LOG_VERBOSE,
172 "H_expr:%s h_deg_expr:%s s_expr:%s\n",
173 hue->hue_expr, hue->hue_deg_expr, hue->saturation_expr);
175 /* compatibility h:s syntax */
177 n = sscanf(args, "%f%c%f%c", &hue->hue_deg, &c1, &hue->saturation, &c2);
178 if (n != 1 && (n != 3 || c1 != ':')) {
179 av_log(ctx, AV_LOG_ERROR,
180 "Invalid syntax for argument '%s': "
181 "must be in the form 'hue[:saturation]'\n", args);
182 return AVERROR(EINVAL);
185 if (hue->saturation < SAT_MIN_VAL || hue->saturation > SAT_MAX_VAL) {
186 av_log(ctx, AV_LOG_ERROR,
187 "Invalid value for saturation %0.1f: "
188 "must be included between range %d and +%d\n",
189 hue->saturation, SAT_MIN_VAL, SAT_MAX_VAL);
190 return AVERROR(EINVAL);
193 hue->hue = hue->hue_deg * M_PI / 180;
194 hue->flat_syntax = 1;
196 av_log(ctx, AV_LOG_VERBOSE,
197 "H:%0.1f h:%0.1f s:%0.1f\n",
198 hue->hue, hue->hue_deg, hue->saturation);
202 compute_sin_and_cos(hue);
207 static av_cold int init(AVFilterContext *ctx, const char *args)
209 HueContext *hue = ctx->priv;
211 hue->class = &hue_class;
212 av_opt_set_defaults(hue);
214 hue->saturation = SAT_DEFAULT_VAL;
215 hue->hue = HUE_DEFAULT_VAL;
216 hue->hue_deg_pexpr = NULL;
217 hue->hue_pexpr = NULL;
218 hue->flat_syntax = 1;
220 return set_options(ctx, args);
223 static av_cold void uninit(AVFilterContext *ctx)
225 HueContext *hue = ctx->priv;
229 av_free(hue->hue_deg_expr);
230 av_expr_free(hue->hue_deg_pexpr);
231 av_free(hue->hue_expr);
232 av_expr_free(hue->hue_pexpr);
233 av_free(hue->saturation_expr);
234 av_expr_free(hue->saturation_pexpr);
237 static int query_formats(AVFilterContext *ctx)
239 static const enum AVPixelFormat pix_fmts[] = {
240 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P,
241 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV411P,
242 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
247 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
252 static int config_props(AVFilterLink *inlink)
254 HueContext *hue = inlink->dst->priv;
255 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
257 hue->hsub = desc->log2_chroma_w;
258 hue->vsub = desc->log2_chroma_h;
260 hue->var_values[VAR_N] = 0;
261 hue->var_values[VAR_TB] = av_q2d(inlink->time_base);
262 hue->var_values[VAR_R] = inlink->frame_rate.num == 0 || inlink->frame_rate.den == 0 ?
263 NAN : av_q2d(inlink->frame_rate);
268 static void process_chrominance(uint8_t *udst, uint8_t *vdst, const int dst_linesize,
269 uint8_t *usrc, uint8_t *vsrc, const int src_linesize,
271 const int32_t c, const int32_t s)
273 int32_t u, v, new_u, new_v;
277 * If we consider U and V as the components of a 2D vector then its angle
278 * is the hue and the norm is the saturation
281 for (i = 0; i < w; i++) {
282 /* Normalize the components from range [16;140] to [-112;112] */
286 * Apply the rotation of the vector : (c * u) - (s * v)
288 * De-normalize the components (without forgetting to scale 128
290 * Finally scale back the result by >> 16
292 new_u = ((c * u) - (s * v) + (1 << 15) + (128 << 16)) >> 16;
293 new_v = ((s * u) + (c * v) + (1 << 15) + (128 << 16)) >> 16;
295 /* Prevent a potential overflow */
296 udst[i] = av_clip_uint8_c(new_u);
297 vdst[i] = av_clip_uint8_c(new_v);
300 usrc += src_linesize;
301 vsrc += src_linesize;
302 udst += dst_linesize;
303 vdst += dst_linesize;
307 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
308 #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts) * av_q2d(tb))
310 static int start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpic)
312 HueContext *hue = inlink->dst->priv;
313 AVFilterLink *outlink = inlink->dst->outputs[0];
314 AVFilterBufferRef *buf_out;
316 outlink->out_buf = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
317 if (!outlink->out_buf)
318 return AVERROR(ENOMEM);
320 avfilter_copy_buffer_ref_props(outlink->out_buf, inpic);
321 outlink->out_buf->video->w = outlink->w;
322 outlink->out_buf->video->h = outlink->h;
323 buf_out = avfilter_ref_buffer(outlink->out_buf, ~0);
325 return AVERROR(ENOMEM);
327 if (!hue->flat_syntax) {
328 hue->var_values[VAR_T] = TS2T(inpic->pts, inlink->time_base);
329 hue->var_values[VAR_PTS] = TS2D(inpic->pts);
331 if (hue->saturation_expr) {
332 hue->saturation = av_expr_eval(hue->saturation_pexpr, hue->var_values, NULL);
334 if (hue->saturation < SAT_MIN_VAL || hue->saturation > SAT_MAX_VAL) {
335 hue->saturation = av_clip(hue->saturation, SAT_MIN_VAL, SAT_MAX_VAL);
336 av_log(inlink->dst, AV_LOG_WARNING,
337 "Saturation value not in range [%d,%d]: clipping value to %0.1f\n",
338 SAT_MIN_VAL, SAT_MAX_VAL, hue->saturation);
342 if (hue->hue_deg_expr) {
343 hue->hue_deg = av_expr_eval(hue->hue_deg_pexpr, hue->var_values, NULL);
344 hue->hue = hue->hue_deg * M_PI / 180;
345 } else if (hue->hue_expr) {
346 hue->hue = av_expr_eval(hue->hue_pexpr, hue->var_values, NULL);
349 av_log(inlink->dst, AV_LOG_DEBUG,
350 "H:%0.1f s:%0.f t:%0.1f n:%d\n",
351 hue->hue, hue->saturation,
352 hue->var_values[VAR_T], (int)hue->var_values[VAR_N]);
354 compute_sin_and_cos(hue);
357 hue->var_values[VAR_N] += 1;
359 return ff_start_frame(outlink, buf_out);
362 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
364 HueContext *hue = inlink->dst->priv;
365 AVFilterBufferRef *inpic = inlink->cur_buf;
366 AVFilterBufferRef *outpic = inlink->dst->outputs[0]->out_buf;
367 uint8_t *inrow[3], *outrow[3]; // 0 : Y, 1 : U, 2 : V
370 inrow[0] = inpic->data[0] + y * inpic->linesize[0];
371 outrow[0] = outpic->data[0] + y * outpic->linesize[0];
373 for (plane = 1; plane < 3; plane++) {
374 inrow[plane] = inpic->data[plane] + (y >> hue->vsub) * inpic->linesize[plane];
375 outrow[plane] = outpic->data[plane] + (y >> hue->vsub) * outpic->linesize[plane];
378 av_image_copy_plane(outrow[0], outpic->linesize[0],
379 inrow[0], inpic->linesize[0],
380 inlink->w, inlink->h);
382 process_chrominance(outrow[1], outrow[2], outpic->linesize[1],
383 inrow[1], inrow[2], inpic->linesize[1],
384 inlink->w >> hue->hsub, inlink->h >> hue->vsub,
385 hue->hue_cos, hue->hue_sin);
387 return ff_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
390 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
391 char *res, int res_len, int flags)
393 if (!strcmp(cmd, "reinit"))
394 return set_options(ctx, args);
396 return AVERROR(ENOSYS);
399 AVFilter avfilter_vf_hue = {
401 .description = NULL_IF_CONFIG_SMALL("Adjust the hue and saturation of the input video."),
403 .priv_size = sizeof(HueContext),
407 .query_formats = query_formats,
408 .process_command = process_command,
410 .inputs = (const AVFilterPad[]) {
413 .type = AVMEDIA_TYPE_VIDEO,
414 .start_frame = start_frame,
415 .draw_slice = draw_slice,
416 .config_props = config_props,
417 .min_perms = AV_PERM_READ,
421 .outputs = (const AVFilterPad[]) {
424 .type = AVMEDIA_TYPE_VIDEO,
428 .priv_class = &hue_class,