[cli] Finalize save-edl command

Fix end timecode alignment. Tested with DaVinci Resolve and added unit tests.

Fixes #495

Author: Breakthrough

scenedetect.cfg

@@ -313,7 +313,7 @@
 # Reel/tape name to use.
 #reel = AX
 
-# Title to use for the EDL file. Can use $VIDEO_NAME macro.
+# Title to use for the EDL information. Can use $VIDEO_NAME macro.
 #title = $VIDEO_NAME
 
 

scenedetect/_cli/commands.py

@@ -24,6 +24,7 @@
 from xml.dom import minidom
 from xml.etree import ElementTree
 
+import scenedetect
 from scenedetect._cli.config import XmlFormat
 from scenedetect._cli.context import CliContext
 from scenedetect.frame_timecode import FrameTimecode
@@ -288,19 +289,8 @@ def get_edl_timecode(timecode: FrameTimecode):
 
     # Add each shot as an edit entry
     for i, (start, end) in enumerate(scenes):
-        # TODO: Handle start time shift.
         in_tc = get_edl_timecode(start)
-        out_tc = get_edl_timecode(end)
-
-        # TODO: How should the source/rec timestamps be aligned? One example I found showed:
-        #
-        # 001  AX V     C        00:00:00:00 00:00:10:00 00:00:00:00 00:00:10:00
-        # 002  AX V     C        00:00:10:01 00:00:20:00 00:00:10:00 00:00:20:00
-        # 003  AX V     C        00:00:20:01 00:00:30:00 00:00:20:00 00:00:30:00
-        # 004  AX V     C        00:00:30:01 00:00:40:00 00:00:30:00 00:00:40:00
-        #                                  ^
-        #                                  |- Shifted by 1 frame here
-
+        out_tc = get_edl_timecode(end - 1)  # Correct for presentation time
         # Format the edit entry according to CMX 3600 format
         event_line = f"{(i + 1):03d}  {reel} V     C        {in_tc} {out_tc} {in_tc} {out_tc}"
         edl_content.append(event_line)
@@ -311,6 +301,7 @@ def get_edl_timecode(timecode: FrameTimecode):
     )
     logger.info(f"Writing scenes in EDL format to {edl_path}")
     with open(edl_path, "w") as f:
+        f.write(f"* CREATED WITH PYSCENEDETECT {scenedetect.__version__}\n")
         f.write("\n".join(edl_content))
         f.write("\n")
 
@@ -398,16 +389,15 @@ def _save_xml_fcp(
     output: str,
 ):
     """Saves scenes in Final Cut Pro 7 XML format."""
+    assert scenes
     root = ElementTree.Element("xmeml", version="5")
     project = ElementTree.SubElement(root, "project")
     ElementTree.SubElement(project, "name").text = context.video_stream.name
     sequence = ElementTree.SubElement(project, "sequence")
     ElementTree.SubElement(sequence, "name").text = context.video_stream.name
 
-    # TODO: We should calculate duration from the scene list.
-    duration = context.video_stream.duration
-    duration = str(duration.get_seconds())  # TODO: Is float okay here?
-    ElementTree.SubElement(sequence, "duration").text = duration
+    duration = scenes[-1][1] - scenes[0][0]
+    ElementTree.SubElement(sequence, "duration").text = f"{duration.get_frames()}"
 
     rate = ElementTree.SubElement(sequence, "rate")
     ElementTree.SubElement(rate, "timebase").text = str(context.video_stream.frame_rate)
@@ -444,6 +434,8 @@ def _save_xml_fcp(
         ElementTree.SubElement(file_ref, "name").text = context.video_stream.name
         path = Path(context.video_stream.path).absolute()
         # TODO: Can we just use path.as_uri() here?
+        # On Windows this should be: file://localhost/C:/Users/... according to the samples provided
+        # from https://github.com/Breakthrough/PySceneDetect/issues/156#issuecomment-1076213412.
         ElementTree.SubElement(file_ref, "pathurl").text = f"file://{path}"
 
         media_ref = ElementTree.SubElement(file_ref, "media")
@@ -477,6 +469,9 @@ def save_xml(
     # We only use scene information.
     del cuts
 
+    if not scenes:
+        return
+
     if format == XmlFormat.FCPX:
         _save_xml_fcpx(context, scenes, filename, output)
     elif format == XmlFormat.FCP:

tests/test_cli.py

@@ -10,7 +10,6 @@
 # included LICENSE file, or visit one of the above pages for details.
 #
 
-import glob
 import os
 import subprocess
 import typing as ty
@@ -20,6 +19,7 @@
 import numpy as np
 import pytest
 
+import scenedetect
 from scenedetect.video_splitter import is_ffmpeg_available, is_mkvmerge_available
 
 # These tests validate that the CLI itself functions correctly, mainly based on the return
@@ -739,3 +739,45 @@ def test_cli_load_scenes_round_trip():
     assert ground_truth.split(SPLIT_POINT)[1] == loaded_first_pass.split(SPLIT_POINT)[1]
     with open("testout.csv") as first, open("testout2.csv") as second:
         assert first.readlines() == second.readlines()
+
+
+def test_cli_save_edl(tmp_path: Path):
+    """Test `save-edl` command."""
+    assert (
+        invoke_scenedetect(
+            "-i {VIDEO} time {TIME} {DETECTOR} save-edl",
+            output_dir=tmp_path,
+        )
+        == 0
+    )
+    output_path = tmp_path.joinpath(f"{DEFAULT_VIDEO_NAME}.edl")
+    assert os.path.exists(output_path)
+    EXPECTED_EDL_OUTPUT = f"""* CREATED WITH PYSCENEDETECT {scenedetect.__version__}
+TITLE: {DEFAULT_VIDEO_NAME}
+FCM: NON-DROP FRAME
+
+001  AX V     C        00:00:02:00 00:00:03:17 00:00:02:00 00:00:03:17
+002  AX V     C        00:00:03:18 00:00:05:23 00:00:03:18 00:00:05:23
+"""
+    assert output_path.read_text() == EXPECTED_EDL_OUTPUT
+
+
+def test_cli_save_edl_with_params(tmp_path: Path):
+    """Test `save-edl` command but override the other options."""
+    assert (
+        invoke_scenedetect(
+            "-i {VIDEO} time {TIME} {DETECTOR} save-edl -t title -r BX -f file_no_ext",
+            output_dir=tmp_path,
+        )
+        == 0
+    )
+    output_path = tmp_path.joinpath("file_no_ext")
+    assert os.path.exists(output_path)
+    EXPECTED_EDL_OUTPUT = f"""* CREATED WITH PYSCENEDETECT {scenedetect.__version__}
+TITLE: title
+FCM: NON-DROP FRAME
+
+001  BX V     C        00:00:02:00 00:00:03:17 00:00:02:00 00:00:03:17
+002  BX V     C        00:00:03:18 00:00:05:23 00:00:03:18 00:00:05:23
+"""
+    assert output_path.read_text() == EXPECTED_EDL_OUTPUT

website/pages/changelog.md

@@ -627,10 +627,10 @@ Development
 ### Work In Progress
 
 - [feature] New `save-xml` command supports saving scenes in Final Cut Pro format [#156](https://github.com/Breakthrough/PySceneDetect/issues/156)
-- [feature] New `save-edl` command supports saving scenes in EDL format CMX 3600 [#495](https://github.com/Breakthrough/PySceneDetect/issues/495)
 
 ### Complete
 
+ - [feature] New `save-edl` command supports saving scenes in EDL format CMX 3600 [#495](https://github.com/Breakthrough/PySceneDetect/issues/495)
  - [general] The `export-html` command is now deprecated, use `save-html` instead
  - [bugfix] Fix incorrect help entries for short-form arguments which suggested invalid syntax [#493](https://github.com/Breakthrough/PySceneDetect/issues/493)
  - [bugfix] Fix crash when using `split-video` with `-m`/`--mkvmerge` option [#473](https://github.com/Breakthrough/PySceneDetect/issues/473)