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

lyrics_transcriber/output/countdown_processor.py

@@ -0,0 +1,267 @@
+"""Handles adding countdown intro to songs that start too quickly for karaoke singers."""
+
+import logging
+import os
+import subprocess
+from typing import List, Optional, Tuple
+from copy import deepcopy
+
+from lyrics_transcriber.types import CorrectionResult, LyricsSegment, Word
+from lyrics_transcriber.utils.word_utils import WordUtils
+
+
+class CountdownProcessor:
+    """
+    Processes corrected lyrics and audio to add countdown intro for songs that start too quickly.
+    
+    For songs where vocals start within the first 3 seconds, this processor:
+    - Adds 3 seconds of silence to the start of the audio file
+    - Shifts all timestamps in corrected lyrics by 3 seconds
+    - Adds a countdown segment "3... 2... 1..." spanning 0.1s to 2.9s
+    """
+
+    # Configuration constants
+    COUNTDOWN_THRESHOLD_SECONDS = 3.0  # Trigger countdown if first word is within this time
+    COUNTDOWN_PADDING_SECONDS = 3.0    # Amount of silence to add
+    COUNTDOWN_START_TIME = 0.1         # When countdown text starts
+    COUNTDOWN_END_TIME = 2.9           # When countdown text ends
+    COUNTDOWN_TEXT = "3... 2... 1..."  # The countdown text to display
+
+    def __init__(
+        self,
+        cache_dir: str,
+        logger: Optional[logging.Logger] = None,
+    ):
+        """
+        Initialize CountdownProcessor.
+
+        Args:
+            cache_dir: Directory for temporary files (padded audio)
+            logger: Optional logger instance
+        """
+        self.cache_dir = cache_dir
+        self.logger = logger or logging.getLogger(__name__)
+
+        # Ensure cache directory exists
+        os.makedirs(self.cache_dir, exist_ok=True)
+
+    def process(
+        self,
+        correction_result: CorrectionResult,
+        audio_filepath: str,
+    ) -> Tuple[CorrectionResult, str, bool, float]:
+        """
+        Process correction result and audio file, adding countdown if needed.
+
+        Args:
+            correction_result: The CorrectionResult to potentially modify
+            audio_filepath: Path to the original audio file
+
+        Returns:
+            Tuple of:
+            - potentially modified CorrectionResult
+            - potentially padded audio filepath
+            - whether padding was added (bool)
+            - amount of padding in seconds (float)
+        """
+        # Check if countdown is needed
+        if not self._needs_countdown(correction_result):
+            self.logger.info(
+                f"First word starts after {self.COUNTDOWN_THRESHOLD_SECONDS}s - "
+                "no countdown needed"
+            )
+            return correction_result, audio_filepath, False, 0.0
+
+        self.logger.info(
+            f"First word starts within {self.COUNTDOWN_THRESHOLD_SECONDS}s - "
+            "adding countdown intro"
+        )
+
+        # Create padded audio file
+        padded_audio_path = self._create_padded_audio(audio_filepath)
+
+        # Create modified correction result with adjusted timestamps
+        modified_result = self._add_countdown_to_result(correction_result)
+
+        self.logger.info(
+            f"Countdown intro added successfully. "
+            f"Padded audio: {os.path.basename(padded_audio_path)}"
+        )
+
+        return modified_result, padded_audio_path, True, self.COUNTDOWN_PADDING_SECONDS
+
+    def _needs_countdown(self, correction_result: CorrectionResult) -> bool:
+        """
+        Check if the song needs a countdown intro.
+
+        Args:
+            correction_result: The correction result to check
+
+        Returns:
+            True if first word starts within threshold, False otherwise
+        """
+        if not correction_result.corrected_segments:
+            return False
+
+        # Find the first segment with words
+        for segment in correction_result.corrected_segments:
+            if segment.words:
+                first_word_start = segment.words[0].start_time
+                return first_word_start < self.COUNTDOWN_THRESHOLD_SECONDS
+
+        return False
+
+    def _create_padded_audio(self, audio_filepath: str) -> str:
+        """
+        Create a new audio file with silence prepended.
+
+        Args:
+            audio_filepath: Path to original audio file
+
+        Returns:
+            Path to padded audio file
+
+        Raises:
+            FileNotFoundError: If input audio file doesn't exist
+            RuntimeError: If ffmpeg command fails
+        """
+        if not os.path.isfile(audio_filepath):
+            raise FileNotFoundError(f"Audio file not found: {audio_filepath}")
+
+        # Create output path in cache directory
+        # Always use .flac extension since we encode with FLAC codec for quality
+        basename = os.path.basename(audio_filepath)
+        name, _ = os.path.splitext(basename)
+        padded_filename = f"{name}_padded.flac"
+        padded_filepath = os.path.join(self.cache_dir, padded_filename)
+
+        self.logger.info(f"Creating padded audio file: {padded_filename}")
+
+        # Build ffmpeg command to prepend silence
+        # We use the anullsrc filter to generate silence and concat it with the original audio
+        cmd = [
+            "ffmpeg",
+            "-y",  # Overwrite output file if it exists
+            "-hide_banner",
+            "-loglevel", "error",
+            "-f", "lavfi",
+            "-t", str(self.COUNTDOWN_PADDING_SECONDS),
+            "-i", f"anullsrc=channel_layout=stereo:sample_rate=44100",
+            "-i", audio_filepath,
+            "-filter_complex", "[0:a][1:a]concat=n=2:v=0:a=1[out]",
+            "-map", "[out]",
+            "-c:a", "flac",  # Use FLAC to preserve quality
+            padded_filepath,
+        ]
+
+        try:
+            self.logger.debug(f"Running ffmpeg command: {' '.join(cmd)}")
+            output = subprocess.check_output(
+                cmd,
+                stderr=subprocess.STDOUT,
+                universal_newlines=True
+            )
+            self.logger.debug(f"ffmpeg output: {output}")
+
+            if not os.path.isfile(padded_filepath):
+                raise RuntimeError(
+                    f"ffmpeg command succeeded but output file not created: {padded_filepath}"
+                )
+
+            return padded_filepath
+
+        except subprocess.CalledProcessError as e:
+            self.logger.error(f"Failed to create padded audio: {e.output}")
+            raise RuntimeError(f"ffmpeg command failed: {e.output}")
+
+    def _add_countdown_to_result(self, correction_result: CorrectionResult) -> CorrectionResult:
+        """
+        Create a new CorrectionResult with countdown segment and adjusted timestamps.
+
+        Args:
+            correction_result: The original correction result
+
+        Returns:
+            A new CorrectionResult with countdown and shifted timestamps
+        """
+        # Deep copy the result to avoid modifying the original
+        modified_result = deepcopy(correction_result)
+
+        # Shift all timestamps in corrected_segments
+        self._shift_segments_timestamps(
+            modified_result.corrected_segments,
+            self.COUNTDOWN_PADDING_SECONDS
+        )
+
+        # Shift timestamps in resized_segments if they exist
+        if modified_result.resized_segments:
+            self._shift_segments_timestamps(
+                modified_result.resized_segments,
+                self.COUNTDOWN_PADDING_SECONDS
+            )
+
+        # Create and prepend countdown segment
+        countdown_segment = self._create_countdown_segment()
+        modified_result.corrected_segments.insert(0, countdown_segment)
+
+        # Also add to resized_segments if present
+        if modified_result.resized_segments:
+            modified_result.resized_segments.insert(0, countdown_segment)
+
+        self.logger.debug(
+            f"Added countdown segment and shifted {len(modified_result.corrected_segments)} segments "
+            f"by {self.COUNTDOWN_PADDING_SECONDS}s"
+        )
+
+        return modified_result
+
+    def _shift_segments_timestamps(
+        self,
+        segments: List[LyricsSegment],
+        offset_seconds: float
+    ) -> None:
+        """
+        Shift all timestamps in segments by the given offset (in-place).
+
+        Args:
+            segments: List of segments to modify
+            offset_seconds: Amount to shift timestamps (in seconds)
+        """
+        for segment in segments:
+            # Shift segment timestamps
+            segment.start_time += offset_seconds
+            segment.end_time += offset_seconds
+
+            # Shift all word timestamps
+            for word in segment.words:
+                word.start_time += offset_seconds
+                word.end_time += offset_seconds
+
+    def _create_countdown_segment(self) -> LyricsSegment:
+        """
+        Create a countdown segment with the countdown text.
+
+        Returns:
+            A LyricsSegment containing the countdown
+        """
+        # Create a single word for the countdown text
+        countdown_word = Word(
+            id=WordUtils.generate_id(),
+            text=self.COUNTDOWN_TEXT,
+            start_time=self.COUNTDOWN_START_TIME,
+            end_time=self.COUNTDOWN_END_TIME,
+            confidence=1.0,
+            created_during_correction=True,
+        )
+
+        # Create the segment
+        countdown_segment = LyricsSegment(
+            id=WordUtils.generate_id(),
+            text=self.COUNTDOWN_TEXT,
+            words=[countdown_word],
+            start_time=self.COUNTDOWN_START_TIME,
+            end_time=self.COUNTDOWN_END_TIME,
+        )
+
+        return countdown_segment
+

lyrics_transcriber/output/generator.py

@@ -0,0 +1,257 @@
+from dataclasses import dataclass
+import os
+import logging
+from typing import List, Optional
+import json
+
+from lyrics_transcriber.types import LyricsData
+from lyrics_transcriber.correction.corrector import CorrectionResult
+from lyrics_transcriber.output.plain_text import PlainTextGenerator
+from lyrics_transcriber.output.lyrics_file import LyricsFileGenerator
+from lyrics_transcriber.output.subtitles import SubtitlesGenerator
+from lyrics_transcriber.output.video import VideoGenerator
+from lyrics_transcriber.output.segment_resizer import SegmentResizer
+from lyrics_transcriber.output.cdg import CDGGenerator
+from lyrics_transcriber.core.config import OutputConfig
+
+
+@dataclass
+class OutputPaths:
+    """Holds paths for generated output files."""
+
+    lrc: Optional[str] = None
+    ass: Optional[str] = None
+    video: Optional[str] = None
+    original_txt: Optional[str] = None
+    corrected_txt: Optional[str] = None
+    corrections_json: Optional[str] = None
+    cdg: Optional[str] = None
+    mp3: Optional[str] = None
+    cdg_zip: Optional[str] = None
+
+
+class OutputGenerator:
+    """Handles generation of various lyrics output formats."""
+
+    def __init__(
+        self,
+        config: OutputConfig,
+        logger: Optional[logging.Logger] = None,
+        preview_mode: bool = False,
+    ):
+        """
+        Initialize OutputGenerator with configuration.
+
+        Args:
+            config: OutputConfig instance with required paths and settings
+            logger: Optional logger instance
+            preview_mode: Boolean indicating if the generator is in preview mode
+        """
+        self.config = config
+        self.logger = logger or logging.getLogger(__name__)
+
+        self.logger.info(f"Initializing OutputGenerator with config: {self.config}")
+
+        # Load output styles from JSON if provided
+        if self.config.output_styles_json and os.path.exists(self.config.output_styles_json):
+            try:
+                with open(self.config.output_styles_json, "r") as f:
+                    self.config.styles = json.load(f)
+                self.logger.debug(f"Loaded output styles from: {self.config.output_styles_json}")
+            except Exception as e:
+                if self.config.render_video or self.config.generate_cdg:
+                    # Only raise error for video/CDG since they require styles
+                    raise ValueError(f"Failed to load output styles file: {str(e)}")
+                else:
+                    # For other outputs, just log warning and continue with empty styles
+                    self.logger.warning(f"Failed to load output styles file: {str(e)}")
+                    self.config.styles = {}
+        else:
+            # No styles file provided or doesn't exist
+            if self.config.render_video or self.config.generate_cdg:
+                raise ValueError(f"Output styles file required for video/CDG generation but not found: {self.config.output_styles_json}")
+            else:
+                self.config.styles = {}
+
+        # Set video resolution parameters
+        self.video_resolution_num, self.font_size, self.line_height = self._get_video_params(self.config.video_resolution)
+        self.logger.info(f"Video resolution: {self.video_resolution_num}, font size: {self.font_size}, line height: {self.line_height}")
+
+        # Initialize generators
+        self.plain_text = PlainTextGenerator(self.config.output_dir, self.logger)
+        self.lyrics_file = LyricsFileGenerator(self.config.output_dir, self.logger)
+
+        if self.config.generate_cdg:
+            self.cdg = CDGGenerator(self.config.output_dir, self.logger)
+
+        self.preview_mode = preview_mode
+        if self.config.render_video:
+            # Apply preview mode scaling if needed
+            if self.preview_mode:
+                # Scale down from 4K (2160p) to 360p - factor of 1/6
+                scale_factor = 1 / 6
+
+                # Scale down top padding for preview if it exists
+                if "karaoke" in self.config.styles and "top_padding" in self.config.styles["karaoke"]:
+                    self.logger.info(f"Preview mode: Found top_padding: {self.config.styles['karaoke']['top_padding']}")
+                    original_padding = self.config.styles["karaoke"]["top_padding"]
+                    if original_padding is not None:
+                        # Scale down from 4K (2160p) to 360p - factor of 1/6
+                        self.config.styles["karaoke"]["top_padding"] = original_padding * scale_factor
+                        self.logger.info(f"Preview mode: Scaled down top_padding to: {self.config.styles['karaoke']['top_padding']}")
+
+                # Scale down font size for preview if it exists
+                if "karaoke" in self.config.styles and "font_size" in self.config.styles["karaoke"]:
+                    self.logger.info(f"Preview mode: Found font_size: {self.config.styles['karaoke']['font_size']}")
+                    original_font_size = self.config.styles["karaoke"]["font_size"]
+                    if original_font_size is not None:
+                        # Scale down from 4K (2160p) to 360p - factor of 1/6
+                        self.font_size = original_font_size * scale_factor
+                        self.config.styles["karaoke"]["font_size"] = self.font_size
+                        self.logger.info(f"Preview mode: Scaled down font_size to: {self.font_size}")
+
+        # Get max_line_length from styles if available, otherwise use config default
+        max_line_length = self.config.styles.get("karaoke", {}).get("max_line_length", self.config.default_max_line_length)
+        self.logger.info(f"Using max_line_length: {max_line_length}")
+        self.segment_resizer = SegmentResizer(max_line_length=max_line_length, logger=self.logger)
+
+        if self.config.render_video:
+            # Initialize subtitle generator with potentially scaled values
+            self.subtitle = SubtitlesGenerator(
+                output_dir=self.config.output_dir,
+                video_resolution=self.video_resolution_num,
+                font_size=self.font_size,
+                line_height=self.line_height,
+                styles=self.config.styles,
+                subtitle_offset_ms=self.config.subtitle_offset_ms,
+                logger=self.logger,
+            )
+
+            self.video = VideoGenerator(
+                output_dir=self.config.output_dir,
+                cache_dir=self.config.cache_dir,
+                video_resolution=self.video_resolution_num,
+                styles=self.config.styles,
+                logger=self.logger,
+            )
+
+        # Log the configured directories
+        self.logger.debug(f"Initialized OutputGenerator with output_dir: {self.config.output_dir}")
+        self.logger.debug(f"Using cache_dir: {self.config.cache_dir}")
+
+    def generate_outputs(
+        self,
+        transcription_corrected: Optional[CorrectionResult],
+        lyrics_results: dict[str, LyricsData],
+        output_prefix: str,
+        audio_filepath: str,
+        artist: Optional[str] = None,
+        title: Optional[str] = None,
+    ) -> OutputPaths:
+        """Generate all requested output formats."""
+        outputs = OutputPaths()
+
+        try:
+            # Only process transcription-related outputs if we have transcription data
+            if transcription_corrected:
+
+                # Resize corrected segments
+                resized_segments = self.segment_resizer.resize_segments(transcription_corrected.corrected_segments)
+                transcription_corrected.resized_segments = resized_segments
+
+                # For preview, we only need to generate ASS and video
+                if self.preview_mode:
+                    # Generate ASS subtitles for preview
+                    outputs.ass = self.subtitle.generate_ass(transcription_corrected.resized_segments, output_prefix, audio_filepath)
+
+                    # Generate preview video
+                    outputs.video = self.video.generate_preview_video(outputs.ass, audio_filepath, output_prefix)
+
+                    return outputs
+
+                # Normal output generation (non-preview mode)
+                # Generate plain lyrics files for each provider
+                for name, lyrics_data in lyrics_results.items():
+                    self.plain_text.write_lyrics(lyrics_data, output_prefix)
+
+                # Write original (uncorrected) transcription
+                outputs.original_txt = self.plain_text.write_original_transcription(transcription_corrected, output_prefix)
+
+                outputs.corrections_json = self.write_corrections_data(transcription_corrected, output_prefix)
+
+                # Write corrected lyrics as plain text
+                outputs.corrected_txt = self.plain_text.write_corrected_lyrics(resized_segments, output_prefix)
+
+                # Generate LRC using LyricsFileGenerator
+                outputs.lrc = self.lyrics_file.generate_lrc(resized_segments, output_prefix)
+
+                # Generate CDG file if requested
+                if self.config.generate_cdg:
+                    outputs.cdg, outputs.mp3, outputs.cdg_zip = self.cdg.generate_cdg(
+                        segments=resized_segments,
+                        audio_file=audio_filepath,
+                        title=title or output_prefix,
+                        artist=artist or "",
+                        cdg_styles=self.config.styles["cdg"],
+                    )
+
+                # Generate video if requested
+                if self.config.render_video:
+                    # Generate ASS subtitles
+                    outputs.ass = self.subtitle.generate_ass(resized_segments, output_prefix, audio_filepath)
+                    outputs.video = self.video.generate_video(outputs.ass, audio_filepath, output_prefix)
+
+            return outputs
+
+        except Exception as e:
+            self.logger.error(f"Failed to generate outputs: {str(e)}")
+            raise
+
+    def _get_output_path(self, output_prefix: str, extension: str) -> str:
+        """Generate full output path for a file."""
+        return os.path.join(self.config.output_dir or self.config.cache_dir, f"{output_prefix}.{extension}")
+
+    def _get_video_params(self, resolution: str) -> tuple:
+        """Get video parameters: (width, height), font_size, line_height based on video resolution config."""
+        # Get resolution dimensions
+        resolution_map = {
+            "4k": (3840, 2160),
+            "1080p": (1920, 1080),
+            "720p": (1280, 720),
+            "360p": (640, 360),
+        }
+
+        if resolution not in resolution_map:
+            raise ValueError("Invalid video_resolution value. Must be one of: 4k, 1080p, 720p, 360p")
+
+        resolution_dims = resolution_map[resolution]
+
+        # Default font sizes for each resolution
+        default_font_sizes = {
+            "4k": 250,
+            "1080p": 120,
+            "720p": 100,
+            "360p": 40,
+        }
+
+        # Get font size from styles if available, otherwise use default
+        font_size = self.config.styles.get("karaoke", {}).get("font_size", default_font_sizes[resolution])
+
+        # Line height matches font size for all except 360p
+        line_height = 50 if resolution == "360p" else font_size
+
+        return resolution_dims, font_size, line_height
+
+    def write_corrections_data(self, correction_result: CorrectionResult, output_prefix: str) -> str:
+        """Write corrections data to JSON file."""
+        self.logger.info("Writing corrections data JSON")
+        output_path = self._get_output_path(f"{output_prefix} (Lyrics Corrections)", "json")
+
+        try:
+            with open(output_path, "w", encoding="utf-8") as f:
+                json.dump(correction_result.to_dict(), f, indent=2, ensure_ascii=False)
+            self.logger.info(f"Corrections data JSON generated: {output_path}")
+            return output_path
+        except Exception as e:
+            self.logger.error(f"Failed to write corrections data JSON: {str(e)}")
+            raise

lyrics_transcriber/output/lrc_to_cdg.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+
+import logging
+import argparse
+import json
+import sys
+from pathlib import Path
+
+from lyrics_transcriber.output.cdg import CDGGenerator
+
+logger = logging.getLogger(__name__)
+
+
+def cli_main():
+    """Command-line interface entry point for the lrc2cdg tool."""
+    logging.basicConfig(level=logging.DEBUG, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+
+    parser = argparse.ArgumentParser(description="Convert LRC file to CDG")
+    parser.add_argument("lrc_file", help="Path to the LRC file")
+    parser.add_argument("audio_file", help="Path to the audio file")
+    parser.add_argument("--title", required=True, help="Title of the song")
+    parser.add_argument("--artist", required=True, help="Artist of the song")
+    parser.add_argument("--style_params_json", required=True, help="Path to JSON file containing CDG style configuration")
+
+    args = parser.parse_args()
+
+    try:
+        with open(args.style_params_json, "r") as f:
+            style_params = json.loads(f.read())
+            cdg_styles = style_params["cdg"]
+    except FileNotFoundError:
+        logger.error(f"Style configuration file not found: {args.style_params_json}")
+        sys.exit(1)
+    except json.JSONDecodeError as e:
+        logger.error(f"Invalid JSON in style configuration file: {e}")
+        sys.exit(1)
+
+    try:
+        output_dir = str(Path(args.lrc_file).parent)
+        generator = CDGGenerator(output_dir=output_dir, logger=logger)
+
+        cdg_file, mp3_file, zip_file = generator.generate_cdg_from_lrc(
+            lrc_file=args.lrc_file,
+            audio_file=args.audio_file,
+            title=args.title,
+            artist=args.artist,
+            cdg_styles=cdg_styles,
+        )
+
+        logger.info(f"Generated files:\nCDG: {cdg_file}\nMP3: {mp3_file}\nZIP: {zip_file}")
+
+    except ValueError as e:
+        logger.error(f"Invalid style configuration: {e}")
+        sys.exit(1)
+    except Exception as e:
+        logger.error(f"Error generating CDG: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    cli_main()