Add moviepy 2 compatibility

.github/workflows/python-app.yml

@@ -43,7 +43,7 @@ jobs:
       run: |
         curl -Os https://cli.codecov.io/latest/linux/codecov
         chmod +x codecov
-        ./codecov --verbose upload-process --fail-on-error -t ${{ secrets.CODECOV_TOKEN }} -n 'service'-${{ github.run_id }} -F service -f coverage.xml
+        ./codecov --verbose upload-process --fail-on-error -n 'service'-${{ github.run_id }} -F service -f coverage.xml
 
   test:
     needs: build

tensorboardX/summary.py

@@ -1,4 +1,3 @@
-
 import logging
 import os
 import re as _re
@@ -369,25 +368,46 @@ def video(tag, tensor, fps=4, dataformats="NTCHW"):
 
 def make_video(tensor, fps):
     try:
-        import moviepy  # noqa: F401
+        import moviepy
     except ImportError:
         print('add_video needs package moviepy')
         return
     try:
-        from moviepy import editor as mpy
+        # moviepy v2+
+        from moviepy import ImageSequenceClip
     except ImportError:
-        print("moviepy is installed, but can't import moviepy.editor.",
-              "Some packages could be missing [imageio, requests]")
-        return
+        try:
+            # Fallback for all moviepy versions
+            from moviepy.video.io.ImageSequenceClip import ImageSequenceClip
+        except ModuleNotFoundError as e:
+            logger.error(
+                "moviepy is installed, but can't import moviepy.video.io.ImageSequenceClip due to missing module: %s",
+                e,
+            )
+            return
+        except ImportError as e:
+            logger.error(
+                "moviepy is installed, but can't import moviepy.video.io.ImageSequenceClip due to %r",
+                e,
+            )
+            return
 
     import tempfile
 
+    import imageio
     import moviepy.version
+    from packaging.version import Version
 
     t, h, w, c = tensor.shape
 
+    # Convert to RGB if moviepy v2/imageio>2.27 is used; 1-channel input is not supported.
+    if c == 1 and (
+        Version(moviepy.version.__version__) >= Version("2")
+        or Version(imageio.__version__) > Version("2.27")
+    ):
+        tensor = np.repeat(tensor, 3, axis=-1)
     # encode sequence of images into gif string
-    clip = mpy.ImageSequenceClip(list(tensor), fps=fps)
+    clip = ImageSequenceClip(list(tensor), fps=fps)
     with tempfile.NamedTemporaryFile(suffix='.gif', delete=False) as fp:
         filename = fp.name
 

tests/test_summary.py

@@ -76,12 +76,44 @@ def test_image_with_four_channel_batched(self):
     def test_image_without_channel(self):
         compare_proto(summary.image('dummy', tensor_N(shape=(8, 8)), dataformats='HW'), self)
 
+    @staticmethod
+    def _iter_gif(encoded_image):
+        import io
+
+        from PIL import Image, ImageSequence
+        image_io = io.BytesIO(encoded_image)
+        im = Image.open(image_io, )
+        for frame in ImageSequence.Iterator(im):
+            yield frame.getchannel(0)
+
+    @staticmethod
+    def _load_expected_test_video():
+        from PIL import Image, ImageSequence
+        with Image.open("tests/expect/test_summary.test_video.expect.gif") as im:
+            return list(ImageSequence.Iterator(im))
+
+    def assert_grayscale(self, image) -> None:
+        channels = image.split()
+        c0colors = channels[0].getcolors()
+        for c in channels[1:]:
+            self.assertEqual(c0colors, c.getcolors())
+
     def test_video(self):
         try:
             import moviepy
         except ImportError:
-            return
-        compare_proto(summary.video('dummy', tensor_N(shape=(4, 3, 1, 8, 8))), self)
+            self.skipTest('moviepy not installed')
+        t1 = tensor_N(shape=(4, 3, 1, 8, 8))
+        v1 = summary.video("dummy", t1)
+        frames = list(self._iter_gif(v1.value[0].image.encoded_image_string))
+        self.assertEqual(len(frames), 3)
+        prepared = self._load_expected_test_video()
+        for image, expected in zip(frames, prepared):
+            self.assert_grayscale(image)
+            self.assert_grayscale(expected)
+            self.assertEqual(
+                image.getchannel(0).getcolors(), expected.getchannel(0).getcolors()
+            )
         summary.video('dummy', tensor_N(shape=(16, 48, 1, 28, 28)))
         summary.video('dummy', tensor_N(shape=(20, 7, 1, 8, 8)))