A community-maintained Python framework for creating mathematical animations.
Significantly reduce rendering time with a separate thread for writing frames to stream (#3888)
Saveliy Yusufov11ea41633c7a
diff --git a/manim/scene/scene_file_writer.py b/manim/scene/scene_file_writer.pyindex eed0db1e5..49d8492a9 100644--- a/manim/scene/scene_file_writer.py+++ b/manim/scene/scene_file_writer.py@@ -7,6 +7,8 @@ __all__ = ["SceneFileWriter"]import jsonimport shutilfrom pathlib import Path+from queue import Queue+from threading import Threadfrom typing import TYPE_CHECKING, Anyimport av@@ -16,6 +18,7 @@ from PIL import Imagefrom pydub import AudioSegmentfrom manim import __version__+from manim.typing import PixelArrayfrom .. import config, loggerfrom .._config.logger_utils import set_file_logger@@ -359,6 +362,33 @@ class SceneFileWriter:if write_to_movie() and allow_write:self.close_partial_movie_stream()+ def listen_and_write(self):+ """+ For internal use only: blocks until new frame is available on the queue.+ """+ while True:+ num_frames, frame_data = self.queue.get()+ if frame_data is None:+ break++ self.encode_and_write_frame(frame_data, num_frames)++ def encode_and_write_frame(self, frame: PixelArray, num_frames: int) -> None:+ """+ For internal use only: takes a given frame in ``np.ndarray`` format and+ write it to the stream+ """+ for _ in range(num_frames):+ # Notes: precomputing reusing packets does not work!+ # I.e., you cannot do `packets = encode(...)`+ # and reuse it, as it seems that `mux(...)`+ # consumes the packet.+ # The same issue applies for `av_frame`,+ # reusing it renders weird-looking frames.+ av_frame = av.VideoFrame.from_ndarray(frame, format="rgba")+ for packet in self.video_stream.encode(av_frame):+ self.video_container.mux(packet)+def write_frame(self, frame_or_renderer: np.ndarray | OpenGLRenderer, num_frames: int = 1):@@ -379,16 +409,9 @@ class SceneFileWriter:if config.renderer == RendererType.OPENGLelse frame_or_renderer)- for _ in range(num_frames):- # Notes: precomputing reusing packets does not work!- # I.e., you cannot do `packets = encode(...)`- # and reuse it, as it seems that `mux(...)`- # consumes the packet.- # The same issue applies for `av_frame`,- # reusing it renders weird-looking frames.- av_frame = av.VideoFrame.from_ndarray(frame, format="rgba")- for packet in self.video_stream.encode(av_frame):- self.video_container.mux(packet)++ msg = (num_frames, frame)+ self.queue.put(msg)if is_png_format() and not config["dry_run"]:image: Image = (@@ -430,7 +453,7 @@ class SceneFileWriter:image.save(self.image_file_path)self.print_file_ready_message(self.image_file_path)- def finish(self):+ def finish(self) -> None:"""Finishes writing to the FFMPEG buffer or writing imagesto output directory.@@ -440,8 +463,6 @@ class SceneFileWriter:frame in the default image directory."""if write_to_movie():- if hasattr(self, "writing_process"):- self.writing_process.terminate()self.combine_to_movie()if config.save_sections:self.combine_to_section_videos()@@ -455,7 +476,7 @@ class SceneFileWriter:if self.subcaptions:self.write_subcaption_file()- def open_partial_movie_stream(self, file_path=None):+ def open_partial_movie_stream(self, file_path=None) -> None:"""Open a container holding a video stream.This is used internally by Manim initialize the container holding@@ -499,13 +520,20 @@ class SceneFileWriter:self.video_container = video_containerself.video_stream = stream- def close_partial_movie_stream(self):+ self.queue: Queue[tuple[int, PixelArray | None]] = Queue()+ self.writer_thread = Thread(target=self.listen_and_write, args=())+ self.writer_thread.start()++ def close_partial_movie_stream(self) -> None:"""Close the currently opened video container.Used internally by Manim to first flush the remaining packagesin the video stream holding a partial file, and then closethe corresponding container."""+ self.queue.put((-1, None))+ self.writer_thread.join()+for packet in self.video_stream.encode():self.video_container.mux(packet)