feat: add merging modes to web UI

assets/merging_mode_info.html

@@ -0,0 +1,10 @@
+<div>
+  <p><strong>Merging Mode:</strong></p>
+  <ul>
+    <li><b>Synced</b> – all timestamps overlap (from the same cut)</li>
+    <li><b>Mixed</b> – some timestamps don't overlap (from the same cut)</li>
+    <li><b>Cuts</b> – different cuts (primary being extended or longer version)</li>
+  </ul>
+
+  <p>💡 For <strong>Mixed</strong> and <strong>Cuts</strong> modes, subtitles should <strong>not contain scene annotations </strong>if possible.</p>
+</div>

ui/constants.py

@@ -1,19 +1,22 @@
 """
 Constants used in the DuoSubs Hugging Face Web UI.
 
-This module defines file paths, supported subtitle formats, and default values for use 
-in the UI and other components.
+This module defines file paths, supported subtitle formats, merging mode options, 
+and default values for use in the UI and other components.
 """
 
 from pathlib import Path
 
-from duosubs import SubtitleFormat
+from duosubs import MergingMode, SubtitleFormat
 
 TITLE_HTML = Path(__file__).parent.parent / "assets" / "title.html"
+MERGING_MODE_INFO = Path(__file__).parent.parent / "assets" / "merging_mode_info.html"
 
 SUB_EXT_LIST: list[str] = [f.value for f in SubtitleFormat]
 SUB_EXT_LIST_WITH_DOT: list[str] = [f".{ext}" for ext in SUB_EXT_LIST]
 
+MERGING_MODE_LIST: list[str] = [f.value.capitalize() for f in MergingMode]
+
 DEFAULT_SUB_EXT = SubtitleFormat.ASS.value
 
 MODEL_NAME_LIST = [

ui/events.py

@@ -13,6 +13,7 @@ from duosubs import (
     LoadSubsError,
     MergeArgs,
     MergeSubsError,
+    MergingMode,
     OmitFile,
     SaveSubsError,
     SubtitleFormat,
@@ -29,7 +30,7 @@ def start_merging(
         secondary_subtitles: str,
         model_name: str,
         batch_size: int,
-        ignore_non_overlap: bool,
+        merging_mode: str,
         retain_newline: bool,
         secondary_above_primary: bool,
         omit_subtitles: list[str],
@@ -50,14 +51,18 @@ def start_merging(
         secondary_subtitles (str): Path to secondary subtitle file.
         model_name (str): Name of the model to use.
         batch_size (int): Batch size for inference.
-        ignore_non_overlap (bool): Whether to ignore non-overlapping subtitles.
+        merging_mode (str): Subttitle merging mode (based on the value of MergingMode).
         retain_newline (bool): Whether to retain newlines in output.
         secondary_above_primary (bool): Whether to place secondary subtitle above 
             primary.
-        omit_subtitles (list[str]): List of subtitle types to omit from output.
-        combined_format (str): Format for combined subtitles.
-        primary_format (str): Format for primary subtitles.
-        secondary_format (str): Format for secondary subtitles.
+        omit_subtitles (list[str]): List of subtitle types to omit from output (based 
+            on the value of OmitFile).
+        combined_format (str): Format for combined subtitles (based on the value of 
+            SubtitleFormat).
+        primary_format (str): Format for primary subtitles (based on the value of 
+            SubtitleFormat).
+        secondary_format (str): Format for secondary subtitles (based on the value of 
+            SubtitleFormat).
         cancel_state (list[bool]): List tracking cancellation state.
         progress (gradio.Progress) : Gradio progress object (optional). 
             Defaults to None.
@@ -75,7 +80,7 @@ def start_merging(
         primary=primary_subtitles,
         secondary=secondary_subtitles,
         batch_size=int(batch_size),
-        ignore_non_overlap_filter=ignore_non_overlap,
+        merging_mode=MergingMode(merging_mode.lower()),
         retain_newline=retain_newline,
         secondary_above=secondary_above_primary,
         omit=[OmitFile.EDIT],
@@ -114,7 +119,11 @@ def start_merging(
             def update_progress(current: int) -> None:
                 progress(
                     progress=current/100,
-                    desc= f"Stage 2 → Merging subtitles using {model_name}",
+                    desc= (
+                        f"Stage 2 → Merging subtitles "
+                        f"({args.merging_mode.value.capitalize()} mode, "
+                        f"using {model_name})"
+                    ),
                     total=100
                 )
             merged_subs = merge_subtitles(

ui/layout.py

@@ -11,6 +11,8 @@ import gradio as gr
 
 from .constants import (
     DEFAULT_SUB_EXT,
+    MERGING_MODE_INFO,
+    MERGING_MODE_LIST,
     MODEL_NAME_LIST,
     SUB_EXT_LIST,
     SUB_EXT_LIST_WITH_DOT,
@@ -70,24 +72,22 @@ def create_main_gr_blocks_ui(
                 ) = _create_subtitles_io_block()
             with gr.Column():
                 gr.Markdown("### ⚙️ Configurations")
-                with gr.Accordion("Basic"):
-                    with gr.Tab("Model Selection"):
-                        model_name =  _create_model_configurations_block()
-                    with gr.Tab("Output Styling"):
-                        (
-                            retain_newline,
-                            secondary_above_primary
-                        ) = _create_output_styling_block()
-                    with gr.Tab("File Exports"):
-                        (
-                            omit_subtitles,
-                            combined_format,
-                            primary_format,
-                            secondary_format
-                        ) = _create_file_exports_block()
-                with gr.Accordion("Advanced", open=False):
-                    with gr.Tab("Alignment Behavior"):
-                        ignore_non_overlap = _create_alignment_behaviour_block()
+                with gr.Tab("Model Selection"):
+                    model_name =  _create_model_configurations_block()
+                with gr.Tab("Alignment Behavior"):
+                    merging_mode = _create_alignment_behaviour_block()
+                with gr.Tab("Output Styling"):
+                    (
+                        retain_newline,
+                        secondary_above_primary
+                    ) = _create_output_styling_block()
+                with gr.Tab("File Exports"):
+                    (
+                        omit_subtitles,
+                        combined_format,
+                        primary_format,
+                        secondary_format
+                    ) = _create_file_exports_block()        
 
         omit_subtitles.change(
             fn=validate_excluded_subtitle_file,
@@ -104,7 +104,7 @@ def create_main_gr_blocks_ui(
                 primary_file,
                 secondary_file,
                 model_name,
-                ignore_non_overlap, 
+                merging_mode, 
                 retain_newline,
                 secondary_above_primary,
                 omit_subtitles,
@@ -188,26 +188,26 @@ def _create_model_configurations_block() -> gr.Dropdown:
         )
     return model_name
 
-def _create_alignment_behaviour_block() -> gr.Checkbox:
+def _create_alignment_behaviour_block() -> gr.Radio:
     """
     Creates alignment behavior UI components.
 
-    This function sets up a checkbox for ignoring non-overlapping subtitles, in the 
-    merging process.
-
+    This function sets up a radio buttons for selecting the subtitles merging mode.
+    
     Returns:
-        gradio.Checkbox: Checkbox for alignment behavior.
+        gradio.Radio: Radio buttons for merging mode.
     """
+    mode_content = open_html(MERGING_MODE_INFO)
     with gr.Column():
-        ignore_non_overlap = gr.Checkbox(
-            label="Ignore Non-Overlap Filter",
-            value=False,
-            info=(
-                "💡 Use only if both subtitles are **semantically identical** "
-                "and contain **no added scenes or annotations**"
-            )
+        merging_mode = gr.Radio(
+            label="Merging Mode",
+            choices=MERGING_MODE_LIST,
+            value=MERGING_MODE_LIST[0],
+            info="Please refer to **ℹ️ Info** below for more information" # noqa: RUF001
         )
-    return ignore_non_overlap
+        with gr.Accordion("ℹ️ Info"): # noqa: RUF001
+            gr.HTML(mode_content)
+    return merging_mode
 
 def _create_output_styling_block() -> tuple[gr.Checkbox, gr.Checkbox]:
     """
@@ -280,7 +280,7 @@ def wrapped_start_merging(
         primary_subtitles: str,
         secondary_subtitles: str,
         model_name: str,
-        ignore_non_overlap: bool,
+        merging_mode: str,
         retain_newline: bool,
         secondary_above_primary: bool,
         omit_subtitles: list[str],
@@ -297,14 +297,18 @@ def wrapped_start_merging(
         primary_subtitles (str): Path to primary subtitle file.
         secondary_subtitles (str): Path to secondary subtitle file.
         model_name (str): Name of the model to use.
-        ignore_non_overlap (bool): Whether to ignore non-overlapping subtitles.
+        merging_mode (str): Subttitle merging mode (based on the value of MergingMode).
         retain_newline (bool): Whether to retain newlines in output.
         secondary_above_primary (bool): Whether to place secondary subtitle above 
             primary.
-        omit_subtitles (list[str]): List of subtitle types to omit from output.
-        combined_format (str): Format for combined subtitles.
-        primary_format (str): Format for primary subtitles.
-        secondary_format (str): Format for secondary subtitles.
+        omit_subtitles (list[str]): List of subtitle types to omit from output (based 
+            on the value of OmitFile).
+        combined_format (str): Format for combined subtitles (based on the value of 
+            SubtitleFormat).
+        primary_format (str): Format for primary subtitles (based on the value of 
+            SubtitleFormat).
+        secondary_format (str): Format for secondary subtitles (based on the value of 
+            SubtitleFormat).
         gpu_list (list[str]): List of available GPU names.
         loaded_model_device (list[str]): List tracking loaded model device.
         loaded_model_name (list[str]): List tracking loaded model name.
@@ -322,7 +326,7 @@ def wrapped_start_merging(
         secondary_subtitles,
         model_name,
         256,
-        ignore_non_overlap,
+        merging_mode,
         retain_newline,
         secondary_above_primary,
         omit_subtitles,