Cleanup Animation frame_formats.

anntzer · anntzer · commit fc44d8a22f4a · 2020-11-29T15:32:36.000+01:00
- Warn if the requested frame format is unsupported and fallback occurs. - FFMpegFileWriter does not support 'raw' or 'rgba' (AFAICT there's no way to forward the relevant frame size/bitdepth info). - ImageMagickFileWriter supports 'rgba' but requires explicit frame_size and depth to do so (they are the same as for ImageMagickWriter, and passing them doesn't negatively impact other formats), but it does not support 'raw' (per https://imagemagick.org/script/formats.php). Test script: ```python import numpy as np import matplotlib.pyplot as plt import matplotlib.animation as animation fig, ax = plt.subplots() x = np.arange(0, 2*np.pi, 0.01) line, = ax.plot(x, np.sin(x)) def animate(i): line.set_ydata(np.sin(x + i / 50)) # update the data. return line, ani = animation.FuncAnimation( fig, animate, interval=50, blit=True, save_count=20) plt.rcParams["animation.frame_format"] = "rgba" # or "raw" writer = animation.FFMpegFileWriter() # or animation.ImageMagickFileWriter() ani.save("/tmp/movie.mp4", writer=writer) ``` (Also move import of PIL up, as it's a standard dependency now.)
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -31,6 +31,7 @@
 import warnings
 
 import numpy as np
+from PIL import Image
 
 import matplotlib as mpl
 from matplotlib._animation_data import (
@@ -296,8 +297,11 @@ def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
 
         super().__init__(fps=fps, metadata=metadata, codec=codec,
                          bitrate=bitrate)
-
-        self.frame_format = 'rgba'
+        # The rcParam only applies to FileMovieWriters, but should be read here
+        # because setting to frame_format to 'rgba' would otherwise spuriously
+        # warn that that format is unsupported e.g. for FFMpegFileWriter.
+        self.frame_format = (mpl.rcParams['animation.frame_format']
+                             if isinstance(self, FileMovieWriter) else 'rgba')
         self.extra_args = extra_args
 
     def _adjust_frame_size(self):
@@ -395,9 +399,6 @@ class FileMovieWriter(MovieWriter):
 
     This must be sub-classed to be useful.
     """
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.frame_format = mpl.rcParams['animation.frame_format']
 
     @cbook._delete_parameter("3.3", "clear_temp")
     def setup(self, fig, outfile, dpi=None, frame_prefix=None,
@@ -467,6 +468,10 @@ def frame_format(self, frame_format):
         if frame_format in self.supported_formats:
             self._frame_format = frame_format
         else:
+            cbook._warn_external(
+                f"Ignoring file format {frame_format!r} which is not "
+                f"supported by {type(self).__name__}; using "
+                f"{self.supported_formats[0]} instead.")
             self._frame_format = self.supported_formats[0]
 
     def _base_temp_name(self):
@@ -529,7 +534,6 @@ def setup(self, fig, outfile, dpi=None):
         self._frames = []
 
     def grab_frame(self, **savefig_kwargs):
-        from PIL import Image
         buf = BytesIO()
         self.fig.savefig(
             buf, **{**savefig_kwargs, "format": "rgba", "dpi": self.dpi})
@@ -629,8 +633,7 @@ class FFMpegFileWriter(FFMpegBase, FileMovieWriter):
     Frames are written to temporary files on disk and then stitched
     together at the end.
     """
-    supported_formats = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp',
-                         'pbm', 'raw', 'rgba']
+    supported_formats = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp', 'pbm']
 
     def _args(self):
         # Returns the command line parameters for subprocess to use
@@ -744,14 +747,15 @@ class ImageMagickFileWriter(ImageMagickBase, FileMovieWriter):
 
     Frames are written to temporary files on disk and then stitched
     together at the end.
-
     """
 
-    supported_formats = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp',
-                         'pbm', 'raw', 'rgba']
+    supported_formats = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp', 'pbm',
+                         'rgba']
 
     def _args(self):
-        return ([self.bin_path(), '-delay', str(self.delay), '-loop', '0',
+        return ([self.bin_path(),
+                 '-size', '%ix%i' % self.frame_size, '-depth', '8',
+                 '-delay', str(self.delay), '-loop', '0',
                  '%s*.%s' % (self.temp_prefix, self.frame_format)]
                 + self.output_args)
 
