Remove mencoder support.

anntzer · anntzer · commit 68c31d76e52d · 2017-12-25T18:43:31.000-08:00
Also removed movie_demo_sgskip, which was broken anyways (it did not
import os); moviewrite_sgskip, which uses the animation API is a better
example anyways (I don't think there's much of a point to show the flags
for a specific encoder in an example -- if anything, that should go to
the class docstring).
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -101,7 +101,7 @@ test_script:
 
   # this are optional dependencies so that we don't skip so many tests...
   - if x%TEST_ALL% == xyes conda install -q ffmpeg inkscape miktex pillow
-  # missing packages on conda-forge for avconv mencoder imagemagick
+  # missing packages on conda-forge for avconv imagemagick
   # This install sometimes failed randomly :-(
   #- choco install imagemagick
 
diff --git a/.travis.yml b/.travis.yml
@@ -30,7 +30,6 @@ addons:
       - libgeos-dev
       - libgirepository-1.0.1
       - lmodern
-      - mencoder
       - otf-freefont
       - pgf
       - texlive-fonts-recommended
diff --git a/INSTALL.rst b/INSTALL.rst
@@ -84,8 +84,7 @@ To run the test suite:
    :file:`lib\\mpl_toolkits\\tests` directories from the source distribution;
  * install test dependencies: `pytest <https://pypi.python.org/pypi/pytest>`_,
    `mock <https://pypi.python.org/pypi/mock>`_, Pillow, MiKTeX, GhostScript,
-   ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape
-   <https://inkscape.org/>`_;
+   ffmpeg, avconv, ImageMagick, and `Inkscape <https://inkscape.org/>`_;
  * run ``py.test path\to\tests\directory``.
 
 
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -302,17 +302,3 @@ Inheritance Diagrams
 
 .. inheritance-diagram:: matplotlib.animation.AVConvFileWriter matplotlib.animation.AVConvWriter matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
    :private-bases:
-
-
-
-Deprecated
-==========
-
-
-.. autosummary::
-   :toctree: _as_gen
-   :nosignatures:
-
-   MencoderBase
-   MencoderFileWriter
-   MencoderWriter
diff --git a/doc/api/api_changes/2017-09-22-AL-removal-of-deprecated-features.rst b/doc/api/api_changes/2017-09-22-AL-removal-of-deprecated-features.rst
@@ -15,3 +15,5 @@ The ``bgcolor`` keyword argument to ``Axes`` has been removed.
 
 The ``spectral`` colormap has been removed.  The ``Vega*`` colormaps, which
 were aliases for the ``tab*`` colormaps, have been removed.
+
+``mencoder`` can no longer be used to encode animations.
diff --git a/examples/animation/movie_demo_sgskip.py b/examples/animation/movie_demo_sgskip.py
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -702,88 +702,9 @@ class AVConvFileWriter(AVConvBase, FFMpegFileWriter):
 
     Frames are written to temporary files on disk and then stitched
     together at the end.
-
     '''
 
 
-# Base class of mencoder information. Contains configuration key information
-# as well as arguments for controlling *output*
-class MencoderBase(object):
-    exec_key = 'animation.mencoder_path'
-    args_key = 'animation.mencoder_args'
-
-    # Mencoder only allows certain keys, other ones cause the program
-    # to fail.
-    allowed_metadata = ['name', 'artist', 'genre', 'subject', 'copyright',
-                        'srcform', 'comment']
-
-    # Mencoder mandates using name, but 'title' works better with ffmpeg.
-    # If we find it, just put it's value into name
-    def _remap_metadata(self):
-        if 'title' in self.metadata:
-            self.metadata['name'] = self.metadata['title']
-
-    @property
-    def output_args(self):
-        self._remap_metadata()
-        lavcopts = {'vcodec': self.codec}
-        if self.bitrate > 0:
-            lavcopts.update(vbitrate=self.bitrate)
-        args = ['-o', self.outfile, '-ovc', 'lavc', '-lavcopts',
-                ':'.join(itertools.starmap('{0}={1}'.format,
-                                           lavcopts.items()))]
-        if self.extra_args:
-            args.extend(self.extra_args)
-        if self.metadata:
-            args.extend(['-info', ':'.join('%s=%s' % (k, v)
-                         for k, v in six.iteritems(self.metadata)
-                         if k in self.allowed_metadata)])
-        return args
-
-
-# The message must be a single line; internal newlines cause sphinx failure.
-mencoder_dep = ("Support for mencoder is only partially functional, "
-                "and will be removed entirely in 2.2. "
-                "Please use ffmpeg instead.")
-
-
-@writers.register('mencoder')
-class MencoderWriter(MovieWriter, MencoderBase):
-
-    @deprecated('2.0', message=mencoder_dep)
-    def __init__(self, *args, **kwargs):
-        with rc_context(rc={'animation.codec': 'mpeg4'}):
-            super(MencoderWriter, self).__init__(*args, **kwargs)
-
-    def _args(self):
-        # Returns the command line parameters for subprocess to use
-        # mencoder to create a movie
-        return [self.bin_path(), '-', '-demuxer', 'rawvideo', '-rawvideo',
-                ('w=%i:h=%i:' % self.frame_size +
-                'fps=%i:format=%s' % (self.fps,
-                                      self.frame_format))] + self.output_args
-
-
-# Combine Mencoder options with temp file-based writing
-@writers.register('mencoder_file')
-class MencoderFileWriter(FileMovieWriter, MencoderBase):
-    supported_formats = ['png', 'jpeg', 'tga', 'sgi']
-
-    @deprecated('2.0', message=mencoder_dep)
-    def __init__(self, *args, **kwargs):
-        with rc_context(rc={'animation.codec': 'mpeg4'}):
-            super(MencoderFileWriter, self).__init__(*args, **kwargs)
-
-    def _args(self):
-        # Returns the command line parameters for subprocess to use
-        # mencoder to create a movie
-        return [self.bin_path(),
-                'mf://%s*.%s' % (self.temp_prefix, self.frame_format),
-                '-frames', str(self._frame_counter), '-mf',
-                'type=%s:fps=%d' % (self.frame_format,
-                                    self.fps)] + self.output_args
-
-
 # Base class for animated GIFs with convert utility
 class ImageMagickBase(object):
     '''Mixin class for ImageMagick output.
@@ -1102,8 +1023,8 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
 
         writer : :class:`MovieWriter` or str, optional
             A `MovieWriter` instance to use or a key that identifies a
-            class to use, such as 'ffmpeg' or 'mencoder'. If ``None``,
-            defaults to ``rcParams['animation.writer']``.
+            class to use, such as 'ffmpeg'. If ``None``, defaults to
+            ``rcParams['animation.writer']``.
 
         fps : number, optional
            Frames per second in the movie. Defaults to ``None``, which will use
diff --git a/lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle b/lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle
@@ -504,10 +504,6 @@ animation.ffmpeg_args:            # Additional arguments to pass to ffmpeg
 animation.avconv_path: avconv     # Path to avconv binary. Without full path
                                   # $PATH is searched
 animation.avconv_args:            # Additional arguments to pass to avconv
-animation.mencoder_path: mencoder
-                                  # Path to mencoder binary. Without full path
-                                  # $PATH is searched
-animation.mencoder_args:          # Additional arguments to pass to mencoder
 animation.convert_path: convert   # Path to ImageMagick's convert binary.
                                   # On Windows use the full path since convert
                                   # is also the name of a system tool.
diff --git a/lib/matplotlib/mpl-data/stylelib/classic.mplstyle b/lib/matplotlib/mpl-data/stylelib/classic.mplstyle
@@ -506,10 +506,6 @@ animation.ffmpeg_args:            # Additional arguments to pass to ffmpeg
 animation.avconv_path: avconv     # Path to avconv binary. Without full path
                                   # $PATH is searched
 animation.avconv_args:            # Additional arguments to pass to avconv
-animation.mencoder_path: mencoder
-                                  # Path to mencoder binary. Without full path
-                                  # $PATH is searched
-animation.mencoder_args:          # Additional arguments to pass to mencoder
 animation.convert_path: convert   # Path to ImageMagick's convert binary.
                                   # On Windows use the full path since convert
                                   # is also the name of a system tool.
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -580,7 +580,6 @@ def validate_hinting(s):
 validate_movie_writer = ValidateInStrings('animation.writer',
     ['ffmpeg', 'ffmpeg_file',
      'avconv', 'avconv_file',
-     'mencoder', 'mencoder_file',
      'imagemagick', 'imagemagick_file',
      'html'])
 
@@ -1371,23 +1370,17 @@ def _validate_linestyle(ls):
     'animation.frame_format': ['png', validate_movie_frame_fmt],
     # Additional arguments for HTML writer
     'animation.html_args':    [[], validate_stringlist],
-    # Path to FFMPEG binary. If just binary name, subprocess uses $PATH.
+    # Path to ffmpeg binary. If just binary name, subprocess uses $PATH.
     'animation.ffmpeg_path':  ['ffmpeg', validate_animation_writer_path],
-
     # Additional arguments for ffmpeg movie writer (using pipes)
     'animation.ffmpeg_args':   [[], validate_stringlist],
     # Path to AVConv binary. If just binary name, subprocess uses $PATH.
     'animation.avconv_path':   ['avconv', validate_animation_writer_path],
     # Additional arguments for avconv movie writer (using pipes)
     'animation.avconv_args':   [[], validate_stringlist],
-    # Path to MENCODER binary. If just binary name, subprocess uses $PATH.
-    'animation.mencoder_path': ['mencoder', validate_animation_writer_path],
-    # Additional arguments for mencoder movie writer (using pipes)
-    'animation.mencoder_args': [[], validate_stringlist],
-     # Path to convert binary. If just binary name, subprocess uses $PATH
+     # Path to convert binary. If just binary name, subprocess uses $PATH.
     'animation.convert_path':  ['convert', validate_animation_writer_path],
-     # Additional arguments for mencoder movie writer (using pipes)
-
+     # Additional arguments for convert movie writer (using pipes)
     'animation.convert_args':  [[], validate_stringlist],
 
     # Classic (pre 2.0) compatibility mode
diff --git a/lib/matplotlib/tests/test_animation.py b/lib/matplotlib/tests/test_animation.py
@@ -113,8 +113,6 @@ def isAvailable(self):
 WRITER_OUTPUT = [
     ('ffmpeg', 'mp4'),
     ('ffmpeg_file', 'mp4'),
-    ('mencoder', 'mp4'),
-    ('mencoder_file', 'mp4'),
     ('avconv', 'mp4'),
     ('avconv_file', 'mp4'),
     ('imagemagick', 'gif'),
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -590,10 +590,7 @@ backend      : $TEMPLATE_BACKEND
 #animation.avconv_path: 'avconv'   # Path to avconv binary. Without full path
                                    # $PATH is searched
 #animation.avconv_args: ''         # Additional arguments to pass to avconv
-#animation.mencoder_path: 'mencoder'
-                                   # Path to mencoder binary. Without full path
-                                   # $PATH is searched
-#animation.mencoder_args: ''       # Additional arguments to pass to mencoder
 #animation.convert_path: 'convert' # Path to ImageMagick's convert binary.
                                    # On Windows use the full path since convert
                                    # is also the name of a system tool.
+#animation.convert_args: ''        # Additional arguments to pass to convert
