[video_splitter] Fix inconsistent naming in output paths

Author: Breakthrough

scenedetect/_cli/commands.py

@@ -215,6 +215,9 @@ def split_video(
     """Handles the `split-video` command."""
     del cuts  # split-video only uses scenes.
 
+    if use_mkvmerge:
+        name_format = name_format.removesuffix("-$SCENE_NUMBER")
+
     # Add proper extension to filename template if required.
     dot_pos = name_format.rfind(".")
     extension_length = 0 if dot_pos < 0 else len(name_format) - (dot_pos + 1)

scenedetect/video_splitter.py

@@ -156,8 +156,8 @@ def default_formatter(template: str) -> PathFormatter:
 def split_video_mkvmerge(
     input_video_path: str,
     scene_list: ty.Iterable[TimecodePair],
-    output_dir: ty.Optional[Path] = None,
-    output_file_template: str = "$VIDEO_NAME.mkv",
+    output_dir: ty.Optional[ty.Union[str, Path]] = None,
+    output_file_template: ty.Optional[ty.Union[str, Path]] = "$VIDEO_NAME.mkv",
     video_name: ty.Optional[str] = None,
     show_output: bool = False,
     suppress_output=None,
@@ -202,8 +202,13 @@ def split_video_mkvmerge(
     output_path = template.safe_substitute(VIDEO_NAME=video_name)
     if output_dir:
         output_path = Path(output_dir) / output_path
-    Path(output_path).parent.mkdir(parents=True, exist_ok=True)
+    output_path = Path(output_path)
     logger.info(f"Splitting video with mkvmerge, path template: {output_path}")
+    # If there is only one scene, mkvmerge omits the suffix for the output. To make the filenames
+    # consistent with the output when there are multiple scenes present, we append "-001".
+    if len(scene_list) == 1:
+        output_path = output_path.with_stem(output_path.stem + "-001")
+    output_path.parent.mkdir(parents=True, exist_ok=True)
 
     call_list = ["mkvmerge"]
     if not show_output:

tests/test_cli.py

@@ -445,25 +445,44 @@ def test_cli_split_video_mkvmerge(tmp_path: Path):
         )
         == 0
     )
+    for scene in range(DEFAULT_NUM_SCENES):
+        path = tmp_path / (Path(DEFAULT_VIDEO_PATH).stem + f"-Scene-{1 + scene:03d}.mkv")
+        path.unlink(missing_ok=False)
+    # If only one scene (just using a few frames), should keep same output template.
+    assert (
+        invoke_scenedetect(
+            "-i {VIDEO} -s {STATS} time -e 3 {DETECTOR} split-video -m", output_dir=tmp_path
+        )
+        == 0
+    )
+    path = tmp_path / (Path(DEFAULT_VIDEO_PATH).stem + "-Scene-001.mkv")
+    path.unlink(missing_ok=False)
+    # -m takes precedence over -c
     assert (
         invoke_scenedetect(
             "-i {VIDEO} -s {STATS} time {TIME} {DETECTOR} split-video -m -c", output_dir=tmp_path
         )
         == 0
     )
+    # Custom filename format
+    for scene in range(DEFAULT_NUM_SCENES):
+        path = tmp_path / (Path(DEFAULT_VIDEO_PATH).stem + f"-Scene-{1 + scene:03d}.mkv")
+        path.unlink(missing_ok=False)
     assert (
         invoke_scenedetect(
-            '-i {VIDEO} -s {STATS} time {TIME} {DETECTOR} split-video -m -f "test$VIDEO_NAME"',
+            "-i {VIDEO} -s {STATS} time {TIME} {DETECTOR} split-video -m -f test$VIDEO_NAME",
             output_dir=tmp_path,
         )
         == 0
     )
+    for scene in range(DEFAULT_NUM_SCENES):
+        path = tmp_path / ("test" + Path(DEFAULT_VIDEO_PATH).stem + f"-{1 + scene:03d}.mkv")
+        path.unlink(missing_ok=False)
     # -a/--args and -m/--mkvmerge are mutually exclusive
     assert invoke_scenedetect(
         '-i {VIDEO} -s {STATS} time {TIME} {DETECTOR} split-video -m -a "-c:v libx264"',
         output_dir=tmp_path,
     )
-    # TODO: Check for existence of split video files.
 
 
 def test_cli_save_images(tmp_path: Path):

website/pages/changelog.md

@@ -624,4 +624,6 @@ Development
 
 ## PySceneDetect 0.6.6 (In Development)
 
- - [bugfix] Fix crash when using `-m`/`--mkvmerge` flag with `split-video` command [#473](https://github.com/Breakthrough/PySceneDetect/issues/473)
+ - [bugfix] Fix crash when using `split-video` with `-m`/`--mkvmerge` option [#473](https://github.com/Breakthrough/PySceneDetect/issues/473)
+ - [bugfix] Fix incorrect default filename template for `split-video` command with `-m`/`--mkvmerge` option
+ - [bugfix] Fix inconsistent filenames when using `split_video_mkvmerge()` function in `scenedetect.video_splitter` module