[save-otio] Finalize OTIO support

Breakthrough · Breakthrough · commit 2b7ebbd69ef3 · 2025-03-09T18:07:44.000-04:00
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -754,6 +754,14 @@ Options
 
   Output directory to save OTIO file to. Overrides global option :option:`-o/--output <scenedetect -o>`.
 
+.. option:: --audio
+
+  Include audio track (default).
+
+.. option:: --no-audio
+
+  Exclude audio track.
+
 
 .. _command-save-qp:
 
@@ -795,7 +803,7 @@ Options
 ``save-xml``
 ========================================================================
 
-Save cuts in XML format.
+[IN DEVELOPMENT] Save cuts in XML format.
 
 
 Options
diff --git a/scenedetect.cfg b/scenedetect.cfg
@@ -328,6 +328,9 @@
 # Name to use for the OTIO timeline. Can use $VIDEO_NAME macro.
 #title = $VIDEO_NAME (PySceneDetect)
 
+# Include audio track (yes/no).
+#audio = yes
+
 
 [save-qp]
 
@@ -341,20 +344,6 @@
 #disable-shift = no
 
 
-[save-xml]
-
-# Filename format of XML file. Can use $VIDEO_NAME macro.
-#filename = $VIDEO_NAME.xml
-
-# Format of the XML file. Must be one of:
-#  - fcpx:  Final Cut Pro X (default)
-#  - fcp:   Final Cut Pro 7
-#format = fcpx
-
-# Folder to output XML file to. Overrides [global] output option.
-#output = /usr/tmp/images
-
-
 #
 # BACKEND OPTIONS
 #
diff --git a/scenedetect/_cli/__init__.py b/scenedetect/_cli/__init__.py
@@ -1626,10 +1626,10 @@ def save_qp_command(
     ctx.add_command(cli_commands.save_qp, save_qp_args)
 
 
-SAVE_XML_HELP = """Save cuts in XML format."""
+SAVE_XML_HELP = """[IN DEVELOPMENT] Save cuts in XML format."""
 
 
-@click.command("save-xml", cls=Command, help=SAVE_XML_HELP)
+@click.command("save-xml", cls=Command, help=SAVE_XML_HELP, hidden=True)
 @click.option(
     "--filename",
     "-f",
@@ -1705,20 +1705,40 @@ def save_xml_command(
     help="Output directory to save OTIO file to. Overrides global option -o/--output.%s"
     % (USER_CONFIG.get_help_string("save-otio", "output", show_default=False)),
 )
+@click.option(
+    "--audio",
+    is_flag=True,
+    flag_value=True,
+    help="Include audio track (default).",
+)
+@click.option(
+    "--no-audio",
+    is_flag=True,
+    flag_value=True,
+    help="Exclude audio track.",
+)
 @click.pass_context
 def save_otio_command(
     ctx: click.Context,
     filename: ty.Optional[ty.AnyStr],
     name: ty.Optional[ty.AnyStr],
     output: ty.Optional[ty.AnyStr],
+    audio: bool,
+    no_audio: bool,
 ):
     ctx = ctx.obj
     assert isinstance(ctx, CliContext)
 
+    if audio and no_audio:
+        raise click.BadArgumentUsage("Only one of --audio or --no-audio can be specified.")
+
     save_otio_args = {
         "filename": ctx.config.get_value("save-otio", "filename", filename),
         "name": ctx.config.get_value("save-otio", "name", name),
         "output": ctx.config.get_value("save-otio", "output", output),
+        "audio": ctx.config.get_value(
+            "save-otio", "audio", True if audio else False if no_audio else None
+        ),
     }
     ctx.add_command(cli_commands.save_otio, save_otio_args)
 
diff --git a/scenedetect/_cli/commands.py b/scenedetect/_cli/commands.py
@@ -489,6 +489,7 @@ def save_otio(
     filename: str,
     output: str,
     name: str,
+    audio: bool,
 ):
     """Saves scenes in OTIO format."""
 
@@ -501,7 +502,9 @@ def save_otio(
 
     # List of track mapping to resource type.
     # TODO(#497): Allow exporting without an audio track.
-    track_list = {"Video 1": "Video", "Audio 1": "Audio"}
+    track_list = {"Video 1": "Video"}
+    if audio:
+        track_list["Audio 1"] = "Audio"
 
     otio = {
         "OTIO_SCHEMA": "Timeline.1",
diff --git a/scenedetect/_cli/config.py b/scenedetect/_cli/config.py
@@ -425,6 +425,7 @@ class XmlFormat(Enum):
         "width": 0,
     },
     "save-otio": {
+        "audio": True,
         "filename": "$VIDEO_NAME.otio",
         "name": "$VIDEO_NAME (PySceneDetect)",
         "output": None,
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -990,3 +990,123 @@ def test_cli_save_otio(tmp_path: Path):
     assert output_path.read_text() == EXPECTED_OTIO_OUTPUT.replace(
         "{ABSOLUTE_PATH}", os.path.abspath(DEFAULT_VIDEO_PATH).replace("\\", "\\\\")
     )
+
+
+def test_cli_save_otio_no_audio(tmp_path: Path):
+    """Test `save-otio` command without audio."""
+    assert (
+        invoke_scenedetect(
+            "-i {VIDEO} time {TIME} {DETECTOR} save-otio --no-audio",
+            output_dir=tmp_path,
+        )
+        == 0
+    )
+    output_path = tmp_path.joinpath(f"{DEFAULT_VIDEO_NAME}.otio")
+    assert os.path.exists(output_path)
+    EXPECTED_OTIO_OUTPUT = """{
+    "OTIO_SCHEMA": "Timeline.1",
+    "name": "goldeneye (PySceneDetect)",
+    "global_start_time": {
+        "OTIO_SCHEMA": "RationalTime.1",
+        "rate": 23.976023976023978,
+        "value": 0.0
+    },
+    "tracks": {
+        "OTIO_SCHEMA": "Stack.1",
+        "enabled": true,
+        "children": [
+            {
+                "OTIO_SCHEMA": "Track.1",
+                "name": "Video 1",
+                "enabled": true,
+                "children": [
+                    {
+                        "OTIO_SCHEMA": "Clip.2",
+                        "name": "goldeneye.mp4",
+                        "source_range": {
+                            "OTIO_SCHEMA": "TimeRange.1",
+                            "duration": {
+                                "OTIO_SCHEMA": "RationalTime.1",
+                                "rate": 23.976023976023978,
+                                "value": 42.0
+                            },
+                            "start_time": {
+                                "OTIO_SCHEMA": "RationalTime.1",
+                                "rate": 23.976023976023978,
+                                "value": 48.0
+                            }
+                        },
+                        "enabled": true,
+                        "media_references": {
+                            "DEFAULT_MEDIA": {
+                                "OTIO_SCHEMA": "ExternalReference.1",
+                                "name": "goldeneye.mp4",
+                                "available_range": {
+                                    "OTIO_SCHEMA": "TimeRange.1",
+                                    "duration": {
+                                        "OTIO_SCHEMA": "RationalTime.1",
+                                        "rate": 23.976023976023978,
+                                        "value": 1980.0
+                                    },
+                                    "start_time": {
+                                        "OTIO_SCHEMA": "RationalTime.1",
+                                        "rate": 23.976023976023978,
+                                        "value": 0.0
+                                    }
+                                },
+                                "available_image_bounds": null,
+                                "target_url": "{ABSOLUTE_PATH}"
+                            }
+                        },
+                        "active_media_reference_key": "DEFAULT_MEDIA"
+                    },
+                    {
+                        "OTIO_SCHEMA": "Clip.2",
+                        "name": "goldeneye.mp4",
+                        "source_range": {
+                            "OTIO_SCHEMA": "TimeRange.1",
+                            "duration": {
+                                "OTIO_SCHEMA": "RationalTime.1",
+                                "rate": 23.976023976023978,
+                                "value": 54.0
+                            },
+                            "start_time": {
+                                "OTIO_SCHEMA": "RationalTime.1",
+                                "rate": 23.976023976023978,
+                                "value": 90.0
+                            }
+                        },
+                        "enabled": true,
+                        "media_references": {
+                            "DEFAULT_MEDIA": {
+                                "OTIO_SCHEMA": "ExternalReference.1",
+                                "name": "goldeneye.mp4",
+                                "available_range": {
+                                    "OTIO_SCHEMA": "TimeRange.1",
+                                    "duration": {
+                                        "OTIO_SCHEMA": "RationalTime.1",
+                                        "rate": 23.976023976023978,
+                                        "value": 1980.0
+                                    },
+                                    "start_time": {
+                                        "OTIO_SCHEMA": "RationalTime.1",
+                                        "rate": 23.976023976023978,
+                                        "value": 0.0
+                                    }
+                                },
+                                "available_image_bounds": null,
+                                "target_url": "{ABSOLUTE_PATH}"
+                            }
+                        },
+                        "active_media_reference_key": "DEFAULT_MEDIA"
+                    }
+                ],
+                "kind": "Video"
+            }
+        ]
+    }
+}
+"""
+    assert output_path.read_text() == EXPECTED_OTIO_OUTPUT.replace(
+        "{ABSOLUTE_PATH}", os.path.abspath(DEFAULT_VIDEO_PATH).replace("\\", "\\\\")
+    )
diff --git a/website/pages/changelog.md b/website/pages/changelog.md
@@ -4,6 +4,23 @@ Releases
 
 ## PySceneDetect 0.6
 
+### PySceneDetect 0.6.6 (March 9, 2025)
+
+#### Release Notes
+
+PySceneDetect v0.6.6 introduces new output formats, which improve compatibility with popular video editors (e.g. DaVinci Resolve). Also included are several important bugfixes.
+
+#### Changelog
+
+ - [feature] New `save-otio` command supports saving scenes in OTIO format [#497](https://github.com/Breakthrough/PySceneDetect/issues/497)
+ - [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)
+ - [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
+
+
 ### PySceneDetect 0.6.5 (November 24, 2024)
 
 #### Release Notes
@@ -622,17 +639,8 @@ Both the Windows installer and portable distributions now include signed executa
 Development
 ==========================================================
 
-## PySceneDetect 0.6.6 (In Development)
+## PySceneDetect 0.7 (In 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)
-
-### 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)
- - [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
