[cli] Make argument names consistent with CLI options in command handlers

Author: Breakthrough

scenedetect/_cli/__init__.py

@@ -1049,7 +1049,7 @@ def save_html_command(
     if include_images and not ctx.save_images:
         save_images_command.callback()
     save_html_args = {
-        "html_name_format": ctx.config.get_value("save-html", "filename", filename),
+        "filename": ctx.config.get_value("save-html", "filename", filename),
         "image_width": ctx.config.get_value("save-html", "image-width", image_width),
         "image_height": ctx.config.get_value("save-html", "image-height", image_height),
         "include_images": include_images,
@@ -1128,18 +1128,15 @@ def list_scenes_command(
     ctx = ctx.obj
     assert isinstance(ctx, CliContext)
 
-    create_file = not ctx.config.get_value("list-scenes", "no-output-file", no_output_file)
-    output_dir = ctx.config.get_value("list-scenes", "output", output)
-    name_format = ctx.config.get_value("list-scenes", "filename", filename)
     list_scenes_args = {
         "col_separator": ctx.config.get_value("list-scenes", "col-separator"),
         "cut_format": ctx.config.get_value("list-scenes", "cut-format"),
         "display_scenes": ctx.config.get_value("list-scenes", "display-scenes"),
         "display_cuts": ctx.config.get_value("list-scenes", "display-cuts"),
-        "scene_list_output": create_file,
-        "scene_list_name_format": name_format,
+        "no_output_file": ctx.config.get_value("list-scenes", "no-output-file", no_output_file),
+        "filename": ctx.config.get_value("list-scenes", "filename", filename),
         "skip_cuts": ctx.config.get_value("list-scenes", "skip-cuts", skip_cuts),
-        "output_dir": output_dir,
+        "output": ctx.config.get_value("list-scenes", "output", output),
         "quiet": ctx.config.get_value("list-scenes", "quiet", quiet) or ctx.quiet_mode,
         "row_separator": ctx.config.get_value("list-scenes", "row-separator"),
     }
@@ -1322,7 +1319,7 @@ def split_video_command(
     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),
+        "output": ctx.config.get_value("split-video", "output", output),
         "show_output": not ctx.config.get_value("split-video", "quiet", quiet),
         "ffmpeg_args": args,
     }
@@ -1506,10 +1503,10 @@ def save_images_command(
         "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),
+        "filename": 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,
+        "output": output,
         "scale": scale,
         "show_progress": not ctx.quiet_mode,
         "threading": ctx.config.get_value("save-images", "threading"),
@@ -1565,9 +1562,9 @@ def save_qp_command(
     assert isinstance(ctx, CliContext)
 
     save_qp_args = {
-        "filename_format": ctx.config.get_value("save-qp", "filename", filename),
-        "output_dir": ctx.config.get_value("save-qp", "output", output),
-        "shift_start": not ctx.config.get_value("save-qp", "disable-shift", disable_shift),
+        "filename": ctx.config.get_value("save-qp", "filename", filename),
+        "output": ctx.config.get_value("save-qp", "output", output),
+        "disable_shift": ctx.config.get_value("save-qp", "disable-shift", disable_shift),
     }
     ctx.add_command(cli_commands.save_qp, save_qp_args)
 

scenedetect/_cli/commands.py

@@ -46,16 +46,16 @@ def save_html(
     show: bool,
 ):
     """Handles the `save-html` command."""
-    (image_filenames, output_dir) = (
+    (image_filenames, output) = (
         context.save_images_result
         if context.save_images_result is not None
-        else (None, context.output_dir)
+        else (None, context.output)
     )
 
     html_filename = Template(html_name_format).safe_substitute(VIDEO_NAME=context.video_stream.name)
     if not html_filename.lower().endswith(".html"):
         html_filename += ".html"
-    html_path = get_and_create_path(html_filename, output_dir)
+    html_path = get_and_create_path(html_filename, output)
     write_scene_list_html(
         output_html_filename=html_path,
         scene_list=scenes,
@@ -72,17 +72,18 @@ def save_qp(
     context: CliContext,
     scenes: SceneList,
     cuts: CutList,
-    output_dir: str,
-    filename_format: str,
-    shift_start: bool,
+    output: str,
+    filename: str,
+    disable_shift: bool,
 ):
     """Handler for the `save-qp` command."""
     del scenes  # We only use cuts for this handler.
     qp_path = get_and_create_path(
-        Template(filename_format).safe_substitute(VIDEO_NAME=context.video_stream.name),
-        output_dir,
+        Template(filename).safe_substitute(VIDEO_NAME=context.video_stream.name),
+        output,
     )
     start_frame = context.start_time.frame_num if context.start_time else 0
+    shift_start = not disable_shift
     offset = start_frame if shift_start else 0
     with open(qp_path, "wt") as qp_file:
         qp_file.write(f"{0 if shift_start else start_frame} I -1\n")
@@ -95,9 +96,9 @@ def list_scenes(
     context: CliContext,
     scenes: SceneList,
     cuts: CutList,
-    scene_list_output: bool,
-    scene_list_name_format: str,
-    output_dir: str,
+    no_output_file: bool,
+    filename: str,
+    output: str,
     skip_cuts: bool,
     quiet: bool,
     display_scenes: bool,
@@ -108,15 +109,15 @@ def list_scenes(
 ):
     """Handles the `list-scenes` command."""
     # Write scene list CSV to if required.
-    if scene_list_output:
-        scene_list_filename = Template(scene_list_name_format).safe_substitute(
+    if not no_output_file:
+        scene_list_filename = Template(filename).safe_substitute(
             VIDEO_NAME=context.video_stream.name
         )
         if not scene_list_filename.lower().endswith(".csv"):
             scene_list_filename += ".csv"
         scene_list_path = get_and_create_path(
             scene_list_filename,
-            output_dir,
+            output,
         )
         logger.info("Writing scene list to CSV file:\n  %s", scene_list_path)
         with open(scene_list_path, "w") as scene_list_file:
@@ -170,8 +171,8 @@ def save_images(
     frame_margin: int,
     image_extension: str,
     encoder_param: int,
-    image_name_template: str,
-    output_dir: ty.Optional[str],
+    filename: str,
+    output: ty.Optional[str],
     show_progress: bool,
     scale: int,
     height: int,
@@ -189,8 +190,8 @@ def save_images(
         frame_margin=frame_margin,
         image_extension=image_extension,
         encoder_param=encoder_param,
-        image_name_template=image_name_template,
-        output_dir=output_dir,
+        image_name_template=filename,
+        output_dir=output,
         show_progress=show_progress,
         scale=scale,
         height=height,
@@ -199,7 +200,7 @@ def save_images(
         threading=threading,
     )
     # Save the result for use by `save-html` if required.
-    context.save_images_result = (images, output_dir)
+    context.save_images_result = (images, output)
 
 
 def split_video(
@@ -208,7 +209,7 @@ def split_video(
     cuts: CutList,
     name_format: str,
     use_mkvmerge: bool,
-    output_dir: str,
+    output: str,
     show_output: bool,
     ffmpeg_args: str,
 ):
@@ -231,15 +232,15 @@ def split_video(
         split_video_mkvmerge(
             input_video_path=context.video_stream.path,
             scene_list=scenes,
-            output_dir=output_dir,
+            output_dir=output,
             output_file_template=name_format,
             show_output=show_output,
         )
     else:
         split_video_ffmpeg(
             input_video_path=context.video_stream.path,
             scene_list=scenes,
-            output_dir=output_dir,
+            output_dir=output,
             output_file_template=name_format,
             arg_override=ffmpeg_args,
             show_progress=not context.quiet_mode,

scenedetect/_cli/context.py

@@ -101,7 +101,7 @@ def __init__(self):
         self.merge_last_scene: bool = None
         self.min_scene_len: FrameTimecode = None
         self.default_detector: ty.Tuple[ty.Type[SceneDetector], ty.Dict[str, ty.Any]] = None
-        self.output_dir: str = None
+        self.output: str = None
         self.stats_file_path: str = None
 
         # Output Commands (e.g. split-video, save-images):
@@ -111,8 +111,8 @@ def __init__(self):
 
     def add_command(self, command: ty.Callable, command_args: ty.Dict[str, ty.Any]):
         """Add `command` to the processing pipeline. Will be called after processing the input."""
-        if "output_dir" in command_args and command_args["output_dir"] is None:
-            command_args["output_dir"] = self.output_dir
+        if "output" in command_args and command_args["output"] is None:
+            command_args["output"] = self.output
         logger.debug("Adding command: %s(%s)", command.__name__, command_args)
         self.commands.append((command, command_args))
 
@@ -238,9 +238,9 @@ def handle_options(
         # Load the input video to obtain a time base for parsing timecodes.
         self._open_video_stream(input_path, framerate, backend)
 
-        self.output_dir = self.config.get_value("global", "output", output)
-        if self.output_dir:
-            logger.debug("Output directory set:\n  %s", self.output_dir)
+        self.output = self.config.get_value("global", "output", output)
+        if self.output:
+            logger.debug("Output directory set:\n  %s", self.output)
 
         self.min_scene_len = self.parse_timecode(
             min_scene_len

scenedetect/_cli/controller.py

@@ -154,7 +154,7 @@ def _save_stats(context: CliContext) -> None:
     if not context.stats_file_path:
         return
     if context.stats_manager.is_save_required():
-        path = get_and_create_path(context.stats_file_path, context.output_dir)
+        path = get_and_create_path(context.stats_file_path, context.output)
         logger.info("Saving frame metrics to stats file: %s", path)
         with open(path, mode="w") as file:
             context.stats_manager.save_to_csv(csv_file=file)