Add show_ffmpeg_output option to Loom (#24)

Author: ali-ramadhan

matplotloom/loom.py

@@ -43,6 +43,10 @@ class Loom:
             - The user is responsible for parallelizing the frame creation process,
               typically using tools like joblib, multiprocessing, or concurrent.futures.
 
+    show_ffmpeg_output : bool, optional
+        Whether to show ffmpeg output when saving the video. Default is False.
+        When True, the ffmpeg command and its stdout/stderr output will be printed
+        during video creation, regardless of the verbose setting.
     savefig_kwargs : dict, optional
         Additional keyword arguments to pass to matplotlib's savefig function. Default is {}.
 
@@ -60,6 +64,7 @@ def __init__(
         overwrite: bool = False,
         verbose: bool = False,
         parallel: bool = False,
+        show_ffmpeg_output: bool = False,
         savefig_kwargs: Optional[Dict[str, Any]] = None
     ) -> None:
         self.output_filepath: Path = Path(output_filepath)
@@ -68,6 +73,7 @@ def __init__(
         self.overwrite: bool = overwrite
         self.verbose: bool = verbose
         self.parallel: bool = parallel
+        self.show_ffmpeg_output: bool = show_ffmpeg_output
         self.savefig_kwargs: Dict[str, Any] = savefig_kwargs or {}
 
         if self.output_filepath.exists() and not self.overwrite:
@@ -222,7 +228,7 @@ def save_video(self) -> None:
         process = subprocess.Popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
         stdout, stderr = process.communicate()
 
-        if self.verbose:
+        if self.verbose or self.show_ffmpeg_output:
             print(" ".join(command))
             print(stdout.decode())
             print(stderr.decode())

tests/test_loom.py

@@ -16,7 +16,7 @@ def test_init_loom(tmp_path):
 def test_init_loom_with_custom_frames_directory(tmp_path):
     output_filepath = tmp_path / "output.gif"
     custom_frames_dir = tmp_path / "frames"
-    
+
     loom_with_custom_dir = Loom(
         output_filepath=output_filepath,
         frames_directory=custom_frames_dir,
@@ -29,19 +29,19 @@ def test_init_loom_with_custom_frames_directory(tmp_path):
 def test_save_frame(tmp_path):
     output_filepath = tmp_path / "output.mp4"
     loom = Loom(output_filepath=output_filepath, verbose=True)
-    
+
     fig = Figure()
     ax = fig.subplots()
     ax.plot([0, 1], [0, 1])
-    
+
     loom.save_frame(fig)
     assert len(loom.frame_filepaths) == 1
     assert loom.frame_filepaths[0].exists()
 
 def test_video_creation(tmp_path):
     output_filepath = tmp_path / "output.mp4"
     loom = Loom(output_filepath=output_filepath, verbose=True)
-    
+
     fig = Figure()
     ax = fig.subplots()
     ax.plot([0, 1], [0, 1])
@@ -57,7 +57,7 @@ def test_dont_keep_frames(tmp_path):
         keep_frames=False,
         verbose=True
     )
-    
+
     fig = Figure()
     ax = fig.subplots()
     ax.plot([0, 1], [0, 1])
@@ -128,3 +128,38 @@ def test_loom_error_handling(tmp_path):
 
     frames_dir = Path(loom.frames_directory)
     assert not any(frames_dir.glob("frame_*.png"))
+
+def test_show_ffmpeg_output(tmp_path):
+    output_filepath = tmp_path / "output.mp4"
+
+    loom = Loom(
+        output_filepath=output_filepath,
+        show_ffmpeg_output=True,
+        verbose=False
+    )
+
+    assert loom.show_ffmpeg_output is True
+    assert loom.verbose is False
+
+    fig = Figure()
+    ax = fig.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    loom.save_frame(fig)
+    loom.save_video()
+
+    assert loom.output_filepath.exists()
+
+    output_filepath2 = tmp_path / "output2.mp4"
+    loom2 = Loom(output_filepath=output_filepath2)
+
+    assert loom2.show_ffmpeg_output is False
+
+    fig2 = Figure()
+    ax2 = fig2.subplots()
+    ax2.plot([1, 2], [1, 2])
+
+    loom2.save_frame(fig2)
+    loom2.save_video()
+
+    assert loom2.output_filepath.exists()