8000 Add note about frame rates too ffmpeg writers · matplotlib/matplotlib@09c28d6 · GitHub
[go: up one dir, main page]

Skip to content

Commit 09c28d6

Browse files
committed
Add note about frame rates too ffmpeg writers
1 parent fc5bb10 commit 09c28d6

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

lib/matplotlib/animation.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -552,8 +552,12 @@ class FFMpegWriter(FFMpegBase, MovieWriter):
552552
"""
553553
Pipe-based ffmpeg writer.
554554
555-
Frames are streamed directly to ffmpeg via a pipe and written in a single
556-
pass.
555+
Frames are streamed directly to ffmpeg via a pipe and written in a single pass.
556+
557+
This effectively works as a slideshow input to ffmpeg with the fps passed as
558+
``-framerate``, so see also `their notes on frame rates`_ for further details.
559+
560+
.. _their notes on frame rates: https://trac.ffmpeg.org/wiki/Slideshow#Framerates
557561
"""
558562
def _args(self):
559563
# Returns the command line parameters for subprocess to use
@@ -576,8 +580,12 @@ class FFMpegFileWriter(FFMpegBase, FileMovieWriter):
576580
"""
577581
File-based ffmpeg writer.
578582
579-
Frames are written to temporary files on disk and then stitched
580-
together at the end.
583+
Frames are written to temporary files on disk and then stitched together at the end.
584+
585+
This effectively works as a slideshow input to ffmpeg with the fps passed as
586+
``-framerate``, so see also `their notes on frame rates`_ for further details.
587+
588+
.. _their notes on frame rates: https://trac.ffmpeg.org/wiki/Slideshow#Framerates
581589
"""
582590
supported_formats = ['png', 'jpeg', 'tiff', 'raw', 'rgba']
583591

0 commit comments

Comments
 (0)
0