ENH: add avconv movie writer for animations

jakevdp · jakevdp · commit 0b6e803edb4d · 2012-11-26T15:58:24.000-08:00
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -390,6 +390,57 @@ def _args(self):
                 self._base_temp_name()] + self.output_args
 
 
+# Base class of avconv information. Has the config keys and the common set
+# of arguments that controls the *output* side of things.
+class AVConvBase:
+    exec_key = 'animation.avconv_path'
+    args_key = 'animation.avconv_args'
+
+    @property
+    def output_args(self):
+        # The %dk adds 'k' as a suffix so that avconv treats our bitrate as in
+        # kbps
+        args = ['-vcodec', self.codec]
+        if self.bitrate > 0:
+            args.extend(['-b', '%dk' % self.bitrate])
+        if self.extra_args:
+            args.extend(self.extra_args)
+        for k, v in self.metadata.items():
+            args.extend(['-metadata', '%s=%s' % (k, v)])
+
+        return args + ['-y', self.outfile]
+
+
+# Combine AVConv options with pipe-based writing
+@writers.register('avconv')
+class AVConvWriter(MovieWriter, AVConvBase):
+    def _args(self):
+        # Returns the command line parameters for subprocess to use
+        # avconv to create a movie using a pipe.
+        args = [self.bin_path(), '-f', 'rawvideo', '-vcodec', 'rawvideo',
+                '-s', '%dx%d' % self.frame_size, '-pix_fmt', self.frame_format,
+                '-r', str(self.fps)]
+        # Logging is quieted because subprocess.PIPE has limited buffer size.
+        if not verbose.ge('debug'):
+            args += ['-loglevel', 'quiet']
+        args += ['-i', 'pipe:'] + self.output_args
+        return args
+
+
+#Combine AVConv options with temp file-based writing
+@writers.register('avconv_file')
+class AVConvFileWriter(FileMovieWriter, AVConvBase):
+    supported_formats = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp',
+                         'pbm', 'raw', 'rgba']
+
+    def _args(self):
+        # Returns the command line parameters for subprocess to use
+        # avconv to create a movie using a collection of temp images
+        return [self.bin_path(), '-vframes', str(self._frame_counter),
+                '-r', str(self.fps), '-i',
+                self._base_temp_name()] + self.output_args
+
+
 # Base class of mencoder information. Contains configuration key information
 # as well as arguments for controlling *output*
 class MencoderBase:
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -327,7 +327,9 @@ def validate_hinting(s):
                                            ['xelatex', 'lualatex', 'pdflatex'])
 
 validate_movie_writer = ValidateInStrings('animation.writer',
-    ['ffmpeg', 'ffmpeg_file', 'mencoder', 'mencoder_file',
+    ['ffmpeg', 'ffmpeg_file',
+     'avconv', 'avconv_file',
+     'mencoder', 'mencoder_file',
      'imagemagick', 'imagemagick_file'])
 
 validate_movie_frame_fmt = ValidateInStrings('animation.frame_format',
@@ -627,7 +629,9 @@ def __call__(self, s):
     'animation.frame_format' : ['png', validate_movie_frame_fmt], # Controls image format when frames are written to disk
     'animation.ffmpeg_path' : ['ffmpeg', str], # Path to FFMPEG binary. If just binary name, subprocess uses $PATH.
     '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.avconv_path' : ['avconv', str], # Path to AVConv binary. If just binary name, subprocess uses $PATH.
+    'animation.avconv_args' : ['', validate_stringlist], # Additional arguments for avconv movie writer (using pipes)
+    'animation.mencoder_path' : ['mencoder', str], # Path to MENCODER 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)
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -434,7 +434,11 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
 #animation.frame_format: 'png'     # Controls frame format used by temp files
 #animation.ffmpeg_path: 'ffmpeg'   # Path to ffmpeg binary. Without full path
                                    # $PATH is searched
-#animation.ffmpeg_args: ''         # Additional arugments to pass to mencoder
-#animation.mencoder_path: 'ffmpeg' # Path to mencoder binary. Without full path
+#animation.ffmpeg_args: ''         # Additional arugments to pass to ffmpeg
+#animation.avconv_path: 'avconv'   # Path to ffmpeg binary. Without full path
+                                   # $PATH is searched
+#animation.avconv_args: ''         # Additional arugments to pass to ffmpeg
+#animation.mencoder_path: 'mencoder' 
+			           # Path to mencoder binary. Without full path
                                    # $PATH is searched
 #animation.mencoder_args: ''       # Additional arugments to pass to mencoder
