[cli] Move output command state out of CliContext

To simplify things, all output commands can be treated similarily
as they all act on the result of the processing pipeline. This
allows new commands to be added without needing to explicitly define
their values in CliContext, and makes the values that do remain there
much more meaningful.

It also allows commands to be specified multiple times gracefully
and with different options, so for example `save-images` can now be
run twice with different encoding parameters.

Author: Breakthrough

scenedetect/__main__.py

@@ -22,10 +22,10 @@
 
 def main():
     """PySceneDetect command-line interface (CLI) entry point."""
-    cli_ctx = CliContext()
+    context = CliContext()
     try:
         # Process command line arguments and subcommands to initialize the context.
-        scenedetect.main(obj=cli_ctx)  # Parse CLI arguments with registered callbacks.
+        scenedetect.main(obj=context)  # Parse CLI arguments with registered callbacks.
     except SystemExit as exit:
         help_command = any(arg in sys.argv for arg in ["-h", "--help"])
         if help_command or exit.code != 0:
@@ -38,12 +38,12 @@ def main():
     # no progress bars get created, we instead create a fake context manager. This is done here
     # to avoid needing a separate context manager at each point a progress bar is created.
     log_redirect = (
-        FakeTqdmLoggingRedirect() if cli_ctx.quiet_mode else logging_redirect_tqdm(loggers=[logger])
+        FakeTqdmLoggingRedirect() if context.quiet_mode else logging_redirect_tqdm(loggers=[logger])
     )
 
     with log_redirect:
         try:
-            run_scenedetect(cli_ctx)
+            run_scenedetect(context)
         except KeyboardInterrupt:
             logger.info("Stopped.")
             if __debug__:

scenedetect/_cli/__init__.py

@@ -25,8 +25,17 @@
 import click
 
 import scenedetect
-from scenedetect._cli.config import CHOICE_MAP, CONFIG_FILE_PATH, CONFIG_MAP
-from scenedetect._cli.context import USER_CONFIG, CliContext
+import scenedetect._cli.commands as cli_commands
+from scenedetect._cli.config import (
+    CHOICE_MAP,
+    CONFIG_FILE_PATH,
+    CONFIG_MAP,
+    DEFAULT_JPG_QUALITY,
+    DEFAULT_WEBP_QUALITY,
+    USER_CONFIG,
+    TimecodeFormat,
+)
+from scenedetect._cli.context import CliContext, check_split_video_requirements
 from scenedetect.backends import AVAILABLE_BACKENDS
 from scenedetect.detectors import (
     AdaptiveDetector,
@@ -35,7 +44,8 @@
     HistogramDetector,
     ThresholdDetector,
 )
-from scenedetect.platform import get_system_version_info
+from scenedetect.platform import get_cv2_imwrite_params, get_system_version_info
+from scenedetect.scene_manager import Interpolation
 
 _PROGRAM_VERSION = scenedetect.__version__
 """Used to avoid name conflict with named `scenedetect` command below."""
@@ -958,13 +968,20 @@ def export_html_command(
     image_height: ty.Optional[int],
 ):
     """Export scene list to HTML file. Requires save-images unless --no-images is specified."""
-    assert isinstance(ctx.obj, CliContext)
-    ctx.obj.handle_export_html(
-        filename=filename,
-        no_images=no_images,
-        image_width=image_width,
-        image_height=image_height,
-    )
+    ctx = ctx.obj
+    assert isinstance(ctx, CliContext)
+    ctx.ensure_input_open()
+    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."
+        )
+    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),
+    }
+    ctx.add_command(cli_commands.export_html, export_html_args)
 
 
 @click.command("list-scenes", cls=_Command)
@@ -1018,14 +1035,23 @@ def list_scenes_command(
     skip_cuts: bool,
 ):
     """Create scene list CSV file (will be named $VIDEO_NAME-Scenes.csv by default)."""
-    assert isinstance(ctx.obj, CliContext)
-    ctx.obj.handle_list_scenes(
-        output=output,
-        filename=filename,
-        no_output_file=no_output_file,
-        quiet=quiet,
-        skip_cuts=skip_cuts,
-    )
+    ctx = ctx.obj
+    assert isinstance(ctx, CliContext)
+    ctx.ensure_input_open()
+    no_output_file = no_output_file or ctx.config.get_value("list-scenes", "no-output-file")
+    scene_list_dir = ctx.config.get_value("list-scenes", "output", output, ignore_default=True)
+    scene_list_name_format = ctx.config.get_value("list-scenes", "filename", filename)
+    list_scenes_args = {
+        "cut_format": TimecodeFormat[ctx.config.get_value("list-scenes", "cut-format").upper()],
+        "display_scenes": ctx.config.get_value("list-scenes", "display-scenes"),
+        "display_cuts": ctx.config.get_value("list-scenes", "display-cuts"),
+        "scene_list_output": not no_output_file,
+        "scene_list_name_format": scene_list_name_format,
+        "skip_cuts": skip_cuts or ctx.config.get_value("list-scenes", "skip-cuts"),
+        "output_dir": scene_list_dir,
+        "quiet": quiet or ctx.config.get_value("list-scenes", "quiet") or ctx.quiet_mode,
+    }
+    ctx.add_command(cli_commands.list_scenes, list_scenes_args)
 
 
 @click.command("split-video", cls=_Command)
@@ -1134,18 +1160,73 @@ def split_video_command(
 
         {scenedetect_with_video} split-video --filename \\$VIDEO_NAME-Clip-\\$SCENE_NUMBER
     """
-    assert isinstance(ctx.obj, CliContext)
-    ctx.obj.handle_split_video(
-        output=output,
-        filename=filename,
-        quiet=quiet,
-        copy=copy,
-        high_quality=high_quality,
-        rate_factor=rate_factor,
-        preset=preset,
-        args=args,
-        mkvmerge=mkvmerge,
-    )
+    ctx = ctx.obj
+    assert isinstance(ctx, CliContext)
+    ctx.ensure_input_open()
+    check_split_video_requirements(use_mkvmerge=mkvmerge)
+    if "%" in ctx.video_stream.path or "://" in ctx.video_stream.path:
+        error = "The split-video command is incompatible with image sequences/URLs."
+        raise click.BadParameter(error, param_hint="split-video")
+
+    # We only load the config values for these flags/options if none of the other
+    # encoder flags/options were set via the CLI to avoid any conflicting options
+    # (e.g. if the config file sets `high-quality = yes` but `--copy` is specified).
+    if not (mkvmerge or copy or high_quality or args or rate_factor or preset):
+        mkvmerge = ctx.config.get_value("split-video", "mkvmerge")
+        copy = ctx.config.get_value("split-video", "copy")
+        high_quality = ctx.config.get_value("split-video", "high-quality")
+        rate_factor = ctx.config.get_value("split-video", "rate-factor")
+        preset = ctx.config.get_value("split-video", "preset")
+        args = ctx.config.get_value("split-video", "args")
+
+    # Disallow certain combinations of options.
+    if mkvmerge or copy:
+        command = "mkvmerge (-m)" if mkvmerge else "copy (-c)"
+        if high_quality:
+            raise click.BadParameter(
+                "high-quality (-hq) cannot be used with %s" % (command),
+                param_hint="split-video",
+            )
+        if args:
+            raise click.BadParameter(
+                "args (-a) cannot be used with %s" % (command), param_hint="split-video"
+            )
+        if rate_factor:
+            raise click.BadParameter(
+                "rate-factor (crf) cannot be used with %s" % (command), param_hint="split-video"
+            )
+        if preset:
+            raise click.BadParameter(
+                "preset (-p) cannot be used with %s" % (command), param_hint="split-video"
+            )
+
+    # mkvmerge-Specific Options
+    if mkvmerge and copy:
+        logger.warning("copy mode (-c) ignored due to mkvmerge mode (-m).")
+
+    # ffmpeg-Specific Options
+    if copy:
+        args = "-map 0:v:0 -map 0:a? -map 0:s? -c:v copy -c:a copy"
+    elif not args:
+        if rate_factor is None:
+            rate_factor = 22 if not high_quality else 17
+        if preset is None:
+            preset = "veryfast" if not high_quality else "slow"
+        args = (
+            "-map 0:v:0 -map 0:a? -map 0:s? "
+            f"-c:v libx264 -preset {preset} -crf {rate_factor} -c:a aac"
+        )
+    if filename:
+        logger.info("Output file name format: %s", filename)
+
+    split_video_args = {
+        "name_format": ctx.config.get_value("split-video", "filename", filename),
+        "use_mkvmerge": mkvmerge,
+        "output_dir": ctx.config.get_value("split-video", "output", output, ignore_default=True),
+        "show_output": not quiet,
+        "ffmpeg_args": args,
+    }
+    ctx.add_command(cli_commands.split_video, split_video_args)
 
 
 @click.command("save-images", cls=_Command)
@@ -1279,21 +1360,65 @@ def save_images_command(
 
         {scenedetect_with_video} save-images --filename \\$SCENE_NUMBER-img\\$IMAGE_NUMBER
     """
-    assert isinstance(ctx.obj, CliContext)
-    ctx.obj.handle_save_images(
-        num_images=num_images,
-        output=output,
-        filename=filename,
-        jpeg=jpeg,
-        webp=webp,
-        quality=quality,
-        png=png,
-        compression=compression,
-        frame_margin=frame_margin,
-        scale=scale,
-        height=height,
-        width=width,
+    ctx = ctx.obj
+    assert isinstance(ctx, CliContext)
+    ctx.ensure_input_open()
+    if "://" in ctx.video_stream.path:
+        error_str = "\nThe save-images command is incompatible with URLs."
+        logger.error(error_str)
+        raise click.BadParameter(error_str, param_hint="save-images")
+    num_flags = sum([1 if flag else 0 for flag in [jpeg, webp, png]])
+    if num_flags > 1:
+        logger.error(".")
+        raise click.BadParameter("Only one image type can be specified.", param_hint="save-images")
+    elif num_flags == 0:
+        image_format = ctx.config.get_value("save-images", "format").lower()
+        jpeg = image_format == "jpeg"
+        webp = image_format == "webp"
+        png = image_format == "png"
+
+    if not any((scale, height, width)):
+        scale = ctx.config.get_value("save-images", "scale")
+        height = ctx.config.get_value("save-images", "height")
+        width = ctx.config.get_value("save-images", "width")
+    scale_method = Interpolation[ctx.config.get_value("save-images", "scale-method").upper()]
+    quality = (
+        (DEFAULT_WEBP_QUALITY if webp else DEFAULT_JPG_QUALITY)
+        if ctx.config.is_default("save-images", "quality")
+        else ctx.config.get_value("save-images", "quality")
     )
+    compression = ctx.config.get_value("save-images", "compression", compression)
+    image_extension = "jpg" if jpeg else "png" if png else "webp"
+    valid_params = get_cv2_imwrite_params()
+    if image_extension not in valid_params or valid_params[image_extension] is None:
+        error_strs = [
+            "Image encoder type `%s` not supported." % image_extension.upper(),
+            "The specified encoder type could not be found in the current OpenCV module.",
+            "To enable this output format, please update the installed version of OpenCV.",
+            "If you build OpenCV, ensure the the proper dependencies are enabled. ",
+        ]
+        logger.debug("\n".join(error_strs))
+        raise click.BadParameter("\n".join(error_strs), param_hint="save-images")
+    output = ctx.config.get_value("save-images", "output", output, ignore_default=True)
+
+    save_images_args = {
+        "encoder_param": compression if png else quality,
+        "frame_margin": ctx.config.get_value("save-images", "frame-margin", frame_margin),
+        "height": height,
+        "image_extension": image_extension,
+        "image_name_template": ctx.config.get_value("save-images", "filename", filename),
+        "interpolation": scale_method,
+        "num_images": ctx.config.get_value("save-images", "num-images", num_images),
+        "output_dir": output,
+        "scale": scale,
+        "show_progress": ctx.quiet_mode,
+        "width": width,
+    }
+    ctx.add_command(cli_commands.save_images, save_images_args)
+
+    # Record that we added a save-images command to the pipeline so we can allow export-html
+    # to run afterwards (it is dependent on the output).
+    ctx.save_images = True
 
 
 # ----------------------------------------------------------------------