# LICENSE HEADER MANAGED BY add-license-header
#
# Copyright 2018 Kornia Team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

import math
from typing import Any, Dict, Optional, Tuple

import torch

from kornia.augmentation import random_generator as rg
from kornia.augmentation._2d.intensity.base import IntensityAugmentationBase2D
from kornia.augmentation.utils.param_validation import _learnable_range_bound, _load_unowned_learnable_range
from kornia.core.utils import _clamp_unit_range, _to_device_nonblocking
from kornia.enhance.adjust import adjust_hue


class RandomHue(IntensityAugmentationBase2D):
    r"""Rotate the hue of a three-channel image by a random number of turns.

    ``output = RandomHue(hue)(input)`` samples an HSV hue rotation for each selected image.

    The shift is in turns of the hue circle, the unit of torchvision's ``adjust_hue`` ``hue_factor``, so a
    torchvision hue range carries over unchanged.

    .. image:: _static/img/RandomHue.png

    See the Convention block on :class:`~kornia.augmentation.IntensityAugmentationBase2D`.

    Args:
        hue: the hue shift, in turns of the hue circle, restricted to the closed ``[-0.5, 0.5]``. If ``hue``
          is a single number ``x`` the shift is sampled from ``[-x, x]``, and ``x`` above ``0.5`` raises; a
          tuple gives the range directly, and one outside the bound raises as well.
        same_on_batch: apply the same transformation across the batch.
        p: probability of applying the transformation.
        keepdim: whether to keep the output shape the same as input (True) or broadcast it
                 to the batch form (False).
    Shape:
        - Input: ``(C, H, W)`` or ``(B, C, H, W)``, Optional: ``(B, 3, 3)``
        - Output: ``(B, C, H, W)``

    Convention:
        - input values are clamped into ``[0, 1]`` before the operation, and the result is clamped
          into the same range. This applies only to samples selected by the probability gate.
        - the input must have three channels: the shift is computed in HSV, and any other channel count raises
          a ``ValueError`` on the forward pass.
        - the drawn shift is in turns of the hue circle, and the class multiplies it by ``2 * pi`` before
          calling :func:`kornia.enhance.adjust_hue`, which takes radians. Passing the same number
          straight to that primitive shifts the hue by a different amount.
        - the HSV hue shift preserves the clamped input pixel's largest and smallest channel, up to rounding.

    .. note::
        This function internally uses :func:`kornia.enhance.adjust_hue`

    See Also:
        - :class:`RandomSaturation`: scales HSV saturation without rotating hue.
        - :class:`ColorJiggle`: combines hue rotation with other Kornia color adjustments.
        - :class:`ColorJitter`: combines hue rotation with torchvision-compatible color adjustments.

    Examples:
        >>> rng = torch.manual_seed(0)
        >>> inputs = torch.rand(1, 3, 3, 3)
        >>> aug = RandomHue(hue = (-0.5,0.5),p=1.)
        >>> aug(inputs)
        tensor([[[[0.3993, 0.2823, 0.6816],
                  [0.6117, 0.2090, 0.4081],
                  [0.4693, 0.5529, 0.9527]],
        <BLANKLINE>
                 [[0.1610, 0.5962, 0.4971],
                  [0.9152, 0.3971, 0.8742],
                  [0.4194, 0.6771, 0.7162]],
        <BLANKLINE>
                 [[0.6323, 0.7682, 0.0885],
                  [0.0223, 0.1689, 0.2939],
                  [0.5185, 0.8964, 0.4556]]]])

    To apply the exact augmenation again, you may take the advantage of the previous parameter state:

        >>> input = torch.rand(1, 3, 32, 32)
        >>> aug = RandomHue((-0.2,0.2), p=1.)
        >>> (aug(input) == aug(input, params=aug._params)).all()
        tensor(True)

    """

    def __init__(
        self, hue: Tuple[float, float] = (0.0, 0.0), same_on_batch: bool = False, p: float = 1.0, keepdim: bool = False
    ) -> None:
        super().__init__(p=p, same_on_batch=same_on_batch, keepdim=keepdim)
        factor, center, bounds = _learnable_range_bound(hue, "hue", bounds=(-0.5, 0.5))
        self.hue: torch.Tensor = factor
        self._param_generator = rg.PlainUniformGenerator((self.hue, "hue_factor", center, bounds))
        _load_unowned_learnable_range(self, "hue", center)

    def apply_transform(
        self,
        input: torch.Tensor,
        params: Dict[str, torch.Tensor],
        flags: Dict[str, Any],
        transform: Optional[torch.Tensor] = None,
    ) -> torch.Tensor:
        input = _clamp_unit_range(input)
        hue_factor = _to_device_nonblocking(params["hue_factor"], input.device, input.dtype)
        return _clamp_unit_range(adjust_hue(input, hue_factor * 2 * math.pi))
