Expand .ani and .cur functionality

Tests/test_file_ani.py

@@ -0,0 +1,161 @@
+from __future__ import annotations
+
+from io import BytesIO
+
+import pytest
+
+from PIL import Image
+
+from .helper import assert_image_equal_tofile
+
+
+def test_aero_busy() -> None:
+    with Image.open("Tests/images/ani/aero_busy.ani") as im:
+        assert im.size == (64, 64)
+        assert im.n_frames == 18
+
+        assert_image_equal_tofile(im, "Tests/images/ani/aero_busy_0.png")
+
+        im.seek(8)
+        assert im.tell() == 8
+        assert_image_equal_tofile(im, "Tests/images/ani/aero_busy_8.png")
+
+        with pytest.raises(EOFError):
+            im.seek(-1)
+
+        with pytest.raises(EOFError):
+            im.seek(18)
+
+
+def test_posy_busy() -> None:
+    with Image.open("Tests/images/ani/posy_busy.ani") as im:
+        assert im.size == (96, 96)
+        assert im.n_frames == 77
+
+        assert_image_equal_tofile(im, "Tests/images/ani/posy_busy_0.png")
+
+        im.seek(24)
+        assert_image_equal_tofile(im, "Tests/images/ani/posy_busy_24.png")
+
+        with pytest.raises(EOFError):
+            im.seek(77)
+
+
+def test_seq_rate() -> None:
+    with Image.open("Tests/images/ani/stopwtch.ani") as im:
+        assert im.size == (32, 32)
+        assert im.n_frames == 8
+
+        assert im.info["seq"][:3] == [0, 1, 0]
+        assert im.info["rate"] == [8, 16, 16] + [8] * 42
+
+        assert_image_equal_tofile(im, "Tests/images/ani/stopwtch_0.png")
+
+        im.seek(5)
+        assert_image_equal_tofile(im, "Tests/images/ani/stopwtch_5.png")
+
+        with pytest.raises(EOFError):
+            im.seek(8)
+
+
+def test_save() -> None:
+    filenames = [
+        "aero_busy_0.png",
+        "aero_busy_8.png",
+        "posy_busy_0.png",
+        "posy_busy_24.png",
+        "stopwtch_0.png",
+        "stopwtch_5.png",
+    ]
+
+    images = [Image.open("Tests/images/ani/" + filename) for filename in filenames]
+
+    with BytesIO() as output:
+        images[0].save(
+            output, append_images=[images[1]], seq=[0, 1], rate=[5, 10], format="ANI"
+        )
+
+        with Image.open(output, formats=["ANI"]) as im:
+            assert im.tobytes() == images[0].tobytes()
+            im.seek(1)
+            assert im.tobytes() == images[1].tobytes()
+            assert im.info["seq"] == [0, 1]
+            assert im.info["rate"] == [5, 10]
+
+    with BytesIO() as output:
+        images[2].save(
+            output,
+            append_images=[images[3]],
+            seq=[1, 0],
+            rate=[2, 2],
+            format="ANI",
+            sizes=[(96, 96)],
+        )
+
+        with Image.open(output, formats=["ANI"]) as im:
+            assert im.tobytes() == images[2].tobytes()
+            im.seek(1)
+            assert im.tobytes() == images[3].tobytes()
+            assert im.info["seq"] == [1, 0]
+            assert im.info["rate"] == [2, 2]
+
+    with BytesIO() as output:
+        images[4].save(
+            output, append_images=[images[5]], seq=[0, 1], rate=[3, 4], format="ANI"
+        )
+
+        with Image.open(output, formats=["ANI"]) as im:
+            assert im.tobytes() == images[4].tobytes()
+            im.seek(1)
+            assert im.tobytes() == images[5].tobytes()
+            assert im.info["seq"] == [0, 1]
+            assert im.info["rate"] == [3, 4]
+
+    with BytesIO() as output:
+        images[0].save(
+            output,
+            append_images=images[1:],
+            seq=[0, 2, 4, 1, 3, 5, 0, 1, 0, 1],
+            rate=[1, 2, 3, 1, 2, 3, 1, 2, 3, 4],
+            format="ANI",
+            sizes=[(32, 32)],
+        )
+
+        with Image.open(output, formats=["ANI"]) as im:
+            assert im.n_frames == 6
+            assert im.info["seq"] == [0, 2, 4, 1, 3, 5, 0, 1, 0, 1]
+            assert im.info["rate"] == [1, 2, 3, 1, 2, 3, 1, 2, 3, 4]
+            assert im.size == (32, 32)
+
+            im.seek(4)
+            assert im.tobytes() == images[4].tobytes()
+
+    with BytesIO() as output:
+        with pytest.raises(ValueError):
+            images[0].save(
+                output,
+                append_images=images[1:],
+                seq=[0, 1, 8, 1, 2],
+                rate=[1, 1, 1, 1, 1],
+                format="ANI",
+                sizes=[(32, 32)],
+            )
+
+        with pytest.raises(ValueError):
+            images[0].save(
+                output,
+                append_images=images[1:],
+                seq=[0, 1, 1, 1, 2],
+                rate=[1, 1, 1, 1],
+                format="ANI",
+                sizes=[(32, 32)],
+            )
+
+        with pytest.raises(ValueError):
+            images[0].save(
+                output,
+                append_images=images[1:],
+                rate=[1, 1, 1, 1],
+                format="ANI",
+                sizes=[(32, 32)],
+            )

Tests/test_file_cur.py

@@ -9,14 +9,16 @@
 from PIL._binary import o16le as o16
 from PIL._binary import o32le as o32
 
-TEST_FILE = "Tests/images/deerstalker.cur"
+from .helper import assert_image_equal
 
 
 def test_sanity() -> None:
-    with Image.open(TEST_FILE) as im:
+    with Image.open("Tests/images/cur/deerstalker.cur") as im:
         assert im.size == (32, 32)
+        assert im.info["hotspots"] == [(0, 0)]
         assert isinstance(im, CurImagePlugin.CurImageFile)
-        # Check some pixel colors to ensure image is loaded properly
+
+        # Check pixel colors to ensure image is loaded properly
         assert im.getpixel((10, 1)) == (0, 0, 0, 0)
         assert im.getpixel((11, 1)) == (253, 254, 254, 1)
         assert im.getpixel((16, 16)) == (84, 87, 86, 255)
@@ -36,21 +38,128 @@ def test_largest_cursor() -> None:
         + o16(0)  # planes
         + o16(1)  # bits
     )
+
+    fp = BytesIO()
+    im = Image.new("1", (8, 8))
+    im.save(fp, "PNG")
+    data += fp.getvalue()
+
     with Image.open(BytesIO(data)) as im:
         assert im.size == (8, 8)
 
 
+def test_posy_link() -> None:
+    with Image.open("Tests/images/cur/posy_link.cur") as im:
+        assert im.size == (128, 128)
+        assert im.info["sizes"] == {(128, 128), (96, 96), (64, 64), (48, 48), (32, 32)}
+        assert im.info["hotspots"] == [(25, 7), (18, 5), (12, 3), (9, 2), (5, 1)]
+
+        # check pixel colors
+        assert im.getpixel((0, 0)) == (0, 0, 0, 0)
+        assert im.getpixel((20, 20)) == (0, 0, 0, 255)
+        assert im.getpixel((40, 40)) == (255, 255, 255, 255)
+
+        im.size = (32, 32)
+        im.load()
+        assert im.getpixel((0, 0)) == (0, 0, 0, 0)
+        assert im.getpixel((10, 10)) == (191, 191, 191, 255)
+
+
+def test_stopwtch() -> None:
+    with Image.open("Tests/images/cur/stopwtch.cur") as im:
+        assert im.size == (32, 32)
+        assert im.info["hotspots"] == [(16, 19)]
+
+        assert im.getpixel((16, 16)) == (0, 0, 255, 255)
+        assert im.getpixel((8, 16)) == (255, 0, 0, 255)
+
+
+def test_win98_arrow() -> None:
+    with Image.open("Tests/images/cur/win98_arrow.cur") as im:
+        assert im.size == (32, 32)
+        assert im.info["hotspots"] == [(10, 10)]
+
+        assert im.getpixel((0, 0)) == (0, 0, 0, 0)
+        assert im.getpixel((16, 16)) == (0, 0, 0, 255)
+        assert im.getpixel((14, 19)) == (255, 255, 255, 255)
+
+
 def test_invalid_file() -> None:
-    invalid_file = "Tests/images/flower.jpg"
+    invalid_file = "Tests/images/cur/posy_link.png"
 
     with pytest.raises(SyntaxError):
         CurImagePlugin.CurImageFile(invalid_file)
 
-    no_cursors_file = "Tests/images/no_cursors.cur"
+    no_cursors_file = "Tests/images/cur/no_cursors.cur"
 
-    cur = CurImagePlugin.CurImageFile(TEST_FILE)
+    cur = CurImagePlugin.CurImageFile("Tests/images/cur/deerstalker.cur")
     assert cur.fp is not None
     cur.fp.close()
     with open(no_cursors_file, "rb") as cur.fp:
         with pytest.raises(TypeError):
             cur._open()
+
+
+def test_save_win98_arrow() -> None:
+    with Image.open("Tests/images/cur/win98_arrow.png") as im:
+        # save the data
+        with BytesIO() as output:
+            im.save(
+                output,
+                format="CUR",
+                sizes=[(32, 32)],
+                hotspots=[(10, 10)],
+                bitmap_format="bmp",
+            )
+            with Image.open(output) as reloaded:
+                assert_image_equal(im, reloaded)
+
+        with BytesIO() as output:
+            im.save(output, format="CUR")
+
+            # check default save params
+            with Image.open(output) as reloaded:
+                assert reloaded.size == (32, 32)
+                assert reloaded.info["sizes"] == {(32, 32), (24, 24), (16, 16)}
+                assert reloaded.info["hotspots"] == [(0, 0), (0, 0), (0, 0)]
+
+
+def test_save_posy_link() -> None:
+    sizes = [(128, 128), (96, 96), (64, 64), (48, 48), (32, 32)]
+    hotspots = [(25, 7), (18, 5), (12, 3), (9, 2), (5, 1)]
+
+    with Image.open("Tests/images/cur/posy_link.png") as im:
+        # save the data
+        with BytesIO() as output:
+            im.save(
+                output,
+                sizes=sizes,
+                hotspots=hotspots,
+                format="CUR",
+                bitmap_format="bmp",
+            )
+
+            # make sure saved output is readable
+            # and sizes/hotspots are correct
+            with Image.open(output, formats=["CUR"]) as reloaded:
+                assert (128, 128) == reloaded.size
+                assert set(sizes) == reloaded.info["sizes"]
+
+        with BytesIO() as output:
+            im.save(output, sizes=sizes[3:], hotspots=hotspots[3:], format="CUR")
+
+            # make sure saved output is readable
+            # and sizes/hotspots are correct
+            with Image.open(output, formats=["CUR"]) as reloaded:
+                assert reloaded.size == (48, 48)
+                assert reloaded.info["sizes"] == set(sizes[3:])
+
+            # check error is thrown when size and hotspot length don't match
+            with pytest.raises(ValueError):
+                im.save(
+                    output,
+                    sizes=sizes[2:],
+                    hotspots=hotspots[3:],
+                    format="CUR",
+                    bitmap_format="bmp",
+                )