[export-html] Add new --show flag, remove dependency on save-images (#447)

* [export-html] Add --show option to display result in browser (#442)

* [export-html] Invoke `save-images` automatically

Author: Breakthrough

scenedetect.cfg

@@ -240,6 +240,9 @@
 # Filename format of created HTML file. Can use $VIDEO_NAME in the name.
 #filename = $VIDEO_NAME-Scenes.html
 
+# Automatically open resulting HTML when processing is complete.
+#show = no
+
 # Override <img> element width/height.
 #image-height = 0
 #image-width = 0

scenedetect/_cli/__init__.py

@@ -959,9 +959,10 @@ def load_scenes_command(
 )
 @click.option(
     "--no-images",
+    "-n",
     is_flag=True,
     flag_value=True,
-    help="Export the scene list including or excluding the saved images.%s"
+    help="Do not include images with the result.%s"
     % (USER_CONFIG.get_help_string("export-html", "no-images")),
 )
 @click.option(
@@ -980,30 +981,43 @@ def load_scenes_command(
     help="Height in pixels of the images in the resulting HTML table.%s"
     % (USER_CONFIG.get_help_string("export-html", "image-height", show_default=False)),
 )
+@click.option(
+    "--show",
+    "-s",
+    is_flag=True,
+    flag_value=True,
+    default=None,
+    help="Automatically open resulting HTML when processing is complete.%s"
+    % (USER_CONFIG.get_help_string("export-html", "show")),
+)
 @click.pass_context
 def export_html_command(
     ctx: click.Context,
     filename: ty.Optional[ty.AnyStr],
     no_images: bool,
     image_width: ty.Optional[int],
     image_height: ty.Optional[int],
+    show: bool,
 ):
-    """Export scene list to HTML file. Requires save-images unless --no-images is specified."""
+    """Export scene list to HTML file.
+
+    To customize image generation, specify the `save-images` command before `export-html`. This command always uses the result of the preceeding `save-images` command, or runs it with the default config values unless `--no-images` is set.
+    """
     # TODO: Rename this command to save-html to align with other export commands. This will require
     # that we allow `export-html` as an alias on the CLI and via the config file for a few versions
     # as to not break existing workflows.
     ctx = ctx.obj
     assert isinstance(ctx, CliContext)
-
-    no_images = no_images or ctx.config.get_value("export-html", "no-images")
-    if not ctx.save_images and not no_images:
-        raise click.BadArgumentUsage(
-            "export-html requires that save-images precedes it or --no-images is specified."
-        )
+    include_images = not ctx.config.get_value("export-html", "no-images", no_images)
+    # Make sure a save-images command is in the pipeline for us to use the results from.
+    if include_images and not ctx.save_images:
+        save_images_command.callback()
     export_html_args = {
         "html_name_format": ctx.config.get_value("export-html", "filename", filename),
         "image_width": ctx.config.get_value("export-html", "image-width", image_width),
         "image_height": ctx.config.get_value("export-html", "image-height", image_height),
+        "include_images": include_images,
+        "show": ctx.config.get_value("export-html", "show", show),
     }
     ctx.add_command(cli_commands.export_html, export_html_args)
 
@@ -1362,18 +1376,18 @@ def split_video_command(
 @click.pass_context
 def save_images_command(
     ctx: click.Context,
-    output: ty.Optional[ty.AnyStr],
-    filename: ty.Optional[ty.AnyStr],
-    num_images: ty.Optional[int],
-    jpeg: bool,
-    webp: bool,
-    quality: ty.Optional[int],
-    png: bool,
-    compression: ty.Optional[int],
-    frame_margin: ty.Optional[int],
-    scale: ty.Optional[float],
-    height: ty.Optional[int],
-    width: ty.Optional[int],
+    output: ty.Optional[ty.AnyStr] = None,
+    filename: ty.Optional[ty.AnyStr] = None,
+    num_images: ty.Optional[int] = None,
+    jpeg: bool = False,
+    webp: bool = False,
+    quality: ty.Optional[int] = None,
+    png: bool = False,
+    compression: ty.Optional[int] = None,
+    frame_margin: ty.Optional[int] = None,
+    scale: ty.Optional[float] = None,
+    height: ty.Optional[int] = None,
+    width: ty.Optional[int] = None,
 ):
     """Create images for each detected scene.
 

scenedetect/_cli/commands.py

@@ -17,6 +17,7 @@
 
 import logging
 import typing as ty
+import webbrowser
 from string import Template
 
 from scenedetect._cli.context import CliContext
@@ -43,13 +44,16 @@ def export_html(
     image_width: int,
     image_height: int,
     html_name_format: str,
+    include_images: bool,
+    show: bool,
 ):
     """Handles the `export-html` command."""
     (image_filenames, output_dir) = (
         context.save_images_result
         if context.save_images_result is not None
         else (None, context.output_dir)
     )
+
     html_filename = Template(html_name_format).safe_substitute(VIDEO_NAME=context.video_stream.name)
     if not html_filename.lower().endswith(".html"):
         html_filename += ".html"
@@ -58,10 +62,12 @@ def export_html(
         output_html_filename=html_path,
         scene_list=scenes,
         cut_list=cuts,
-        image_filenames=image_filenames,
+        image_filenames=image_filenames if include_images else None,
         image_width=image_width,
         image_height=image_height,
     )
+    if show:
+        webbrowser.open(html_path)
 
 
 def save_qp(

scenedetect/_cli/config.py

@@ -300,6 +300,7 @@ def format(self, timecode: FrameTimecode) -> str:
         "image-height": 0,
         "image-width": 0,
         "no-images": False,
+        "show": False,
     },
     "list-scenes": {
         "cut-format": TimecodeFormat.TIMECODE,

website/pages/changelog.md

@@ -584,12 +584,16 @@ Development
 ## PySceneDetect 0.6.5 (TBD)
 
  - [bugfix] Fix new detectors not working with `default-detector` config option
- - [bugfix] Fix crash when using `save-images` with OpenCV backend [#455](https://github.com/Breakthrough/PySceneDetect/issues/455)
- - [bugfix] Fix `SyntaxWarning` due to incorrect escaping [#400](https://github.com/Breakthrough/PySceneDetect/issues/400)
- - [bugfix] Fix `ContentDetector` crash when using callbacks [#416](https://github.com/Breakthrough/PySceneDetect/issues/416) [#420](https://github.com/Breakthrough/PySceneDetect/issues/420)
+ - [bugfix] Fix crash when using `save-images`/`save_images()` with OpenCV backend [#455](https://github.com/Breakthrough/PySceneDetect/issues/455)
  - [general] Timecodes of the form `MM:SS[.nnn]` are now processed correctly [#443](https://github.com/Breakthrough/PySceneDetect/issues/443)
- - [api] The `save_to_csv` function now works correctly with paths from the `pathlib` module
+ - [feature] Add new `--show` flag to `export-html` command to launch browser after processing (#442)
+ - [improvement] The `export-html` command now implicitly invokes `save-images` with default parameters
+     - The output of the `export-html` command will always use the result of the `save-images` command that *precedes* it
  - [general] Updates to Windows distributions:
     - The MoviePy backend is now included with Windows distributions
     - Bundled Python interpreter is now Python 3.13
     - Updated PyAV 10 -> 13.1.0 and OpenCV 4.10.0.82 -> 4.10.0.84
+ - [improvement] `save_to_csv` now works with paths from `pathlib`
+ - [bugfix] Fix `SyntaxWarning` due to incorrect escaping [#400](https://github.com/Breakthrough/PySceneDetect/issues/400)
+ - [bugfix] Fix `ContentDetector` crash when using callbacks [#416](https://github.com/Breakthrough/PySceneDetect/issues/416) [#420](https://github.com/Breakthrough/PySceneDetect/issues/420)
+