karaoke-gen 0.57.0__py3-none-any.whl → 0.71.23__py3-none-any.whl

karaoke_gen/utils/gen_cli.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python
+# Suppress SyntaxWarnings from third-party dependencies (pydub, syrics)
+# that have invalid escape sequences in regex patterns (not yet fixed for Python 3.12+)
+import warnings
+warnings.filterwarnings("ignore", category=SyntaxWarning, module="pydub")
+warnings.filterwarnings("ignore", category=SyntaxWarning, module="syrics")
+
 import argparse
 import logging
 from importlib import metadata
@@ -11,16 +17,7 @@ import time
 import pyperclip
 from karaoke_gen import KaraokePrep
 from karaoke_gen.karaoke_finalise import KaraokeFinalise
-
-
-def is_url(string):
-    """Simple check to determine if a string is a URL."""
-    return string.startswith("http://") or string.startswith("https://")
-
-
-def is_file(string):
-    """Check if a string is a valid file."""
-    return os.path.isfile(string)
+from .cli_args import create_parser, process_style_overrides, is_url, is_file
 
 
 async def async_main():
@@ -30,258 +27,15 @@ async def async_main():
     log_handler.setFormatter(log_formatter)
     logger.addHandler(log_handler)
 
-    parser = argparse.ArgumentParser(
-        description="Generate karaoke videos with synchronized lyrics. Handles the entire process from downloading audio and lyrics to creating the final video.",
-        formatter_class=lambda prog: argparse.RawTextHelpFormatter(prog, max_help_position=54),
-    )
-
-    # Basic information
-    parser.add_argument(
-        "args",
-        nargs="*",
-        help="[Media or playlist URL] [Artist] [Title] of song to process. If URL is provided, Artist and Title are optional but increase chance of fetching the correct lyrics. If Artist and Title are provided with no URL, the top YouTube search result will be fetched.",
-    )
+    # Use shared CLI parser
+    parser = create_parser(prog="karaoke-gen")
+    args = parser.parse_args()
 
-    # Get version using importlib.metadata
+    # Process style overrides
     try:
-        package_version = metadata.version("karaoke-gen")
-    except metadata.PackageNotFoundError:
-        package_version = "unknown"
-
-    parser.add_argument("-v", "--version", action="version", version=f"%(prog)s {package_version}")
-
-    # Workflow control
-    workflow_group = parser.add_argument_group("Workflow Control")
-    workflow_group.add_argument(
-        "--prep-only",
-        action="store_true",
-        help="Only run the preparation phase (download audio, lyrics, separate stems, create title screens). Example: --prep-only",
-    )
-    workflow_group.add_argument(
-        "--finalise-only",
-        action="store_true",
-        help="Only run the finalisation phase (remux, encode, organize). Must be run in a directory prepared by the prep phase. Example: --finalise-only",
-    )
-    workflow_group.add_argument(
-        "--skip-transcription",
-        action="store_true",
-        help="Skip automatic lyrics transcription/synchronization. Use this to fall back to manual syncing. Example: --skip-transcription",
-    )
-    workflow_group.add_argument(
-        "--skip-separation",
-        action="store_true",
-        help="Skip audio separation process. Example: --skip-separation",
-    )
-    workflow_group.add_argument(
-        "--skip-lyrics",
-        action="store_true",
-        help="Skip fetching and processing lyrics. Example: --skip-lyrics",
-    )
-    workflow_group.add_argument(
-        "--lyrics-only",
-        action="store_true",
-        help="Only process lyrics, skipping audio separation and title/end screen generation. Example: --lyrics-only",
-    )
-    workflow_group.add_argument(
-        "--edit-lyrics",
-        action="store_true",
-        help="Edit lyrics of an existing track. This will backup existing outputs, re-run the lyrics transcription process, and update all outputs. Example: --edit-lyrics",
-    )
-
-    # Logging & Debugging
-    debug_group = parser.add_argument_group("Logging & Debugging")
-    debug_group.add_argument(
-        "--log_level",
-        default="info",
-        help="Optional: logging level, e.g. info, debug, warning (default: %(default)s). Example: --log_level=debug",
-    )
-    debug_group.add_argument(
-        "--dry_run",
-        action="store_true",
-        help="Optional: perform a dry run without making any changes. Example: --dry_run",
-    )
-    debug_group.add_argument(
-        "--render_bounding_boxes",
-        action="store_true",
-        help="Optional: render bounding boxes around text regions for debugging. Example: --render_bounding_boxes",
-    )
-
-    # Input/Output Configuration
-    io_group = parser.add_argument_group("Input/Output Configuration")
-    io_group.add_argument(
-        "--filename_pattern",
-        help="Required if processing a folder: Python regex pattern to extract track names from filenames. Must contain a named group 'title'. Example: --filename_pattern='(?P<index>\\d+) - (?P<title>.+).mp3'",
-    )
-    io_group.add_argument(
-        "--output_dir",
-        default=".",
-        help="Optional: directory to write output files (default: <current dir>). Example: --output_dir=/app/karaoke",
-    )
-    io_group.add_argument(
-        "--no_track_subfolders",
-        action="store_false",
-        dest="no_track_subfolders",
-        help="Optional: do NOT create a named subfolder for each track. Example: --no_track_subfolders",
-    )
-    io_group.add_argument(
-        "--lossless_output_format",
-        default="FLAC",
-        help="Optional: lossless output format for separated audio (default: FLAC). Example: --lossless_output_format=WAV",
-    )
-    io_group.add_argument(
-        "--output_png",
-        type=lambda x: (str(x).lower() == "true"),
-        default=True,
-        help="Optional: output PNG format for title and end images (default: %(default)s). Example: --output_png=False",
-    )
-    io_group.add_argument(
-        "--output_jpg",
-        type=lambda x: (str(x).lower() == "true"),
-        default=True,
-        help="Optional: output JPG format for title and end images (default: %(default)s). Example: --output_jpg=False",
-    )
-
-    # Audio Processing Configuration
-    audio_group = parser.add_argument_group("Audio Processing Configuration")
-    audio_group.add_argument(
-        "--clean_instrumental_model",
-        default="model_bs_roformer_ep_317_sdr_12.9755.ckpt",
-        help="Optional: Model for clean instrumental separation (default: %(default)s).",
-    )
-    audio_group.add_argument(
-        "--backing_vocals_models",
-        nargs="+",
-        default=["mel_band_roformer_karaoke_aufr33_viperx_sdr_10.1956.ckpt"],
-        help="Optional: List of models for backing vocals separation (default: %(default)s).",
-    )
-    audio_group.add_argument(
-        "--other_stems_models",
-        nargs="+",
-        default=["htdemucs_6s.yaml"],
-        help="Optional: List of models for other stems separation (default: %(default)s).",
-    )
-
-    default_model_dir_unix = "/tmp/audio-separator-models/"
-    if os.name == "posix" and os.path.exists(default_model_dir_unix):
-        default_model_dir = default_model_dir_unix
-    else:
-        # Use tempfile to get the platform-independent temp directory
-        default_model_dir = os.path.join(tempfile.gettempdir(), "audio-separator-models")
-
-    audio_group.add_argument(
-        "--model_file_dir",
-        default=default_model_dir,
-        help="Optional: model files directory (default: %(default)s). Example: --model_file_dir=/app/models",
-    )
-    audio_group.add_argument(
-        "--existing_instrumental",
-        help="Optional: Path to an existing instrumental audio file. If provided, audio separation will be skipped.",
-    )
-    audio_group.add_argument(
-        "--instrumental_format",
-        default="flac",
-        help="Optional: format / file extension for instrumental track to use for remux (default: %(default)s). Example: --instrumental_format=mp3",
-    )
-
-    # Lyrics Configuration
-    lyrics_group = parser.add_argument_group("Lyrics Configuration")
-    lyrics_group.add_argument(
-        "--lyrics_artist",
-        help="Optional: Override the artist name used for lyrics search. Example: --lyrics_artist='The Beatles'",
-    )
-    lyrics_group.add_argument(
-        "--lyrics_title",
-        help="Optional: Override the song title used for lyrics search. Example: --lyrics_title='Hey Jude'",
-    )
-    lyrics_group.add_argument(
-        "--lyrics_file",
-        help="Optional: Path to a file containing lyrics to use instead of fetching from online. Example: --lyrics_file='/path/to/lyrics.txt'",
-    )
-    lyrics_group.add_argument(
-        "--subtitle_offset_ms",
-        type=int,
-        default=0,
-        help="Optional: Adjust subtitle timing by N milliseconds (+ve delays, -ve advances). Example: --subtitle_offset_ms=500",
-    )
-    lyrics_group.add_argument(
-        "--skip_transcription_review",
-        action="store_true",
-        help="Optional: Skip the review step after transcription. Example: --skip_transcription_review",
-    )
-
-    # Style Configuration
-    style_group = parser.add_argument_group("Style Configuration")
-    style_group.add_argument(
-        "--style_params_json",
-        help="Optional: Path to JSON file containing style configuration. Example: --style_params_json='/path/to/style_params.json'",
-    )
-
-    # Finalisation Configuration
-    finalise_group = parser.add_argument_group("Finalisation Configuration")
-    finalise_group.add_argument(
-        "--enable_cdg",
-        action="store_true",
-        help="Optional: Enable CDG ZIP generation during finalisation. Example: --enable_cdg",
-    )
-    finalise_group.add_argument(
-        "--enable_txt",
-        action="store_true",
-        help="Optional: Enable TXT ZIP generation during finalisation. Example: --enable_txt",
-    )
-    finalise_group.add_argument(
-        "--brand_prefix",
-        help="Optional: Your brand prefix to calculate the next sequential number. Example: --brand_prefix=BRAND",
-    )
-    finalise_group.add_argument(
-        "--organised_dir",
-        help="Optional: Target directory where the processed folder will be moved. Example: --organised_dir='/path/to/Tracks-Organized'",
-    )
-    finalise_group.add_argument(
-        "--organised_dir_rclone_root",
-        help="Optional: Rclone path which maps to your organised_dir. Example: --organised_dir_rclone_root='dropbox:Media/Karaoke/Tracks-Organized'",
-    )
-    finalise_group.add_argument(
-        "--public_share_dir",
-        help="Optional: Public share directory for final files. Example: --public_share_dir='/path/to/Tracks-PublicShare'",
-    )
-    finalise_group.add_argument(
-        "--youtube_client_secrets_file",
-        help="Optional: Path to youtube client secrets file. Example: --youtube_client_secrets_file='/path/to/client_secret.json'",
-    )
-    finalise_group.add_argument(
-        "--youtube_description_file",
-        help="Optional: Path to youtube description template. Example: --youtube_description_file='/path/to/description.txt'",
-    )
-    finalise_group.add_argument(
-        "--rclone_destination",
-        help="Optional: Rclone destination for public_share_dir sync. Example: --rclone_destination='googledrive:KaraokeFolder'",
-    )
-    finalise_group.add_argument(
-        "--discord_webhook_url",
-        help="Optional: Discord webhook URL for notifications. Example: --discord_webhook_url='https://discord.com/api/webhooks/...'",
-    )
-    finalise_group.add_argument(
-        "--email_template_file",
-        help="Optional: Path to email template file. Example: --email_template_file='/path/to/template.txt'",
-    )
-    finalise_group.add_argument(
-        "--keep-brand-code",
-        action="store_true",
-        help="Optional: Use existing brand code from current directory instead of generating new one. Example: --keep-brand-code",
-    )
-    finalise_group.add_argument(
-        "-y",
-        "--yes",
-        action="store_true",
-        help="Optional: Run in non-interactive mode, assuming yes to all prompts. Example: -y",
-    )
-    finalise_group.add_argument(
-        "--test_email_template",
-        action="store_true",
-        help="Optional: Test the email template functionality with fake data. Example: --test_email_template",
-    )
-
-    args = parser.parse_args()
+        style_overrides = process_style_overrides(args.style_override, logger)
+    except ValueError:
+        sys.exit(1)
 
     # Handle test email template case first
     if args.test_email_template:
@@ -354,6 +108,10 @@ async def async_main():
             skip_transcription_review=args.skip_transcription_review,
             subtitle_offset_ms=args.subtitle_offset_ms,
             style_params_json=args.style_params_json,
+            style_overrides=style_overrides,
+            background_video=args.background_video,
+            background_video_darkness=args.background_video_darkness,
+            auto_download=getattr(args, 'auto_download', False),
         )
         # No await needed for constructor
         kprep = kprep_coroutine
@@ -625,7 +383,10 @@ async def async_main():
     elif len(args.args) > 1:
         artist = args.args[0]
         title = args.args[1]
-        logger.warning(f"No input media provided, the top YouTube search result for {artist} - {title} will be used.")
+        if getattr(args, 'auto_download', False):
+            logger.info(f"No input media provided, flacfetch will automatically search and download: {artist} - {title}")
+        else:
+            logger.info(f"No input media provided, flacfetch will search for: {artist} - {title} (interactive selection)")
 
     else:
         parser.print_help()
@@ -671,6 +432,10 @@ async def async_main():
         skip_transcription_review=args.skip_transcription_review,
         subtitle_offset_ms=args.subtitle_offset_ms,
         style_params_json=args.style_params_json,
+        style_overrides=style_overrides,
+        background_video=args.background_video,
+        background_video_darkness=args.background_video_darkness,
+        auto_download=getattr(args, 'auto_download', False),
     )
     # No await needed for constructor
     kprep = kprep_coroutine