# 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.
#

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_brightness


class RandomBrightness(IntensityAugmentationBase2D):
    r"""Shift brightness by an additive random offset.

    ``output = RandomBrightness(brightness)(input)`` computes ``input + (factor - 1)`` for each selected image
    using a sampled brightness factor, with clamping enabled by default. Use :class:`ColorJitter` for
    torchvision-compatible multiplicative brightness, ``input * factor``.

    .. image:: _static/img/RandomBrightness.png

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

    Args:
        brightness: the brightness factor to apply
        clip_output: if true clip output
        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:
        - with ``clip_output=True``, input values are clamped into ``[0, 1]`` before the operation
          as well as afterwards. With ``clip_output=False``, the arithmetic is range-independent:
          neither input nor output is clamped.
        - ``brightness`` is centered on ``1.0``: the drawn factor is re-based to ``factor - 1`` before it reaches
          :func:`kornia.enhance.adjust_brightness`, whose own identity is ``0.0``, so the same number passed
          straight to the primitive means something else.
        - at the default ``clip_output=True`` the result is clamped into ``[0, 1]``; with ``clip_output=False``
          the raw sum is returned.

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

    See Also:
        - :class:`RandomContrast`: scales values instead of adding an offset.
        - :class:`ColorJiggle`: combines this additive brightness step with color adjustments.
        - :class:`ColorJitter`: uses torchvision-compatible multiplicative brightness.

    Examples:
        >>> rng = torch.manual_seed(0)
        >>> inputs = torch.rand(1, 3, 3, 3)
        >>> aug = RandomBrightness(brightness = (0.5,2.),p=1.)
        >>> aug(inputs)
        tensor([[[[0.0505, 0.3225, 0.0000],
                  [0.0000, 0.0000, 0.1883],
                  [0.0443, 0.4507, 0.0099]],
        <BLANKLINE>
                 [[0.1866, 0.0000, 0.0000],
                  [0.0000, 0.0000, 0.0000],
                  [0.0728, 0.2519, 0.3543]],
        <BLANKLINE>
                 [[0.0000, 0.0000, 0.2359],
                  [0.4694, 0.0000, 0.4284],
                  [0.0000, 0.1072, 0.5070]]]])

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

        >>> input = torch.rand(1, 3, 32, 32)
        >>> aug = RandomBrightness((0.8,1.2), p=1.)
        >>> (aug(input) == aug(input, params=aug._params)).all()
        tensor(True)

    """

    def __init__(
        self,
        brightness: Tuple[float, float] = (1.0, 1.0),
        clip_output: bool = True,
        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(brightness, "brightness", center=1.0, bounds=(0.0, 2.0))
        self.brightness: torch.Tensor = factor
        self._param_generator = rg.PlainUniformGenerator((self.brightness, "brightness_factor", center, bounds))
        _load_unowned_learnable_range(self, "brightness", center)

        self.clip_output = clip_output

    def apply_transform(
        self,
        input: torch.Tensor,
        params: Dict[str, torch.Tensor],
        flags: Dict[str, Any],
        transform: Optional[torch.Tensor] = None,
    ) -> torch.Tensor:
        if self.clip_output:
            input = _clamp_unit_range(input)
        brightness_factor = _to_device_nonblocking(params["brightness_factor"], input.device, input.dtype)
        return adjust_brightness(input, brightness_factor - 1, self.clip_output)
