yading@10: /*
yading@10:  * Copyright (c) 2003 Michael Niedermayer
yading@10:  * Copyright (c) 2012 Jeremy Tran
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or modify
yading@10:  * it under the terms of the GNU General Public License as published by
yading@10:  * the Free Software Foundation; either version 2 of the License, or
yading@10:  * (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
yading@10:  * GNU General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU General Public License along
yading@10:  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
yading@10:  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * Apply a hue/saturation filter to the input video
yading@10:  * Ported from MPlayer libmpcodecs/vf_hue.c.
yading@10:  */
yading@10: 
yading@10: #include <float.h>
yading@10: #include "libavutil/eval.h"
yading@10: #include "libavutil/imgutils.h"
yading@10: #include "libavutil/opt.h"
yading@10: #include "libavutil/pixdesc.h"
yading@10: 
yading@10: #include "avfilter.h"
yading@10: #include "formats.h"
yading@10: #include "internal.h"
yading@10: #include "video.h"
yading@10: 
yading@10: #define SAT_MIN_VAL -10
yading@10: #define SAT_MAX_VAL 10
yading@10: 
yading@10: static const char *const var_names[] = {
yading@10:     "n",   // frame count
yading@10:     "pts", // presentation timestamp expressed in AV_TIME_BASE units
yading@10:     "r",   // frame rate
yading@10:     "t",   // timestamp expressed in seconds
yading@10:     "tb",  // timebase
yading@10:     NULL
yading@10: };
yading@10: 
yading@10: enum var_name {
yading@10:     VAR_N,
yading@10:     VAR_PTS,
yading@10:     VAR_R,
yading@10:     VAR_T,
yading@10:     VAR_TB,
yading@10:     VAR_NB
yading@10: };
yading@10: 
yading@10: typedef struct {
yading@10:     const    AVClass *class;
yading@10:     float    hue_deg; /* hue expressed in degrees */
yading@10:     float    hue; /* hue expressed in radians */
yading@10:     char     *hue_deg_expr;
yading@10:     char     *hue_expr;
yading@10:     AVExpr   *hue_deg_pexpr;
yading@10:     AVExpr   *hue_pexpr;
yading@10:     float    saturation;
yading@10:     char     *saturation_expr;
yading@10:     AVExpr   *saturation_pexpr;
yading@10:     int      hsub;
yading@10:     int      vsub;
yading@10:     int32_t hue_sin;
yading@10:     int32_t hue_cos;
yading@10:     double   var_values[VAR_NB];
yading@10: } HueContext;
yading@10: 
yading@10: #define OFFSET(x) offsetof(HueContext, x)
yading@10: #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
yading@10: static const AVOption hue_options[] = {
yading@10:     { "h", "set the hue angle degrees expression", OFFSET(hue_deg_expr), AV_OPT_TYPE_STRING,
yading@10:       { .str = NULL }, .flags = FLAGS },
yading@10:     { "s", "set the saturation expression", OFFSET(saturation_expr), AV_OPT_TYPE_STRING,
yading@10:       { .str = "1" }, .flags = FLAGS },
yading@10:     { "H", "set the hue angle radians expression", OFFSET(hue_expr), AV_OPT_TYPE_STRING,
yading@10:       { .str = NULL }, .flags = FLAGS },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFILTER_DEFINE_CLASS(hue);
yading@10: 
yading@10: static inline void compute_sin_and_cos(HueContext *hue)
yading@10: {
yading@10:     /*
yading@10:      * Scale the value to the norm of the resulting (U,V) vector, that is
yading@10:      * the saturation.
yading@10:      * This will be useful in the process_chrominance function.
yading@10:      */
yading@10:     hue->hue_sin = rint(sin(hue->hue) * (1 << 16) * hue->saturation);
yading@10:     hue->hue_cos = rint(cos(hue->hue) * (1 << 16) * hue->saturation);
yading@10: }
yading@10: 
yading@10: static int set_expr(AVExpr **pexpr, const char *expr, const char *option, void *log_ctx)
yading@10: {
yading@10:     int ret;
yading@10:     AVExpr *old = NULL;
yading@10: 
yading@10:     if (*pexpr)
yading@10:         old = *pexpr;
yading@10:     ret = av_expr_parse(pexpr, expr, var_names,
yading@10:                         NULL, NULL, NULL, NULL, 0, log_ctx);
yading@10:     if (ret < 0) {
yading@10:         av_log(log_ctx, AV_LOG_ERROR,
yading@10:                "Error when evaluating the expression '%s' for %s\n",
yading@10:                expr, option);
yading@10:         *pexpr = old;
yading@10:         return ret;
yading@10:     }
yading@10:     av_expr_free(old);
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static av_cold int init(AVFilterContext *ctx)
yading@10: {
yading@10:     HueContext *hue = ctx->priv;
yading@10:     int ret;
yading@10: 
yading@10:     if (hue->hue_expr && hue->hue_deg_expr) {
yading@10:         av_log(ctx, AV_LOG_ERROR,
yading@10:                "H and h options are incompatible and cannot be specified "
yading@10:                "at the same time\n");
yading@10:         return AVERROR(EINVAL);
yading@10:     }
yading@10: 
yading@10: #define SET_EXPR(expr, option)                                          \
yading@10:     if (hue->expr##_expr) do {                                          \
yading@10:         ret = set_expr(&hue->expr##_pexpr, hue->expr##_expr, option, ctx); \
yading@10:         if (ret < 0)                                                    \
yading@10:             return ret;                                                 \
yading@10:     } while (0)
yading@10:     SET_EXPR(saturation, "s");
yading@10:     SET_EXPR(hue_deg,    "h");
yading@10:     SET_EXPR(hue,        "H");
yading@10: 
yading@10:     av_log(ctx, AV_LOG_VERBOSE,
yading@10:            "H_expr:%s h_deg_expr:%s s_expr:%s\n",
yading@10:            hue->hue_expr, hue->hue_deg_expr, hue->saturation_expr);
yading@10:     compute_sin_and_cos(hue);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static av_cold void uninit(AVFilterContext *ctx)
yading@10: {
yading@10:     HueContext *hue = ctx->priv;
yading@10: 
yading@10:     av_expr_free(hue->hue_deg_pexpr);
yading@10:     av_expr_free(hue->hue_pexpr);
yading@10:     av_expr_free(hue->saturation_pexpr);
yading@10: }
yading@10: 
yading@10: static int query_formats(AVFilterContext *ctx)
yading@10: {
yading@10:     static const enum AVPixelFormat pix_fmts[] = {
yading@10:         AV_PIX_FMT_YUV444P,      AV_PIX_FMT_YUV422P,
yading@10:         AV_PIX_FMT_YUV420P,      AV_PIX_FMT_YUV411P,
yading@10:         AV_PIX_FMT_YUV410P,      AV_PIX_FMT_YUV440P,
yading@10:         AV_PIX_FMT_YUVA444P,     AV_PIX_FMT_YUVA422P,
yading@10:         AV_PIX_FMT_YUVA420P,
yading@10:         AV_PIX_FMT_NONE
yading@10:     };
yading@10: 
yading@10:     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int config_props(AVFilterLink *inlink)
yading@10: {
yading@10:     HueContext *hue = inlink->dst->priv;
yading@10:     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
yading@10: 
yading@10:     hue->hsub = desc->log2_chroma_w;
yading@10:     hue->vsub = desc->log2_chroma_h;
yading@10: 
yading@10:     hue->var_values[VAR_N]  = 0;
yading@10:     hue->var_values[VAR_TB] = av_q2d(inlink->time_base);
yading@10:     hue->var_values[VAR_R]  = inlink->frame_rate.num == 0 || inlink->frame_rate.den == 0 ?
yading@10:         NAN : av_q2d(inlink->frame_rate);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static void process_chrominance(uint8_t *udst, uint8_t *vdst, const int dst_linesize,
yading@10:                                 uint8_t *usrc, uint8_t *vsrc, const int src_linesize,
yading@10:                                 int w, int h,
yading@10:                                 const int32_t c, const int32_t s)
yading@10: {
yading@10:     int32_t u, v, new_u, new_v;
yading@10:     int i;
yading@10: 
yading@10:     /*
yading@10:      * If we consider U and V as the components of a 2D vector then its angle
yading@10:      * is the hue and the norm is the saturation
yading@10:      */
yading@10:     while (h--) {
yading@10:         for (i = 0; i < w; i++) {
yading@10:             /* Normalize the components from range [16;140] to [-112;112] */
yading@10:             u = usrc[i] - 128;
yading@10:             v = vsrc[i] - 128;
yading@10:             /*
yading@10:              * Apply the rotation of the vector : (c * u) - (s * v)
yading@10:              *                                    (s * u) + (c * v)
yading@10:              * De-normalize the components (without forgetting to scale 128
yading@10:              * by << 16)
yading@10:              * Finally scale back the result by >> 16
yading@10:              */
yading@10:             new_u = ((c * u) - (s * v) + (1 << 15) + (128 << 16)) >> 16;
yading@10:             new_v = ((s * u) + (c * v) + (1 << 15) + (128 << 16)) >> 16;
yading@10: 
yading@10:             /* Prevent a potential overflow */
yading@10:             udst[i] = av_clip_uint8_c(new_u);
yading@10:             vdst[i] = av_clip_uint8_c(new_v);
yading@10:         }
yading@10: 
yading@10:         usrc += src_linesize;
yading@10:         vsrc += src_linesize;
yading@10:         udst += dst_linesize;
yading@10:         vdst += dst_linesize;
yading@10:     }
yading@10: }
yading@10: 
yading@10: #define TS2D(ts) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts))
yading@10: #define TS2T(ts, tb) ((ts) == AV_NOPTS_VALUE ? NAN : (double)(ts) * av_q2d(tb))
yading@10: 
yading@10: static int filter_frame(AVFilterLink *inlink, AVFrame *inpic)
yading@10: {
yading@10:     HueContext *hue = inlink->dst->priv;
yading@10:     AVFilterLink *outlink = inlink->dst->outputs[0];
yading@10:     AVFrame *outpic;
yading@10:     int direct = 0;
yading@10: 
yading@10:     if (av_frame_is_writable(inpic)) {
yading@10:         direct = 1;
yading@10:         outpic = inpic;
yading@10:     } else {
yading@10:         outpic = ff_get_video_buffer(outlink, outlink->w, outlink->h);
yading@10:         if (!outpic) {
yading@10:             av_frame_free(&inpic);
yading@10:             return AVERROR(ENOMEM);
yading@10:         }
yading@10:         av_frame_copy_props(outpic, inpic);
yading@10:     }
yading@10: 
yading@10:     hue->var_values[VAR_T]   = TS2T(inpic->pts, inlink->time_base);
yading@10:     hue->var_values[VAR_PTS] = TS2D(inpic->pts);
yading@10: 
yading@10:     if (hue->saturation_expr) {
yading@10:         hue->saturation = av_expr_eval(hue->saturation_pexpr, hue->var_values, NULL);
yading@10: 
yading@10:         if (hue->saturation < SAT_MIN_VAL || hue->saturation > SAT_MAX_VAL) {
yading@10:             hue->saturation = av_clip(hue->saturation, SAT_MIN_VAL, SAT_MAX_VAL);
yading@10:             av_log(inlink->dst, AV_LOG_WARNING,
yading@10:                    "Saturation value not in range [%d,%d]: clipping value to %0.1f\n",
yading@10:                    SAT_MIN_VAL, SAT_MAX_VAL, hue->saturation);
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     if (hue->hue_deg_expr) {
yading@10:         hue->hue_deg = av_expr_eval(hue->hue_deg_pexpr, hue->var_values, NULL);
yading@10:         hue->hue = hue->hue_deg * M_PI / 180;
yading@10:     } else if (hue->hue_expr) {
yading@10:         hue->hue = av_expr_eval(hue->hue_pexpr, hue->var_values, NULL);
yading@10:         hue->hue_deg = hue->hue * 180 / M_PI;
yading@10:     }
yading@10: 
yading@10:     av_log(inlink->dst, AV_LOG_DEBUG,
yading@10:            "H:%0.1f*PI h:%0.1f s:%0.f t:%0.1f n:%d\n",
yading@10:            hue->hue/M_PI, hue->hue_deg, hue->saturation,
yading@10:            hue->var_values[VAR_T], (int)hue->var_values[VAR_N]);
yading@10: 
yading@10:     compute_sin_and_cos(hue);
yading@10: 
yading@10:     hue->var_values[VAR_N] += 1;
yading@10: 
yading@10:     if (!direct) {
yading@10:         av_image_copy_plane(outpic->data[0], outpic->linesize[0],
yading@10:                             inpic->data[0],  inpic->linesize[0],
yading@10:                             inlink->w, inlink->h);
yading@10:         if (inpic->data[3])
yading@10:             av_image_copy_plane(outpic->data[3], outpic->linesize[3],
yading@10:                                 inpic->data[3],  inpic->linesize[3],
yading@10:                                 inlink->w, inlink->h);
yading@10:     }
yading@10: 
yading@10:     process_chrominance(outpic->data[1], outpic->data[2], outpic->linesize[1],
yading@10:                         inpic->data[1],  inpic->data[2],  inpic->linesize[1],
yading@10:                         inlink->w >> hue->hsub, inlink->h >> hue->vsub,
yading@10:                         hue->hue_cos, hue->hue_sin);
yading@10: 
yading@10:     if (!direct)
yading@10:         av_frame_free(&inpic);
yading@10:     return ff_filter_frame(outlink, outpic);
yading@10: }
yading@10: 
yading@10: static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
yading@10:                            char *res, int res_len, int flags)
yading@10: {
yading@10:     HueContext *hue = ctx->priv;
yading@10: 
yading@10: #define SET_CMD(expr, option) do {                                 \
yading@10:     if (!strcmp(cmd, option))                                      \
yading@10:         return set_expr(&hue->expr##_pexpr, args, cmd, ctx);       \
yading@10: } while (0)
yading@10:     SET_CMD(hue_deg,    "h");
yading@10:     SET_CMD(hue,        "H");
yading@10:     SET_CMD(saturation, "s");
yading@10: 
yading@10:     return AVERROR(ENOSYS);
yading@10: }
yading@10: 
yading@10: static const AVFilterPad hue_inputs[] = {
yading@10:     {
yading@10:         .name         = "default",
yading@10:         .type         = AVMEDIA_TYPE_VIDEO,
yading@10:         .filter_frame = filter_frame,
yading@10:         .config_props = config_props,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: static const AVFilterPad hue_outputs[] = {
yading@10:     {
yading@10:         .name = "default",
yading@10:         .type = AVMEDIA_TYPE_VIDEO,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFilter avfilter_vf_hue = {
yading@10:     .name        = "hue",
yading@10:     .description = NULL_IF_CONFIG_SMALL("Adjust the hue and saturation of the input video."),
yading@10: 
yading@10:     .priv_size = sizeof(HueContext),
yading@10: 
yading@10:     .init          = init,
yading@10:     .uninit        = uninit,
yading@10:     .query_formats = query_formats,
yading@10:     .process_command = process_command,
yading@10:     .inputs          = hue_inputs,
yading@10:     .outputs         = hue_outputs,
yading@10:     .priv_class      = &hue_class,
yading@10: };