9674a20f67d839fca688f4b322b34464988b4cb5
[ffmpeg.git] / libavfilter / vf_hue.c
1 /*
2  * Copyright (c) 2003 Michael Niedermayer
3  * Copyright (c) 2012 Jeremy Tran
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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.
20  */
21
22 /**
23  * @file
24  * Apply a hue/saturation filter to the input video
25  * Ported from MPlayer libmpcodecs/vf_hue.c.
26  */
27
28 #include <float.h>
29 #include "libavutil/eval.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33
34 #include "avfilter.h"
35 #include "formats.h"
36 #include "internal.h"
37 #include "video.h"
38
39 #define HUE_DEFAULT_VAL 0
40 #define SAT_DEFAULT_VAL 1
41
42 #define HUE_DEFAULT_VAL_STRING AV_STRINGIFY(HUE_DEFAULT_VAL)
43 #define SAT_DEFAULT_VAL_STRING AV_STRINGIFY(SAT_DEFAULT_VAL)
44
45 #define SAT_MIN_VAL -10
46 #define SAT_MAX_VAL 10
47
48 static const char *const var_names[] = {
49     "n",   // frame count
50     "pts", // presentation timestamp expressed in AV_TIME_BASE units
51     "r",   // frame rate
52     "t",   // timestamp expressed in seconds
53     "tb",  // timebase
54     NULL
55 };
56
57 enum var_name {
58     VAR_N,
59     VAR_PTS,
60     VAR_R,
61     VAR_T,
62     VAR_TB,
63     VAR_NB
64 };
65
66 typedef struct {
67     const    AVClass *class;
68     float    hue_deg; /* hue expressed in degrees */
69     float    hue; /* hue expressed in radians */
70     char     *hue_deg_expr;
71     char     *hue_expr;
72     AVExpr   *hue_deg_pexpr;
73     AVExpr   *hue_pexpr;
74     float    saturation;
75     char     *saturation_expr;
76     AVExpr   *saturation_pexpr;
77     int      hsub;
78     int      vsub;
79     int32_t hue_sin;
80     int32_t hue_cos;
81     int      flat_syntax;
82     double   var_values[VAR_NB];
83 } HueContext;
84
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 },
94     { NULL }
95 };
96
97 AVFILTER_DEFINE_CLASS(hue);
98
99 static inline void compute_sin_and_cos(HueContext *hue)
100 {
101     /*
102      * Scale the value to the norm of the resulting (U,V) vector, that is
103      * the saturation.
104      * This will be useful in the process_chrominance function.
105      */
106     hue->hue_sin = rint(sin(hue->hue) * (1 << 16) * hue->saturation);
107     hue->hue_cos = rint(cos(hue->hue) * (1 << 16) * hue->saturation);
108 }
109
110 #define PARSE_EXPRESSION(attr, name)                                              \
111     do {                                                                          \
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'",                \
116                    hue->attr##_expr);                                             \
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_free(old_##attr##_expr);                                           \
122             av_expr_free(old_##attr##_pexpr);                                     \
123         }                                                                         \
124     } while (0)
125
126 static inline int set_options(AVFilterContext *ctx, const char *args)
127 {
128     HueContext *hue = ctx->priv;
129     int n, ret;
130     char c1 = 0, c2 = 0;
131     char   *old_hue_expr,  *old_hue_deg_expr,  *old_saturation_expr;
132     AVExpr *old_hue_pexpr, *old_hue_deg_pexpr, *old_saturation_pexpr;
133
134     if (args) {
135         /* named options syntax */
136         if (strchr(args, '=')) {
137             old_hue_expr        = hue->hue_expr;
138             old_hue_deg_expr    = hue->hue_deg_expr;
139             old_saturation_expr = hue->saturation_expr;
140
141             old_hue_pexpr        = hue->hue_pexpr;
142             old_hue_deg_pexpr    = hue->hue_deg_pexpr;
143             old_saturation_pexpr = hue->saturation_pexpr;
144
145             hue->hue_expr     = NULL;
146             hue->hue_deg_expr = NULL;
147
148             if ((ret = av_set_options_string(hue, args, "=", ":")) < 0)
149                 return ret;
150             if (hue->hue_expr && hue->hue_deg_expr) {
151                 av_log(ctx, AV_LOG_ERROR,
152                        "H and h options are incompatible and cannot be specified "
153                        "at the same time\n");
154                 hue->hue_expr     = old_hue_expr;
155                 hue->hue_deg_expr = old_hue_deg_expr;
156
157                 return AVERROR(EINVAL);
158             }
159
160             /*
161              * if both 'H' and 'h' options have not been specified, restore the
162              * old values
163              */
164             if (!hue->hue_expr && !hue->hue_deg_expr) {
165                 hue->hue_expr     = old_hue_expr;
166                 hue->hue_deg_expr = old_hue_deg_expr;
167             }
168
169             if (hue->hue_deg_expr)
170                 PARSE_EXPRESSION(hue_deg, h);
171             if (hue->hue_expr)
172                 PARSE_EXPRESSION(hue, H);
173             if (hue->saturation_expr)
174                 PARSE_EXPRESSION(saturation, s);
175
176             hue->flat_syntax = 0;
177
178             av_log(ctx, AV_LOG_VERBOSE,
179                    "H_expr:%s h_deg_expr:%s s_expr:%s\n",
180                    hue->hue_expr, hue->hue_deg_expr, hue->saturation_expr);
181
182         /* compatibility h:s syntax */
183         } else {
184             n = sscanf(args, "%f%c%f%c", &hue->hue_deg, &c1, &hue->saturation, &c2);
185             if (n != 1 && (n != 3 || c1 != ':')) {
186                 av_log(ctx, AV_LOG_ERROR,
187                        "Invalid syntax for argument '%s': "
188                        "must be in the form 'hue[:saturation]'\n", args);
189                 return AVERROR(EINVAL);
190             }
191
192             if (hue->saturation < SAT_MIN_VAL || hue->saturation > SAT_MAX_VAL) {
193                 av_log(ctx, AV_LOG_ERROR,
194                        "Invalid value for saturation %0.1f: "
195                        "must be included between range %d and +%d\n",
196                        hue->saturation, SAT_MIN_VAL, SAT_MAX_VAL);
197                 return AVERROR(EINVAL);
198             }
199
200             hue->hue = hue->hue_deg * M_PI / 180;
201             hue->flat_syntax = 1;
202
203             av_log(ctx, AV_LOG_VERBOSE,
204                    "H:%0.1f h:%0.1f s:%0.1f\n",
205                    hue->hue, hue->hue_deg, hue->saturation);
206         }
207     }
208
209     compute_sin_and_cos(hue);
210
211     return 0;
212 }
213
214 static av_cold int init(AVFilterContext *ctx, const char *args)
215 {
216     HueContext *hue = ctx->priv;
217
218     hue->class = &hue_class;
219     av_opt_set_defaults(hue);
220
221     hue->saturation    = SAT_DEFAULT_VAL;
222     hue->hue           = HUE_DEFAULT_VAL;
223     hue->hue_deg_pexpr = NULL;
224     hue->hue_pexpr     = NULL;
225     hue->flat_syntax   = 1;
226
227     return set_options(ctx, args);
228 }
229
230 static av_cold void uninit(AVFilterContext *ctx)
231 {
232     HueContext *hue = ctx->priv;
233
234     av_opt_free(hue);
235
236     av_free(hue->hue_deg_expr);
237     av_expr_free(hue->hue_deg_pexpr);
238     av_free(hue->hue_expr);
239     av_expr_free(hue->hue_pexpr);
240     av_free(hue->saturation_expr);
241     av_expr_free(hue->saturation_pexpr);
242 }
243
244 static int query_formats(AVFilterContext *ctx)
245 {
246     static const enum PixelFormat pix_fmts[] = {
247         PIX_FMT_YUV444P,      PIX_FMT_YUV422P,
248         PIX_FMT_YUV420P,      PIX_FMT_YUV411P,
249         PIX_FMT_YUV410P,      PIX_FMT_YUV440P,
250         PIX_FMT_YUVA420P,
251         PIX_FMT_NONE
252     };
253
254     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
255
256     return 0;
257 }
258
259 static int config_props(AVFilterLink *inlink)
260 {
261     HueContext *hue = inlink->dst->priv;
262     const AVPixFmtDescriptor *desc = &av_pix_fmt_descriptors[inlink->format];
263
264     hue->hsub = desc->log2_chroma_w;
265     hue->vsub = desc->log2_chroma_h;
266
267     hue->var_values[VAR_N]  = 0;
268     hue->var_values[VAR_TB] = av_q2d(inlink->time_base);
269     hue->var_values[VAR_R]  = inlink->frame_rate.num == 0 || inlink->frame_rate.den == 0 ?
270         NAN : av_q2d(inlink->frame_rate);
271
272     return 0;
273 }
274
275 static void process_chrominance(uint8_t *udst, uint8_t *vdst, const int dst_linesize,
276                                 uint8_t *usrc, uint8_t *vsrc, const int src_linesize,
277                                 int w, int h,
278                                 const int32_t c, const int32_t s)
279 {
280     int32_t u, v, new_u, new_v;
281     int i;
282
283     /*
284      * If we consider U and V as the components of a 2D vector then its angle
285      * is the hue and the norm is the saturation
286      */
287     while (h--) {
288         for (i = 0; i < w; i++) {
289             /* Normalize the components from range [16;140] to [-112;112] */
290             u = usrc[i] - 128;
291             v = vsrc[i] - 128;
292             /*
293              * Apply the rotation of the vector : (c * u) - (s * v)
294              *                                    (s * u) + (c * v)
295              * De-normalize the components (without forgetting to scale 128
296              * by << 16)
297              * Finally scale back the result by >> 16
298              */
299             new_u = ((c * u) - (s * v) + (1 << 15) + (128 << 16)) >> 16;
300             new_v = ((s * u) + (c * v) + (1 << 15) + (128 << 16)) >> 16;
301
302             /* Prevent a potential overflow */
303             udst[i] = av_clip_uint8_c(new_u);
304             vdst[i] = av_clip_uint8_c(new_v);
305         }
306
307         usrc += src_linesize;
308         vsrc += src_linesize;
309         udst += dst_linesize;
310         vdst += dst_linesize;
311     }
312 }
313
314 #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
315 #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts) * av_q2d(tb))
316
317 static int start_frame(AVFilterLink *inlink, AVFilterBufferRef *inpic)
318 {
319     HueContext *hue = inlink->dst->priv;
320     AVFilterLink *outlink = inlink->dst->outputs[0];
321     AVFilterBufferRef *buf_out;
322
323     outlink->out_buf = ff_get_video_buffer(outlink, AV_PERM_WRITE, outlink->w, outlink->h);
324     if (!outlink->out_buf)
325         return AVERROR(ENOMEM);
326
327     avfilter_copy_buffer_ref_props(outlink->out_buf, inpic);
328     outlink->out_buf->video->w = outlink->w;
329     outlink->out_buf->video->h = outlink->h;
330     buf_out = avfilter_ref_buffer(outlink->out_buf, ~0);
331     if (!buf_out)
332         return AVERROR(ENOMEM);
333
334     if (!hue->flat_syntax) {
335         hue->var_values[VAR_T]   = TS2T(inpic->pts, inlink->time_base);
336         hue->var_values[VAR_PTS] = TS2D(inpic->pts);
337
338         if (hue->saturation_expr) {
339             hue->saturation = av_expr_eval(hue->saturation_pexpr, hue->var_values, NULL);
340
341             if (hue->saturation < SAT_MIN_VAL || hue->saturation > SAT_MAX_VAL) {
342                 hue->saturation = av_clip(hue->saturation, SAT_MIN_VAL, SAT_MAX_VAL);
343                 av_log(inlink->dst, AV_LOG_WARNING,
344                        "Saturation value not in range [%d,%d]: clipping value to %0.1f\n",
345                        SAT_MIN_VAL, SAT_MAX_VAL, hue->saturation);
346             }
347         }
348
349         if (hue->hue_deg_expr) {
350             hue->hue_deg = av_expr_eval(hue->hue_deg_pexpr, hue->var_values, NULL);
351             hue->hue = hue->hue_deg * M_PI / 180;
352         } else if (hue->hue_expr) {
353             hue->hue = av_expr_eval(hue->hue_pexpr, hue->var_values, NULL);
354         }
355
356         av_log(inlink->dst, AV_LOG_DEBUG,
357                "H:%0.1f s:%0.f t:%0.1f n:%d\n",
358                hue->hue, hue->saturation,
359                hue->var_values[VAR_T], (int)hue->var_values[VAR_N]);
360
361         compute_sin_and_cos(hue);
362     }
363
364     hue->var_values[VAR_N] += 1;
365
366     return ff_start_frame(outlink, buf_out);
367 }
368
369 static int draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
370 {
371     HueContext        *hue    = inlink->dst->priv;
372     AVFilterBufferRef *inpic  = inlink->cur_buf;
373     AVFilterBufferRef *outpic = inlink->dst->outputs[0]->out_buf;
374     uint8_t *inrow[3], *outrow[3]; // 0 : Y, 1 : U, 2 : V
375     int plane;
376
377     inrow[0]  = inpic->data[0]  + y * inpic->linesize[0];
378     outrow[0] = outpic->data[0] + y * outpic->linesize[0];
379
380     for (plane = 1; plane < 3; plane++) {
381         inrow[plane]  = inpic->data[plane]  + (y >> hue->vsub) * inpic->linesize[plane];
382         outrow[plane] = outpic->data[plane] + (y >> hue->vsub) * outpic->linesize[plane];
383     }
384
385     av_image_copy_plane(outrow[0], outpic->linesize[0],
386                         inrow[0],  inpic->linesize[0],
387                         inlink->w, inlink->h);
388
389     process_chrominance(outrow[1], outrow[2], outpic->linesize[1],
390                         inrow[1], inrow[2], inpic->linesize[1],
391                         inlink->w >> hue->hsub, inlink->h >> hue->vsub,
392                         hue->hue_cos, hue->hue_sin);
393
394     return ff_draw_slice(inlink->dst->outputs[0], y, h, slice_dir);
395 }
396
397 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
398                            char *res, int res_len, int flags)
399 {
400     if (!strcmp(cmd, "reinit"))
401         return set_options(ctx, args);
402     else
403         return AVERROR(ENOSYS);
404 }
405
406 AVFilter avfilter_vf_hue = {
407     .name        = "hue",
408     .description = NULL_IF_CONFIG_SMALL("Adjust the hue and saturation of the input video."),
409
410     .priv_size = sizeof(HueContext),
411
412     .init          = init,
413     .uninit        = uninit,
414     .query_formats = query_formats,
415     .process_command = process_command,
416
417     .inputs = (const AVFilterPad[]) {
418         {
419             .name         = "default",
420             .type         = AVMEDIA_TYPE_VIDEO,
421             .start_frame  = start_frame,
422             .draw_slice   = draw_slice,
423             .config_props = config_props,
424             .min_perms    = AV_PERM_READ,
425         },
426         { .name = NULL }
427     },
428     .outputs = (const AVFilterPad[]) {
429         {
430             .name         = "default",
431             .type         = AVMEDIA_TYPE_VIDEO,
432         },
433         { .name = NULL }
434     },
435     .priv_class = &hue_class,
436 };