1#
2# The Python Imaging Library.
3# $Id$
4#
5# FLI/FLC file handling.
6#
7# History:
8# 95-09-01 fl Created
9# 97-01-03 fl Fixed parser, setup decoder tile
10# 98-07-15 fl Renamed offset attribute to avoid name clash
11#
12# Copyright (c) Secret Labs AB 1997-98.
13# Copyright (c) Fredrik Lundh 1995-97.
14#
15# See the README file for information on usage and redistribution.
16#
17from __future__ import annotations
18
19import os
20
21from . import Image, ImageFile, ImagePalette
22from ._binary import i16le as i16
23from ._binary import i32le as i32
24from ._binary import o8
25from ._util import DeferredError
26
27#
28# decoder
29
30
31def _accept(prefix: bytes) -> bool:
32 return (
33 len(prefix) >= 6
34 and i16(prefix, 4) in [0xAF11, 0xAF12]
35 and i16(prefix, 14) in [0, 3] # flags
36 )
37
38
39##
40# Image plugin for the FLI/FLC animation format. Use the <b>seek</b>
41# method to load individual frames.
42
43
44class FliImageFile(ImageFile.ImageFile):
45 format = "FLI"
46 format_description = "Autodesk FLI/FLC Animation"
47 _close_exclusive_fp_after_loading = False
48
49 def _open(self) -> None:
50 # HEAD
51 s = self.fp.read(128)
52 if not (_accept(s) and s[20:22] == b"\x00\x00"):
53 msg = "not an FLI/FLC file"
54 raise SyntaxError(msg)
55
56 # frames
57 self.n_frames = i16(s, 6)
58 self.is_animated = self.n_frames > 1
59
60 # image characteristics
61 self._mode = "P"
62 self._size = i16(s, 8), i16(s, 10)
63
64 # animation speed
65 duration = i32(s, 16)
66 magic = i16(s, 4)
67 if magic == 0xAF11:
68 duration = (duration * 1000) // 70
69 self.info["duration"] = duration
70
71 # look for palette
72 palette = [(a, a, a) for a in range(256)]
73
74 s = self.fp.read(16)
75
76 self.__offset = 128
77
78 if i16(s, 4) == 0xF100:
79 # prefix chunk; ignore it
80 self.__offset = self.__offset + i32(s)
81 self.fp.seek(self.__offset)
82 s = self.fp.read(16)
83
84 if i16(s, 4) == 0xF1FA:
85 # look for palette chunk
86 number_of_subchunks = i16(s, 6)
87 chunk_size: int | None = None
88 for _ in range(number_of_subchunks):
89 if chunk_size is not None:
90 self.fp.seek(chunk_size - 6, os.SEEK_CUR)
91 s = self.fp.read(6)
92 chunk_type = i16(s, 4)
93 if chunk_type in (4, 11):
94 self._palette(palette, 2 if chunk_type == 11 else 0)
95 break
96 chunk_size = i32(s)
97 if not chunk_size:
98 break
99
100 self.palette = ImagePalette.raw(
101 "RGB", b"".join(o8(r) + o8(g) + o8(b) for (r, g, b) in palette)
102 )
103
104 # set things up to decode first frame
105 self.__frame = -1
106 self._fp = self.fp
107 self.__rewind = self.fp.tell()
108 self.seek(0)
109
110 def _palette(self, palette: list[tuple[int, int, int]], shift: int) -> None:
111 # load palette
112
113 i = 0
114 for e in range(i16(self.fp.read(2))):
115 s = self.fp.read(2)
116 i = i + s[0]
117 n = s[1]
118 if n == 0:
119 n = 256
120 s = self.fp.read(n * 3)
121 for n in range(0, len(s), 3):
122 r = s[n] << shift
123 g = s[n + 1] << shift
124 b = s[n + 2] << shift
125 palette[i] = (r, g, b)
126 i += 1
127
128 def seek(self, frame: int) -> None:
129 if not self._seek_check(frame):
130 return
131 if frame < self.__frame:
132 self._seek(0)
133
134 for f in range(self.__frame + 1, frame + 1):
135 self._seek(f)
136
137 def _seek(self, frame: int) -> None:
138 if isinstance(self._fp, DeferredError):
139 raise self._fp.ex
140 if frame == 0:
141 self.__frame = -1
142 self._fp.seek(self.__rewind)
143 self.__offset = 128
144 else:
145 # ensure that the previous frame was loaded
146 self.load()
147
148 if frame != self.__frame + 1:
149 msg = f"cannot seek to frame {frame}"
150 raise ValueError(msg)
151 self.__frame = frame
152
153 # move to next frame
154 self.fp = self._fp
155 self.fp.seek(self.__offset)
156
157 s = self.fp.read(4)
158 if not s:
159 msg = "missing frame size"
160 raise EOFError(msg)
161
162 framesize = i32(s)
163
164 self.decodermaxblock = framesize
165 self.tile = [ImageFile._Tile("fli", (0, 0) + self.size, self.__offset)]
166
167 self.__offset += framesize
168
169 def tell(self) -> int:
170 return self.__frame
171
172
173#
174# registry
175
176Image.register_open(FliImageFile.format, FliImageFile, _accept)
177
178Image.register_extensions(FliImageFile.format, [".fli", ".flc"])