FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Cleanup Animation frame_formats. by anntzer · Pull Request #19044 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Cleanup Animation frame_formats. - #19044

Merged
timhoffm merged 1 commit into
matplotlib:masterfrom
anntzer:animframefmts
Dec 12, 2020
ConversationCommits (1)ChecksFiles changed
Merged

Cleanup Animation frame_formats.#19044
timhoffm merged 1 commit into
matplotlib:masterfrom
anntzer:animframefmts

Conversation

anntzer commented Nov 29, 2020

Copy link
Copy Markdown
Contributor
  • 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:

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.)

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

dopplershift reviewed Nov 30, 2020
View reviewed changes
Comment thread lib/matplotlib/animation.py Outdated

QuLogic commented Dec 1, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

FFMpegFileWriter does not support 'raw' or 'rgba' (AFAICT there's no
way to forward the relevant frame size/bitdepth info).

I'm not sure about the class in Matplotlib, but at least ffmpeg can accept rgba frames (specifying size, etc. via command-line info) https://ffmpeg.org/ffmpeg-formats.html#rawvideo

anntzer commented Dec 1, 2020

Copy link
Copy Markdown
Contributor Author

I specifically meant the Matplotlib class, when used for reconstituting a movie from on-disk image (rgba) files. If you (or someone else) knows the right invocation to make the example given above work, then that's even better :)

QuLogic commented Dec 1, 2020

Copy link
Copy Markdown
Member

Yes, I linked to the wrong format, but it should be possible. I just need to test out the other frame formats to be sure I didn't break it.

QuLogic mentioned this pull request Dec 2, 2020
Merged
2 of 3 tasks
QuLogic requested changes Dec 2, 2020
View reviewed changes

QuLogic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Can you revert the raw/rgba removal bits, and then I can add tests into #19056.

Comment thread lib/matplotlib/animation.py Outdated
Comment thread lib/matplotlib/animation.py Outdated
Comment thread lib/matplotlib/animation.py Outdated

anntzer commented Dec 2, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Actually, looks like the check for FileMovieWriter when setting the frame format to rgba is still needed for HTMLWriter, which does not support that format...

QuLogic commented Dec 3, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

Isn't that overwritten in FileMovieWriter.__init__ anyway? Ah, I see you want to avoid that new warning. How about re-ordering supported_formats to put rgba first, and then use frame_format = supported_formats[0] in the init?

anntzer commented Dec 3, 2020

Copy link
Copy Markdown
Contributor Author

Ah yes, that's a good idea.

QuLogic commented Dec 4, 2020

Copy link
Copy Markdown
Member

Unfortunately, seems to have broken docs.

Cleanup Animation frame_formats.
6062833 
- Warn if the requested frame format is unsupported and fallback occurs.
- 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); it does not
  support 'raw' (per https://imagemagick.org/script/formats.php) but we
  can just override it as 'rgba'.

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.)

anntzer commented Dec 4, 2020

Copy link
Copy Markdown
Contributor Author

hopefully fixed now...

QuLogic requested a review from dopplershift December 8, 2020 05:36
timhoffm added this to the v3.4.0 milestone Dec 12, 2020
timhoffm merged commit 7a5458b into matplotlib:master Dec 12, 2020
anntzer deleted the animframefmts branch December 12, 2020 12:12
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

QuLogic QuLogic approved these changes
timhoffm timhoffm approved these changes
dopplershift Awaiting requested review from dopplershift

Assignees

No one assigned

Labels

Maintenance topic: animation

Projects

None yet

Milestone

v3.4.0

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL