Added progress callback to AVIF

Author: radarhere

Tests/test_file_apng.py

@@ -710,11 +710,9 @@ def test_save_all_progress() -> None:
     out = BytesIO()
     progress = []
 
-    def callback(state):
+    def callback(state) -> None:
         if state["image_filename"]:
-            state["image_filename"] = (
-                state["image_filename"].replace("\\", "/").split("Tests/images/")[-1]
-            )
+            state["image_filename"] = state["image_filename"].replace("\\", "/")
         progress.append(state)
 
     Image.new("RGB", (1, 1)).save(out, "PNG", save_all=True, progress=callback)
@@ -741,7 +739,7 @@ def callback(state):
         expected.append(
             {
                 "image_index": i,
-                "image_filename": "apng/single_frame.png",
+                "image_filename": "Tests/images/apng/single_frame.png",
                 "completed_frames": i + 1,
                 "total_frames": 7,
             }
@@ -750,7 +748,7 @@ def callback(state):
         expected.append(
             {
                 "image_index": 2,
-                "image_filename": "apng/delay.png",
+                "image_filename": "Tests/images/apng/delay.png",
                 "completed_frames": i + 3,
                 "total_frames": 7,
             }

Tests/test_file_avif.py

@@ -217,6 +217,52 @@ def test_file_pointer_could_be_reused(self) -> None:
             with Image.open(blob) as im:
                 im.load()
 
+    def test_save_all_progress(self) -> None:
+        out = BytesIO()
+        progress = []
+
+        def callback(state) -> None:
+            if state["image_filename"]:
+                state["image_filename"] = state["image_filename"].replace("\\", "/")
+            progress.append(state)
+
+        Image.new("RGB", (1, 1)).save(out, "AVIF", save_all=True, progress=callback)
+        assert progress == [
+            {
+                "image_index": 0,
+                "image_filename": None,
+                "completed_frames": 1,
+                "total_frames": 1,
+            }
+        ]
+
+        out = BytesIO()
+        progress = []
+
+        with Image.open("Tests/images/avif/hopper.avif") as im:
+            im2 = Image.new("RGB", im.size)
+            im.save(out, "AVIF", save_all=True, append_images=[im2], progress=callback)
+
+        expected = []
+        for i in range(42):
+            expected.append(
+                {
+                    "image_index": 0,
+                    "image_filename": "Tests/images/avif/hopper.avif",
+                    "completed_frames": i + 1,
+                    "total_frames": 43,
+                }
+            )
+        expected.append(
+            {
+                "image_index": 1,
+                "image_filename": None,
+                "completed_frames": 43,
+                "total_frames": 43,
+            }
+        )
+        assert progress == expected
+
     def test_background_from_gif(self, tmp_path: Path) -> None:
         with Image.open("Tests/images/chi.gif") as im:
             original_value = im.convert("RGB").getpixel((1, 1))

Tests/test_file_gif.py

@@ -296,15 +296,13 @@ def test_roundtrip_save_all_1(tmp_path: Path) -> None:
         assert reloaded.getpixel((0, 0)) == 255
 
 
-def test_save_all_progress():
+def test_save_all_progress() -> None:
     out = BytesIO()
     progress = []
 
-    def callback(state):
+    def callback(state) -> None:
         if state["image_filename"]:
-            state["image_filename"] = (
-                state["image_filename"].replace("\\", "/").split("Tests/images/")[-1]
-            )
+            state["image_filename"] = state["image_filename"].replace("\\", "/")
         progress.append(state)
 
     Image.new("RGB", (1, 1)).save(out, "GIF", save_all=True, progress=callback)
@@ -336,7 +334,7 @@ def callback(state):
         expected.append(
             {
                 "image_index": 1,
-                "image_filename": "chi.gif",
+                "image_filename": "Tests/images/chi.gif",
                 "completed_frames": i + 2,
                 "total_frames": 32,
             }

Tests/test_file_pdf.py

@@ -178,7 +178,7 @@ def test_save_all_progress() -> None:
     out = BytesIO()
     progress = []
 
-    def callback(state):
+    def callback(state) -> None:
         if state["image_filename"]:
             state["image_filename"] = (
                 state["image_filename"].replace("\\", "/").split("Tests/images/")[-1]

Tests/test_file_tiff.py

@@ -797,7 +797,7 @@ def test_save_all_progress(self) -> None:
         out = BytesIO()
         progress = []
 
-        def callback(state):
+        def callback(state) -> None:
             if state["image_filename"]:
                 state["image_filename"] = (
                     state["image_filename"]

Tests/test_file_webp.py

@@ -129,18 +129,13 @@ def test_unsupported_image_mode(self) -> None:
         with pytest.raises(ValueError):
             _webp.WebPEncode(im.getim(), False, 0, 0, "", 4, 0, b"", "")
 
-    @skip_unless_feature("webp_anim")
     def test_save_all_progress(self) -> None:
         out = BytesIO()
         progress = []
 
-        def callback(state):
+        def callback(state) -> None:
             if state["image_filename"]:
-                state["image_filename"] = (
-                    state["image_filename"]
-                    .replace("\\", "/")
-                    .split("Tests/images/")[-1]
-                )
+                state["image_filename"] = state["image_filename"].replace("\\", "/")
             progress.append(state)
 
         Image.new("RGB", (1, 1)).save(out, "WEBP", save_all=True, progress=callback)
@@ -165,7 +160,7 @@ def callback(state):
             expected.append(
                 {
                     "image_index": 0,
-                    "image_filename": "iss634.webp",
+                    "image_filename": "Tests/images/iss634.webp",
                     "completed_frames": i + 1,
                     "total_frames": 43,
                 }

src/PIL/AvifImagePlugin.py

@@ -236,8 +236,9 @@ def _save(
     frame_duration = 0
     cur_idx = im.tell()
     is_single_frame = total == 1
+    progress = info.get("progress")
     try:
-        for ims in [im] + append_images:
+        for i, ims in enumerate([im] + append_images):
             # Get number of frames in this image
             nfr = getattr(ims, "n_frames", 1)
 
@@ -268,6 +269,7 @@ def _save(
 
                 # Update frame index
                 frame_idx += 1
+                im._save_all_progress(progress, ims, i, frame_idx, total)
 
                 if not save_all:
                     break