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#
15from __future__ import annotations
16
17import sys
18from functools import lru_cache
19from typing import NamedTuple
20
21from ._deprecate import deprecate
22
23
24class ModeDescriptor(NamedTuple):
25 """Wrapper for mode strings."""
26
27 mode: str
28 bands: tuple[str, ...]
29 basemode: str
30 basetype: str
31 typestr: str
32
33 def __str__(self) -> str:
34 return self.mode
35
36
37@lru_cache
38def getmode(mode: str) -> ModeDescriptor:
39 """Gets a mode descriptor for the given mode."""
40 endian = "<" if sys.byteorder == "little" else ">"
41
42 modes = {
43 # core modes
44 # Bits need to be extended to bytes
45 "1": ("L", "L", ("1",), "|b1"),
46 "L": ("L", "L", ("L",), "|u1"),
47 "I": ("L", "I", ("I",), f"{endian}i4"),
48 "F": ("L", "F", ("F",), f"{endian}f4"),
49 "P": ("P", "L", ("P",), "|u1"),
50 "RGB": ("RGB", "L", ("R", "G", "B"), "|u1"),
51 "RGBX": ("RGB", "L", ("R", "G", "B", "X"), "|u1"),
52 "RGBA": ("RGB", "L", ("R", "G", "B", "A"), "|u1"),
53 "CMYK": ("RGB", "L", ("C", "M", "Y", "K"), "|u1"),
54 "YCbCr": ("RGB", "L", ("Y", "Cb", "Cr"), "|u1"),
55 # UNDONE - unsigned |u1i1i1
56 "LAB": ("RGB", "L", ("L", "A", "B"), "|u1"),
57 "HSV": ("RGB", "L", ("H", "S", "V"), "|u1"),
58 # extra experimental modes
59 "RGBa": ("RGB", "L", ("R", "G", "B", "a"), "|u1"),
60 "BGR;15": ("RGB", "L", ("B", "G", "R"), "|u1"),
61 "BGR;16": ("RGB", "L", ("B", "G", "R"), "|u1"),
62 "BGR;24": ("RGB", "L", ("B", "G", "R"), "|u1"),
63 "LA": ("L", "L", ("L", "A"), "|u1"),
64 "La": ("L", "L", ("L", "a"), "|u1"),
65 "PA": ("RGB", "L", ("P", "A"), "|u1"),
66 }
67 if mode in modes:
68 if mode in ("BGR;15", "BGR;16", "BGR;24"):
69 deprecate(mode, 12)
70 base_mode, base_type, bands, type_str = modes[mode]
71 return ModeDescriptor(mode, bands, base_mode, base_type, type_str)
72
73 mapping_modes = {
74 # I;16 == I;16L, and I;32 == I;32L
75 "I;16": "<u2",
76 "I;16S": "<i2",
77 "I;16L": "<u2",
78 "I;16LS": "<i2",
79 "I;16B": ">u2",
80 "I;16BS": ">i2",
81 "I;16N": f"{endian}u2",
82 "I;16NS": f"{endian}i2",
83 "I;32": "<u4",
84 "I;32B": ">u4",
85 "I;32L": "<u4",
86 "I;32S": "<i4",
87 "I;32BS": ">i4",
88 "I;32LS": "<i4",
89 }
90
91 type_str = mapping_modes[mode]
92 return ModeDescriptor(mode, ("I",), "L", "L", type_str)