Skip to content

Commit

Permalink
Deprecate avconv animation writers.
Browse files Browse the repository at this point in the history
See changelog.  (avconv was a fork of ffmpeg which has kept the same
CLI, so the ffmpeg writers are good enough anyways.)
  • Loading branch information
anntzer committed Feb 4, 2020
1 parent 7b6eb77 commit bb7609c
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 6 deletions.
11 changes: 11 additions & 0 deletions doc/api/next_api_changes/deprecations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,3 +173,14 @@ variables is deprecated. Additional fonts may be registered using
``matplotlib.compat``
~~~~~~~~~~~~~~~~~~~~~
This module is deprecated.

AVConv animation writer deprecated
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``AVConvBase``, ``AVConvWriter`` and ``AVConvFileWriter`` classes, and the
associated ``animation.avconv_path`` and ``animation.avconv_args`` rcParams are
deprecated.

Debian 8 (2015, EOL 06/2020) and Ubuntu 14.04 (EOL 04/2019) were the
last versions of Debian and Ubuntu to ship avconv. It remains possible
to force the use of avconv by using the ffmpeg-based writers with
:rc:`animation.ffmpeg_path` set to "avconv".
2 changes: 2 additions & 0 deletions lib/matplotlib/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -609,6 +609,8 @@ def gen_candidates():
# listed in the rcParams (not included in _all_deprecated).
# Values are tuples of (version,)
_deprecated_remain_as_none = {
'animation.avconv_path': ('3.3',),
'animation.avconv_args': ('3.3',),
}


Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/animation.py
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,7 @@ def _args(self):


# Base class of avconv information. AVConv has identical arguments to FFMpeg.
@cbook.deprecated('3.3')
class AVConvBase(FFMpegBase):
"""
Mixin class for avconv output.
Expand Down
3 changes: 0 additions & 3 deletions lib/matplotlib/mpl-data/stylelib/classic.mplstyle
Original file line number Diff line number Diff line change
Expand Up @@ -478,9 +478,6 @@ 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 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.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.
Expand Down
3 changes: 0 additions & 3 deletions matplotlibrc.template
Original file line number Diff line number Diff line change
Expand Up @@ -744,9 +744,6 @@
#animation.ffmpeg_path : ffmpeg ## Path to ffmpeg binary. Without full path
## $PATH is searched
#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.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.
Expand Down

0 comments on commit bb7609c

Please sign in to comment.