ImageMode.py 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. #
  2. # The Python Imaging Library.
  3. # $Id$
  4. #
  5. # standard mode descriptors
  6. #
  7. # History:
  8. # 2006-03-20 fl Added
  9. #
  10. # Copyright (c) 2006 by Secret Labs AB.
  11. # Copyright (c) 2006 by Fredrik Lundh.
  12. #
  13. # See the README file for information on usage and redistribution.
  14. #
  15. from __future__ import annotations
  16. import sys
  17. from functools import lru_cache
  18. from typing import NamedTuple
  19. from ._deprecate import deprecate
  20. class ModeDescriptor(NamedTuple):
  21. """Wrapper for mode strings."""
  22. mode: str
  23. bands: tuple[str, ...]
  24. basemode: str
  25. basetype: str
  26. typestr: str
  27. def __str__(self) -> str:
  28. return self.mode
  29. @lru_cache
  30. def getmode(mode: str) -> ModeDescriptor:
  31. """Gets a mode descriptor for the given mode."""
  32. endian = "<" if sys.byteorder == "little" else ">"
  33. modes = {
  34. # core modes
  35. # Bits need to be extended to bytes
  36. "1": ("L", "L", ("1",), "|b1"),
  37. "L": ("L", "L", ("L",), "|u1"),
  38. "I": ("L", "I", ("I",), f"{endian}i4"),
  39. "F": ("L", "F", ("F",), f"{endian}f4"),
  40. "P": ("P", "L", ("P",), "|u1"),
  41. "RGB": ("RGB", "L", ("R", "G", "B"), "|u1"),
  42. "RGBX": ("RGB", "L", ("R", "G", "B", "X"), "|u1"),
  43. "RGBA": ("RGB", "L", ("R", "G", "B", "A"), "|u1"),
  44. "CMYK": ("RGB", "L", ("C", "M", "Y", "K"), "|u1"),
  45. "YCbCr": ("RGB", "L", ("Y", "Cb", "Cr"), "|u1"),
  46. # UNDONE - unsigned |u1i1i1
  47. "LAB": ("RGB", "L", ("L", "A", "B"), "|u1"),
  48. "HSV": ("RGB", "L", ("H", "S", "V"), "|u1"),
  49. # extra experimental modes
  50. "RGBa": ("RGB", "L", ("R", "G", "B", "a"), "|u1"),
  51. "BGR;15": ("RGB", "L", ("B", "G", "R"), "|u1"),
  52. "BGR;16": ("RGB", "L", ("B", "G", "R"), "|u1"),
  53. "BGR;24": ("RGB", "L", ("B", "G", "R"), "|u1"),
  54. "LA": ("L", "L", ("L", "A"), "|u1"),
  55. "La": ("L", "L", ("L", "a"), "|u1"),
  56. "PA": ("RGB", "L", ("P", "A"), "|u1"),
  57. }
  58. if mode in modes:
  59. if mode in ("BGR;15", "BGR;16", "BGR;24"):
  60. deprecate(mode, 12)
  61. base_mode, base_type, bands, type_str = modes[mode]
  62. return ModeDescriptor(mode, bands, base_mode, base_type, type_str)
  63. mapping_modes = {
  64. # I;16 == I;16L, and I;32 == I;32L
  65. "I;16": "<u2",
  66. "I;16S": "<i2",
  67. "I;16L": "<u2",
  68. "I;16LS": "<i2",
  69. "I;16B": ">u2",
  70. "I;16BS": ">i2",
  71. "I;16N": f"{endian}u2",
  72. "I;16NS": f"{endian}i2",
  73. "I;32": "<u4",
  74. "I;32B": ">u4",
  75. "I;32L": "<u4",
  76. "I;32S": "<i4",
  77. "I;32BS": ">i4",
  78. "I;32LS": "<i4",
  79. }
  80. type_str = mapping_modes[mode]
  81. return ModeDescriptor(mode, ("I",), "L", "L", type_str)