ENH: add support for saving animations as ImageMagick GIF files

jakevdp · jakevdp · commit 301c1e731d24 · 2012-10-05T16:53:59.000-07:00
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -450,6 +450,26 @@ def _args(self):
                                 self.fps)] + self.output_args
 
 
+# Base class for animated GIFs with convert utility
+class ImageMagickBase:
+    exec_key = 'animation.convert_path'
+    args_key = 'animation.convert_args'
+
+    @property
+    def output_args(self):
+        return [self.outfile]
+
+
+@writers.register('imagemagick_file')
+class ImageMagickFileWriter(FileMovieWriter, ImageMagickBase):
+    supported_formats = ['png']
+
+    def _args(self):
+        delay = 100. / self.fps
+        return [self.bin_path(), '-delay', str(delay), '-loop', '0',
+                '%s*.%s' % (self.temp_prefix, self.frame_format)] + self.output_args
+
+
 class Animation(object):
     '''
     This class wraps the creation of an animation using matplotlib. It is
@@ -512,7 +532,7 @@ def _stop(self, *args):
         self.event_source = None
 
     def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
-            bitrate=None, extra_args=None, metadata=None, extra_anim=None):
+             bitrate=None, extra_args=None, metadata=None, extra_anim=None):
         '''
         Saves a movie file by drawing every frame.
 
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -323,7 +323,7 @@ def validate_hinting(s):
                                            ['xelatex', 'lualatex', 'pdflatex'])
 
 validate_movie_writer = ValidateInStrings('animation.writer',
-    ['ffmpeg', 'ffmpeg_file', 'mencoder', 'mencoder_file'])
+    ['ffmpeg', 'ffmpeg_file', 'mencoder', 'mencoder_file', 'imagemagick_file'])
 
 validate_movie_frame_fmt = ValidateInStrings('animation.frame_format',
     ['png', 'jpeg', 'tiff', 'raw', 'rgba'])
@@ -621,6 +621,8 @@ def __call__(self, s):
     'animation.ffmpeg_args' : ['', validate_stringlist], # Additional arguments for ffmpeg movie writer (using pipes)
     'animation.mencoder_path' : ['mencoder', str], # Path to FFMPEG binary. If just binary name, subprocess uses $PATH.
     'animation.mencoder_args' : ['', validate_stringlist], # Additional arguments for mencoder movie writer (using pipes)
+    'animation.convert_path' : ['convert', str], # Path to convert binary. If just binary name, subprocess uses $PATH
+    'animation.convert_args' : ['', validate_stringlist], # Additional arguments for mencoder movie writer (using pipes)
 }
 
 if __name__ == '__main__':
