#
# openslide-python - Python bindings for the OpenSlide library
#
# Copyright (c) 2010-2014 Carnegie Mellon University
# Copyright (c) 2021-2023 Benjamin Gilbert
#
# This library is free software; you can redistribute it and/or modify it
# under the terms of version 2.1 of the GNU Lesser General Public License
# as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
# License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

"""A library for reading whole-slide images.

This package provides Python bindings for the OpenSlide library.
"""

from __future__ import annotations

from abc import ABCMeta, abstractmethod
from io import BytesIO
from types import TracebackType
from typing import Iterator, Literal, Mapping, TypeVar

from PIL import Image, ImageCms

from openslide import lowlevel

# Re-exports for the benefit of library users
from openslide._version import (  # noqa: F401  module-imported-but-unused
    __version__ as __version__,
)
from openslide.lowlevel import (
    OpenSlideUnsupportedFormatError as OpenSlideUnsupportedFormatError,
)
from openslide.lowlevel import (  # noqa: F401  module-imported-but-unused
    OpenSlideVersionError as OpenSlideVersionError,
)
from openslide.lowlevel import OpenSlideError as OpenSlideError

__library_version__ = lowlevel.get_version()

PROPERTY_NAME_COMMENT = 'openslide.comment'
PROPERTY_NAME_VENDOR = 'openslide.vendor'
PROPERTY_NAME_QUICKHASH1 = 'openslide.quickhash-1'
PROPERTY_NAME_BACKGROUND_COLOR = 'openslide.background-color'
PROPERTY_NAME_OBJECTIVE_POWER = 'openslide.objective-power'
PROPERTY_NAME_MPP_X = 'openslide.mpp-x'
PROPERTY_NAME_MPP_Y = 'openslide.mpp-y'
PROPERTY_NAME_BOUNDS_X = 'openslide.bounds-x'
PROPERTY_NAME_BOUNDS_Y = 'openslide.bounds-y'
PROPERTY_NAME_BOUNDS_WIDTH = 'openslide.bounds-width'
PROPERTY_NAME_BOUNDS_HEIGHT = 'openslide.bounds-height'

_T = TypeVar('_T')


class AbstractSlide(metaclass=ABCMeta):
    """The base class of a slide object."""

    def __init__(self) -> None:
        self._profile: bytes | None = None

    def __enter__(self: _T) -> _T:
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        traceback: TracebackType | None,
    ) -> Literal[False]:
        self.close()
        return False

    @classmethod
    @abstractmethod
    def detect_format(cls, filename: lowlevel.Filename) -> str | None:
        """Return a string describing the format of the specified file.

        If the file format is not recognized, return None."""
        raise NotImplementedError

    @abstractmethod
    def close(self) -> None:
        """Close the slide."""
        raise NotImplementedError

    @property
    @abstractmethod
    def level_count(self) -> int:
        """The number of levels in the image."""
        raise NotImplementedError

    @property
    @abstractmethod
    def level_dimensions(self) -> tuple[tuple[int, int], ...]:
        """A tuple of (width, height) tuples, one for each level of the image.

        level_dimensions[n] contains the dimensions of level n."""
        raise NotImplementedError

    @property
    def dimensions(self) -> tuple[int, int]:
        """A (width, height) tuple for level 0 of the image."""
        return self.level_dimensions[0]

    @property
    @abstractmethod
    def level_downsamples(self) -> tuple[float, ...]:
        """A tuple of downsampling factors for each level of the image.

        level_downsample[n] contains the downsample factor of level n."""
        raise NotImplementedError

    @property
    @abstractmethod
    def properties(self) -> Mapping[str, str]:
        """Metadata about the image.

        This is a map: property name -> property value."""
        raise NotImplementedError

    @property
    @abstractmethod
    def associated_images(self) -> Mapping[str, Image.Image]:
        """Images associated with this whole-slide image.

        This is a map: image name -> PIL.Image."""
        raise NotImplementedError

    @property
    def color_profile(self) -> ImageCms.ImageCmsProfile | None:
        """Color profile for the whole-slide image, or None if unavailable."""
        if self._profile is None:
            return None
        return ImageCms.getOpenProfile(BytesIO(self._profile))

    @abstractmethod
    def get_best_level_for_downsample(self, downsample: float) -> int:
        """Return the best level for displaying the given downsample."""
        raise NotImplementedError

    @abstractmethod
    def read_region(
        self, location: tuple[int, int], level: int, size: tuple[int, int]
    ) -> Image.Image:
        """Return a PIL.Image containing the contents of the region.

        location: (x, y) tuple giving the top left pixel in the level 0
                  reference frame.
        level:    the level number.
        size:     (width, height) tuple giving the region size."""
        raise NotImplementedError

    def set_cache(self, cache: OpenSlideCache) -> None:  # noqa: B027
        """Use the specified cache to store recently decoded slide tiles.

        This class does not support caching, so this method does nothing.

        cache: an OpenSlideCache object."""
        pass

    def get_thumbnail(self, size: tuple[int, int]) -> Image.Image:
        """Return a PIL.Image containing an RGB thumbnail of the image.

        size:     the maximum size of the thumbnail."""
        downsample = max(dim / thumb for dim, thumb in zip(self.dimensions, size))
        level = self.get_best_level_for_downsample(downsample)
        tile = self.read_region((0, 0), level, self.level_dimensions[level])
        # Apply on solid background
        bg_color = '#' + self.properties.get(PROPERTY_NAME_BACKGROUND_COLOR, 'ffffff')
        thumb = Image.new('RGB', tile.size, bg_color)
        thumb.paste(tile, None, tile)
        # Image.Resampling added in Pillow 9.1.0
        # Image.LANCZOS removed in Pillow 10
        thumb.thumbnail(size, getattr(Image, 'Resampling', Image).LANCZOS)
        if self._profile is not None:
            thumb.info['icc_profile'] = self._profile
        return thumb


class OpenSlide(AbstractSlide):
    """An open whole-slide image.

    close() is called automatically when the object is deleted.
    The object may be used as a context manager, in which case it will be
    closed upon exiting the context.

    If an operation fails, OpenSlideError is raised.  Note that OpenSlide
    has latching error semantics: once OpenSlideError is raised, all future
    operations on the OpenSlide object, other than close(), will fail.
    """

    def __init__(self, filename: lowlevel.Filename):
        """Open a whole-slide image."""
        AbstractSlide.__init__(self)
        self._filename = filename
        self._osr = lowlevel.open(filename)
        if lowlevel.read_icc_profile.available:
            self._profile = lowlevel.read_icc_profile(self._osr)

    def __repr__(self) -> str:
        return f'{self.__class__.__name__}({self._filename!r})'

    @classmethod
    def detect_format(cls, filename: lowlevel.Filename) -> str | None:
        """Return a string describing the format vendor of the specified file.

        If the file format is not recognized, return None."""
        return lowlevel.detect_vendor(filename)

    def close(self) -> None:
        """Close the OpenSlide object."""
        lowlevel.close(self._osr)

    @property
    def level_count(self) -> int:
        """The number of levels in the image."""
        return lowlevel.get_level_count(self._osr)

    @property
    def level_dimensions(self) -> tuple[tuple[int, int], ...]:
        """A tuple of (width, height) tuples, one for each level of the image.

        level_dimensions[n] contains the dimensions of level n."""
        return tuple(
            lowlevel.get_level_dimensions(self._osr, i) for i in range(self.level_count)
        )

    @property
    def level_downsamples(self) -> tuple[float, ...]:
        """A tuple of downsampling factors for each level of the image.

        level_downsample[n] contains the downsample factor of level n."""
        return tuple(
            lowlevel.get_level_downsample(self._osr, i) for i in range(self.level_count)
        )

    @property
    def properties(self) -> Mapping[str, str]:
        """Metadata about the image.

        This is a map: property name -> property value."""
        return _PropertyMap(self._osr)

    @property
    def associated_images(self) -> Mapping[str, Image.Image]:
        """Images associated with this whole-slide image.

        This is a map: image name -> PIL.Image.

        Unlike in the C interface, the images accessible via this property
        are not premultiplied."""
        return _AssociatedImageMap(self._osr, self._profile)

    def get_best_level_for_downsample(self, downsample: float) -> int:
        """Return the best level for displaying the given downsample."""
        return lowlevel.get_best_level_for_downsample(self._osr, downsample)

    def read_region(
        self, location: tuple[int, int], level: int, size: tuple[int, int]
    ) -> Image.Image:
        """Return a PIL.Image containing the contents of the region.

        location: (x, y) tuple giving the top left pixel in the level 0
                  reference frame.
        level:    the level number.
        size:     (width, height) tuple giving the region size.

        Unlike in the C interface, the image data returned by this
        function is not premultiplied."""
        region = lowlevel.read_region(
            self._osr, location[0], location[1], level, size[0], size[1]
        )
        if self._profile is not None:
            region.info['icc_profile'] = self._profile
        return region

    def set_cache(self, cache: OpenSlideCache) -> None:
        """Use the specified cache to store recently decoded slide tiles.

        By default, the object has a private cache with a default size.

        cache: an OpenSlideCache object."""
        try:
            llcache = cache._openslide_cache
        except AttributeError as exc:
            raise TypeError('Not a cache object') from exc
        lowlevel.set_cache(self._osr, llcache)


class _OpenSlideMap(Mapping[str, _T]):
    def __init__(self, osr: lowlevel._OpenSlide):
        self._osr = osr

    def __repr__(self) -> str:
        return f'<{self.__class__.__name__} {dict(self)!r}>'

    def __len__(self) -> int:
        return len(self._keys())

    def __iter__(self) -> Iterator[str]:
        return iter(self._keys())

    @abstractmethod
    def _keys(self) -> list[str]:
        # Private method; always returns list.
        raise NotImplementedError()


class _PropertyMap(_OpenSlideMap[str]):
    def _keys(self) -> list[str]:
        return lowlevel.get_property_names(self._osr)

    def __getitem__(self, key: str) -> str:
        v = lowlevel.get_property_value(self._osr, key)
        if v is None:
            raise KeyError()
        return v


class _AssociatedImageMap(_OpenSlideMap[Image.Image]):
    def __init__(self, osr: lowlevel._OpenSlide, profile: bytes | None):
        _OpenSlideMap.__init__(self, osr)
        self._profile = profile

    def _keys(self) -> list[str]:
        return lowlevel.get_associated_image_names(self._osr)

    def __getitem__(self, key: str) -> Image.Image:
        if key not in self._keys():
            raise KeyError()
        image = lowlevel.read_associated_image(self._osr, key)
        if lowlevel.read_associated_image_icc_profile.available:
            profile = lowlevel.read_associated_image_icc_profile(self._osr, key)
            if profile == self._profile:
                # reuse profile copy from main image to save memory
                profile = self._profile
            if profile is not None:
                image.info['icc_profile'] = profile
        return image


class OpenSlideCache:
    """An in-memory tile cache.

    Tile caches can be attached to one or more OpenSlide objects with
    OpenSlide.set_cache() to cache recently-decoded tiles.  By default,
    each OpenSlide object has its own cache with a default size.
    """

    def __init__(self, capacity: int):
        """Create a tile cache with the specified capacity in bytes."""
        self._capacity = capacity
        self._openslide_cache = lowlevel.cache_create(capacity)

    def __repr__(self) -> str:
        return f'{self.__class__.__name__}({self._capacity!r})'


class ImageSlide(AbstractSlide):
    """A wrapper for a PIL.Image that provides the OpenSlide interface."""

    def __init__(self, file: lowlevel.Filename | Image.Image):
        """Open an image file.

        file can be a filename or a PIL.Image."""
        AbstractSlide.__init__(self)
        self._file_arg = file
        if isinstance(file, Image.Image):
            self._close = False
            self._image: Image.Image | None = file
        else:
            self._close = True
            self._image = Image.open(file)
        self._profile = self._image.info.get('icc_profile')

    def __repr__(self) -> str:
        return f'{self.__class__.__name__}({self._file_arg!r})'

    @classmethod
    def detect_format(cls, filename: lowlevel.Filename) -> str | None:
        """Return a string describing the format of the specified file.

        If the file format is not recognized, return None."""
        try:
            with Image.open(filename) as img:
                # img currently resolves as Any
                # https://github.com/python-pillow/Pillow/pull/8362
                return img.format  # type: ignore[no-any-return]
        except OSError:
            return None

    def close(self) -> None:
        """Close the slide object."""
        if self._close:
            assert self._image is not None
            self._image.close()
            self._close = False
        self._image = None

    @property
    def level_count(self) -> Literal[1]:
        """The number of levels in the image."""
        return 1

    @property
    def level_dimensions(self) -> tuple[tuple[int, int]]:
        """A tuple of (width, height) tuples, one for each level of the image.

        level_dimensions[n] contains the dimensions of level n."""
        if self._image is None:
            raise ValueError('Cannot read from a closed slide')
        return (self._image.size,)

    @property
    def level_downsamples(self) -> tuple[float]:
        """A tuple of downsampling factors for each level of the image.

        level_downsample[n] contains the downsample factor of level n."""
        return (1.0,)

    @property
    def properties(self) -> Mapping[str, str]:
        """Metadata about the image.

        This is a map: property name -> property value."""
        return {}

    @property
    def associated_images(self) -> Mapping[str, Image.Image]:
        """Images associated with this whole-slide image.

        This is a map: image name -> PIL.Image."""
        return {}

    def get_best_level_for_downsample(self, _downsample: float) -> Literal[0]:
        """Return the best level for displaying the given downsample."""
        return 0

    def read_region(
        self, location: tuple[int, int], level: int, size: tuple[int, int]
    ) -> Image.Image:
        """Return a PIL.Image containing the contents of the region.

        location: (x, y) tuple giving the top left pixel in the level 0
                  reference frame.
        level:    the level number.
        size:     (width, height) tuple giving the region size."""
        if self._image is None:
            raise ValueError('Cannot read from a closed slide')
        if level != 0:
            raise OpenSlideError("Invalid level")
        if ['fail' for s in size if s < 0]:
            raise OpenSlideError(f"Size {size} must be non-negative")
        # Any corner of the requested region may be outside the bounds of
        # the image.  Create a transparent tile of the correct size and
        # paste the valid part of the region into the correct location.
        image_topleft = [
            max(0, min(l, limit - 1)) for l, limit in zip(location, self._image.size)
        ]
        image_bottomright = [
            max(0, min(l + s - 1, limit - 1))
            for l, s, limit in zip(location, size, self._image.size)
        ]
        tile = Image.new("RGBA", size, (0,) * 4)
        if not [
            'fail' for tl, br in zip(image_topleft, image_bottomright) if br - tl < 0
        ]:  # "< 0" not a typo
            # Crop size is greater than zero in both dimensions.
            # PIL thinks the bottom right is the first *excluded* pixel
            crop_box = tuple(image_topleft + [d + 1 for d in image_bottomright])
            tile_offset = tuple(il - l for il, l in zip(image_topleft, location))
            assert len(crop_box) == 4 and len(tile_offset) == 2
            crop = self._image.crop(crop_box)
            tile.paste(crop, tile_offset)
        if self._profile is not None:
            tile.info['icc_profile'] = self._profile
        return tile


def open_slide(filename: lowlevel.Filename) -> OpenSlide | ImageSlide:
    """Open a whole-slide or regular image.

    Return an OpenSlide object for whole-slide images and an ImageSlide
    object for other types of images."""
    try:
        return OpenSlide(filename)
    except OpenSlideUnsupportedFormatError:
        return ImageSlide(filename)


if __name__ == '__main__':
    import sys

    print("OpenSlide vendor:", OpenSlide.detect_format(sys.argv[1]))
    print("PIL format:", ImageSlide.detect_format(sys.argv[1]))
    with open_slide(sys.argv[1]) as _slide:
        print("Dimensions:", _slide.dimensions)
        print("Levels:", _slide.level_count)
        print("Level dimensions:", _slide.level_dimensions)
        print("Level downsamples:", _slide.level_downsamples)
        print("Properties:", _slide.properties)
        print("Associated images:", _slide.associated_images)