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;
134 char *old_hue_expr, *old_hue_deg_expr, *old_saturation_expr;
135 AVExpr *old_hue_pexpr, *old_hue_deg_pexpr, *old_saturation_pexpr;
136 static const char *shorthand[] = { "h", "s", NULL };
137 old_hue_expr = hue->hue_expr;
138 old_hue_deg_expr = hue->hue_deg_expr;
139 old_saturation_expr = hue->saturation_expr;
141 old_hue_pexpr = hue->hue_pexpr;
142 old_hue_deg_pexpr = hue->hue_deg_pexpr;
143 old_saturation_pexpr = hue->saturation_pexpr;
145 hue->hue_expr = NULL;
146 hue->hue_deg_expr = NULL;
147 hue->saturation_expr = NULL;
149 if ((ret = av_opt_set_from_string(hue, args, shorthand, "=", ":")) < 0)
151 if (hue->hue_expr && hue->hue_deg_expr) {
152 av_log(ctx, AV_LOG_ERROR,
153 "H and h options are incompatible and cannot be specified "
154 "at the same time\n");
155 hue->hue_expr = old_hue_expr;
156 hue->hue_deg_expr = old_hue_deg_expr;
158 return AVERROR(EINVAL);
161 SET_EXPRESSION(hue_deg, h);
162 SET_EXPRESSION(hue, H);
163 SET_EXPRESSION(saturation, s);
165 hue->flat_syntax = 0;
167 av_log(ctx, AV_LOG_VERBOSE,
168 "H_expr:%s h_deg_expr:%s s_expr:%s\n",
169 hue->hue_expr, hue->hue_deg_expr, hue->saturation_expr);
171 compute_sin_and_cos(hue);
176 static av_cold int init(AVFilterContext *ctx, const char *args)
178 HueContext *hue = ctx->priv;
180 hue->class = &hue_class;
181 av_opt_set_defaults(hue);
183 hue->saturation = SAT_DEFAULT_VAL;
184 hue->hue = HUE_DEFAULT_VAL;
185 hue->hue_deg_pexpr = NULL;
186 hue->hue_pexpr = NULL;
187 hue->flat_syntax = 1;
189 return set_options(ctx, args);
192 static av_cold void uninit(AVFilterContext *ctx)
194 HueContext *hue = ctx->priv;
198 av_free(hue->hue_deg_expr);
199 av_expr_free(hue->hue_deg_pexpr);
200 av_free(hue->hue_expr);
201 av_expr_free(hue->hue_pexpr);
202 av_free(hue->saturation_expr);
203 av_expr_free(hue->saturation_pexpr);
206 static int query_formats(AVFilterContext *ctx)
208 static const enum AVPixelFormat pix_fmts[] = {
209 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P,
210 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV411P,
211 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV440P,
216 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
221 static int config_props(AVFilterLink *inlink)
223 HueContext *hue = inlink->dst->priv;
224 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
226 hue->hsub = desc->log2_chroma_w;
227 hue->vsub = desc->log2_chroma_h;
229 hue->var_values[VAR_N] = 0;
230 hue->var_values[VAR_TB] = av_q2d(inlink->time_base);
231 hue->var_values[VAR_R] = inlink->frame_rate.num == 0 || inlink->frame_rate.den == 0 ?
232 NAN : av_q2d(inlink->frame_rate);
237 static void process_chrominance(uint8_t *udst, uint8_t *vdst, const int dst_linesize,
238 uint8_t *usrc, uint8_t *vsrc, const int src_linesize,
240 const int32_t c, const int32_t s)
242 int32_t u, v, new_u, new_v;
246 * If we consider U and V as the components of a 2D vector then its angle
247 * is the hue and the norm is the saturation
250 for (i = 0; i < w; i++) {
251 /* Normalize the components from range [16;140] to [-112;112] */
255 * Apply the rotation of the vector : (c * u) - (s * v)
257 * De-normalize the components (without forgetting to scale 128
259 * Finally scale back the result by >> 16
261 new_u = ((c * u) - (s * v) + (1 << 15) + (128 << 16)) >> 16;
262 new_v = ((s * u) + (c * v) + (1 << 15) + (128 << 16)) >> 16;
264 /* Prevent a potential overflow */
265 udst[i] = av_clip_uint8_c(new_u);
266 vdst[i] = av_clip_uint8_c(new_v);
269 usrc += src_linesize;
270 vsrc += src_linesize;
271 udst += dst_linesize;
272 vdst += dst_linesize;
276 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
277 #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts) * av_q2d(tb))
279 static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
281 HueContext *hue = inlink->dst->priv;
282 AVFilterLink *outlink = inlink->dst->outputs[0];
286 if (av_frame_is_writable(inpic)) {
290 outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
292 av_frame_free(&inpic);
293 return AVERROR(ENOMEM);
295 av_frame_copy_props(outpic, inpic);
298 if (!hue->flat_syntax) {
299 hue->var_values[VAR_T] = TS2T(inpic->pts, inlink->time_base);
300 hue->var_values[VAR_PTS] = TS2D(inpic->pts);
302 if (hue->saturation_expr) {
303 hue->saturation = av_expr_eval(hue->saturation_pexpr, hue->var_values, NULL);
305 if (hue->saturation < SAT_MIN_VAL || hue->saturation > SAT_MAX_VAL) {
306 hue->saturation = av_clip(hue->saturation, SAT_MIN_VAL, SAT_MAX_VAL);
307 av_log(inlink->dst, AV_LOG_WARNING,
308 "Saturation value not in range [%d,%d]: clipping value to %0.1f\n",
309 SAT_MIN_VAL, SAT_MAX_VAL, hue->saturation);
313 if (hue->hue_deg_expr) {
314 hue->hue_deg = av_expr_eval(hue->hue_deg_pexpr, hue->var_values, NULL);
315 hue->hue = hue->hue_deg * M_PI / 180;
316 } else if (hue->hue_expr) {
317 hue->hue = av_expr_eval(hue->hue_pexpr, hue->var_values, NULL);
320 av_log(inlink->dst, AV_LOG_DEBUG,
321 "H:%0.1f s:%0.f t:%0.1f n:%d\n",
322 hue->hue, hue->saturation,
323 hue->var_values[VAR_T], (int)hue->var_values[VAR_N]);
325 compute_sin_and_cos(hue);
328 hue->var_values[VAR_N] += 1;
331 av_image_copy_plane(outpic->data[0], outpic->linesize[0],
332 inpic->data[0], inpic->linesize[0],
333 inlink->w, inlink->h);
335 process_chrominance(outpic->data[1], outpic->data[2], outpic->linesize[1],
336 inpic->data[1], inpic->data[2], inpic->linesize[1],
337 inlink->w >> hue->hsub, inlink->h >> hue->vsub,
338 hue->hue_cos, hue->hue_sin);
341 av_frame_free(&inpic);
342 return ff_filter_frame(outlink, outpic);
345 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
346 char *res, int res_len, int flags)
348 if (!strcmp(cmd, "reinit"))
349 return set_options(ctx, args);
351 return AVERROR(ENOSYS);
354 static const AVFilterPad hue_inputs[] = {
357 .type = AVMEDIA_TYPE_VIDEO,
358 .filter_frame = filter_frame,
359 .config_props = config_props,
364 static const AVFilterPad hue_outputs[] = {
367 .type = AVMEDIA_TYPE_VIDEO,
372 AVFilter avfilter_vf_hue = {
374 .description = NULL_IF_CONFIG_SMALL("Adjust the hue and saturation of the input video."),
376 .priv_size = sizeof(HueContext),
380 .query_formats = query_formats,
381 .process_command = process_command,
382 .inputs = hue_inputs,
383 .outputs = hue_outputs,
384 .priv_class = &hue_class,