Compare commits

...
Author SHA1 Message Date
Andrew Beveridge ddc4460065 chore: update flacfetch submodule to v0.7.3 2025-12-21 21:31:40 -05:00
Andrew Beveridge b0f3d15112 feat: configure flacfetch remote service via secrets
- Add flacfetch-api-url secret to infrastructure (stores VM IP as secret)
- Add FLACFETCH_API_URL and FLACFETCH_API_KEY to Cloud Run deployment
- Both values pulled from Secret Manager (no IPs in repo)
2025-12-21 21:31:35 -05:00
Andrew Beveridge 753499db01 chore: Update flacfetch submodule to feature/http-api branch
Updates submodule to include HTTP API implementation.
2025-12-20 17:38:38 -05:00
Andrew Beveridge 1b6e682860 feat: Add flacfetch HTTP API for torrent downloads
This commit implements a dedicated flacfetch HTTP API service to handle
torrent downloads from private trackers (Redacted, OPS), replacing the
non-functional Transmission daemon in Cloud Run.

## Flacfetch API (v0.5.0)
- Add FastAPI-based HTTP API module (flacfetch/api/)
- Implement endpoints: /search, /download, /torrents, /health
- Add API key authentication (X-API-Key header)
- Add download manager with progress tracking and GCS uploads
- Add disk manager with automatic cleanup by oldest/largest/ratio
- Add keep_seeding mode to TorrentDownloader
- Add 'serve' CLI subcommand for running API server
- Add [api] optional dependencies (FastAPI, Uvicorn, httpx, GCS)
- Add comprehensive unit tests (158 tests, 57% coverage)

## Infrastructure (Pulumi)
- Add flacfetch VM (e2-small) with static IP for tracker whitelist
- Add firewall rules for BitTorrent (51413) and API (8080)
- Add service account with GCS and Secret Manager permissions
- Add startup script for automated deployment

## Backend Integration
- Add FlacfetchClient for remote API communication
- Update AudioSearchService to use remote flacfetch when configured
- Add FLACFETCH_API_URL and FLACFETCH_API_KEY config
- Add flacfetch health check to /health/detailed endpoint

## Backend Cleanup
- Remove Transmission daemon from Dockerfile.base
- Remove startup script with transmission-daemon
- Simplify CMD to direct uvicorn invocation

Closes #torrent-service-implementation
2025-12-20 17:37:38 -05:00
Andrew Beveridge ☄️ 9baba12280 Merge pull request #40 from nomadkaraoke/feat/interruptible-download-with-cleanup
feat: Add interruptible download with Ctrl+C support and torrent cleanup
2025-12-20 15:06:41 -05:00
Andrew Beveridge 24b7b75ab2 feat: Add torrent service plan and improve test coverage to 70%+
- Add docs/00-current-plan/TORRENT-SERVICE-PLAN.md with detailed implementation plan
- Add 8 tests for JobMonitor._show_download_progress()
- Add test for _check_interrupt() function
- Add test for AudioSearchResult.to_dict() with full Release fields
- Add test for interactive_select fallback on CLIHandler error
- Add test coverage for AudioSearchResult.from_dict() with seeders/target_file
- Coverage increased from 69.51% to 70.15%
2025-12-20 14:57:03 -05:00
Andrew Beveridge 0b59b7abfc feat: Add verbose download progress to remote CLI
- Remote CLI now shows detailed torrent progress during download_audio status
- Health endpoint returns detailed torrent info (progress, peers, speed, stalled)
- CLI polls health endpoint every 5s during download and shows:
  - Progress percentage
  - Download speed
  - Peer count
  - Stalled warning when no peers connected
- Helps diagnose issues like Cloud Run torrent connectivity problems
2025-12-20 14:33:47 -05:00
Andrew Beveridge 942cbb4f66 feat: Add interruptible download with Ctrl+C support and torrent cleanup
- Wrap torrent downloads in _interruptible_download() to handle Ctrl+C
- Check for interrupt every 200ms during download
- Clean up incomplete torrents from Transmission when cancelled
- Add _cleanup_transmission_torrents() to remove matching incomplete torrents
- Fix empty filepath check (use 'not filepath' instead of 'is None')
- Add BASE_IMAGE arg to Dockerfile for local testing
- Add comprehensive tests for interruptible download and cleanup (10 new tests)
2025-12-20 14:25:48 -05:00
Andrew Beveridge 96383a60d4 Deleted flacfetch code from this repo 2025-12-20 13:45:05 -05:00
Andrew Beveridge 0cf14be531 fix: Rebuild base image when Dockerfile.base changes (not just poetry.lock)
CI was only checking poetry.lock hash to decide if base image needs rebuild.
Now it checks a combined hash of poetry.lock + Dockerfile.base, so changes
to the Dockerfile (like adding Transmission) will trigger a rebuild.

- Update CI to hash both files
- Update cloudbuild-base.yaml to use new combined hash
- Update Dockerfile.base label to base.content.hash
- Bump version to 0.73.3
2025-12-20 13:44:36 -05:00
Andrew Beveridge 95edd82555 Merge branch 'backend-parity-fixes-one' 2025-12-20 13:39:11 -05:00
Andrew Beveridge 6e02ca3056 feat: Add Transmission daemon for tracker downloads on Cloud Run
- Install transmission-daemon in base Docker image
- Add startup script to launch Transmission before uvicorn
- Add _check_transmission_available() to only enable tracker providers
  when Transmission is actually available (graceful fallback to YouTube)
- Add /api/health/detailed endpoint to check Transmission status
- Add comprehensive tests for Transmission availability checking
- Bump version to 0.73.2
2025-12-20 13:38:24 -05:00
Andrew Beveridge ☄️ 966e8cc963 Merge pull request #38 from nomadkaraoke/backend-parity-fixes-one
feat: Add flacfetch API keys to cloud backend and improve audio selection display
2025-12-20 03:28:04 -05:00
Andrew Beveridge 04b1c8fd3e fix: Fix failing tests after flacfetch refactor
- Add create_test_release helper to create real Release objects for tests
- Update interactive_select tests to use real Release objects instead of MagicMocks
  (flacfetch's print_releases does type comparisons that fail with MagicMock)
- Update test assertions to match flacfetch's CLIHandler output messages
- Update test_cli_handler_works_with_real_releases to use format_release_line
2025-12-20 03:18:28 -05:00
Andrew Beveridge f47b126c08 fix: Address CodeRabbit review comments
- Fix undefined print_search_results in _basic_interactive_select (use flacfetch.print_releases)
- Remove unused title variable in handle_audio_selection
2025-12-20 03:07:36 -05:00
Andrew Beveridge 4438293b6d chore: Remove unnecessary backwards compatibility wrappers 2025-12-20 02:59:46 -05:00
Andrew Beveridge de4e92d9bf Updated flacfetch 2025-12-20 02:53:11 -05:00
Andrew Beveridge e7f88b60d0 refactor: Use flacfetch's shared display functions for audio selection
- Updated karaoke-gen to use flacfetch's print_releases and format_release_line
- Remote CLI now converts API results to Release-compatible dicts for display
- Backend API now returns full Release data for rich display on remote CLI
- Simplified audio_fetcher.py to wrap flacfetch functions instead of duplicating
- This ensures consistent, colorized output between local and remote CLIs
2025-12-20 02:38:09 -05:00
Andrew Beveridge fbb1cd7299 feat: Add flacfetch API keys to cloud backend and improve audio selection display
- Add REDACTED_API_KEY and OPS_API_KEY secrets to infrastructure (Pulumi)
- Update cloudbuild.yaml to pass secrets as env vars to Cloud Run
- Add seeders and target_file fields to AudioSearchResult
- Create shared format_search_result_line() and print_search_results() functions
- Update remote CLI to use shared formatting (consistent with local CLI)
- Add artist/title to /results endpoint response for header display
- Color-coded providers, seeder counts, and quality in selection display

This enables flacfetch audio search to work in cloud backend (search Redacted/OPS
trackers, not just YouTube) and provides rich, informative output matching local CLI.
2025-12-20 02:14:25 -05:00
Andrew Beveridge ☄️ 77820a44c9 Merge pull request #37 from nomadkaraoke/update-deps
Update deps
2025-12-20 02:02:50 -05:00
Andrew Beveridge e92ddd8609 Updated dependencies, bumped version 2025-12-20 01:50:27 -05:00
Andrew Beveridge a2bf2230ab Merge branch 'main' of github.com:nomadkaraoke/karaoke-gen 2025-12-20 01:49:33 -05:00
Andrew Beveridge 75c6879b7e Added codecov, bumped for release 2025-12-20 01:49:01 -05:00
Andrew Beveridge ☄️ f51ef68179 Merge pull request #36 from nomadkaraoke/refactor/unify-audio-fetcher
refactor: Unify audio fetcher code between local CLI and backend
2025-12-20 01:33:44 -05:00
Andrew Beveridge 8a5420f5f8 test: Add comprehensive tests for audio_fetcher new features
Add tests for:
- AudioSearchResult.to_dict() and from_dict() methods
- AudioSearchResult.index field
- AudioFetchResult.to_dict() and from_dict() methods
- FlacFetchAudioFetcher.select_best() method
- FlacFetcher alias
- search() setting index on results
- Roundtrip serialization tests
- Edge cases (empty lists, missing fields, exception handling)

These tests improve coverage for the code sharing between
local CLI and cloud backend.
2025-12-20 01:23:27 -05:00
Andrew Beveridge c9b7f1bb1a refactor: Unify audio fetcher code between local CLI and backend
This eliminates code duplication between karaoke_gen/audio_fetcher.py
and backend/services/audio_search_service.py.

Changes:
- Add to_dict()/from_dict() methods to AudioSearchResult and AudioFetchResult
- Add select_best() standalone method to FlacFetcher
- Add index field to AudioSearchResult for API selection
- Add FlacFetcher alias for FlacFetchAudioFetcher
- Refactor backend AudioSearchService to delegate to karaoke_gen.audio_fetcher
- Update karaoke_gen/__init__.py with lazy imports to avoid heavy dependencies
- Update backend tests to work with shared classes
- Add integration tests verifying shared classes are identical

Benefits:
- Single source of truth for flacfetch integration
- ~150 lines of duplicate code removed from backend
- Bug fixes apply everywhere automatically
- Prevents future divergence like YouTubeProvider -> YoutubeProvider

Resolves: docs/00-current-plan/REFACTOR-AUDIO-FETCHER.md
2025-12-20 01:12:50 -05:00
Andrew Beveridge d9da1dd360 docs: Add audio fetcher refactoring plan to eliminate code duplication
Proposes unifying backend/services/audio_search_service.py with
karaoke_gen/audio_fetcher.py to prevent future bugs like the
YouTubeProvider -> YoutubeProvider rename issue.
2025-12-20 01:05:18 -05:00
Andrew Beveridge a8fa6b5f46 test: Add flacfetch integration tests to catch import errors
These tests verify the actual flacfetch imports work, not just mocks.
Would have caught the YouTubeProvider -> YoutubeProvider rename.
2025-12-20 01:01:51 -05:00
Andrew Beveridge ebe0121938 fix: Update YoutubeProvider import in backend audio_search_service.py
The flacfetch 0.2.0 renamed YouTubeProvider to YoutubeProvider (lowercase 'tube').
PR #28 fixed this in karaoke_gen/audio_fetcher.py but missed the backend version.

This caused 'flacfetch library is not installed' errors when using the
audio search feature remotely, even though flacfetch was actually installed.

The ImportError from the renamed class was being caught and converted to
the generic 'not installed' error message.
2025-12-20 01:00:22 -05:00
Andrew Beveridge ☄️ 01db9a764a fix: countdown padding synchronization for instrumental audio (#35)
When LyricsTranscriber adds 3-second countdown padding to vocals,
the instrumental audio must be padded to match. This was broken when
transcription was skipped due to existing files.

Changes:
- Add _detect_countdown_padding_from_lrc() to detect padding from existing LRC
- Update early returns in transcribe_lyrics() to include padding info
- Add _scan_directory_for_instrumentals() to find existing instrumentals
- Fix counting bug in apply_countdown_padding_to_instrumentals
- Add countdown_padding_seconds safety net to KaraokeFinalise
- Store padding metadata in lyrics_worker job state_data
- Pass padding info to video_worker for instrumental sync
- Add comprehensive unit tests for new functionality
2025-12-19 18:49:03 -05:00
Andrew Beveridge ☄️ f524796f7f Merge pull request #14 from nomadkaraoke/feature/batch-6-two-phase-workflow
feat: Batch 6 - Two-Phase Workflow (prep-only, finalise-only, keep-brand-code)
2025-12-19 00:07:15 -05:00
Andrew Beveridge ☄️ 8372ed211a Merge pull request #34 from nomadkaraoke/fix/youtube-duplicate-checker-channel-filter
Fix YouTube duplicate checker returning videos from other channels
2025-12-19 00:06:11 -05:00
Andrew Beveridge 78068ea1d8 Fix YouTube duplicate checker returning videos from other channels
The YouTube Data API v3 search endpoint's channelId parameter doesn't
always filter correctly and sometimes returns videos from other channels.

This fix verifies each search result's snippet.channelId matches the
user's channel ID before considering it as a potential match, preventing
false positives from unrelated videos with similar titles.

Added tests for the channel filtering behavior.
2025-12-18 23:28:23 -05:00
Andrew Beveridge 84d7c12f13 fix: Address CodeRabbit review comments for Batch 6 PR
- Add PREP_COMPLETE to RENDERING_VIDEO state transitions (job.py)
- Simplify instrumental detection logic for consistency (remote_cli.py)
- Add shell escaping (shlex.quote) for continuation command display (remote_cli.py)
- Update test for --finalise-only now that it's implemented (test_remote_cli.py)
- Add test for PREP_COMPLETE status (test_remote_cli.py)
- Bump version to 0.71.69
2025-12-18 23:22:05 -05:00
Andrew Beveridge 7a4ed9661c Merge origin/main into feature/batch-6-two-phase-workflow 2025-12-18 22:42:49 -05:00
Andrew Beveridge ☄️ dd62c32026 Merge pull request #33 from nomadkaraoke/fix/uploaded-instrumental-selection
Fix: Handle 'uploaded' selection in instrumental review CLI
2025-12-18 21:35:28 -05:00
Andrew Beveridge c130fa8a07 Merge remote-tracking branch 'origin/main' into fix/uploaded-instrumental-selection 2025-12-18 20:24:14 -05:00
Andrew Beveridge ☄️ e0d1fa7536 Merge pull request #32 from nomadkaraoke/replicate-midico-synchronizer
feat: Add MidiCo-style lyrics synchronizer for re-syncing existing lyrics
2025-12-18 20:23:47 -05:00
Andrew Beveridge 29ffbd4ae2 fix: handle 'uploaded' selection in instrumental review CLI
The instrumental review UI supports uploading custom instrumental files,
but gen_cli.py was missing the handler for the 'uploaded' selection type.

When a user uploaded a custom instrumental and selected it, the CLI would
log 'Unknown selection: uploaded' and crash with an unhelpful error message.

This fix adds proper handling for the 'uploaded' case, retrieving the
uploaded file path from the server just like the 'custom' case does.
2025-12-18 20:21:00 -05:00
Andrew Beveridge e440f0bbcd fix: Address CodeRabbit review comments
- Fix word move timing bug: ensure end time is always after start time
  (prevents invalid timings where end < start with very negative deltas)
- Add typeof checks before calling window methods for runtime type safety
2025-12-18 20:13:13 -05:00
Andrew Beveridge e0f5a84e54 feat: Add MidiCo-style lyrics synchronizer for re-syncing existing lyrics
Implements a new synchronizer UI that closely replicates MidiCo's UX:

- Mode selection modal: Choose between "Re-sync Existing Lyrics" or "Replace All Lyrics"
- Canvas-based timeline for high-performance word block rendering
- Two-level alternating segment layout to prevent text overlap
- Spacebar sync mode: tap for short words, hold for longer words
- Current word highlighting (red text + brighter block)
- Word block manipulation:
  - Resize words by dragging handle on right edge
  - Drag to move single or multiple selected words
- Scroll/zoom controls for timeline navigation
- Play/Stop/Pause controls for audio playback
- "Unsync from Cursor" to re-sync only the drifted portion
- Fixed-height layout sections to prevent UI jumping during sync

This addresses the core problem of lyrics that start well-synced but drift
progressively out of sync in the second half of a song.
2025-12-18 19:59:08 -05:00
Andrew Beveridge 8da57da767 Added reference doc explaining the plan to replace our "Edit All" functionality with something much more closely aligned with MidiCo functionality 2025-12-18 16:27:59 -05:00
Andrew Beveridge b840a12669 Added midico synchronizer reference guide 2025-12-18 16:02:19 -05:00
Andrew Beveridge ☄️ f7038ce72c Merge pull request #31 from nomadkaraoke/fix/ctrlc-audio-fetcher
Ensure we can quit during audio fetch
2025-12-18 12:04:35 -05:00
Andrew Beveridge 138ddeecf5 Ensure we can quit during audio fetch 2025-12-18 11:46:33 -05:00
Andrew Beveridge ☄️ a7d9bb40b9 Merge pull request #30 from nomadkaraoke/feature/local-review-ui
Support local review UI for frontend development
2025-12-18 02:16:55 -05:00
Andrew Beveridge ☄️ 20f842fa85 Merge pull request #29 from nomadkaraoke/feature/annotation-toggle
Add toggle to disable annotation prompts when editing lyrics
2025-12-18 02:07:51 -05:00
Andrew Beveridge 1b74199032 Default to bundled local frontend for lyrics review
- Change default from hosted https://lyrics.nomadkaraoke.com to local
- Local karaoke-gen now uses bundled frontend served by FastAPI
- No external dependency for local runs
- Can override with LYRICS_REVIEW_UI_URL env var if needed:
  - 'local' (default): bundled frontend at http://localhost:8000
  - 'http://localhost:5173': Vite dev server for frontend development
  - 'https://lyrics.nomadkaraoke.com': hosted version (legacy)

Also includes rebuilt frontend assets with annotation toggle feature.

Version bump: 0.71.65 -> 0.71.66
2025-12-18 01:58:53 -05:00
Andrew Beveridge e75c5b2723 Support local review UI for development via --review-ui-url
- Add --review-ui-url argument to local gen_cli (was remote-only)
- Set LYRICS_REVIEW_UI_URL env var from CLI argument
- Allows pointing to local Vite dev server (http://localhost:5173)
- Supports both REVIEW_UI_URL and LYRICS_REVIEW_UI_URL env vars

Usage for local frontend development:
  karaoke-gen --review-ui-url http://localhost:5173 ...

Version bump: 0.71.64 -> 0.71.65
2025-12-18 01:53:34 -05:00
Andrew Beveridge 9e53bb7934 Merge remote-tracking branch 'origin/main' into feature/annotation-toggle 2025-12-18 01:53:10 -05:00
Andrew Beveridge ☄️ a85727b147 Merge pull request #28 from nomadkaraoke/fix-flac-fetcher
Fix flacfetch API compatibility and use rich CLI output
2025-12-18 01:52:32 -05:00
Andrew Beveridge 3eb8f707b6 Add toggle to disable annotation prompts when editing lyrics
- Add "Feedback On/Off" chip in header next to title
- Toggle persists to localStorage for session continuity
- Defaults to enabled (annotation prompts shown)
- Hidden in read-only mode
- Tooltip explains functionality

Version bump: 0.71.63 -> 0.71.64
2025-12-18 01:46:41 -05:00
Andrew Beveridge 4b26fe9eac Add integration tests for flacfetch compatibility
Add comprehensive tests that would have caught both recent bugs:

1. TestGetManagerIntegration - Tests that actually execute _get_manager():
   - test_get_manager_imports_work: Would have caught YouTubeProvider rename
   - test_get_manager_registers_*: Would have caught missing downloader registration

2. TestFlacFetchReleaseModelCompatibility - Tests against real flacfetch models:
   - test_release_model_has_expected_attributes: Verifies attribute names match
   - test_search_converts_release_attributes_correctly: Tests with real Release objects

3. TestFlacFetchCLIHandlerCompatibility - Tests CLIHandler integration:
   - test_cli_handler_import_works: Verifies import path
   - test_cli_handler_works_with_real_releases: Tests with real Quality objects

These tests use real flacfetch classes instead of mocks to catch API changes.

Bump version to 0.71.63
2025-12-18 01:37:00 -05:00
Andrew Beveridge 4de3ecc85d Register downloaders for flacfetch sources
- Register YoutubeDownloader for YouTube source
- Register TorrentDownloader for Redacted and OPS sources
- Handle optional TorrentDownloader import (has extra dependencies)

This fixes "No downloader registered for source: Redacted" error when
trying to download from torrent tracker sources.

Bump version to 0.71.62
2025-12-18 01:32:52 -05:00
Andrew Beveridge cbb4cd8f9e Fix flacfetch API compatibility and use rich CLI output
- Update YouTubeProvider import to YoutubeProvider (API change in flacfetch 0.2.0)
- Update attribute names to match flacfetch Release model:
  - provider -> source_name
  - duration -> duration_seconds
  - url -> download_url
  - id -> info_hash
- Use flacfetch's built-in CLIHandler for rich, colorized interactive selection
- Add fallback to basic display if CLIHandler fails (e.g., in tests)
- Update tests to use correct flacfetch attribute names

Bump version to 0.71.61
2025-12-18 01:25:55 -05:00
Andrew Beveridge ☄️ 218011cf2a Merge pull request #27 from nomadkaraoke/refactor/instrumental-review-ui-improvements
Refactor instrumental review UI: extract frontend to static file and improve UX
2025-12-18 01:22:55 -05:00
Andrew Beveridge 22c6e7ed41 Fix audio listeners not attached after DOM rebuild
Track audio element reference instead of boolean flag to detect when the
audio element is replaced during render(). Re-attach listeners when the
element changes, ensuring new audio elements have proper event handlers.

Version bump: 0.71.59 → 0.71.60
2025-12-18 01:13:19 -05:00
Andrew Beveridge e104fb9252 Add original audio option to instrumental review UI
Backend:
- Add original_audio_path parameter to InstrumentalReviewServer
- Add /api/audio/original endpoint for streaming original audio
- Add "original" to valid selection options

Frontend:
- Add "Original" toggle button (shown first when available)
- Add "Original Audio" selection option with description
- Add original to success message labels

Helper script:
- Find original audio files matching "(Original)" pattern
- Log and pass original_audio_path to server

Version bump: 0.71.58 → 0.71.59
2025-12-18 01:05:11 -05:00
Andrew Beveridge 31931cc55d Address CodeRabbit PR review comments
Frontend (index.html):
- Fix duplicate event listeners: add audioListenersInitialized flag and named
  handlers (onAudioPlay, onAudioPause, onAudioEnded) to prevent accumulation
- Remove redundant removeEventListener in loadeddata handler (already using once: true)
- Use data-audio-type attributes on toggle buttons for robust type detection
- Add escapeHtml() helper to prevent XSS in artist/title/filename interpolation
- Guard updatePlayhead() against NaN/Infinity when duration is 0 or invalid
- Add explicit 'uploaded' branch in success message ternary

Backend (server.py):
- Wrap temp file handling in try/finally to ensure cleanup on error
- Track file_moved state to only unlink temp file if not successfully moved

Version bump: 0.71.57 → 0.71.58
2025-12-18 00:45:55 -05:00
Andrew Beveridge d21729bf3d Fix JavaScript syntax error and improve file discovery in helper script
- Fix invalid escape sequences in updateMuteRegionsPanel() - use string
  concatenation instead of nested template literals
- Update helper script to find instrumental files in main job directory
  (not just stems/) and handle "+BV" naming convention

Version bump: 0.71.56 → 0.71.57
2025-12-18 00:39:07 -05:00
Andrew Beveridge b49a09e1c6 Add helper script to run instrumental review UI from existing job folder
New script: scripts/run_instrumental_review.py
- Takes a karaoke job directory path as input
- Auto-discovers backing vocals, clean instrumental, and combined files in stems/
- Runs audio analysis and generates waveform if needed
- Starts the review server for frontend development iteration

Usage:
  python scripts/run_instrumental_review.py "Artist - Title"
  python scripts/run_instrumental_review.py "path/to/job" --port 9000
  python scripts/run_instrumental_review.py "path/to/job" --no-browser

Version bump: 0.71.55 → 0.71.56
2025-12-18 00:34:41 -05:00
Andrew Beveridge e6b2194272 Preserve scroll position when adding/removing mute regions while zoomed
- Replace full render() calls with targeted updates when modifying mute regions
- Add updateMuteRegionsPanel() to update only the mute panel DOM
- Just redraw waveform canvas instead of rebuilding entire UI
- Scroll position is now preserved when adding, removing, or clearing regions

Version bump: 0.71.54 → 0.71.55
2025-12-18 00:31:51 -05:00
Andrew Beveridge a08b83df40 Add custom instrumental upload and waveform zoom features
Upload feature:
- Add POST /api/jobs/local/upload-instrumental endpoint
- Validate uploaded audio duration matches original (±0.5s tolerance)
- Support .flac, .mp3, .wav, .m4a, .ogg formats
- Show upload progress overlay with spinner
- Auto-select uploaded audio after successful upload
- Add "Uploaded" option to audio toggles and final selection

Zoom feature:
- Add 1x, 2x, 4x zoom levels for waveform precision
- Waveform container is horizontally scrollable when zoomed
- Zoom controls in toolbar with active state indication
- Maintain proportional scroll position when changing zoom
- Playhead and selection overlay work correctly at all zoom levels

Version bump: 0.71.53 → 0.71.54
2025-12-18 00:27:38 -05:00
Andrew Beveridge 53d2ed2828 Fix duplicate audio when switching sources during playback
- Remove full render() call from setActiveAudio() to avoid recreating audio element
- Update toggle button states directly via classList instead of DOM rebuild
- Check actual audio.paused state instead of isPlaying variable (which gets stale)
- Prevents multiple audio streams playing simultaneously

Version bump: 0.71.52 → 0.71.53
2025-12-18 00:10:58 -05:00
Andrew Beveridge ff20b5ffb3 Fix audio playback AbortError when DOM rebuilds during render
- Pause audio before rebuilding DOM in render() to prevent AbortError
- Use loadeddata event to safely restore playback position and state
- Handle audio lifecycle properly in setActiveAudio() and createCustomInstrumental()
- Prevents duplicate audio playback and console errors

Version bump: 0.71.51 → 0.71.52
2025-12-18 00:09:08 -05:00
Andrew Beveridge 49290f94d7 Refactor instrumental review UI: extract frontend to static file and improve UX
- Move inline HTML/CSS/JS from server.py to static/index.html for better maintainability
- Add proper syntax highlighting, formatting, and linting support for frontend code
- Server now reads HTML from file using Path(__file__).parent / "static"

UI/UX improvements:
- Click on waveform now seeks AND starts playback automatically
- Switching audio sources (Backing/Clean/Combined) maintains playback state
- Clearer audio mode labels: "Backing Vocals Only", "Pure Instrumental", "Instrumental + Backing"
- Replace M key toggle mode with Shift+drag for intuitive mute region selection
- Update help text and keyboard hints

Package configuration:
- Add karaoke_gen/instrumental_review/static/* to pyproject.toml includes
- Verified static files are correctly packaged in wheel for pip installs

Version bump: 0.71.48 → 0.71.51
2025-12-18 00:07:13 -05:00
Andrew Beveridge ☄️ 9b114fcb3d Merge pull request #26 from nomadkaraoke/fix/waveform-generator-param-name
fix: correct parameter name in WaveformGenerator.generate() call
2025-12-17 23:34:34 -05:00
Andrew Beveridge e507b3f685 fix: prevent duplicate log messages from external package side effects
External packages like lyrics_converter call logging.info() directly on the
root logger, which triggers Python's 'last resort' handler. This causes log
messages to appear twice: once from our custom handler and once from the
root logger's default handler.

Fixed by setting logger.propagate = False on all loggers that have their
own handlers configured. This prevents logs from propagating to the root
logger while still displaying through our custom formatted handlers.

Affected files:
- karaoke_gen/karaoke_finalise/karaoke_finalise.py
- karaoke_gen/karaoke_gen.py
- karaoke_gen/utils/gen_cli.py
- karaoke_gen/utils/remote_cli.py
- karaoke_gen/utils/bulk_cli.py

Also updated tests to use capsys instead of caplog since caplog relies
on log propagation to capture messages.

Bumps version to 0.71.47
2025-12-17 23:17:29 -05:00
Andrew Beveridge 6d0c765f4d test: add integration tests for run_instrumental_review parameter contract
Added tests that verify:
- WaveformGenerator.generate() is called with 'segments' (not 'audible_segments')
- Correct parameter values are passed between components
- Error handling and edge cases

These tests would have caught the parameter name bug that broke
the instrumental review flow. They exercise the actual function
with properly mocked components instead of mocking the entire function.

Bumps version to 0.71.46
2025-12-17 23:04:51 -05:00
Andrew Beveridge 8086242d38 fix: correct parameter name in WaveformGenerator.generate() call
The WaveformGenerator.generate() method expects 'segments' parameter,
not 'audible_segments'. This caused the instrumental review to fail
with 'unexpected keyword argument' error during karaoke-gen CLI execution.

Bumps version to 0.71.45
2025-12-17 22:56:59 -05:00
Andrew Beveridge ☄️ 3c3680632b Merge pull request #25 from nomadkaraoke/fix/instrumental-selection-single-path
Remove legacy instrumental selection fallback, fix path resolution
2025-12-17 22:23:46 -05:00
Andrew Beveridge dd5f05b291 fix: update integration test to use --skip_instrumental_review
The integration test was failing because it didn't provide the
separated_audio data structure expected by run_instrumental_review.
Since the test uses mocked audio data, it makes sense to use the
--skip_instrumental_review flag with auto_select_instrumental instead.

- Added --skip_instrumental_review to test CLI args
- Updated mock_process_audio_separation to return clean_instrumental
  data structure needed by auto_select_instrumental
- Bumped version to 0.71.44
2025-12-14 13:30:47 -05:00
Andrew Beveridge 36a60c09da Merge origin/main into feature/batch-6-two-phase-workflow
Resolved conflicts to merge Batch 6 (Two-Phase Workflow) with:
- Batch 5 (FlacFetch Audio Search) - Added SEARCHING_AUDIO states
- Instrumental review UI fixes
- Worker logging context improvements

Key merge resolutions:
- job.py: Combined state transitions for SEARCHING_AUDIO and AWAITING_INSTRUMENTAL_SELECTION
- remote_cli.py: Added prep_only/keep_brand_code to both URL and file submission paths
- render_video_worker.py: Added job_logging_context while preserving prep_only transition logic
- file_upload.py: Re-added all finalise-only endpoints and models

All 180 tests pass.
2025-12-14 13:15:10 -05:00
Andrew Beveridge 9340ed5d9f Remove legacy instrumental selection fallback, fix path resolution
This change eliminates the silent fallback to the legacy numbered instrumental
selection in KaraokeFinalise and ensures a single code path for instrumental
selection:

1. **Path resolution fix**: Added `_resolve_path_for_cwd()` helper to correctly
   resolve paths in `separated_audio` after `os.chdir(track_dir)`. The paths
   were stored relative to the original directory, causing `os.path.exists()`
   to fail after the directory change.

2. **No silent fallback**: When `run_instrumental_review()` fails, the CLI now
   exits with a clear error message explaining what went wrong and how to fix
   it, rather than silently falling back to the legacy numbered selection.

3. **Auto-select for non-interactive mode**: Added `auto_select_instrumental()`
   function for `--skip_instrumental_review` mode that intelligently selects
   the best instrumental (preferring padded+combined > padded > combined > clean).

4. **Clear error messages**: When instrumental selection fails, users now get
   detailed diagnostics about what to check and how to recover.

The legacy `choose_instrumental_audio_file()` method in KaraokeFinalise is
preserved for direct usage but is no longer called from the gen_cli flow.

Includes comprehensive tests for the new helper functions.

Bump version to 0.71.43.
2025-12-14 13:10:29 -05:00
Andrew Beveridge ☄️ 8959da63a1 Merge pull request #24 from nomadkaraoke/fix/instrumental-review-path-resolution
Fix instrumental review UI path resolution after chdir
2025-12-14 12:56:07 -05:00
Andrew Beveridge ☄️ cb7b4863f5 Merge pull request #13 from nomadkaraoke/feature/batch-5-flacfetch-audio-search
feat: Batch 5 - Flacfetch audio search for remote CLI
2025-12-14 12:53:45 -05:00
Andrew Beveridge e84a511676 Fix instrumental review UI path resolution after chdir
The instrumental review UI was being skipped with "No backing vocals file
found" because file paths stored in separated_audio were relative to the
original working directory, but os.chdir(track_dir) had already been called
before the paths were checked with os.path.exists().

This fix:
- Adds _resolve_path_for_cwd() helper to convert paths that were created
  relative to the original directory to work from the new current directory
- Applies path resolution to backing_vocals, clean_instrumental, and
  combined_instrumentals paths before checking their existence
- Updates waveform and output paths to use current directory since we're
  already inside track_dir after chdir

Includes unit tests for the new helper function.

Bump version to 0.71.42.
2025-12-11 20:27:11 -05:00
Andrew Beveridge aee2b48ffd Merge origin/main into feature/batch-5-flacfetch-audio-search
Resolved conflicts to combine:
- Batch 4 (YouTube URL input) from main
- Batch 5 (Flacfetch audio search) from this branch

Both features are now fully integrated:
- P2 (YouTube URLs): ✅ COMPLETE
- P3 (Flacfetch search): ✅ COMPLETE
- A1 (--auto-download): ✅ COMPLETE

remote_cli.py now supports:
- File upload mode (original)
- YouTube URL mode (from main)
- Audio search mode (from this branch)

Documentation updated to reflect both batches complete.
Version bumped to 0.71.42.
2025-12-11 20:10:03 -05:00
Andrew Beveridge ☄️ a7652ba72d Merge pull request #23 from nomadkaraoke/fix/local-cli-instrumental-review-integration
fix: integrate instrumental review UI into local CLI workflow
2025-12-11 19:42:21 -05:00
Andrew Beveridge 0ce5225bde fix: integrate instrumental review UI into local CLI workflow
The instrumental review UI was built but never integrated into the
local CLI (karaoke-gen) workflow. This fix:

1. Adds run_instrumental_review() function to gen_cli.py that:
   - Analyzes backing vocals using AudioAnalyzer
   - Generates waveform visualization
   - Starts InstrumentalReviewServer and opens browser
   - Returns the user's selected instrumental file path

2. Integrates the review into the finalization loop:
   - Runs before KaraokeFinalise for each track
   - Passes selected_instrumental_file to KaraokeFinalise
   - Skips review if --skip_instrumental_review flag is set

3. Adds --skip_instrumental_review CLI flag for backwards compatibility

4. Adds comprehensive tests in test_cli_feature_parity.py that verify:
   - gen_cli.py has run_instrumental_review function
   - The function uses AudioAnalyzer, WaveformGenerator, and InstrumentalReviewServer
   - The --skip_instrumental_review flag works correctly

These tests would have caught this integration gap and will prevent
similar regressions in the future.

Version bump: 0.71.40 → 0.71.41
2025-12-11 19:15:37 -05:00
Andrew Beveridge ☄️ c494685211 Merge pull request #22 from nomadkaraoke/feature/instrumental-review-ui
feat: Add intelligent instrumental selection with web-based review UI
2025-12-11 19:01:40 -05:00
Andrew Beveridge 599625e21a fix: address CodeRabbit PR review comments and improve test coverage
CodeRabbit fixes:
- Chain exceptions with 'from e' in jobs.py for proper tracebacks
- Use logger.exception() for automatic stack traces
- Add end_seconds validation warning in audio_editing_service.py
- Handle recommended_selection='with_backing' explicitly in frontend
- Sync audio player state with actual audio element via event listeners
- Fix muted duration stats overcounting by clamping to audio duration
- Add num_points validation (1-10000) in server waveform endpoint
- Improve exception handling in server endpoints

Test coverage improvements:
- Add comprehensive tests for InstrumentalReviewServer
- Test request/response models
- Test server initialization and configuration
- Test FastAPI endpoints with TestClient
- Coverage: karaoke_gen 73.05% (above 70% minimum)

Version bump: 0.71.39 → 0.71.40
2025-12-11 18:33:20 -05:00
Andrew Beveridge 5c4404839b chore: remove unused imports from server.py 2025-12-11 18:09:50 -05:00
Andrew Beveridge f699850d30 feat: rewrite local review server with FastAPI and full-featured standalone UI
- Replace http.server with FastAPI for better async/CORS support
- Add complete standalone HTML/CSS/JS frontend with all features:
  - Dark theme matching React frontend
  - Interactive waveform display with Canvas rendering
  - Audio playback with source selection
  - Region selection via click/drag or quick-add from segments
  - Custom instrumental creation
  - Final selection submission with success feedback
- API endpoints now match cloud backend for true feature parity
- Update CLI parity tests for new FastAPI-based server structure
- Add test-instrumental-review.py script for local testing

This enables the same user experience for instrumental review
whether running locally (karaoke-gen) or remotely (karaoke-gen-remote).

Version bump: 0.71.38 → 0.71.39
2025-12-11 18:08:04 -05:00
Andrew Beveridge e8d9871d3e feat: Add intelligent instrumental selection with web-based review UI
Adds a comprehensive instrumental selection workflow with:
- Audio analysis to detect backing vocals (>-40dB threshold)
- Waveform visualization with segment highlighting
- Interactive web UI for audio playback and region selection
- Custom instrumental creation by muting selected regions
- Smart recommendations based on analysis results
- Feature parity between local (karaoke-gen) and remote (karaoke-gen-remote) CLIs

Key components:
- Shared core module (karaoke_gen/instrumental_review/) with AudioAnalyzer,
  AudioEditor, WaveformGenerator, and InstrumentalReviewServer
- Backend services wrapping core module with GCS integration
- New API endpoints for analysis, audio streaming, and custom creation
- React frontend components for waveform display, audio playback, region selection
- Local HTTP server for browser-based review in local CLI workflow
- 1280 tests passing with comprehensive coverage

Closes the need for manual Audacity editing when selecting instrumentals.
2025-12-11 17:12:49 -05:00
Andrew Beveridge ☄️ 473253b5ab Merge pull request #21 from nomadkaraoke/fix/enable-cloud-tasks-deployment
fix: Enable Cloud Tasks in deployment for scalable architecture
2025-12-11 16:20:00 -05:00
Andrew Beveridge 89cc9e9113 fix: Enable Cloud Tasks in deployment for scalable architecture
The scalable architecture (Cloud Tasks queues, IAM, infrastructure) was
deployed via Pulumi but never activated in the Cloud Run deployment.

Changes:
- Enable ENABLE_CLOUD_TASKS=true environment variable
- Set CLOUD_RUN_SERVICE_URL for Cloud Tasks callbacks
- Set GCP_REGION for queue location consistency
- Change concurrency from 4 to 1 for true container isolation
- Increase max-instances from 10 to 50 for higher throughput

This completes Phase 1 of the scalable architecture migration, ensuring
each job gets dedicated container resources with no contention.
2025-12-11 15:45:03 -05:00
Andrew Beveridge ☄️ ec5a816b68 Merge pull request #20 from nomadkaraoke/anchor-sequence-optimization
feat: Optimize AnchorSequenceFinder for cloud compatibility and performance
2025-12-11 14:37:06 -05:00
Andrew Beveridge 651cbbdbca feat: Batch 5 - Flacfetch audio search for remote CLI
Add support for searching and downloading audio by artist+title in remote mode,
enabling the same functionality as the local CLI's flacfetch integration.

New features:
- `karaoke-gen-remote "Artist" "Title"` - search for audio without providing a file
- `--auto-download` flag for automatic best-quality selection
- `-y` flag also triggers auto-download mode
- Interactive mode displays search results for user selection

Backend changes:
- New AudioSearchService integrating flacfetch library
- New API endpoints: POST /api/audio-search/search, GET /api/audio-search/{job_id}/results, POST /api/audio-search/{job_id}/select
- New job statuses: searching_audio, awaiting_audio_selection, downloading_audio
- Job model extended with audio_search_artist, audio_search_title, auto_download fields

Remote CLI changes:
- Detects artist+title input without file path
- Displays search results interactively
- Handles audio source selection flow
- Supports both interactive and auto-download modes

Tests:
- 20+ unit tests for AudioSearchService and Job model fields
- Tests for state transitions and API response handling

Documentation:
- Updated BACKEND-FEATURE-PARITY-PLAN.md with batch 5 status

Version bump: 0.71.26 -> 0.71.28
2025-12-11 02:38:41 -05:00
Andrew Beveridge ba4534fdbd feat: Batch 6 - Two-Phase Workflow (prep-only, finalise-only, keep-brand-code)
Implements the two-phase workflow for remote CLI, allowing users to:
- Run prep-only mode to stop after review phase and download all outputs
- Run finalise-only mode to upload local prep outputs and continue with finalization
- Preserve existing brand codes when re-running finalisation

Backend changes:
- Added PREP_COMPLETE status to JobStatus enum
- Added prep_only, finalise_only, keep_brand_code fields to Job/JobCreate models
- Updated state transitions to allow new workflow paths
- New endpoint /api/jobs/create-finalise-only for uploading prep outputs
- New endpoint /api/jobs/{job_id}/finalise-uploads-complete
- Modified render_video_worker to transition to PREP_COMPLETE for prep-only jobs
- Modified video_worker to use preserved brand code when set

Remote CLI changes:
- Added --prep-only flag support (passes prep_only=true to backend)
- Added --finalise-only flow (detects local prep folder, uploads files)
- Added --keep-brand-code support (extracts from folder name)
- Added PREP_COMPLETE status handling in job monitor

Tests:
- Added comprehensive tests for new Job model fields and PREP_COMPLETE status
- Added tests for finalise-only endpoints and Pydantic models
- All 151 tests pass

Version bumped to 0.71.27
2025-12-11 02:38:22 -05:00
103 changed files with 24017 additions and 1747 deletions

No files matched your search

@@ -0,0 +1,717 @@
---
name: Instrumental Review UI
overview: Add an intelligent instrumental selection workflow with audio analysis, waveform visualization, playback controls, and the ability to mute sections of backing vocals to create custom instrumentals. This replaces the current text-only CLI prompt with a web UI that works for both local and remote workflows, with shared core logic for DRY/maintainable code.
todos:
- id: shared-core-module
content: Create karaoke_gen/instrumental_review/ shared module with AudioAnalyzer and AudioEditor classes (used by both local and remote)
status: completed
- id: shared-core-tests
content: Add comprehensive unit tests for shared module with >80% coverage (tests/unit/test_instrumental_review.py)
status: completed
- id: backend-services
content: Create backend service wrappers that use shared core module (audio_analysis_service.py, audio_editing_service.py)
status: completed
- id: backend-services-tests
content: Add unit tests for backend services with mocked GCS interactions (backend/tests/test_audio_services.py)
status: completed
- id: api-endpoints
content: Add new API endpoints for analysis, audio streaming, and custom instrumental creation
status: completed
- id: api-endpoints-tests
content: Add API endpoint tests with >80% coverage (backend/tests/test_instrumental_api.py)
status: completed
- id: render-worker-integration
content: Integrate audio analysis into render_video_worker before transitioning to awaiting_instrumental_selection
status: completed
- id: render-worker-tests
content: Add/update render_video_worker tests to cover new analysis integration
status: completed
- id: frontend-components
content: Create React components (WaveformDisplay, AudioPlayer, RegionSelector, InstrumentalReviewPage)
status: completed
- id: local-cli-integration
content: Update local gen_cli.py to use shared core module with local file paths (feature parity with remote)
status: completed
- id: local-cli-review-server
content: Add lightweight review server to local CLI for browser-based review (similar to lyrics review pattern)
status: completed
- id: remote-cli-update
content: Update remote_cli.py to use new analysis API and open browser for review
status: completed
- id: cli-tests
content: Add CLI tests verifying feature parity between local and remote modes
status: completed
- id: integration-tests
content: Add end-to-end integration tests for the full instrumental review workflow
status: completed
---
# Intelligent Instrumental Selection Plan
## Current State
The instrumental selection workflow currently:
- Presents a simple 1/2 choice in the CLI (clean vs. with_backing)
- Requires manual inspection in Audacity to evaluate backing vocals quality
- Cannot handle the common "Scenario 3" where backing vocals need partial muting
- Has no audio preview capability in remote mode
## Target Architecture
```
┌────────────────────────────────────────────────────────────────────────────┐
│ INSTRUMENTAL REVIEW WORKFLOW │
├────────────────────────────────────────────────────────────────────────────┤
│ │
│ 1. AUDIO ANALYSIS (automatic after render_video completes) │
│ │ │
│ ├── Analyze backing vocals stem for amplitude │
│ ├── Detect audible segments (> -40dB threshold) │
│ ├── Generate waveform visualization image │
│ └── Store analysis results in job state_data │
│ │
│ 2. AUTO-DECISION CHECK │
│ │ │
│ └── IF no audible segments detected: │
│ ├── Set recommended_selection = "clean" │
│ └── Skip to step 4 (or show minimal UI with suggestion) │
│ │
│ 3. HUMAN REVIEW (Web UI) │
│ │ │
│ ├── Display waveform with time axis │
│ ├── Show audible segment markers │
│ ├── Audio playback with waveform-click seeking │
│ ├── Toggle between: clean / with_backing / preview-custom │
│ ├── Select regions to mute (click/drag on waveform) │
│ └── Create custom instrumental if regions selected │
│ │
│ 4. SELECTION SUBMISSION │
│ │ │
│ └── POST /api/jobs/{job_id}/select-instrumental │
│ with selection = "clean" | "with_backing" | "custom" │
│ │
└────────────────────────────────────────────────────────────────────────────┘
```
## Architecture: Shared Core for DRY/SOLID
To ensure feature parity between local and remote CLIs while keeping code maintainable, we use a **shared core module** pattern:
```
┌─────────────────────────────────────────────────────────────────────────────┐
│ SHARED CORE ARCHITECTURE │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ karaoke_gen/instrumental_review/ <── SHARED CORE MODULE │
│ ├── __init__.py │
│ ├── analyzer.py # AudioAnalyzer class (pure Python, no GCS) │
│ ├── editor.py # AudioEditor class (pure Python, no GCS) │
│ ├── waveform.py # WaveformGenerator class (matplotlib) │
│ └── models.py # Pydantic models: AnalysisResult, MuteRegion │
│ │
│ ┌─────────────────────┐ ┌──────────────────────┐ │
│ │ LOCAL CLI │ │ REMOTE BACKEND │ │
│ │ (karaoke-gen) │ │ (Cloud Run) │ │
│ ├─────────────────────┤ ├──────────────────────┤ │
│ │ │ │ │ │
│ │ gen_cli.py │ │ audio_analysis_ │ │
│ │ └── uses shared ───┼──────────────┼──► service.py │ │
│ │ core directly │ │ └── wraps shared│ │
│ │ with local │ │ core with │ │
│ │ file paths │ │ GCS I/O │ │
│ │ │ │ │ │
│ │ local_review_ │ │ audio_editing_ │ │
│ │ server.py │ │ service.py │ │
│ │ └── serves same ───┼──────────────┼──► (same pattern) │ │
│ │ React UI │ │ │ │
│ │ │ │ │ │
│ └─────────────────────┘ └──────────────────────┘ │
│ │
│ BENEFITS: │
│ ✓ Single source of truth for analysis logic │
│ ✓ Bug fixes apply to both local and remote │
│ ✓ Easy to test core logic without GCS mocks │
│ ✓ Backend services are thin wrappers (Single Responsibility) │
│ ✓ Same React UI served by both local server and Cloud Run │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
```
### Shared Core Module Design
```python
# karaoke_gen/instrumental_review/analyzer.py
class AudioAnalyzer:
"""
Analyzes audio files for backing vocals content.
Pure Python - no cloud dependencies. Works with local file paths.
"""
def __init__(self, silence_threshold_db: float = -40.0,
min_segment_duration_ms: int = 100):
self.silence_threshold_db = silence_threshold_db
self.min_segment_duration_ms = min_segment_duration_ms
def analyze(self, audio_path: str) -> AnalysisResult:
"""Analyze audio file and return structured result."""
...
def get_amplitude_envelope(self, audio_path: str,
window_ms: int = 100) -> List[float]:
"""Get amplitude envelope for waveform rendering."""
...
# karaoke_gen/instrumental_review/editor.py
class AudioEditor:
"""
Creates custom instrumentals by muting regions of backing vocals.
Pure Python - no cloud dependencies.
"""
def create_custom_instrumental(
self,
clean_instrumental_path: str,
backing_vocals_path: str,
mute_regions: List[MuteRegion],
output_path: str
) -> str:
"""Create custom instrumental with muted regions."""
...
# karaoke_gen/instrumental_review/waveform.py
class WaveformGenerator:
"""Generates waveform visualization images."""
def generate(self, audio_path: str, output_path: str,
segments: List[AudibleSegment] = None,
width: int = 1200, height: int = 200) -> str:
"""Generate waveform PNG with optional segment highlighting."""
...
```
## Implementation Components
### 1. Shared Core Module (karaoke_gen/instrumental_review/)
Create the shared module first - this is the foundation:
```python
# karaoke_gen/instrumental_review/models.py
from pydantic import BaseModel
from typing import List, Optional
from enum import Enum
class RecommendedSelection(str, Enum):
CLEAN = "clean"
WITH_BACKING = "with_backing"
REVIEW_NEEDED = "review_needed"
class AudibleSegment(BaseModel):
start_seconds: float
end_seconds: float
duration_seconds: float
avg_amplitude_db: float
class MuteRegion(BaseModel):
start_seconds: float
end_seconds: float
class AnalysisResult(BaseModel):
has_audible_content: bool
total_duration_seconds: float
audible_segments: List[AudibleSegment]
recommended_selection: RecommendedSelection
waveform_data: Optional[List[float]] = None # For JSON API response
```
### 2. Backend Service Wrappers
Create `backend/services/audio_analysis_service.py`:
```python
# Key functionality:
- analyze_backing_vocals(audio_path) -> AnalysisResult
- Uses pydub for audio loading
- Calculates RMS amplitude in dB across time windows
- Detects audible segments (contiguous regions > threshold)
- Returns: {
"has_audible_content": bool,
"total_duration_seconds": float,
"audible_segments": [
{"start_seconds": float, "end_seconds": float,
"duration_seconds": float, "avg_amplitude_db": float}
],
"recommended_selection": "clean" | "with_backing" | "review_needed"
}
- generate_waveform_image(audio_path, output_path, segments=None) -> str
- Uses matplotlib to render amplitude envelope over time
- Highlights audible segments with different colors
- Returns path to generated PNG image
```
### 2. Audio Editing Service
Create `backend/services/audio_editing_service.py`:
```python
# Key functionality:
- create_custom_instrumental(
clean_instrumental_path: str,
backing_vocals_path: str,
mute_regions: List[Tuple[float, float]], # [(start_s, end_s), ...]
output_path: str
) -> str
- Loads backing vocals
- Applies silence to mute_regions
- Mixes with clean instrumental
- Saves as new FLAC file
```
### 3. Backend API Endpoints
Add to `backend/api/routes/jobs.py`:
```python
GET /api/jobs/{job_id}/instrumental-analysis
# Returns analysis data + waveform URL
GET /api/jobs/{job_id}/audio-stream/{stem_type}
# Stream audio for playback (clean, backing_vocals, combined)
POST /api/jobs/{job_id}/create-custom-instrumental
# Body: {"mute_regions": [[0.5, 2.3], [45.0, 48.5]]}
# Creates custom instrumental, updates job state
POST /api/jobs/{job_id}/select-instrumental
# Extended to accept: "clean" | "with_backing" | "custom"
```
### 4. Frontend Web UI
Create `frontend/app/jobs/[id]/instrumental-review/page.tsx`:
```
Components needed:
- WaveformDisplay: SVG/Canvas waveform with time axis
- AudioPlayer: HTML5 audio with controls + waveform sync
- RegionSelector: Click/drag to select mute regions
- InstrumentalOptions: Radio buttons for clean/backing/custom
- SegmentList: Table showing detected audible segments
```
Key interactions:
- Click on waveform to seek playback position
- Drag on waveform to select mute region
- Toggle audio source (clean/backing/preview)
- Submit selection
### 5. Backend Worker Updates
Modify `backend/workers/render_video_worker.py`:
```python
# After video render completes, before transitioning to AWAITING_INSTRUMENTAL_SELECTION:
1. Download backing_vocals stem
2. Run audio analysis
3. Generate waveform image
4. Upload waveform to GCS
5. Store analysis results in job.state_data
6. If no audible content: set recommended_selection = "clean"
7. Transition to AWAITING_INSTRUMENTAL_SELECTION
```
### 6. CLI Updates
Modify `karaoke_gen/utils/remote_cli.py`:
```python
def handle_instrumental_selection(self, job_id: str):
# Get analysis data
analysis = self.client.get_instrumental_analysis(job_id)
# If no backing vocals detected, suggest auto-select
if analysis['recommended_selection'] == 'clean':
if self.config.non_interactive:
# Auto-select clean
self.client.select_instrumental(job_id, 'clean')
return
else:
# Show suggestion, offer to open browser for verification
self.logger.info("No backing vocals detected - recommending clean instrumental")
# Open browser anyway so user can verify if desired
# Open browser to instrumental review UI
self.open_instrumental_review_ui(job_id)
# Poll until selection made
while job.status == 'awaiting_instrumental_selection':
time.sleep(self.config.poll_interval)
```
### 7. Local CLI Integration (Feature Parity)
The local CLI (`karaoke-gen`) uses the **same shared core module** as the backend:
```python
# karaoke_gen/utils/gen_cli.py - Updated instrumental selection flow
def handle_instrumental_selection(self, output_dir: str, base_name: str):
"""Handle instrumental selection using shared core module."""
from karaoke_gen.instrumental_review import AudioAnalyzer, WaveformGenerator
# Paths to local files (already exist from audio separation)
backing_vocals_path = os.path.join(output_dir, "stems",
f"{base_name} (Backing Vocals ...).flac")
clean_instrumental_path = os.path.join(output_dir, "stems",
f"{base_name} (Instrumental ...).flac")
# Use SAME analyzer as backend
analyzer = AudioAnalyzer(silence_threshold_db=-40.0)
analysis = analyzer.analyze(backing_vocals_path)
# Generate waveform locally
waveform_path = os.path.join(output_dir, "backing_vocals_waveform.png")
WaveformGenerator().generate(backing_vocals_path, waveform_path,
analysis.audible_segments)
if not analysis.has_audible_content:
self.logger.info("No backing vocals detected - using clean instrumental")
if not self.non_interactive:
# Offer to open browser for verification
...
return "clean"
# Start local review server (serves same React UI)
from karaoke_gen.instrumental_review.server import InstrumentalReviewServer
server = InstrumentalReviewServer(
output_dir=output_dir,
base_name=base_name,
analysis=analysis,
waveform_path=waveform_path,
)
server.start_and_open_browser() # Blocking until user submits selection
return server.get_selection()
```
### 8. Local Review Server
Create `karaoke_gen/instrumental_review/server.py`:
```python
"""
Lightweight local server for instrumental review.
Serves the same React frontend used by the cloud backend.
Similar pattern to LyricsTranscriber's ReviewServer.
"""
from http.server import HTTPServer, SimpleHTTPRequestHandler
import json
import threading
class InstrumentalReviewServer:
"""
Local HTTP server for instrumental review UI.
Endpoints:
- GET /api/analysis - Returns analysis data
- GET /api/audio/{type} - Streams audio files
- GET /api/waveform - Returns waveform image
- POST /api/create-custom - Creates custom instrumental
- POST /api/select - Submits selection
- GET /* - Serves React frontend static files
"""
def __init__(self, output_dir: str, base_name: str,
analysis: AnalysisResult, waveform_path: str):
...
def start_and_open_browser(self, port: int = 8765):
"""Start server, open browser, block until selection submitted."""
...
def get_selection(self) -> str:
"""Get the user's selection after browser submission."""
...
```
## Testing Strategy
### Test Coverage Requirements
All new code must meet the project's **70% minimum coverage** requirement, with critical paths targeting **>80%**:
| Module | Target Coverage | Test File |
|--------|----------------|-----------|
| `karaoke_gen/instrumental_review/analyzer.py` | >90% | `tests/unit/test_instrumental_analyzer.py` |
| `karaoke_gen/instrumental_review/editor.py` | >90% | `tests/unit/test_instrumental_editor.py` |
| `karaoke_gen/instrumental_review/waveform.py` | >80% | `tests/unit/test_instrumental_waveform.py` |
| `karaoke_gen/instrumental_review/server.py` | >70% | `tests/unit/test_instrumental_server.py` |
| `backend/services/audio_analysis_service.py` | >80% | `backend/tests/test_audio_analysis_service.py` |
| `backend/services/audio_editing_service.py` | >80% | `backend/tests/test_audio_editing_service.py` |
| `backend/api/routes/jobs.py` (new endpoints) | >80% | `backend/tests/test_instrumental_api.py` |
### Test Categories
**1. Unit Tests (Shared Core) - tests/unit/test_instrumental_*.py**
```python
# tests/unit/test_instrumental_analyzer.py
class TestAudioAnalyzer:
def test_analyze_silent_audio_returns_no_audible_content(self):
"""Silent audio should return has_audible_content=False."""
def test_analyze_audio_with_content_detects_segments(self):
"""Audio with content should detect audible segments."""
def test_segment_detection_respects_threshold(self):
"""Segments below threshold should not be detected."""
def test_segment_merging_for_close_segments(self):
"""Close segments should be merged into one."""
def test_recommended_selection_clean_for_silent(self):
"""Silent audio should recommend 'clean'."""
def test_recommended_selection_review_for_content(self):
"""Audio with content should recommend 'review_needed'."""
# tests/unit/test_instrumental_editor.py
class TestAudioEditor:
def test_mute_single_region(self):
"""Single mute region should be applied correctly."""
def test_mute_multiple_regions(self):
"""Multiple mute regions should all be applied."""
def test_mute_region_boundaries(self):
"""Mute region at start/end of audio should work."""
def test_output_format_is_flac(self):
"""Output should be FLAC format."""
def test_combines_with_clean_instrumental(self):
"""Result should be backing vocals mixed with clean instrumental."""
```
**2. Unit Tests (Backend Services) - backend/tests/test_audio_*_service.py**
```python
# backend/tests/test_audio_analysis_service.py
class TestAudioAnalysisService:
@pytest.fixture
def mock_storage(self):
"""Mock GCS storage service."""
def test_analyze_downloads_from_gcs(self, mock_storage):
"""Service should download audio from GCS before analysis."""
def test_analyze_uploads_waveform_to_gcs(self, mock_storage):
"""Service should upload waveform image to GCS."""
def test_analyze_updates_job_state_data(self, mock_storage):
"""Service should store analysis in job.state_data."""
```
**3. API Endpoint Tests - backend/tests/test_instrumental_api.py**
```python
# backend/tests/test_instrumental_api.py
class TestInstrumentalAnalysisEndpoint:
def test_get_analysis_returns_data(self, client, mock_job):
"""GET /instrumental-analysis should return analysis data."""
def test_get_analysis_requires_correct_status(self, client, mock_job):
"""Should return 400 if job not in correct status."""
class TestAudioStreamEndpoint:
def test_stream_backing_vocals(self, client, mock_job):
"""Should stream backing vocals audio."""
def test_stream_clean_instrumental(self, client, mock_job):
"""Should stream clean instrumental audio."""
class TestCreateCustomInstrumental:
def test_create_with_mute_regions(self, client, mock_job):
"""Should create custom instrumental with mute regions."""
def test_validates_mute_regions(self, client, mock_job):
"""Should validate mute region boundaries."""
```
**4. Integration Tests - tests/integration/test_instrumental_review.py**
```python
# tests/integration/test_instrumental_review_flow.py
class TestInstrumentalReviewFlow:
"""End-to-end tests for instrumental review workflow."""
def test_full_flow_clean_selection(self):
"""Test complete flow: analysis -> review -> select clean."""
def test_full_flow_with_backing_selection(self):
"""Test complete flow: analysis -> review -> select with_backing."""
def test_full_flow_custom_creation(self):
"""Test complete flow: analysis -> mute regions -> custom."""
def test_auto_recommend_clean_for_silent_backing(self):
"""When no backing vocals, should recommend clean."""
```
**5. CLI Feature Parity Tests - tests/unit/test_cli_feature_parity.py**
```python
# tests/unit/test_cli_feature_parity.py
class TestCLIFeatureParity:
"""Verify local and remote CLIs have equivalent functionality."""
def test_both_clis_use_same_analyzer(self):
"""Both CLIs should use AudioAnalyzer from shared module."""
def test_both_clis_support_custom_instrumental(self):
"""Both CLIs should support creating custom instrumentals."""
def test_analysis_results_identical(self):
"""Same audio should produce identical analysis from both CLIs."""
```
### Test Data
Create test fixtures in `tests/data/instrumental_review/`:
- `silent_backing_vocals.flac` - Silent/near-silent audio (~10s)
- `backing_vocals_with_content.flac` - Audio with clear backing vocals (~30s)
- `backing_vocals_mixed_quality.flac` - Audio with some good/some bad sections (~30s)
Use pydub to programmatically generate these in `tests/conftest.py` fixtures.
## File Changes Summary
| Category | Files to Create/Modify |
|----------|------------------------|
| **Shared Core** | `karaoke_gen/instrumental_review/__init__.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/models.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/analyzer.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/editor.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/waveform.py` (new) |
| Shared Core | `karaoke_gen/instrumental_review/server.py` (new) |
| **Backend Services** | `backend/services/audio_analysis_service.py` (new) |
| Backend Services | `backend/services/audio_editing_service.py` (new) |
| **API** | `backend/api/routes/jobs.py` (modify - add endpoints) |
| API | `backend/api/routes/instrumental.py` (new - if endpoints get large) |
| **Workers** | `backend/workers/render_video_worker.py` (modify) |
| **Models** | `backend/models/job.py` (add analysis fields to state_data) |
| **Frontend** | `frontend/app/jobs/[id]/instrumental-review/page.tsx` (new) |
| Frontend | `frontend/components/waveform-display.tsx` (new) |
| Frontend | `frontend/components/audio-player-with-waveform.tsx` (new) |
| Frontend | `frontend/components/region-selector.tsx` (new) |
| **Local CLI** | `karaoke_gen/utils/gen_cli.py` (modify) |
| **Remote CLI** | `karaoke_gen/utils/remote_cli.py` (modify) |
| **Tests - Shared** | `tests/unit/test_instrumental_analyzer.py` (new) |
| Tests - Shared | `tests/unit/test_instrumental_editor.py` (new) |
| Tests - Shared | `tests/unit/test_instrumental_waveform.py` (new) |
| Tests - Shared | `tests/unit/test_instrumental_server.py` (new) |
| **Tests - Backend** | `backend/tests/test_audio_analysis_service.py` (new) |
| Tests - Backend | `backend/tests/test_audio_editing_service.py` (new) |
| Tests - Backend | `backend/tests/test_instrumental_api.py` (new) |
| **Tests - Parity** | `tests/unit/test_cli_feature_parity.py` (new) |
| **Tests - Integration** | `tests/integration/test_instrumental_review.py` (new) |
| **Test Data** | `tests/conftest.py` (modify - add fixtures) |
## Dependencies
Already available in `pyproject.toml`:
- `pydub>=0.25.1` - Audio loading and manipulation
- `matplotlib>=3` - Waveform visualization
- `numpy>=2` - Audio array processing
Frontend:
- React/Next.js (existing)
- HTML5 Audio API (native)
- Canvas or SVG for waveform (native)
## Implementation Order
Execute in this order to enable incremental testing:
### Phase 1: Shared Core Module (Foundation)
1. Create `karaoke_gen/instrumental_review/` package with models, analyzer, editor, waveform
2. Add comprehensive unit tests for shared core (>90% coverage)
3. Create test audio fixtures in `tests/conftest.py`
### Phase 2: Backend Integration
4. Create backend service wrappers with GCS integration
5. Add backend service unit tests with mocked GCS
6. Add new API endpoints to `backend/api/routes/jobs.py`
7. Add API endpoint tests
8. Integrate analysis into `render_video_worker.py`
9. Update render worker tests
### Phase 3: Frontend
10. Create React components (WaveformDisplay, AudioPlayer, RegionSelector)
11. Create instrumental review page
12. Test frontend manually with backend
### Phase 4: CLI Integration
13. Update `remote_cli.py` to use new analysis API and open browser
14. Create local review server `karaoke_gen/instrumental_review/server.py`
15. Update `gen_cli.py` to use shared core and local server
16. Add CLI feature parity tests
### Phase 5: Integration Testing
17. Add end-to-end integration tests
18. Manual testing of full workflow (local and remote)
### Verification Checklist
- [ ] All unit tests pass: `pytest tests/unit/ -v`
- [ ] All backend tests pass: `pytest backend/tests/ -v`
- [ ] Coverage meets 70% minimum: `pytest --cov=karaoke_gen --cov-fail-under=70`
- [ ] Local CLI works: `karaoke-gen "Artist" "Title"` (reaches instrumental selection)
- [ ] Remote CLI works: `karaoke-gen-remote ./audio.flac "Artist" "Title"`
- [ ] Both CLIs produce identical analysis for same audio
- [ ] Custom instrumental creation works in both modes
- [ ] Version bumped in `pyproject.toml`
@@ -0,0 +1,217 @@
---
name: MidiCo-Style Synchronizer
overview: Build a new MidiCo-style Synchronizer component for efficient re-syncing of lyrics timing, particularly for fixing progressive drift in the second half of songs. This involves refactoring the "Edit All" entry point and creating a high-performance timeline-based sync interface.
todos:
- id: mode-selection-modal
content: Create ModeSelectionModal for 'Replace All' vs 'Re-sync Existing' choice
status: completed
- id: timeline-canvas
content: Build canvas-based TimelineCanvas component for high-performance word block rendering
status: completed
- id: upcoming-words-bar
content: Create UpcomingWordsBar component showing next unsynced words in fixed position
status: completed
- id: sync-controls
content: Build SyncControls with Start Sync, Clear Sync, Unsync from Cursor, Delete Selected buttons
status: completed
- id: lyrics-synchronizer
content: Create main LyricsSynchronizer component integrating all sub-components
status: completed
- id: unsync-from-cursor
content: Add 'unsync from cursor' functionality to useManualSync hook
status: completed
- id: integrate-modal
content: Integrate new synchronizer into ReplaceAllLyricsModal with mode selection
status: completed
- id: word-selection
content: Implement single-click and drag-select for word blocks
status: completed
- id: zoom-slider
content: Add smooth zoom slider with 4.5s-24s range
status: completed
- id: performance-test
content: Test performance with long songs and optimize as needed
status: completed
---
# MidiCo-Style Synchronizer Implementation
## Current State Analysis
The existing implementation in [`ReplaceAllLyricsModal.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/ReplaceAllLyricsModal.tsx) has two phases:
1. **Paste Phase** - User pastes new lyrics text
2. **Sync Phase** - Manual sync using spacebar with timeline view
Key existing components:
- [`useManualSync.ts`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/hooks/useManualSync.ts) - Spacebar handling, tap/hold detection
- [`EditTimelineSection.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/EditTimelineSection.tsx) - Timeline controls with zoom/scroll
- [`TimelineEditor.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/TimelineEditor.tsx) - Timeline rendering
**Problems with current implementation:**
1. Forces full lyrics replacement - no option to keep existing sync data
2. Performance issues (laggy, slow rendering)
3. Poor UX for seeing upcoming words while syncing
4. No "unsync from cursor" feature for fixing drift
5. No two-level word block layout for overlapping segments
## Architecture Overview
```mermaid
flowchart TB
subgraph Entry [Entry Point]
EditAll[Edit All Button]
EditAll --> ChoiceModal[Mode Selection Modal]
ChoiceModal -->|Replace All| PastePhase[Paste New Lyrics]
ChoiceModal -->|Re-sync Existing| SyncView[Synchronizer View]
PastePhase --> SyncView
end
subgraph Sync [Synchronizer Component]
SyncView --> Timeline[Timeline Canvas]
SyncView --> Controls[Control Buttons]
SyncView --> UpcomingWords[Upcoming Words Display]
Timeline --> WordBlocks[Word Blocks Renderer]
Timeline --> Playhead[Playhead Marker]
Timeline --> TimeBar[Time Bar]
end
subgraph Audio [Audio Integration]
AudioPlayer[Audio Player]
AudioPlayer <--> SyncView
end
```
## Implementation Plan
### Phase 1: Entry Point Refactor
Modify the "Edit All" button flow to show a choice modal:
```typescript
// New ModeSelectionModal component
interface ModeSelectionModalProps {
open: boolean
onClose: () => void
onSelectReplace: () => void // Goes to paste phase
onSelectResync: () => void // Goes directly to sync view
}
```
- **Replace All Lyrics**: Current flow (paste box -> sync)
- **Re-sync Existing Lyrics**: Load current segments directly into sync view
### Phase 2: New Synchronizer Component
Create a new high-performance `LyricsSynchronizer.tsx` component inspired by MidiCo:
#### Core Features
1. **Timeline Canvas** (HTML5 Canvas for performance)
- Time bar at top (MM:SS format with decisecond ticks)
- Playhead with arrow indicator + vertical line
- Red word blocks with text labels
- Two-level word layout for overlapping segments
- Zoom slider (4.5s to 24s visible range)
- Horizontal scroll with smooth panning
2. **Upcoming Words Display** (dual location)
- Fixed position above timeline: next words as red/white blocks
- On timeline: words appear to right of playhead during sync
3. **Control Buttons**
- **Start Sync** - Begin sync mode from first unsynced word
- **Clear Sync** - Reset all word timings to null
- **Edit Lyrics** - Modal to edit lyrics text (warns about timing loss)
- **Unsync from Cursor** - Critical: reset all words after playhead position
- **Split/Edit Word** - Edit single selected word
- **Delete Selected** - Remove selected word blocks
4. **Word Selection**
- Single click: select one word (white border)
- Click-drag on background: selection rectangle for multi-select
- Click on time bar: set playhead position
5. **Spacebar Sync Logic** (reuse/enhance `useManualSync`)
- Tap: set start time, default 500ms duration
- Hold: set both start and end times
- Handle previous word end time calculation
### Phase 3: Performance Optimization
The current `TimelineEditor` uses DOM elements which causes lag. New approach:
1. **Canvas-based rendering** for word blocks and timeline
- Single canvas element, no DOM nodes per word
- RequestAnimationFrame for smooth playhead updates
- Only re-render changed regions
2. **Virtual scrolling** for very long songs
- Only render visible word blocks
- Cache off-screen block positions
3. **Debounced state updates**
- Batch word timing updates
- Throttle zoom/scroll handlers
### Phase 4: Apply/Cancel Flow
Changes are held in local state until user clicks Apply:
```typescript
interface SynchronizerState {
words: Word[] // Working copy of words
segments: LyricsSegment[] // Working copy of segments
isDirty: boolean // Has unsaved changes
}
```
- **Apply**: Commit changes to parent component
- **Cancel**: Discard changes, close modal
## File Changes
### New Files
- `src/components/LyricsSynchronizer.tsx` - Main synchronizer component
- `src/components/LyricsSynchronizer/TimelineCanvas.tsx` - Canvas-based timeline
- `src/components/LyricsSynchronizer/UpcomingWordsBar.tsx` - Fixed upcoming words display
- `src/components/LyricsSynchronizer/SyncControls.tsx` - Control buttons
- `src/components/ModeSelectionModal.tsx` - Entry point choice modal
### Modified Files
- [`ReplaceAllLyricsModal.tsx`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/components/ReplaceAllLyricsModal.tsx) - Add mode selection, integrate new synchronizer
- [`useManualSync.ts`](lyrics_transcriber_temp/lyrics_transcriber/frontend/src/hooks/useManualSync.ts) - Add "unsync from cursor" functionality
## Key UX Details from MidiCo Reference
Per the documentation at [`MIDICO_SYNCHRONIZER_REFERENCE.md`](lyrics_transcriber_temp/docs/MIDICO_SYNCHRONIZER_REFERENCE.md):
1. **Zoom range**: 4.5s (max zoom) to 24s (min zoom) visible
2. **Timeline click behavior**:
- Time bar click = set playhead (no playback change)
- Background click = nothing (prevent accidental deselection)
- Word block click = select
3. **Two-level word blocks**: Adjacent/overlapping words display on alternating vertical levels
4. **Playhead**: Small arrow in time bar + white vertical line spanning timeline height
5. **Selection rectangle**: Click-drag on background creates selection box
## Testing Strategy
1. Manual testing with the provided URL: `http://localhost:8000/?baseApiUrl=...`
2. Test sync accuracy with songs that have known drift issues
3. Performance testing with 400+ word songs
4. Test "unsync from cursor" workflow for fixing drift
+9 -4
View File
@@ -415,8 +415,9 @@ jobs:
run: |
echo "🔍 Checking if base image needs rebuild..."
CURRENT_HASH=$(sha256sum poetry.lock | cut -d' ' -f1)
echo "Current poetry.lock hash: $CURRENT_HASH"
# Hash both poetry.lock AND Dockerfile.base - rebuild if either changes
CURRENT_HASH=$(cat poetry.lock backend/Dockerfile.base | sha256sum | cut -d' ' -f1)
echo "Current combined hash (poetry.lock + Dockerfile.base): $CURRENT_HASH"
gcloud auth configure-docker us-central1-docker.pkg.dev --quiet
@@ -424,14 +425,18 @@ jobs:
EXISTING_HASH=""
if docker pull $BASE_IMAGE 2>/dev/null; then
EXISTING_HASH=$(docker inspect $BASE_IMAGE --format='{{index .Config.Labels "poetry.lock.hash"}}' 2>/dev/null || echo "")
EXISTING_HASH=$(docker inspect $BASE_IMAGE --format='{{index .Config.Labels "base.content.hash"}}' 2>/dev/null || echo "")
# Fallback to old label name for backwards compatibility
if [ -z "$EXISTING_HASH" ]; then
EXISTING_HASH=$(docker inspect $BASE_IMAGE --format='{{index .Config.Labels "poetry.lock.hash"}}' 2>/dev/null || echo "")
fi
echo "Existing base image hash: $EXISTING_HASH"
else
echo "⚠️ No existing base image found"
fi
if [ "$CURRENT_HASH" != "$EXISTING_HASH" ]; then
echo "🔄 Base image needs rebuild (poetry.lock changed)"
echo "🔄 Base image needs rebuild (poetry.lock or Dockerfile.base changed)"
echo "needs_rebuild=true" >> $GITHUB_OUTPUT
else
echo "✅ Base image is up to date"
+6 -2
View File
@@ -11,7 +11,9 @@
# gcloud builds submit --config=cloudbuild-base.yaml --project=nomadkaraoke
# Use pre-built base image with all dependencies
FROM us-central1-docker.pkg.dev/nomadkaraoke/karaoke-repo/karaoke-backend-base:latest
# Override with --build-arg BASE_IMAGE=karaoke-backend-base:local for local testing
ARG BASE_IMAGE=us-central1-docker.pkg.dev/nomadkaraoke/karaoke-repo/karaoke-backend-base:latest
FROM ${BASE_IMAGE}
# Set working directory (should already exist from base)
WORKDIR /app
@@ -34,5 +36,7 @@ ENV PORT=8080
# Expose port
EXPOSE 8080
# Run the application
# Run uvicorn directly
# Note: Transmission daemon removed - torrent downloads now handled by
# dedicated flacfetch VM service (see docs/00-current-plan/TORRENT-SERVICE-PLAN.md)
CMD ["uvicorn", "backend.main:app", "--host", "0.0.0.0", "--port", "8080"]
+6 -3
View File
@@ -7,12 +7,15 @@
FROM python:3.11-slim
# Install system dependencies required by karaoke-gen
# Note: Transmission daemon removed - torrent downloads now handled by
# dedicated flacfetch VM service (see docs/00-current-plan/TORRENT-SERVICE-PLAN.md)
RUN apt-get update && apt-get install -y \
ffmpeg \
libsndfile1 \
libsox-dev \
sox \
build-essential \
curl \
&& rm -rf /var/lib/apt/lists/*
# Set working directory
@@ -34,9 +37,9 @@ RUN python -m spacy download en_core_web_sm
# Label with build info
ARG BUILD_DATE
ARG BUILD_ID
ARG POETRY_LOCK_HASH
ARG BASE_CONTENT_HASH
LABEL org.opencontainers.image.created="${BUILD_DATE}"
LABEL org.opencontainers.image.revision="${BUILD_ID}"
LABEL org.opencontainers.image.title="karaoke-backend-base"
LABEL org.opencontainers.image.description="Base image with Python dependencies for karaoke-backend"
LABEL poetry.lock.hash="${POETRY_LOCK_HASH}"
LABEL org.opencontainers.image.description="Base image with Python dependencies and system tools for karaoke-backend"
LABEL base.content.hash="${BASE_CONTENT_HASH}"
+600
View File
@@ -0,0 +1,600 @@
"""
Audio search API routes for artist+title search mode.
This module provides endpoints for:
1. Creating a job with audio search (artist+title without file)
2. Getting search results for a job
3. Selecting an audio source to download
The flow is:
1. POST /api/audio-search/search - Create job and search for audio
2. GET /api/audio-search/{job_id}/results - Get search results
3. POST /api/audio-search/{job_id}/select - Select audio source
"""
import asyncio
import logging
import os
import tempfile
from typing import Optional, List, Dict, Any
from fastapi import APIRouter, HTTPException, BackgroundTasks, Request
from pydantic import BaseModel, Field
from backend.models.job import JobCreate, JobStatus
from backend.services.job_manager import JobManager
from backend.services.storage_service import StorageService
from backend.services.worker_service import get_worker_service
from backend.services.credential_manager import get_credential_manager, CredentialStatus
from backend.services.audio_search_service import (
get_audio_search_service,
AudioSearchResult,
AudioSearchError,
NoResultsError,
DownloadError,
)
from backend.config import get_settings
from backend.version import VERSION
logger = logging.getLogger(__name__)
router = APIRouter(tags=["audio-search"])
# Initialize services
job_manager = JobManager()
storage_service = StorageService()
worker_service = get_worker_service()
# ============================================================================
# Pydantic models
# ============================================================================
class AudioSearchRequest(BaseModel):
"""Request to search for audio by artist and title."""
artist: str = Field(..., description="Artist name to search for")
title: str = Field(..., description="Song title to search for")
# Auto-download mode
auto_download: bool = Field(False, description="Automatically select best result and download")
# Processing options
enable_cdg: bool = Field(True, description="Generate CDG+MP3 package")
enable_txt: bool = Field(True, description="Generate TXT+MP3 package")
# Finalisation options
brand_prefix: Optional[str] = Field(None, description="Brand code prefix (e.g., NOMAD)")
enable_youtube_upload: bool = Field(False, description="Upload to YouTube")
youtube_description: Optional[str] = Field(None, description="YouTube video description text")
discord_webhook_url: Optional[str] = Field(None, description="Discord webhook URL for notifications")
# Distribution options
dropbox_path: Optional[str] = Field(None, description="Dropbox folder path for organized output")
gdrive_folder_id: Optional[str] = Field(None, description="Google Drive folder ID for public share uploads")
# Lyrics configuration
lyrics_artist: Optional[str] = Field(None, description="Override artist name for lyrics search")
lyrics_title: Optional[str] = Field(None, description="Override title for lyrics search")
subtitle_offset_ms: int = Field(0, description="Subtitle timing offset in milliseconds")
# Audio separation model configuration
clean_instrumental_model: Optional[str] = Field(None, description="Model for clean instrumental separation")
backing_vocals_models: Optional[List[str]] = Field(None, description="Models for backing vocals separation")
other_stems_models: Optional[List[str]] = Field(None, description="Models for other stems")
class AudioSearchResultResponse(BaseModel):
"""A single audio search result.
Contains all fields needed for rich display using flacfetch's
shared formatting functions.
"""
index: int
title: str
artist: str
provider: str # Maps to source_name in Release
url: str # Maps to download_url in Release
duration: Optional[int] = None # Maps to duration_seconds in Release
quality: Optional[str] = None # Stringified quality
source_id: Optional[str] = None # Maps to info_hash in Release
seeders: Optional[int] = None
target_file: Optional[str] = None
# Additional fields for rich display (from Release.to_dict())
year: Optional[int] = None
label: Optional[str] = None
edition_info: Optional[str] = None
release_type: Optional[str] = None
channel: Optional[str] = None # For YouTube
view_count: Optional[int] = None # For YouTube
size_bytes: Optional[int] = None
target_file_size: Optional[int] = None
track_pattern: Optional[str] = None
match_score: Optional[float] = None
# Pre-computed display fields
formatted_size: Optional[str] = None
formatted_duration: Optional[str] = None
formatted_views: Optional[str] = None
is_lossless: Optional[bool] = None
quality_str: Optional[str] = None
# Full quality object for Release.from_dict()
quality_data: Optional[Dict[str, Any]] = None
class AudioSearchResponse(BaseModel):
"""Response from audio search."""
status: str
job_id: str
message: str
results: Optional[List[AudioSearchResultResponse]] = None
results_count: int = 0
auto_download: bool = False
server_version: str
class AudioSelectRequest(BaseModel):
"""Request to select an audio source."""
selection_index: int = Field(..., description="Index of the selected audio source from search results")
class AudioSelectResponse(BaseModel):
"""Response from audio source selection."""
status: str
job_id: str
message: str
selected_index: int
selected_title: str
selected_artist: str
selected_provider: str
def extract_request_metadata(request: Request, created_from: str = "audio_search") -> Dict[str, Any]:
"""Extract metadata from request for job tracking."""
headers = dict(request.headers)
client_ip = headers.get('x-forwarded-for', '').split(',')[0].strip()
if not client_ip and request.client:
client_ip = request.client.host
user_agent = headers.get('user-agent', '')
environment = headers.get('x-environment', '')
client_id = headers.get('x-client-id', '')
custom_headers = {}
for key, value in headers.items():
if key.lower().startswith('x-') and key.lower() not in ('x-forwarded-for', 'x-forwarded-proto', 'x-forwarded-host'):
custom_headers[key] = value
return {
'client_ip': client_ip,
'user_agent': user_agent,
'environment': environment,
'client_id': client_id,
'server_version': VERSION,
'created_from': created_from,
'custom_headers': custom_headers,
}
async def _trigger_workers_parallel(job_id: str) -> None:
"""Trigger both audio and lyrics workers in parallel."""
await asyncio.gather(
worker_service.trigger_audio_worker(job_id),
worker_service.trigger_lyrics_worker(job_id)
)
async def _download_and_start_processing(
job_id: str,
selection_index: int,
audio_search_service,
background_tasks: BackgroundTasks,
) -> Dict[str, Any]:
"""
Download selected audio and start job processing.
This is called either:
- Immediately after search if auto_download=True
- When user calls the select endpoint
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Get search results from state_data
search_results = job.state_data.get('audio_search_results', [])
if not search_results:
raise HTTPException(status_code=400, detail="No search results available")
if selection_index < 0 or selection_index >= len(search_results):
raise HTTPException(
status_code=400,
detail=f"Invalid selection index {selection_index}. Valid range: 0-{len(search_results)-1}"
)
selected = search_results[selection_index]
# Transition to downloading state
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.DOWNLOADING_AUDIO,
progress=10,
message=f"Downloading from {selected['provider']}: {selected['artist']} - {selected['title']}",
state_data_updates={
'selected_audio_index': selection_index,
'selected_audio_provider': selected['provider'],
}
)
try:
# Download to temp directory
temp_dir = tempfile.mkdtemp(prefix=f"audio_download_{job_id}_")
result = audio_search_service.download(
result_index=selection_index,
output_dir=temp_dir,
)
# Upload to GCS
filename = os.path.basename(result.filepath)
audio_gcs_path = f"uploads/{job_id}/audio/{filename}"
with open(result.filepath, 'rb') as f:
storage_service.upload_fileobj(
f,
audio_gcs_path,
content_type='audio/flac' # flacfetch typically returns FLAC
)
logger.info(f"Uploaded audio to GCS: {audio_gcs_path}")
# Clean up temp file
try:
os.remove(result.filepath)
os.rmdir(temp_dir)
except Exception as e:
logger.warning(f"Failed to clean up temp files: {e}")
# Update job with GCS path and transition to DOWNLOADING
job_manager.update_job(job_id, {
'input_media_gcs_path': audio_gcs_path,
'filename': filename,
})
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.DOWNLOADING,
progress=15,
message="Audio downloaded, starting processing"
)
# Trigger workers
background_tasks.add_task(_trigger_workers_parallel, job_id)
return {
'selected_index': selection_index,
'selected_title': selected['title'],
'selected_artist': selected['artist'],
'selected_provider': selected['provider'],
}
except DownloadError as e:
job_manager.fail_job(job_id, f"Audio download failed: {e}")
raise HTTPException(status_code=500, detail=f"Download failed: {e}")
except Exception as e:
job_manager.fail_job(job_id, f"Audio download failed: {e}")
raise HTTPException(status_code=500, detail=f"Download failed: {e}")
@router.post("/audio-search/search", response_model=AudioSearchResponse)
async def search_audio(
request: Request,
background_tasks: BackgroundTasks,
body: AudioSearchRequest,
):
"""
Search for audio by artist and title, creating a new job.
This endpoint:
1. Creates a job in PENDING state
2. Searches for audio using flacfetch
3. Either returns search results for user selection, or
4. If auto_download=True, automatically selects best and starts processing
Use cases:
- Interactive mode (default): Returns results, user calls /select endpoint
- Auto mode (auto_download=True): Automatically selects and downloads best
"""
try:
# Apply default distribution settings
settings = get_settings()
effective_dropbox_path = body.dropbox_path or settings.default_dropbox_path
effective_gdrive_folder_id = body.gdrive_folder_id or settings.default_gdrive_folder_id
effective_discord_webhook_url = body.discord_webhook_url or settings.default_discord_webhook_url
# Validate credentials if distribution services are requested
invalid_services = []
credential_manager = get_credential_manager()
if body.enable_youtube_upload:
result = credential_manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"youtube ({result.message})")
if effective_dropbox_path:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_gdrive_folder_id:
result = credential_manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"gdrive ({result.message})")
if invalid_services:
raise HTTPException(
status_code=400,
detail={
"error": "credentials_invalid",
"message": f"Distribution services need re-authorization: {', '.join(invalid_services)}",
"invalid_services": invalid_services,
}
)
# Extract request metadata
request_metadata = extract_request_metadata(request, created_from="audio_search")
# Create job
job_create = JobCreate(
artist=body.artist,
title=body.title,
enable_cdg=body.enable_cdg,
enable_txt=body.enable_txt,
brand_prefix=body.brand_prefix,
enable_youtube_upload=body.enable_youtube_upload,
youtube_description=body.youtube_description,
discord_webhook_url=effective_discord_webhook_url,
dropbox_path=effective_dropbox_path,
gdrive_folder_id=effective_gdrive_folder_id,
lyrics_artist=body.lyrics_artist,
lyrics_title=body.lyrics_title,
subtitle_offset_ms=body.subtitle_offset_ms,
clean_instrumental_model=body.clean_instrumental_model,
backing_vocals_models=body.backing_vocals_models,
other_stems_models=body.other_stems_models,
audio_search_artist=body.artist,
audio_search_title=body.title,
auto_download=body.auto_download,
request_metadata=request_metadata,
)
job = job_manager.create_job(job_create)
job_id = job.job_id
logger.info(f"Created job {job_id} for audio search: {body.artist} - {body.title}")
# Update job with audio search fields
job_manager.update_job(job_id, {
'audio_search_artist': body.artist,
'audio_search_title': body.title,
'auto_download': body.auto_download,
})
# Transition to searching state
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.SEARCHING_AUDIO,
progress=5,
message=f"Searching for: {body.artist} - {body.title}"
)
# Perform search
audio_search_service = get_audio_search_service()
try:
search_results = audio_search_service.search(body.artist, body.title)
except NoResultsError as e:
job_manager.fail_job(job_id, f"No audio sources found for: {body.artist} - {body.title}")
raise HTTPException(
status_code=404,
detail={
"error": "no_results",
"message": str(e),
"job_id": job_id,
}
)
except AudioSearchError as e:
job_manager.fail_job(job_id, f"Audio search failed: {e}")
raise HTTPException(status_code=500, detail=f"Search failed: {e}")
# Store results in job state_data
results_dicts = [r.to_dict() for r in search_results]
job_manager.update_job(job_id, {
'state_data': {
'audio_search_results': results_dicts,
'audio_search_count': len(results_dicts),
}
})
# If auto_download, select best and start processing
if body.auto_download:
best_index = audio_search_service.select_best(search_results)
logger.info(f"Auto-download enabled, selecting result {best_index}")
selection_info = await _download_and_start_processing(
job_id=job_id,
selection_index=best_index,
audio_search_service=audio_search_service,
background_tasks=background_tasks,
)
return AudioSearchResponse(
status="success",
job_id=job_id,
message=f"Audio found and download started: {selection_info['selected_artist']} - {selection_info['selected_title']} ({selection_info['selected_provider']})",
results=None, # Don't return results in auto mode
results_count=len(search_results),
auto_download=True,
server_version=VERSION,
)
# Interactive mode: return results for user selection
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.AWAITING_AUDIO_SELECTION,
progress=10,
message=f"Found {len(search_results)} audio sources. Waiting for selection."
)
# Convert to response format with full Release data for rich display
result_responses = []
for r in search_results:
# Get full serialized data from raw_result if available
raw_dict = {}
if r.raw_result:
try:
raw_dict = r.raw_result.to_dict()
except AttributeError:
pass # Not a Release object
result_responses.append(
AudioSearchResultResponse(
index=r.index,
title=r.title,
artist=r.artist,
provider=r.provider,
url=r.url,
duration=r.duration,
quality=r.quality,
source_id=r.source_id,
seeders=raw_dict.get('seeders') or r.seeders,
target_file=raw_dict.get('target_file') or r.target_file,
# Additional fields for rich display
year=raw_dict.get('year'),
label=raw_dict.get('label'),
edition_info=raw_dict.get('edition_info'),
release_type=raw_dict.get('release_type'),
channel=raw_dict.get('channel'),
view_count=raw_dict.get('view_count'),
size_bytes=raw_dict.get('size_bytes'),
target_file_size=raw_dict.get('target_file_size'),
track_pattern=raw_dict.get('track_pattern'),
match_score=raw_dict.get('match_score'),
# Pre-computed display fields
formatted_size=raw_dict.get('formatted_size'),
formatted_duration=raw_dict.get('formatted_duration'),
formatted_views=raw_dict.get('formatted_views'),
is_lossless=raw_dict.get('is_lossless'),
quality_str=raw_dict.get('quality_str'),
# Full quality object for Release.from_dict()
quality_data=raw_dict.get('quality'),
)
)
return AudioSearchResponse(
status="awaiting_selection",
job_id=job_id,
message=f"Found {len(search_results)} audio sources. Call /api/audio-search/{job_id}/select to choose one.",
results=result_responses,
results_count=len(search_results),
auto_download=False,
server_version=VERSION,
)
except HTTPException:
raise
except Exception as e:
logger.error(f"Error in audio search: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=str(e))
@router.get("/audio-search/{job_id}/results")
async def get_audio_search_results(job_id: str):
"""
Get audio search results for a job.
Returns the cached search results so user can select one.
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
search_results = job.state_data.get('audio_search_results', [])
if not search_results:
raise HTTPException(
status_code=400,
detail="No search results available for this job"
)
return {
"status": "success",
"job_id": job_id,
"job_status": job.status,
"artist": job.audio_search_artist or job.artist,
"title": job.audio_search_title or job.title,
"results": search_results,
"results_count": len(search_results),
}
@router.post("/audio-search/{job_id}/select", response_model=AudioSelectResponse)
async def select_audio_source(
job_id: str,
background_tasks: BackgroundTasks,
body: AudioSelectRequest,
):
"""
Select an audio source and start job processing.
This endpoint:
1. Validates the job is awaiting selection
2. Downloads the selected audio
3. Uploads to GCS
4. Triggers audio and lyrics workers
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Verify job is awaiting selection
if job.status != JobStatus.AWAITING_AUDIO_SELECTION:
raise HTTPException(
status_code=400,
detail=f"Job is not awaiting audio selection (status: {job.status})"
)
# Re-instantiate the audio search service (it caches raw results from search)
# For production, we'd need to re-search or store raw results differently
audio_search_service = get_audio_search_service()
# Re-run search to populate the cache
# This is necessary because the service caches raw results in memory
search_results = job.state_data.get('audio_search_results', [])
if not search_results:
raise HTTPException(status_code=400, detail="No search results cached for this job")
artist = job.audio_search_artist or job.artist
title = job.audio_search_title or job.title
try:
# Re-search to populate cache
audio_search_service.search(artist, title)
except Exception as e:
logger.warning(f"Re-search failed, trying direct download: {e}")
selection_info = await _download_and_start_processing(
job_id=job_id,
selection_index=body.selection_index,
audio_search_service=audio_search_service,
background_tasks=background_tasks,
)
return AudioSelectResponse(
status="success",
job_id=job_id,
message="Audio selected and download started",
selected_index=selection_info['selected_index'],
selected_title=selection_info['selected_title'],
selected_artist=selection_info['selected_artist'],
selected_provider=selection_info['selected_provider'],
)
+476
View File
@@ -131,6 +131,10 @@ class CreateJobWithUploadUrlsRequest(BaseModel):
# Existing instrumental configuration (Batch 3)
existing_instrumental: bool = Field(False, description="Whether an existing instrumental file is being uploaded")
# Two-phase workflow configuration (Batch 6)
prep_only: bool = Field(False, description="Stop after review phase, don't run finalisation")
keep_brand_code: Optional[str] = Field(None, description="Preserve existing brand code instead of generating new one")
class SignedUploadUrl(BaseModel):
@@ -638,6 +642,56 @@ VALID_FILE_TYPES = {
'existing_instrumental': ALLOWED_AUDIO_EXTENSIONS, # Batch 3: user-provided instrumental
}
# Valid file types for finalise-only mode (Batch 6)
ALLOWED_VIDEO_EXTENSIONS = {'.mkv', '.mov', '.mp4'}
FINALISE_ONLY_FILE_TYPES = {
'audio': ALLOWED_AUDIO_EXTENSIONS, # Original audio
'with_vocals': ALLOWED_VIDEO_EXTENSIONS, # Karaoke video from prep
'title_screen': ALLOWED_VIDEO_EXTENSIONS, # Title screen video
'end_screen': ALLOWED_VIDEO_EXTENSIONS, # End screen video
'title_jpg': ALLOWED_IMAGE_EXTENSIONS, # Title screen JPG
'title_png': ALLOWED_IMAGE_EXTENSIONS, # Title screen PNG
'end_jpg': ALLOWED_IMAGE_EXTENSIONS, # End screen JPG
'end_png': ALLOWED_IMAGE_EXTENSIONS, # End screen PNG
'instrumental_clean': ALLOWED_AUDIO_EXTENSIONS, # Clean instrumental
'instrumental_backing': ALLOWED_AUDIO_EXTENSIONS, # Instrumental with backing vocals
'lrc': {'.lrc'}, # LRC lyrics
'ass': {'.ass'}, # ASS subtitles
'corrections': {'.json'}, # Corrections JSON
'style_params': {'.json'}, # Style params
}
# Pydantic models for finalise-only flow (Batch 6)
class FinaliseOnlyFileRequest(BaseModel):
"""Information about a prep output file to be uploaded for finalise-only mode."""
filename: str = Field(..., description="Original filename with extension")
content_type: str = Field(..., description="MIME type of the file")
file_type: str = Field(..., description="Type of prep file: 'with_vocals', 'title_screen', 'end_screen', 'instrumental_clean', 'instrumental_backing', 'lrc', etc.")
class CreateFinaliseOnlyJobRequest(BaseModel):
"""Request to create a finalise-only job with prep output files."""
artist: str = Field(..., description="Artist name")
title: str = Field(..., description="Song title")
files: List[FinaliseOnlyFileRequest] = Field(..., description="List of prep output files to upload")
# Processing options
enable_cdg: bool = Field(True, description="Generate CDG+MP3 package")
enable_txt: bool = Field(True, description="Generate TXT+MP3 package")
# Finalisation options
brand_prefix: Optional[str] = Field(None, description="Brand code prefix (e.g., NOMAD)")
keep_brand_code: Optional[str] = Field(None, description="Preserve existing brand code from folder name")
enable_youtube_upload: bool = Field(False, description="Upload to YouTube")
youtube_description: Optional[str] = Field(None, description="YouTube video description text")
discord_webhook_url: Optional[str] = Field(None, description="Discord webhook URL for notifications")
# Distribution options
dropbox_path: Optional[str] = Field(None, description="Dropbox folder path for organized output")
gdrive_folder_id: Optional[str] = Field(None, description="Google Drive folder ID for public share uploads")
async def _validate_audio_durations(
storage: StorageService,
@@ -1243,3 +1297,425 @@ async def create_job_from_url(
except Exception as e:
logger.error(f"Error creating job from URL: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=str(e)) from e
# ============================================================================
# Finalise-Only Upload Flow (Batch 6)
# ============================================================================
def _get_gcs_path_for_finalise_file(job_id: str, file_type: str, filename: str) -> str:
"""Generate the GCS path for a finalise-only file based on its type."""
ext = Path(filename).suffix.lower()
# Map file types to appropriate GCS paths
if file_type == 'audio':
return f"uploads/{job_id}/audio/{filename}"
elif file_type == 'with_vocals':
return f"jobs/{job_id}/videos/with_vocals{ext}"
elif file_type == 'title_screen':
return f"jobs/{job_id}/screens/title{ext}"
elif file_type == 'end_screen':
return f"jobs/{job_id}/screens/end{ext}"
elif file_type == 'title_jpg':
return f"jobs/{job_id}/screens/title.jpg"
elif file_type == 'title_png':
return f"jobs/{job_id}/screens/title.png"
elif file_type == 'end_jpg':
return f"jobs/{job_id}/screens/end.jpg"
elif file_type == 'end_png':
return f"jobs/{job_id}/screens/end.png"
elif file_type == 'instrumental_clean':
return f"jobs/{job_id}/stems/instrumental_clean{ext}"
elif file_type == 'instrumental_backing':
return f"jobs/{job_id}/stems/instrumental_with_backing{ext}"
elif file_type == 'lrc':
return f"jobs/{job_id}/lyrics/karaoke.lrc"
elif file_type == 'ass':
return f"jobs/{job_id}/lyrics/karaoke.ass"
elif file_type == 'corrections':
return f"jobs/{job_id}/lyrics/corrections.json"
elif file_type == 'style_params':
return f"uploads/{job_id}/style/style_params.json"
else:
return f"uploads/{job_id}/other/{filename}"
@router.post("/jobs/create-finalise-only")
async def create_finalise_only_job(
request: Request,
body: CreateFinaliseOnlyJobRequest,
):
"""
Create a finalise-only job for continuing from a local prep phase.
This endpoint is used when:
1. User previously ran --prep-only which created local prep outputs
2. User optionally made manual edits to stems, lyrics, etc.
3. User now wants cloud to handle finalisation (encoding, distribution)
Required files:
- with_vocals: The karaoke video from prep (*.mkv or *.mov)
- title_screen: Title screen video
- end_screen: End screen video
- instrumental_clean or instrumental_backing: At least one instrumental
The endpoint returns signed URLs for uploading all the prep files.
"""
try:
# Validate files list
if not body.files:
raise HTTPException(status_code=400, detail="At least one file is required")
# Validate file types
file_types = {f.file_type for f in body.files}
# Check required files for finalise-only
if 'with_vocals' not in file_types:
raise HTTPException(
status_code=400,
detail="with_vocals video is required for finalise-only mode"
)
if 'title_screen' not in file_types:
raise HTTPException(
status_code=400,
detail="title_screen video is required for finalise-only mode"
)
if 'end_screen' not in file_types:
raise HTTPException(
status_code=400,
detail="end_screen video is required for finalise-only mode"
)
if 'instrumental_clean' not in file_types and 'instrumental_backing' not in file_types:
raise HTTPException(
status_code=400,
detail="At least one instrumental (clean or backing) is required"
)
# Validate file extensions
for file_info in body.files:
if file_info.file_type not in FINALISE_ONLY_FILE_TYPES:
raise HTTPException(
status_code=400,
detail=f"Invalid file_type: '{file_info.file_type}'. Valid types: {list(FINALISE_ONLY_FILE_TYPES.keys())}"
)
ext = Path(file_info.filename).suffix.lower()
allowed_extensions = FINALISE_ONLY_FILE_TYPES[file_info.file_type]
if ext not in allowed_extensions:
raise HTTPException(
status_code=400,
detail=f"Invalid file extension '{ext}' for file_type '{file_info.file_type}'. Allowed: {allowed_extensions}"
)
# Apply default distribution settings
settings = get_settings()
effective_dropbox_path = body.dropbox_path or settings.default_dropbox_path
effective_gdrive_folder_id = body.gdrive_folder_id or settings.default_gdrive_folder_id
effective_discord_webhook_url = body.discord_webhook_url or settings.default_discord_webhook_url
# Validate distribution credentials if services are requested
invalid_services = []
credential_manager = get_credential_manager()
if body.enable_youtube_upload:
result = credential_manager.check_youtube_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"youtube ({result.message})")
if effective_dropbox_path:
result = credential_manager.check_dropbox_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"dropbox ({result.message})")
if effective_gdrive_folder_id:
result = credential_manager.check_gdrive_credentials()
if result.status != CredentialStatus.VALID:
invalid_services.append(f"gdrive ({result.message})")
if invalid_services:
raise HTTPException(
status_code=400,
detail={
"error": "credentials_invalid",
"message": f"The following distribution services need re-authorization: {', '.join(invalid_services)}",
"invalid_services": invalid_services,
"auth_url": "/api/auth/status"
}
)
# Extract request metadata
request_metadata = extract_request_metadata(request, created_from="finalise_only_upload")
# Create job with finalise_only=True
job_create = JobCreate(
artist=body.artist,
title=body.title,
filename="finalise_only", # No single audio file - using prep outputs
enable_cdg=body.enable_cdg,
enable_txt=body.enable_txt,
brand_prefix=body.brand_prefix,
enable_youtube_upload=body.enable_youtube_upload,
youtube_description=body.youtube_description,
discord_webhook_url=effective_discord_webhook_url,
dropbox_path=effective_dropbox_path,
gdrive_folder_id=effective_gdrive_folder_id,
finalise_only=True,
keep_brand_code=body.keep_brand_code,
request_metadata=request_metadata,
)
job = job_manager.create_job(job_create)
job_id = job.job_id
logger.info(f"Created finalise-only job {job_id} for {body.artist} - {body.title}")
# Generate signed upload URLs for each file
upload_urls = []
for file_info in body.files:
gcs_path = _get_gcs_path_for_finalise_file(job_id, file_info.file_type, file_info.filename)
# Generate signed upload URL (valid for 60 minutes)
signed_url = storage_service.generate_signed_upload_url(
gcs_path,
content_type=file_info.content_type,
expiration_minutes=60
)
upload_urls.append(SignedUploadUrl(
file_type=file_info.file_type,
gcs_path=gcs_path,
upload_url=signed_url,
content_type=file_info.content_type
))
logger.info(f"Generated signed upload URL for {file_info.file_type}: {gcs_path}")
return CreateJobWithUploadUrlsResponse(
status="success",
job_id=job_id,
message="Finalise-only job created. Upload files to the provided URLs, then call /api/jobs/{job_id}/finalise-uploads-complete",
upload_urls=upload_urls,
server_version=VERSION
)
except HTTPException:
raise
except Exception as e:
logger.error(f"Error creating finalise-only job: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=str(e)) from e
@router.post("/jobs/{job_id}/finalise-uploads-complete")
async def mark_finalise_uploads_complete(
job_id: str,
background_tasks: BackgroundTasks,
body: UploadsCompleteRequest,
):
"""
Mark finalise-only file uploads as complete and start video generation.
This is called after uploading prep outputs for a finalise-only job.
The job will transition directly to AWAITING_INSTRUMENTAL_SELECTION.
"""
try:
# Get job and verify it exists
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail=f"Job {job_id} not found")
# Verify job is in pending state and is finalise-only
if job.status != JobStatus.PENDING:
raise HTTPException(
status_code=400,
detail=f"Job {job_id} is not in pending state (current: {job.status}). Cannot complete uploads."
)
if not job.finalise_only:
raise HTTPException(
status_code=400,
detail=f"Job {job_id} is not a finalise-only job. Use /api/jobs/{{job_id}}/uploads-complete instead."
)
# Validate required files were uploaded
required_files = {'with_vocals', 'title_screen', 'end_screen'}
uploaded_set = set(body.uploaded_files)
missing_files = required_files - uploaded_set
if missing_files:
raise HTTPException(
status_code=400,
detail=f"Missing required files: {missing_files}"
)
# Require at least one instrumental
if 'instrumental_clean' not in uploaded_set and 'instrumental_backing' not in uploaded_set:
raise HTTPException(
status_code=400,
detail="At least one instrumental (clean or backing) is required"
)
# Build file_urls structure from uploaded files
file_urls: Dict[str, Dict[str, str]] = {
'videos': {},
'screens': {},
'stems': {},
'lyrics': {},
}
for file_type in body.uploaded_files:
if file_type not in FINALISE_ONLY_FILE_TYPES:
logger.warning(f"Unknown file_type in uploaded_files: {file_type}")
continue
# Determine the GCS path - we need to find the actual file
if file_type == 'audio':
prefix = f"uploads/{job_id}/audio/"
elif file_type == 'with_vocals':
prefix = f"jobs/{job_id}/videos/with_vocals"
elif file_type == 'title_screen':
prefix = f"jobs/{job_id}/screens/title"
elif file_type == 'end_screen':
prefix = f"jobs/{job_id}/screens/end"
elif file_type == 'title_jpg':
prefix = f"jobs/{job_id}/screens/title.jpg"
elif file_type == 'title_png':
prefix = f"jobs/{job_id}/screens/title.png"
elif file_type == 'end_jpg':
prefix = f"jobs/{job_id}/screens/end.jpg"
elif file_type == 'end_png':
prefix = f"jobs/{job_id}/screens/end.png"
elif file_type == 'instrumental_clean':
prefix = f"jobs/{job_id}/stems/instrumental_clean"
elif file_type == 'instrumental_backing':
prefix = f"jobs/{job_id}/stems/instrumental_with_backing"
elif file_type == 'lrc':
prefix = f"jobs/{job_id}/lyrics/karaoke.lrc"
elif file_type == 'ass':
prefix = f"jobs/{job_id}/lyrics/karaoke.ass"
elif file_type == 'corrections':
prefix = f"jobs/{job_id}/lyrics/corrections"
elif file_type == 'style_params':
prefix = f"uploads/{job_id}/style/style_params"
else:
continue
# List files with this prefix to find the actual uploaded file
files = storage_service.list_files(prefix)
if not files:
raise HTTPException(
status_code=400,
detail=f"File for '{file_type}' was not uploaded to GCS. Expected prefix: {prefix}"
)
gcs_path = files[0]
# Map to file_urls structure
if file_type == 'audio':
pass # Handled separately
elif file_type == 'with_vocals':
file_urls['videos']['with_vocals'] = gcs_path
elif file_type == 'title_screen':
file_urls['screens']['title'] = gcs_path
elif file_type == 'end_screen':
file_urls['screens']['end'] = gcs_path
elif file_type == 'title_jpg':
file_urls['screens']['title_jpg'] = gcs_path
elif file_type == 'title_png':
file_urls['screens']['title_png'] = gcs_path
elif file_type == 'end_jpg':
file_urls['screens']['end_jpg'] = gcs_path
elif file_type == 'end_png':
file_urls['screens']['end_png'] = gcs_path
elif file_type == 'instrumental_clean':
file_urls['stems']['instrumental_clean'] = gcs_path
elif file_type == 'instrumental_backing':
file_urls['stems']['instrumental_with_backing'] = gcs_path
elif file_type == 'lrc':
file_urls['lyrics']['lrc'] = gcs_path
elif file_type == 'ass':
file_urls['lyrics']['ass'] = gcs_path
elif file_type == 'corrections':
file_urls['lyrics']['corrections'] = gcs_path
# Get audio path if uploaded
audio_gcs_path = None
if 'audio' in body.uploaded_files:
audio_files = storage_service.list_files(f"uploads/{job_id}/audio/")
if audio_files:
audio_gcs_path = audio_files[0]
# Update job with file paths
update_data = {
'file_urls': file_urls,
'finalise_only': True,
}
if audio_gcs_path:
update_data['input_media_gcs_path'] = audio_gcs_path
# Mark parallel processing as complete (we're skipping it)
update_data['state_data'] = {
'audio_complete': True,
'lyrics_complete': True,
'finalise_only': True,
}
job_manager.update_job(job_id, update_data)
logger.info(f"Validated finalise-only uploads for job {job_id}: {body.uploaded_files}")
# Transition directly to AWAITING_INSTRUMENTAL_SELECTION
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
progress=80,
message="Prep files uploaded - select your instrumental"
)
# Get distribution services info for response
credential_manager = get_credential_manager()
distribution_services: Dict[str, Any] = {}
updated_job = job_manager.get_job(job_id)
if updated_job.dropbox_path:
dropbox_result = credential_manager.check_dropbox_credentials()
distribution_services["dropbox"] = {
"enabled": True,
"path": updated_job.dropbox_path,
"credentials_valid": dropbox_result.status == CredentialStatus.VALID,
}
if updated_job.gdrive_folder_id:
gdrive_result = credential_manager.check_gdrive_credentials()
distribution_services["gdrive"] = {
"enabled": True,
"folder_id": updated_job.gdrive_folder_id,
"credentials_valid": gdrive_result.status == CredentialStatus.VALID,
}
if updated_job.enable_youtube_upload:
youtube_result = credential_manager.check_youtube_credentials()
distribution_services["youtube"] = {
"enabled": True,
"credentials_valid": youtube_result.status == CredentialStatus.VALID,
}
if updated_job.discord_webhook_url:
distribution_services["discord"] = {
"enabled": True,
}
return {
"status": "success",
"job_id": job_id,
"message": "Finalise-only uploads validated. Select instrumental to continue.",
"files_validated": body.uploaded_files,
"server_version": VERSION,
"distribution_services": distribution_services,
}
except HTTPException:
raise
except Exception as e:
logger.error(f"Error completing finalise-only uploads for job {job_id}: {e}", exc_info=True)
raise HTTPException(status_code=500, detail=str(e)) from e
+116 -1
View File
@@ -1,10 +1,64 @@
"""
Health check routes.
"""
import os
import logging
from fastapi import APIRouter
from typing import Dict
from typing import Dict, Any, Optional
from backend.version import VERSION
from backend.services.flacfetch_client import get_flacfetch_client
router = APIRouter()
logger = logging.getLogger(__name__)
def check_transmission_status() -> Dict[str, Any]:
"""Check if Transmission daemon is available and responsive."""
try:
import transmission_rpc
host = os.environ.get("TRANSMISSION_HOST", "localhost")
port = int(os.environ.get("TRANSMISSION_PORT", "9091"))
client = transmission_rpc.Client(host=host, port=port, timeout=5)
stats = client.session_stats()
# Get detailed torrent info
torrents = client.get_torrents()
torrent_details = []
for t in torrents:
torrent_info = {
"name": t.name,
"progress": round(t.progress, 1),
"status": str(t.status),
"peers": t.peers_connected if hasattr(t, 'peers_connected') else 0,
"download_speed": round(t.rate_download / 1024, 1) if hasattr(t, 'rate_download') else 0, # KB/s
}
# Check if stalled (downloading but no progress and no peers)
if t.status.downloading and t.progress < 100 and torrent_info['peers'] == 0:
torrent_info['stalled'] = True
torrent_details.append(torrent_info)
return {
"available": True,
"host": host,
"port": port,
"download_dir": stats.download_dir if hasattr(stats, 'download_dir') else None,
"active_torrent_count": stats.active_torrent_count if hasattr(stats, 'active_torrent_count') else 0,
"torrents": torrent_details,
}
except ImportError as e:
return {
"available": False,
"error": f"transmission_rpc not installed: {e}",
}
except Exception as e:
return {
"available": False,
"host": os.environ.get("TRANSMISSION_HOST", "localhost"),
"port": int(os.environ.get("TRANSMISSION_PORT", "9091")),
"error": str(e),
}
@router.get("/health")
@@ -16,6 +70,67 @@ async def health_check() -> Dict[str, str]:
}
async def check_flacfetch_service_status() -> Dict[str, Any]:
"""Check if remote flacfetch service is available and healthy."""
client = get_flacfetch_client()
if not client:
return {
"configured": False,
"message": "Remote flacfetch service not configured (FLACFETCH_API_URL not set)",
}
try:
health = await client.health_check()
return {
"configured": True,
"available": True,
"status": health.get("status"),
"version": health.get("version"),
"transmission": health.get("transmission", {}),
"disk": health.get("disk", {}),
"providers": health.get("providers", {}),
}
except Exception as e:
return {
"configured": True,
"available": False,
"error": str(e),
}
@router.get("/health/detailed")
async def detailed_health_check() -> Dict[str, Any]:
"""
Detailed health check including dependencies.
Use this to debug issues with Transmission, flacfetch service, etc.
"""
transmission_status = check_transmission_status()
flacfetch_status = await check_flacfetch_service_status()
# Log for debugging
if not transmission_status.get("available"):
logger.warning(f"Local Transmission not available: {transmission_status.get('error')}")
else:
logger.info(f"Local Transmission available at {transmission_status.get('host')}:{transmission_status.get('port')}")
if flacfetch_status.get("configured") and not flacfetch_status.get("available"):
logger.warning(f"Remote flacfetch service not available: {flacfetch_status.get('error')}")
elif flacfetch_status.get("available"):
logger.info(f"Remote flacfetch service healthy: {flacfetch_status.get('status')}")
return {
"status": "healthy",
"service": "karaoke-gen-backend",
"version": VERSION,
"dependencies": {
"transmission_local": transmission_status,
"flacfetch_remote": flacfetch_status,
}
}
@router.get("/readiness")
async def readiness_check() -> Dict[str, str]:
"""Readiness check endpoint for Cloud Run."""
+307 -1
View File
@@ -19,7 +19,8 @@ from backend.models.requests import (
CorrectionsSubmission,
InstrumentalSelection,
StartReviewRequest,
CancelJobRequest
CancelJobRequest,
CreateCustomInstrumentalRequest,
)
from backend.services.job_manager import JobManager
from backend.services.worker_service import get_worker_service
@@ -523,6 +524,311 @@ async def get_instrumental_options(job_id: str) -> Dict[str, Any]:
}
@router.get("/{job_id}/instrumental-analysis")
async def get_instrumental_analysis(job_id: str) -> Dict[str, Any]:
"""
Get audio analysis data for instrumental selection.
Returns:
- Analysis of backing vocals (audible segments, recommendation)
- Waveform image URL
- Audio stream URLs for playback
This endpoint enables intelligent instrumental selection by providing
detailed analysis of the backing vocals track.
"""
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
if job.status != JobStatus.AWAITING_INSTRUMENTAL_SELECTION:
raise HTTPException(
status_code=400,
detail=f"Job not ready for instrumental analysis (current status: {job.status})"
)
storage = StorageService()
# Get analysis from state_data (populated by render_video_worker)
analysis_data = job.state_data.get('backing_vocals_analysis', {})
# Get URLs
stems = job.file_urls.get('stems', {})
analysis_files = job.file_urls.get('analysis', {})
clean_url = stems.get('instrumental_clean')
backing_vocals_url = stems.get('backing_vocals')
with_backing_url = stems.get('instrumental_with_backing')
waveform_url = analysis_files.get('backing_vocals_waveform')
custom_instrumental_url = stems.get('instrumental_custom')
# Build response
response = {
"job_id": job_id,
"artist": job.artist,
"title": job.title,
"status": job.status,
# Analysis results
"analysis": {
"has_audible_content": analysis_data.get('has_audible_content', False),
"total_duration_seconds": analysis_data.get('total_duration_seconds', 0),
"audible_segments": analysis_data.get('audible_segments', []),
"recommended_selection": analysis_data.get('recommended_selection', 'review_needed'),
"total_audible_duration_seconds": analysis_data.get('total_audible_duration_seconds', 0),
"audible_percentage": analysis_data.get('audible_percentage', 0),
"silence_threshold_db": analysis_data.get('silence_threshold_db', -40.0),
},
# Audio URLs for playback
"audio_urls": {
"clean_instrumental": storage.generate_signed_url(clean_url, expiration_minutes=120) if clean_url else None,
"backing_vocals": storage.generate_signed_url(backing_vocals_url, expiration_minutes=120) if backing_vocals_url else None,
"with_backing": storage.generate_signed_url(with_backing_url, expiration_minutes=120) if with_backing_url else None,
"custom_instrumental": storage.generate_signed_url(custom_instrumental_url, expiration_minutes=120) if custom_instrumental_url else None,
},
# Waveform image URL
"waveform_url": storage.generate_signed_url(waveform_url, expiration_minutes=120) if waveform_url else None,
# Whether a custom instrumental has been created
"has_custom_instrumental": custom_instrumental_url is not None,
}
return response
@router.get("/{job_id}/audio-stream/{stem_type}")
async def stream_audio(job_id: str, stem_type: str):
"""
Stream an audio file for playback in the browser.
Supported stem_type values:
- clean_instrumental: Clean instrumental (no backing vocals)
- backing_vocals: Backing vocals only
- with_backing: Instrumental with backing vocals
- custom_instrumental: Custom instrumental (if created)
Returns audio as a streaming response with proper headers for
browser audio playback.
"""
from fastapi.responses import StreamingResponse
import tempfile
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
# Map stem_type to file_urls key
stem_map = {
'clean_instrumental': ('stems', 'instrumental_clean'),
'backing_vocals': ('stems', 'backing_vocals'),
'with_backing': ('stems', 'instrumental_with_backing'),
'custom_instrumental': ('stems', 'instrumental_custom'),
}
if stem_type not in stem_map:
raise HTTPException(
status_code=400,
detail=f"Invalid stem_type. Must be one of: {list(stem_map.keys())}"
)
category, key = stem_map[stem_type]
gcs_path = job.file_urls.get(category, {}).get(key)
if not gcs_path:
raise HTTPException(
status_code=404,
detail=f"Audio file not available: {stem_type}"
)
# Determine content type
ext = gcs_path.split('.')[-1].lower()
content_types = {
'flac': 'audio/flac',
'mp3': 'audio/mpeg',
'wav': 'audio/wav',
'm4a': 'audio/mp4',
}
content_type = content_types.get(ext, 'audio/flac')
try:
storage = StorageService()
with tempfile.NamedTemporaryFile(delete=False, suffix=f'.{ext}') as tmp:
tmp_path = tmp.name
storage.download_file(gcs_path, tmp_path)
def file_iterator():
try:
with open(tmp_path, 'rb') as f:
while chunk := f.read(8192):
yield chunk
finally:
import os
os.unlink(tmp_path)
filename = gcs_path.split('/')[-1]
return StreamingResponse(
file_iterator(),
media_type=content_type,
headers={
'Content-Disposition': f'inline; filename="{filename}"',
'Accept-Ranges': 'bytes',
}
)
except Exception as e:
logger.exception(f"Error streaming audio {gcs_path}: {e}")
raise HTTPException(status_code=500, detail=f"Error streaming audio: {e}") from e
@router.post("/{job_id}/create-custom-instrumental")
async def create_custom_instrumental(
job_id: str,
request: CreateCustomInstrumentalRequest,
) -> Dict[str, Any]:
"""
Create a custom instrumental by muting regions of backing vocals.
This endpoint:
1. Takes a list of time ranges to mute in the backing vocals
2. Creates a custom instrumental (clean + muted backing vocals)
3. Stores the result and makes it available for selection
After calling this endpoint, the user can select "custom" in the
select-instrumental endpoint.
"""
from backend.services.audio_editing_service import AudioEditingService
from karaoke_gen.instrumental_review import MuteRegion
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
if job.status != JobStatus.AWAITING_INSTRUMENTAL_SELECTION:
raise HTTPException(
status_code=400,
detail=f"Job not ready for custom instrumental creation (current status: {job.status})"
)
# Get stem paths
stems = job.file_urls.get('stems', {})
clean_path = stems.get('instrumental_clean')
backing_path = stems.get('backing_vocals')
if not clean_path or not backing_path:
raise HTTPException(
status_code=500,
detail="Required audio files not available"
)
try:
# Convert request mute regions to model objects
mute_regions = [
MuteRegion(
start_seconds=r.start_seconds,
end_seconds=r.end_seconds
)
for r in request.mute_regions
]
# Create custom instrumental
editing_service = AudioEditingService()
# Determine output path
output_path = f"jobs/{job_id}/stems/instrumental_custom.flac"
result = editing_service.create_custom_instrumental(
gcs_clean_instrumental_path=clean_path,
gcs_backing_vocals_path=backing_path,
mute_regions=mute_regions,
gcs_output_path=output_path,
job_id=job_id,
)
# Update job file_urls with custom instrumental
job_manager.update_file_url(job_id, 'stems', 'instrumental_custom', output_path)
# Store mute regions in state_data for reference
job_manager.update_state_data(job_id, 'custom_instrumental_mute_regions', [
{"start_seconds": r.start_seconds, "end_seconds": r.end_seconds}
for r in mute_regions
])
logger.info(f"Job {job_id}: Custom instrumental created with {len(mute_regions)} mute regions")
# Generate signed URL for the new file
storage = StorageService()
return {
"status": "success",
"message": "Custom instrumental created successfully",
"custom_instrumental_url": storage.generate_signed_url(output_path, expiration_minutes=120),
"mute_regions_applied": len(result.mute_regions_applied),
"total_muted_duration_seconds": result.total_muted_duration_seconds,
"output_duration_seconds": result.output_duration_seconds,
}
except Exception as e:
logger.exception(f"Error creating custom instrumental for job {job_id}: {e}")
raise HTTPException(status_code=500, detail=str(e)) from e
@router.get("/{job_id}/waveform-data")
async def get_waveform_data(job_id: str, num_points: int = 500) -> Dict[str, Any]:
"""
Get waveform amplitude data for client-side rendering.
This endpoint returns raw amplitude data that the frontend can use
to render a waveform using Canvas or SVG, enabling interactive
features like click-to-seek.
Args:
num_points: Number of data points to return (default 500)
Returns:
{
"amplitudes": [0.1, 0.2, ...], # Normalized 0-1 values
"duration_seconds": 180.5,
"num_points": 500
}
"""
from backend.services.audio_analysis_service import AudioAnalysisService
job = job_manager.get_job(job_id)
if not job:
raise HTTPException(status_code=404, detail="Job not found")
if job.status != JobStatus.AWAITING_INSTRUMENTAL_SELECTION:
raise HTTPException(
status_code=400,
detail=f"Job not ready for waveform data (current status: {job.status})"
)
backing_vocals_path = job.file_urls.get('stems', {}).get('backing_vocals')
if not backing_vocals_path:
raise HTTPException(status_code=404, detail="Backing vocals file not found")
try:
analysis_service = AudioAnalysisService()
amplitudes, duration = analysis_service.get_waveform_data(
gcs_audio_path=backing_vocals_path,
job_id=job_id,
num_points=num_points,
)
return {
"amplitudes": amplitudes,
"duration_seconds": duration,
"num_points": len(amplitudes),
}
except Exception as e:
logger.exception(f"Error getting waveform data for job {job_id}: {e}")
raise HTTPException(status_code=500, detail=str(e)) from e
@router.post("/{job_id}/select-instrumental")
async def select_instrumental(
job_id: str,
+6
View File
@@ -56,6 +56,12 @@ class Settings(BaseSettings):
# Storage paths
temp_dir: str = os.getenv("TEMP_DIR", "/tmp/karaoke-gen")
# Flacfetch remote service (for torrent downloads)
# When configured, audio search uses the remote flacfetch HTTP API instead of local flacfetch.
# This is required for torrent downloads since Cloud Run doesn't support BitTorrent.
flacfetch_api_url: Optional[str] = os.getenv("FLACFETCH_API_URL") # e.g., http://10.0.0.5:8080
flacfetch_api_key: Optional[str] = os.getenv("FLACFETCH_API_KEY")
# Default distribution settings (can be overridden per-request)
default_dropbox_path: Optional[str] = os.getenv("DEFAULT_DROPBOX_PATH")
default_gdrive_folder_id: Optional[str] = os.getenv("DEFAULT_GDRIVE_FOLDER_ID")
+2 -1
View File
@@ -7,7 +7,7 @@ from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from backend.config import settings
from backend.api.routes import health, jobs, internal, file_upload, review, auth
from backend.api.routes import health, jobs, internal, file_upload, review, auth, audio_search
from backend.services.tracing import setup_tracing, instrument_app, get_current_trace_id
@@ -108,6 +108,7 @@ app.include_router(file_upload.router, prefix="/api") # File upload endpoint
app.include_router(internal.router, prefix="/api") # Internal worker endpoints
app.include_router(review.router, prefix="/api") # Review UI compatibility endpoints
app.include_router(auth.router, prefix="/api") # OAuth credential management
app.include_router(audio_search.router, prefix="/api") # Audio search (artist+title mode)
@app.get("/")
+42 -6
View File
@@ -14,8 +14,8 @@ class JobStatus(str, Enum):
"""
Job status enumeration - Complete state machine.
The workflow has 8 main stages with 2 human interaction points:
1. Input & Setup
The workflow has 8 main stages with 3 human interaction points:
1. Input & Setup (may include audio source selection)
2. Parallel Processing (audio + lyrics)
3. Title/End Screen Generation
4. Countdown Padding Synchronization
@@ -26,6 +26,12 @@ class JobStatus(str, Enum):
"""
# Initial states
PENDING = "pending" # Job created, queued for processing
# Audio search states (for artist+title search mode)
SEARCHING_AUDIO = "searching_audio" # Searching for audio sources via flacfetch
AWAITING_AUDIO_SELECTION = "awaiting_audio_selection" # ⚠️ WAITING FOR USER - select audio source
DOWNLOADING_AUDIO = "downloading_audio" # Downloading selected audio from source
DOWNLOADING = "downloading" # Downloading from URL or processing upload
# Stage 2a: Audio separation (parallel track 1)
@@ -67,6 +73,7 @@ class JobStatus(str, Enum):
# Terminal states
COMPLETE = "complete" # All processing finished successfully
PREP_COMPLETE = "prep_complete" # Prep-only job completed (stops after review)
FAILED = "failed" # Unrecoverable error occurred
CANCELLED = "cancelled" # User cancelled the job
@@ -80,7 +87,14 @@ class JobStatus(str, Enum):
# Valid state transitions
STATE_TRANSITIONS = {
JobStatus.PENDING: [JobStatus.DOWNLOADING, JobStatus.FAILED, JobStatus.CANCELLED],
# PENDING can go to DOWNLOADING (file upload), SEARCHING_AUDIO (artist+title search), or AWAITING_INSTRUMENTAL_SELECTION (finalise-only)
JobStatus.PENDING: [JobStatus.DOWNLOADING, JobStatus.SEARCHING_AUDIO, JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.FAILED, JobStatus.CANCELLED],
# Audio search flow (for artist+title search mode)
JobStatus.SEARCHING_AUDIO: [JobStatus.AWAITING_AUDIO_SELECTION, JobStatus.DOWNLOADING_AUDIO, JobStatus.FAILED],
JobStatus.AWAITING_AUDIO_SELECTION: [JobStatus.DOWNLOADING_AUDIO, JobStatus.FAILED, JobStatus.CANCELLED],
JobStatus.DOWNLOADING_AUDIO: [JobStatus.DOWNLOADING, JobStatus.FAILED],
# DOWNLOADING allows parallel processing (audio + lyrics) and then screens when both complete
JobStatus.DOWNLOADING: [JobStatus.SEPARATING_STAGE1, JobStatus.TRANSCRIBING, JobStatus.GENERATING_SCREENS, JobStatus.FAILED],
@@ -102,10 +116,10 @@ STATE_TRANSITIONS = {
# AWAITING_REVIEW can go directly to REVIEW_COMPLETE (quick review) or to IN_REVIEW (editing)
JobStatus.AWAITING_REVIEW: [JobStatus.IN_REVIEW, JobStatus.REVIEW_COMPLETE, JobStatus.FAILED, JobStatus.CANCELLED],
JobStatus.IN_REVIEW: [JobStatus.REVIEW_COMPLETE, JobStatus.AWAITING_REVIEW, JobStatus.FAILED],
JobStatus.REVIEW_COMPLETE: [JobStatus.RENDERING_VIDEO, JobStatus.FAILED],
JobStatus.REVIEW_COMPLETE: [JobStatus.RENDERING_VIDEO, JobStatus.PREP_COMPLETE, JobStatus.FAILED], # PREP_COMPLETE for prep-only jobs
# Video rendering (post-review)
JobStatus.RENDERING_VIDEO: [JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.FAILED],
JobStatus.RENDERING_VIDEO: [JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.PREP_COMPLETE, JobStatus.FAILED],
# Instrumental selection flow
JobStatus.AWAITING_INSTRUMENTAL_SELECTION: [JobStatus.INSTRUMENTAL_SELECTED, JobStatus.FAILED, JobStatus.CANCELLED],
@@ -120,9 +134,11 @@ STATE_TRANSITIONS = {
JobStatus.UPLOADING: [JobStatus.NOTIFYING, JobStatus.COMPLETE, JobStatus.FAILED],
JobStatus.NOTIFYING: [JobStatus.COMPLETE, JobStatus.FAILED],
# Terminal states - COMPLETE and CANCELLED have no transitions
# Terminal states - COMPLETE, PREP_COMPLETE, and CANCELLED have no transitions
# FAILED allows retry transitions to resume from checkpoints
# PREP_COMPLETE allows finalise-only continuation
JobStatus.COMPLETE: [],
JobStatus.PREP_COMPLETE: [JobStatus.AWAITING_INSTRUMENTAL_SELECTION, JobStatus.FAILED], # Finalise-only continues from here
JobStatus.FAILED: [
JobStatus.INSTRUMENTAL_SELECTED, # Retry from video generation
JobStatus.REVIEW_COMPLETE, # Retry from render stage
@@ -225,6 +241,16 @@ class Job(BaseModel):
# Existing instrumental configuration (Batch 3)
existing_instrumental_gcs_path: Optional[str] = None # GCS path to user-provided instrumental file
# Audio search configuration (Batch 5 - artist+title search mode)
audio_search_artist: Optional[str] = None # Artist name used for audio search
audio_search_title: Optional[str] = None # Title used for audio search
auto_download: bool = False # Auto-select best audio source (skip selection)
# Two-phase workflow configuration (Batch 6)
prep_only: bool = False # Stop after review, don't run finalisation
finalise_only: bool = False # Skip prep, run only finalisation (requires uploaded prep outputs)
keep_brand_code: Optional[str] = None # Preserve existing brand code instead of generating new one
# Processing state
track_output_dir: Optional[str] = None # Local output directory (temp)
audio_hash: Optional[str] = None # Hash for deduplication
@@ -401,6 +427,16 @@ class JobCreate(BaseModel):
# Existing instrumental configuration (Batch 3)
existing_instrumental_gcs_path: Optional[str] = None # GCS path to user-provided instrumental file
# Audio search configuration (Batch 5 - artist+title search mode)
audio_search_artist: Optional[str] = None # Artist name used for audio search
audio_search_title: Optional[str] = None # Title used for audio search
auto_download: bool = False # Auto-select best audio source (skip selection)
# Two-phase workflow configuration (Batch 6)
prep_only: bool = False # Stop after review, don't run finalisation
finalise_only: bool = False # Skip prep, run only finalisation
keep_brand_code: Optional[str] = None # Preserve existing brand code instead of generating new one
# Request metadata (set by API endpoint from request headers)
request_metadata: Dict[str, Any] = Field(default_factory=dict)
"""
+38 -3
View File
@@ -59,19 +59,54 @@ class InstrumentalSelection(BaseModel):
Request to select instrumental audio option.
This is the second critical human-in-the-loop interaction point.
User chooses between clean instrumental or instrumental with backing vocals.
User chooses between clean instrumental, instrumental with backing vocals,
or a custom instrumental (created via create-custom-instrumental endpoint).
"""
selection: str # "clean" or "with_backing"
selection: str # "clean", "with_backing", or "custom"
@validator('selection')
def validate_selection(cls, v):
"""Validate selection is a valid option."""
valid_options = ['clean', 'with_backing']
valid_options = ['clean', 'with_backing', 'custom']
if v not in valid_options:
raise ValueError(f"Selection must be one of: {valid_options}")
return v
class MuteRegionRequest(BaseModel):
"""A region to mute in the backing vocals."""
start_seconds: float
end_seconds: float
@validator('start_seconds')
def validate_start(cls, v):
if v < 0:
raise ValueError("start_seconds must be non-negative")
return v
@validator('end_seconds')
def validate_end(cls, v, values):
if 'start_seconds' in values and v <= values['start_seconds']:
raise ValueError("end_seconds must be greater than start_seconds")
return v
class CreateCustomInstrumentalRequest(BaseModel):
"""
Request to create a custom instrumental with muted backing vocal regions.
The mute_regions specify time ranges in the backing vocals track that
should be silenced before mixing with the clean instrumental.
"""
mute_regions: List[MuteRegionRequest]
@validator('mute_regions')
def validate_regions(cls, v):
if not v:
raise ValueError("At least one mute region is required")
return v
class StartReviewRequest(BaseModel):
"""Request to mark job as in-review (user opened interface)."""
pass # No body needed, just triggers state transition
+243
View File
@@ -0,0 +1,243 @@
"""
Audio analysis service for analyzing backing vocals.
This service wraps the shared karaoke_gen.instrumental_review module
to provide GCS-integrated audio analysis capabilities.
"""
import logging
import os
import tempfile
from typing import Optional
from backend.services.storage_service import StorageService
from karaoke_gen.instrumental_review import (
AudioAnalyzer,
AnalysisResult,
WaveformGenerator,
)
logger = logging.getLogger(__name__)
class AudioAnalysisService:
"""
Service for analyzing backing vocals audio files stored in GCS.
This service acts as a thin wrapper around the shared AudioAnalyzer
and WaveformGenerator classes, handling GCS download/upload operations.
The actual analysis logic is in the shared karaoke_gen.instrumental_review
module, ensuring feature parity between local and remote workflows.
"""
def __init__(
self,
storage_service: Optional[StorageService] = None,
silence_threshold_db: float = -40.0,
min_segment_duration_ms: int = 100,
):
"""
Initialize the audio analysis service.
Args:
storage_service: GCS storage service. If not provided, a new
instance will be created.
silence_threshold_db: Threshold for considering audio as silent.
Default is -40.0 dB.
min_segment_duration_ms: Minimum duration for audible segments.
Default is 100ms.
"""
self.storage_service = storage_service or StorageService()
self.analyzer = AudioAnalyzer(
silence_threshold_db=silence_threshold_db,
min_segment_duration_ms=min_segment_duration_ms,
)
self.waveform_generator = WaveformGenerator()
def analyze_backing_vocals(
self,
gcs_audio_path: str,
job_id: str,
) -> AnalysisResult:
"""
Analyze a backing vocals audio file from GCS.
This method:
1. Downloads the audio file from GCS to a temp file
2. Runs the analysis using the shared AudioAnalyzer
3. Returns the analysis result
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
Returns:
AnalysisResult containing analysis data
"""
logger.info(f"[{job_id}] Analyzing backing vocals: {gcs_audio_path}")
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# Run analysis
result = self.analyzer.analyze(local_audio_path)
logger.info(
f"[{job_id}] Analysis complete: "
f"has_audible={result.has_audible_content}, "
f"segments={result.segment_count}, "
f"recommendation={result.recommended_selection.value}"
)
return result
def analyze_and_generate_waveform(
self,
gcs_audio_path: str,
job_id: str,
gcs_waveform_destination: str,
) -> tuple[AnalysisResult, str]:
"""
Analyze backing vocals and generate a waveform image.
This method:
1. Downloads the audio file from GCS
2. Runs analysis using AudioAnalyzer
3. Generates waveform image using WaveformGenerator
4. Uploads the waveform image to GCS
5. Returns analysis result and waveform GCS path
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
gcs_waveform_destination: Where to upload the waveform image in GCS
Returns:
Tuple of (AnalysisResult, waveform_gcs_path)
"""
logger.info(f"[{job_id}] Analyzing and generating waveform: {gcs_audio_path}")
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# Run analysis
result = self.analyzer.analyze(local_audio_path)
# Generate waveform
local_waveform_path = os.path.join(temp_dir, "waveform.png")
self.waveform_generator.generate(
audio_path=local_audio_path,
output_path=local_waveform_path,
segments=result.audible_segments,
show_time_axis=True,
silence_threshold_db=self.analyzer.silence_threshold_db,
)
# Upload waveform to GCS
self.storage_service.upload_file(
local_waveform_path,
gcs_waveform_destination
)
logger.info(
f"[{job_id}] Analysis and waveform generation complete. "
f"Waveform uploaded to: {gcs_waveform_destination}"
)
return result, gcs_waveform_destination
def get_waveform_data(
self,
gcs_audio_path: str,
job_id: str,
num_points: int = 500,
) -> tuple[list[float], float]:
"""
Get waveform data (amplitude envelope) for client-side rendering.
This is useful when the frontend wants to render the waveform
itself using Canvas or SVG, rather than displaying a pre-generated
image.
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
num_points: Number of data points to return
Returns:
Tuple of (amplitude_values, duration_seconds)
"""
logger.info(f"[{job_id}] Getting waveform data: {gcs_audio_path}")
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# Generate waveform data
amplitudes, duration = self.waveform_generator.generate_data_only(
audio_path=local_audio_path,
num_points=num_points,
)
return amplitudes, duration
def generate_waveform_with_mutes(
self,
gcs_audio_path: str,
job_id: str,
gcs_waveform_destination: str,
mute_regions: list,
) -> str:
"""
Generate a waveform image with mute regions highlighted.
This is useful for showing the user which regions will be muted
in the custom instrumental.
Args:
gcs_audio_path: Path to the audio file in GCS
job_id: Job ID for logging
gcs_waveform_destination: Where to upload the waveform image
mute_regions: List of MuteRegion objects to highlight
Returns:
GCS path to the uploaded waveform image
"""
from karaoke_gen.instrumental_review import MuteRegion
logger.info(
f"[{job_id}] Generating waveform with {len(mute_regions)} mute regions"
)
with tempfile.TemporaryDirectory() as temp_dir:
# Download audio file
local_audio_path = os.path.join(temp_dir, "backing_vocals.flac")
self.storage_service.download_file(gcs_audio_path, local_audio_path)
# First run analysis to get segments
result = self.analyzer.analyze(local_audio_path)
# Generate waveform with mute regions
local_waveform_path = os.path.join(temp_dir, "waveform_with_mutes.png")
self.waveform_generator.generate(
audio_path=local_audio_path,
output_path=local_waveform_path,
segments=result.audible_segments,
mute_regions=mute_regions,
show_time_axis=True,
)
# Upload to GCS
self.storage_service.upload_file(
local_waveform_path,
gcs_waveform_destination
)
return gcs_waveform_destination
+278
View File
@@ -0,0 +1,278 @@
"""
Audio editing service for creating custom instrumentals.
This service wraps the shared karaoke_gen.instrumental_review module
to provide GCS-integrated audio editing capabilities.
"""
import logging
import os
import tempfile
from typing import List, Optional
from backend.services.storage_service import StorageService
from karaoke_gen.instrumental_review import (
AudioEditor,
MuteRegion,
)
from karaoke_gen.instrumental_review.models import CustomInstrumentalResult
logger = logging.getLogger(__name__)
class AudioEditingService:
"""
Service for creating custom instrumental tracks with GCS integration.
This service acts as a thin wrapper around the shared AudioEditor
class, handling GCS download/upload operations.
The actual editing logic is in the shared karaoke_gen.instrumental_review
module, ensuring feature parity between local and remote workflows.
"""
def __init__(
self,
storage_service: Optional[StorageService] = None,
output_format: str = "flac",
):
"""
Initialize the audio editing service.
Args:
storage_service: GCS storage service. If not provided, a new
instance will be created.
output_format: Output audio format. Default is "flac".
"""
self.storage_service = storage_service or StorageService()
self.editor = AudioEditor(output_format=output_format)
def create_custom_instrumental(
self,
gcs_clean_instrumental_path: str,
gcs_backing_vocals_path: str,
mute_regions: List[MuteRegion],
gcs_output_path: str,
job_id: str,
) -> CustomInstrumentalResult:
"""
Create a custom instrumental by muting regions of backing vocals.
This method:
1. Downloads clean instrumental and backing vocals from GCS
2. Applies mute regions to backing vocals
3. Combines with clean instrumental
4. Uploads result to GCS
Args:
gcs_clean_instrumental_path: Path to clean instrumental in GCS
gcs_backing_vocals_path: Path to backing vocals in GCS
mute_regions: List of regions to mute in backing vocals
gcs_output_path: Where to upload the custom instrumental in GCS
job_id: Job ID for logging
Returns:
CustomInstrumentalResult with details about the created file
"""
logger.info(
f"[{job_id}] Creating custom instrumental with "
f"{len(mute_regions)} mute regions"
)
with tempfile.TemporaryDirectory() as temp_dir:
# Download input files
local_clean_path = os.path.join(temp_dir, "clean_instrumental.flac")
local_backing_path = os.path.join(temp_dir, "backing_vocals.flac")
local_output_path = os.path.join(temp_dir, "custom_instrumental.flac")
logger.debug(f"[{job_id}] Downloading clean instrumental")
self.storage_service.download_file(
gcs_clean_instrumental_path,
local_clean_path
)
logger.debug(f"[{job_id}] Downloading backing vocals")
self.storage_service.download_file(
gcs_backing_vocals_path,
local_backing_path
)
# Create custom instrumental using shared editor
result = self.editor.create_custom_instrumental(
clean_instrumental_path=local_clean_path,
backing_vocals_path=local_backing_path,
mute_regions=mute_regions,
output_path=local_output_path,
)
# Upload result to GCS
logger.debug(f"[{job_id}] Uploading custom instrumental to GCS")
self.storage_service.upload_file(local_output_path, gcs_output_path)
# Update result with GCS path
result.output_path = gcs_output_path
logger.info(
f"[{job_id}] Custom instrumental created: {gcs_output_path}, "
f"muted {result.total_muted_duration_seconds:.1f}s across "
f"{len(result.mute_regions_applied)} regions"
)
return result
def create_preview(
self,
gcs_clean_instrumental_path: str,
gcs_backing_vocals_path: str,
mute_regions: List[MuteRegion],
gcs_preview_path: str,
job_id: str,
preview_duration_seconds: Optional[float] = None,
) -> str:
"""
Create a preview of the custom instrumental.
This is similar to create_custom_instrumental but optimized for
quick preview generation (optionally truncated duration).
Args:
gcs_clean_instrumental_path: Path to clean instrumental in GCS
gcs_backing_vocals_path: Path to backing vocals in GCS
mute_regions: List of regions to mute
gcs_preview_path: Where to upload the preview in GCS
job_id: Job ID for logging
preview_duration_seconds: Optional max duration for preview
Returns:
GCS path to the uploaded preview
"""
logger.info(f"[{job_id}] Creating preview with {len(mute_regions)} mute regions")
with tempfile.TemporaryDirectory() as temp_dir:
# Download input files
local_clean_path = os.path.join(temp_dir, "clean_instrumental.flac")
local_backing_path = os.path.join(temp_dir, "backing_vocals.flac")
local_preview_path = os.path.join(temp_dir, "preview.flac")
self.storage_service.download_file(
gcs_clean_instrumental_path,
local_clean_path
)
self.storage_service.download_file(
gcs_backing_vocals_path,
local_backing_path
)
# Generate preview
from pydub import AudioSegment
preview = self.editor.preview_with_mutes(
clean_instrumental_path=local_clean_path,
backing_vocals_path=local_backing_path,
mute_regions=mute_regions,
)
# Optionally truncate
if preview_duration_seconds:
max_ms = int(preview_duration_seconds * 1000)
preview = preview[:max_ms]
# Export and upload
preview.export(local_preview_path, format="flac")
self.storage_service.upload_file(local_preview_path, gcs_preview_path)
logger.info(f"[{job_id}] Preview created: {gcs_preview_path}")
return gcs_preview_path
def mute_backing_vocals_only(
self,
gcs_backing_vocals_path: str,
mute_regions: List[MuteRegion],
gcs_output_path: str,
job_id: str,
) -> str:
"""
Apply mute regions to backing vocals without combining with instrumental.
This is useful for creating an edited backing vocals track that
can be combined with the instrumental later.
Args:
gcs_backing_vocals_path: Path to backing vocals in GCS
mute_regions: List of regions to mute
gcs_output_path: Where to upload the edited backing vocals
job_id: Job ID for logging
Returns:
GCS path to the uploaded edited backing vocals
"""
logger.info(
f"[{job_id}] Muting backing vocals with {len(mute_regions)} regions"
)
with tempfile.TemporaryDirectory() as temp_dir:
local_backing_path = os.path.join(temp_dir, "backing_vocals.flac")
local_output_path = os.path.join(temp_dir, "muted_backing.flac")
self.storage_service.download_file(
gcs_backing_vocals_path,
local_backing_path
)
self.editor.apply_mute_to_single_track(
audio_path=local_backing_path,
mute_regions=mute_regions,
output_path=local_output_path,
)
self.storage_service.upload_file(local_output_path, gcs_output_path)
logger.info(f"[{job_id}] Muted backing vocals: {gcs_output_path}")
return gcs_output_path
def validate_mute_regions(
self,
mute_regions: List[MuteRegion],
total_duration_seconds: float,
) -> List[str]:
"""
Validate mute regions for consistency.
Args:
mute_regions: List of mute regions to validate
total_duration_seconds: Total duration of the audio
Returns:
List of validation error messages (empty if valid)
"""
errors = []
for i, region in enumerate(mute_regions):
if region.start_seconds < 0:
errors.append(
f"Region {i}: start_seconds ({region.start_seconds}) cannot be negative"
)
if region.end_seconds <= region.start_seconds:
errors.append(
f"Region {i}: end_seconds ({region.end_seconds}) must be after "
f"start_seconds ({region.start_seconds})"
)
if region.start_seconds > total_duration_seconds:
errors.append(
f"Region {i}: start_seconds ({region.start_seconds}) exceeds "
f"audio duration ({total_duration_seconds})"
)
if region.end_seconds > total_duration_seconds:
# Not an error, but log a warning - the region will be clamped
logger.warning(
f"Region {i}: end_seconds ({region.end_seconds}) exceeds "
f"audio duration ({total_duration_seconds}), will be clamped"
)
return errors
+459
View File
@@ -0,0 +1,459 @@
"""
Audio search service for finding and downloading audio files.
This service integrates with karaoke_gen.audio_fetcher (which wraps flacfetch)
to search for audio from various sources (YouTube, music trackers, etc.)
and download the selected audio file.
This is a thin wrapper that adds backend-specific functionality:
- Caching raw results for API-based selection flow
- Firestore-compatible serialization
- Singleton pattern for service lifecycle
- Remote flacfetch service integration for torrent downloads
When FLACFETCH_API_URL is configured, this service uses the remote flacfetch
HTTP API for search and download operations. This is required for torrent
downloads since Cloud Run doesn't support BitTorrent peer connections.
"""
import asyncio
import logging
import os
from typing import List, Optional
# Import shared classes from karaoke_gen.audio_fetcher - single source of truth
# Note: Import directly from audio_fetcher module, not karaoke_gen.__init__
# to avoid pulling in heavier dependencies like lyrics_transcriber
from karaoke_gen.audio_fetcher import (
FlacFetcher,
AudioSearchResult,
AudioFetchResult,
AudioFetcherError,
NoResultsError,
DownloadError,
)
from .flacfetch_client import get_flacfetch_client, FlacfetchServiceError
logger = logging.getLogger(__name__)
# Re-export exception under backend's naming convention for compatibility
AudioSearchError = AudioFetcherError
# Also alias AudioFetchResult as AudioDownloadResult for backwards compatibility
AudioDownloadResult = AudioFetchResult
class AudioSearchService:
"""
Service for searching and downloading audio files.
This is a thin wrapper around karaoke_gen.audio_fetcher.FlacFetcher that adds
backend-specific functionality:
- Caches raw results for API-based selection (client picks by index)
- Provides Firestore-compatible serialization
- Manages service lifecycle as singleton
- Remote flacfetch service integration for torrent downloads
When FLACFETCH_API_URL is configured, this service uses the remote flacfetch
HTTP API for search and download operations. This enables torrent downloads
which are not possible in Cloud Run due to network restrictions.
The actual flacfetch integration is in karaoke_gen.audio_fetcher.FlacFetcher,
which is shared between local CLI and cloud backend.
"""
# Sentinel value to indicate "use environment variable"
_USE_ENV = object()
def __init__(
self,
redacted_api_key: Optional[str] = _USE_ENV,
ops_api_key: Optional[str] = _USE_ENV,
):
"""
Initialize the audio search service.
Args:
redacted_api_key: API key for Redacted tracker (optional, uses env if not provided)
ops_api_key: API key for OPS tracker (optional, uses env if not provided)
"""
# Use environment variables if not explicitly provided
if redacted_api_key is self._USE_ENV:
redacted_api_key = os.environ.get("REDACTED_API_KEY")
if ops_api_key is self._USE_ENV:
ops_api_key = os.environ.get("OPS_API_KEY")
# Check for remote flacfetch client
self._remote_client = get_flacfetch_client()
# Log which mode we're using
if self._remote_client:
logger.info("AudioSearchService using REMOTE flacfetch service (torrent downloads enabled)")
else:
logger.info("AudioSearchService using LOCAL flacfetch (YouTube only in Cloud Run)")
# Delegate to shared FlacFetcher implementation (for local mode or fallback)
self._fetcher = FlacFetcher(
redacted_api_key=redacted_api_key,
ops_api_key=ops_api_key,
)
# Cache search results for API-based selection flow
# Key: index, Value: AudioSearchResult (with raw_result)
self._cached_results: List[AudioSearchResult] = []
# Cache for remote search results (search_id -> results)
self._remote_search_id: Optional[str] = None
def search(self, artist: str, title: str) -> List[AudioSearchResult]:
"""
Search for audio matching the given artist and title.
Results are cached internally for later download via download().
If a remote flacfetch service is configured (FLACFETCH_API_URL), uses that
for better torrent download support. Otherwise falls back to local flacfetch.
Args:
artist: The artist name to search for
title: The track title to search for
Returns:
List of AudioSearchResult objects
Raises:
NoResultsError: If no results are found
AudioSearchError: For other errors (e.g., flacfetch not installed)
"""
try:
# Try remote flacfetch service first if configured
if self._remote_client:
return self._search_remote(artist, title)
# Fallback to local flacfetch
results = self._fetcher.search(artist, title)
# Cache results for later download
self._cached_results = results
self._remote_search_id = None
logger.info(f"Found {len(results)} results for: {artist} - {title}")
return results
except (NoResultsError, AudioFetcherError):
# Re-raise these as-is
raise
except Exception as e:
logger.error(f"Search failed: {e}")
raise AudioSearchError(f"Search failed: {e}") from e
def _search_remote(self, artist: str, title: str) -> List[AudioSearchResult]:
"""
Search using the remote flacfetch service.
Runs async code in a sync context for compatibility with existing API.
"""
try:
# Run async search in sync context
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
try:
response = loop.run_until_complete(
self._remote_client.search(artist, title)
)
finally:
loop.close()
# Check for empty results
if not response.get("results"):
raise NoResultsError(f"No results found for: {artist} - {title}")
# Store search_id for download
self._remote_search_id = response.get("search_id")
# Convert remote results to AudioSearchResult objects
results = []
for item in response.get("results", []):
result = AudioSearchResult(
title=item.get("title", "Unknown"),
artist=item.get("artist", "Unknown"),
provider=item.get("provider", "Unknown"),
quality=item.get("quality", ""),
size_bytes=item.get("size_bytes"),
duration_seconds=item.get("duration_seconds"),
is_lossless=item.get("is_lossless", False),
seeders=item.get("seeders"),
year=item.get("year"),
extra_info={
"index": item.get("index"),
"target_file": item.get("target_file"),
"view_count": item.get("view_count"),
"channel": item.get("channel"),
"remote": True, # Flag for download logic
},
)
results.append(result)
# Cache results
self._cached_results = results
logger.info(f"Found {len(results)} results from remote flacfetch for: {artist} - {title}")
return results
except FlacfetchServiceError as e:
logger.warning(f"Remote flacfetch search failed, falling back to local: {e}")
# Fallback to local search
self._remote_search_id = None
results = self._fetcher.search(artist, title)
self._cached_results = results
return results
def select_best(self, results: List[AudioSearchResult]) -> int:
"""
Select the best result from a list of search results.
Uses flacfetch's built-in quality ranking to select the best source.
Args:
results: List of search results
Returns:
Index of the best result
"""
return self._fetcher.select_best(results)
def download(
self,
result_index: int,
output_dir: str,
output_filename: Optional[str] = None,
gcs_path: Optional[str] = None,
) -> AudioDownloadResult:
"""
Download audio from a cached search result.
This method uses the cached results from the last search() call.
The API flow is:
1. Client calls search() -> gets list of results
2. Client picks an index
3. Client calls download(index) -> gets downloaded file
If a remote flacfetch service is configured and the search was performed
remotely (for torrent sources), uses the remote service for download.
Args:
result_index: Index of the result to download (from search results)
output_dir: Directory to save the downloaded file
output_filename: Optional filename (without extension)
gcs_path: Optional GCS path for remote uploads (e.g., "uploads/job123/audio/")
Returns:
AudioDownloadResult with the downloaded file path
Raises:
DownloadError: If download fails or no cached result for index
"""
if result_index < 0 or result_index >= len(self._cached_results):
raise DownloadError(
f"No cached result for index {result_index}. "
f"Available indices: 0-{len(self._cached_results) - 1}. "
"Run search() first."
)
result = self._cached_results[result_index]
logger.info(f"Downloading: {result.artist} - {result.title} from {result.provider}")
# Check if this was a remote search (torrent sources need remote download)
if self._remote_search_id and self._remote_client:
# Check if this is a torrent source that needs remote handling
is_remote = result.extra_info.get("remote", False) if result.extra_info else False
is_torrent = result.provider in ["Redacted", "OPS"]
if is_remote or is_torrent:
return self._download_remote(result_index, output_dir, output_filename, gcs_path)
# Delegate to shared FlacFetcher (local download)
fetch_result = self._fetcher.download(result, output_dir, output_filename)
logger.info(f"Downloaded to: {fetch_result.filepath}")
return fetch_result
def _download_remote(
self,
result_index: int,
output_dir: str,
output_filename: Optional[str] = None,
gcs_path: Optional[str] = None,
) -> AudioDownloadResult:
"""
Download using the remote flacfetch service.
The remote service downloads via torrent and optionally uploads to GCS.
"""
if not self._remote_search_id:
raise DownloadError("No remote search ID - run search() first")
result = self._cached_results[result_index]
try:
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
try:
# Start download
download_id = loop.run_until_complete(
self._remote_client.download(
search_id=self._remote_search_id,
result_index=result_index,
output_filename=output_filename,
gcs_path=gcs_path,
)
)
logger.info(f"Remote download started: {download_id}")
# Wait for completion with progress logging
def log_progress(status):
progress = status.get("progress", 0)
speed = status.get("download_speed_kbps", 0)
logger.debug(f"Download progress: {progress:.1f}% ({speed:.1f} KB/s)")
final_status = loop.run_until_complete(
self._remote_client.wait_for_download(
download_id,
timeout=600, # 10 minute timeout
progress_callback=log_progress,
)
)
finally:
loop.close()
# Determine file path
filepath = final_status.get("gcs_path") or final_status.get("output_path")
if not filepath:
raise DownloadError("Remote download completed but no file path returned")
logger.info(f"Remote download complete: {filepath}")
return AudioDownloadResult(
filepath=filepath,
artist=result.artist,
title=result.title,
provider=result.provider,
quality=result.quality,
)
except FlacfetchServiceError as e:
raise DownloadError(f"Remote download failed: {e}") from e
except Exception as e:
logger.error(f"Remote download error: {e}")
raise DownloadError(f"Remote download failed: {e}") from e
def search_and_download_auto(
self,
artist: str,
title: str,
output_dir: str,
output_filename: Optional[str] = None,
gcs_path: Optional[str] = None,
) -> AudioDownloadResult:
"""
Search for audio and automatically download the best result.
This is a convenience method that combines search(), select_best(),
and download() for automated/non-interactive usage.
Args:
artist: The artist name to search for
title: The track title to search for
output_dir: Directory to save the downloaded file
output_filename: Optional filename (without extension)
gcs_path: Optional GCS path for remote uploads
Returns:
AudioDownloadResult with the downloaded file path
Raises:
NoResultsError: If no results are found
DownloadError: If download fails
"""
# Search
results = self.search(artist, title)
# Select best
best_index = self.select_best(results)
best_result = results[best_index]
logger.info(
f"Auto-selected result {best_index}: "
f"{best_result.artist} - {best_result.title} ({best_result.provider})"
)
# Download
return self.download(best_index, output_dir, output_filename, gcs_path)
async def search_async(self, artist: str, title: str) -> List[AudioSearchResult]:
"""
Async version of search for use in async routes.
Note: Currently wraps sync search in executor. Future optimization
could make this fully async.
"""
loop = asyncio.get_event_loop()
return await loop.run_in_executor(None, self.search, artist, title)
async def download_async(
self,
result_index: int,
output_dir: str,
output_filename: Optional[str] = None,
gcs_path: Optional[str] = None,
) -> AudioDownloadResult:
"""
Async version of download for use in async routes.
Note: Currently wraps sync download in executor. Future optimization
could make this fully async.
"""
loop = asyncio.get_event_loop()
return await loop.run_in_executor(
None,
lambda: self.download(result_index, output_dir, output_filename, gcs_path)
)
def is_remote_enabled(self) -> bool:
"""Check if remote flacfetch service is configured."""
return self._remote_client is not None
async def check_remote_health(self) -> Optional[dict]:
"""
Check health of remote flacfetch service.
Returns:
Health status dict if remote service is configured and healthy,
None if not configured or unhealthy.
"""
if not self._remote_client:
return None
try:
return await self._remote_client.health_check()
except Exception as e:
logger.warning(f"Remote flacfetch health check failed: {e}")
return None
# Singleton instance
_audio_search_service: Optional[AudioSearchService] = None
def get_audio_search_service() -> AudioSearchService:
"""Get the singleton AudioSearchService instance."""
global _audio_search_service
if _audio_search_service is None:
_audio_search_service = AudioSearchService()
return _audio_search_service
+412
View File
@@ -0,0 +1,412 @@
"""
Client for the remote flacfetch HTTP API service.
This client communicates with a dedicated flacfetch VM that handles:
- BitTorrent downloads from private trackers (Redacted, OPS)
- YouTube downloads
- GCS uploads of downloaded files
The flacfetch service provides:
- Full peer connectivity for torrents (not possible in Cloud Run)
- Indefinite seeding of completed torrents
- Automatic disk cleanup
Usage:
client = get_flacfetch_client()
if client:
# Search for audio
search_result = await client.search("ABBA", "Waterloo")
# Download the best result
download_id = await client.download(
search_id=search_result["search_id"],
result_index=0,
gcs_path="uploads/job123/audio/",
)
# Wait for completion
result = await client.wait_for_download(download_id)
print(f"Downloaded to: {result['gcs_path']}")
"""
import asyncio
import logging
from typing import Any, Dict, List, Optional
import httpx
logger = logging.getLogger(__name__)
class FlacfetchServiceError(Exception):
"""Error communicating with or returned from flacfetch service."""
pass
class FlacfetchClient:
"""
Client for remote flacfetch HTTP API.
All endpoints require authentication via X-API-Key header.
"""
def __init__(
self,
base_url: str,
api_key: str,
timeout: int = 60,
):
"""
Initialize flacfetch client.
Args:
base_url: Base URL of flacfetch service (e.g., http://10.0.0.5:8080)
api_key: API key for authentication
timeout: Default request timeout in seconds
"""
self.base_url = base_url.rstrip('/')
self.api_key = api_key
self.timeout = timeout
logger.info(f"FlacfetchClient initialized with base_url={self.base_url}")
def _headers(self) -> Dict[str, str]:
"""Get request headers with authentication."""
return {
"X-API-Key": self.api_key,
"Content-Type": "application/json",
}
async def health_check(self) -> Dict[str, Any]:
"""
Check if flacfetch service is healthy.
Returns:
Health status dict with transmission, disk, and provider info
Raises:
FlacfetchServiceError: If service is unhealthy or unreachable
"""
try:
async with httpx.AsyncClient() as client:
resp = await client.get(
f"{self.base_url}/health",
headers=self._headers(),
timeout=10,
)
resp.raise_for_status()
data = resp.json()
if data.get("status") not in ["healthy", "degraded"]:
raise FlacfetchServiceError(f"Service unhealthy: {data}")
return data
except httpx.RequestError as e:
raise FlacfetchServiceError(f"Cannot reach flacfetch service: {e}")
except httpx.HTTPStatusError as e:
raise FlacfetchServiceError(f"Health check failed: {e.response.status_code}")
async def search(
self,
artist: str,
title: str,
) -> Dict[str, Any]:
"""
Search for audio matching artist and title.
Args:
artist: Artist name
title: Track title
Returns:
Search response dict with search_id and results list
Raises:
FlacfetchServiceError: On search failure
"""
try:
async with httpx.AsyncClient() as client:
resp = await client.post(
f"{self.base_url}/search",
headers=self._headers(),
json={"artist": artist, "title": title},
timeout=self.timeout,
)
if resp.status_code == 404:
# No results found - return empty results
return {
"search_id": None,
"artist": artist,
"title": title,
"results": [],
"results_count": 0,
}
resp.raise_for_status()
return resp.json()
except httpx.RequestError as e:
raise FlacfetchServiceError(f"Search request failed: {e}")
except httpx.HTTPStatusError as e:
raise FlacfetchServiceError(f"Search failed: {e.response.status_code} - {e.response.text}")
async def download(
self,
search_id: str,
result_index: int,
output_filename: Optional[str] = None,
gcs_path: Optional[str] = None,
) -> str:
"""
Start downloading an audio file.
Args:
search_id: Search ID from previous search
result_index: Index of result to download
output_filename: Optional custom filename (without extension)
gcs_path: GCS path for upload (e.g., "uploads/job123/audio/")
Returns:
Download ID for tracking progress
Raises:
FlacfetchServiceError: On download start failure
"""
try:
async with httpx.AsyncClient() as client:
payload = {
"search_id": search_id,
"result_index": result_index,
}
if output_filename:
payload["output_filename"] = output_filename
if gcs_path:
payload["upload_to_gcs"] = True
payload["gcs_path"] = gcs_path
resp = await client.post(
f"{self.base_url}/download",
headers=self._headers(),
json=payload,
timeout=self.timeout,
)
resp.raise_for_status()
data = resp.json()
return data["download_id"]
except httpx.RequestError as e:
raise FlacfetchServiceError(f"Download request failed: {e}")
except httpx.HTTPStatusError as e:
raise FlacfetchServiceError(f"Download start failed: {e.response.status_code} - {e.response.text}")
async def get_download_status(self, download_id: str) -> Dict[str, Any]:
"""
Get the current status of a download.
Args:
download_id: Download ID from start_download
Returns:
Status dict with progress, speed, path info
Raises:
FlacfetchServiceError: On status check failure
"""
try:
async with httpx.AsyncClient() as client:
resp = await client.get(
f"{self.base_url}/download/{download_id}/status",
headers=self._headers(),
timeout=10,
)
resp.raise_for_status()
return resp.json()
except httpx.RequestError as e:
raise FlacfetchServiceError(f"Status request failed: {e}")
except httpx.HTTPStatusError as e:
if e.response.status_code == 404:
raise FlacfetchServiceError(f"Download not found: {download_id}")
raise FlacfetchServiceError(f"Status check failed: {e.response.status_code}")
async def wait_for_download(
self,
download_id: str,
timeout: int = 600,
poll_interval: float = 2.0,
progress_callback: Optional[callable] = None,
) -> Dict[str, Any]:
"""
Wait for a download to complete.
Args:
download_id: Download ID to wait for
timeout: Maximum wait time in seconds
poll_interval: Time between status checks
progress_callback: Optional callback(status_dict) for progress updates
Returns:
Final status dict with output_path or gcs_path
Raises:
FlacfetchServiceError: On download failure or timeout
"""
elapsed = 0.0
while elapsed < timeout:
status = await self.get_download_status(download_id)
if progress_callback:
try:
progress_callback(status)
except Exception as e:
logger.warning(f"Progress callback error: {e}")
download_status = status.get("status")
if download_status in ["complete", "seeding"]:
logger.info(f"Download {download_id} complete: {status.get('gcs_path') or status.get('output_path')}")
return status
elif download_status == "failed":
error = status.get("error", "Unknown error")
raise FlacfetchServiceError(f"Download failed: {error}")
elif download_status == "cancelled":
raise FlacfetchServiceError("Download was cancelled")
# Log progress
progress = status.get("progress", 0)
speed = status.get("download_speed_kbps", 0)
peers = status.get("peers", 0)
logger.debug(
f"Download {download_id}: {progress:.1f}% "
f"({speed:.1f} KB/s, {peers} peers)"
)
await asyncio.sleep(poll_interval)
elapsed += poll_interval
raise FlacfetchServiceError(f"Download timed out after {timeout}s")
async def list_torrents(self) -> Dict[str, Any]:
"""
List all torrents in Transmission.
Returns:
Torrent list response with torrent info and totals
"""
try:
async with httpx.AsyncClient() as client:
resp = await client.get(
f"{self.base_url}/torrents",
headers=self._headers(),
timeout=30,
)
resp.raise_for_status()
return resp.json()
except httpx.RequestError as e:
raise FlacfetchServiceError(f"List torrents failed: {e}")
except httpx.HTTPStatusError as e:
raise FlacfetchServiceError(f"List torrents failed: {e.response.status_code}")
async def delete_torrent(
self,
torrent_id: int,
delete_data: bool = True,
) -> Dict[str, Any]:
"""
Delete a torrent from Transmission.
Args:
torrent_id: Transmission torrent ID
delete_data: Also delete downloaded files
Returns:
Delete response
"""
try:
async with httpx.AsyncClient() as client:
resp = await client.delete(
f"{self.base_url}/torrents/{torrent_id}",
headers=self._headers(),
params={"delete_data": str(delete_data).lower()},
timeout=30,
)
resp.raise_for_status()
return resp.json()
except httpx.RequestError as e:
raise FlacfetchServiceError(f"Delete torrent failed: {e}")
except httpx.HTTPStatusError as e:
raise FlacfetchServiceError(f"Delete torrent failed: {e.response.status_code}")
async def cleanup_torrents(
self,
strategy: str = "oldest",
target_free_gb: float = 10.0,
) -> Dict[str, Any]:
"""
Trigger disk cleanup.
Args:
strategy: Cleanup strategy (oldest, largest, lowest_ratio)
target_free_gb: Target free space to achieve
Returns:
Cleanup response with removed count and freed space
"""
try:
async with httpx.AsyncClient() as client:
resp = await client.post(
f"{self.base_url}/torrents/cleanup",
headers=self._headers(),
json={
"strategy": strategy,
"target_free_gb": target_free_gb,
},
timeout=60,
)
resp.raise_for_status()
return resp.json()
except httpx.RequestError as e:
raise FlacfetchServiceError(f"Cleanup failed: {e}")
except httpx.HTTPStatusError as e:
raise FlacfetchServiceError(f"Cleanup failed: {e.response.status_code}")
# Singleton client instance
_client: Optional[FlacfetchClient] = None
def get_flacfetch_client() -> Optional[FlacfetchClient]:
"""
Get the flacfetch client if configured.
Returns:
FlacfetchClient instance if FLACFETCH_API_URL and FLACFETCH_API_KEY are set,
None otherwise (indicating local-only mode).
"""
global _client
if _client is None:
from backend.config import get_settings
settings = get_settings()
if settings.flacfetch_api_url and settings.flacfetch_api_key:
_client = FlacfetchClient(
base_url=settings.flacfetch_api_url,
api_key=settings.flacfetch_api_key,
)
logger.info("FlacfetchClient initialized for remote service")
else:
logger.debug("FlacfetchClient not configured (missing URL or API key)")
return _client
def reset_flacfetch_client():
"""Reset the singleton client (for testing)."""
global _client
_client = None
+4
View File
@@ -55,6 +55,10 @@ class JobManager:
youtube_description=job_create.youtube_description,
webhook_url=job_create.webhook_url,
user_email=job_create.user_email,
# Two-phase workflow (Batch 6)
prep_only=job_create.prep_only,
finalise_only=job_create.finalise_only,
keep_brand_code=job_create.keep_brand_code,
# Request metadata (for tracking and filtering)
request_metadata=job_create.request_metadata,
)
+499
View File
@@ -0,0 +1,499 @@
"""
Tests for audio search functionality (Batch 5).
Tests the audio search service, API routes, and job model fields.
"""
import pytest
import os
from unittest.mock import Mock, patch, MagicMock
from datetime import datetime
from backend.models.job import Job, JobCreate, JobStatus, STATE_TRANSITIONS
from backend.services.audio_search_service import (
AudioSearchService,
AudioSearchResult,
AudioDownloadResult,
AudioSearchError,
NoResultsError,
DownloadError,
get_audio_search_service,
)
class TestJobModelAudioSearchFields:
"""Test Job model has audio search fields."""
def test_job_has_audio_search_fields(self):
"""Test Job model has audio search configuration fields."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.utcnow(),
updated_at=datetime.utcnow(),
artist="ABBA",
title="Waterloo",
audio_search_artist="ABBA",
audio_search_title="Waterloo",
auto_download=True,
)
assert job.audio_search_artist == "ABBA"
assert job.audio_search_title == "Waterloo"
assert job.auto_download is True
def test_job_audio_search_fields_default_values(self):
"""Test default values for audio search fields."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.utcnow(),
updated_at=datetime.utcnow(),
)
assert job.audio_search_artist is None
assert job.audio_search_title is None
assert job.auto_download is False
def test_job_create_has_audio_search_fields(self):
"""Test JobCreate model has audio search fields."""
job_create = JobCreate(
artist="ABBA",
title="Waterloo",
audio_search_artist="ABBA",
audio_search_title="Waterloo",
auto_download=True,
)
assert job_create.audio_search_artist == "ABBA"
assert job_create.audio_search_title == "Waterloo"
assert job_create.auto_download is True
class TestJobStatusAudioSearchStates:
"""Test Job status includes audio search states."""
def test_audio_search_statuses_exist(self):
"""Test audio search status values exist."""
assert hasattr(JobStatus, 'SEARCHING_AUDIO')
assert hasattr(JobStatus, 'AWAITING_AUDIO_SELECTION')
assert hasattr(JobStatus, 'DOWNLOADING_AUDIO')
assert JobStatus.SEARCHING_AUDIO == "searching_audio"
assert JobStatus.AWAITING_AUDIO_SELECTION == "awaiting_audio_selection"
assert JobStatus.DOWNLOADING_AUDIO == "downloading_audio"
def test_state_transitions_include_audio_search_flow(self):
"""Test state transitions include audio search flow."""
# PENDING can go to SEARCHING_AUDIO
assert JobStatus.SEARCHING_AUDIO in STATE_TRANSITIONS[JobStatus.PENDING]
# SEARCHING_AUDIO can go to AWAITING_AUDIO_SELECTION or DOWNLOADING_AUDIO
assert JobStatus.AWAITING_AUDIO_SELECTION in STATE_TRANSITIONS[JobStatus.SEARCHING_AUDIO]
assert JobStatus.DOWNLOADING_AUDIO in STATE_TRANSITIONS[JobStatus.SEARCHING_AUDIO]
# AWAITING_AUDIO_SELECTION can go to DOWNLOADING_AUDIO
assert JobStatus.DOWNLOADING_AUDIO in STATE_TRANSITIONS[JobStatus.AWAITING_AUDIO_SELECTION]
# DOWNLOADING_AUDIO can go to DOWNLOADING
assert JobStatus.DOWNLOADING in STATE_TRANSITIONS[JobStatus.DOWNLOADING_AUDIO]
class TestAudioSearchResult:
"""Test AudioSearchResult dataclass.
AudioSearchResult is now imported from karaoke_gen.audio_fetcher.
These tests verify the backend can use it correctly.
"""
def test_create_audio_search_result(self):
"""Test creating an AudioSearchResult."""
result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
duration=180,
quality="FLAC",
source_id="abc123",
index=0,
)
assert result.title == "Waterloo"
assert result.artist == "ABBA"
assert result.provider == "YouTube"
assert result.url == "https://youtube.com/watch?v=abc123"
assert result.duration == 180
assert result.quality == "FLAC"
assert result.source_id == "abc123"
assert result.index == 0
def test_to_dict(self):
"""Test converting to dict for serialization."""
result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
index=0,
)
data = result.to_dict()
assert data['title'] == "Waterloo"
assert data['artist'] == "ABBA"
assert data['provider'] == "YouTube"
assert data['url'] == "https://youtube.com/watch?v=abc123"
assert data['index'] == 0
# raw_result should NOT be in serialized dict
assert 'raw_result' not in data
def test_from_dict(self):
"""Test creating from dict."""
data = {
'title': "Waterloo",
'artist': "ABBA",
'provider': "YouTube",
'url': "https://youtube.com/watch?v=abc123",
'duration': 180,
'quality': "FLAC",
'source_id': "abc123",
'index': 0,
}
result = AudioSearchResult.from_dict(data)
assert result.title == "Waterloo"
assert result.artist == "ABBA"
assert result.provider == "YouTube"
assert result.index == 0
assert result.raw_result is None # Not set from dict
class TestAudioSearchServiceInit:
"""Test AudioSearchService initialization."""
@patch.dict('os.environ', {'REDACTED_API_KEY': '', 'OPS_API_KEY': ''}, clear=False)
def test_init_with_no_keys(self):
"""Test initialization without API keys."""
# Pass explicit None to override environment
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
# Service should have a FlacFetcher internally
assert service._fetcher is not None
assert service._cached_results == []
def test_init_with_keys(self):
"""Test initialization with API keys."""
service = AudioSearchService(
redacted_api_key="test_redacted_key",
ops_api_key="test_ops_key",
)
# Keys are passed to FlacFetcher
assert service._fetcher._redacted_api_key == "test_redacted_key"
assert service._fetcher._ops_api_key == "test_ops_key"
def test_init_reads_from_environment(self):
"""Test initialization reads keys from environment variables."""
# Just test that the service can be initialized
service = AudioSearchService()
# The service should have a FlacFetcher
assert service._fetcher is not None
class TestAudioSearchServiceSearch:
"""Test AudioSearchService.search() method."""
def test_search_returns_results(self):
"""Test search returns AudioSearchResult list."""
# Create mock result
mock_result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
duration=180,
quality="FLAC",
source_id="abc123",
index=0,
)
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.search.return_value = [mock_result]
results = service.search("ABBA", "Waterloo")
assert len(results) == 1
assert results[0].title == "Waterloo"
assert results[0].artist == "ABBA"
assert results[0].provider == "YouTube"
assert results[0].index == 0
def test_search_no_results_raises_error(self):
"""Test search raises NoResultsError when no results."""
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.search.side_effect = NoResultsError("No results found")
with pytest.raises(NoResultsError) as exc_info:
service.search("Unknown Artist", "Unknown Song")
assert "No results found" in str(exc_info.value)
def test_search_multiple_results(self):
"""Test search returns multiple results with correct indices."""
mock_results = []
for i in range(3):
mock_results.append(AudioSearchResult(
title=f"Song {i}",
artist="Artist",
provider=["YouTube", "Redacted", "OPS"][i],
url=f"https://example.com/{i}",
duration=180 + i * 10,
quality=["320kbps", "FLAC", "FLAC"][i],
source_id=str(i),
index=i,
))
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.search.return_value = mock_results
results = service.search("Artist", "Song")
assert len(results) == 3
assert results[0].index == 0
assert results[1].index == 1
assert results[2].index == 2
class TestAudioSearchServiceSelectBest:
"""Test AudioSearchService.select_best() method."""
def test_select_best_delegates_to_fetcher(self):
"""Test select_best uses FlacFetcher's select_best."""
mock_results = [
AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
index=0,
),
AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="Redacted",
url="https://example.com/456",
index=1,
),
]
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.select_best.return_value = 1
best_index = service.select_best(mock_results)
assert best_index == 1
service._fetcher.select_best.assert_called_once_with(mock_results)
def test_select_best_empty_list_returns_zero(self):
"""Test select_best returns 0 for empty list."""
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.select_best.return_value = 0
best_index = service.select_best([])
assert best_index == 0
class TestAudioSearchServiceDownload:
"""Test AudioSearchService.download() method."""
def test_download_without_search_raises_error(self):
"""Test download without prior search raises error."""
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
with pytest.raises(DownloadError) as exc_info:
service.download(0, "/tmp")
assert "No cached result" in str(exc_info.value)
def test_download_after_search(self):
"""Test download after search works."""
import tempfile
# Create a temp file to simulate downloaded file
temp_dir = tempfile.mkdtemp()
temp_file = os.path.join(temp_dir, "test.flac")
with open(temp_file, 'w') as f:
f.write("test")
mock_result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
duration=180,
quality="FLAC",
source_id="abc123",
index=0,
)
mock_fetch_result = AudioDownloadResult(
filepath=temp_file,
artist="ABBA",
title="Waterloo",
provider="YouTube",
duration=180,
quality="FLAC",
)
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.search.return_value = [mock_result]
service._fetcher.download.return_value = mock_fetch_result
service.search("ABBA", "Waterloo")
result = service.download(0, temp_dir)
assert result.filepath == temp_file
assert result.artist == "ABBA"
assert result.title == "Waterloo"
assert result.provider == "YouTube"
# Cleanup
os.remove(temp_file)
os.rmdir(temp_dir)
def test_download_invalid_index_raises_error(self):
"""Test download with invalid index raises error."""
mock_result = AudioSearchResult(
title="Waterloo",
artist="ABBA",
provider="YouTube",
url="https://youtube.com/watch?v=abc123",
index=0,
)
service = AudioSearchService(redacted_api_key=None, ops_api_key=None)
service._fetcher = Mock()
service._fetcher.search.return_value = [mock_result]
service.search("ABBA", "Waterloo")
with pytest.raises(DownloadError) as exc_info:
service.download(99, "/tmp")
assert "No cached result for index 99" in str(exc_info.value)
class TestGetAudioSearchService:
"""Test get_audio_search_service singleton."""
def test_get_audio_search_service_returns_instance(self):
"""Test get_audio_search_service returns an instance."""
# Reset singleton
import backend.services.audio_search_service as module
module._audio_search_service = None
service = get_audio_search_service()
assert service is not None
assert isinstance(service, AudioSearchService)
def test_get_audio_search_service_singleton(self):
"""Test get_audio_search_service returns same instance."""
service1 = get_audio_search_service()
service2 = get_audio_search_service()
assert service1 is service2
class TestFlacfetchIntegration:
"""
Integration tests that verify flacfetch imports work correctly.
These tests ensure the backend code is compatible with the installed
flacfetch version and would catch issues like renamed classes.
Note: Some tests are marked with pytest.importorskip for flacfetch
since it may not be installed in all test environments (e.g., CI).
"""
def test_flacfetch_imports_work(self):
"""Test that all flacfetch imports in audio_search_service work.
This test would have caught the YouTubeProvider -> YoutubeProvider rename.
"""
flacfetch = pytest.importorskip("flacfetch")
# These imports match what karaoke_gen.audio_fetcher does
from flacfetch.core.manager import FetchManager
from flacfetch.providers.youtube import YoutubeProvider
from flacfetch.core.models import TrackQuery
# Verify the classes exist and are callable
assert FetchManager is not None
assert YoutubeProvider is not None
assert TrackQuery is not None
def test_karaoke_gen_audio_fetcher_imports_work(self):
"""Test that karaoke_gen.audio_fetcher imports work.
Since backend now imports from karaoke_gen, this is the critical test.
This should work even without flacfetch installed (lazy import).
"""
from karaoke_gen.audio_fetcher import (
FlacFetcher,
AudioSearchResult,
AudioFetchResult,
AudioFetcherError,
NoResultsError,
DownloadError,
)
assert FlacFetcher is not None
assert AudioSearchResult is not None
assert AudioFetchResult is not None
assert AudioFetcherError is not None
assert NoResultsError is not None
assert DownloadError is not None
def test_audio_search_service_can_initialize_fetcher(self):
"""Test AudioSearchService can initialize its FlacFetcher.
This verifies the actual initialization code path works.
"""
pytest.importorskip("flacfetch")
service = AudioSearchService(
redacted_api_key=None,
ops_api_key=None,
)
# Verify FlacFetcher was initialized
assert service._fetcher is not None
# FlacFetcher can initialize its manager (tests actual flacfetch)
manager = service._fetcher._get_manager()
assert manager is not None
def test_shared_classes_are_same_as_karaoke_gen(self):
"""Verify backend uses the same classes as karaoke_gen."""
from karaoke_gen.audio_fetcher import (
AudioSearchResult as KGAudioSearchResult,
AudioFetchResult as KGAudioFetchResult,
NoResultsError as KGNoResultsError,
DownloadError as KGDownloadError,
)
# These should be the exact same classes, not copies
assert AudioSearchResult is KGAudioSearchResult
assert AudioDownloadResult is KGAudioFetchResult
assert NoResultsError is KGNoResultsError
assert DownloadError is KGDownloadError
+363
View File
@@ -0,0 +1,363 @@
"""
Unit tests for audio analysis and editing services.
These tests verify the backend service wrappers that use the shared
karaoke_gen.instrumental_review module with GCS integration.
"""
import os
import tempfile
import pytest
from unittest.mock import MagicMock, patch, ANY
from pydub import AudioSegment
from pydub.generators import Sine
from karaoke_gen.instrumental_review import MuteRegion
class TestAudioAnalysisService:
"""Tests for AudioAnalysisService."""
@pytest.fixture
def mock_storage_service(self):
"""Create a mock storage service."""
mock = MagicMock()
return mock
@pytest.fixture
def temp_audio_file(self, tmp_path):
"""Create a temporary audio file for testing."""
audio_path = tmp_path / "test_audio.flac"
# Create a simple sine wave audio
tone = Sine(440).to_audio_segment(duration=5000) - 15
tone.export(str(audio_path), format="flac")
return str(audio_path)
@pytest.fixture
def silent_audio_file(self, tmp_path):
"""Create a silent audio file for testing."""
audio_path = tmp_path / "silent_audio.flac"
audio = AudioSegment.silent(duration=5000, frame_rate=44100)
audio.export(str(audio_path), format="flac")
return str(audio_path)
def test_service_initialization(self, mock_storage_service):
"""Test service initializes with default parameters."""
from backend.services.audio_analysis_service import AudioAnalysisService
service = AudioAnalysisService(storage_service=mock_storage_service)
assert service.storage_service == mock_storage_service
assert service.analyzer.silence_threshold_db == -40.0
def test_service_custom_threshold(self, mock_storage_service):
"""Test service accepts custom silence threshold."""
from backend.services.audio_analysis_service import AudioAnalysisService
service = AudioAnalysisService(
storage_service=mock_storage_service,
silence_threshold_db=-35.0,
)
assert service.analyzer.silence_threshold_db == -35.0
def test_analyze_backing_vocals_downloads_file(
self, mock_storage_service, temp_audio_file
):
"""Test that analyze_backing_vocals downloads file from GCS."""
from backend.services.audio_analysis_service import AudioAnalysisService
# Set up mock to copy the temp file to the download location
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(temp_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
service = AudioAnalysisService(storage_service=mock_storage_service)
result = service.analyze_backing_vocals(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
)
# Verify download was called
mock_storage_service.download_file.assert_called_once()
# Verify result is valid
assert result is not None
assert hasattr(result, 'has_audible_content')
def test_analyze_silent_audio_returns_no_audible(
self, mock_storage_service, silent_audio_file
):
"""Test that silent audio returns has_audible_content=False."""
from backend.services.audio_analysis_service import AudioAnalysisService
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(silent_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
service = AudioAnalysisService(storage_service=mock_storage_service)
result = service.analyze_backing_vocals(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
)
assert result.has_audible_content is False
assert len(result.audible_segments) == 0
def test_analyze_and_generate_waveform_uploads_image(
self, mock_storage_service, temp_audio_file
):
"""Test that analyze_and_generate_waveform uploads waveform to GCS."""
from backend.services.audio_analysis_service import AudioAnalysisService
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(temp_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/analysis/waveform.png"
service = AudioAnalysisService(storage_service=mock_storage_service)
result, waveform_path = service.analyze_and_generate_waveform(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
gcs_waveform_destination="jobs/test/analysis/waveform.png",
)
# Verify upload was called
mock_storage_service.upload_file.assert_called_once()
# Verify waveform path is returned
assert waveform_path == "jobs/test/analysis/waveform.png"
def test_get_waveform_data_returns_amplitudes(
self, mock_storage_service, temp_audio_file
):
"""Test that get_waveform_data returns amplitude data."""
from backend.services.audio_analysis_service import AudioAnalysisService
def mock_download(gcs_path, local_path):
import shutil
shutil.copy(temp_audio_file, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
service = AudioAnalysisService(storage_service=mock_storage_service)
amplitudes, duration = service.get_waveform_data(
gcs_audio_path="jobs/test/stems/backing_vocals.flac",
job_id="test-job",
num_points=100,
)
# Verify we get amplitude data
assert isinstance(amplitudes, list)
assert len(amplitudes) > 0
assert all(isinstance(a, float) for a in amplitudes)
# Verify duration is reasonable
assert duration > 0
assert duration <= 10 # Our test file is 5 seconds
class TestAudioEditingService:
"""Tests for AudioEditingService."""
@pytest.fixture
def mock_storage_service(self):
"""Create a mock storage service."""
mock = MagicMock()
return mock
@pytest.fixture
def temp_audio_files(self, tmp_path):
"""Create temporary audio files for testing."""
clean_path = tmp_path / "clean_instrumental.flac"
backing_path = tmp_path / "backing_vocals.flac"
# Create clean instrumental (chord)
tone1 = Sine(220).to_audio_segment(duration=5000) - 15
tone2 = Sine(330).to_audio_segment(duration=5000) - 15
clean = tone1.overlay(tone2)
clean.export(str(clean_path), format="flac")
# Create backing vocals
backing = Sine(440).to_audio_segment(duration=5000) - 20
backing.export(str(backing_path), format="flac")
return str(clean_path), str(backing_path)
def test_service_initialization(self, mock_storage_service):
"""Test service initializes correctly."""
from backend.services.audio_editing_service import AudioEditingService
service = AudioEditingService(storage_service=mock_storage_service)
assert service.storage_service == mock_storage_service
assert service.editor.output_format == "flac"
def test_create_custom_instrumental_downloads_files(
self, mock_storage_service, temp_audio_files
):
"""Test that create_custom_instrumental downloads input files."""
from backend.services.audio_editing_service import AudioEditingService
clean_path, backing_path = temp_audio_files
# Track which files were downloaded
downloaded_files = []
def mock_download(gcs_path, local_path):
downloaded_files.append(gcs_path)
# Copy the appropriate test file
import shutil
if 'clean' in gcs_path:
shutil.copy(clean_path, local_path)
else:
shutil.copy(backing_path, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/stems/custom.flac"
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [MuteRegion(start_seconds=1.0, end_seconds=2.0)]
result = service.create_custom_instrumental(
gcs_clean_instrumental_path="jobs/test/stems/clean.flac",
gcs_backing_vocals_path="jobs/test/stems/backing.flac",
mute_regions=mute_regions,
gcs_output_path="jobs/test/stems/custom.flac",
job_id="test-job",
)
# Verify both files were downloaded
assert len(downloaded_files) == 2
assert mock_storage_service.upload_file.called
def test_create_custom_instrumental_uploads_result(
self, mock_storage_service, temp_audio_files
):
"""Test that create_custom_instrumental uploads the result."""
from backend.services.audio_editing_service import AudioEditingService
clean_path, backing_path = temp_audio_files
def mock_download(gcs_path, local_path):
import shutil
if 'clean' in gcs_path:
shutil.copy(clean_path, local_path)
else:
shutil.copy(backing_path, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/stems/custom.flac"
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [MuteRegion(start_seconds=1.0, end_seconds=2.0)]
result = service.create_custom_instrumental(
gcs_clean_instrumental_path="jobs/test/stems/clean.flac",
gcs_backing_vocals_path="jobs/test/stems/backing.flac",
mute_regions=mute_regions,
gcs_output_path="jobs/test/stems/custom.flac",
job_id="test-job",
)
# Verify upload was called with correct destination
mock_storage_service.upload_file.assert_called_once()
call_args = mock_storage_service.upload_file.call_args
assert call_args[0][1] == "jobs/test/stems/custom.flac"
# Verify result has correct path
assert result.output_path == "jobs/test/stems/custom.flac"
def test_create_custom_instrumental_returns_statistics(
self, mock_storage_service, temp_audio_files
):
"""Test that create_custom_instrumental returns correct statistics."""
from backend.services.audio_editing_service import AudioEditingService
clean_path, backing_path = temp_audio_files
def mock_download(gcs_path, local_path):
import shutil
if 'clean' in gcs_path:
shutil.copy(clean_path, local_path)
else:
shutil.copy(backing_path, local_path)
return local_path
mock_storage_service.download_file.side_effect = mock_download
mock_storage_service.upload_file.return_value = "jobs/test/stems/custom.flac"
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [
MuteRegion(start_seconds=1.0, end_seconds=2.0),
MuteRegion(start_seconds=3.0, end_seconds=4.0),
]
result = service.create_custom_instrumental(
gcs_clean_instrumental_path="jobs/test/stems/clean.flac",
gcs_backing_vocals_path="jobs/test/stems/backing.flac",
mute_regions=mute_regions,
gcs_output_path="jobs/test/stems/custom.flac",
job_id="test-job",
)
# Verify statistics
assert len(result.mute_regions_applied) == 2
assert result.total_muted_duration_seconds == 2.0 # 1s + 1s
assert result.output_duration_seconds > 0
def test_validate_mute_regions_returns_errors_for_invalid(
self, mock_storage_service
):
"""Test that validate_mute_regions catches invalid regions."""
from backend.services.audio_editing_service import AudioEditingService
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [
MuteRegion(start_seconds=0.0, end_seconds=1.0), # Valid
MuteRegion(start_seconds=100.0, end_seconds=110.0), # Beyond duration
]
errors = service.validate_mute_regions(mute_regions, total_duration_seconds=60.0)
# Should have error for region exceeding duration
assert len(errors) == 1
assert "exceeds" in errors[0].lower()
def test_validate_mute_regions_returns_empty_for_valid(
self, mock_storage_service
):
"""Test that validate_mute_regions returns empty for valid regions."""
from backend.services.audio_editing_service import AudioEditingService
service = AudioEditingService(storage_service=mock_storage_service)
mute_regions = [
MuteRegion(start_seconds=0.0, end_seconds=1.0),
MuteRegion(start_seconds=10.0, end_seconds=15.0),
]
errors = service.validate_mute_regions(mute_regions, total_duration_seconds=60.0)
assert len(errors) == 0
+222
View File
@@ -963,6 +963,228 @@ class TestDurationValidation:
assert inspect.iscoroutinefunction(_validate_audio_durations)
class TestTwoPhaseWorkflowModels:
"""Test Pydantic models for two-phase workflow (Batch 6)."""
def test_create_job_with_upload_urls_request_has_prep_only(self):
"""Test that CreateJobWithUploadUrlsRequest has prep_only field."""
from backend.api.routes.file_upload import CreateJobWithUploadUrlsRequest, FileUploadRequest
request = CreateJobWithUploadUrlsRequest(
artist="Test Artist",
title="Test Song",
files=[
FileUploadRequest(filename="test.flac", content_type="audio/flac", file_type="audio")
],
prep_only=True
)
assert request.prep_only is True
def test_create_job_with_upload_urls_request_prep_only_default_false(self):
"""Test that prep_only defaults to False."""
from backend.api.routes.file_upload import CreateJobWithUploadUrlsRequest, FileUploadRequest
request = CreateJobWithUploadUrlsRequest(
artist="Test Artist",
title="Test Song",
files=[
FileUploadRequest(filename="test.flac", content_type="audio/flac", file_type="audio")
]
)
assert request.prep_only is False
def test_create_job_with_upload_urls_request_has_keep_brand_code(self):
"""Test that CreateJobWithUploadUrlsRequest has keep_brand_code field."""
from backend.api.routes.file_upload import CreateJobWithUploadUrlsRequest, FileUploadRequest
request = CreateJobWithUploadUrlsRequest(
artist="Test Artist",
title="Test Song",
files=[
FileUploadRequest(filename="test.flac", content_type="audio/flac", file_type="audio")
],
keep_brand_code="NOMAD-1234"
)
assert request.keep_brand_code == "NOMAD-1234"
def test_create_job_with_upload_urls_request_keep_brand_code_default_none(self):
"""Test that keep_brand_code defaults to None."""
from backend.api.routes.file_upload import CreateJobWithUploadUrlsRequest, FileUploadRequest
request = CreateJobWithUploadUrlsRequest(
artist="Test Artist",
title="Test Song",
files=[
FileUploadRequest(filename="test.flac", content_type="audio/flac", file_type="audio")
]
)
assert request.keep_brand_code is None
class TestFinaliseOnlyFileTypes:
"""Test finalise-only file types (Batch 6)."""
def test_finalise_only_file_types_exists(self):
"""Test that FINALISE_ONLY_FILE_TYPES is defined."""
from backend.api.routes.file_upload import FINALISE_ONLY_FILE_TYPES
assert FINALISE_ONLY_FILE_TYPES is not None
assert isinstance(FINALISE_ONLY_FILE_TYPES, dict)
def test_finalise_only_file_types_has_with_vocals(self):
"""Test that with_vocals is a valid finalise-only file type."""
from backend.api.routes.file_upload import FINALISE_ONLY_FILE_TYPES
assert 'with_vocals' in FINALISE_ONLY_FILE_TYPES
assert '.mkv' in FINALISE_ONLY_FILE_TYPES['with_vocals']
assert '.mov' in FINALISE_ONLY_FILE_TYPES['with_vocals']
def test_finalise_only_file_types_has_title_screen(self):
"""Test that title_screen is a valid finalise-only file type."""
from backend.api.routes.file_upload import FINALISE_ONLY_FILE_TYPES
assert 'title_screen' in FINALISE_ONLY_FILE_TYPES
def test_finalise_only_file_types_has_end_screen(self):
"""Test that end_screen is a valid finalise-only file type."""
from backend.api.routes.file_upload import FINALISE_ONLY_FILE_TYPES
assert 'end_screen' in FINALISE_ONLY_FILE_TYPES
def test_finalise_only_file_types_has_instrumentals(self):
"""Test that instrumental types are valid finalise-only file types."""
from backend.api.routes.file_upload import FINALISE_ONLY_FILE_TYPES
assert 'instrumental_clean' in FINALISE_ONLY_FILE_TYPES
assert 'instrumental_backing' in FINALISE_ONLY_FILE_TYPES
def test_finalise_only_file_types_has_lrc(self):
"""Test that lrc is a valid finalise-only file type."""
from backend.api.routes.file_upload import FINALISE_ONLY_FILE_TYPES
assert 'lrc' in FINALISE_ONLY_FILE_TYPES
assert '.lrc' in FINALISE_ONLY_FILE_TYPES['lrc']
class TestFinaliseOnlyModels:
"""Test Pydantic models for finalise-only flow (Batch 6)."""
def test_finalise_only_file_request_model(self):
"""Test FinaliseOnlyFileRequest model."""
from backend.api.routes.file_upload import FinaliseOnlyFileRequest
file_req = FinaliseOnlyFileRequest(
filename="with_vocals.mkv",
content_type="video/mkv",
file_type="with_vocals"
)
assert file_req.filename == "with_vocals.mkv"
assert file_req.content_type == "video/mkv"
assert file_req.file_type == "with_vocals"
def test_create_finalise_only_job_request_model(self):
"""Test CreateFinaliseOnlyJobRequest model."""
from backend.api.routes.file_upload import CreateFinaliseOnlyJobRequest, FinaliseOnlyFileRequest
request = CreateFinaliseOnlyJobRequest(
artist="Test Artist",
title="Test Song",
files=[
FinaliseOnlyFileRequest(filename="with_vocals.mkv", content_type="video/mkv", file_type="with_vocals"),
FinaliseOnlyFileRequest(filename="title.mov", content_type="video/quicktime", file_type="title_screen"),
FinaliseOnlyFileRequest(filename="end.mov", content_type="video/quicktime", file_type="end_screen"),
FinaliseOnlyFileRequest(filename="instrumental.flac", content_type="audio/flac", file_type="instrumental_clean"),
],
enable_cdg=True,
enable_txt=True,
brand_prefix="NOMAD",
keep_brand_code="NOMAD-1234"
)
assert request.artist == "Test Artist"
assert request.title == "Test Song"
assert len(request.files) == 4
assert request.keep_brand_code == "NOMAD-1234"
def test_create_finalise_only_job_request_optional_fields(self):
"""Test CreateFinaliseOnlyJobRequest optional fields default correctly."""
from backend.api.routes.file_upload import CreateFinaliseOnlyJobRequest, FinaliseOnlyFileRequest
request = CreateFinaliseOnlyJobRequest(
artist="Artist",
title="Title",
files=[
FinaliseOnlyFileRequest(filename="with_vocals.mkv", content_type="video/mkv", file_type="with_vocals"),
]
)
assert request.enable_cdg is True
assert request.enable_txt is True
assert request.brand_prefix is None
assert request.keep_brand_code is None
assert request.enable_youtube_upload is False
assert request.dropbox_path is None
assert request.gdrive_folder_id is None
class TestFinaliseOnlyGCSPaths:
"""Test GCS path generation for finalise-only files (Batch 6)."""
def test_with_vocals_gcs_path(self):
"""Test GCS path generation for with_vocals file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "with_vocals", "video.mkv")
assert path == "jobs/test123/videos/with_vocals.mkv"
def test_title_screen_gcs_path(self):
"""Test GCS path generation for title_screen file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "title_screen", "title.mov")
assert path == "jobs/test123/screens/title.mov"
def test_end_screen_gcs_path(self):
"""Test GCS path generation for end_screen file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "end_screen", "end.mov")
assert path == "jobs/test123/screens/end.mov"
def test_instrumental_clean_gcs_path(self):
"""Test GCS path generation for instrumental_clean file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "instrumental_clean", "clean.flac")
assert path == "jobs/test123/stems/instrumental_clean.flac"
def test_instrumental_backing_gcs_path(self):
"""Test GCS path generation for instrumental_backing file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "instrumental_backing", "backing.flac")
assert path == "jobs/test123/stems/instrumental_with_backing.flac"
def test_lrc_gcs_path(self):
"""Test GCS path generation for lrc file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "lrc", "karaoke.lrc")
assert path == "jobs/test123/lyrics/karaoke.lrc"
def test_title_jpg_gcs_path(self):
"""Test GCS path generation for title_jpg file."""
from backend.api.routes.file_upload import _get_gcs_path_for_finalise_file
path = _get_gcs_path_for_finalise_file("test123", "title_jpg", "title.jpg")
assert path == "jobs/test123/screens/title.jpg"
# ============================================================================
# Batch 4: YouTube URL Input Tests
# ============================================================================
+457
View File
@@ -0,0 +1,457 @@
"""
API endpoint tests for instrumental review functionality.
Tests for:
- GET /api/jobs/{job_id}/instrumental-analysis
- GET /api/jobs/{job_id}/audio-stream/{stem_type}
- POST /api/jobs/{job_id}/create-custom-instrumental
- GET /api/jobs/{job_id}/waveform-data
"""
import pytest
from datetime import datetime
from unittest.mock import MagicMock, patch, AsyncMock
from fastapi.testclient import TestClient
from backend.models.job import Job, JobStatus
@pytest.fixture
def mock_job_manager():
"""Create a mock job manager."""
with patch('backend.api.routes.jobs.job_manager') as mock:
yield mock
@pytest.fixture
def mock_storage_service():
"""Create a mock storage service."""
with patch('backend.api.routes.jobs.StorageService') as mock:
mock_instance = MagicMock()
mock_instance.generate_signed_url.return_value = "https://storage.googleapis.com/signed-url"
mock.return_value = mock_instance
yield mock_instance
@pytest.fixture
def sample_job():
"""Create a sample job for testing."""
return Job(
job_id="test-job-123",
artist="Test Artist",
title="Test Song",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(),
updated_at=datetime.now(),
file_urls={
"stems": {
"instrumental_clean": "jobs/test/stems/instrumental_clean.flac",
"backing_vocals": "jobs/test/stems/backing_vocals.flac",
"instrumental_with_backing": "jobs/test/stems/instrumental_with_backing.flac",
},
"analysis": {
"backing_vocals_waveform": "jobs/test/analysis/waveform.png",
},
},
state_data={
"backing_vocals_analysis": {
"has_audible_content": True,
"total_duration_seconds": 180.0,
"audible_segments": [
{
"start_seconds": 10.0,
"end_seconds": 20.0,
"duration_seconds": 10.0,
"avg_amplitude_db": -25.0,
},
{
"start_seconds": 60.0,
"end_seconds": 80.0,
"duration_seconds": 20.0,
"avg_amplitude_db": -30.0,
},
],
"recommended_selection": "review_needed",
"total_audible_duration_seconds": 30.0,
"audible_percentage": 16.67,
"silence_threshold_db": -40.0,
}
},
)
@pytest.fixture
def silent_job():
"""Create a job with silent backing vocals."""
return Job(
job_id="test-job-silent",
artist="Test Artist",
title="Test Song",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(),
updated_at=datetime.now(),
file_urls={
"stems": {
"instrumental_clean": "jobs/test/stems/instrumental_clean.flac",
"backing_vocals": "jobs/test/stems/backing_vocals.flac",
"instrumental_with_backing": "jobs/test/stems/instrumental_with_backing.flac",
},
"analysis": {
"backing_vocals_waveform": "jobs/test/analysis/waveform.png",
},
},
state_data={
"backing_vocals_analysis": {
"has_audible_content": False,
"total_duration_seconds": 180.0,
"audible_segments": [],
"recommended_selection": "clean",
"total_audible_duration_seconds": 0.0,
"audible_percentage": 0.0,
"silence_threshold_db": -40.0,
}
},
)
class TestGetInstrumentalAnalysis:
"""Tests for GET /api/jobs/{job_id}/instrumental-analysis."""
def test_get_analysis_returns_data(self, mock_job_manager, mock_storage_service, sample_job):
"""GET /instrumental-analysis should return analysis data."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert result["job_id"] == "test-job-123"
assert result["artist"] == "Test Artist"
assert result["title"] == "Test Song"
assert result["analysis"]["has_audible_content"] is True
assert len(result["analysis"]["audible_segments"]) == 2
def test_get_analysis_includes_audio_urls(self, mock_job_manager, mock_storage_service, sample_job):
"""GET /instrumental-analysis should include audio URLs."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert "audio_urls" in result
assert "clean_instrumental" in result["audio_urls"]
assert "backing_vocals" in result["audio_urls"]
assert "with_backing" in result["audio_urls"]
def test_get_analysis_includes_waveform_url(self, mock_job_manager, sample_job):
"""GET /instrumental-analysis should include waveform URL."""
mock_job_manager.get_job.return_value = sample_job
# Need to mock StorageService at module level for the signed URL
with patch('backend.api.routes.jobs.StorageService') as mock_storage_cls:
mock_storage = MagicMock()
mock_storage.generate_signed_url.return_value = "https://storage.googleapis.com/signed-url"
mock_storage_cls.return_value = mock_storage
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert "waveform_url" in result
# Waveform URL should be generated from the file_urls
assert result["waveform_url"] == "https://storage.googleapis.com/signed-url"
def test_get_analysis_silent_audio(self, mock_job_manager, mock_storage_service, silent_job):
"""GET /instrumental-analysis should correctly report silent audio."""
mock_job_manager.get_job.return_value = silent_job
from backend.api.routes.jobs import get_instrumental_analysis
import asyncio
result = asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-silent")
)
assert result["analysis"]["has_audible_content"] is False
assert result["analysis"]["recommended_selection"] == "clean"
assert len(result["analysis"]["audible_segments"]) == 0
def test_get_analysis_job_not_found(self, mock_job_manager):
"""GET /instrumental-analysis should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import get_instrumental_analysis
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("non-existent")
)
assert exc_info.value.status_code == 404
def test_get_analysis_wrong_status(self, mock_job_manager, sample_job):
"""GET /instrumental-analysis should return 400 for wrong job status."""
sample_job.status = JobStatus.PENDING
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_instrumental_analysis
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_instrumental_analysis("test-job-123")
)
assert exc_info.value.status_code == 400
class TestAudioStream:
"""Tests for GET /api/jobs/{job_id}/audio-stream/{stem_type}."""
def test_stream_backing_vocals_valid(self, mock_job_manager, sample_job):
"""Should return redirect for backing vocals stream."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import stream_audio
import asyncio
# This will try to stream from GCS which we can't test easily
# Instead, verify the function exists and has correct signature
assert callable(stream_audio)
def test_stream_invalid_stem_type(self, mock_job_manager, sample_job):
"""Should return 400 for invalid stem type."""
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import stream_audio
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
stream_audio("test-job-123", "invalid_stem")
)
assert exc_info.value.status_code == 400
def test_stream_job_not_found(self, mock_job_manager):
"""Should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import stream_audio
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
stream_audio("non-existent", "backing_vocals")
)
assert exc_info.value.status_code == 404
class TestCreateCustomInstrumental:
"""Tests for POST /api/jobs/{job_id}/create-custom-instrumental."""
@pytest.fixture
def mock_audio_editing_service(self):
"""Mock the audio editing service."""
with patch('backend.api.routes.jobs.AudioEditingService') as mock:
mock_instance = MagicMock()
mock_instance.create_custom_instrumental.return_value = MagicMock(
output_path="jobs/test/stems/custom_instrumental.flac",
mute_regions_applied=[
MagicMock(start_seconds=10.0, end_seconds=20.0),
],
total_muted_duration_seconds=10.0,
output_duration_seconds=180.0,
)
mock.return_value = mock_instance
yield mock_instance
def test_create_custom_validates_mute_regions(self):
"""Should validate mute regions at model level."""
from backend.models.requests import CreateCustomInstrumentalRequest, MuteRegionRequest
from pydantic import ValidationError
# Empty mute regions should fail at model validation
with pytest.raises(ValidationError) as exc_info:
CreateCustomInstrumentalRequest(mute_regions=[])
assert "At least one mute region is required" in str(exc_info.value)
def test_create_custom_job_not_found(self, mock_job_manager):
"""Should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import create_custom_instrumental
from backend.models.requests import CreateCustomInstrumentalRequest, MuteRegionRequest
from fastapi import HTTPException
import asyncio
request = CreateCustomInstrumentalRequest(
mute_regions=[MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)]
)
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
create_custom_instrumental("non-existent", request)
)
assert exc_info.value.status_code == 404
def test_create_custom_wrong_status(self, mock_job_manager, sample_job):
"""Should return 400 for wrong job status."""
sample_job.status = JobStatus.PENDING
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import create_custom_instrumental
from backend.models.requests import CreateCustomInstrumentalRequest, MuteRegionRequest
from fastapi import HTTPException
import asyncio
request = CreateCustomInstrumentalRequest(
mute_regions=[MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)]
)
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
create_custom_instrumental("test-job-123", request)
)
assert exc_info.value.status_code == 400
class TestGetWaveformData:
"""Tests for GET /api/jobs/{job_id}/waveform-data."""
def test_get_waveform_data_job_not_found(self, mock_job_manager):
"""Should return 404 for non-existent job."""
mock_job_manager.get_job.return_value = None
from backend.api.routes.jobs import get_waveform_data
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_waveform_data("non-existent")
)
assert exc_info.value.status_code == 404
def test_get_waveform_data_wrong_status(self, mock_job_manager, sample_job):
"""Should return 400 for wrong job status."""
sample_job.status = JobStatus.PENDING
mock_job_manager.get_job.return_value = sample_job
from backend.api.routes.jobs import get_waveform_data
from fastapi import HTTPException
import asyncio
with pytest.raises(HTTPException) as exc_info:
asyncio.get_event_loop().run_until_complete(
get_waveform_data("test-job-123")
)
assert exc_info.value.status_code == 400
def test_waveform_data_endpoint_exists(self):
"""Verify the endpoint function exists and is callable."""
from backend.api.routes.jobs import get_waveform_data
assert callable(get_waveform_data)
# Verify it's an async function
import inspect
assert inspect.iscoroutinefunction(get_waveform_data)
class TestRequestModels:
"""Tests for API request models."""
def test_mute_region_request_valid(self):
"""MuteRegionRequest should accept valid values."""
from backend.models.requests import MuteRegionRequest
region = MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)
assert region.start_seconds == 10.0
assert region.end_seconds == 20.0
def test_mute_region_request_invalid_start(self):
"""MuteRegionRequest should reject negative start."""
from backend.models.requests import MuteRegionRequest
from pydantic import ValidationError
with pytest.raises(ValidationError):
MuteRegionRequest(start_seconds=-1.0, end_seconds=20.0)
def test_mute_region_request_invalid_order(self):
"""MuteRegionRequest should reject end before start."""
from backend.models.requests import MuteRegionRequest
from pydantic import ValidationError
with pytest.raises(ValidationError):
MuteRegionRequest(start_seconds=20.0, end_seconds=10.0)
def test_create_custom_instrumental_request_valid(self):
"""CreateCustomInstrumentalRequest should accept valid mute regions."""
from backend.models.requests import (
CreateCustomInstrumentalRequest,
MuteRegionRequest,
)
request = CreateCustomInstrumentalRequest(
mute_regions=[
MuteRegionRequest(start_seconds=10.0, end_seconds=20.0),
MuteRegionRequest(start_seconds=60.0, end_seconds=80.0),
]
)
assert len(request.mute_regions) == 2
class TestInstrumentalSelectionExtension:
"""Tests for extended instrumental selection (including 'custom')."""
def test_instrumental_selection_accepts_custom(self):
"""InstrumentalSelection should accept 'custom' as valid selection."""
from backend.models.requests import InstrumentalSelection
selection = InstrumentalSelection(selection="custom")
assert selection.selection == "custom"
def test_instrumental_selection_accepts_clean(self):
"""InstrumentalSelection should accept 'clean' as valid selection."""
from backend.models.requests import InstrumentalSelection
selection = InstrumentalSelection(selection="clean")
assert selection.selection == "clean"
def test_instrumental_selection_accepts_with_backing(self):
"""InstrumentalSelection should accept 'with_backing' as valid selection."""
from backend.models.requests import InstrumentalSelection
selection = InstrumentalSelection(selection="with_backing")
assert selection.selection == "with_backing"
def test_instrumental_selection_rejects_invalid(self):
"""InstrumentalSelection should reject invalid values."""
from backend.models.requests import InstrumentalSelection
from pydantic import ValidationError
with pytest.raises(ValidationError):
InstrumentalSelection(selection="invalid_option")
+243
View File
@@ -670,6 +670,249 @@ class TestExistingInstrumentalModelFields:
assert job.existing_instrumental_gcs_path == "uploads/test123/audio/my_instrumental.flac"
class TestTwoPhaseWorkflowFields:
"""Test two-phase workflow fields in Job and JobCreate models (Batch 6)."""
def test_job_has_prep_only_field(self):
"""Test that Job model has prep_only field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
prep_only=True
)
assert hasattr(job, 'prep_only')
assert job.prep_only is True
def test_job_prep_only_defaults_to_false(self):
"""Test that prep_only defaults to False."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.prep_only is False
def test_job_has_finalise_only_field(self):
"""Test that Job model has finalise_only field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
finalise_only=True
)
assert hasattr(job, 'finalise_only')
assert job.finalise_only is True
def test_job_finalise_only_defaults_to_false(self):
"""Test that finalise_only defaults to False."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.finalise_only is False
def test_job_has_keep_brand_code_field(self):
"""Test that Job model has keep_brand_code field."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
keep_brand_code="NOMAD-1234"
)
assert hasattr(job, 'keep_brand_code')
assert job.keep_brand_code == "NOMAD-1234"
def test_job_keep_brand_code_defaults_to_none(self):
"""Test that keep_brand_code defaults to None."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.keep_brand_code is None
def test_job_create_has_two_phase_workflow_fields(self):
"""Test that JobCreate model has two-phase workflow fields."""
job_create = JobCreate(
artist="Artist",
title="Title",
prep_only=True,
finalise_only=False,
keep_brand_code="BRAND-0001"
)
assert job_create.prep_only is True
assert job_create.finalise_only is False
assert job_create.keep_brand_code == "BRAND-0001"
def test_two_phase_workflow_roundtrip_serialization(self):
"""Test that two-phase workflow fields survive serialization/deserialization."""
job = Job(
job_id="test123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
prep_only=True,
finalise_only=False,
keep_brand_code="NOMAD-5678"
)
# Serialize to dict (simulates writing to Firestore)
job_dict = job.model_dump()
# Convert to JSON and back (simulates Firestore storage)
json_str = json.dumps(job_dict, default=str)
restored_dict = json.loads(json_str)
# Deserialize back to Job (simulates reading from Firestore)
restored_job = Job(**restored_dict)
assert restored_job.prep_only is True
assert restored_job.finalise_only is False
assert restored_job.keep_brand_code == "NOMAD-5678"
class TestPrepCompleteStatus:
"""Test PREP_COMPLETE status and state transitions (Batch 6)."""
def test_prep_complete_status_exists(self):
"""Test that PREP_COMPLETE status exists in JobStatus enum."""
assert hasattr(JobStatus, 'PREP_COMPLETE')
assert JobStatus.PREP_COMPLETE.value == "prep_complete"
def test_job_can_have_prep_complete_status(self):
"""Test that Job can be created with PREP_COMPLETE status."""
job = Job(
job_id="test123",
status=JobStatus.PREP_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC)
)
assert job.status == JobStatus.PREP_COMPLETE
def test_state_transitions_review_complete_to_prep_complete(self):
"""Test that REVIEW_COMPLETE can transition to PREP_COMPLETE."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.REVIEW_COMPLETE, [])
assert JobStatus.PREP_COMPLETE in valid_transitions
def test_state_transitions_prep_complete_to_awaiting_instrumental(self):
"""Test that PREP_COMPLETE can transition to AWAITING_INSTRUMENTAL_SELECTION."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.PREP_COMPLETE, [])
assert JobStatus.AWAITING_INSTRUMENTAL_SELECTION in valid_transitions
def test_state_transitions_pending_to_awaiting_instrumental(self):
"""Test that PENDING can transition to AWAITING_INSTRUMENTAL_SELECTION (for finalise-only)."""
from backend.models.job import STATE_TRANSITIONS
valid_transitions = STATE_TRANSITIONS.get(JobStatus.PENDING, [])
assert JobStatus.AWAITING_INSTRUMENTAL_SELECTION in valid_transitions
def test_critical_statuses_include_prep_complete(self):
"""Test that PREP_COMPLETE is in the list of job statuses."""
all_statuses = [status.value for status in JobStatus]
assert "prep_complete" in all_statuses
class TestJobWithFullTwoPhaseConfig:
"""Integration tests for two-phase workflow job configuration."""
def test_prep_only_job_full_config(self):
"""Test creating a prep-only job with full configuration."""
job = Job(
job_id="prep123",
status=JobStatus.PENDING,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song",
prep_only=True,
enable_cdg=True,
enable_txt=True,
brand_prefix="NOMAD",
)
assert job.prep_only is True
assert job.finalise_only is False
assert job.brand_prefix == "NOMAD"
def test_finalise_only_job_full_config(self):
"""Test creating a finalise-only job with full configuration."""
job = Job(
job_id="final123",
status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="Test Artist",
title="Test Song",
finalise_only=True,
keep_brand_code="NOMAD-1234",
enable_youtube_upload=True,
dropbox_path="/Karaoke/Tracks",
state_data={
"audio_complete": True,
"lyrics_complete": True,
"finalise_only": True,
}
)
assert job.finalise_only is True
assert job.keep_brand_code == "NOMAD-1234"
assert job.state_data["finalise_only"] is True
def test_prep_complete_job_with_file_urls(self):
"""Test a job that has reached PREP_COMPLETE status with all prep outputs."""
job = Job(
job_id="prepcomp123",
status=JobStatus.PREP_COMPLETE,
created_at=datetime.now(UTC),
updated_at=datetime.now(UTC),
artist="ABBA",
title="Waterloo",
prep_only=True,
file_urls={
"stems": {
"instrumental_clean": "gs://bucket/jobs/prepcomp123/stems/instrumental_clean.flac",
"instrumental_with_backing": "gs://bucket/jobs/prepcomp123/stems/instrumental_with_backing.flac",
},
"videos": {
"with_vocals": "gs://bucket/jobs/prepcomp123/videos/with_vocals.mkv",
},
"screens": {
"title": "gs://bucket/jobs/prepcomp123/screens/title.mov",
"end": "gs://bucket/jobs/prepcomp123/screens/end.mov",
},
"lyrics": {
"lrc": "gs://bucket/jobs/prepcomp123/lyrics/karaoke.lrc",
"ass": "gs://bucket/jobs/prepcomp123/lyrics/karaoke.ass",
},
}
)
assert job.status == JobStatus.PREP_COMPLETE
assert job.prep_only is True
assert "with_vocals" in job.file_urls["videos"]
assert "title" in job.file_urls["screens"]
if __name__ == "__main__":
pytest.main([__file__, "-v"])
+78
View File
@@ -869,3 +869,81 @@ class TestDownloadAudioWithUrl:
# Should have called storage.download_file
mock_storage.download_file.assert_called()
class TestBackingVocalsAnalysis:
"""Tests for backing vocals analysis in render_video_worker."""
def test_analyze_backing_vocals_function_exists(self):
"""Test that _analyze_backing_vocals function exists in render_video_worker."""
from backend.workers.render_video_worker import _analyze_backing_vocals
assert callable(_analyze_backing_vocals)
def test_analyze_backing_vocals_is_async(self):
"""Test that _analyze_backing_vocals is an async function."""
import inspect
from backend.workers.render_video_worker import _analyze_backing_vocals
assert inspect.iscoroutinefunction(_analyze_backing_vocals)
def test_render_video_worker_imports_analysis_service(self):
"""Test that render_video_worker can import AudioAnalysisService."""
# This verifies the import path is correct
from backend.services.audio_analysis_service import AudioAnalysisService
assert AudioAnalysisService is not None
@pytest.mark.asyncio
async def test_analyze_backing_vocals_handles_missing_job(self):
"""Test that analysis returns early when job not found (no error stored)."""
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = None # No job found
mock_job_manager.update_state_data = MagicMock()
mock_storage = MagicMock()
mock_logger = MagicMock()
from backend.workers.render_video_worker import _analyze_backing_vocals
# Should not raise when job not found, just log warning and return
await _analyze_backing_vocals(
"nonexistent", mock_job_manager, mock_storage, mock_logger
)
# Should log warning but not update state (early return)
mock_logger.warning.assert_called()
# No state_data update since we return early
mock_job_manager.update_state_data.assert_not_called()
@pytest.mark.asyncio
async def test_analyze_backing_vocals_handles_missing_stems(self):
"""Test that analysis returns early when stems not found (no error stored)."""
mock_job = MagicMock()
mock_job.file_urls = {} # No stems
mock_job_manager = MagicMock()
mock_job_manager.get_job.return_value = mock_job
mock_job_manager.update_state_data = MagicMock()
mock_storage = MagicMock()
mock_logger = MagicMock()
from backend.workers.render_video_worker import _analyze_backing_vocals
# Should not raise when stems not found, just log warning and return
await _analyze_backing_vocals(
"test123", mock_job_manager, mock_storage, mock_logger
)
# Should log warning but not update state (early return)
mock_logger.warning.assert_called()
# No state_data update since we return early
mock_job_manager.update_state_data.assert_not_called()
def test_analysis_service_can_be_instantiated(self):
"""Test that AudioAnalysisService can be instantiated."""
from backend.services.audio_analysis_service import AudioAnalysisService
mock_storage = MagicMock()
service = AudioAnalysisService(storage_service=mock_storage)
assert service is not None
assert service.storage_service == mock_storage
+16 -3
View File
@@ -447,11 +447,24 @@ async def upload_lyrics_results(
corrections_data = json.load(f)
# Store metadata in state_data
job_manager.update_state_data(job_id, 'lyrics_metadata', {
# Include countdown padding info for instrumental synchronization
lyrics_metadata = {
'segment_count': len(corrections_data.get('corrected_segments', [])),
'has_corrections': True,
'ready_for_review': True
})
'ready_for_review': True,
}
# Add countdown padding info from transcription result
# This is needed by video_worker to pad instrumentals for sync
if transcription_result.get("countdown_padding_added"):
lyrics_metadata['has_countdown_padding'] = True
lyrics_metadata['countdown_padding_seconds'] = transcription_result.get("countdown_padding_seconds", 3.0)
logger.info(f"Job {job_id}: Countdown padding detected: {lyrics_metadata['countdown_padding_seconds']}s")
else:
lyrics_metadata['has_countdown_padding'] = False
lyrics_metadata['countdown_padding_seconds'] = 0.0
job_manager.update_state_data(job_id, 'lyrics_metadata', lyrics_metadata)
except Exception as e:
logger.warning(f"Job {job_id}: Could not parse corrections JSON: {e}")
else:
+128 -9
View File
@@ -266,16 +266,31 @@ async def process_render_video(job_id: str) -> bool:
job_log.info("Uploaded corrected.txt")
logger.info(f"Job {job_id}: Uploaded corrected.txt")
# 11. Transition to awaiting instrumental selection
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
progress=80,
message="Video rendered - select your instrumental"
)
# 11. Analyze backing vocals for intelligent instrumental selection
job_log.info("Analyzing backing vocals for instrumental selection...")
await _analyze_backing_vocals(job_id, job_manager, storage, job_log)
job_log.info("=== RENDER VIDEO WORKER COMPLETE ===")
logger.info(f"Job {job_id}: Video render complete, awaiting instrumental selection")
# 12. Transition based on prep_only flag
if getattr(job, 'prep_only', False):
# Prep-only mode: stop here and mark as prep complete
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.PREP_COMPLETE,
progress=100,
message="Prep phase complete - download outputs to continue locally"
)
job_log.info("=== RENDER VIDEO WORKER COMPLETE (PREP ONLY) ===")
logger.info(f"Job {job_id}: Prep-only video render complete")
else:
# Normal mode: proceed to instrumental selection
job_manager.transition_to_state(
job_id=job_id,
new_status=JobStatus.AWAITING_INSTRUMENTAL_SELECTION,
progress=80,
message="Video rendered - select your instrumental"
)
job_log.info("=== RENDER VIDEO WORKER COMPLETE ===")
logger.info(f"Job {job_id}: Video render complete, awaiting instrumental selection")
return True
except Exception as e:
@@ -302,5 +317,109 @@ def _extract_gcs_path(url: str) -> str:
return url
async def _analyze_backing_vocals(
job_id: str,
job_manager: JobManager,
storage: StorageService,
job_log: logging.Logger,
) -> None:
"""
Analyze backing vocals to help with intelligent instrumental selection.
This function:
1. Downloads the backing vocals stem from GCS
2. Runs audio analysis to detect audible content
3. Generates a waveform visualization image
4. Stores analysis results and waveform URL in job state
The analysis data is then used by the frontend to provide an
intelligent instrumental selection experience.
"""
from backend.services.audio_analysis_service import AudioAnalysisService
try:
# Get the job to access file URLs
job = job_manager.get_job(job_id)
if not job:
job_log.warning(f"Could not get job {job_id} for backing vocals analysis")
return
# Get backing vocals path
backing_vocals_path = job.file_urls.get('stems', {}).get('backing_vocals')
if not backing_vocals_path:
job_log.warning("No backing vocals file found - skipping analysis")
return
job_log.info(f"Analyzing backing vocals: {backing_vocals_path}")
# Create analysis service and run analysis
analysis_service = AudioAnalysisService()
# Define output path for waveform
waveform_gcs_path = f"jobs/{job_id}/analysis/backing_vocals_waveform.png"
# Run analysis and generate waveform
result, waveform_path = analysis_service.analyze_and_generate_waveform(
gcs_audio_path=backing_vocals_path,
job_id=job_id,
gcs_waveform_destination=waveform_gcs_path,
)
# Store analysis results in job state_data
analysis_data = {
'has_audible_content': result.has_audible_content,
'total_duration_seconds': result.total_duration_seconds,
'audible_segments': [
{
'start_seconds': seg.start_seconds,
'end_seconds': seg.end_seconds,
'duration_seconds': seg.duration_seconds,
'avg_amplitude_db': seg.avg_amplitude_db,
'peak_amplitude_db': seg.peak_amplitude_db,
}
for seg in result.audible_segments
],
'recommended_selection': result.recommended_selection.value,
'total_audible_duration_seconds': result.total_audible_duration_seconds,
'audible_percentage': result.audible_percentage,
'silence_threshold_db': result.silence_threshold_db,
}
job_manager.update_state_data(job_id, 'backing_vocals_analysis', analysis_data)
# Store waveform URL
job_manager.update_file_url(job_id, 'analysis', 'backing_vocals_waveform', waveform_path)
job_log.info(
f"Backing vocals analysis complete: "
f"has_audible={result.has_audible_content}, "
f"segments={result.segment_count}, "
f"recommendation={result.recommended_selection.value}"
)
# Log segment details if there are any
if result.audible_segments:
job_log.info(f"Audible segments ({len(result.audible_segments)}):")
for i, seg in enumerate(result.audible_segments[:5]): # Log first 5
job_log.info(
f" [{i+1}] {seg.start_seconds:.1f}s - {seg.end_seconds:.1f}s "
f"({seg.duration_seconds:.1f}s, avg: {seg.avg_amplitude_db:.1f}dB)"
)
if len(result.audible_segments) > 5:
job_log.info(f" ... and {len(result.audible_segments) - 5} more")
except Exception as e:
# Log the error but don't fail the job - analysis is a nice-to-have
job_log.warning(f"Backing vocals analysis failed (non-fatal): {e}")
logger.warning(f"Job {job_id}: Backing vocals analysis failed: {e}")
# Store empty analysis so the frontend knows analysis was attempted
job_manager.update_state_data(job_id, 'backing_vocals_analysis', {
'has_audible_content': None,
'analysis_error': str(e),
'recommended_selection': 'review_needed',
})
# For compatibility with worker service
render_video_worker = process_render_video
+18
View File
@@ -162,6 +162,14 @@ async def generate_video(job_id: str) -> bool:
message="Encoding videos (15-20 min)"
)
# Get countdown padding info from lyrics metadata
# This ensures instrumental is padded to match vocals if countdown was added
lyrics_metadata = job.state_data.get('lyrics_metadata', {})
countdown_padding_seconds = None
if lyrics_metadata.get('has_countdown_padding'):
countdown_padding_seconds = lyrics_metadata.get('countdown_padding_seconds', 3.0)
job_log.info(f"Countdown padding detected: {countdown_padding_seconds}s - instrumental will be padded if needed")
# Log finalization parameters
job_log.info("Creating KaraokeFinalise with parameters:")
job_log.info(f" enable_cdg: {getattr(job, 'enable_cdg', False)}")
@@ -169,6 +177,7 @@ async def generate_video(job_id: str) -> bool:
job_log.info(f" brand_prefix: {getattr(job, 'brand_prefix', None)}")
job_log.info(f" discord_webhook: {'configured' if getattr(job, 'discord_webhook_url', None) else 'not configured'}")
job_log.info(f" instrumental source: {instrumental_source}")
job_log.info(f" countdown_padding_seconds: {countdown_padding_seconds}")
if existing_instrumental_path:
job_log.info(f" using user-provided instrumental (selection was: {instrumental_selection})")
@@ -209,6 +218,8 @@ async def generate_video(job_id: str) -> bool:
non_interactive=True,
server_side_mode=True,
selected_instrumental_file=instrumental_file,
# Audio synchronization - ensure instrumental matches vocal padding
countdown_padding_seconds=countdown_padding_seconds,
)
# Call process() - this does ALL the work:
@@ -324,6 +335,13 @@ async def _handle_native_distribution(
brand_code = result.get('brand_code')
base_name = f"{job.artist} - {job.title}"
# Check if we should preserve existing brand code (Batch 6: --keep-brand-code)
keep_brand_code = getattr(job, 'keep_brand_code', None)
if keep_brand_code:
brand_code = keep_brand_code
result['brand_code'] = brand_code
job_log.info(f"Using preserved brand code: {brand_code}")
# Upload to Dropbox using native SDK
dropbox_path = getattr(job, 'dropbox_path', None)
brand_prefix = getattr(job, 'brand_prefix', None)
+9 -8
View File
@@ -1,22 +1,23 @@
# Cloud Build configuration for base image
#
# This builds the base image with all Python dependencies pre-installed.
# Run this manually when poetry.lock changes:
# Run this manually when poetry.lock OR Dockerfile.base changes:
# gcloud builds submit --config=cloudbuild-base.yaml --project=nomadkaraoke
#
# The base image is used by the main Dockerfile for fast app builds.
# The poetry.lock hash is stored as a label for change detection.
# A combined hash of poetry.lock + Dockerfile.base is stored as a label for change detection.
steps:
# Calculate poetry.lock hash for change detection
# Calculate combined hash for change detection (poetry.lock + Dockerfile.base)
- name: 'gcr.io/cloud-builders/docker'
entrypoint: 'bash'
args:
- '-c'
- |
POETRY_LOCK_HASH=$$(sha256sum poetry.lock | cut -d' ' -f1)
echo "Poetry.lock hash: $$POETRY_LOCK_HASH"
echo "$$POETRY_LOCK_HASH" > /workspace/POETRY_LOCK_HASH
# Hash both files to detect changes in either
CONTENT_HASH=$$(cat poetry.lock backend/Dockerfile.base | sha256sum | cut -d' ' -f1)
echo "Combined content hash (poetry.lock + Dockerfile.base): $$CONTENT_HASH"
echo "$$CONTENT_HASH" > /workspace/CONTENT_HASH
# Build base image with all dependencies
- name: 'gcr.io/cloud-builders/docker'
@@ -24,11 +25,11 @@ steps:
args:
- '-c'
- |
POETRY_LOCK_HASH=$$(cat /workspace/POETRY_LOCK_HASH)
CONTENT_HASH=$$(cat /workspace/CONTENT_HASH)
docker build \
--build-arg BUILD_DATE=$BUILD_ID \
--build-arg BUILD_ID=$BUILD_ID \
--build-arg POETRY_LOCK_HASH=$$POETRY_LOCK_HASH \
--build-arg BASE_CONTENT_HASH=$$CONTENT_HASH \
-t us-central1-docker.pkg.dev/$PROJECT_ID/karaoke-repo/karaoke-backend-base:latest \
-t us-central1-docker.pkg.dev/$PROJECT_ID/karaoke-repo/karaoke-backend-base:$BUILD_ID \
-f backend/Dockerfile.base \
+5 -4
View File
@@ -54,6 +54,7 @@ steps:
- 'us-central1-docker.pkg.dev/$PROJECT_ID/karaoke-repo/karaoke-backend:latest'
# Deploy to Cloud Run with version from pyproject.toml
# Uses Cloud Tasks for worker coordination (scalable architecture)
- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
entrypoint: 'bash'
args:
@@ -71,11 +72,11 @@ steps:
--cpu-boost \
--execution-environment gen2 \
--timeout 1800 \
--concurrency 4 \
--max-instances 10 \
--concurrency 1 \
--max-instances 50 \
--min-instances 0 \
--set-env-vars "GOOGLE_CLOUD_PROJECT=$PROJECT_ID,GCS_BUCKET_NAME=karaoke-gen-storage-$PROJECT_ID,FIRESTORE_COLLECTION=jobs,ENVIRONMENT=production,AUDIO_SEPARATOR_API_URL=https://nomadkaraoke--audio-separator-api.modal.run,KARAOKE_GEN_VERSION=$$VERSION,DEFAULT_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-Organized,DEFAULT_GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX" \
--set-secrets "AUDIOSHAKE_API_TOKEN=audioshake-api-key:latest,GENIUS_API_TOKEN=genius-api-key:latest,SPOTIFY_COOKIE_SP_DC=spotify-cookie:latest,RAPIDAPI_KEY=rapidapi-key:latest,DEFAULT_DISCORD_WEBHOOK_URL=discord-releases-webhook:latest,ADMIN_TOKENS=admin-tokens:latest"
--set-env-vars "GOOGLE_CLOUD_PROJECT=$PROJECT_ID,GCS_BUCKET_NAME=karaoke-gen-storage-$PROJECT_ID,FIRESTORE_COLLECTION=jobs,ENVIRONMENT=production,AUDIO_SEPARATOR_API_URL=https://nomadkaraoke--audio-separator-api.modal.run,KARAOKE_GEN_VERSION=$$VERSION,DEFAULT_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-Organized,DEFAULT_GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX,ENABLE_CLOUD_TASKS=true,CLOUD_RUN_SERVICE_URL=https://api.nomadkaraoke.com,GCP_REGION=us-central1" \
--set-secrets "AUDIOSHAKE_API_TOKEN=audioshake-api-key:latest,GENIUS_API_TOKEN=genius-api-key:latest,SPOTIFY_COOKIE_SP_DC=spotify-cookie:latest,RAPIDAPI_KEY=rapidapi-key:latest,DEFAULT_DISCORD_WEBHOOK_URL=discord-releases-webhook:latest,ADMIN_TOKENS=admin-tokens:latest,REDACTED_API_KEY=redacted-api-key:latest,OPS_API_KEY=ops-api-key:latest,FLACFETCH_API_URL=flacfetch-api-url:latest,FLACFETCH_API_KEY=flacfetch-api-key:latest"
images:
- 'us-central1-docker.pkg.dev/$PROJECT_ID/karaoke-repo/karaoke-backend:latest'
+35
View File
@@ -0,0 +1,35 @@
# Codecov Configuration
# Docs: https://docs.codecov.com/docs/codecovyml-reference
coverage:
# Coverage value precision (2 decimal places)
precision: 2
round: down
# Green range starts at 70% (our target)
range: "70...100"
status:
# Project-level coverage status check
project:
default:
target: 70% # Pass if coverage >= 70%
threshold: 2% # Allow 2% drop without failing
if_ci_failed: error
# Patch coverage (new/changed lines only)
patch:
default:
target: 70% # New code should also meet 70%
threshold: 5% # More lenient for patches
# Disable PR comments entirely since we're satisfied with 70%+ coverage
# Status checks will still appear on the PR
comment: false
# Alternative: Uncomment below to only comment when coverage changes
# comment:
# layout: "diff, flags, files"
# behavior: default
# require_changes: true # Only comment if coverage actually changes
# require_base: true # Require base report to exist
@@ -1,7 +1,7 @@
# Backend Feature Parity Plan
**Last Updated:** 2024-12-11
**Status:** ✅ Core Feature Parity Achieved (v0.71.0) | Batch 1 ✅ | Batch 2 ✅ | Batch 3 ✅ | Batch 4 ✅
**Status:** ✅ Core Feature Parity Achieved (v0.71.0) | Batch 1 ✅ | Batch 2 ✅ | Batch 3 ✅ | Batch 4 ✅ | Batch 5 ✅
This document tracks the progress toward complete feature parity between the local `karaoke-gen` CLI and the cloud backend, enabling the `karaoke-gen-remote` CLI to have equivalent functionality.
@@ -15,14 +15,14 @@ This document tracks the progress toward complete feature parity between the loc
| Style Configuration | 1 | 4 | **25%** | S2-S4 are MEDIUM priority |
| Workflow Control | 0 | 3 | **0%** | W1/W2 HIGH, W7 MEDIUM (skip flags deferred) |
| Audio Processing | 4 | 4 | **100%** | ✅ **Batch 2 & 3 Complete** (AP1-AP3, AP5) |
| Input Modes | 2 | 3 | **67%** | ✅ **Batch 4 Complete** (P2), P3 remaining |
| Audio Fetching | 0 | 1 | **0%** | A1 is HIGH priority |
| Input Modes | 3 | 3 | **100%** | ✅ **Batch 4 & 5 Complete** (P2, P3) |
| Audio Fetching | 1 | 1 | **100%** | ✅ **Batch 5 Complete** (A1) |
| Flags to Remove | - | - | - | I3-I6, AP6 (simplify codebase) |
**Overall:** Core workflow complete. See [CLI Parameter Parity Analysis](#-cli-parameter-parity-analysis) for detailed parameter list with implementation plans.
**Priority Summary:**
- **HIGH**: L1-L4 (lyrics), AP1-AP5 (audio models/instrumental), P2-P3 (YouTube/flacfetch), A1 (interactive search), W1/W2 (prep/finalise phases), F15 (keep-brand-code)
- **HIGH**: L1-L4 ✅, AP1-AP5 ✅, P3 ✅, A1 ✅ | P2 (YouTube URLs), W1/W2 (prep/finalise phases), F15 (keep-brand-code)
- **MEDIUM**: S2-S4 (style overrides/video bg), W7 (edit-lyrics), F14 (email template)
- **LOW/DEFERRED**: W3-W6 (skip flags), D2-D3 (debugging)
- **REMOVE**: I3, I4, I5, I6, AP6 (unnecessary options)
@@ -80,12 +80,12 @@ This section provides a comprehensive comparison of all CLI parameters between `
|---|-----------|-------|--------|-------------|
| P1 | `<file>` | ✅ | ✅ | **Local audio file path.** Copies file to output directory, converts to WAV for processing. Supports MP3, FLAC, WAV, M4A, OGG, AAC. |
| P2 | `<url>` (YouTube) | ✅ | ✅ | **YouTube/online URL.** Uses yt-dlp to download audio and extract metadata (artist/title from video title). |
| P3 | `<artist> <title>` | ✅ | ❌ | **Audio search mode.** When no file is provided, uses flacfetch to search Deezer/Tidal/etc for high-quality audio and downloads it. |
| P3 | `<artist> <title>` | ✅ | ✅ | **Audio search mode.** When no file is provided, uses flacfetch to search Deezer/Tidal/etc for high-quality audio and downloads it. |
| P4 | `<folder>` | ✅ | ❌ | **Batch folder processing.** Process all audio files in a folder, using `--filename_pattern` to extract track titles from filenames. |
**Remote Implementation Status:** ✅ **BATCH 4 COMPLETE** (v0.71.26)
**Remote Implementation Status:** ✅ **BATCH 4 & 5 COMPLETE** (v0.71.42)
- **P2 YouTube URLs**: ✅ IMPLEMENTED. Backend accepts URL via `/api/jobs/create-from-url` endpoint. Uses yt-dlp to download audio and extract metadata (artist/title). Remote CLI detects URLs and routes to URL endpoint.
- **P3 Flacfetch search**: HIGH PRIORITY. Backend integrates flacfetch to search Deezer/Tidal/etc. IMPORTANT: Must support interactive mode via API - return search results to client, let user select, then proceed. Default should be interactive (not auto-select). Use case: Eventually expose audio source selection in web UI.
- **P3 Flacfetch search**: ✅ IMPLEMENTED. Remote CLI submits artist+title, backend searches via flacfetch. Returns results for interactive selection (or auto-selects with `-y`/`--auto-download`). New job statuses: `searching_audio`, `awaiting_audio_selection`, `downloading_audio`.
- **P4 Folder batch**: LOW PRIORITY. Could accept ZIP upload, process each as separate job. Defer for now.
---
@@ -149,12 +149,12 @@ This section provides a comprehensive comparison of all CLI parameters between `
| # | Parameter | Local | Remote | Description |
|---|-----------|-------|--------|-------------|
| A1 | `--auto-download` | ✅ | ❌ | **Auto-select audio source.** When using artist+title search mode (flacfetch), automatically select the best quality source instead of prompting for manual selection. Useful for scripted/batch processing. |
| A1 | `--auto-download` | ✅ | ✅ | **Auto-select audio source.** When using artist+title search mode (flacfetch), automatically select the best quality source instead of prompting for manual selection. Useful for scripted/batch processing. |
**Remote Implementation Plan:**
- **A1 `--auto-download`**: HIGH PRIORITY. Backend must support BOTH modes:
- **Interactive (default)**: API returns search results to client. Client displays options, user selects, client sends selection back to backend. Use case: Web UI will show audio source picker.
- **Auto-download (`--auto-download` or `-y`)**: Backend auto-selects best quality source. Use case: Automated/batch processing.
**Remote Implementation Status:** ✅ **BATCH 5 COMPLETE** (v0.71.28)
- **A1 `--auto-download`**: ✅ IMPLEMENTED. Backend supports BOTH modes:
- **Interactive (default)**: API returns search results to client. Client displays options, user selects via `/api/audio-search/{job_id}/select` endpoint.
- **Auto-download (`--auto-download` or `-y`)**: Backend auto-selects best quality source using flacfetch's ranking.
---
@@ -394,40 +394,54 @@ Bump the patch version in `pyproject.toml` before committing.
---
### Batch 5: Flacfetch Audio Search (HIGH)
### Batch 5: Flacfetch Audio Search (HIGH) ✅ COMPLETE
**Parameters:** P3 `<artist> <title>` (search mode), A1 `--auto-download`
**Scope:**
- Remote CLI: Detect artist+title without file, trigger search flow
- Backend: New endpoint to search for audio sources via flacfetch
- Backend: Return search results to client for interactive selection
- Remote CLI: Display results, let user select, send selection back
- Backend: Download selected audio, proceed with job
- Support `--auto-download` / `-y` to skip interactive selection
**Status:** ✅ **IMPLEMENTED** - PR #13 merged (v0.71.28)
**Files to modify:**
- `karaoke_gen/utils/remote_cli.py` - search flow, display results, selection
- `backend/api/routes/` - new search endpoint
- `backend/services/` - flacfetch integration service
- `backend/workers/` - download from selected source
**Implementation Summary:**
- Remote CLI: Detects artist+title without file, calls `/api/audio-search/search` endpoint
- Backend: New `AudioSearchService` integrates flacfetch for searching
- Backend: New job statuses `searching_audio`, `awaiting_audio_selection`, `downloading_audio`
- Backend: Returns search results for interactive selection, or auto-selects with `auto_download=true`
- Remote CLI: Displays results interactively, user selects, sends to `/api/audio-search/{job_id}/select`
- Backend: Downloads selected audio to GCS, proceeds with normal job flow
- Support `--auto-download` / `-y` for non-interactive auto-selection
**Files modified:**
- `karaoke_gen/utils/remote_cli.py` - search flow, display results, `search_audio()`, `select_audio_source()`, `handle_audio_selection()`
- `backend/api/routes/audio_search.py` - NEW: search and select endpoints
- `backend/services/audio_search_service.py` - NEW: flacfetch integration service
- `backend/models/job.py` - New statuses and fields (`audio_search_artist`, `audio_search_title`, `auto_download`)
- `backend/main.py` - Register audio_search router
**Tests added:** 20+ unit tests covering Job model fields, AudioSearchService, state transitions
**Complexity:** High (new interactive API flow, new service integration)
---
### Batch 6: Two-Phase Workflow (HIGH)
### Batch 6: Two-Phase Workflow (HIGH) ✅ COMPLETE
**Parameters:** W1 `--prep-only`, W2 `--finalise-only`, F15 `--keep-brand-code`
**Scope:**
- **prep-only:** Remote CLI submits with `prep_only=true`. Backend runs through review, then stops. CLI downloads all outputs and exits.
- **finalise-only:** Remote CLI checks local folder for prep outputs, uploads ALL files, sends `finalise_only=true`. Backend runs finalisation only.
- **keep-brand-code:** Remote CLI extracts brand code from local folder name, sends to backend to preserve.
**Status:** ✅ Complete (2025-12-11)
**Files to modify:**
- `karaoke_gen/utils/remote_cli.py` - prep-only flow, finalise-only upload flow, brand code extraction
- `backend/api/routes/file_upload.py` - accept prep_only, finalise_only flags
- `backend/api/routes/` - new endpoint for finalise-only upload (multiple files)
- `backend/workers/orchestrator.py` or job state machine - conditional worker execution
**Implementation Summary:**
- **prep-only:** Added `prep_only` field to Job model. When set, backend transitions to new `PREP_COMPLETE` status after review and video rendering (with_vocals.mkv). CLI downloads all prep outputs.
- **finalise-only:** Added new endpoint `/api/jobs/create-finalise-only` for uploading prep outputs. Remote CLI detects files in prep folder, uploads them via signed URLs, and monitors finalisation.
- **keep-brand-code:** Remote CLI extracts brand code from folder name (e.g., "NOMAD-1234 - Artist - Title"), sends to backend. Video worker uses preserved brand code for distribution.
**Files modified:**
- `backend/models/job.py` - Added `PREP_COMPLETE` status, `prep_only`, `finalise_only`, `keep_brand_code` fields, updated state transitions
- `backend/api/routes/file_upload.py` - Added `prep_only`, `keep_brand_code` to job creation, new finalise-only endpoints
- `backend/workers/render_video_worker.py` - Conditional transition to PREP_COMPLETE for prep-only jobs
- `backend/workers/video_worker.py` - Use preserved brand code when set
- `backend/services/job_manager.py` - Pass new fields through job creation
- `karaoke_gen/utils/remote_cli.py` - Full implementation of prep-only, finalise-only, and keep-brand-code flows
**Tests added:**
- `backend/tests/test_models.py` - Tests for new fields and PREP_COMPLETE status
- `backend/tests/test_file_upload.py` - Tests for finalise-only models and endpoints
**Complexity:** High (significant workflow changes, new upload flow)
@@ -516,14 +530,14 @@ Bump the patch version in `pyproject.toml` before committing.
| 2 | AP1-AP3 (model selection) | HIGH | Low | ✅ **COMPLETE** (PR #9) |
| 3 | AP5 (existing instrumental) | HIGH | Medium | ✅ **COMPLETE** (PR #10) |
| 4 | P2 (YouTube URLs) | HIGH | Medium-High | ✅ **COMPLETE** |
| 5 | P3, A1 (flacfetch search) | HIGH | High | ⏳ Pending |
| 5 | P3, A1 (flacfetch search) | HIGH | High | ✅ **COMPLETE** (PR #13) |
| 6 | W1, W2, F15 (two-phase) | HIGH | High | ⏳ Pending |
| 7 | S2 (style overrides) | MEDIUM | Medium | ⏳ Pending |
| 8 | S3, S4 (video background) | MEDIUM | Medium | ⏳ Pending |
| 9 | W7 (edit-lyrics) | MEDIUM | Medium-High | ⏳ Pending |
| 10 | F14, D2, D3, removals | LOW | Mixed | ⏳ Pending |
**Recommended Order:** ~~1~~ → ~~2~~ → ~~3~~ → ~~4~~ → 5 → 6 → 7 → 8 → 9 → 10
**Recommended Order:** ~~1~~ → ~~2~~ → ~~3~~ → ~~4~~ → ~~5~~ → 6 → 7 → 8 → 9 → 10
Batches 1-4 are quick wins that add significant value. Batches 5-6 are larger but high priority. Batches 7-10 can be done as time permits.
@@ -632,6 +646,7 @@ The karaoke-gen system supports multiple interfaces to the same core functionali
| Feature | Version | PR | Notes |
|---------|---------|-----|-------|
| Flacfetch audio search | v0.71.42 | #13 | `artist title` (search mode), `--auto-download` - search and download audio by artist+title |
| YouTube URL input | v0.71.26 | - | `<url>` positional argument for YouTube/online URLs |
| Existing instrumental | v0.71.26 | #10 | `--existing_instrumental` - upload and use user-provided instrumental |
| Audio model selection | v0.71.24 | #9 | `--clean_instrumental_model`, `--backing_vocals_models`, `--other_stems_models` |
@@ -645,7 +660,6 @@ The karaoke-gen system supports multiple interfaces to the same core functionali
| Skip separation/transcription | MEDIUM | Workflow control for re-processing |
| Edit lyrics mode | MEDIUM | `--edit-lyrics` for fixing existing tracks |
| Background video | MEDIUM | `--background_video` requires video upload |
| Audio search (flacfetch) | HIGH | Artist+title search, auto-download |
| Two-phase workflow | HIGH | `--prep-only`, `--finalise-only` |
| Batch folder processing | LOW | Process multiple files at once |
| Gmail draft creation | LOW | Nice-to-have, not blocking |
@@ -667,6 +681,8 @@ The karaoke-gen system supports multiple interfaces to the same core functionali
| `dropbox-oauth-credentials` | ✅ | Dropbox API OAuth tokens |
| `gdrive-service-account` | ✅ | Google Drive service account |
| `discord-webhook-url` | ✅ | Default Discord webhook |
| `redacted-api-key` | ⏳ | Redacted tracker API key (flacfetch audio search) |
| `ops-api-key` | ⏳ | OPS/Orpheus tracker API key (flacfetch audio search) |
### Default Distribution Settings
@@ -812,6 +828,19 @@ DEFAULT_DISCORD_WEBHOOK_URL=https://discord.com/...
## Recent Changes Log
### 2024-12-11: v0.71.28 - Batch 5 Complete (Flacfetch Audio Search)
**PR #13: Flacfetch Audio Search for Remote CLI**
- ✅ `artist title` (search mode) - Search for audio by artist and title without providing a file
- ✅ `--auto-download` - Auto-select best audio source (skip interactive selection)
- New job statuses: `searching_audio`, `awaiting_audio_selection`, `downloading_audio`
- New API endpoints: `POST /api/audio-search/search`, `GET /api/audio-search/{job_id}/results`, `POST /api/audio-search/{job_id}/select`
- Interactive mode: Returns search results for user selection
- Auto mode: Uses flacfetch's quality ranking to auto-select best source
- Added 20+ unit tests for new functionality
- Files: `remote_cli.py`, `audio_search.py` (new route), `audio_search_service.py` (new service), `job.py`
### 2024-12-11: v0.71.26 - Batch 3 Complete (Existing Instrumental Support)
**PR #10: Existing Instrumental Support for Remote CLI**
@@ -907,12 +936,13 @@ DEFAULT_DISCORD_WEBHOOK_URL=https://discord.com/...
- Requires: yt-dlp in container
- Enables: Processing niche live versions only on YouTube
5. ✅ **Flacfetch Audio Search** (Batch 5 - COMPLETE)
- Interactive audio source selection via API
- v0.71.28
### Medium-Term: Workflow Features
1. **Flacfetch Audio Search** (Batch 5)
- Interactive audio source selection via API
2. **Two-Phase Workflow** (Batch 6)
1. **Two-Phase Workflow** (Batch 6) ✅ COMPLETE
- `--prep-only` and `--finalise-only` modes
3. **Style Override** (Batch 7)
@@ -0,0 +1,141 @@
# Refactor: Unify Audio Fetcher Code
**Created:** 2025-12-20
**Completed:** 2025-12-20
**Priority:** MEDIUM (prevents future bugs like YouTubeProvider -> YoutubeProvider)
**Status:** ✅ Completed
## Problem
The codebase has **two separate implementations** of flacfetch integration:
1. `karaoke_gen/audio_fetcher.py` - Used by local CLI
2. `backend/services/audio_search_service.py` - Used by cloud backend
This violates DRY and caused a bug where the backend's import wasn't updated when flacfetch renamed `YouTubeProvider` to `YoutubeProvider`.
## Current State
### Duplicated Code
| Component | Local (`audio_fetcher.py`) | Backend (`audio_search_service.py`) |
|-----------|---------------------------|-------------------------------------|
| `_get_manager()` | ✅ 40 lines | ❌ 35 lines (copy) |
| Provider setup | ✅ Redacted, OPS, YouTube | ❌ Same, diverged |
| `search()` | ✅ Full implementation | ❌ Similar, diverged |
| `download()` | ✅ With downloaders | ⚠️ Different, simpler |
| `AudioSearchResult` | ✅ Dataclass | ❌ Duplicate, different fields |
| `AudioDownloadResult` | ✅ (`AudioFetchResult`) | ❌ Duplicate |
| Exceptions | ✅ 4 types | ❌ 3 types, different names |
### Drift Examples
- Backend missing `raw_result` field on `AudioSearchResult`
- Backend has `index` field, local doesn't
- Backend exceptions inherit from `AudioSearchError`, local from `AudioFetcherError`
- Backend missing `UserCancelledError`
- Backend missing downloader registration (TorrentDownloader, YoutubeDownloader)
## Proposed Solution
### Option 1: Backend imports from karaoke_gen (Recommended)
The backend already depends on `karaoke_gen` (installed via `pip install -e .` in Dockerfile).
```python
# backend/services/audio_search_service.py - REFACTORED
from karaoke_gen.audio_fetcher import (
FlacFetcher,
AudioSearchResult,
AudioFetchResult,
AudioFetcherError,
NoResultsError,
DownloadError,
)
class AudioSearchService:
"""
Thin wrapper around karaoke_gen.audio_fetcher.FlacFetcher.
Adds backend-specific functionality:
- Firestore serialization (to_dict/from_dict)
- GCS integration for downloads
- Job state management
"""
def __init__(
self,
redacted_api_key: Optional[str] = None,
ops_api_key: Optional[str] = None,
):
self._fetcher = FlacFetcher(
redacted_api_key=redacted_api_key,
ops_api_key=ops_api_key,
)
def search(self, artist: str, title: str) -> List[AudioSearchResult]:
"""Delegate to FlacFetcher.search()."""
return self._fetcher.search(artist, title)
def select_best(self, results: List[AudioSearchResult]) -> int:
"""Delegate to FlacFetcher.select_best()."""
return self._fetcher.select_best(results)
def download(
self,
result: AudioSearchResult,
output_dir: str,
output_filename: Optional[str] = None,
) -> AudioFetchResult:
"""Delegate to FlacFetcher.download()."""
return self._fetcher.download(result, output_dir, output_filename)
```
### Changes Required to karaoke_gen.audio_fetcher
1. **Add `to_dict()` method to `AudioSearchResult`** - For Firestore serialization
2. **Add `from_dict()` classmethod** - For deserialization
3. **Ensure `select_best()` is a standalone method** - Currently buried in interactive flow
4. **Export all public classes from `__init__.py`**
### Changes Required to backend
1. **Remove duplicate dataclasses** - Use imports from karaoke_gen
2. **Remove duplicate `_get_manager()`** - Delegate to FlacFetcher
3. **Remove duplicate exception classes** - Use karaoke_gen exceptions
4. **Update tests** - Point to real classes, not mocks
## Benefits
1. **Single source of truth** - Bug fixes apply everywhere
2. **No more drift** - Dataclasses, exceptions stay in sync
3. **Better test coverage** - karaoke_gen has integration tests for flacfetch imports
4. **Less code to maintain** - Backend becomes thin wrapper
## Migration Steps
1. [x] Add `to_dict()` / `from_dict()` to `AudioSearchResult` in karaoke_gen
2. [x] Extract `select_best()` as standalone method in FlacFetcher
3. [x] Update karaoke_gen `__init__.py` exports (with lazy imports)
4. [x] Refactor backend to import from karaoke_gen
5. [x] Update backend tests
6. [x] Delete duplicate code from backend (~150 lines removed)
7. [x] Add integration test that catches import divergence
## Related Files
- `karaoke_gen/audio_fetcher.py` - Source of truth (keep)
- `backend/services/audio_search_service.py` - Refactor to thin wrapper
- `backend/api/routes/audio_search.py` - Update imports
- `backend/tests/test_audio_search.py` - Update tests
## Estimated Effort
- **Time:** 2-4 hours
- **Risk:** Low (well-defined changes, good test coverage)
- **Dependencies:** None
## Related Architecture Docs
- `docs/01-reference/ARCHITECTURE.md` - "LyricsTranscriber Integration" section shows similar pattern
- `docs/00-current-plan/SCALABLE-ARCHITECTURE-PLAN.md` - "Shared pipeline architecture" goal
@@ -1,7 +1,7 @@
# Scalable Architecture Plan
**Last Updated:** 2025-12-11
**Status:** Analysis Complete - Ready for Implementation
**Status:** Phase 1 Complete - Cloud Tasks Enabled
This document outlines the plan for evolving karaoke-gen's cloud backend to support **100+ concurrent jobs** with no performance degradation, while also achieving a clean, maintainable codebase with proper separation of concerns.
@@ -756,7 +756,11 @@ wait
## Success Criteria
### Phase 1 (Cloud Tasks)
- [ ] 50 concurrent jobs complete without failures
- [x] Cloud Tasks queues created and configured via Pulumi
- [x] WorkerService updated to support Cloud Tasks mode
- [x] Deployment configured with ENABLE_CLOUD_TASKS=true
- [x] Container concurrency set to 1 for true isolation
- [ ] 50 concurrent jobs complete without failures (to be validated)
- [ ] Processing time per job unchanged (same as 1 job)
- [ ] No resource contention (CPU/memory per job consistent)
- [ ] Automatic retry on transient failures works
@@ -0,0 +1,729 @@
# Flacfetch HTTP API Service Implementation Plan
**Created:** 2025-12-20
**Updated:** 2025-12-20
**Status:** In Progress
**Priority:** Medium
**Estimated Effort:** 3-4 days
## Problem Statement
BitTorrent downloads don't work reliably in Cloud Run due to:
- No inbound peer connections (NAT/firewall)
- Ephemeral containers with no stable IP
- DHT peer discovery blocked
- Container timeout limits (max 60 min)
This prevents downloading lossless audio from private trackers (Redacted, OPS) via the remote backend.
## Solution Overview
Add an HTTP API mode to **flacfetch** (our audio fetching library) and deploy it on a dedicated GCP VM with:
- Full BitTorrent peer connectivity via Transmission daemon
- Static IP for tracker whitelist (seedbox-like)
- Indefinite seeding of downloaded torrents
- Automatic disk cleanup when space runs low
- YouTube downloads also handled (single service for all audio acquisition)
This approach provides clean separation of concerns:
- **flacfetch**: Handles ALL audio acquisition (torrents + YouTube)
- **karaoke-gen backend**: Orchestrates karaoke generation pipeline, calls flacfetch API
```
┌─────────────────────────────────────────────────────────────────────────────┐
│ FLACFETCH SERVICE ARCHITECTURE │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ Cloud Run Backend Flacfetch VM (e2-small) │
│ ┌────────────────────┐ ┌─────────────────────────┐ │
│ │ │ │ │ │
│ │ karaoke-gen │ 1. Search │ flacfetch HTTP API │ │
│ │ AudioSearchService │ ────────────▶ │ POST /search │ │
│ │ │ │ │ │
│ │ │ 2. Results │ Providers: │ │
│ │ │ ◀──────────── │ • Redacted (FLAC) │ │
│ │ │ │ • OPS (FLAC) │ │
│ │ │ 3. Download │ • YouTube (fallback) │ │
│ │ │ ────────────▶ │ │ │
│ │ │ │ POST /download │ │
│ │ │ 4. Status │ GET /download/{id} │ │
│ │ │ ◀──────────── │ │ │
│ │ │ (polling) │ Transmission Daemon │ │
│ │ │ │ • Full peer connect │ │
│ │ │ 5. Complete │ • DHT enabled │ │
│ │ │ ◀──────────── │ • Indefinite seeding │ │
│ │ │ (file path) │ │ │
│ └────────────────────┘ └───────────┬─────────────┘ │
│ │ │ │
│ │ │ 6. Upload to GCS │
│ │ │ │
│ ▼ ▼ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ Google Cloud Storage │ │
│ │ │ │
│ │ uploads/{job_id}/audio/{filename}.flac │ │
│ │ │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────────┘
```
## Key Design Decisions
### 1. HTTP API in flacfetch (not separate service)
- **Why**: Clean separation of concerns, reusable by future projects, single source of truth
- **How**: Add `flacfetch/api/` module with FastAPI, new CLI mode `flacfetch serve`
### 2. Indefinite Seeding
- **Why**: VM is always-on anyway, helps maintain tracker ratio, acts like a seedbox
- **Current behavior**: Torrent removed after download (line 317-321 in torrent.py)
- **New behavior**: Torrent kept seeding, only removed by cleanup or explicit delete
### 3. Static IP
- **Why**: Required for tracker account IP whitelist, consistent for firewall rules
- **Cost**: ~$3/month additional
### 4. Disk Space Management
- **Strategy**: Auto-cleanup oldest torrents when free space < 5GB threshold
- **API**: Manual cleanup endpoints + automatic background cleanup
### 5. Instance Type: e2-small
- **Specs**: 0.5 vCPU, 2GB RAM, ~$12/month
- **Why**: Sufficient for I/O-bound workload, newer C3/N4 require 2+ vCPUs (overkill)
- **Disk**: 30GB SSD (20GB for torrents + headroom)
### 6. Authentication
- **Method**: Static API key in `X-API-Key` header
- **Firewall**: Permissive (allows future web UI), auth enforced at app level
## Implementation Phases
### Phase 1: Add HTTP API to flacfetch
**Location:** `./flacfetch/flacfetch/api/`
**New Directory Structure:**
```
flacfetch/
├── flacfetch/
│ ├── api/ # NEW
│ │ ├── __init__.py
│ │ ├── main.py # FastAPI app entry point
│ │ ├── auth.py # API key authentication
│ │ ├── models.py # Pydantic request/response models
│ │ ├── routes/
│ │ │ ├── __init__.py
│ │ │ ├── search.py # POST /search
│ │ │ ├── download.py # POST /download, GET /download/{id}/status
│ │ │ ├── torrents.py # GET /torrents, DELETE /torrents/{id}
│ │ │ └── health.py # GET /health, GET /disk-usage
│ │ └── services/
│ │ ├── __init__.py
│ │ ├── download_manager.py # Track active downloads
│ │ └── disk_manager.py # Disk cleanup logic
│ ├── core/
│ ├── downloaders/
│ │ └── torrent.py # MODIFIED: optional keep-seeding mode
│ ├── interface/
│ │ └── cli.py # MODIFIED: add 'serve' subcommand
│ └── providers/
└── pyproject.toml # MODIFIED: add fastapi, uvicorn deps
```
**API Endpoints:**
```yaml
# All endpoints require X-API-Key header
# Search for audio
POST /search
Request:
{ "artist": "ABBA", "title": "Waterloo" }
Response:
{
"search_id": "abc123",
"results": [
{
"index": 0,
"title": "Waterloo",
"artist": "ABBA",
"provider": "Redacted",
"quality": "FLAC 16bit CD",
"seeders": 45,
"size_bytes": 31457280,
"target_file": "02. Waterloo.flac",
...
},
...
]
}
# Start download
POST /download
Request:
{
"search_id": "abc123", # From previous search
"result_index": 0, # Which result to download
"output_filename": "ABBA - Waterloo", # Optional
"upload_to_gcs": true, # Upload to GCS when complete
"gcs_path": "uploads/job123/audio/" # Required if upload_to_gcs
}
Response:
{
"download_id": "dl_xyz789",
"status": "queued"
}
# Check download status
GET /download/{download_id}/status
Response:
{
"download_id": "dl_xyz789",
"status": "downloading", # queued, downloading, uploading, seeding, complete, failed
"progress": 45.2,
"peers": 3,
"download_speed_kbps": 1250.5,
"eta_seconds": 120,
"provider": "Redacted",
"title": "ABBA - Waterloo",
"output_path": null, # Set when complete (local path)
"gcs_path": null, # Set when uploaded to GCS
"error": null
}
# List all torrents (for management)
GET /torrents
Response:
{
"torrents": [
{
"id": 1,
"name": "ABBA - Waterloo [FLAC]",
"status": "seeding",
"progress": 100.0,
"size_bytes": 314572800,
"uploaded_bytes": 628145600, # Seeding stats
"ratio": 2.0,
"added_at": "2025-12-20T10:30:00Z"
},
...
],
"total_size_bytes": 5368709120,
"count": 15
}
# Delete a torrent (manual cleanup)
DELETE /torrents/{torrent_id}
Query params: ?delete_data=true # Also delete downloaded files
Response:
{ "status": "deleted" }
# Trigger cleanup (free disk space)
POST /torrents/cleanup
Request:
{
"strategy": "oldest", # oldest, largest, lowest_ratio
"target_free_gb": 10 # Keep removing until this much free
}
Response:
{
"removed_count": 3,
"freed_bytes": 1073741824,
"free_space_gb": 10.5
}
# Health check
GET /health
Response:
{
"status": "healthy",
"transmission": {
"available": true,
"version": "4.0.5",
"active_torrents": 5
},
"disk": {
"total_gb": 30,
"used_gb": 18,
"free_gb": 12
},
"providers": {
"redacted": true,
"ops": true,
"youtube": true
}
}
```
**Torrent Downloader Changes:**
```python
# flacfetch/downloaders/torrent.py
class TorrentDownloader(Downloader):
def __init__(self, ..., keep_seeding: bool = False):
"""
Args:
keep_seeding: If True, don't remove torrent after download.
Used in server mode for indefinite seeding.
"""
self.keep_seeding = keep_seeding
def download(self, release, output_path, output_filename=None):
# ... existing download logic ...
# After download complete:
if self.keep_seeding:
# Don't remove, just return the file path
logger.info(f"Download complete, keeping torrent for seeding: {torrent.name}")
else:
# Original behavior: stop and remove
self.client.stop_torrent(torrent.id)
self.client.remove_torrent(torrent.id, delete_data=True)
```
**CLI Changes:**
```bash
# New serve subcommand
flacfetch serve --port 8080 --host 0.0.0.0
# Or via environment
FLACFETCH_API_PORT=8080 flacfetch serve
```
### Phase 2: Infrastructure (Pulumi)
**Location:** `./infrastructure/__main__.py`
**New Resources:**
```python
# Static IP for flacfetch service (for tracker whitelist)
flacfetch_ip = gcp.compute.Address(
"flacfetch-ip",
name="flacfetch-static-ip",
region="us-central1",
)
# Service account for flacfetch VM
flacfetch_sa = gcp.serviceaccount.Account(
"flacfetch-sa",
account_id="flacfetch-service",
display_name="Flacfetch Service Account",
)
# GCS write permissions for flacfetch
gcp.storage.BucketIAMMember(
"flacfetch-gcs-writer",
bucket=bucket.name,
role="roles/storage.objectCreator",
member=pulumi.Output.concat("serviceAccount:", flacfetch_sa.email),
)
# Flacfetch VM
flacfetch_vm = gcp.compute.Instance(
"flacfetch-service",
machine_type="e2-small",
zone="us-central1-a",
boot_disk=gcp.compute.InstanceBootDiskArgs(
initialize_params=gcp.compute.InstanceBootDiskInitializeParamsArgs(
image="debian-cloud/debian-12",
size=30, # GB
type="pd-ssd",
),
),
network_interfaces=[gcp.compute.InstanceNetworkInterfaceArgs(
network="default",
access_configs=[gcp.compute.InstanceNetworkInterfaceAccessConfigArgs(
nat_ip=flacfetch_ip.address, # Static IP
)],
)],
service_account=gcp.compute.InstanceServiceAccountArgs(
email=flacfetch_sa.email,
scopes=["cloud-platform"],
),
metadata_startup_script=FLACFETCH_STARTUP_SCRIPT,
tags=["flacfetch-service"],
)
# Firewall for flacfetch
flacfetch_firewall = gcp.compute.Firewall(
"flacfetch-firewall",
network="default",
allows=[
# BitTorrent peer connections
gcp.compute.FirewallAllowArgs(protocol="tcp", ports=["51413"]),
gcp.compute.FirewallAllowArgs(protocol="udp", ports=["51413"]),
# Flacfetch HTTP API (auth required at app level)
gcp.compute.FirewallAllowArgs(protocol="tcp", ports=["8080"]),
],
source_ranges=["0.0.0.0/0"], # Permissive, auth at app level
target_tags=["flacfetch-service"],
)
# Store API key in Secret Manager
flacfetch_api_key = gcp.secretmanager.Secret(
"flacfetch-api-key",
secret_id="flacfetch-api-key",
replication=gcp.secretmanager.SecretReplicationArgs(
auto=gcp.secretmanager.SecretReplicationAutoArgs(),
),
)
# Export for use
pulumi.export("flacfetch_static_ip", flacfetch_ip.address)
pulumi.export("flacfetch_service_url", pulumi.Output.concat("http://", flacfetch_ip.address, ":8080"))
```
**Startup Script:**
```bash
#!/bin/bash
set -e
# Install dependencies
apt-get update
apt-get install -y python3-pip python3-venv transmission-daemon ffmpeg git
# Configure Transmission
systemctl stop transmission-daemon
cat > /etc/transmission-daemon/settings.json << 'EOF'
{
"download-dir": "/var/lib/transmission-daemon/downloads",
"incomplete-dir": "/var/lib/transmission-daemon/.incomplete",
"incomplete-dir-enabled": true,
"rpc-authentication-required": false,
"rpc-bind-address": "127.0.0.1",
"rpc-enabled": true,
"rpc-port": 9091,
"rpc-whitelist-enabled": false,
"peer-port": 51413,
"port-forwarding-enabled": false,
"speed-limit-down": 0,
"speed-limit-down-enabled": false,
"speed-limit-up": 0,
"speed-limit-up-enabled": false,
"ratio-limit-enabled": false,
"umask": 2
}
EOF
systemctl start transmission-daemon
# Install flacfetch
cd /opt
git clone https://github.com/nomadkaraoke/flacfetch.git
cd flacfetch
python3 -m venv venv
source venv/bin/activate
pip install -e ".[api]"
# Get secrets from metadata/Secret Manager
FLACFETCH_API_KEY=$(gcloud secrets versions access latest --secret=flacfetch-api-key)
REDACTED_API_KEY=$(gcloud secrets versions access latest --secret=redacted-api-key)
OPS_API_KEY=$(gcloud secrets versions access latest --secret=ops-api-key)
GCS_BUCKET=$(curl -s "http://metadata.google.internal/computeMetadata/v1/instance/attributes/gcs-bucket" -H "Metadata-Flavor: Google")
# Create systemd service
cat > /etc/systemd/system/flacfetch.service << EOF
[Unit]
Description=Flacfetch HTTP API Service
After=network.target transmission-daemon.service
[Service]
Type=simple
User=root
WorkingDirectory=/opt/flacfetch
Environment="FLACFETCH_API_KEY=${FLACFETCH_API_KEY}"
Environment="REDACTED_API_KEY=${REDACTED_API_KEY}"
Environment="OPS_API_KEY=${OPS_API_KEY}"
Environment="GCS_BUCKET=${GCS_BUCKET}"
Environment="FLACFETCH_KEEP_SEEDING=true"
Environment="FLACFETCH_MIN_FREE_GB=5"
ExecStart=/opt/flacfetch/venv/bin/flacfetch serve --host 0.0.0.0 --port 8080
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
EOF
systemctl daemon-reload
systemctl enable flacfetch
systemctl start flacfetch
```
### Phase 3: Backend Integration
**New File:** `backend/services/flacfetch_client.py`
```python
"""
Client for the remote flacfetch HTTP API service.
Used when FLACFETCH_API_URL is configured, otherwise falls back to local flacfetch.
"""
import asyncio
import logging
from typing import Optional, List, Dict, Any
import httpx
logger = logging.getLogger(__name__)
class FlacfetchServiceError(Exception):
"""Error communicating with flacfetch service."""
pass
class FlacfetchClient:
"""Client for remote flacfetch HTTP API."""
def __init__(self, base_url: str, api_key: str, timeout: int = 30):
self.base_url = base_url.rstrip('/')
self.api_key = api_key
self.timeout = timeout
def _headers(self) -> Dict[str, str]:
return {"X-API-Key": self.api_key}
async def health_check(self) -> Dict[str, Any]:
"""Check if service is healthy."""
async with httpx.AsyncClient() as client:
resp = await client.get(
f"{self.base_url}/health",
headers=self._headers(),
timeout=10,
)
resp.raise_for_status()
return resp.json()
async def search(self, artist: str, title: str) -> Dict[str, Any]:
"""Search for audio."""
async with httpx.AsyncClient() as client:
resp = await client.post(
f"{self.base_url}/search",
headers=self._headers(),
json={"artist": artist, "title": title},
timeout=self.timeout,
)
resp.raise_for_status()
return resp.json()
async def download(
self,
search_id: str,
result_index: int,
output_filename: Optional[str] = None,
gcs_path: Optional[str] = None,
) -> str:
"""
Start download and return download_id.
If gcs_path is provided, file will be uploaded to GCS.
"""
async with httpx.AsyncClient() as client:
payload = {
"search_id": search_id,
"result_index": result_index,
}
if output_filename:
payload["output_filename"] = output_filename
if gcs_path:
payload["upload_to_gcs"] = True
payload["gcs_path"] = gcs_path
resp = await client.post(
f"{self.base_url}/download",
headers=self._headers(),
json=payload,
timeout=self.timeout,
)
resp.raise_for_status()
return resp.json()["download_id"]
async def get_download_status(self, download_id: str) -> Dict[str, Any]:
"""Get download status."""
async with httpx.AsyncClient() as client:
resp = await client.get(
f"{self.base_url}/download/{download_id}/status",
headers=self._headers(),
timeout=10,
)
resp.raise_for_status()
return resp.json()
async def wait_for_download(
self,
download_id: str,
timeout: int = 600,
poll_interval: int = 2,
) -> Dict[str, Any]:
"""
Wait for download to complete.
Returns final status dict with output_path or gcs_path.
Raises FlacfetchServiceError on failure or timeout.
"""
elapsed = 0
while elapsed < timeout:
status = await self.get_download_status(download_id)
if status["status"] == "complete":
return status
elif status["status"] == "failed":
raise FlacfetchServiceError(f"Download failed: {status.get('error')}")
await asyncio.sleep(poll_interval)
elapsed += poll_interval
raise FlacfetchServiceError(f"Download timed out after {timeout}s")
# Singleton
_client: Optional[FlacfetchClient] = None
def get_flacfetch_client() -> Optional[FlacfetchClient]:
"""Get flacfetch client if configured."""
global _client
if _client is None:
from backend.config import get_settings
settings = get_settings()
if settings.flacfetch_api_url and settings.flacfetch_api_key:
_client = FlacfetchClient(
base_url=settings.flacfetch_api_url,
api_key=settings.flacfetch_api_key,
)
return _client
```
**Modify:** `backend/services/audio_search_service.py` to use remote client when available.
**Modify:** `backend/config.py` to add new settings:
```python
flacfetch_api_url: Optional[str] = None # e.g., http://10.0.0.5:8080
flacfetch_api_key: Optional[str] = None
```
### Phase 4: Monitoring & Reliability
**Tasks:**
- [ ] Add Cloud Monitoring alert for VM CPU/memory
- [ ] Add alert for disk space < 5GB
- [ ] Add alert for flacfetch service down (health check fails)
- [ ] Configure Cloud Logging export from VM
- [ ] Add Grafana dashboard (optional)
**Automatic Disk Cleanup:**
The disk manager runs as a background task in the flacfetch API service:
```python
# Check every 5 minutes, cleanup if free space < threshold
async def background_cleanup_task():
while True:
await asyncio.sleep(300)
free_gb = get_free_space_gb()
if free_gb < MIN_FREE_GB:
cleanup_oldest_torrents(target_free_gb=MIN_FREE_GB + 5)
```
### Phase 5: Testing & Documentation
**Testing:**
- [ ] Unit tests for flacfetch API endpoints
- [ ] Unit tests for disk manager
- [ ] Integration test: search → download → GCS upload
- [ ] Mock tests for karaoke-gen backend client
**Documentation:**
- [ ] Update `docs/01-reference/ARCHITECTURE.md` with flacfetch service
- [ ] Add `flacfetch/README.md` HTTP API section
- [ ] Document deployment process
- [ ] Document environment variables
## Environment Variables
### Flacfetch Service (VM)
```bash
# API Configuration
FLACFETCH_API_KEY=<secret> # Required for API auth
FLACFETCH_API_PORT=8080 # Default: 8080
FLACFETCH_API_HOST=0.0.0.0 # Default: 0.0.0.0
# Tracker API Keys
REDACTED_API_KEY=<key> # For Redacted provider
OPS_API_KEY=<key> # For OPS provider
# GCS Upload (optional)
GCS_BUCKET=karaoke-uploads # For uploading completed downloads
GOOGLE_CLOUD_PROJECT=nomadkaraoke
# Transmission
TRANSMISSION_HOST=localhost # Default: localhost
TRANSMISSION_PORT=9091 # Default: 9091
# Behavior
FLACFETCH_KEEP_SEEDING=true # Keep torrents seeding after download
FLACFETCH_MIN_FREE_GB=5 # Minimum free disk space before cleanup
FLACFETCH_DOWNLOAD_DIR=/var/lib/transmission-daemon/downloads
```
### Cloud Run Backend
```bash
# New variables
FLACFETCH_API_URL=http://10.128.0.5:8080 # Internal IP of flacfetch VM
FLACFETCH_API_KEY=<same-secret>
```
## Security Considerations
1. **API Authentication**: Static API key in `X-API-Key` header
2. **Firewall**: Permissive for future web UI, auth enforced at application level
3. **GCS**: Service account with `storage.objectCreator` role only
4. **Transmission**: RPC bound to localhost only, no external access
5. **Static IP**: Can be whitelisted on tracker accounts
## Rollback Plan
If flacfetch service fails:
1. Set `FLACFETCH_API_URL=""` in Cloud Run (disables remote service)
2. Backend falls back to local flacfetch (YouTube only in Cloud Run)
3. Users see warning that lossless downloads may be slower/unavailable
## Cost Estimate
| Resource | Monthly Cost |
|----------|--------------|
| e2-small VM | ~$12 |
| Static IP | ~$3 |
| 30GB SSD | ~$5 |
| Network egress | ~$2-5 |
| **Total** | **~$22-25/month** |
## Success Criteria
- [ ] Flacfetch HTTP API accepts search requests and returns results
- [ ] Downloads complete successfully for Redacted/OPS sources
- [ ] Downloaded files upload to GCS automatically
- [ ] Torrents continue seeding after download
- [ ] Disk cleanup triggers automatically when space is low
- [ ] Remote CLI shows download progress from flacfetch service
- [ ] Fallback to local flacfetch works when service unavailable
- [ ] Static IP can be whitelisted on tracker accounts
## Timeline
| Phase | Duration | Dependencies |
|-------|----------|--------------|
| Phase 1: Flacfetch HTTP API | 1.5 days | None |
| Phase 2: Infrastructure | 0.5 day | Phase 1 |
| Phase 3: Backend Integration | 0.5 day | Phase 1, 2 |
| Phase 4: Monitoring | 0.5 day | Phase 2 |
| Phase 5: Testing & Docs | 0.5 day | Phase 1-3 |
| **Total** | **3.5 days** | |
## References
- [Transmission RPC Spec](https://github.com/transmission/transmission/blob/main/docs/rpc-spec.md)
- [transmission-rpc Python library](https://github.com/Trim21/transmission-rpc)
- [FastAPI Documentation](https://fastapi.tiangolo.com/)
- [flacfetch source code](./flacfetch/)
Submodule
+1
Submodule flacfetch added at 35ae8994b8.
@@ -0,0 +1,603 @@
"use client"
import { useParams, useRouter } from "next/navigation"
import { useState, useEffect, useCallback } from "react"
import { AppHeader } from "@/components/app-header"
import { ProtectedRoute } from "@/components/protected-route"
import { Button } from "@/components/ui/button"
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card"
import { Alert, AlertDescription } from "@/components/ui/alert"
import { Badge } from "@/components/ui/badge"
import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group"
import { Label } from "@/components/ui/label"
import { Skeleton } from "@/components/ui/skeleton"
import {
WaveformDisplay,
AudioPlayer,
RegionSelector,
} from "@/components/instrumental-review"
import {
ArrowLeft,
AlertCircle,
CheckCircle2,
Loader2,
Music,
VolumeX,
Volume2,
} from "lucide-react"
interface AudibleSegment {
start_seconds: number
end_seconds: number
duration_seconds: number
avg_amplitude_db: number
peak_amplitude_db?: number
}
interface MuteRegion {
start_seconds: number
end_seconds: number
}
interface AnalysisData {
has_audible_content: boolean
total_duration_seconds: number
audible_segments: AudibleSegment[]
recommended_selection: string
total_audible_duration_seconds: number
audible_percentage: number
silence_threshold_db: number
}
interface InstrumentalAnalysisResponse {
job_id: string
artist: string
title: string
status: string
analysis: AnalysisData
audio_urls: {
clean_instrumental: string | null
backing_vocals: string | null
with_backing: string | null
custom_instrumental: string | null
}
waveform_url: string | null
has_custom_instrumental: boolean
}
// Get API base URL from environment or default to relative path
const API_BASE = process.env.NEXT_PUBLIC_API_URL || "/api"
function InstrumentalReviewContent() {
const params = useParams()
const router = useRouter()
const jobId = params.id as string
// State
const [isLoading, setIsLoading] = useState(true)
const [error, setError] = useState<string | null>(null)
const [analysisData, setAnalysisData] = useState<InstrumentalAnalysisResponse | null>(null)
const [waveformData, setWaveformData] = useState<{ amplitudes: number[]; duration: number } | null>(null)
const [selectedOption, setSelectedOption] = useState<string>("clean")
const [muteRegions, setMuteRegions] = useState<MuteRegion[]>([])
const [isSelectionMode, setIsSelectionMode] = useState(false)
const [currentTime, setCurrentTime] = useState(0)
const [seekTo, setSeekTo] = useState<number | undefined>(undefined)
const [isCreatingCustom, setIsCreatingCustom] = useState(false)
const [isSubmitting, setIsSubmitting] = useState(false)
const [activeAudio, setActiveAudio] = useState<"clean" | "backing" | "with_backing" | "custom">("backing")
// Fetch analysis data
const fetchAnalysis = useCallback(async () => {
try {
setIsLoading(true)
setError(null)
const response = await fetch(`${API_BASE}/jobs/${jobId}/instrumental-analysis`)
if (!response.ok) {
const errorData = await response.json().catch(() => ({}))
throw new Error(errorData.detail || `Failed to fetch analysis: ${response.status}`)
}
const data: InstrumentalAnalysisResponse = await response.json()
setAnalysisData(data)
// Set initial selection based on recommendation
const recommendation = data.analysis.recommended_selection
if (recommendation === "clean") {
setSelectedOption("clean")
} else if (recommendation === "with_backing") {
setSelectedOption("with_backing")
} else {
// "review_needed" - default to with_backing but user should review
setSelectedOption("with_backing")
}
// Fetch waveform data for interactive display
const waveformResponse = await fetch(`${API_BASE}/jobs/${jobId}/waveform-data?num_points=600`)
if (waveformResponse.ok) {
const waveform = await waveformResponse.json()
setWaveformData(waveform)
}
} catch (err) {
setError(err instanceof Error ? err.message : "Failed to load analysis data")
} finally {
setIsLoading(false)
}
}, [jobId])
useEffect(() => {
fetchAnalysis()
}, [fetchAnalysis])
// Handle seeking from waveform click
const handleSeek = (time: number) => {
setSeekTo(time)
// Reset seekTo after a short delay
setTimeout(() => setSeekTo(undefined), 100)
}
// Handle adding a mute region
const handleAddRegion = (region: MuteRegion) => {
setMuteRegions((prev) => {
// Check for overlaps and merge if needed
const newRegions = [...prev, region].sort((a, b) => a.start_seconds - b.start_seconds)
// Merge overlapping regions
const merged: MuteRegion[] = []
for (const r of newRegions) {
if (merged.length === 0) {
merged.push(r)
} else {
const last = merged[merged.length - 1]
if (r.start_seconds <= last.end_seconds) {
last.end_seconds = Math.max(last.end_seconds, r.end_seconds)
} else {
merged.push(r)
}
}
}
return merged
})
setIsSelectionMode(false)
}
// Handle removing a mute region
const handleRemoveRegion = (index: number) => {
setMuteRegions((prev) => prev.filter((_, i) => i !== index))
}
// Handle clearing all mute regions
const handleClearAll = () => {
setMuteRegions([])
}
// Create custom instrumental
const handleCreateCustom = async () => {
if (muteRegions.length === 0) {
setError("Please select at least one region to mute")
return
}
try {
setIsCreatingCustom(true)
setError(null)
const response = await fetch(`${API_BASE}/jobs/${jobId}/create-custom-instrumental`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
mute_regions: muteRegions.map((r) => ({
start_seconds: r.start_seconds,
end_seconds: r.end_seconds,
})),
}),
})
if (!response.ok) {
const errorData = await response.json().catch(() => ({}))
throw new Error(errorData.detail || "Failed to create custom instrumental")
}
// Refresh analysis to get updated URLs
await fetchAnalysis()
setSelectedOption("custom")
setActiveAudio("custom")
} catch (err) {
setError(err instanceof Error ? err.message : "Failed to create custom instrumental")
} finally {
setIsCreatingCustom(false)
}
}
// Submit selection
const handleSubmit = async () => {
let selection = selectedOption
// If "review" is selected, determine based on mute regions
if (selectedOption === "review") {
if (muteRegions.length > 0 && analysisData?.has_custom_instrumental) {
selection = "custom"
} else {
selection = "with_backing"
}
}
try {
setIsSubmitting(true)
setError(null)
const response = await fetch(`${API_BASE}/jobs/${jobId}/select-instrumental`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ selection }),
})
if (!response.ok) {
const errorData = await response.json().catch(() => ({}))
throw new Error(errorData.detail || "Failed to submit selection")
}
// Navigate back to job page
router.push(`/jobs/${jobId}`)
} catch (err) {
setError(err instanceof Error ? err.message : "Failed to submit selection")
} finally {
setIsSubmitting(false)
}
}
// Get current audio URL based on active selection
const getCurrentAudioUrl = () => {
if (!analysisData) return null
switch (activeAudio) {
case "clean":
return analysisData.audio_urls.clean_instrumental
case "backing":
return analysisData.audio_urls.backing_vocals
case "with_backing":
return analysisData.audio_urls.with_backing
case "custom":
return analysisData.audio_urls.custom_instrumental
default:
return null
}
}
// Loading state
if (isLoading) {
return (
<div className="min-h-screen bg-background">
<AppHeader />
<main className="container mx-auto px-4 py-8 max-w-5xl">
<Skeleton className="h-8 w-48 mb-4" />
<Skeleton className="h-4 w-96 mb-8" />
<Skeleton className="h-[200px] w-full mb-4" />
<Skeleton className="h-32 w-full" />
</main>
</div>
)
}
// Error state
if (error && !analysisData) {
return (
<div className="min-h-screen bg-background">
<AppHeader />
<main className="container mx-auto px-4 py-8 max-w-5xl">
<Alert variant="destructive">
<AlertCircle className="h-4 w-4" />
<AlertDescription>{error}</AlertDescription>
</Alert>
<Button variant="outline" className="mt-4" onClick={() => router.push(`/jobs/${jobId}`)}>
<ArrowLeft className="w-4 h-4 mr-2" />
Back to Job
</Button>
</main>
</div>
)
}
const analysis = analysisData?.analysis
return (
<div className="min-h-screen bg-background">
<AppHeader />
<main className="container mx-auto px-4 py-8 max-w-6xl">
{/* Header */}
<Button variant="ghost" className="mb-6" onClick={() => router.push(`/jobs/${jobId}`)}>
<ArrowLeft className="w-4 h-4 mr-2" />
Back to Job
</Button>
<div className="mb-8">
<h1 className="text-3xl font-bold mb-2">
Select Instrumental Track
</h1>
<p className="text-muted-foreground">
{analysisData?.artist} - {analysisData?.title}
</p>
</div>
{/* Error Alert */}
{error && (
<Alert variant="destructive" className="mb-6">
<AlertCircle className="h-4 w-4" />
<AlertDescription>{error}</AlertDescription>
</Alert>
)}
{/* Analysis Summary */}
{analysis && (
<Card className="mb-6">
<CardHeader>
<CardTitle className="text-lg flex items-center gap-2">
<Music className="h-5 w-5" />
Backing Vocals Analysis
</CardTitle>
<CardDescription>
Automated analysis of the backing vocals stem
</CardDescription>
</CardHeader>
<CardContent>
<div className="flex flex-wrap gap-4">
<div className="flex items-center gap-2">
{analysis.has_audible_content ? (
<Volume2 className="h-4 w-4 text-yellow-500" />
) : (
<VolumeX className="h-4 w-4 text-green-500" />
)}
<span className="text-sm">
{analysis.has_audible_content
? "Backing vocals detected"
: "No backing vocals detected"}
</span>
</div>
{analysis.has_audible_content && (
<>
<Badge variant="outline">
{analysis.audible_segments.length} audible segments
</Badge>
<Badge variant="outline">
{analysis.audible_percentage.toFixed(1)}% of track
</Badge>
<Badge variant="outline">
{analysis.total_audible_duration_seconds.toFixed(1)}s total
</Badge>
</>
)}
<Badge
variant={analysis.recommended_selection === "clean" ? "default" : "secondary"}
>
Recommended: {analysis.recommended_selection === "clean" ? "Clean Instrumental" : "Review Needed"}
</Badge>
</div>
</CardContent>
</Card>
)}
{/* Waveform Display */}
{waveformData && analysis && (
<Card className="mb-6">
<CardHeader>
<CardTitle className="text-lg">Backing Vocals Waveform</CardTitle>
<CardDescription>
Click to seek • {isSelectionMode ? "Drag to select mute region" : "Click 'Add Region' to start selecting"}
</CardDescription>
</CardHeader>
<CardContent>
<WaveformDisplay
amplitudes={waveformData.amplitudes}
duration={waveformData.duration}
currentTime={currentTime}
segments={analysis.audible_segments}
muteRegions={muteRegions}
onSeek={handleSeek}
onRegionSelect={handleAddRegion}
isSelecting={isSelectionMode}
width={900}
height={150}
className="w-full overflow-x-auto"
/>
</CardContent>
</Card>
)}
<div className="grid lg:grid-cols-2 gap-6 mb-6">
{/* Audio Players */}
<Card>
<CardHeader>
<CardTitle className="text-lg">Audio Preview</CardTitle>
<CardDescription>
Listen to different instrumental options
</CardDescription>
</CardHeader>
<CardContent className="space-y-4">
{/* Audio source selector */}
<div className="flex flex-wrap gap-2">
<Button
variant={activeAudio === "backing" ? "default" : "outline"}
size="sm"
onClick={() => setActiveAudio("backing")}
>
Backing Vocals
</Button>
<Button
variant={activeAudio === "clean" ? "default" : "outline"}
size="sm"
onClick={() => setActiveAudio("clean")}
>
Clean Instrumental
</Button>
<Button
variant={activeAudio === "with_backing" ? "default" : "outline"}
size="sm"
onClick={() => setActiveAudio("with_backing")}
>
With Backing
</Button>
{analysisData?.has_custom_instrumental && (
<Button
variant={activeAudio === "custom" ? "default" : "outline"}
size="sm"
onClick={() => setActiveAudio("custom")}
>
Custom
</Button>
)}
</div>
{/* Audio player */}
{getCurrentAudioUrl() && (
<AudioPlayer
src={getCurrentAudioUrl()!}
onTimeUpdate={setCurrentTime}
seekTo={seekTo}
label={
activeAudio === "backing"
? "Backing Vocals Only"
: activeAudio === "clean"
? "Clean Instrumental"
: activeAudio === "custom"
? "Custom Instrumental"
: "Instrumental + Backing Vocals"
}
/>
)}
</CardContent>
</Card>
{/* Region Selector */}
<RegionSelector
muteRegions={muteRegions}
audibleSegments={analysis?.audible_segments}
onAddRegion={handleAddRegion}
onRemoveRegion={handleRemoveRegion}
onClearAll={handleClearAll}
onSeekTo={handleSeek}
isSelectionMode={isSelectionMode}
onToggleSelectionMode={() => setIsSelectionMode(!isSelectionMode)}
/>
</div>
{/* Create Custom Button */}
{muteRegions.length > 0 && !analysisData?.has_custom_instrumental && (
<Card className="mb-6">
<CardContent className="py-4">
<div className="flex items-center justify-between">
<div>
<p className="font-medium">Ready to create custom instrumental</p>
<p className="text-sm text-muted-foreground">
{muteRegions.length} region{muteRegions.length > 1 ? "s" : ""} will be muted
</p>
</div>
<Button onClick={handleCreateCustom} disabled={isCreatingCustom}>
{isCreatingCustom ? (
<>
<Loader2 className="h-4 w-4 mr-2 animate-spin" />
Creating...
</>
) : (
"Create Custom Instrumental"
)}
</Button>
</div>
</CardContent>
</Card>
)}
{/* Selection Options */}
<Card className="mb-6">
<CardHeader>
<CardTitle className="text-lg">Final Selection</CardTitle>
<CardDescription>
Choose which instrumental to use for your karaoke video
</CardDescription>
</CardHeader>
<CardContent>
<RadioGroup value={selectedOption} onValueChange={setSelectedOption}>
<div className="space-y-4">
<div className="flex items-center space-x-3">
<RadioGroupItem value="clean" id="clean" />
<Label htmlFor="clean" className="flex-1 cursor-pointer">
<div className="font-medium">Clean Instrumental</div>
<div className="text-sm text-muted-foreground">
Use the instrumental with no backing vocals at all
</div>
</Label>
{analysis?.recommended_selection === "clean" && (
<Badge variant="default" className="bg-green-600">
<CheckCircle2 className="h-3 w-3 mr-1" />
Recommended
</Badge>
)}
</div>
<div className="flex items-center space-x-3">
<RadioGroupItem value="with_backing" id="with_backing" />
<Label htmlFor="with_backing" className="flex-1 cursor-pointer">
<div className="font-medium">Instrumental with Backing Vocals</div>
<div className="text-sm text-muted-foreground">
Use the instrumental with all backing vocals included
</div>
</Label>
</div>
{analysisData?.has_custom_instrumental && (
<div className="flex items-center space-x-3">
<RadioGroupItem value="custom" id="custom" />
<Label htmlFor="custom" className="flex-1 cursor-pointer">
<div className="font-medium">Custom Instrumental</div>
<div className="text-sm text-muted-foreground">
Use your custom instrumental with {muteRegions.length} muted region{muteRegions.length > 1 ? "s" : ""}
</div>
</Label>
<Badge variant="secondary">Custom</Badge>
</div>
)}
</div>
</RadioGroup>
</CardContent>
</Card>
{/* Submit Button */}
<div className="flex gap-4">
<Button
size="lg"
onClick={handleSubmit}
disabled={isSubmitting}
className="flex-1 max-w-md"
>
{isSubmitting ? (
<>
<Loader2 className="h-4 w-4 mr-2 animate-spin" />
Submitting...
</>
) : (
<>
<CheckCircle2 className="h-4 w-4 mr-2" />
Confirm Selection & Continue
</>
)}
</Button>
</div>
</main>
</div>
)
}
export default function InstrumentalReviewPage() {
return (
<ProtectedRoute>
<InstrumentalReviewContent />
</ProtectedRoute>
)
}
+9 -2
View File
@@ -190,8 +190,15 @@ function JobDetailContent() {
{job.status === "awaiting_instrumental" && (
<Alert className="bg-secondary/10 border-secondary/30">
<AlertCircle className="h-4 w-4 text-secondary" />
<AlertDescription className="text-foreground">
Multiple instrumental versions were detected. Please select your preferred version to continue.
<AlertDescription className="text-foreground flex items-center justify-between">
<span>Multiple instrumental versions were detected. Please select your preferred version to continue.</span>
<Button
size="sm"
onClick={() => router.push(`/jobs/${job.id}/instrumental-review`)}
className="ml-4"
>
Select Instrumental
</Button>
</AlertDescription>
</Alert>
)}
@@ -0,0 +1,263 @@
"use client"
import { useRef, useState, useEffect, useCallback } from "react"
import { Button } from "@/components/ui/button"
import { Slider } from "@/components/ui/slider"
import { Play, Pause, SkipBack, SkipForward, Volume2, VolumeX } from "lucide-react"
interface AudioPlayerProps {
src: string
onTimeUpdate?: (currentTime: number) => void
onDurationChange?: (duration: number) => void
seekTo?: number
label?: string
className?: string
}
export function AudioPlayer({
src,
onTimeUpdate,
onDurationChange,
seekTo,
label,
className = "",
}: AudioPlayerProps) {
const audioRef = useRef<HTMLAudioElement>(null)
const [isPlaying, setIsPlaying] = useState(false)
const [currentTime, setCurrentTime] = useState(0)
const [duration, setDuration] = useState(0)
const [volume, setVolume] = useState(1)
const [isMuted, setIsMuted] = useState(false)
const [isLoading, setIsLoading] = useState(true)
// Handle external seek requests
useEffect(() => {
if (seekTo !== undefined && audioRef.current && !isNaN(seekTo)) {
audioRef.current.currentTime = seekTo
}
}, [seekTo])
// Handle audio events
useEffect(() => {
const audio = audioRef.current
if (!audio) return
const handleTimeUpdate = () => {
setCurrentTime(audio.currentTime)
onTimeUpdate?.(audio.currentTime)
}
const handleDurationChange = () => {
setDuration(audio.duration)
onDurationChange?.(audio.duration)
}
const handleLoadedData = () => {
setIsLoading(false)
setDuration(audio.duration)
onDurationChange?.(audio.duration)
}
const handleEnded = () => {
setIsPlaying(false)
}
const handleLoadStart = () => {
setIsLoading(true)
}
const handleCanPlay = () => {
setIsLoading(false)
}
// Sync isPlaying state with actual audio element state
const handlePlay = () => {
setIsPlaying(true)
}
const handlePause = () => {
setIsPlaying(false)
}
audio.addEventListener("timeupdate", handleTimeUpdate)
audio.addEventListener("durationchange", handleDurationChange)
audio.addEventListener("loadeddata", handleLoadedData)
audio.addEventListener("ended", handleEnded)
audio.addEventListener("loadstart", handleLoadStart)
audio.addEventListener("canplay", handleCanPlay)
audio.addEventListener("play", handlePlay)
audio.addEventListener("pause", handlePause)
return () => {
audio.removeEventListener("timeupdate", handleTimeUpdate)
audio.removeEventListener("durationchange", handleDurationChange)
audio.removeEventListener("loadeddata", handleLoadedData)
audio.removeEventListener("ended", handleEnded)
audio.removeEventListener("loadstart", handleLoadStart)
audio.removeEventListener("canplay", handleCanPlay)
audio.removeEventListener("play", handlePlay)
audio.removeEventListener("pause", handlePause)
}
}, [onTimeUpdate, onDurationChange])
// Update volume
useEffect(() => {
if (audioRef.current) {
audioRef.current.volume = isMuted ? 0 : volume
}
}, [volume, isMuted])
const togglePlay = useCallback(async () => {
const audio = audioRef.current
if (!audio) return
try {
if (audio.paused) {
await audio.play()
} else {
audio.pause()
}
// State will be updated by the play/pause event listeners
} catch (error) {
// Play was prevented (e.g., user hasn't interacted with page yet)
console.warn("Audio playback was prevented:", error)
}
}, [])
const handleSeek = useCallback((value: number[]) => {
const audio = audioRef.current
if (!audio) return
const newTime = value[0]
audio.currentTime = newTime
setCurrentTime(newTime)
}, [])
const skipBackward = useCallback(() => {
const audio = audioRef.current
if (!audio) return
audio.currentTime = Math.max(0, audio.currentTime - 5)
}, [])
const skipForward = useCallback(() => {
const audio = audioRef.current
if (!audio) return
audio.currentTime = Math.min(duration, audio.currentTime + 5)
}, [duration])
const toggleMute = useCallback(() => {
setIsMuted(!isMuted)
}, [isMuted])
const handleVolumeChange = useCallback((value: number[]) => {
setVolume(value[0])
if (value[0] > 0 && isMuted) {
setIsMuted(false)
}
}, [isMuted])
const formatTime = (time: number) => {
if (isNaN(time)) return "0:00"
const minutes = Math.floor(time / 60)
const seconds = Math.floor(time % 60)
return `${minutes}:${seconds.toString().padStart(2, "0")}`
}
return (
<div className={`bg-card rounded-lg p-4 ${className}`}>
<audio ref={audioRef} src={src} preload="metadata" />
{label && (
<div className="text-sm font-medium text-muted-foreground mb-3">
{label}
</div>
)}
{/* Progress bar */}
<div className="mb-4">
<Slider
value={[currentTime]}
max={duration || 100}
step={0.1}
onValueChange={handleSeek}
disabled={isLoading}
className="w-full"
/>
<div className="flex justify-between text-xs text-muted-foreground mt-1">
<span>{formatTime(currentTime)}</span>
<span>{formatTime(duration)}</span>
</div>
</div>
{/* Controls */}
<div className="flex items-center justify-between">
<div className="flex items-center gap-2">
<Button
variant="ghost"
size="icon"
onClick={skipBackward}
disabled={isLoading}
className="h-8 w-8"
>
<SkipBack className="h-4 w-4" />
</Button>
<Button
variant="default"
size="icon"
onClick={togglePlay}
disabled={isLoading}
className="h-10 w-10"
>
{isPlaying ? (
<Pause className="h-5 w-5" />
) : (
<Play className="h-5 w-5 ml-0.5" />
)}
</Button>
<Button
variant="ghost"
size="icon"
onClick={skipForward}
disabled={isLoading}
className="h-8 w-8"
>
<SkipForward className="h-4 w-4" />
</Button>
</div>
{/* Volume control */}
<div className="flex items-center gap-2">
<Button
variant="ghost"
size="icon"
onClick={toggleMute}
className="h-8 w-8"
>
{isMuted || volume === 0 ? (
<VolumeX className="h-4 w-4" />
) : (
<Volume2 className="h-4 w-4" />
)}
</Button>
<Slider
value={[isMuted ? 0 : volume]}
max={1}
step={0.1}
onValueChange={handleVolumeChange}
className="w-20"
/>
</div>
</div>
{isLoading && (
<div className="text-xs text-muted-foreground text-center mt-2">
Loading audio...
</div>
)}
</div>
)
}
@@ -0,0 +1,3 @@
export { WaveformDisplay } from "./waveform-display"
export { AudioPlayer } from "./audio-player"
export { RegionSelector } from "./region-selector"
@@ -0,0 +1,222 @@
"use client"
import { Button } from "@/components/ui/button"
import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card"
import { Badge } from "@/components/ui/badge"
import { Trash2, VolumeX, Plus } from "lucide-react"
interface MuteRegion {
start_seconds: number
end_seconds: number
}
interface AudibleSegment {
start_seconds: number
end_seconds: number
duration_seconds: number
avg_amplitude_db: number
}
interface RegionSelectorProps {
muteRegions: MuteRegion[]
audibleSegments?: AudibleSegment[]
onAddRegion: (region: MuteRegion) => void
onRemoveRegion: (index: number) => void
onClearAll: () => void
onSeekTo?: (time: number) => void
isSelectionMode: boolean
onToggleSelectionMode: () => void
className?: string
}
export function RegionSelector({
muteRegions,
audibleSegments = [],
onAddRegion,
onRemoveRegion,
onClearAll,
onSeekTo,
isSelectionMode,
onToggleSelectionMode,
className = "",
}: RegionSelectorProps) {
const formatTime = (seconds: number) => {
const mins = Math.floor(seconds / 60)
const secs = Math.floor(seconds % 60)
const ms = Math.floor((seconds % 1) * 100)
return `${mins}:${secs.toString().padStart(2, "0")}.${ms.toString().padStart(2, "0")}`
}
const formatDuration = (seconds: number) => {
if (seconds < 1) {
return `${Math.round(seconds * 1000)}ms`
}
return `${seconds.toFixed(1)}s`
}
const totalMutedDuration = muteRegions.reduce(
(sum, r) => sum + (r.end_seconds - r.start_seconds),
0
)
// Quick mute: add mute region for an audible segment
const handleQuickMute = (segment: AudibleSegment) => {
onAddRegion({
start_seconds: segment.start_seconds,
end_seconds: segment.end_seconds,
})
}
// Check if a segment is already muted
const isSegmentMuted = (segment: AudibleSegment) => {
return muteRegions.some(
(r) =>
r.start_seconds <= segment.start_seconds &&
r.end_seconds >= segment.end_seconds
)
}
return (
<div className={`space-y-4 ${className}`}>
{/* Selection Mode Toggle */}
<Card>
<CardHeader className="pb-3">
<div className="flex items-center justify-between">
<CardTitle className="text-lg">Mute Regions</CardTitle>
<Button
variant={isSelectionMode ? "default" : "outline"}
size="sm"
onClick={onToggleSelectionMode}
>
<Plus className="h-4 w-4 mr-2" />
{isSelectionMode ? "Click waveform to select" : "Add Region"}
</Button>
</div>
</CardHeader>
<CardContent>
{muteRegions.length === 0 ? (
<p className="text-sm text-muted-foreground">
No mute regions selected. Click "Add Region" and drag on the waveform to select areas to mute.
</p>
) : (
<div className="space-y-2">
{muteRegions.map((region, index) => (
<div
key={index}
className="flex items-center justify-between p-2 bg-muted/50 rounded-lg group"
>
<div className="flex items-center gap-3">
<VolumeX className="h-4 w-4 text-destructive" />
<button
onClick={() => onSeekTo?.(region.start_seconds)}
className="text-sm font-mono hover:text-primary transition-colors"
>
{formatTime(region.start_seconds)}
</button>
<span className="text-muted-foreground">→</span>
<button
onClick={() => onSeekTo?.(region.end_seconds)}
className="text-sm font-mono hover:text-primary transition-colors"
>
{formatTime(region.end_seconds)}
</button>
<Badge variant="secondary" className="ml-2">
{formatDuration(region.end_seconds - region.start_seconds)}
</Badge>
</div>
<Button
variant="ghost"
size="icon"
onClick={() => onRemoveRegion(index)}
className="h-8 w-8 opacity-0 group-hover:opacity-100 transition-opacity"
>
<Trash2 className="h-4 w-4 text-destructive" />
</Button>
</div>
))}
<div className="flex items-center justify-between pt-2 border-t mt-3">
<span className="text-sm text-muted-foreground">
Total muted: {formatDuration(totalMutedDuration)}
</span>
<Button
variant="ghost"
size="sm"
onClick={onClearAll}
className="text-destructive hover:text-destructive"
>
Clear All
</Button>
</div>
</div>
)}
</CardContent>
</Card>
{/* Detected Audible Segments */}
{audibleSegments.length > 0 && (
<Card>
<CardHeader className="pb-3">
<CardTitle className="text-lg">Detected Backing Vocals</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm text-muted-foreground mb-3">
Click a segment to jump to that time, or click the mute button to add it as a mute region.
</p>
<div className="space-y-2 max-h-64 overflow-y-auto">
{audibleSegments.map((segment, index) => {
const isMuted = isSegmentMuted(segment)
return (
<div
key={index}
className={`flex items-center justify-between p-2 rounded-lg transition-colors ${
isMuted ? "bg-destructive/10" : "bg-muted/50 hover:bg-muted"
}`}
>
<button
onClick={() => onSeekTo?.(segment.start_seconds)}
className="flex items-center gap-3 text-left"
>
<span className="text-sm font-mono">
{formatTime(segment.start_seconds)} - {formatTime(segment.end_seconds)}
</span>
<Badge variant="outline" className="text-xs">
{formatDuration(segment.duration_seconds)}
</Badge>
<Badge
variant="outline"
className={`text-xs ${
segment.avg_amplitude_db > -20
? "border-yellow-500 text-yellow-500"
: "border-muted-foreground"
}`}
>
{segment.avg_amplitude_db.toFixed(1)}dB
</Badge>
</button>
{!isMuted && (
<Button
variant="ghost"
size="sm"
onClick={() => handleQuickMute(segment)}
className="text-xs"
>
<VolumeX className="h-3 w-3 mr-1" />
Mute
</Button>
)}
{isMuted && (
<Badge variant="destructive" className="text-xs">
Muted
</Badge>
)}
</div>
)
})}
</div>
</CardContent>
</Card>
)}
</div>
)
}
@@ -0,0 +1,259 @@
"use client"
import { useRef, useEffect, useState, useCallback } from "react"
interface AudibleSegment {
start_seconds: number
end_seconds: number
duration_seconds: number
avg_amplitude_db: number
}
interface MuteRegion {
start_seconds: number
end_seconds: number
}
interface WaveformDisplayProps {
amplitudes: number[]
duration: number
currentTime?: number
segments?: AudibleSegment[]
muteRegions?: MuteRegion[]
onSeek?: (time: number) => void
onRegionSelect?: (region: MuteRegion) => void
isSelecting?: boolean
width?: number
height?: number
className?: string
}
export function WaveformDisplay({
amplitudes,
duration,
currentTime = 0,
segments = [],
muteRegions = [],
onSeek,
onRegionSelect,
isSelecting = false,
width = 800,
height = 150,
className = "",
}: WaveformDisplayProps) {
const canvasRef = useRef<HTMLCanvasElement>(null)
const [isDragging, setIsDragging] = useState(false)
const [dragStart, setDragStart] = useState<number | null>(null)
const [dragEnd, setDragEnd] = useState<number | null>(null)
const [hoveredTime, setHoveredTime] = useState<number | null>(null)
// Convert time to x position
const timeToX = useCallback((time: number) => {
return (time / duration) * width
}, [duration, width])
// Convert x position to time
const xToTime = useCallback((x: number) => {
return (x / width) * duration
}, [duration, width])
// Draw the waveform
useEffect(() => {
const canvas = canvasRef.current
if (!canvas) return
const ctx = canvas.getContext("2d")
if (!ctx) return
// Clear canvas
ctx.fillStyle = "#1a1a2e"
ctx.fillRect(0, 0, width, height)
const barWidth = width / amplitudes.length
const centerY = height / 2
// Draw mute regions background
ctx.fillStyle = "rgba(255, 107, 107, 0.2)"
for (const region of muteRegions) {
const startX = timeToX(region.start_seconds)
const endX = timeToX(region.end_seconds)
ctx.fillRect(startX, 0, endX - startX, height)
}
// Draw current drag selection
if (isDragging && dragStart !== null && dragEnd !== null) {
const startX = Math.min(timeToX(dragStart), timeToX(dragEnd))
const endX = Math.max(timeToX(dragStart), timeToX(dragEnd))
ctx.fillStyle = "rgba(255, 107, 107, 0.3)"
ctx.fillRect(startX, 0, endX - startX, height)
}
// Draw segment highlights
for (const segment of segments) {
const startX = timeToX(segment.start_seconds)
const endX = timeToX(segment.end_seconds)
const startIdx = Math.floor((segment.start_seconds / duration) * amplitudes.length)
const endIdx = Math.ceil((segment.end_seconds / duration) * amplitudes.length)
ctx.fillStyle = "rgba(233, 69, 96, 0.4)"
for (let i = startIdx; i < endIdx && i < amplitudes.length; i++) {
const amplitude = amplitudes[i]
const barHeight = amplitude * height * 0.8
const x = i * barWidth
ctx.fillRect(x, centerY - barHeight / 2, barWidth - 1, barHeight)
}
}
// Draw main waveform
ctx.fillStyle = "#4a90d9"
for (let i = 0; i < amplitudes.length; i++) {
const amplitude = amplitudes[i]
const barHeight = amplitude * height * 0.8
const x = i * barWidth
ctx.fillRect(x, centerY - barHeight / 2, barWidth - 1, barHeight)
}
// Draw silence threshold line
ctx.strokeStyle = "rgba(255, 255, 255, 0.2)"
ctx.setLineDash([5, 5])
ctx.beginPath()
const thresholdY = height * 0.5 // Visual representation
ctx.moveTo(0, thresholdY)
ctx.lineTo(width, thresholdY)
ctx.stroke()
ctx.setLineDash([])
// Draw playhead
if (currentTime > 0) {
const playheadX = timeToX(currentTime)
ctx.strokeStyle = "#ffffff"
ctx.lineWidth = 2
ctx.beginPath()
ctx.moveTo(playheadX, 0)
ctx.lineTo(playheadX, height)
ctx.stroke()
}
// Draw hover position
if (hoveredTime !== null && !isDragging) {
const hoverX = timeToX(hoveredTime)
ctx.strokeStyle = "rgba(255, 255, 255, 0.5)"
ctx.lineWidth = 1
ctx.beginPath()
ctx.moveTo(hoverX, 0)
ctx.lineTo(hoverX, height)
ctx.stroke()
}
// Draw time axis
ctx.fillStyle = "#ffffff"
ctx.font = "10px sans-serif"
ctx.textAlign = "center"
const tickInterval = duration > 300 ? 60 : duration > 60 ? 30 : 10
for (let t = 0; t <= duration; t += tickInterval) {
const x = timeToX(t)
const minutes = Math.floor(t / 60)
const seconds = Math.floor(t % 60)
const label = `${minutes}:${seconds.toString().padStart(2, "0")}`
ctx.fillText(label, x, height - 5)
// Tick mark
ctx.strokeStyle = "rgba(255, 255, 255, 0.3)"
ctx.beginPath()
ctx.moveTo(x, height - 20)
ctx.lineTo(x, height - 15)
ctx.stroke()
}
}, [amplitudes, duration, currentTime, segments, muteRegions, width, height, isDragging, dragStart, dragEnd, hoveredTime, timeToX])
// Handle mouse events for seeking and region selection
const handleMouseDown = (e: React.MouseEvent<HTMLCanvasElement>) => {
const canvas = canvasRef.current
if (!canvas) return
const rect = canvas.getBoundingClientRect()
const x = e.clientX - rect.left
const time = xToTime(x)
if (isSelecting) {
setIsDragging(true)
setDragStart(time)
setDragEnd(time)
} else if (onSeek) {
onSeek(time)
}
}
const handleMouseMove = (e: React.MouseEvent<HTMLCanvasElement>) => {
const canvas = canvasRef.current
if (!canvas) return
const rect = canvas.getBoundingClientRect()
const x = e.clientX - rect.left
const time = xToTime(x)
setHoveredTime(time)
if (isDragging && isSelecting) {
setDragEnd(time)
}
}
const handleMouseUp = () => {
if (isDragging && dragStart !== null && dragEnd !== null && onRegionSelect) {
const start = Math.min(dragStart, dragEnd)
const end = Math.max(dragStart, dragEnd)
// Only create region if it's at least 0.1 seconds
if (end - start >= 0.1) {
onRegionSelect({ start_seconds: start, end_seconds: end })
}
}
setIsDragging(false)
setDragStart(null)
setDragEnd(null)
}
const handleMouseLeave = () => {
setHoveredTime(null)
if (isDragging) {
handleMouseUp()
}
}
// Format time for tooltip
const formatTime = (time: number) => {
const minutes = Math.floor(time / 60)
const seconds = Math.floor(time % 60)
const ms = Math.floor((time % 1) * 100)
return `${minutes}:${seconds.toString().padStart(2, "0")}.${ms.toString().padStart(2, "0")}`
}
return (
<div className={`relative ${className}`}>
<canvas
ref={canvasRef}
width={width}
height={height}
className={`rounded-lg ${isSelecting ? "cursor-crosshair" : "cursor-pointer"}`}
onMouseDown={handleMouseDown}
onMouseMove={handleMouseMove}
onMouseUp={handleMouseUp}
onMouseLeave={handleMouseLeave}
/>
{/* Time tooltip */}
{hoveredTime !== null && (
<div
className="absolute top-0 transform -translate-x-1/2 bg-black/80 text-white text-xs px-2 py-1 rounded pointer-events-none"
style={{ left: timeToX(hoveredTime) }}
>
{formatTime(hoveredTime)}
</div>
)}
</div>
)
}
+8
View File
@@ -94,6 +94,14 @@ echo -n "your-genius-key" | \
# Add Audio Separator API URL
echo -n "https://your-modal-url" | \
gcloud secrets versions add audio-separator-api-url --data-file=-
# Add Redacted API key (for flacfetch audio search - private tracker)
echo -n "your-redacted-api-key" | \
gcloud secrets versions add redacted-api-key --data-file=-
# Add OPS API key (for flacfetch audio search - private tracker)
echo -n "your-ops-api-key" | \
gcloud secrets versions add ops-api-key --data-file=-
```
Or use Pulumi config secrets:
+259
View File
@@ -428,6 +428,24 @@ audio_separator_secret = secretmanager.Secret(
),
)
# Redacted API Key Secret (for flacfetch audio search)
redacted_api_key_secret = secretmanager.Secret(
"redacted-api-key",
secret_id="redacted-api-key",
replication=secretmanager.SecretReplicationArgs(
auto=secretmanager.SecretReplicationAutoArgs(),
),
)
# OPS API Key Secret (for flacfetch audio search)
ops_api_key_secret = secretmanager.Secret(
"ops-api-key",
secret_id="ops-api-key",
replication=secretmanager.SecretReplicationArgs(
auto=secretmanager.SecretReplicationAutoArgs(),
),
)
# Create Cloud Run Domain Mapping
# Maps api.nomadkaraoke.com to the karaoke-backend service
domain_mapping = cloudrun.DomainMapping(
@@ -479,3 +497,244 @@ domain_mapping.statuses.apply(
})
)
# ==================== Flacfetch Service (Torrent Downloads) ====================
# A dedicated VM running flacfetch with Transmission daemon for BitTorrent downloads.
# This is required because Cloud Run doesn't support inbound peer connections for torrents.
# The VM has a static IP for tracker whitelist and runs indefinitely for seeding.
# Static IP for flacfetch (for tracker account whitelist)
flacfetch_ip = gcp.compute.Address(
"flacfetch-ip",
name="flacfetch-static-ip",
region="us-central1",
address_type="EXTERNAL",
description="Static IP for flacfetch service (torrent downloads)",
)
# Service account for flacfetch VM
flacfetch_sa = serviceaccount.Account(
"flacfetch-sa",
account_id="flacfetch-service",
display_name="Flacfetch Service Account",
description="Service account for flacfetch torrent/audio download VM",
)
# Grant flacfetch service account GCS write permissions
flacfetch_storage_iam = gcp.storage.BucketIAMMember(
"flacfetch-storage-writer",
bucket=bucket.name,
role="roles/storage.objectCreator",
member=flacfetch_sa.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Grant flacfetch service account GCS read permissions (for uploads folder)
flacfetch_storage_reader_iam = gcp.storage.BucketIAMMember(
"flacfetch-storage-reader",
bucket=bucket.name,
role="roles/storage.objectViewer",
member=flacfetch_sa.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Grant flacfetch service account Secret Manager access
flacfetch_secrets_iam = gcp.projects.IAMMember(
"flacfetch-secrets-access",
project=project_id,
role="roles/secretmanager.secretAccessor",
member=flacfetch_sa.email.apply(lambda email: f"serviceAccount:{email}"),
)
# Flacfetch API key secret (for authenticating API requests)
flacfetch_api_key_secret = secretmanager.Secret(
"flacfetch-api-key",
secret_id="flacfetch-api-key",
replication=secretmanager.SecretReplicationArgs(
auto=secretmanager.SecretReplicationAutoArgs(),
),
)
# Flacfetch API URL secret (the static IP address of the flacfetch VM)
# This is stored as a secret to avoid committing infrastructure IPs to the repo
flacfetch_api_url_secret = secretmanager.Secret(
"flacfetch-api-url",
secret_id="flacfetch-api-url",
replication=secretmanager.SecretReplicationArgs(
auto=secretmanager.SecretReplicationAutoArgs(),
),
)
# Startup script for the flacfetch VM
# This installs and configures Transmission daemon and the flacfetch service
FLACFETCH_STARTUP_SCRIPT = """#!/bin/bash
set -e
# Log to a file for debugging
exec > >(tee /var/log/flacfetch-startup.log) 2>&1
echo "Starting flacfetch setup at $(date)"
# Install dependencies
apt-get update
apt-get install -y python3-pip python3-venv transmission-daemon ffmpeg git curl
# Configure Transmission
echo "Configuring Transmission daemon..."
systemctl stop transmission-daemon || true
# Create transmission directories
mkdir -p /var/lib/transmission-daemon/downloads
mkdir -p /var/lib/transmission-daemon/.config/transmission-daemon
chown -R debian-transmission:debian-transmission /var/lib/transmission-daemon
# Configure transmission settings
cat > /var/lib/transmission-daemon/.config/transmission-daemon/settings.json << 'SETTINGS'
{
"download-dir": "/var/lib/transmission-daemon/downloads",
"incomplete-dir": "/var/lib/transmission-daemon/.incomplete",
"incomplete-dir-enabled": true,
"rpc-authentication-required": false,
"rpc-bind-address": "127.0.0.1",
"rpc-enabled": true,
"rpc-port": 9091,
"rpc-whitelist-enabled": false,
"peer-port": 51413,
"port-forwarding-enabled": false,
"speed-limit-down": 0,
"speed-limit-down-enabled": false,
"speed-limit-up": 0,
"speed-limit-up-enabled": false,
"ratio-limit-enabled": false,
"umask": 2,
"encryption": 1
}
SETTINGS
chown debian-transmission:debian-transmission /var/lib/transmission-daemon/.config/transmission-daemon/settings.json
systemctl start transmission-daemon
echo "Transmission daemon started"
# Install flacfetch
echo "Installing flacfetch..."
cd /opt
# Clone flacfetch (we'll use the repo from GitHub)
if [ ! -d "flacfetch" ]; then
git clone https://github.com/nomadkaraoke/flacfetch.git
fi
cd flacfetch
# Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate
# Install flacfetch with API dependencies
pip install -e ".[api]"
# Get secrets from Secret Manager
echo "Fetching secrets from Secret Manager..."
FLACFETCH_API_KEY=$(gcloud secrets versions access latest --secret=flacfetch-api-key 2>/dev/null || echo "")
REDACTED_API_KEY=$(gcloud secrets versions access latest --secret=redacted-api-key 2>/dev/null || echo "")
OPS_API_KEY=$(gcloud secrets versions access latest --secret=ops-api-key 2>/dev/null || echo "")
# Get bucket name from project metadata
GCS_BUCKET=$(gcloud compute project-info describe --format='value(commonInstanceMetadata.items.gcs-bucket)' 2>/dev/null || echo "")
if [ -z "$GCS_BUCKET" ]; then
# Fallback: construct from project ID
PROJECT_ID=$(curl -s "http://metadata.google.internal/computeMetadata/v1/project/project-id" -H "Metadata-Flavor: Google")
GCS_BUCKET="karaoke-gen-storage-${PROJECT_ID}"
fi
echo "Using GCS bucket: $GCS_BUCKET"
# Create systemd service for flacfetch
echo "Creating systemd service..."
cat > /etc/systemd/system/flacfetch.service << SYSTEMD
[Unit]
Description=Flacfetch HTTP API Service
After=network.target transmission-daemon.service
Requires=transmission-daemon.service
[Service]
Type=simple
User=root
WorkingDirectory=/opt/flacfetch
Environment="FLACFETCH_API_KEY=${FLACFETCH_API_KEY}"
Environment="REDACTED_API_KEY=${REDACTED_API_KEY}"
Environment="OPS_API_KEY=${OPS_API_KEY}"
Environment="GCS_BUCKET=${GCS_BUCKET}"
Environment="FLACFETCH_KEEP_SEEDING=true"
Environment="FLACFETCH_MIN_FREE_GB=5"
Environment="FLACFETCH_DOWNLOAD_DIR=/var/lib/transmission-daemon/downloads"
Environment="TRANSMISSION_HOST=localhost"
Environment="TRANSMISSION_PORT=9091"
ExecStart=/opt/flacfetch/venv/bin/flacfetch serve --host 0.0.0.0 --port 8080
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
SYSTEMD
systemctl daemon-reload
systemctl enable flacfetch
systemctl start flacfetch
echo "Flacfetch service started at $(date)"
echo "Setup complete!"
"""
# Flacfetch VM instance
flacfetch_vm = gcp.compute.Instance(
"flacfetch-service",
name="flacfetch-service",
machine_type="e2-small", # 0.5 vCPU, 2GB RAM - sufficient for I/O-bound workload
zone="us-central1-a",
boot_disk=gcp.compute.InstanceBootDiskArgs(
initialize_params=gcp.compute.InstanceBootDiskInitializeParamsArgs(
image="debian-cloud/debian-12",
size=30, # GB - for torrent storage + headroom
type="pd-ssd", # SSD for faster I/O
),
),
network_interfaces=[gcp.compute.InstanceNetworkInterfaceArgs(
network="default",
access_configs=[gcp.compute.InstanceNetworkInterfaceAccessConfigArgs(
nat_ip=flacfetch_ip.address, # Static IP
)],
)],
service_account=gcp.compute.InstanceServiceAccountArgs(
email=flacfetch_sa.email,
scopes=["cloud-platform"],
),
metadata_startup_script=FLACFETCH_STARTUP_SCRIPT,
metadata={
"gcs-bucket": bucket.name, # Pass bucket name to startup script
},
tags=["flacfetch-service"],
allow_stopping_for_update=True,
)
# Firewall rule for flacfetch
# - Port 51413 TCP/UDP: BitTorrent peer connections
# - Port 8080 TCP: Flacfetch HTTP API (auth required at app level)
flacfetch_firewall = gcp.compute.Firewall(
"flacfetch-firewall",
name="flacfetch-firewall",
network="default",
allows=[
# BitTorrent peer connections
gcp.compute.FirewallAllowArgs(protocol="tcp", ports=["51413"]),
gcp.compute.FirewallAllowArgs(protocol="udp", ports=["51413"]),
# Flacfetch HTTP API (auth required at app level)
gcp.compute.FirewallAllowArgs(protocol="tcp", ports=["8080"]),
],
source_ranges=["0.0.0.0/0"], # Permissive, auth enforced at app level
target_tags=["flacfetch-service"],
description="Firewall rules for flacfetch torrent/API service",
)
# Export flacfetch values
pulumi.export("flacfetch_static_ip", flacfetch_ip.address)
pulumi.export("flacfetch_service_url", flacfetch_ip.address.apply(
lambda ip: f"http://{ip}:8080"
))
pulumi.export("flacfetch_service_account", flacfetch_sa.email)
+32 -1
View File
@@ -4,4 +4,35 @@ import warnings
warnings.filterwarnings("ignore", category=SyntaxWarning, module="pydub.*")
warnings.filterwarnings("ignore", category=SyntaxWarning, module="syrics.*")
from .karaoke_gen import KaraokePrep
# Lazy imports to avoid loading heavy dependencies when not needed.
# KaraokePrep has many dependencies (lyrics_transcriber, etc.) which may not
# be available in all contexts (e.g., backend which only needs audio_fetcher).
#
# Use explicit imports instead:
# from karaoke_gen.karaoke_gen import KaraokePrep
# from karaoke_gen.audio_fetcher import FlacFetcher, AudioSearchResult, ...
__all__ = [
"KaraokePrep",
# Audio fetcher
"FlacFetcher",
"AudioSearchResult",
"AudioFetchResult",
"AudioFetcherError",
"NoResultsError",
"DownloadError",
"UserCancelledError",
]
def __getattr__(name):
"""Lazy import for heavy modules."""
if name == "KaraokePrep":
from .karaoke_gen import KaraokePrep
return KaraokePrep
elif name in ("FlacFetcher", "AudioSearchResult", "AudioFetchResult",
"AudioFetcherError", "NoResultsError", "DownloadError",
"UserCancelledError"):
from . import audio_fetcher
return getattr(audio_fetcher, name)
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+474 -54
View File
@@ -7,15 +7,29 @@ using flacfetch, replacing the previous direct yt-dlp usage.
import logging
import os
import signal
import sys
import tempfile
import threading
from abc import ABC, abstractmethod
from dataclasses import dataclass
from typing import List, Optional
from concurrent.futures import ThreadPoolExecutor, TimeoutError as FuturesTimeoutError
from dataclasses import dataclass, asdict, field
from typing import List, Optional, Dict, Any
# Global flag to track if user requested cancellation via Ctrl+C
_interrupt_requested = False
@dataclass
class AudioSearchResult:
"""Represents a single search result for audio."""
"""Represents a single search result for audio.
Used by both local CLI and cloud backend. Supports serialization
for Firestore storage via to_dict()/from_dict().
For rich display, this class can serialize the full flacfetch Release
data so remote CLIs can use flacfetch's shared display functions.
"""
title: str
artist: str
@@ -24,13 +38,75 @@ class AudioSearchResult:
duration: Optional[int] = None # Duration in seconds
quality: Optional[str] = None # e.g., "FLAC", "320kbps", etc.
source_id: Optional[str] = None # Unique ID from the source
# Raw result object from the provider (for download)
raw_result: Optional[object] = None
index: int = 0 # Index in the results list (for API selection)
seeders: Optional[int] = None # Number of seeders (for torrent sources)
target_file: Optional[str] = None # Target filename in the release
# Raw result object from the provider (for download) - not serialized
raw_result: Optional[object] = field(default=None, repr=False)
def to_dict(self) -> Dict[str, Any]:
"""Convert to dict for JSON/Firestore serialization.
Includes full flacfetch Release data if available, enabling
remote CLIs to use flacfetch's shared display functions.
"""
result = {
"title": self.title,
"artist": self.artist,
"url": self.url,
"provider": self.provider,
"duration": self.duration,
"quality": self.quality,
"source_id": self.source_id,
"index": self.index,
"seeders": self.seeders,
"target_file": self.target_file,
}
# If we have a raw_result (flacfetch Release), include its full data
# This enables rich display on the remote CLI
if self.raw_result:
try:
release_dict = self.raw_result.to_dict()
# Merge Release fields into result (they may override basic fields)
for key in ['year', 'label', 'edition_info', 'release_type', 'channel',
'view_count', 'size_bytes', 'target_file_size', 'track_pattern',
'match_score', 'formatted_size', 'formatted_duration',
'formatted_views', 'is_lossless', 'quality_str', 'quality']:
if key in release_dict:
# Use 'quality_data' for the quality dict to avoid confusion with quality string
result_key = 'quality_data' if key == 'quality' else key
result[result_key] = release_dict[key]
except AttributeError:
pass # raw_result doesn't have to_dict() method
return result
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "AudioSearchResult":
"""Create from dict (e.g., from Firestore)."""
return cls(
title=data.get("title", ""),
artist=data.get("artist", ""),
url=data.get("url", ""),
provider=data.get("provider", "Unknown"),
duration=data.get("duration"),
quality=data.get("quality"),
source_id=data.get("source_id"),
index=data.get("index", 0),
seeders=data.get("seeders"),
target_file=data.get("target_file"),
raw_result=None, # Not stored in serialized form
)
@dataclass
class AudioFetchResult:
"""Result of an audio fetch operation."""
"""Result of an audio fetch operation.
Used by both local CLI and cloud backend. Supports serialization
for Firestore storage via to_dict()/from_dict().
"""
filepath: str
artist: str
@@ -38,6 +114,22 @@ class AudioFetchResult:
provider: str
duration: Optional[int] = None
quality: Optional[str] = None
def to_dict(self) -> Dict[str, Any]:
"""Convert to dict for JSON/Firestore serialization."""
return asdict(self)
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> "AudioFetchResult":
"""Create from dict (e.g., from Firestore)."""
return cls(
filepath=data.get("filepath", ""),
artist=data.get("artist", ""),
title=data.get("title", ""),
provider=data.get("provider", "Unknown"),
duration=data.get("duration"),
quality=data.get("quality"),
)
class AudioFetcherError(Exception):
@@ -58,6 +150,19 @@ class DownloadError(AudioFetcherError):
pass
class UserCancelledError(AudioFetcherError):
"""Raised when user explicitly cancels the operation (e.g., enters 0 or Ctrl+C)."""
pass
def _check_interrupt():
"""Check if interrupt was requested and raise UserCancelledError if so."""
global _interrupt_requested
if _interrupt_requested:
raise UserCancelledError("Operation cancelled by user")
class AudioFetcher(ABC):
"""Abstract base class for audio fetching implementations."""
@@ -140,6 +245,8 @@ class FlacFetchAudioFetcher(AudioFetcher):
This provides access to multiple audio sources including private music trackers
and YouTube, with intelligent prioritization of high-quality sources.
Also exported as FlacFetcher for shorter name.
"""
def __init__(
@@ -163,31 +270,101 @@ class FlacFetchAudioFetcher(AudioFetcher):
self._ops_api_key = ops_api_key or os.environ.get("OPS_API_KEY")
self._provider_priority = provider_priority
self._manager = None
self._transmission_available = None # Cached result of Transmission check
def _check_transmission_available(self) -> bool:
"""
Check if Transmission daemon is available for torrent downloads.
This prevents adding tracker providers (Redacted/OPS) when Transmission
isn't running, which would result in search results that can't be downloaded.
Returns:
True if Transmission is available and responsive, False otherwise.
"""
if self._transmission_available is not None:
self.logger.info(f"[Transmission] Using cached status: available={self._transmission_available}")
return self._transmission_available
host = os.environ.get("TRANSMISSION_HOST", "localhost")
port = int(os.environ.get("TRANSMISSION_PORT", "9091"))
self.logger.info(f"[Transmission] Checking availability at {host}:{port}")
try:
import transmission_rpc
self.logger.info(f"[Transmission] transmission_rpc imported successfully")
client = transmission_rpc.Client(host=host, port=port, timeout=5)
self.logger.info(f"[Transmission] Client created, calling session_stats()...")
# Simple test to verify connection works
stats = client.session_stats()
self.logger.info(f"[Transmission] Connected! Download dir: {getattr(stats, 'download_dir', 'unknown')}")
self._transmission_available = True
except ImportError as e:
self._transmission_available = False
self.logger.warning(f"[Transmission] transmission_rpc not installed: {e}")
except Exception as e:
self._transmission_available = False
self.logger.warning(f"[Transmission] Connection failed to {host}:{port}: {type(e).__name__}: {e}")
self.logger.info(f"[Transmission] Final status: available={self._transmission_available}")
return self._transmission_available
def _get_manager(self):
"""Lazily initialize and return the FetchManager."""
if self._manager is None:
# Import flacfetch here to avoid import errors if not installed
from flacfetch.core.manager import FetchManager
from flacfetch.providers.youtube import YouTubeProvider
from flacfetch.providers.youtube import YoutubeProvider
from flacfetch.downloaders.youtube import YoutubeDownloader
# Try to import TorrentDownloader (has optional dependencies)
TorrentDownloader = None
try:
from flacfetch.downloaders.torrent import TorrentDownloader
except ImportError:
self.logger.debug("TorrentDownloader not available (missing dependencies)")
self._manager = FetchManager()
# Add providers based on available API keys
if self._redacted_api_key:
# Only add tracker providers if we can actually download from them
# This requires both TorrentDownloader and a running Transmission daemon
has_torrent_downloader = TorrentDownloader is not None
transmission_available = self._check_transmission_available()
can_use_trackers = has_torrent_downloader and transmission_available
self.logger.info(
f"[FlacFetcher] Provider setup: TorrentDownloader={has_torrent_downloader}, "
f"Transmission={transmission_available}, can_use_trackers={can_use_trackers}"
)
if not can_use_trackers and (self._redacted_api_key or self._ops_api_key):
self.logger.warning(
"[FlacFetcher] Tracker providers (Redacted/OPS) DISABLED: "
f"TorrentDownloader={has_torrent_downloader}, Transmission={transmission_available}. "
"Only YouTube sources will be used."
)
# Add providers and downloaders based on available API keys
if self._redacted_api_key and can_use_trackers:
from flacfetch.providers.redacted import RedactedProvider
self._manager.add_provider(RedactedProvider(api_key=self._redacted_api_key))
self.logger.debug("Added Redacted provider")
self._manager.register_downloader("Redacted", TorrentDownloader())
self.logger.info("[FlacFetcher] Added Redacted provider with TorrentDownloader")
if self._ops_api_key:
if self._ops_api_key and can_use_trackers:
from flacfetch.providers.ops import OPSProvider
self._manager.add_provider(OPSProvider(api_key=self._ops_api_key))
self.logger.debug("Added OPS provider")
self._manager.register_downloader("OPS", TorrentDownloader())
self.logger.info("[FlacFetcher] Added OPS provider with TorrentDownloader")
# Always add YouTube as a fallback provider
self._manager.add_provider(YouTubeProvider())
# Always add YouTube as a fallback provider with its downloader
self._manager.add_provider(YoutubeProvider())
self._manager.register_downloader("YouTube", YoutubeDownloader())
self.logger.debug("Added YouTube provider")
return self._manager
@@ -219,16 +396,23 @@ class FlacFetchAudioFetcher(AudioFetcher):
# Convert to our AudioSearchResult format
search_results = []
for result in results:
for i, result in enumerate(results):
# Get quality as string if it's a Quality object
quality = getattr(result, "quality", None)
quality_str = str(quality) if quality else None
search_results.append(
AudioSearchResult(
title=getattr(result, "title", title),
artist=getattr(result, "artist", artist),
url=getattr(result, "url", ""),
provider=getattr(result, "provider", "Unknown"),
duration=getattr(result, "duration", None),
quality=getattr(result, "quality", None),
source_id=getattr(result, "id", None),
url=getattr(result, "download_url", "") or "",
provider=getattr(result, "source_name", "Unknown"),
duration=getattr(result, "duration_seconds", None),
quality=quality_str,
source_id=getattr(result, "info_hash", None),
index=i, # Set index for API selection
seeders=getattr(result, "seeders", None),
target_file=getattr(result, "target_file", None),
raw_result=result,
)
)
@@ -265,7 +449,7 @@ class FlacFetchAudioFetcher(AudioFetcher):
if output_filename is None:
output_filename = f"{result.artist} - {result.title}"
self.logger.info(f"Downloading: {result.artist} - {result.title} from {result.provider}")
self.logger.info(f"Downloading: {result.artist} - {result.title} from {result.provider or 'Unknown'}")
try:
# Use flacfetch to download
@@ -292,6 +476,40 @@ class FlacFetchAudioFetcher(AudioFetcher):
except Exception as e:
raise DownloadError(f"Failed to download {result.artist} - {result.title}: {e}") from e
def select_best(self, results: List[AudioSearchResult]) -> int:
"""
Select the best result from a list of search results.
Uses flacfetch's built-in quality ranking to determine the best source.
This is useful for automated/non-interactive usage.
Args:
results: List of AudioSearchResult objects from search()
Returns:
Index of the best result in the list
"""
if not results:
return 0
manager = self._get_manager()
# Get raw results that have raw_result set
raw_results = [r.raw_result for r in results if r.raw_result is not None]
if raw_results:
try:
best = manager.select_best(raw_results)
# Find index of best result
for i, r in enumerate(results):
if r.raw_result == best:
return i
except Exception as e:
self.logger.warning(f"select_best failed, using first result: {e}")
# Fallback: return first result
return 0
def search_and_download(
self,
artist: str,
@@ -319,6 +537,7 @@ class FlacFetchAudioFetcher(AudioFetcher):
Raises:
NoResultsError: If no results are found
DownloadError: If download fails
UserCancelledError: If user cancels (Ctrl+C or enters 0)
"""
from flacfetch.core.models import TrackQuery
@@ -326,7 +545,9 @@ class FlacFetchAudioFetcher(AudioFetcher):
query = TrackQuery(artist=artist, title=title)
self.logger.info(f"Searching for: {artist} - {title}")
results = manager.search(query)
# Run search in a thread so we can handle Ctrl+C
results = self._interruptible_search(manager, query)
if not results:
raise NoResultsError(f"No results found for: {artist} - {title}")
@@ -336,11 +557,13 @@ class FlacFetchAudioFetcher(AudioFetcher):
if auto_select:
# Auto mode: select best result based on flacfetch's ranking
selected = manager.select_best(results)
self.logger.info(f"Auto-selected: {getattr(selected, 'title', title)} from {getattr(selected, 'provider', 'Unknown')}")
self.logger.info(f"Auto-selected: {getattr(selected, 'title', title)} from {getattr(selected, 'source_name', 'Unknown')}")
else:
# Interactive mode: present options to user
selected = self._interactive_select(results, artist, title)
# Note: _interactive_select now raises UserCancelledError instead of returning None
# This check is kept as a safety net
if selected is None:
raise NoResultsError(f"No result selected for: {artist} - {title}")
@@ -351,69 +574,262 @@ class FlacFetchAudioFetcher(AudioFetcher):
if output_filename is None:
output_filename = f"{artist} - {title}"
self.logger.info(f"Downloading from {getattr(selected, 'provider', 'Unknown')}...")
self.logger.info(f"Downloading from {getattr(selected, 'source_name', 'Unknown')}...")
try:
filepath = manager.download(
# Use interruptible download so Ctrl+C works during torrent downloads
filepath = self._interruptible_download(
manager,
selected,
output_path=output_dir,
output_filename=output_filename,
)
if filepath is None:
if not filepath:
raise DownloadError(f"Download returned no file path for: {artist} - {title}")
self.logger.info(f"Downloaded to: {filepath}")
# Get quality as string if it's a Quality object
quality = getattr(selected, "quality", None)
quality_str = str(quality) if quality else None
return AudioFetchResult(
filepath=filepath,
artist=artist,
title=title,
provider=getattr(selected, "provider", "Unknown"),
duration=getattr(selected, "duration", None),
quality=getattr(selected, "quality", None),
provider=getattr(selected, "source_name", "Unknown"),
duration=getattr(selected, "duration_seconds", None),
quality=quality_str,
)
except (UserCancelledError, KeyboardInterrupt):
# Let cancellation exceptions propagate without wrapping
raise
except Exception as e:
raise DownloadError(f"Failed to download {artist} - {title}: {e}") from e
def _interruptible_search(self, manager, query) -> list:
"""
Run search in a way that can be interrupted by Ctrl+C.
The flacfetch search is a blocking network operation that doesn't
respond to SIGINT while running. This method runs it in a background
thread and periodically checks for interrupts.
Args:
manager: The FetchManager instance
query: The TrackQuery to search for
Returns:
List of search results
Raises:
UserCancelledError: If user presses Ctrl+C during search
"""
global _interrupt_requested
_interrupt_requested = False
result_container = {"results": None, "error": None}
def do_search():
try:
result_container["results"] = manager.search(query)
except Exception as e:
result_container["error"] = e
# Set up signal handler for immediate response to Ctrl+C
original_handler = signal.getsignal(signal.SIGINT)
def interrupt_handler(signum, frame):
global _interrupt_requested
_interrupt_requested = True
# Print immediately so user knows it was received
print("\nCancelling... please wait", file=sys.stderr)
signal.signal(signal.SIGINT, interrupt_handler)
try:
# Start search in background thread
search_thread = threading.Thread(target=do_search, daemon=True)
search_thread.start()
# Wait for completion with periodic interrupt checks
while search_thread.is_alive():
search_thread.join(timeout=0.1) # Check every 100ms
if _interrupt_requested:
# Don't wait for thread - it's a daemon and will be killed
raise UserCancelledError("Search cancelled by user (Ctrl+C)")
# Check for errors from the search
if result_container["error"] is not None:
raise result_container["error"]
return result_container["results"]
finally:
# Restore original signal handler
signal.signal(signal.SIGINT, original_handler)
_interrupt_requested = False
def _interruptible_download(self, manager, selected, output_path: str, output_filename: str) -> str:
"""
Run download in a way that can be interrupted by Ctrl+C.
The flacfetch/transmission download is a blocking operation that doesn't
respond to SIGINT while running (especially for torrent downloads).
This method runs it in a background thread and periodically checks for interrupts.
Args:
manager: The FetchManager instance
selected: The selected result to download
output_path: Directory to save the file
output_filename: Filename to save as
Returns:
Path to the downloaded file
Raises:
UserCancelledError: If user presses Ctrl+C during download
DownloadError: If download fails
"""
global _interrupt_requested
_interrupt_requested = False
result_container = {"filepath": None, "error": None}
was_cancelled = False
def do_download():
try:
result_container["filepath"] = manager.download(
selected,
output_path=output_path,
output_filename=output_filename,
)
except Exception as e:
result_container["error"] = e
# Set up signal handler for immediate response to Ctrl+C
original_handler = signal.getsignal(signal.SIGINT)
def interrupt_handler(signum, frame):
global _interrupt_requested
_interrupt_requested = True
# Print immediately so user knows it was received
print("\nCancelling download... please wait (may take a few seconds)", file=sys.stderr)
signal.signal(signal.SIGINT, interrupt_handler)
try:
# Start download in background thread
download_thread = threading.Thread(target=do_download, daemon=True)
download_thread.start()
# Wait for completion with periodic interrupt checks
while download_thread.is_alive():
download_thread.join(timeout=0.2) # Check every 200ms
if _interrupt_requested:
was_cancelled = True
# Clean up any pending torrents before raising
self._cleanup_transmission_torrents(selected)
raise UserCancelledError("Download cancelled by user (Ctrl+C)")
# Check for errors from the download
if result_container["error"] is not None:
raise result_container["error"]
return result_container["filepath"]
finally:
# Restore original signal handler
signal.signal(signal.SIGINT, original_handler)
_interrupt_requested = False
def _cleanup_transmission_torrents(self, selected) -> None:
"""
Clean up any torrents in Transmission that were started for this download.
Called when a download is cancelled to remove incomplete torrents and their data.
Args:
selected: The selected result that was being downloaded
"""
try:
import transmission_rpc
host = os.environ.get("TRANSMISSION_HOST", "localhost")
port = int(os.environ.get("TRANSMISSION_PORT", "9091"))
client = transmission_rpc.Client(host=host, port=port, timeout=5)
# Get the release name to match against torrents
release_name = getattr(selected, 'name', None) or getattr(selected, 'title', None)
if not release_name:
self.logger.debug("[Transmission] No release name to match for cleanup")
return
# Find and remove matching incomplete torrents
torrents = client.get_torrents()
for torrent in torrents:
# Match by name similarity and incomplete status
if torrent.progress < 100 and release_name.lower() in torrent.name.lower():
self.logger.info(f"[Transmission] Removing cancelled torrent: {torrent.name}")
client.remove_torrent(torrent.id, delete_data=True)
except Exception as e:
# Don't fail the cancellation if cleanup fails
self.logger.debug(f"[Transmission] Cleanup failed (non-fatal): {e}")
def _interactive_select(self, results: list, artist: str, title: str) -> object:
"""
Present search results to the user for interactive selection.
Uses flacfetch's built-in CLIHandler for rich, colorized output.
Args:
results: List of search results from flacfetch
results: List of Release objects from flacfetch
artist: The artist name being searched
title: The track title being searched
Returns:
The selected result object
The selected Release object
Raises:
UserCancelledError: If user cancels selection
"""
print(f"\n{'=' * 60}")
print(f"Search Results for: {artist} - {title}")
print(f"{'=' * 60}\n")
try:
# Use flacfetch's built-in CLIHandler for rich display
from flacfetch.interface.cli import CLIHandler
for i, result in enumerate(results, 1):
provider = getattr(result, "provider", "Unknown")
result_title = getattr(result, "title", "Unknown")
result_artist = getattr(result, "artist", "Unknown")
quality = getattr(result, "quality", "")
duration = getattr(result, "duration", None)
handler = CLIHandler(target_artist=artist)
result = handler.select_release(results)
if result is None:
# User selected 0 to cancel
raise UserCancelledError("Selection cancelled by user")
return result
except ImportError:
# Fallback to basic display if CLIHandler not available
return self._basic_interactive_select(results, artist, title)
except (KeyboardInterrupt, EOFError):
raise UserCancelledError("Selection cancelled by user (Ctrl+C)")
except (AttributeError, TypeError):
# Fallback if results aren't proper Release objects (e.g., in tests)
return self._basic_interactive_select(results, artist, title)
# Format duration if available
duration_str = ""
if duration:
minutes = duration // 60
seconds = duration % 60
duration_str = f" [{minutes}:{seconds:02d}]"
def _basic_interactive_select(self, results: list, artist: str, title: str) -> object:
"""
Basic fallback for interactive selection without rich formatting.
quality_str = f" ({quality})" if quality else ""
Args:
results: List of Release objects from flacfetch
artist: The artist name being searched
title: The track title being searched
print(f" {i}. [{provider}] {result_artist} - {result_title}{quality_str}{duration_str}")
print()
print(" 0. Cancel")
print()
Returns:
The selected Release object
Raises:
UserCancelledError: If user cancels selection
"""
# Use flacfetch's shared display function
from flacfetch import print_releases
print_releases(results, target_artist=artist, use_colors=True)
while True:
try:
@@ -421,7 +837,7 @@ class FlacFetchAudioFetcher(AudioFetcher):
if choice == "0":
self.logger.info("User cancelled selection")
return None
raise UserCancelledError("Selection cancelled by user")
choice_num = int(choice)
if 1 <= choice_num <= len(results):
@@ -435,7 +851,11 @@ class FlacFetchAudioFetcher(AudioFetcher):
print("Please enter a valid number")
except KeyboardInterrupt:
print("\nCancelled")
return None
raise UserCancelledError("Selection cancelled by user (Ctrl+C)")
# Alias for shorter name - used by backend and other consumers
FlacFetcher = FlacFetchAudioFetcher
def create_audio_fetcher(
+11 -3
View File
@@ -771,8 +771,16 @@ class AudioProcessor:
padded_result["other_stems"] = separation_result.get("other_stems", {})
padded_result["backing_vocals"] = separation_result.get("backing_vocals", {})
self.logger.info(
f"✓ Countdown padding applied to {len(padded_result['combined_instrumentals']) + 1} instrumental file(s)"
)
# Count actual padded files (don't assume clean instrumental was padded)
padded_count = (1 if padded_result["clean_instrumental"].get("instrumental") else 0) + len(padded_result["combined_instrumentals"])
if padded_count > 0:
self.logger.info(
f"✓ Countdown padding applied to {padded_count} instrumental file(s)"
)
else:
self.logger.warning(
"No instrumental files found to pad. Check that audio separation completed successfully."
)
return padded_result
@@ -0,0 +1,45 @@
"""
Instrumental Review Module - Shared core for both local and remote CLI.
This module provides audio analysis and editing functionality for instrumental
selection in karaoke generation. It's designed to be:
- Pure Python with no cloud dependencies (GCS, etc.)
- Reusable by both local CLI (karaoke-gen) and remote backend (Cloud Run)
- Easy to test without mocking cloud services
Classes:
AudioAnalyzer: Analyzes backing vocals audio for audible content
AudioEditor: Creates custom instrumentals by muting regions
WaveformGenerator: Generates waveform visualization images
InstrumentalReviewServer: Local HTTP server for browser-based review
Models:
AnalysisResult: Result of audio analysis
AudibleSegment: A detected segment of audible content
MuteRegion: A region to mute in the backing vocals
RecommendedSelection: Enum of selection recommendations
"""
from .models import (
AnalysisResult,
AudibleSegment,
MuteRegion,
RecommendedSelection,
)
from .analyzer import AudioAnalyzer
from .editor import AudioEditor
from .waveform import WaveformGenerator
from .server import InstrumentalReviewServer
__all__ = [
# Models
"AnalysisResult",
"AudibleSegment",
"MuteRegion",
"RecommendedSelection",
# Classes
"AudioAnalyzer",
"AudioEditor",
"WaveformGenerator",
"InstrumentalReviewServer",
]
+408
View File
@@ -0,0 +1,408 @@
"""
Audio analyzer for detecting audible content in backing vocals.
This module provides the AudioAnalyzer class which analyzes audio files
to detect segments of audible content above a silence threshold. It's used
to help determine whether backing vocals should be included in the final
karaoke instrumental.
"""
import logging
import math
from pathlib import Path
from typing import List, Optional, Tuple
from pydub import AudioSegment
from .models import AnalysisResult, AudibleSegment, RecommendedSelection
logger = logging.getLogger(__name__)
class AudioAnalyzer:
"""
Analyzes audio files for backing vocals content.
This class is pure Python with no cloud dependencies. It works with
local file paths and uses pydub for audio loading and analysis.
The analyzer detects segments of audible content (above a silence threshold)
and provides recommendations for instrumental selection based on the
analysis results.
Attributes:
silence_threshold_db: Amplitude threshold below which audio is
considered silent (default: -40.0 dB)
min_segment_duration_ms: Minimum duration for a segment to be
considered audible (default: 100ms)
merge_gap_ms: Maximum gap between segments to merge them
(default: 500ms)
window_ms: Analysis window size in milliseconds (default: 50ms)
Example:
>>> analyzer = AudioAnalyzer(silence_threshold_db=-40.0)
>>> result = analyzer.analyze("/path/to/backing_vocals.flac")
>>> if result.has_audible_content:
... print(f"Found {result.segment_count} audible segments")
... for seg in result.audible_segments:
... print(f" {seg.start_seconds:.1f}s - {seg.end_seconds:.1f}s")
"""
def __init__(
self,
silence_threshold_db: float = -40.0,
min_segment_duration_ms: int = 100,
merge_gap_ms: int = 500,
window_ms: int = 50,
):
"""
Initialize the audio analyzer.
Args:
silence_threshold_db: Amplitude threshold below which audio is
considered silent. Default is -40.0 dB.
min_segment_duration_ms: Minimum duration for a segment to be
reported as audible. Segments shorter than this are ignored.
Default is 100ms.
merge_gap_ms: If two audible segments are separated by a gap
shorter than this, they are merged into one segment.
Default is 500ms.
window_ms: Size of the analysis window in milliseconds.
Smaller windows give more precise timing but slower analysis.
Default is 50ms.
"""
self.silence_threshold_db = silence_threshold_db
self.min_segment_duration_ms = min_segment_duration_ms
self.merge_gap_ms = merge_gap_ms
self.window_ms = window_ms
def analyze(self, audio_path: str) -> AnalysisResult:
"""
Analyze an audio file for audible content.
This method loads the audio file, calculates amplitude levels across
the duration, and identifies segments where the amplitude exceeds
the silence threshold.
Args:
audio_path: Path to the audio file to analyze. Supports formats
that pydub/ffmpeg can read (FLAC, WAV, MP3, etc.)
Returns:
AnalysisResult containing:
- has_audible_content: Whether any audible content was found
- total_duration_seconds: Total duration of the audio
- audible_segments: List of detected audible segments
- recommended_selection: Recommendation for which instrumental
- Various statistics about the audible content
Raises:
FileNotFoundError: If the audio file doesn't exist
Exception: If the audio file cannot be loaded
"""
path = Path(audio_path)
if not path.exists():
raise FileNotFoundError(f"Audio file not found: {audio_path}")
logger.info(f"Analyzing audio file: {audio_path}")
# Load audio file
audio = AudioSegment.from_file(audio_path)
total_duration_ms = len(audio)
total_duration_seconds = total_duration_ms / 1000.0
logger.debug(f"Audio duration: {total_duration_seconds:.2f}s, "
f"channels: {audio.channels}, "
f"sample_rate: {audio.frame_rate}")
# Convert to mono for consistent analysis
if audio.channels > 1:
audio = audio.set_channels(1)
# Analyze amplitude in windows
audible_windows = self._find_audible_windows(audio)
# Merge adjacent windows into segments
raw_segments = self._windows_to_segments(audible_windows, audio)
# Merge close segments and filter short ones
segments = self._merge_and_filter_segments(raw_segments)
# Calculate statistics
total_audible_ms = sum(
seg.duration_seconds * 1000 for seg in segments
)
total_audible_seconds = total_audible_ms / 1000.0
audible_percentage = (
(total_audible_seconds / total_duration_seconds * 100)
if total_duration_seconds > 0 else 0.0
)
has_audible_content = len(segments) > 0
# Determine recommendation
recommended_selection = self._get_recommendation(
has_audible_content,
segments,
audible_percentage
)
logger.info(
f"Analysis complete: {len(segments)} segments, "
f"{audible_percentage:.1f}% audible, "
f"recommendation: {recommended_selection.value}"
)
return AnalysisResult(
has_audible_content=has_audible_content,
total_duration_seconds=total_duration_seconds,
audible_segments=segments,
recommended_selection=recommended_selection,
silence_threshold_db=self.silence_threshold_db,
total_audible_duration_seconds=total_audible_seconds,
audible_percentage=audible_percentage,
)
def get_amplitude_envelope(
self,
audio_path: str,
window_ms: int = 100,
normalize: bool = True,
) -> List[float]:
"""
Get the amplitude envelope for waveform visualization.
This method returns a list of amplitude values suitable for
rendering a waveform display. Each value represents the RMS
amplitude of a window of audio.
Args:
audio_path: Path to the audio file
window_ms: Size of each window in milliseconds. Smaller values
give more detail but larger data. Default is 100ms.
normalize: If True, normalize amplitudes to 0.0-1.0 range.
Default is True.
Returns:
List of amplitude values (floats). If normalize=True, values
are in the range [0.0, 1.0]. Otherwise, values are in dBFS.
"""
path = Path(audio_path)
if not path.exists():
raise FileNotFoundError(f"Audio file not found: {audio_path}")
audio = AudioSegment.from_file(audio_path)
# Convert to mono
if audio.channels > 1:
audio = audio.set_channels(1)
amplitudes = []
duration_ms = len(audio)
for start_ms in range(0, duration_ms, window_ms):
end_ms = min(start_ms + window_ms, duration_ms)
window = audio[start_ms:end_ms]
# Get RMS amplitude in dBFS
if window.rms > 0:
db = 20 * math.log10(window.rms / window.max_possible_amplitude)
else:
db = -100.0 # Effectively silent
amplitudes.append(db)
if normalize and amplitudes:
# Normalize to 0.0 - 1.0 range
# Map from [silence_threshold, 0] to [0, 1]
min_db = self.silence_threshold_db
max_db = 0.0
amplitudes = [
max(0.0, min(1.0, (db - min_db) / (max_db - min_db)))
for db in amplitudes
]
return amplitudes
def _find_audible_windows(
self,
audio: AudioSegment
) -> List[Tuple[int, float, float]]:
"""
Find windows with amplitude above the silence threshold.
Returns a list of tuples: (start_ms, avg_db, peak_db)
"""
audible_windows = []
duration_ms = len(audio)
for start_ms in range(0, duration_ms, self.window_ms):
end_ms = min(start_ms + self.window_ms, duration_ms)
window = audio[start_ms:end_ms]
# Calculate RMS amplitude in dB
if window.rms > 0:
avg_db = 20 * math.log10(window.rms / window.max_possible_amplitude)
# Peak is approximated as max sample value
peak_db = window.dBFS if hasattr(window, 'dBFS') else avg_db
else:
avg_db = -100.0
peak_db = -100.0
if avg_db > self.silence_threshold_db:
audible_windows.append((start_ms, avg_db, peak_db))
return audible_windows
def _windows_to_segments(
self,
audible_windows: List[Tuple[int, float, float]],
audio: AudioSegment
) -> List[AudibleSegment]:
"""
Convert list of audible windows into contiguous segments.
"""
if not audible_windows:
return []
segments = []
segment_start_ms = audible_windows[0][0]
segment_dbs = [audible_windows[0][1]]
segment_peaks = [audible_windows[0][2]]
last_end_ms = audible_windows[0][0] + self.window_ms
for i in range(1, len(audible_windows)):
start_ms, avg_db, peak_db = audible_windows[i]
# Check if this window is contiguous with the previous
gap_ms = start_ms - last_end_ms
if gap_ms <= self.window_ms:
# Extend current segment
segment_dbs.append(avg_db)
segment_peaks.append(peak_db)
last_end_ms = start_ms + self.window_ms
else:
# Save current segment and start a new one
segments.append(self._create_segment(
segment_start_ms, last_end_ms, segment_dbs, segment_peaks
))
segment_start_ms = start_ms
segment_dbs = [avg_db]
segment_peaks = [peak_db]
last_end_ms = start_ms + self.window_ms
# Don't forget the last segment
segments.append(self._create_segment(
segment_start_ms, last_end_ms, segment_dbs, segment_peaks
))
return segments
def _create_segment(
self,
start_ms: int,
end_ms: int,
dbs: List[float],
peaks: List[float]
) -> AudibleSegment:
"""Create an AudibleSegment from window data."""
return AudibleSegment(
start_seconds=start_ms / 1000.0,
end_seconds=end_ms / 1000.0,
duration_seconds=(end_ms - start_ms) / 1000.0,
avg_amplitude_db=sum(dbs) / len(dbs) if dbs else -100.0,
peak_amplitude_db=max(peaks) if peaks else -100.0,
)
def _merge_and_filter_segments(
self,
segments: List[AudibleSegment]
) -> List[AudibleSegment]:
"""
Merge segments that are close together and filter out short ones.
"""
if not segments:
return []
# Sort by start time
segments = sorted(segments, key=lambda s: s.start_seconds)
# Merge segments with small gaps
merged = []
current = segments[0]
for next_seg in segments[1:]:
gap_ms = (next_seg.start_seconds - current.end_seconds) * 1000
if gap_ms <= self.merge_gap_ms:
# Merge segments
combined_duration = (
next_seg.end_seconds - current.start_seconds
)
# Weight average amplitude by duration
total_duration = (
current.duration_seconds + next_seg.duration_seconds
)
weighted_avg_db = (
(current.avg_amplitude_db * current.duration_seconds +
next_seg.avg_amplitude_db * next_seg.duration_seconds)
/ total_duration
) if total_duration > 0 else -100.0
current = AudibleSegment(
start_seconds=current.start_seconds,
end_seconds=next_seg.end_seconds,
duration_seconds=combined_duration,
avg_amplitude_db=weighted_avg_db,
peak_amplitude_db=max(
current.peak_amplitude_db,
next_seg.peak_amplitude_db
),
)
else:
merged.append(current)
current = next_seg
merged.append(current)
# Filter out segments shorter than minimum duration
min_duration_seconds = self.min_segment_duration_ms / 1000.0
filtered = [
seg for seg in merged
if seg.duration_seconds >= min_duration_seconds
]
return filtered
def _get_recommendation(
self,
has_audible_content: bool,
segments: List[AudibleSegment],
audible_percentage: float
) -> RecommendedSelection:
"""
Determine the recommended instrumental selection.
Logic:
- If no audible content: recommend clean instrumental
- If audible content covers > 20% of the audio: likely has
meaningful backing vocals, recommend review
- Otherwise: minimal content, recommend clean
"""
if not has_audible_content:
return RecommendedSelection.CLEAN
# If there's significant audible content, recommend review
if audible_percentage > 20.0:
return RecommendedSelection.REVIEW_NEEDED
# If there are loud segments, recommend review
loud_segments = [seg for seg in segments if seg.is_loud]
if loud_segments:
return RecommendedSelection.REVIEW_NEEDED
# Minimal content - recommend clean
return RecommendedSelection.CLEAN
+322
View File
@@ -0,0 +1,322 @@
"""
Audio editor for creating custom instrumentals with muted regions.
This module provides the AudioEditor class which creates custom instrumental
tracks by muting specified regions of backing vocals audio and combining
it with the clean instrumental.
"""
import logging
import os
from pathlib import Path
from typing import List, Optional
from pydub import AudioSegment
from .models import CustomInstrumentalResult, MuteRegion
logger = logging.getLogger(__name__)
class AudioEditor:
"""
Creates custom instrumentals by muting regions of backing vocals.
This class is pure Python with no cloud dependencies. It works with
local file paths and uses pydub for audio manipulation.
The editor takes a clean instrumental and backing vocals track,
applies silence to specified regions of the backing vocals, and
combines them to create a custom instrumental track.
Example:
>>> editor = AudioEditor()
>>> mute_regions = [
... MuteRegion(start_seconds=45.0, end_seconds=48.5),
... MuteRegion(start_seconds=120.0, end_seconds=125.0),
... ]
>>> result = editor.create_custom_instrumental(
... clean_instrumental_path="/path/to/clean.flac",
... backing_vocals_path="/path/to/backing.flac",
... mute_regions=mute_regions,
... output_path="/path/to/custom.flac"
... )
>>> print(f"Created: {result.output_path}")
"""
def __init__(self, output_format: str = "flac"):
"""
Initialize the audio editor.
Args:
output_format: Output audio format. Default is "flac".
Supported formats depend on ffmpeg installation.
"""
self.output_format = output_format
def create_custom_instrumental(
self,
clean_instrumental_path: str,
backing_vocals_path: str,
mute_regions: List[MuteRegion],
output_path: str,
) -> CustomInstrumentalResult:
"""
Create a custom instrumental by muting regions of backing vocals.
This method:
1. Loads the clean instrumental and backing vocals tracks
2. Applies silence to the specified regions of the backing vocals
3. Combines the clean instrumental with the edited backing vocals
4. Exports the result to the specified output path
Args:
clean_instrumental_path: Path to the clean instrumental audio file
backing_vocals_path: Path to the backing vocals audio file
mute_regions: List of regions to mute in the backing vocals
output_path: Path where the output file should be saved
Returns:
CustomInstrumentalResult containing the output path and statistics
Raises:
FileNotFoundError: If input files don't exist
ValueError: If mute regions are invalid
"""
# Validate inputs
if not Path(clean_instrumental_path).exists():
raise FileNotFoundError(
f"Clean instrumental not found: {clean_instrumental_path}"
)
if not Path(backing_vocals_path).exists():
raise FileNotFoundError(
f"Backing vocals not found: {backing_vocals_path}"
)
# Normalize and validate mute regions
normalized_regions = self._normalize_mute_regions(mute_regions)
logger.info(
f"Creating custom instrumental with {len(normalized_regions)} "
f"mute regions"
)
# Load audio files
logger.debug(f"Loading clean instrumental: {clean_instrumental_path}")
clean_instrumental = AudioSegment.from_file(clean_instrumental_path)
logger.debug(f"Loading backing vocals: {backing_vocals_path}")
backing_vocals = AudioSegment.from_file(backing_vocals_path)
# Ensure same duration (use shorter one)
clean_duration_ms = len(clean_instrumental)
backing_duration_ms = len(backing_vocals)
if abs(clean_duration_ms - backing_duration_ms) > 1000:
logger.warning(
f"Duration mismatch: clean={clean_duration_ms}ms, "
f"backing={backing_duration_ms}ms. Using shorter duration."
)
target_duration_ms = min(clean_duration_ms, backing_duration_ms)
clean_instrumental = clean_instrumental[:target_duration_ms]
backing_vocals = backing_vocals[:target_duration_ms]
# Apply mute regions to backing vocals
edited_backing = self._apply_mute_regions(
backing_vocals, normalized_regions
)
# Combine: clean instrumental + edited backing vocals
# The backing vocals are mixed on top of the clean instrumental
combined = clean_instrumental.overlay(edited_backing)
# Ensure output directory exists
output_dir = Path(output_path).parent
output_dir.mkdir(parents=True, exist_ok=True)
# Export
logger.info(f"Exporting custom instrumental to: {output_path}")
combined.export(output_path, format=self.output_format)
# Calculate statistics with clamping to actual audio duration
output_duration_seconds = len(combined) / 1000.0
total_muted_ms = sum(
(min(r.end_seconds, output_duration_seconds) - max(r.start_seconds, 0)) * 1000
for r in normalized_regions
if r.start_seconds < output_duration_seconds # Skip regions entirely outside audio
)
return CustomInstrumentalResult(
output_path=output_path,
mute_regions_applied=normalized_regions,
total_muted_duration_seconds=max(0, total_muted_ms / 1000.0),
output_duration_seconds=output_duration_seconds,
)
def apply_mute_to_single_track(
self,
audio_path: str,
mute_regions: List[MuteRegion],
output_path: str,
) -> str:
"""
Apply mute regions to a single audio track.
This is useful for muting sections of backing vocals without
combining with the clean instrumental.
Args:
audio_path: Path to the input audio file
mute_regions: List of regions to mute
output_path: Path where the output file should be saved
Returns:
Path to the output file
"""
if not Path(audio_path).exists():
raise FileNotFoundError(f"Audio file not found: {audio_path}")
normalized_regions = self._normalize_mute_regions(mute_regions)
logger.info(f"Applying {len(normalized_regions)} mute regions to audio")
audio = AudioSegment.from_file(audio_path)
edited = self._apply_mute_regions(audio, normalized_regions)
output_dir = Path(output_path).parent
output_dir.mkdir(parents=True, exist_ok=True)
edited.export(output_path, format=self.output_format)
return output_path
def _normalize_mute_regions(
self,
regions: List[MuteRegion]
) -> List[MuteRegion]:
"""
Normalize mute regions: sort, validate, and merge overlapping ones.
"""
if not regions:
return []
# Validate regions
for region in regions:
if region.start_seconds < 0:
raise ValueError(
f"Mute region start cannot be negative: {region.start_seconds}"
)
if region.end_seconds <= region.start_seconds:
raise ValueError(
f"Mute region end ({region.end_seconds}) must be after "
f"start ({region.start_seconds})"
)
# Sort by start time
sorted_regions = sorted(regions, key=lambda r: r.start_seconds)
# Merge overlapping regions
merged = [sorted_regions[0]]
for region in sorted_regions[1:]:
last = merged[-1]
# Check if overlapping or adjacent
if region.start_seconds <= last.end_seconds:
# Merge
merged[-1] = MuteRegion(
start_seconds=last.start_seconds,
end_seconds=max(last.end_seconds, region.end_seconds)
)
else:
merged.append(region)
return merged
def _apply_mute_regions(
self,
audio: AudioSegment,
regions: List[MuteRegion]
) -> AudioSegment:
"""
Apply silence to the specified regions of an audio segment.
"""
if not regions:
return audio
duration_ms = len(audio)
result = audio
for region in regions:
start_ms = int(region.start_seconds * 1000)
end_ms = int(region.end_seconds * 1000)
# Clamp to audio boundaries
start_ms = max(0, start_ms)
end_ms = min(duration_ms, end_ms)
if start_ms >= end_ms:
continue
# Create silence segment
silence_duration = end_ms - start_ms
silence = AudioSegment.silent(
duration=silence_duration,
frame_rate=audio.frame_rate
)
# Replace the region with silence
before = result[:start_ms]
after = result[end_ms:]
result = before + silence + after
logger.debug(
f"Muted region: {start_ms/1000:.2f}s - {end_ms/1000:.2f}s"
)
return result
def preview_with_mutes(
self,
clean_instrumental_path: str,
backing_vocals_path: str,
mute_regions: List[MuteRegion],
output_path: Optional[str] = None,
) -> AudioSegment:
"""
Create a preview of the custom instrumental (in memory).
This is useful for creating temporary previews without saving
to disk. If output_path is provided, the preview is also saved.
Args:
clean_instrumental_path: Path to the clean instrumental
backing_vocals_path: Path to the backing vocals
mute_regions: Regions to mute
output_path: Optional path to save the preview
Returns:
AudioSegment of the preview
"""
clean_instrumental = AudioSegment.from_file(clean_instrumental_path)
backing_vocals = AudioSegment.from_file(backing_vocals_path)
# Match durations
target_duration = min(len(clean_instrumental), len(backing_vocals))
clean_instrumental = clean_instrumental[:target_duration]
backing_vocals = backing_vocals[:target_duration]
# Apply mutes
normalized = self._normalize_mute_regions(mute_regions)
edited_backing = self._apply_mute_regions(backing_vocals, normalized)
# Combine
combined = clean_instrumental.overlay(edited_backing)
if output_path:
Path(output_path).parent.mkdir(parents=True, exist_ok=True)
combined.export(output_path, format=self.output_format)
return combined
+171
View File
@@ -0,0 +1,171 @@
"""
Pydantic models for the instrumental review module.
These models define the data structures used for audio analysis results,
mute regions, and recommendations. They're designed to be serializable
to JSON for API responses.
"""
from enum import Enum
from typing import List, Optional
from pydantic import BaseModel, Field
class RecommendedSelection(str, Enum):
"""Recommendation for which instrumental to use."""
CLEAN = "clean"
"""Use clean instrumental - no backing vocals detected or recommended."""
WITH_BACKING = "with_backing"
"""Use instrumental with backing vocals - backing vocals sound good."""
REVIEW_NEEDED = "review_needed"
"""Human review needed - backing vocals detected but quality uncertain."""
class AudibleSegment(BaseModel):
"""A detected segment of audible content in the backing vocals."""
start_seconds: float = Field(
...,
ge=0,
description="Start time of the segment in seconds"
)
end_seconds: float = Field(
...,
ge=0,
description="End time of the segment in seconds"
)
duration_seconds: float = Field(
...,
ge=0,
description="Duration of the segment in seconds"
)
avg_amplitude_db: float = Field(
...,
description="Average amplitude of the segment in dB"
)
peak_amplitude_db: float = Field(
default=0.0,
description="Peak amplitude of the segment in dB"
)
@property
def is_loud(self) -> bool:
"""Check if this segment is relatively loud (> -20dB average)."""
return self.avg_amplitude_db > -20.0
class MuteRegion(BaseModel):
"""A region to mute in the backing vocals audio."""
start_seconds: float = Field(
...,
ge=0,
description="Start time of the region to mute in seconds"
)
end_seconds: float = Field(
...,
ge=0,
description="End time of the region to mute in seconds"
)
@property
def duration_seconds(self) -> float:
"""Duration of the mute region in seconds."""
return self.end_seconds - self.start_seconds
def overlaps(self, other: "MuteRegion") -> bool:
"""Check if this region overlaps with another."""
return not (self.end_seconds <= other.start_seconds or
self.start_seconds >= other.end_seconds)
def merge(self, other: "MuteRegion") -> "MuteRegion":
"""Merge this region with another overlapping region."""
return MuteRegion(
start_seconds=min(self.start_seconds, other.start_seconds),
end_seconds=max(self.end_seconds, other.end_seconds)
)
class AnalysisResult(BaseModel):
"""Result of analyzing backing vocals audio for audible content."""
has_audible_content: bool = Field(
...,
description="Whether any audible content was detected"
)
total_duration_seconds: float = Field(
...,
ge=0,
description="Total duration of the audio file in seconds"
)
audible_segments: List[AudibleSegment] = Field(
default_factory=list,
description="List of detected audible segments"
)
recommended_selection: RecommendedSelection = Field(
...,
description="Recommended instrumental selection based on analysis"
)
silence_threshold_db: float = Field(
default=-40.0,
description="Threshold used to detect silence (in dB)"
)
total_audible_duration_seconds: float = Field(
default=0.0,
ge=0,
description="Total duration of all audible segments combined"
)
audible_percentage: float = Field(
default=0.0,
ge=0,
le=100,
description="Percentage of audio that is audible"
)
waveform_data: Optional[List[float]] = Field(
default=None,
description="Amplitude envelope data for waveform rendering (optional)"
)
@property
def segment_count(self) -> int:
"""Number of audible segments detected."""
return len(self.audible_segments)
def get_segments_in_range(
self,
start_seconds: float,
end_seconds: float
) -> List[AudibleSegment]:
"""Get segments that overlap with the given time range."""
return [
seg for seg in self.audible_segments
if not (seg.end_seconds <= start_seconds or
seg.start_seconds >= end_seconds)
]
class CustomInstrumentalResult(BaseModel):
"""Result of creating a custom instrumental with muted regions."""
output_path: str = Field(
...,
description="Path to the created custom instrumental file"
)
mute_regions_applied: List[MuteRegion] = Field(
default_factory=list,
description="List of mute regions that were applied"
)
total_muted_duration_seconds: float = Field(
default=0.0,
ge=0,
description="Total duration of muted audio in seconds"
)
output_duration_seconds: float = Field(
default=0.0,
ge=0,
description="Duration of the output file in seconds"
)
+423
View File
@@ -0,0 +1,423 @@
"""
Local FastAPI server for instrumental review.
This module provides a local HTTP server that serves the instrumental review
UI for local CLI usage. It provides the same API endpoints as the cloud backend
to enable UI reuse.
Similar pattern to LyricsTranscriber's ReviewServer.
"""
import logging
import os
from pathlib import Path
import threading
import webbrowser
from typing import List, Optional
from fastapi import FastAPI, HTTPException, UploadFile, File
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import FileResponse, HTMLResponse
from pydantic import BaseModel
import shutil
import tempfile
import uvicorn
from pydub import AudioSegment
from karaoke_gen.instrumental_review import (
AnalysisResult,
AudioAnalyzer,
AudioEditor,
MuteRegion,
WaveformGenerator,
)
logger = logging.getLogger(__name__)
# Request/Response Models
class MuteRegionRequest(BaseModel):
start_seconds: float
end_seconds: float
class CreateCustomRequest(BaseModel):
mute_regions: List[MuteRegionRequest]
class SelectionRequest(BaseModel):
selection: str
class InstrumentalReviewServer:
"""
Local FastAPI server for instrumental review UI.
This server provides a web interface for reviewing and selecting
instrumental tracks in the local CLI workflow. It serves the same
API endpoints as the cloud backend to enable UI reuse.
"""
def __init__(
self,
output_dir: str,
base_name: str,
analysis: AnalysisResult,
waveform_path: str,
backing_vocals_path: str,
clean_instrumental_path: str,
with_backing_path: Optional[str] = None,
original_audio_path: Optional[str] = None,
):
"""
Initialize the review server.
Args:
output_dir: Directory containing the audio files
base_name: Base name for output files (e.g., "Artist - Title")
analysis: Analysis result from AudioAnalyzer
waveform_path: Path to the waveform image
backing_vocals_path: Path to the backing vocals audio file
clean_instrumental_path: Path to the clean instrumental audio file
with_backing_path: Path to the instrumental with backing vocals
original_audio_path: Path to the original audio file (with vocals)
"""
self.output_dir = output_dir
self.base_name = base_name
self.analysis = analysis
self.waveform_path = waveform_path
self.backing_vocals_path = backing_vocals_path
self.clean_instrumental_path = clean_instrumental_path
self.with_backing_path = with_backing_path
self.original_audio_path = original_audio_path
self.custom_instrumental_path: Optional[str] = None
self.uploaded_instrumental_path: Optional[str] = None
self.selection: Optional[str] = None
self._app: Optional[FastAPI] = None
self._server_thread: Optional[threading.Thread] = None
self._selection_event = threading.Event()
self._shutdown_event = threading.Event()
def _create_app(self) -> FastAPI:
"""Create and configure the FastAPI application."""
app = FastAPI(title="Instrumental Review", docs_url=None, redoc_url=None)
# Configure CORS
app.add_middleware(
CORSMiddleware,
allow_origins=["*"],
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
# Register routes
self._register_routes(app)
return app
def _register_routes(self, app: FastAPI) -> None:
"""Register API routes."""
@app.get("/")
async def serve_frontend():
"""Serve the frontend HTML."""
return HTMLResponse(content=self._get_frontend_html())
@app.get("/api/jobs/local/instrumental-analysis")
async def get_analysis():
"""Get analysis data for the instrumental review."""
return {
"job_id": "local",
"artist": self.base_name.split(" - ")[0] if " - " in self.base_name else "",
"title": self.base_name.split(" - ")[1] if " - " in self.base_name else self.base_name,
"status": "awaiting_instrumental_selection",
"analysis": {
"has_audible_content": self.analysis.has_audible_content,
"total_duration_seconds": self.analysis.total_duration_seconds,
"audible_segments": [
{
"start_seconds": seg.start_seconds,
"end_seconds": seg.end_seconds,
"duration_seconds": seg.duration_seconds,
"avg_amplitude_db": seg.avg_amplitude_db,
"peak_amplitude_db": seg.peak_amplitude_db,
}
for seg in self.analysis.audible_segments
],
"recommended_selection": self.analysis.recommended_selection.value,
"total_audible_duration_seconds": self.analysis.total_audible_duration_seconds,
"audible_percentage": self.analysis.audible_percentage,
"silence_threshold_db": self.analysis.silence_threshold_db,
},
"audio_urls": {
"clean_instrumental": "/api/audio/clean_instrumental" if self.clean_instrumental_path else None,
"backing_vocals": "/api/audio/backing_vocals" if self.backing_vocals_path else None,
"with_backing": "/api/audio/with_backing" if self.with_backing_path else None,
"custom_instrumental": "/api/audio/custom_instrumental" if self.custom_instrumental_path else None,
"uploaded_instrumental": "/api/audio/uploaded_instrumental" if self.uploaded_instrumental_path else None,
"original": "/api/audio/original" if self.original_audio_path else None,
},
"waveform_url": "/api/waveform" if self.waveform_path else None,
"has_custom_instrumental": self.custom_instrumental_path is not None,
"has_uploaded_instrumental": self.uploaded_instrumental_path is not None,
"has_original": self.original_audio_path is not None,
}
@app.get("/api/jobs/local/waveform-data")
async def get_waveform_data(num_points: int = 600):
"""Get waveform amplitude data for client-side rendering."""
# Validate num_points parameter
if num_points <= 0 or num_points > 10000:
raise HTTPException(
status_code=400,
detail="num_points must be between 1 and 10000"
)
if not self.backing_vocals_path or not os.path.exists(self.backing_vocals_path):
raise HTTPException(status_code=404, detail="Backing vocals file not found")
try:
generator = WaveformGenerator()
amplitudes, duration = generator.generate_data_only(self.backing_vocals_path, num_points)
return {"amplitudes": amplitudes, "duration": duration}
except Exception as e:
logger.exception(f"Error generating waveform data: {e}")
raise HTTPException(status_code=500, detail=str(e)) from e
@app.get("/api/audio/{stem_type}")
async def stream_audio(stem_type: str):
"""Stream audio file."""
path_map = {
"clean_instrumental": self.clean_instrumental_path,
"backing_vocals": self.backing_vocals_path,
"with_backing": self.with_backing_path,
"custom_instrumental": self.custom_instrumental_path,
"uploaded_instrumental": self.uploaded_instrumental_path,
"original": self.original_audio_path,
}
audio_path = path_map.get(stem_type)
if not audio_path or not os.path.exists(audio_path):
raise HTTPException(status_code=404, detail=f"Audio file not found: {stem_type}")
# Determine content type
ext = os.path.splitext(audio_path)[1].lower()
content_types = {
".flac": "audio/flac",
".mp3": "audio/mpeg",
".wav": "audio/wav",
}
content_type = content_types.get(ext, "application/octet-stream")
return FileResponse(audio_path, media_type=content_type)
@app.get("/api/waveform")
async def get_waveform_image():
"""Serve waveform image."""
if not self.waveform_path or not os.path.exists(self.waveform_path):
raise HTTPException(status_code=404, detail="Waveform image not found")
return FileResponse(self.waveform_path, media_type="image/png")
@app.post("/api/jobs/local/create-custom-instrumental")
async def create_custom_instrumental(request: CreateCustomRequest):
"""Create a custom instrumental with muted regions."""
if not request.mute_regions:
raise HTTPException(status_code=400, detail="No mute regions provided")
try:
mute_regions = [
MuteRegion(
start_seconds=r.start_seconds,
end_seconds=r.end_seconds,
)
for r in request.mute_regions
]
editor = AudioEditor()
output_path = os.path.join(
self.output_dir,
f"{self.base_name} (Instrumental Custom).flac"
)
result = editor.create_custom_instrumental(
clean_instrumental_path=self.clean_instrumental_path,
backing_vocals_path=self.backing_vocals_path,
mute_regions=mute_regions,
output_path=output_path,
)
self.custom_instrumental_path = result.output_path
return {
"status": "success",
"custom_instrumental_url": "/api/audio/custom_instrumental",
"statistics": {
"mute_regions_applied": len(result.mute_regions_applied),
"total_muted_duration_seconds": result.total_muted_duration_seconds,
"output_duration_seconds": result.output_duration_seconds,
},
}
except Exception as e:
logger.exception(f"Error creating custom instrumental: {e}")
raise HTTPException(status_code=500, detail=str(e)) from e
@app.post("/api/jobs/local/upload-instrumental")
async def upload_instrumental(file: UploadFile = File(...)):
"""Upload a custom instrumental audio file."""
# Validate file type
allowed_extensions = {".flac", ".mp3", ".wav", ".m4a", ".ogg"}
ext = os.path.splitext(file.filename or "")[1].lower()
if ext not in allowed_extensions:
raise HTTPException(
status_code=400,
detail=f"Invalid file type. Allowed: {', '.join(allowed_extensions)}"
)
tmp_path = None
file_moved = False
try:
# Save to temp file first to validate
with tempfile.NamedTemporaryFile(delete=False, suffix=ext) as tmp:
shutil.copyfileobj(file.file, tmp)
tmp_path = tmp.name
# Load and check duration
uploaded_audio = AudioSegment.from_file(tmp_path)
uploaded_duration = len(uploaded_audio) / 1000.0 # ms to seconds
expected_duration = self.analysis.total_duration_seconds
duration_diff = abs(uploaded_duration - expected_duration)
if duration_diff > 0.5:
raise HTTPException(
status_code=400,
detail=f"Duration mismatch: uploaded file is {uploaded_duration:.2f}s, "
f"expected {expected_duration:.2f}s (±0.5s allowed)"
)
# Move to final location
output_path = os.path.join(
self.output_dir,
f"{self.base_name} (Instrumental Uploaded){ext}"
)
shutil.move(tmp_path, output_path)
file_moved = True
self.uploaded_instrumental_path = output_path
return {
"status": "success",
"uploaded_instrumental_url": "/api/audio/uploaded_instrumental",
"duration_seconds": uploaded_duration,
"filename": file.filename,
}
except HTTPException:
raise
except Exception as e:
logger.exception(f"Error uploading instrumental: {e}")
raise HTTPException(status_code=500, detail=str(e)) from e
finally:
# Clean up temp file if it wasn't moved
if tmp_path and not file_moved and os.path.exists(tmp_path):
try:
os.unlink(tmp_path)
except OSError:
pass # Best effort cleanup
@app.post("/api/jobs/local/select-instrumental")
async def select_instrumental(request: SelectionRequest):
"""Submit instrumental selection."""
if request.selection not in ("clean", "with_backing", "custom", "uploaded", "original"):
raise HTTPException(status_code=400, detail=f"Invalid selection: {request.selection}")
self.selection = request.selection
self._selection_event.set()
return {"status": "success", "selection": request.selection}
@staticmethod
def _get_static_dir() -> Path:
"""Get the path to the static assets directory."""
return Path(__file__).parent / "static"
def _get_frontend_html(self) -> str:
"""Return the frontend HTML by reading from the static file."""
static_file = self._get_static_dir() / "index.html"
if static_file.exists():
return static_file.read_text(encoding="utf-8")
else:
# Fallback error message if file is missing
return """<!DOCTYPE html>
<html>
<head><title>Error</title></head>
<body style="background:#1a1a1a;color:#fff;font-family:sans-serif;padding:2rem;">
<h1>Frontend assets not found</h1>
<p>The static/index.html file is missing from the instrumental_review module.</p>
</body>
</html>"""
def start_and_open_browser(self, port: int = 8765) -> str:
"""
Start server, open browser, and block until selection is submitted.
Args:
port: Port to run the server on
Returns:
The user's selection ("clean", "with_backing", or "custom")
"""
self._app = self._create_app()
# Run uvicorn in a separate thread
config = uvicorn.Config(
self._app,
host="127.0.0.1",
port=port,
log_level="warning",
)
server = uvicorn.Server(config)
def run_server():
server.run()
self._server_thread = threading.Thread(target=run_server, daemon=True)
self._server_thread.start()
# Wait a moment for server to start
import time
time.sleep(0.5)
url = f"http://localhost:{port}/"
logger.info(f"Instrumental review server started at {url}")
# Open browser
webbrowser.open(url)
# Wait for selection
logger.info("Waiting for instrumental selection...")
self._selection_event.wait()
# Give a moment for response to be sent
time.sleep(0.5)
return self.get_selection()
def stop(self) -> None:
"""Stop the server."""
self._shutdown_event.set()
def get_selection(self) -> str:
"""Get the user's selection."""
if self.selection is None:
raise ValueError("No selection has been made")
return self.selection
def get_custom_instrumental_path(self) -> Optional[str]:
"""Get the path to the custom instrumental if one was created."""
return self.custom_instrumental_path
def get_uploaded_instrumental_path(self) -> Optional[str]:
"""Get the path to the uploaded instrumental if one was uploaded."""
return self.uploaded_instrumental_path
File diff suppressed because it is too large. Load diff
+409
View File
@@ -0,0 +1,409 @@
"""
Waveform visualization generator for audio files.
This module provides the WaveformGenerator class which creates waveform
images suitable for display in the instrumental review UI.
"""
import logging
import math
from pathlib import Path
from typing import List, Optional, Tuple
import matplotlib
matplotlib.use('Agg') # Use non-interactive backend
import matplotlib.pyplot as plt
import numpy as np
from pydub import AudioSegment
from .models import AudibleSegment, MuteRegion
logger = logging.getLogger(__name__)
class WaveformGenerator:
"""
Generates waveform visualization images from audio files.
This class creates PNG images showing the amplitude envelope of an
audio file over time. It can highlight detected audible segments
and mute regions with different colors.
The generated images are suitable for display in web UIs and can
be used for interactive seeking (click-to-seek) functionality.
Attributes:
width: Width of the output image in pixels (default: 1200)
height: Height of the output image in pixels (default: 200)
background_color: Background color (default: "#1a1a2e")
waveform_color: Main waveform color (default: "#4a90d9")
segment_color: Color for audible segments (default: "#e94560")
mute_color: Color for mute regions (default: "#ff6b6b")
time_axis_color: Color for time axis (default: "#ffffff")
Example:
>>> generator = WaveformGenerator(width=1200, height=200)
>>> generator.generate(
... audio_path="/path/to/backing_vocals.flac",
... output_path="/path/to/waveform.png",
... segments=analysis_result.audible_segments
... )
"""
def __init__(
self,
width: int = 1200,
height: int = 200,
background_color: str = "#1a1a2e",
waveform_color: str = "#4a90d9",
segment_color: str = "#e94560",
mute_color: str = "#ff6b6b",
time_axis_color: str = "#ffffff",
dpi: int = 100,
):
"""
Initialize the waveform generator.
Args:
width: Width of the output image in pixels
height: Height of the output image in pixels
background_color: Background color (hex or named color)
waveform_color: Main waveform color
segment_color: Color for highlighting audible segments
mute_color: Color for highlighting mute regions
time_axis_color: Color for time axis labels
dpi: DPI for the output image
"""
self.width = width
self.height = height
self.background_color = background_color
self.waveform_color = waveform_color
self.segment_color = segment_color
self.mute_color = mute_color
self.time_axis_color = time_axis_color
self.dpi = dpi
def generate(
self,
audio_path: str,
output_path: str,
segments: Optional[List[AudibleSegment]] = None,
mute_regions: Optional[List[MuteRegion]] = None,
show_time_axis: bool = True,
silence_threshold_db: float = -40.0,
) -> str:
"""
Generate a waveform image from an audio file.
Args:
audio_path: Path to the audio file
output_path: Path where the PNG image will be saved
segments: Optional list of audible segments to highlight
mute_regions: Optional list of mute regions to highlight
show_time_axis: Whether to show time axis labels
silence_threshold_db: Threshold for visual reference line
Returns:
Path to the generated image file
Raises:
FileNotFoundError: If the audio file doesn't exist
"""
path = Path(audio_path)
if not path.exists():
raise FileNotFoundError(f"Audio file not found: {audio_path}")
logger.info(f"Generating waveform for: {audio_path}")
# Load audio
audio = AudioSegment.from_file(audio_path)
duration_seconds = len(audio) / 1000.0
# Convert to mono if needed
if audio.channels > 1:
audio = audio.set_channels(1)
# Get amplitude envelope
envelope = self._get_envelope(audio)
# Create the figure
fig, ax = self._create_figure(duration_seconds, show_time_axis)
# Draw waveform
self._draw_waveform(ax, envelope, duration_seconds)
# Highlight mute regions (if any) - draw first so waveform is on top
if mute_regions:
self._draw_mute_regions(ax, mute_regions, duration_seconds)
# Highlight audible segments (if any)
if segments:
self._draw_segments(ax, segments, envelope, duration_seconds)
# Draw silence threshold reference line
self._draw_threshold_line(ax, silence_threshold_db, duration_seconds)
# Save the figure
output_dir = Path(output_path).parent
output_dir.mkdir(parents=True, exist_ok=True)
fig.savefig(
output_path,
facecolor=self.background_color,
edgecolor='none',
bbox_inches='tight',
pad_inches=0.1,
)
plt.close(fig)
logger.info(f"Waveform saved to: {output_path}")
return output_path
def generate_data_only(
self,
audio_path: str,
num_points: int = 500,
) -> Tuple[List[float], float]:
"""
Generate waveform data without creating an image.
This is useful for sending data to a frontend that will
render the waveform itself (e.g., using Canvas or SVG).
Args:
audio_path: Path to the audio file
num_points: Number of data points to return
Returns:
Tuple of (amplitude_values, duration_seconds)
Amplitude values are normalized to 0.0-1.0 range.
"""
path = Path(audio_path)
if not path.exists():
raise FileNotFoundError(f"Audio file not found: {audio_path}")
audio = AudioSegment.from_file(audio_path)
duration_seconds = len(audio) / 1000.0
if audio.channels > 1:
audio = audio.set_channels(1)
# Calculate window size to get desired number of points
duration_ms = len(audio)
window_ms = max(1, duration_ms // num_points)
amplitudes = []
for start_ms in range(0, duration_ms, window_ms):
end_ms = min(start_ms + window_ms, duration_ms)
window = audio[start_ms:end_ms]
if window.rms > 0:
db = 20 * math.log10(window.rms / window.max_possible_amplitude)
else:
db = -100.0
# Normalize to 0-1 range (mapping -60dB to 0dB -> 0 to 1)
normalized = max(0.0, min(1.0, (db + 60) / 60))
amplitudes.append(normalized)
return amplitudes, duration_seconds
def _get_envelope(
self,
audio: AudioSegment,
window_ms: int = 50,
) -> np.ndarray:
"""
Extract amplitude envelope from audio.
Returns array of amplitude values in dB.
"""
duration_ms = len(audio)
amplitudes = []
for start_ms in range(0, duration_ms, window_ms):
end_ms = min(start_ms + window_ms, duration_ms)
window = audio[start_ms:end_ms]
if window.rms > 0:
db = 20 * math.log10(window.rms / window.max_possible_amplitude)
else:
db = -100.0
amplitudes.append(db)
return np.array(amplitudes)
def _create_figure(
self,
duration_seconds: float,
show_time_axis: bool,
) -> Tuple[plt.Figure, plt.Axes]:
"""
Create matplotlib figure and axes.
"""
fig_width = self.width / self.dpi
fig_height = self.height / self.dpi
fig, ax = plt.subplots(figsize=(fig_width, fig_height), dpi=self.dpi)
# Set background
fig.patch.set_facecolor(self.background_color)
ax.set_facecolor(self.background_color)
# Configure axes
ax.set_xlim(0, duration_seconds)
ax.set_ylim(-60, 0) # dB range
# Remove spines
for spine in ax.spines.values():
spine.set_visible(False)
# Configure ticks
if show_time_axis:
ax.tick_params(
axis='x',
colors=self.time_axis_color,
labelsize=8,
)
ax.tick_params(axis='y', left=False, labelleft=False)
# Set time axis ticks
self._set_time_ticks(ax, duration_seconds)
else:
ax.tick_params(
axis='both',
left=False,
bottom=False,
labelleft=False,
labelbottom=False,
)
return fig, ax
def _set_time_ticks(self, ax: plt.Axes, duration_seconds: float):
"""
Set appropriate time axis tick marks.
"""
if duration_seconds <= 60:
# Under 1 minute: tick every 10 seconds
tick_interval = 10
elif duration_seconds <= 300:
# Under 5 minutes: tick every 30 seconds
tick_interval = 30
else:
# Over 5 minutes: tick every minute
tick_interval = 60
ticks = np.arange(0, duration_seconds + 1, tick_interval)
ax.set_xticks(ticks)
# Format tick labels as MM:SS
labels = []
for t in ticks:
minutes = int(t // 60)
seconds = int(t % 60)
labels.append(f"{minutes}:{seconds:02d}")
ax.set_xticklabels(labels)
def _draw_waveform(
self,
ax: plt.Axes,
envelope: np.ndarray,
duration_seconds: float,
):
"""
Draw the main waveform.
"""
num_points = len(envelope)
time_points = np.linspace(0, duration_seconds, num_points)
# Draw as filled area
ax.fill_between(
time_points,
envelope,
-60, # Bottom of range
color=self.waveform_color,
alpha=0.7,
)
# Draw outline
ax.plot(
time_points,
envelope,
color=self.waveform_color,
linewidth=0.5,
alpha=0.9,
)
def _draw_segments(
self,
ax: plt.Axes,
segments: List[AudibleSegment],
envelope: np.ndarray,
duration_seconds: float,
):
"""
Highlight audible segments on the waveform.
"""
num_points = len(envelope)
time_points = np.linspace(0, duration_seconds, num_points)
for segment in segments:
# Find indices corresponding to this segment
start_idx = int(segment.start_seconds / duration_seconds * num_points)
end_idx = int(segment.end_seconds / duration_seconds * num_points)
start_idx = max(0, min(start_idx, num_points - 1))
end_idx = max(0, min(end_idx, num_points))
if start_idx >= end_idx:
continue
segment_time = time_points[start_idx:end_idx]
segment_envelope = envelope[start_idx:end_idx]
# Highlight this segment with a different color
ax.fill_between(
segment_time,
segment_envelope,
-60,
color=self.segment_color,
alpha=0.6,
)
def _draw_mute_regions(
self,
ax: plt.Axes,
mute_regions: List[MuteRegion],
duration_seconds: float,
):
"""
Draw mute region overlays.
"""
for region in mute_regions:
ax.axvspan(
region.start_seconds,
region.end_seconds,
color=self.mute_color,
alpha=0.3,
zorder=0,
)
def _draw_threshold_line(
self,
ax: plt.Axes,
threshold_db: float,
duration_seconds: float,
):
"""
Draw a reference line at the silence threshold.
"""
ax.axhline(
y=threshold_db,
color=self.time_axis_color,
linestyle='--',
linewidth=0.5,
alpha=0.3,
)
@@ -47,6 +47,7 @@ class KaraokeFinalise:
user_youtube_credentials=None, # Add support for pre-stored credentials
server_side_mode=False, # New parameter for server-side deployment
selected_instrumental_file=None, # Add support for pre-selected instrumental file
countdown_padding_seconds=None, # Padding applied to vocals; instrumental must match
):
self.log_level = log_level
self.log_formatter = log_formatter
@@ -54,6 +55,9 @@ class KaraokeFinalise:
if logger is None:
self.logger = logging.getLogger(__name__)
self.logger.setLevel(log_level)
# Prevent log propagation to root logger to avoid duplicate logs
# when external packages (like lyrics_converter) configure root logger handlers
self.logger.propagate = False
self.log_handler = logging.StreamHandler()
@@ -105,6 +109,7 @@ class KaraokeFinalise:
self.user_youtube_credentials = user_youtube_credentials
self.server_side_mode = server_side_mode
self.selected_instrumental_file = selected_instrumental_file
self.countdown_padding_seconds = countdown_padding_seconds
self.suffixes = {
"title_mov": " (Title).mov",
@@ -421,6 +426,15 @@ class KaraokeFinalise:
# Check if any videos were found
if "items" in response and len(response["items"]) > 0:
for item in response["items"]:
# YouTube search API sometimes returns results from other channels even with channelId filter
# Verify the video actually belongs to our channel
result_channel_id = item["snippet"]["channelId"]
if result_channel_id != channel_id:
self.logger.debug(
f"Skipping video from different channel: {item['snippet']['title']} (channel: {result_channel_id})"
)
continue
found_title = item["snippet"]["title"]
# In server-side mode, require an exact match to avoid false positives.
@@ -720,6 +734,32 @@ class KaraokeFinalise:
artist, title = base_name.split(" - ", 1)
return base_name, artist, title
def _pad_audio_file(self, input_audio, output_audio, padding_seconds):
"""
Pad an audio file by prepending silence at the beginning.
Uses the same ffmpeg approach as LyricsTranscriber's CountdownProcessor
to ensure consistent padding behavior.
Args:
input_audio: Path to input audio file
output_audio: Path for the padded output file
padding_seconds: Amount of silence to prepend (in seconds)
"""
self.logger.info(f"Padding audio file with {padding_seconds}s of silence")
# Use ffmpeg to prepend silence - this matches the approach in audio_processor.py
# adelay filter adds delay in milliseconds
delay_ms = int(padding_seconds * 1000)
ffmpeg_command = (
f'{self.ffmpeg_base_command} -i "{input_audio}" '
f'-af "adelay={delay_ms}|{delay_ms}" '
f'"{output_audio}"'
)
self.execute_command(ffmpeg_command, f"Padding audio with {padding_seconds}s silence")
def execute_command(self, command, description):
"""Execute a shell command and log the output. For general commands (rclone, etc.)"""
self.logger.info(f"{description}")
@@ -764,11 +804,32 @@ class KaraokeFinalise:
def remux_with_instrumental(self, with_vocals_file, instrumental_audio, output_file):
"""Remux the video with instrumental audio to create karaoke version"""
# Safety net: If countdown padding was applied to vocals, ensure instrumental is padded too
actual_instrumental = instrumental_audio
if self.countdown_padding_seconds and self.countdown_padding_seconds > 0:
# Check if the instrumental file is already padded (has "(Padded)" in name)
if "(Padded)" not in instrumental_audio:
self.logger.warning(
f"Countdown padding ({self.countdown_padding_seconds}s) was applied to vocals, "
f"but instrumental doesn't appear to be padded. Creating padded version..."
)
# Create a padded version of the instrumental
base, ext = os.path.splitext(instrumental_audio)
padded_instrumental = f"{base} (Padded){ext}"
if not os.path.exists(padded_instrumental):
self._pad_audio_file(instrumental_audio, padded_instrumental, self.countdown_padding_seconds)
self.logger.info(f"Created padded instrumental: {padded_instrumental}")
actual_instrumental = padded_instrumental
else:
self.logger.info(f"Using already-padded instrumental: {instrumental_audio}")
# This operation is primarily I/O bound (remuxing), so hardware acceleration doesn't provide significant benefit
# Keep the existing approach but use the new execute method
ffmpeg_command = (
f'{self.ffmpeg_base_command} -an -i "{with_vocals_file}" '
f'-vn -i "{instrumental_audio}" -c:v copy -c:a pcm_s16le "{output_file}"'
f'-vn -i "{actual_instrumental}" -c:v copy -c:a pcm_s16le "{output_file}"'
)
self.execute_command(ffmpeg_command, "Remuxing video with instrumental audio")
+114 -1
View File
@@ -29,7 +29,7 @@ from .audio_processor import AudioProcessor
from .lyrics_processor import LyricsProcessor
from .video_generator import VideoGenerator
from .video_background_processor import VideoBackgroundProcessor
from .audio_fetcher import create_audio_fetcher, AudioFetcherError, NoResultsError
from .audio_fetcher import create_audio_fetcher, AudioFetcherError, NoResultsError, UserCancelledError
class KaraokePrep:
@@ -84,6 +84,9 @@ class KaraokePrep:
if logger is None:
self.logger = logging.getLogger(__name__)
self.logger.setLevel(log_level)
# Prevent log propagation to root logger to avoid duplicate logs
# when external packages (like lyrics_converter) configure root logger handlers
self.logger.propagate = False
self.log_handler = logging.StreamHandler()
@@ -256,6 +259,101 @@ class KaraokePrep:
self.artist = metadata_result["artist"]
self.title = metadata_result["title"]
def _scan_directory_for_instrumentals(self, track_output_dir, artist_title):
"""
Scan the directory for existing instrumental files and build a separated_audio structure.
This is used when transcription was skipped (existing files found) but we need to
pad instrumentals due to countdown padding.
Args:
track_output_dir: The track output directory to scan
artist_title: The "{artist} - {title}" string for matching files
Returns:
Dictionary with separated_audio structure containing found instrumental paths
"""
self.logger.info(f"Scanning directory for existing instrumentals: {track_output_dir}")
separated_audio = {
"clean_instrumental": {},
"backing_vocals": {},
"other_stems": {},
"combined_instrumentals": {},
}
# Search patterns for instrumental files
# Files are named like: "{artist} - {title} (Instrumental {model}).flac"
# Or with backing vocals: "{artist} - {title} (Instrumental +BV {model}).flac"
# Look for files in the track output directory
search_dir = track_output_dir
# Find all instrumental files (not padded ones - we want the originals)
instrumental_pattern = os.path.join(search_dir, f"{artist_title} (Instrumental*.flac")
instrumental_files = glob.glob(instrumental_pattern)
# Also check for wav files
instrumental_pattern_wav = os.path.join(search_dir, f"{artist_title} (Instrumental*.wav")
instrumental_files.extend(glob.glob(instrumental_pattern_wav))
self.logger.debug(f"Found {len(instrumental_files)} instrumental files")
for filepath in instrumental_files:
filename = os.path.basename(filepath)
# Skip already padded files
if "(Padded)" in filename:
self.logger.debug(f"Skipping already padded file: {filename}")
continue
# Determine if it's a combined instrumental (+BV) or clean instrumental
if "+BV" in filename or "+bv" in filename.lower():
# Combined instrumental with backing vocals
# Extract model name from filename
# Pattern: "(Instrumental +BV {model}).flac"
model_match = re.search(r'\(Instrumental \+BV ([^)]+)\)', filename)
if model_match:
model_name = model_match.group(1).strip()
separated_audio["combined_instrumentals"][model_name] = filepath
self.logger.info(f"Found combined instrumental: {filename}")
else:
# Clean instrumental (no backing vocals)
# Pattern: "(Instrumental {model}).flac"
model_match = re.search(r'\(Instrumental ([^)]+)\)', filename)
if model_match:
# Use as clean instrumental if we don't have one yet
if not separated_audio["clean_instrumental"].get("instrumental"):
separated_audio["clean_instrumental"]["instrumental"] = filepath
self.logger.info(f"Found clean instrumental: {filename}")
else:
# Additional clean instrumentals go to combined_instrumentals for padding
model_name = model_match.group(1).strip()
separated_audio["combined_instrumentals"][model_name] = filepath
self.logger.info(f"Found additional instrumental: {filename}")
# Also look for backing vocals files
backing_vocals_pattern = os.path.join(search_dir, f"{artist_title} (Backing Vocals*.flac")
backing_vocals_files = glob.glob(backing_vocals_pattern)
backing_vocals_pattern_wav = os.path.join(search_dir, f"{artist_title} (Backing Vocals*.wav")
backing_vocals_files.extend(glob.glob(backing_vocals_pattern_wav))
for filepath in backing_vocals_files:
filename = os.path.basename(filepath)
model_match = re.search(r'\(Backing Vocals ([^)]+)\)', filename)
if model_match:
model_name = model_match.group(1).strip()
if model_name not in separated_audio["backing_vocals"]:
separated_audio["backing_vocals"][model_name] = {"backing_vocals": filepath}
self.logger.info(f"Found backing vocals: {filename}")
# Log summary
clean_count = 1 if separated_audio["clean_instrumental"].get("instrumental") else 0
combined_count = len(separated_audio["combined_instrumentals"])
self.logger.info(f"Directory scan complete: {clean_count} clean instrumental, {combined_count} combined instrumentals")
return separated_audio
async def prep_single_track(self):
# Add signal handler at the start
loop = asyncio.get_running_loop()
@@ -419,6 +517,9 @@ class KaraokePrep:
# No still image for audio-only downloads
processed_track["input_still_image"] = None
except UserCancelledError:
# User cancelled - propagate up to CLI for graceful exit
raise
except NoResultsError as e:
self.logger.error(f"No audio found: {e}")
return None
@@ -761,6 +862,18 @@ class KaraokePrep:
f"Applying {padding_seconds}s padding to all instrumental files to sync with vocal countdown"
)
# If separated_audio is empty (e.g., transcription was skipped but existing files have countdown),
# scan the directory for existing instrumental files
has_instrumentals = (
processed_track["separated_audio"].get("clean_instrumental", {}).get("instrumental") or
processed_track["separated_audio"].get("combined_instrumentals")
)
if not has_instrumentals:
self.logger.info("No instrumentals in separated_audio, scanning directory for existing files...")
processed_track["separated_audio"] = self._scan_directory_for_instrumentals(
track_output_dir, artist_title
)
# Apply padding using AudioProcessor
padded_separation_result = self.audio_processor.apply_countdown_padding_to_instrumentals(
separation_result=processed_track["separated_audio"],
+81 -4
View File
@@ -11,6 +11,9 @@ from .utils import sanitize_filename
# Placeholder class or functions for lyrics processing
class LyricsProcessor:
# Standard countdown padding duration used by LyricsTranscriber
COUNTDOWN_PADDING_SECONDS = 3.0
def __init__(
self, logger, style_params_json, lyrics_file, skip_transcription, skip_transcription_review, render_video, subtitle_offset_ms
):
@@ -22,6 +25,60 @@ class LyricsProcessor:
self.render_video = render_video
self.subtitle_offset_ms = subtitle_offset_ms
def _detect_countdown_padding_from_lrc(self, lrc_filepath):
"""
Detect if countdown padding was applied by checking the first lyric timestamp in the LRC file.
LRC format timestamps look like: [mm:ss.xx] or [mm:ss.xxx]
If the first lyric timestamp is >= 3.0 seconds, countdown padding was likely applied.
Args:
lrc_filepath: Path to the LRC file
Returns:
Tuple of (countdown_padding_added: bool, countdown_padding_seconds: float)
"""
try:
with open(lrc_filepath, 'r', encoding='utf-8') as f:
content = f.read()
# Find all timestamp patterns in the LRC file
# LRC timestamps: [mm:ss.xx] or [mm:ss.xxx]
timestamp_pattern = r'\[(\d{1,2}):(\d{2})\.(\d{2,3})\]'
matches = re.findall(timestamp_pattern, content)
if not matches:
self.logger.debug("No timestamps found in LRC file")
return (False, 0.0)
# Find the first non-metadata timestamp (metadata like [ar:Artist] doesn't have decimal)
# We already filtered for decimal timestamps in our pattern
first_timestamp = matches[0]
minutes = int(first_timestamp[0])
seconds = int(first_timestamp[1])
# Handle both .xx and .xxx formats
centiseconds = first_timestamp[2]
if len(centiseconds) == 2:
milliseconds = int(centiseconds) * 10
else:
milliseconds = int(centiseconds)
first_lyric_time = minutes * 60 + seconds + milliseconds / 1000.0
self.logger.debug(f"First lyric timestamp in LRC: {first_lyric_time:.3f}s")
# If first lyric is at or after 3 seconds, countdown padding was applied
# Use a small buffer (2.5s) to account for songs that naturally start a bit late
if first_lyric_time >= 2.5:
self.logger.info(f"Detected countdown padding from LRC: first lyric at {first_lyric_time:.2f}s")
return (True, self.COUNTDOWN_PADDING_SECONDS)
return (False, 0.0)
except Exception as e:
self.logger.warning(f"Failed to detect countdown padding from LRC file: {e}")
return (False, 0.0)
def find_best_split_point(self, line):
"""
Find the best split point in a line based on the specified criteria.
@@ -138,23 +195,43 @@ class LyricsProcessor:
lyrics_video_path = os.path.join(lyrics_dir, f"{sanitized_artist} - {sanitized_title} (With Vocals).mkv")
lyrics_lrc_path = os.path.join(lyrics_dir, f"{sanitized_artist} - {sanitized_title} (Karaoke).lrc")
# If files exist in parent directory, return early
# If files exist in parent directory, return early (but detect countdown padding first)
if os.path.exists(parent_video_path) and os.path.exists(parent_lrc_path):
self.logger.info(f"Found existing video and LRC files in parent directory, skipping transcription")
self.logger.info("Found existing video and LRC files in parent directory, skipping transcription")
# Detect countdown padding from existing LRC file
countdown_padding_added, countdown_padding_seconds = self._detect_countdown_padding_from_lrc(parent_lrc_path)
if countdown_padding_added:
self.logger.info(f"Existing files have countdown padding: {countdown_padding_seconds}s")
return {
"lrc_filepath": parent_lrc_path,
"ass_filepath": parent_video_path,
"countdown_padding_added": countdown_padding_added,
"countdown_padding_seconds": countdown_padding_seconds,
"padded_audio_filepath": None, # Original padded audio may not exist
}
# If files exist in lyrics directory, copy to parent and return
# If files exist in lyrics directory, copy to parent and return (but detect countdown padding first)
if os.path.exists(lyrics_video_path) and os.path.exists(lyrics_lrc_path):
self.logger.info(f"Found existing video and LRC files in lyrics directory, copying to parent")
self.logger.info("Found existing video and LRC files in lyrics directory, copying to parent")
os.makedirs(track_output_dir, exist_ok=True)
shutil.copy2(lyrics_video_path, parent_video_path)
shutil.copy2(lyrics_lrc_path, parent_lrc_path)
# Detect countdown padding from existing LRC file
countdown_padding_added, countdown_padding_seconds = self._detect_countdown_padding_from_lrc(parent_lrc_path)
if countdown_padding_added:
self.logger.info(f"Existing files have countdown padding: {countdown_padding_seconds}s")
return {
"lrc_filepath": parent_lrc_path,
"ass_filepath": parent_video_path,
"countdown_padding_added": countdown_padding_added,
"countdown_padding_seconds": countdown_padding_seconds,
"padded_audio_filepath": None, # Original padded audio may not exist
}
# Create lyrics directory if it doesn't exist
+3
View File
@@ -19,6 +19,9 @@ from karaoke_gen.karaoke_finalise import KaraokeFinalise
# Global logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO) # Set initial log level
# Prevent log propagation to root logger to avoid duplicate logs
# when external packages (like lyrics_converter) configure root logger handlers
logger.propagate = False
async def process_track_prep(row, args, logger, log_formatter):
+9 -2
View File
@@ -208,6 +208,11 @@ def create_parser(prog: str = "karaoke-gen") -> argparse.ArgumentParser:
default="flac",
help="Optional: format / file extension for instrumental track to use for remux (default: %(default)s). Example: --instrumental_format=mp3",
)
audio_group.add_argument(
"--skip_instrumental_review",
action="store_true",
help="Optional: Skip the interactive instrumental review UI and use the old numeric selection. Example: --skip_instrumental_review",
)
# Lyrics Configuration
lyrics_group = parser.add_argument_group("Lyrics Configuration")
@@ -347,8 +352,10 @@ def create_parser(prog: str = "karaoke-gen") -> argparse.ArgumentParser:
)
remote_group.add_argument(
"--review-ui-url",
default=os.environ.get('REVIEW_UI_URL', 'https://lyrics.nomadkaraoke.com'),
help="Lyrics review UI URL (default: https://lyrics.nomadkaraoke.com)",
default=os.environ.get('REVIEW_UI_URL', os.environ.get('LYRICS_REVIEW_UI_URL', 'local')),
help="Lyrics review UI URL. Use 'local' for bundled frontend (default), "
"'http://localhost:5173' for Vite dev server, or 'https://lyrics.nomadkaraoke.com' for hosted. "
"(env: REVIEW_UI_URL or LYRICS_REVIEW_UI_URL)",
)
remote_group.add_argument(
"--poll-interval",
+369 -2
View File
@@ -14,14 +14,285 @@ import sys
import json
import asyncio
import time
import glob
import pyperclip
from karaoke_gen import KaraokePrep
from karaoke_gen.karaoke_finalise import KaraokeFinalise
from karaoke_gen.audio_fetcher import UserCancelledError
from karaoke_gen.instrumental_review import (
AudioAnalyzer,
WaveformGenerator,
InstrumentalReviewServer,
)
from .cli_args import create_parser, process_style_overrides, is_url, is_file
def _resolve_path_for_cwd(path: str, track_dir: str) -> str:
"""
Resolve a path that may have been created relative to the original working directory.
After os.chdir(track_dir), paths like './TrackDir/stems/file.flac' become invalid.
This function converts such paths to work from the new current directory.
Args:
path: The path to resolve (may be relative or absolute)
track_dir: The track directory we've chdir'd into
Returns:
A path that's valid from the current working directory
"""
if os.path.isabs(path):
return path
# Normalize both paths for comparison
norm_path = os.path.normpath(path)
norm_track_dir = os.path.normpath(track_dir)
# If path starts with track_dir, strip it to get the relative path from within track_dir
# e.g., './Four Lanes Male Choir - The White Rose/stems/file.flac' -> 'stems/file.flac'
if norm_path.startswith(norm_track_dir + os.sep):
return norm_path[len(norm_track_dir) + 1:]
elif norm_path.startswith(norm_track_dir):
return norm_path[len(norm_track_dir):].lstrip(os.sep) or '.'
# If path doesn't start with track_dir, it might already be relative to track_dir
# or it's a path that doesn't need transformation
return path
def auto_select_instrumental(track: dict, track_dir: str, logger: logging.Logger) -> str:
"""
Auto-select the best instrumental file when --skip_instrumental_review is used.
Selection priority:
1. Padded combined instrumental (+BV) - synchronized with vocals + backing vocals
2. Non-padded combined instrumental (+BV) - has backing vocals
3. Padded clean instrumental - synchronized with vocals
4. Non-padded clean instrumental - basic instrumental
Args:
track: The track dictionary from KaraokePrep containing separated audio info
track_dir: The track output directory (we're already chdir'd into it)
logger: Logger instance
Returns:
Path to the selected instrumental file
Raises:
FileNotFoundError: If no suitable instrumental file can be found
"""
separated = track.get("separated_audio", {})
# Look for combined instrumentals first (they include backing vocals)
combined = separated.get("combined_instrumentals", {})
for model, path in combined.items():
if path:
resolved = _resolve_path_for_cwd(path, track_dir)
# Prefer padded version if it exists
base, ext = os.path.splitext(resolved)
padded = f"{base} (Padded){ext}"
if os.path.exists(padded):
logger.info(f"Auto-selected padded combined instrumental: {padded}")
return padded
if os.path.exists(resolved):
logger.info(f"Auto-selected combined instrumental: {resolved}")
return resolved
# Fall back to clean instrumental
clean = separated.get("clean_instrumental", {})
if clean.get("instrumental"):
resolved = _resolve_path_for_cwd(clean["instrumental"], track_dir)
# Prefer padded version if it exists
base, ext = os.path.splitext(resolved)
padded = f"{base} (Padded){ext}"
if os.path.exists(padded):
logger.info(f"Auto-selected padded clean instrumental: {padded}")
return padded
if os.path.exists(resolved):
logger.info(f"Auto-selected clean instrumental: {resolved}")
return resolved
# If separated_audio doesn't have what we need, search the directory
# This handles edge cases and custom instrumentals
logger.info("No instrumental found in separated_audio, searching directory...")
instrumental_files = glob.glob("*(Instrumental*.flac") + glob.glob("*(Instrumental*.wav")
# Sort to prefer padded versions and combined instrumentals
padded_combined = [f for f in instrumental_files if "(Padded)" in f and "+BV" in f]
if padded_combined:
logger.info(f"Auto-selected from directory: {padded_combined[0]}")
return padded_combined[0]
padded_files = [f for f in instrumental_files if "(Padded)" in f]
if padded_files:
logger.info(f"Auto-selected from directory: {padded_files[0]}")
return padded_files[0]
combined_files = [f for f in instrumental_files if "+BV" in f]
if combined_files:
logger.info(f"Auto-selected from directory: {combined_files[0]}")
return combined_files[0]
if instrumental_files:
logger.info(f"Auto-selected from directory: {instrumental_files[0]}")
return instrumental_files[0]
raise FileNotFoundError(
"No instrumental file found. Audio separation may have failed. "
"Check the stems/ directory for separated audio files."
)
def run_instrumental_review(track: dict, logger: logging.Logger) -> str | None:
"""
Run the instrumental review UI to let user select the best instrumental track.
This analyzes the backing vocals, generates a waveform, and opens a browser
with an interactive UI for reviewing and selecting the instrumental.
Args:
track: The track dictionary from KaraokePrep containing separated audio info
logger: Logger instance
Returns:
Path to the selected instrumental file, or None to use the old numeric selection
"""
track_dir = track.get("track_output_dir", ".")
artist = track.get("artist", "")
title = track.get("title", "")
base_name = f"{artist} - {title}"
# Get separation results
separated = track.get("separated_audio", {})
if not separated:
logger.info("No separated audio found, skipping instrumental review UI")
return None
# Find the backing vocals file
# Note: Paths in separated_audio may be relative to the original working directory,
# but we've already chdir'd into track_dir. Use _resolve_path_for_cwd to fix paths.
backing_vocals_path = None
backing_vocals_result = separated.get("backing_vocals", {})
for model, paths in backing_vocals_result.items():
if paths.get("backing_vocals"):
backing_vocals_path = _resolve_path_for_cwd(paths["backing_vocals"], track_dir)
break
if not backing_vocals_path or not os.path.exists(backing_vocals_path):
logger.info("No backing vocals file found, skipping instrumental review UI")
return None
# Find the clean instrumental file
clean_result = separated.get("clean_instrumental", {})
raw_clean_path = clean_result.get("instrumental")
clean_instrumental_path = _resolve_path_for_cwd(raw_clean_path, track_dir) if raw_clean_path else None
if not clean_instrumental_path or not os.path.exists(clean_instrumental_path):
logger.info("No clean instrumental file found, skipping instrumental review UI")
return None
# Find the combined instrumental (with backing vocals) file - these have "(Padded)" suffix if padded
combined_result = separated.get("combined_instrumentals", {})
with_backing_path = None
for model, path in combined_result.items():
resolved_path = _resolve_path_for_cwd(path, track_dir) if path else None
if resolved_path and os.path.exists(resolved_path):
with_backing_path = resolved_path
break
try:
logger.info("=== Starting Instrumental Review ===")
logger.info(f"Analyzing backing vocals: {backing_vocals_path}")
# Analyze backing vocals
analyzer = AudioAnalyzer()
analysis = analyzer.analyze(backing_vocals_path)
logger.info(f"Analysis complete:")
logger.info(f" Has audible content: {analysis.has_audible_content}")
logger.info(f" Total duration: {analysis.total_duration_seconds:.1f}s")
logger.info(f" Audible segments: {len(analysis.audible_segments)}")
logger.info(f" Recommendation: {analysis.recommended_selection.value}")
# Generate waveform
# Note: We're already in track_dir after chdir, so use current directory
logger.info("Generating waveform visualization...")
waveform_generator = WaveformGenerator()
waveform_path = f"{base_name} (Backing Vocals Waveform).png"
waveform_generator.generate(
audio_path=backing_vocals_path,
output_path=waveform_path,
segments=analysis.audible_segments,
)
# Start the review server
# Note: We're already in track_dir after chdir, so output_dir is "."
logger.info("Starting instrumental review UI...")
server = InstrumentalReviewServer(
output_dir=".",
base_name=base_name,
analysis=analysis,
waveform_path=waveform_path,
backing_vocals_path=backing_vocals_path,
clean_instrumental_path=clean_instrumental_path,
with_backing_path=with_backing_path,
)
# Start server and open browser, wait for selection
server.start_and_open_browser()
logger.info("Waiting for instrumental selection in browser...")
logger.info("(Close the browser tab or press Ctrl+C to cancel)")
try:
# Wait for user selection (blocking)
server._selection_event.wait()
selection = server.get_selection()
logger.info(f"User selected: {selection}")
# Stop the server
server.stop()
# Return the selected instrumental path
if selection == "clean":
return clean_instrumental_path
elif selection == "with_backing":
return with_backing_path
elif selection == "custom":
custom_path = server.get_custom_instrumental_path()
if custom_path and os.path.exists(custom_path):
return custom_path
else:
logger.warning("Custom instrumental not found, falling back to clean")
return clean_instrumental_path
elif selection == "uploaded":
uploaded_path = server.get_uploaded_instrumental_path()
if uploaded_path and os.path.exists(uploaded_path):
return uploaded_path
else:
logger.warning("Uploaded instrumental not found, falling back to clean")
return clean_instrumental_path
else:
logger.warning(f"Unknown selection: {selection}, falling back to numeric selection")
return None
except KeyboardInterrupt:
logger.info("Instrumental review cancelled by user")
server.stop()
return None
except Exception as e:
logger.error(f"Error during instrumental review: {e}")
logger.info("Falling back to numeric selection")
return None
async def async_main():
logger = logging.getLogger(__name__)
# Prevent log propagation to root logger to avoid duplicate logs
# when external packages (like lyrics_converter) configure root logger handlers
logger.propagate = False
log_handler = logging.StreamHandler()
log_formatter = logging.Formatter(fmt="%(asctime)s.%(msecs)03d - %(levelname)s - %(module)s - %(message)s", datefmt="%Y-%m-%d %H:%M:%S")
log_handler.setFormatter(log_formatter)
@@ -31,6 +302,11 @@ async def async_main():
parser = create_parser(prog="karaoke-gen")
args = parser.parse_args()
# Set review UI URL environment variable for the lyrics transcriber review server
# This allows development against a local frontend dev server (e.g., http://localhost:5173)
if hasattr(args, 'review_ui_url') and args.review_ui_url:
os.environ['LYRICS_REVIEW_UI_URL'] = args.review_ui_url
# Process style overrides
try:
style_overrides = process_style_overrides(args.style_override, logger)
@@ -122,7 +398,21 @@ async def async_main():
kprep.input_media = input_audio_wav
# Run KaraokePrep
tracks = await kprep.process()
try:
tracks = await kprep.process()
except UserCancelledError:
logger.info("Operation cancelled by user")
return
except KeyboardInterrupt:
logger.info("Operation cancelled by user (Ctrl+C)")
return
# Filter out None tracks (can happen if prep failed for some tracks)
tracks = [t for t in tracks if t is not None] if tracks else []
if not tracks:
logger.warning("No tracks to process")
return
# Load CDG styles if CDG generation is enabled
cdg_styles = None
@@ -441,7 +731,21 @@ async def async_main():
kprep = kprep_coroutine
# Create final tracks data structure
tracks = await kprep.process()
try:
tracks = await kprep.process()
except UserCancelledError:
logger.info("Operation cancelled by user")
return
except KeyboardInterrupt:
logger.info("Operation cancelled by user (Ctrl+C)")
return
# Filter out None tracks (can happen if prep failed for some tracks)
tracks = [t for t in tracks if t is not None] if tracks else []
if not tracks:
logger.warning("No tracks to process")
return
# If prep-only mode, we're done
if args.prep_only:
@@ -461,6 +765,67 @@ async def async_main():
logger.info(f"Changing to directory: {track_dir}")
os.chdir(track_dir)
# Select instrumental file - either via web UI or auto-selection
# This ALWAYS produces a selected file - no silent fallback to legacy code
selected_instrumental_file = None
skip_review = getattr(args, 'skip_instrumental_review', False)
if skip_review:
# Auto-select instrumental when review is skipped (non-interactive mode)
logger.info("Instrumental review skipped (--skip_instrumental_review), auto-selecting instrumental file...")
try:
selected_instrumental_file = auto_select_instrumental(
track=track,
track_dir=track_dir,
logger=logger,
)
except FileNotFoundError as e:
logger.error(f"Failed to auto-select instrumental: {e}")
logger.error("Check that audio separation completed successfully.")
sys.exit(1)
return # Explicit return for testing
else:
# Run instrumental review web UI
selected_instrumental_file = run_instrumental_review(
track=track,
logger=logger,
)
# If instrumental review failed/returned None, show error and exit
# NO SILENT FALLBACK - we want to know if the new flow has issues
if selected_instrumental_file is None:
logger.error("")
logger.error("=" * 70)
logger.error("INSTRUMENTAL SELECTION FAILED")
logger.error("=" * 70)
logger.error("")
logger.error("The instrumental review UI could not find the required files.")
logger.error("")
logger.error("Common causes:")
logger.error(" - No backing vocals file was found (check stems/ directory)")
logger.error(" - No clean instrumental was found (audio separation may have failed)")
logger.error(" - Path resolution failed after directory change")
logger.error("")
logger.error("To investigate:")
logger.error(" - Check the stems/ directory for: *Backing Vocals*.flac and *Instrumental*.flac")
logger.error(" - Look for separation errors earlier in the log")
logger.error(" - Verify audio separation completed without errors")
logger.error("")
logger.error("Workarounds:")
logger.error(" - Re-run with --skip_instrumental_review to auto-select an instrumental")
logger.error(" - Re-run the full pipeline to regenerate stems")
logger.error("")
sys.exit(1)
return # Explicit return for testing
logger.info(f"Selected instrumental file: {selected_instrumental_file}")
# Get countdown padding info from track (if vocals were padded, instrumental must match)
countdown_padding_seconds = None
if track.get("countdown_padding_added", False):
countdown_padding_seconds = track.get("countdown_padding_seconds", 3.0)
logger.info(f"Countdown padding detected: {countdown_padding_seconds}s (will be applied to instrumental if needed)")
# Load CDG styles if CDG generation is enabled
cdg_styles = None
if args.enable_cdg:
@@ -504,6 +869,8 @@ async def async_main():
cdg_styles=cdg_styles,
keep_brand_code=getattr(args, 'keep_brand_code', False),
non_interactive=args.yes,
selected_instrumental_file=selected_instrumental_file,
countdown_padding_seconds=countdown_padding_seconds,
)
try:
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,336 @@
# MidiCo Synchronizer Reference
This document provides a detailed reference for replicating the MidiCo Synchronizer user experience in our Nomad Karaoke lyrics review UI. The MidiCo Synchronizer is a native macOS application that provides a polished, intuitive interface for manually syncing lyrics to audio.
## Problem Statement
Sometimes transcribed lyrics are correct and start well-synced, but progressively drift out of sync towards the second half of the song. We need an efficient way to fix timing for multiple segments without having to re-sync everything from scratch.
## Overview of MidiCo Interface
MidiCo consists of two windows:
1. **Main Audio Player Window** - Controls audio playback
2. **Synchronizer Window** - Timeline-based lyrics sync interface
![Empty Timeline Before Sync](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-Empty-Timeline-Before-Any-Words-Synced.png)
---
## 1. Audio Player Integration
The main MidiCo window provides an audio player that stays synchronized with the Synchronizer:
- **Play/Pause/Stop buttons** - Standard playback controls
- **Rewind/Fast-forward buttons** - Skip through the track
- **Progress slider** - Shows current position (00:00 format) and remaining time (-03:45 format)
- **Volume slider** - Control audio volume
- **Tempo/Pitch sliders** - Adjust playback speed and pitch (useful for difficult sections)
**Key behavior:** The playhead position is always synced between the audio player and the Synchronizer timeline.
---
## 2. Synchronizer Primary View
The Synchronizer window contains the main timeline interface for syncing lyrics.
### 2.1 Top Control Buttons
Four main control buttons at the top:
| Button | Function |
|--------|----------|
| **Voice no.1** | Select which vocal track to sync (for multi-voice karaoke) |
| **Start Sync** | Begin sync mode - starts audio, shows upcoming words, listens for spacebar |
| **Clear Sync** | Delete all sync data, reset to unsynced state |
| **Edit Lyrics** | Open modal to edit the lyrics text directly |
| **Import Lrc** | Import timing data from an LRC file |
### 2.2 Timeline View
The main rectangular timeline area is the core of the interface.
![During Sync Showing Synced And Upcoming Words](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-During-Sync-Showing-Synced-And-Upcoming-Words.png)
#### Time Bar (Top Strip)
- Thin bar at the top showing time in `MM:SS` format
- Small tick marks for decisecond precision
- Clicking anywhere on the time bar sets the playhead position (without changing playback state)
#### Playhead Marker
- Small arrow/triangle indicator in the time bar
- White vertical line spanning the full height of the timeline
- Shows current playback position
- Synced with the audio player position
#### Timeline Background
- Light gray gradient background
- **Clicking on the background deselects any selected words**
- **Click-drag creates a selection rectangle** for selecting multiple word blocks
#### Zoom Control
- Horizontal slider below the timeline labeled "Zoom"
- Smooth continuous zoom (approximately 50 notches)
- **Most zoomed in:** ~4.5 seconds visible edge-to-edge
- **Most zoomed out:** ~24 seconds visible edge-to-edge
- Smooth, responsive zooming is critical for fast songs
![Max Zoom Level](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-During-Sync-Showing-Max-Zoom-Level.png)
#### Horizontal Scrolling
- Timeline scrolls horizontally to show different parts of the song
- Small horizontal scrollbar at the bottom of the timeline area
- During sync mode, the timeline auto-scrolls to follow the playhead
### 2.3 Word Blocks
Synced words appear as **red rectangular blocks** on the timeline:
- Each block shows the word text above the red bar
- If word text is too long to fit the width of the red bar, the alignment with the red blocks becomes "best effort". Words don't overlap, they're all readable above the red bars for that segment
- Block width corresponds to the word's duration
- Block horizontal position corresponds to the word's start time
#### Two-Level Word Layout (Alternating Segments)
Segments alternate between two vertical positions on the timeline. Each consecutive segment (in time order) is placed on the opposite level from the previous one:
- **Level 0 (top)**: 1st, 3rd, 5th, 7th... segments
- **Level 1 (bottom)**: 2nd, 4th, 6th, 8th... segments
![Two Level Word Blocks](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-During-Sync-Showing-Two-Levels-Word-Blocks.png)
This alternating layout is critical because:
1. **Text never overlaps between consecutive segments** - Since each segment is on a different level, the text labels above the red blocks from one segment won't collide with text from the next segment, even if the text extends past its block width.
2. **All words remain readable** - Text is allowed to extend horizontally beyond the red block boundaries. Because consecutive segments are always on different vertical levels, this extended text doesn't overlap with adjacent segments.
![Non-Overlapping Segments](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-Timeline-With-Non-Overlapping-Segments.png)
In the example above, notice how:
- "Monica Mountains" (level 0) has text that extends beyond its block
- "Where she then proceeded to pump her vehicle in and out of turns" (level 1) is on a different vertical level
- "Sometimes dropping down to fifty miles per hour" (level 0) returns to the top level
- "Only to immediately gun it back up to 90 again" (level 1) is back on the bottom level
This simple alternating pattern ensures that even long segment text remains fully readable without truncation.
**Edge case:** Overlap can still occur in rare situations - if one segment's text is extremely long AND the segment two positions later (on the same level) is very short/early. But this is uncommon in practice.
#### Word Block Selection
- **Single click** on a word block: Selects that block (shown with white 1px border)
- **Click-drag on background**: Creates selection rectangle to select multiple blocks
![Click Drag Word Selection](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-Click-Drag-Word-Selection.png)
#### Word Block Manipulation (Resize & Drag)
Selected word blocks can be manipulated directly on the timeline:
##### Resizing Word Blocks (Change Duration)
When a word block is selected and you hover over it, a **small white dot/handle** appears just inside the right edge of the block. This resize handle allows you to change the word's duration:
1. Select a word block (single click)
2. Hover over the selected block to reveal the resize handle (white dot on right edge)
3. Click and drag the handle left/right to shorten/lengthen the word's duration
4. The word's end time changes; start time remains fixed
This is essential for fine-tuning word durations after initial sync, especially for:
- Words that were synced too long or too short
- Adjusting timing to better match the audio
- Creating smoother transitions between words
##### Dragging Word Blocks (Change Position)
Selected word blocks can be dragged horizontally to change their position in time:
**Single word:**
1. Select a word block
2. Click and drag anywhere on the block (not on the resize handle)
3. The entire word moves earlier/later in time (both start and end times shift)
**Multiple words:**
1. Drag-select multiple word blocks (or Ctrl/Cmd+click to add to selection)
2. Click and drag any of the selected blocks
3. **All selected blocks move together**, maintaining their relative timing
This is particularly useful for:
- Shifting an entire segment earlier or later when it's consistently off
- Adjusting groups of words that were synced correctly relative to each other but offset from the audio
- Fine-tuning timing without having to re-sync
**Example workflow:** If a segment of 10 words all come in 0.2 seconds too late:
1. Drag-select all 10 word blocks
2. Drag them 0.2 seconds earlier
3. All words maintain their relative timing but are now properly aligned with the audio
### 2.4 Upcoming Words Display
During sync mode, unsynced words appear in **two locations**:
![Start Sync Showing Upcoming Words](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-Start-Sync-Showing-Upcoming-Words.png)
1. **Fixed position above time bar** (left side): Shows upcoming words as red/white blocks in a horizontal row. The next word to sync is highlighted in red, subsequent words in white.
2. **On the timeline, right of playhead**: Same words appear starting from the playhead position and extending to the right, with a pale yellow background and black text, moving along with the playhead during playback.
This dual display makes it easy to:
- See what's coming next (fixed position - easy to read while focused on timing)
- See where words will land on the timeline relative to already-synced words
---
## 3. Action Buttons (Icon Toolbar)
A row of small icon-only buttons appears above the timeline. Key buttons we need:
### Essential Buttons
| Icon | Tooltip | Function |
|------|---------|----------|
| **Rectangle with Pencil** | Split, spell or edit selected word | Opens popup to edit a single word. Useful for typos. Entering multiple space-separated words splits the selected word while preserving timing. |
| **No entry symbol** | Unsynchronize from cursor position | All word blocks **after** the current playhead position are reset to unsynced state. Critical for fixing drift in later parts of a song. |
| **Trash** | Delete selected | Deletes selected word(s) entirely. Useful for removing backing vocals or nonsense words. |
### Typical Workflow for Deleting Unwanted Words
1. Tap spacebar to sync the unwanted words (so they appear on timeline)
2. Stop playback
3. Click-drag to select the unwanted word blocks
4. Click trash icon to delete
5. Click Start Sync to resume syncing from where you left off
---
## 4. Sync Mode Operation
### Starting Sync
1. Click **Start Sync** button
2. Audio begins playing from current playhead position
3. Upcoming unsynced words appear in both display locations
4. System begins listening for spacebar input
### Spacebar Timing
Two input modes:
**Tap (press and release quickly):**
- Sets the **start time** of the next unsynced word to the current playhead position
- The word's **end time** is set when the following word is synced
- If gap between words > 1 second, previous word gets default 1 second duration
**Press-hold:**
- Hold spacebar down when word starts
- Release when word ends
- Sets both start and end times explicitly
### Stopping Sync
- Click the **Stop** button (replaces Play when in sync mode)
- Or click **Start Sync** again to toggle off
- Sync progress is preserved
---
## 5. Edit Lyrics Modal
![Lyrics Editor Modal](midico-sync-screenshots/MidiCo-Synchronizer-2025-12-18-Lyrics-Editor-Modal.png)
Accessed via the **Edit Lyrics** button. Provides:
- **Left panel**: Plain text editor with all lyrics, newlines separate segments
- **Right panel**: Preview of how lyrics will appear (karaoke style rendering)
- **Language selector**: For hyphenation support
- **Hyphenate button**: Auto-hyphenate words for syllable-level sync
- **Reset button**: Revert to original lyrics
- **Cancel/OK buttons**: Discard or apply changes
### Important Behavior
Editing lyrics when there are already synced timestamps **usually messes up the syncs**. Users typically need to Clear Sync and start over after editing lyrics.
---
## 6. Apply Button
The **Apply** button in the bottom-right corner is critical:
- Changes made in the Synchronizer are **not saved** until Apply is clicked
- This allows experimenting without fear of losing work
- If sync goes badly wrong, user can close the Synchronizer without applying changes
- Provides a safe "sandbox" for sync work
---
## 7. Performance Requirements
The entire interface must be:
- **Smooth and responsive** - No lag or stutter during playback
- **Low latency** - Spacebar input must register with sub-100ms precision
- **Efficient** - No unnecessary computation during sync (user is focused on timing)
- **Native-app feel** - As expected from a macOS application
Since we're dealing with sub-second time precision for synced lyrics, performance is critical.
---
## 8. Implementation Notes for Our App
### Entry Point: "Edit All" Button
The current "Edit All" button should show a choice:
1. **Replace all lyrics** - Shows the existing paste box flow (for completely new lyrics)
2. **Re-sync existing lyrics** - Goes directly to the new Synchronizer view with all existing words/segments plotted on the timeline
This preserves existing sync data while allowing re-sync of later portions.
### Key Features to Implement
1. **Timeline with word blocks showing existing sync data**
2. **Playhead synced with audio player**
3. **Zoom slider (4.5s to 24s range)**
4. **Horizontal scrolling**
5. **Two-level word block layout**
6. **Start Sync mode with spacebar capture**
7. **Upcoming words display (fixed + timeline)**
8. **"Unsynchronize from cursor" - critical for fixing drift**
9. **Word selection (single click + drag-select)**
10. **Delete selected words**
11. **Edit single word popup**
12. **Apply/Cancel for safe experimentation**
### Fixing Timing Drift (Primary Use Case)
The main workflow for fixing drift:
1. Open Synchronizer (with existing sync data loaded)
2. Play audio to find where sync starts drifting
3. Position playhead at last correctly-synced word
4. Click "Unsynchronize from cursor position"
5. Click "Start Sync" to resume syncing from that point
6. Tap spacebar to re-sync the remaining words
7. Click "Apply" when done
This workflow allows keeping good sync data while fixing only the problematic portion.
---
## Screenshots Reference
All screenshots are located in: `docs/midico-sync-screenshots/`
| Filename | Description |
|----------|-------------|
| `MidiCo-Synchronizer-2025-12-18-Empty-Timeline-Before-Any-Words-Synced.png` | Initial state with empty timeline |
| `MidiCo-Synchronizer-2025-12-18-Start-Sync-Showing-Upcoming-Words.png` | Sync mode started, showing upcoming words in both locations |
| `MidiCo-Synchronizer-2025-12-18-During-Sync-Showing-Synced-And-Upcoming-Words.png` | Mid-sync showing both synced blocks and upcoming words |
| `MidiCo-Synchronizer-2025-12-18-During-Sync-Showing-Two-Levels-Word-Blocks.png` | Demonstration of two-level word block layout |
| `MidiCo-Synchronizer-2025-12-18-During-Sync-Showing-Max-Zoom-Level.png` | Maximum zoom level (~4.5 seconds visible) |
| `MidiCo-Synchronizer-2025-12-18-Click-Drag-Word-Selection.png` | Selection rectangle for multi-word selection |
| `MidiCo-Synchronizer-2025-12-18-Lyrics-Editor-Modal.png` | Edit Lyrics modal dialog |
| `MidiCo-Synchronizer-2025-12-18-Timeline-With-Non-Overlapping-Segments.png` | Shows alternating segment levels with long text that doesn't overlap |
Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

@@ -2,7 +2,7 @@
"name": "lyrics-transcriber-frontend",
"private": true,
"homepage": "https://nomadkaraoke.github.io/lyrics-transcriber-frontend",
"version": "0.80.0",
"version": "0.82.0",
"type": "module",
"scripts": {
"dev": "vite",
@@ -1,4 +1,4 @@
import { Box, Button, Typography, useMediaQuery, useTheme, Switch, FormControlLabel, Tooltip, Paper, IconButton } from '@mui/material'
import { Box, Button, Typography, useMediaQuery, useTheme, Switch, FormControlLabel, Tooltip, Paper, IconButton, Chip } from '@mui/material'
import LockIcon from '@mui/icons-material/Lock'
import UploadFileIcon from '@mui/icons-material/UploadFile'
import FindReplaceIcon from '@mui/icons-material/FindReplace'
@@ -7,6 +7,7 @@ import UndoIcon from '@mui/icons-material/Undo'
import RedoIcon from '@mui/icons-material/Redo'
import TimerIcon from '@mui/icons-material/Timer'
import RestoreIcon from '@mui/icons-material/Restore'
import RateReviewIcon from '@mui/icons-material/RateReview'
import { CorrectionData, InteractionMode } from '../types'
import CorrectionMetrics from './CorrectionMetrics'
import AgenticCorrectionMetrics from './AgenticCorrectionMetrics'
@@ -41,6 +42,8 @@ interface HeaderProps {
onRedo: () => void
canUndo: boolean
canRedo: boolean
annotationsEnabled?: boolean
onAnnotationsToggle?: (enabled: boolean) => void
}
export default function Header({
@@ -65,6 +68,8 @@ export default function Header({
onRedo,
canUndo,
canRedo,
annotationsEnabled = true,
onAnnotationsToggle,
}: HeaderProps) {
const theme = useTheme()
const isMobile = useMediaQuery(theme.breakpoints.down('md'))
@@ -135,17 +140,38 @@ export default function Header({
<Typography variant="h4" sx={{ fontSize: isMobile ? '1.3rem' : '1.5rem' }}>
Nomad Karaoke: Lyrics Transcription Review
</Typography>
{isReadOnly && (
<Button
variant="outlined"
size="small"
startIcon={<UploadFileIcon />}
onClick={onFileLoad}
fullWidth={isMobile}
>
Load File
</Button>
)}
<Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
{!isReadOnly && onAnnotationsToggle && (
<Tooltip title={annotationsEnabled
? "Click to disable annotation prompts when editing"
: "Click to enable annotation prompts when editing"
}>
<Chip
icon={<RateReviewIcon />}
label={annotationsEnabled ? "Feedback On" : "Feedback Off"}
onClick={() => onAnnotationsToggle(!annotationsEnabled)}
color={annotationsEnabled ? "primary" : "default"}
variant={annotationsEnabled ? "filled" : "outlined"}
size="small"
sx={{
cursor: 'pointer',
'& .MuiChip-icon': { fontSize: '1rem' }
}}
/>
</Tooltip>
)}
{isReadOnly && (
<Button
variant="outlined"
size="small"
startIcon={<UploadFileIcon />}
onClick={onFileLoad}
fullWidth={isMobile}
>
Load File
</Button>
)}
</Box>
</Box>
<Box sx={{
@@ -200,6 +200,8 @@ interface MemoizedHeaderProps {
canUndo: boolean
canRedo: boolean
onUnCorrectAll: () => void
annotationsEnabled: boolean
onAnnotationsToggle: (enabled: boolean) => void
}
// Create a memoized Header component
@@ -224,7 +226,9 @@ const MemoizedHeader = memo(function MemoizedHeader({
onRedo,
canUndo,
canRedo,
onUnCorrectAll
onUnCorrectAll,
annotationsEnabled,
onAnnotationsToggle
}: MemoizedHeaderProps) {
return (
<Header
@@ -249,6 +253,8 @@ const MemoizedHeader = memo(function MemoizedHeader({
canUndo={canUndo}
canRedo={canRedo}
onUnCorrectAll={onUnCorrectAll}
annotationsEnabled={annotationsEnabled}
onAnnotationsToggle={onAnnotationsToggle}
/>
);
});
@@ -295,13 +301,18 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
wordIdsAffected: string[]
gapId?: string
} | null>(null)
const [annotationsEnabled] = useState(() => {
const [annotationsEnabled, setAnnotationsEnabled] = useState(() => {
// Check localStorage for user preference
const saved = localStorage.getItem('annotationsEnabled')
return saved !== null ? saved === 'true' : true // Default: enabled
// TODO: Add UI toggle to enable/disable via setAnnotationsEnabled
})
// Persist annotation preference to localStorage
const handleAnnotationsToggle = useCallback((enabled: boolean) => {
setAnnotationsEnabled(enabled)
localStorage.setItem('annotationsEnabled', String(enabled))
}, [])
// Correction detail card state
const [correctionDetailOpen, setCorrectionDetailOpen] = useState(false)
const [selectedCorrection, setSelectedCorrection] = useState<{
@@ -1164,6 +1175,8 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
canUndo={canUndo}
canRedo={canRedo}
onUnCorrectAll={handleUnCorrectAll}
annotationsEnabled={annotationsEnabled}
onAnnotationsToggle={handleAnnotationsToggle}
/>
<Grid container direction={isMobile ? 'column' : 'row'}>
@@ -1313,6 +1326,7 @@ export default function LyricsAnalyzer({ data: initialData, onFileLoad, apiClien
onPlaySegment={handlePlaySegment}
currentTime={currentAudioTime}
setModalSpacebarHandler={handleSetModalSpacebarHandler}
existingSegments={data.corrected_segments}
/>
{pendingAnnotation && (
@@ -0,0 +1,185 @@
import { memo } from 'react'
import {
Box,
Button,
Divider,
Stack
} from '@mui/material'
import PlayCircleOutlineIcon from '@mui/icons-material/PlayCircleOutline'
import StopIcon from '@mui/icons-material/Stop'
import PauseIcon from '@mui/icons-material/Pause'
import PlayArrowIcon from '@mui/icons-material/PlayArrow'
import ClearAllIcon from '@mui/icons-material/ClearAll'
import EditNoteIcon from '@mui/icons-material/EditNote'
import BlockIcon from '@mui/icons-material/Block'
import EditIcon from '@mui/icons-material/Edit'
import DeleteIcon from '@mui/icons-material/Delete'
interface SyncControlsProps {
// Main buttons
isManualSyncing: boolean
isPaused: boolean
onStartSync: () => void
onPauseSync: () => void
onResumeSync: () => void
onClearSync: () => void
onEditLyrics: () => void
// Playback controls
onPlay: () => void
onStop: () => void
isPlaying: boolean
// Word action buttons
hasSelectedWords: boolean
selectedWordCount: number
onUnsyncFromCursor: () => void
onEditSelectedWord: () => void
onDeleteSelected: () => void
// Additional state
canUnsyncFromCursor: boolean
}
const SyncControls = memo(function SyncControls({
isManualSyncing,
isPaused,
onStartSync,
onPauseSync,
onResumeSync,
onClearSync,
onEditLyrics,
onPlay,
onStop,
isPlaying,
hasSelectedWords,
selectedWordCount,
onUnsyncFromCursor,
onEditSelectedWord,
onDeleteSelected,
canUnsyncFromCursor
}: SyncControlsProps) {
return (
<Box sx={{ display: 'flex', flexDirection: 'column', gap: 1.5 }}>
{/* Row 1: Playback & Sync Mode Controls */}
<Stack direction="row" spacing={1} alignItems="center" flexWrap="wrap">
{/* Playback controls */}
<Button
variant="outlined"
color="primary"
onClick={onPlay}
startIcon={<PlayArrowIcon />}
size="small"
disabled={isPlaying}
>
Play
</Button>
<Button
variant="outlined"
color="error"
onClick={onStop}
startIcon={<StopIcon />}
size="small"
disabled={!isPlaying}
>
Stop
</Button>
<Divider orientation="vertical" flexItem sx={{ mx: 0.5 }} />
{/* Sync Mode controls */}
{isManualSyncing ? (
<>
<Button
variant="contained"
color="error"
onClick={onStartSync}
startIcon={<StopIcon />}
size="small"
>
Stop Sync
</Button>
<Button
variant="outlined"
color={isPaused ? 'success' : 'warning'}
onClick={isPaused ? onResumeSync : onPauseSync}
startIcon={isPaused ? <PlayArrowIcon /> : <PauseIcon />}
size="small"
>
{isPaused ? 'Resume' : 'Pause'}
</Button>
</>
) : (
<Button
variant="contained"
color="primary"
onClick={onStartSync}
startIcon={<PlayCircleOutlineIcon />}
size="small"
>
Start Sync
</Button>
)}
</Stack>
{/* Row 2: Editing & Word Actions */}
<Stack direction="row" spacing={1} alignItems="center" flexWrap="wrap">
<Button
variant="outlined"
color="warning"
onClick={onClearSync}
startIcon={<ClearAllIcon />}
size="small"
disabled={isManualSyncing && !isPaused}
>
Clear Sync
</Button>
<Button
variant="outlined"
onClick={onEditLyrics}
startIcon={<EditNoteIcon />}
size="small"
disabled={isManualSyncing && !isPaused}
>
Edit Lyrics
</Button>
<Divider orientation="vertical" flexItem sx={{ mx: 0.5 }} />
<Button
variant="outlined"
onClick={onUnsyncFromCursor}
startIcon={<BlockIcon />}
size="small"
disabled={!canUnsyncFromCursor || (isManualSyncing && !isPaused)}
>
Unsync from Cursor
</Button>
<Button
variant="outlined"
onClick={onEditSelectedWord}
startIcon={<EditIcon />}
size="small"
disabled={!hasSelectedWords || selectedWordCount !== 1}
>
Edit Word
</Button>
<Button
variant="outlined"
color="error"
onClick={onDeleteSelected}
startIcon={<DeleteIcon />}
size="small"
disabled={!hasSelectedWords || (isManualSyncing && !isPaused)}
>
Delete{hasSelectedWords && selectedWordCount > 0 ? ` (${selectedWordCount})` : ''}
</Button>
</Stack>
</Box>
)
})
export default SyncControls
@@ -0,0 +1,704 @@
import { useRef, useEffect, useCallback, useState, memo } from 'react'
import { Box, IconButton, Tooltip } from '@mui/material'
import ArrowBackIcon from '@mui/icons-material/ArrowBack'
import ArrowForwardIcon from '@mui/icons-material/ArrowForward'
import { Word, LyricsSegment } from '../../types'
interface TimelineCanvasProps {
words: Word[]
segments: LyricsSegment[]
visibleStartTime: number
visibleEndTime: number
currentTime: number
selectedWordIds: Set<string>
onWordClick: (wordId: string, event: React.MouseEvent) => void
onBackgroundClick: () => void
onTimeBarClick: (time: number) => void
onSelectionComplete: (wordIds: string[]) => void
onWordTimingChange: (wordId: string, newStartTime: number, newEndTime: number) => void
onWordsMove: (updates: Array<{ wordId: string; newStartTime: number; newEndTime: number }>) => void
syncWordIndex: number
isManualSyncing: boolean
onScrollChange: (newStartTime: number) => void
audioDuration: number
zoomSeconds: number
height?: number
}
// Constants for rendering
const TIME_BAR_HEIGHT = 28
const WORD_BLOCK_HEIGHT = 24
const WORD_LEVEL_SPACING = 50
const CANVAS_PADDING = 8
const TEXT_ABOVE_BLOCK = 14
const RESIZE_HANDLE_SIZE = 8
const RESIZE_HANDLE_HITAREA = 12
const PLAYHEAD_COLOR = '#ffffff'
const WORD_BLOCK_COLOR = '#d32f2f'
const WORD_BLOCK_SELECTED_COLOR = '#b71c1c'
const WORD_BLOCK_CURRENT_COLOR = '#f44336'
const WORD_TEXT_CURRENT_COLOR = '#d32f2f'
const UPCOMING_WORD_BG = '#fff9c4'
const UPCOMING_WORD_TEXT = '#000000'
const TIME_BAR_BG = '#f5f5f5'
const TIME_BAR_TEXT = '#666666'
const TIMELINE_BG = '#e0e0e0'
// Drag modes
type DragMode = 'none' | 'selection' | 'resize' | 'move'
// Build a map of word ID to segment index
function buildWordToSegmentMap(segments: LyricsSegment[]): Map<string, number> {
const map = new Map<string, number>()
segments.forEach((segment, idx) => {
segment.words.forEach(word => {
map.set(word.id, idx)
})
})
return map
}
// Calculate which vertical level a word should be on
function calculateWordLevels(words: Word[], segments: LyricsSegment[]): Map<string, number> {
const levels = new Map<string, number>()
const wordToSegment = buildWordToSegmentMap(segments)
const segmentsWithTiming = segments
.map((segment, idx) => {
const timedWords = segment.words.filter(w => w.start_time !== null)
const minStart = timedWords.length > 0
? Math.min(...timedWords.map(w => w.start_time!))
: Infinity
return { idx, minStart }
})
.filter(s => s.minStart !== Infinity)
.sort((a, b) => a.minStart - b.minStart)
const segmentLevels = new Map<number, number>()
segmentsWithTiming.forEach(({ idx }, orderIndex) => {
segmentLevels.set(idx, orderIndex % 2)
})
for (const word of words) {
const segmentIdx = wordToSegment.get(word.id)
if (segmentIdx !== undefined && segmentLevels.has(segmentIdx)) {
levels.set(word.id, segmentLevels.get(segmentIdx)!)
} else {
levels.set(word.id, 0)
}
}
return levels
}
function formatTime(seconds: number): string {
const mins = Math.floor(seconds / 60)
const secs = Math.floor(seconds % 60)
return `${mins.toString().padStart(2, '0')}:${secs.toString().padStart(2, '0')}`
}
const TimelineCanvas = memo(function TimelineCanvas({
words,
segments,
visibleStartTime,
visibleEndTime,
currentTime,
selectedWordIds,
onWordClick,
onBackgroundClick,
onTimeBarClick,
onSelectionComplete,
onWordTimingChange,
onWordsMove,
syncWordIndex,
isManualSyncing,
onScrollChange,
audioDuration,
zoomSeconds,
height = 200
}: TimelineCanvasProps) {
const canvasRef = useRef<HTMLCanvasElement>(null)
const containerRef = useRef<HTMLDivElement>(null)
const [canvasWidth, setCanvasWidth] = useState(800)
const animationFrameRef = useRef<number>()
const wordLevelsRef = useRef<Map<string, number>>(new Map())
// Drag state
const [dragMode, setDragMode] = useState<DragMode>('none')
const dragStartRef = useRef<{ x: number; y: number; time: number } | null>(null)
const dragWordIdRef = useRef<string | null>(null)
const dragOriginalTimesRef = useRef<Map<string, { start: number; end: number }>>(new Map())
// Selection rectangle
const [selectionRect, setSelectionRect] = useState<{
startX: number; startY: number; endX: number; endY: number
} | null>(null)
// Hover state for showing resize handle
const [hoveredWordId, setHoveredWordId] = useState<string | null>(null)
const [cursorStyle, setCursorStyle] = useState<string>('default')
// Update canvas width on resize
useEffect(() => {
const updateWidth = () => {
if (containerRef.current) {
setCanvasWidth(containerRef.current.clientWidth)
}
}
updateWidth()
const resizeObserver = new ResizeObserver(updateWidth)
if (containerRef.current) {
resizeObserver.observe(containerRef.current)
}
return () => resizeObserver.disconnect()
}, [])
// Calculate word levels when words or segments change
useEffect(() => {
wordLevelsRef.current = calculateWordLevels(words, segments)
}, [words, segments])
// Convert time to x position
const timeToX = useCallback((time: number): number => {
const duration = visibleEndTime - visibleStartTime
if (duration <= 0) return 0
return CANVAS_PADDING + ((time - visibleStartTime) / duration) * (canvasWidth - CANVAS_PADDING * 2)
}, [visibleStartTime, visibleEndTime, canvasWidth])
// Convert x position to time
const xToTime = useCallback((x: number): number => {
const duration = visibleEndTime - visibleStartTime
return visibleStartTime + ((x - CANVAS_PADDING) / (canvasWidth - CANVAS_PADDING * 2)) * duration
}, [visibleStartTime, visibleEndTime, canvasWidth])
// Get word bounds
const getWordBounds = useCallback((word: Word) => {
if (word.start_time === null || word.end_time === null) return null
const level = wordLevelsRef.current.get(word.id) || 0
const startX = timeToX(word.start_time)
const endX = timeToX(word.end_time)
const blockWidth = Math.max(endX - startX, 4)
const y = TIME_BAR_HEIGHT + CANVAS_PADDING + TEXT_ABOVE_BLOCK + level * WORD_LEVEL_SPACING
return { startX, endX, blockWidth, y, level }
}, [timeToX])
// Check if position is near resize handle
const isNearResizeHandlePos = useCallback((word: Word, x: number, y: number): boolean => {
const bounds = getWordBounds(word)
if (!bounds) return false
const handleX = bounds.startX + bounds.blockWidth - RESIZE_HANDLE_SIZE / 2
const handleY = bounds.y + WORD_BLOCK_HEIGHT / 2
return Math.abs(x - handleX) < RESIZE_HANDLE_HITAREA / 2 &&
Math.abs(y - handleY) < RESIZE_HANDLE_HITAREA / 2
}, [getWordBounds])
// Find word at position
const findWordAtPosition = useCallback((x: number, y: number): Word | null => {
for (const word of words) {
const bounds = getWordBounds(word)
if (!bounds) continue
if (x >= bounds.startX && x <= bounds.startX + bounds.blockWidth &&
y >= bounds.y && y <= bounds.y + WORD_BLOCK_HEIGHT) {
return word
}
}
return null
}, [words, getWordBounds])
// Find words in selection rectangle
const findWordsInRect = useCallback((rect: { startX: number; startY: number; endX: number; endY: number }): string[] => {
const rectLeft = Math.min(rect.startX, rect.endX)
const rectRight = Math.max(rect.startX, rect.endX)
const rectTop = Math.min(rect.startY, rect.endY)
const rectBottom = Math.max(rect.startY, rect.endY)
const selectedIds: string[] = []
for (const word of words) {
const bounds = getWordBounds(word)
if (!bounds) continue
if (bounds.startX + bounds.blockWidth >= rectLeft && bounds.startX <= rectRight &&
bounds.y + WORD_BLOCK_HEIGHT >= rectTop && bounds.y <= rectBottom) {
selectedIds.push(word.id)
}
}
return selectedIds
}, [words, getWordBounds])
// Draw the timeline
const draw = useCallback(() => {
const canvas = canvasRef.current
if (!canvas) return
const ctx = canvas.getContext('2d')
if (!ctx) return
const dpr = window.devicePixelRatio || 1
canvas.width = canvasWidth * dpr
canvas.height = height * dpr
ctx.scale(dpr, dpr)
// Clear canvas
ctx.fillStyle = TIMELINE_BG
ctx.fillRect(0, 0, canvasWidth, height)
// Draw time bar background
ctx.fillStyle = TIME_BAR_BG
ctx.fillRect(0, 0, canvasWidth, TIME_BAR_HEIGHT)
// Draw time markers
const duration = visibleEndTime - visibleStartTime
const secondsPerTick = duration > 15 ? 2 : duration > 8 ? 1 : 0.5
const startSecond = Math.ceil(visibleStartTime / secondsPerTick) * secondsPerTick
ctx.fillStyle = TIME_BAR_TEXT
ctx.font = '11px system-ui, -apple-system, sans-serif'
ctx.textAlign = 'center'
for (let t = startSecond; t <= visibleEndTime; t += secondsPerTick) {
const x = timeToX(t)
ctx.beginPath()
ctx.strokeStyle = '#999999'
ctx.lineWidth = 1
ctx.moveTo(x, TIME_BAR_HEIGHT - 6)
ctx.lineTo(x, TIME_BAR_HEIGHT)
ctx.stroke()
if (t % 1 === 0) {
ctx.fillText(formatTime(t), x, TIME_BAR_HEIGHT - 10)
}
}
ctx.beginPath()
ctx.strokeStyle = '#cccccc'
ctx.lineWidth = 1
ctx.moveTo(0, TIME_BAR_HEIGHT)
ctx.lineTo(canvasWidth, TIME_BAR_HEIGHT)
ctx.stroke()
const wordToSegment = buildWordToSegmentMap(segments)
const syncedWords = words.filter(w => w.start_time !== null && w.end_time !== null)
const currentWordId = syncedWords.find(w =>
currentTime >= w.start_time! && currentTime <= w.end_time!
)?.id || null
// First pass: draw all blocks
for (const word of syncedWords) {
const bounds = getWordBounds(word)
if (!bounds) continue
const isSelected = selectedWordIds.has(word.id)
const isCurrent = word.id === currentWordId
const isHovered = word.id === hoveredWordId
// Draw word block background
if (isSelected) {
ctx.fillStyle = WORD_BLOCK_SELECTED_COLOR
} else if (isCurrent) {
ctx.fillStyle = WORD_BLOCK_CURRENT_COLOR
} else {
ctx.fillStyle = WORD_BLOCK_COLOR
}
ctx.fillRect(bounds.startX, bounds.y, bounds.blockWidth, WORD_BLOCK_HEIGHT)
// Draw selection border
if (isSelected) {
ctx.strokeStyle = '#ffffff'
ctx.lineWidth = 2
ctx.strokeRect(bounds.startX, bounds.y, bounds.blockWidth, WORD_BLOCK_HEIGHT)
// Draw resize handle (white dot on right edge) for selected words when hovered
if (isHovered || selectedWordIds.size === 1) {
const handleX = bounds.startX + bounds.blockWidth - RESIZE_HANDLE_SIZE / 2
const handleY = bounds.y + WORD_BLOCK_HEIGHT / 2
ctx.beginPath()
ctx.fillStyle = '#ffffff'
ctx.arc(handleX, handleY, RESIZE_HANDLE_SIZE / 2, 0, Math.PI * 2)
ctx.fill()
ctx.strokeStyle = '#666666'
ctx.lineWidth = 1
ctx.stroke()
}
}
}
// Second pass: draw text
const wordsBySegment = new Map<number, Word[]>()
for (const word of syncedWords) {
const segIdx = wordToSegment.get(word.id)
if (segIdx !== undefined) {
if (!wordsBySegment.has(segIdx)) {
wordsBySegment.set(segIdx, [])
}
wordsBySegment.get(segIdx)!.push(word)
}
}
ctx.font = '11px system-ui, -apple-system, sans-serif'
ctx.textAlign = 'left'
for (const [, segmentWords] of wordsBySegment) {
const sortedWords = [...segmentWords].sort((a, b) =>
(a.start_time || 0) - (b.start_time || 0)
)
if (sortedWords.length === 0) continue
const level = wordLevelsRef.current.get(sortedWords[0].id) || 0
const textY = TIME_BAR_HEIGHT + CANVAS_PADDING + TEXT_ABOVE_BLOCK + level * WORD_LEVEL_SPACING - 3
let rightmostTextEnd = -Infinity
for (const word of sortedWords) {
const blockStartX = timeToX(word.start_time!)
const textWidth = ctx.measureText(word.text).width
const textStartX = Math.max(blockStartX, rightmostTextEnd + 3)
if (textStartX < canvasWidth - 10) {
const isCurrent = word.id === currentWordId
ctx.fillStyle = isCurrent ? WORD_TEXT_CURRENT_COLOR : '#333333'
ctx.fillText(word.text, textStartX, textY)
rightmostTextEnd = textStartX + textWidth
}
}
}
// Draw upcoming words during sync
if (isManualSyncing && syncWordIndex >= 0) {
const upcomingWords = words.slice(syncWordIndex).filter(w => w.start_time === null)
const playheadX = timeToX(currentTime)
let offsetX = playheadX + 10
ctx.font = '11px system-ui, -apple-system, sans-serif'
for (let i = 0; i < Math.min(upcomingWords.length, 12); i++) {
const word = upcomingWords[i]
const textWidth = ctx.measureText(word.text).width + 10
ctx.fillStyle = UPCOMING_WORD_BG
ctx.fillRect(offsetX, TIME_BAR_HEIGHT + CANVAS_PADDING + WORD_LEVEL_SPACING + 60, textWidth, 20)
ctx.fillStyle = UPCOMING_WORD_TEXT
ctx.textAlign = 'left'
ctx.fillText(word.text, offsetX + 5, TIME_BAR_HEIGHT + CANVAS_PADDING + WORD_LEVEL_SPACING + 74)
offsetX += textWidth + 3
if (offsetX > canvasWidth - 20) break
}
}
// Draw playhead
if (currentTime >= visibleStartTime && currentTime <= visibleEndTime) {
const playheadX = timeToX(currentTime)
ctx.beginPath()
ctx.fillStyle = PLAYHEAD_COLOR
ctx.strokeStyle = '#333333'
ctx.lineWidth = 1
ctx.moveTo(playheadX - 6, 2)
ctx.lineTo(playheadX + 6, 2)
ctx.lineTo(playheadX, TIME_BAR_HEIGHT - 4)
ctx.closePath()
ctx.fill()
ctx.stroke()
ctx.beginPath()
ctx.strokeStyle = PLAYHEAD_COLOR
ctx.lineWidth = 2
ctx.moveTo(playheadX, TIME_BAR_HEIGHT)
ctx.lineTo(playheadX, height)
ctx.stroke()
ctx.beginPath()
ctx.strokeStyle = 'rgba(0,0,0,0.4)'
ctx.lineWidth = 1
ctx.moveTo(playheadX + 1, TIME_BAR_HEIGHT)
ctx.lineTo(playheadX + 1, height)
ctx.stroke()
}
// Draw selection rectangle
if (selectionRect) {
ctx.fillStyle = 'rgba(25, 118, 210, 0.2)'
ctx.strokeStyle = 'rgba(25, 118, 210, 0.8)'
ctx.lineWidth = 1
const rectX = Math.min(selectionRect.startX, selectionRect.endX)
const rectY = Math.min(selectionRect.startY, selectionRect.endY)
const rectW = Math.abs(selectionRect.endX - selectionRect.startX)
const rectH = Math.abs(selectionRect.endY - selectionRect.startY)
ctx.fillRect(rectX, rectY, rectW, rectH)
ctx.strokeRect(rectX, rectY, rectW, rectH)
}
}, [
canvasWidth, height, visibleStartTime, visibleEndTime, currentTime,
words, segments, selectedWordIds, selectionRect, hoveredWordId,
syncWordIndex, isManualSyncing, timeToX, getWordBounds
])
// Animation frame
useEffect(() => {
const animate = () => {
draw()
animationFrameRef.current = requestAnimationFrame(animate)
}
animate()
return () => {
if (animationFrameRef.current) {
cancelAnimationFrame(animationFrameRef.current)
}
}
}, [draw])
// Mouse handlers
const handleMouseDown = useCallback((e: React.MouseEvent<HTMLCanvasElement>) => {
const rect = canvasRef.current?.getBoundingClientRect()
if (!rect) return
const x = e.clientX - rect.left
const y = e.clientY - rect.top
const time = xToTime(x)
// Time bar click
if (y < TIME_BAR_HEIGHT) {
onTimeBarClick(Math.max(0, time))
return
}
const clickedWord = findWordAtPosition(x, y)
if (clickedWord && selectedWordIds.has(clickedWord.id)) {
// Check if clicking on resize handle
if (isNearResizeHandlePos(clickedWord, x, y)) {
// Start resize
setDragMode('resize')
dragStartRef.current = { x, y, time }
dragWordIdRef.current = clickedWord.id
dragOriginalTimesRef.current = new Map([[clickedWord.id, {
start: clickedWord.start_time!,
end: clickedWord.end_time!
}]])
return
}
// Start move (for all selected words)
setDragMode('move')
dragStartRef.current = { x, y, time }
dragWordIdRef.current = clickedWord.id
// Store original times for all selected words
const originalTimes = new Map<string, { start: number; end: number }>()
for (const wordId of selectedWordIds) {
const word = words.find(w => w.id === wordId)
if (word && word.start_time !== null && word.end_time !== null) {
originalTimes.set(wordId, { start: word.start_time, end: word.end_time })
}
}
dragOriginalTimesRef.current = originalTimes
return
}
if (clickedWord) {
// Click on unselected word - select it
onWordClick(clickedWord.id, e)
return
}
// Background - start selection
setDragMode('selection')
dragStartRef.current = { x, y, time }
setSelectionRect({ startX: x, startY: y, endX: x, endY: y })
}, [xToTime, onTimeBarClick, findWordAtPosition, selectedWordIds, isNearResizeHandlePos, onWordClick, words])
const handleMouseMove = useCallback((e: React.MouseEvent<HTMLCanvasElement>) => {
const rect = canvasRef.current?.getBoundingClientRect()
if (!rect) return
const x = e.clientX - rect.left
const y = e.clientY - rect.top
const time = xToTime(x)
// Update hover state and cursor
if (dragMode === 'none') {
const hoveredWord = findWordAtPosition(x, y)
setHoveredWordId(hoveredWord?.id || null)
if (hoveredWord && selectedWordIds.has(hoveredWord.id)) {
const nearHandle = isNearResizeHandlePos(hoveredWord, x, y)
setCursorStyle(nearHandle ? 'ew-resize' : 'grab')
} else if (hoveredWord) {
setCursorStyle('pointer')
} else if (y < TIME_BAR_HEIGHT) {
setCursorStyle('pointer')
} else {
setCursorStyle('default')
}
}
if (!dragStartRef.current) return
if (dragMode === 'selection') {
setSelectionRect({
startX: dragStartRef.current.x,
startY: dragStartRef.current.y,
endX: x,
endY: y
})
} else if (dragMode === 'resize' && dragWordIdRef.current) {
// Resize the word
const originalTimes = dragOriginalTimesRef.current.get(dragWordIdRef.current)
if (originalTimes) {
const deltaTime = time - dragStartRef.current.time
const newEndTime = Math.max(originalTimes.start + 0.05, originalTimes.end + deltaTime)
onWordTimingChange(dragWordIdRef.current, originalTimes.start, newEndTime)
}
setCursorStyle('ew-resize')
} else if (dragMode === 'move') {
// Move all selected words
const deltaTime = time - dragStartRef.current.time
const updates: Array<{ wordId: string; newStartTime: number; newEndTime: number }> = []
for (const [wordId, originalTimes] of dragOriginalTimesRef.current) {
// Ensure end time is always after start time (at least 0.05s duration)
const newStartTime = Math.max(0, originalTimes.start + deltaTime)
const newEndTime = Math.max(newStartTime + 0.05, originalTimes.end + deltaTime)
updates.push({
wordId,
newStartTime,
newEndTime
})
}
if (updates.length > 0) {
onWordsMove(updates)
}
setCursorStyle('grabbing')
}
}, [dragMode, xToTime, findWordAtPosition, selectedWordIds, isNearResizeHandlePos, onWordTimingChange, onWordsMove])
const handleMouseUp = useCallback((e: React.MouseEvent<HTMLCanvasElement>) => {
const rect = canvasRef.current?.getBoundingClientRect()
if (dragMode === 'selection' && dragStartRef.current && rect) {
const endX = e.clientX - rect.left
const endY = e.clientY - rect.top
const dragDistance = Math.sqrt(
Math.pow(endX - dragStartRef.current.x, 2) +
Math.pow(endY - dragStartRef.current.y, 2)
)
if (dragDistance < 5) {
onBackgroundClick()
} else {
const finalRect = {
startX: dragStartRef.current.x,
startY: dragStartRef.current.y,
endX,
endY
}
const selectedIds = findWordsInRect(finalRect)
if (selectedIds.length > 0) {
onSelectionComplete(selectedIds)
}
}
}
// Reset drag state
setDragMode('none')
dragStartRef.current = null
dragWordIdRef.current = null
dragOriginalTimesRef.current = new Map()
setSelectionRect(null)
setCursorStyle('default')
}, [dragMode, onBackgroundClick, findWordsInRect, onSelectionComplete])
// Wheel handler
const handleWheel = useCallback((e: React.WheelEvent<HTMLCanvasElement>) => {
const delta = e.deltaX !== 0 ? e.deltaX : e.deltaY
const scrollAmount = (delta / 100) * (zoomSeconds / 4)
let newStart = Math.max(0, Math.min(audioDuration - zoomSeconds, visibleStartTime + scrollAmount))
if (newStart !== visibleStartTime) {
onScrollChange(newStart)
}
}, [visibleStartTime, zoomSeconds, audioDuration, onScrollChange])
const handleScrollLeft = useCallback(() => {
const newStart = Math.max(0, visibleStartTime - zoomSeconds * 0.25)
onScrollChange(newStart)
}, [visibleStartTime, zoomSeconds, onScrollChange])
const handleScrollRight = useCallback(() => {
const newStart = Math.min(audioDuration - zoomSeconds, visibleStartTime + zoomSeconds * 0.25)
onScrollChange(Math.max(0, newStart))
}, [visibleStartTime, zoomSeconds, audioDuration, onScrollChange])
return (
<Box sx={{ display: 'flex', flexDirection: 'column', gap: 0.5 }}>
<Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
<Tooltip title="Scroll Left">
<IconButton
size="small"
onClick={handleScrollLeft}
disabled={visibleStartTime <= 0}
>
<ArrowBackIcon fontSize="small" />
</IconButton>
</Tooltip>
<Box
ref={containerRef}
sx={{
flexGrow: 1,
height,
cursor: cursorStyle,
borderRadius: 1,
overflow: 'hidden'
}}
>
<canvas
ref={canvasRef}
style={{
width: '100%',
height: '100%',
display: 'block',
cursor: cursorStyle
}}
onMouseDown={handleMouseDown}
onMouseMove={handleMouseMove}
onMouseUp={handleMouseUp}
onMouseLeave={handleMouseUp}
onWheel={handleWheel}
/>
</Box>
<Tooltip title="Scroll Right">
<IconButton
size="small"
onClick={handleScrollRight}
disabled={visibleStartTime >= audioDuration - zoomSeconds}
>
<ArrowForwardIcon fontSize="small" />
</IconButton>
</Tooltip>
</Box>
</Box>
)
})
export default TimelineCanvas
@@ -0,0 +1,80 @@
import { memo, useMemo } from 'react'
import { Box, Typography } from '@mui/material'
import { Word } from '../../types'
interface UpcomingWordsBarProps {
words: Word[]
syncWordIndex: number
isManualSyncing: boolean
maxWordsToShow?: number
}
const UpcomingWordsBar = memo(function UpcomingWordsBar({
words,
syncWordIndex,
isManualSyncing,
maxWordsToShow = 20
}: UpcomingWordsBarProps) {
// Get upcoming unsynced words
const upcomingWords = useMemo(() => {
if (!isManualSyncing || syncWordIndex < 0) return []
return words
.slice(syncWordIndex)
.filter(w => w.start_time === null)
.slice(0, maxWordsToShow)
}, [words, syncWordIndex, isManualSyncing, maxWordsToShow])
const totalRemaining = useMemo(() => {
if (!isManualSyncing || syncWordIndex < 0) return 0
return words.slice(syncWordIndex).filter(w => w.start_time === null).length
}, [words, syncWordIndex, isManualSyncing])
// Show empty placeholder when no upcoming words
if (upcomingWords.length === 0) {
return null
}
return (
<Box sx={{
height: 44,
bgcolor: 'grey.100',
borderRadius: 1,
display: 'flex',
alignItems: 'center',
px: 1,
gap: 0.5,
overflow: 'hidden',
boxSizing: 'border-box'
}}>
{upcomingWords.map((word, index) => (
<Box
key={word.id}
sx={{
px: 1,
py: 0.5,
borderRadius: 0.5,
bgcolor: index === 0 ? 'error.main' : 'grey.300',
color: index === 0 ? 'white' : 'text.primary',
fontWeight: index === 0 ? 'bold' : 'normal',
fontSize: '13px',
fontFamily: 'system-ui, -apple-system, sans-serif',
whiteSpace: 'nowrap',
border: index === 0 ? '2px solid' : 'none',
borderColor: 'error.dark'
}}
>
{word.text}
</Box>
))}
{totalRemaining > maxWordsToShow && (
<Typography variant="caption" color="text.secondary" sx={{ ml: 1 }}>
+{totalRemaining - maxWordsToShow} more
</Typography>
)}
</Box>
)
})
export default UpcomingWordsBar
@@ -0,0 +1,905 @@
import { useState, useCallback, useEffect, useRef, useMemo, memo } from 'react'
import {
Box,
Typography,
Slider,
Dialog,
DialogTitle,
DialogContent,
DialogActions,
TextField,
Button,
Paper,
Alert
} from '@mui/material'
import ZoomInIcon from '@mui/icons-material/ZoomIn'
import ZoomOutIcon from '@mui/icons-material/ZoomOut'
import { Word, LyricsSegment } from '../../types'
import TimelineCanvas from './TimelineCanvas'
import UpcomingWordsBar from './UpcomingWordsBar'
import SyncControls from './SyncControls'
// Augment window type for audio functions
declare global {
interface Window {
getAudioDuration?: () => number
toggleAudioPlayback?: () => void
isAudioPlaying?: boolean
}
}
interface LyricsSynchronizerProps {
segments: LyricsSegment[]
currentTime: number
onPlaySegment?: (startTime: number) => void
onSave: (segments: LyricsSegment[]) => void
onCancel: () => void
setModalSpacebarHandler: (handler: (() => (e: KeyboardEvent) => void) | undefined) => void
}
// Constants for zoom
const MIN_ZOOM_SECONDS = 4.5 // Most zoomed in - 4.5 seconds visible
const MAX_ZOOM_SECONDS = 24 // Most zoomed out - 24 seconds visible
const ZOOM_STEPS = 50 // Number of zoom levels
// Get all words from segments
function getAllWords(segments: LyricsSegment[]): Word[] {
return segments.flatMap(s => s.words)
}
// Deep clone segments
function cloneSegments(segments: LyricsSegment[]): LyricsSegment[] {
return JSON.parse(JSON.stringify(segments))
}
const LyricsSynchronizer = memo(function LyricsSynchronizer({
segments: initialSegments,
currentTime,
onPlaySegment,
onSave,
onCancel,
setModalSpacebarHandler
}: LyricsSynchronizerProps) {
// Working copy of segments
const [workingSegments, setWorkingSegments] = useState<LyricsSegment[]>(() =>
cloneSegments(initialSegments)
)
// Get all words flattened
const allWords = useMemo(() => getAllWords(workingSegments), [workingSegments])
// Audio duration
const audioDuration = useMemo(() => {
if (typeof window.getAudioDuration === 'function') {
const duration = window.getAudioDuration()
return duration > 0 ? duration : 300
}
return 300 // 5 minute fallback
}, [])
// Zoom state (value is the visible time window in seconds)
const [zoomSeconds, setZoomSeconds] = useState(12) // Default ~12 seconds visible
// Visible time range
const [visibleStartTime, setVisibleStartTime] = useState(0)
const visibleEndTime = useMemo(() =>
Math.min(visibleStartTime + zoomSeconds, audioDuration),
[visibleStartTime, zoomSeconds, audioDuration]
)
// Manual sync state
const [isManualSyncing, setIsManualSyncing] = useState(false)
const [isPaused, setIsPaused] = useState(false)
const [syncWordIndex, setSyncWordIndex] = useState(-1)
const [isSpacebarPressed, setIsSpacebarPressed] = useState(false)
const wordStartTimeRef = useRef<number | null>(null)
const spacebarPressTimeRef = useRef<number | null>(null)
const currentTimeRef = useRef(currentTime)
// Selection state
const [selectedWordIds, setSelectedWordIds] = useState<Set<string>>(new Set())
// Edit lyrics modal state
const [showEditLyricsModal, setShowEditLyricsModal] = useState(false)
const [editLyricsText, setEditLyricsText] = useState('')
// Edit word modal state
const [showEditWordModal, setShowEditWordModal] = useState(false)
const [editWordText, setEditWordText] = useState('')
const [editWordId, setEditWordId] = useState<string | null>(null)
// Keep currentTimeRef up to date
useEffect(() => {
currentTimeRef.current = currentTime
}, [currentTime])
// Auto-scroll to follow playhead during sync
useEffect(() => {
if (isManualSyncing && !isPaused && currentTime > 0) {
// If playhead is near the end of visible area, scroll forward
if (currentTime > visibleEndTime - (zoomSeconds * 0.1)) {
const newStart = Math.max(0, currentTime - zoomSeconds * 0.1)
setVisibleStartTime(newStart)
}
// If playhead is before visible area, scroll back
else if (currentTime < visibleStartTime) {
setVisibleStartTime(Math.max(0, currentTime - 1))
}
}
}, [currentTime, isManualSyncing, isPaused, visibleStartTime, visibleEndTime, zoomSeconds])
// Handle zoom slider change
const handleZoomChange = useCallback((_: Event, value: number | number[]) => {
const zoomValue = value as number
// Map slider value (0-50) to zoom range (4.5-24 seconds)
const newZoomSeconds = MIN_ZOOM_SECONDS + (zoomValue / ZOOM_STEPS) * (MAX_ZOOM_SECONDS - MIN_ZOOM_SECONDS)
setZoomSeconds(newZoomSeconds)
}, [])
// Get slider value from zoom seconds
const sliderValue = useMemo(() => {
return ((zoomSeconds - MIN_ZOOM_SECONDS) / (MAX_ZOOM_SECONDS - MIN_ZOOM_SECONDS)) * ZOOM_STEPS
}, [zoomSeconds])
// Handle scroll change from timeline
const handleScrollChange = useCallback((newStartTime: number) => {
setVisibleStartTime(newStartTime)
}, [])
// Update words in segments
const updateWords = useCallback((newWords: Word[]) => {
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
// Create a map of word id to word for quick lookup
const wordMap = new Map(newWords.map(w => [w.id, w]))
// Update each segment's words
for (const segment of newSegments) {
segment.words = segment.words.map(w => wordMap.get(w.id) || w)
// Recalculate segment timing
const timedWords = segment.words.filter(w =>
w.start_time !== null && w.end_time !== null
)
if (timedWords.length > 0) {
segment.start_time = Math.min(...timedWords.map(w => w.start_time!))
segment.end_time = Math.max(...timedWords.map(w => w.end_time!))
} else {
segment.start_time = null
segment.end_time = null
}
}
return newSegments
})
}, [])
// Check if audio is playing
const [isPlaying, setIsPlaying] = useState(false)
// Update isPlaying state periodically
useEffect(() => {
const checkPlaying = () => {
setIsPlaying(typeof window.isAudioPlaying === 'boolean' ? window.isAudioPlaying : false)
}
checkPlaying()
const interval = setInterval(checkPlaying, 100)
return () => clearInterval(interval)
}, [])
// Play audio from current position
const handlePlayAudio = useCallback(() => {
if (onPlaySegment) {
onPlaySegment(currentTimeRef.current)
}
}, [onPlaySegment])
// Stop audio playback - also exits sync mode
const handleStopAudio = useCallback(() => {
if (typeof window.toggleAudioPlayback === 'function' && window.isAudioPlaying) {
window.toggleAudioPlayback()
}
// Also exit sync mode when stopping
if (isManualSyncing) {
setIsManualSyncing(false)
setIsPaused(false)
setIsSpacebarPressed(false)
}
}, [isManualSyncing])
// Start manual sync
const handleStartSync = useCallback(() => {
if (isManualSyncing) {
// Stop sync
setIsManualSyncing(false)
setIsPaused(false)
setSyncWordIndex(-1)
setIsSpacebarPressed(false)
// Stop audio
handleStopAudio()
return
}
// Find first unsynced word
const firstUnsyncedIndex = allWords.findIndex(w =>
w.start_time === null || w.end_time === null
)
const startIndex = firstUnsyncedIndex !== -1 ? firstUnsyncedIndex : 0
setIsManualSyncing(true)
setIsPaused(false)
setSyncWordIndex(startIndex)
setIsSpacebarPressed(false)
// Start playback
if (onPlaySegment) {
onPlaySegment(Math.max(0, currentTimeRef.current - 1))
}
}, [isManualSyncing, allWords, onPlaySegment, handleStopAudio])
// Pause sync
const handlePauseSync = useCallback(() => {
setIsPaused(true)
handleStopAudio()
}, [handleStopAudio])
// Resume sync
const handleResumeSync = useCallback(() => {
setIsPaused(false)
// Find first unsynced word from current position
const firstUnsyncedIndex = allWords.findIndex(w =>
w.start_time === null || w.end_time === null
)
if (firstUnsyncedIndex !== -1 && firstUnsyncedIndex !== syncWordIndex) {
setSyncWordIndex(firstUnsyncedIndex)
}
// Resume playback
if (onPlaySegment) {
onPlaySegment(currentTimeRef.current)
}
}, [allWords, syncWordIndex, onPlaySegment])
// Clear all sync data
const handleClearSync = useCallback(() => {
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
for (const segment of newSegments) {
for (const word of segment.words) {
word.start_time = null
word.end_time = null
}
segment.start_time = null
segment.end_time = null
}
return newSegments
})
setSyncWordIndex(-1)
}, [])
// Unsync from cursor position
const handleUnsyncFromCursor = useCallback(() => {
const cursorTime = currentTimeRef.current
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
for (const segment of newSegments) {
for (const word of segment.words) {
// Reset words that start after cursor position
if (word.start_time !== null && word.start_time > cursorTime) {
word.start_time = null
word.end_time = null
}
}
// Recalculate segment timing
const timedWords = segment.words.filter(w =>
w.start_time !== null && w.end_time !== null
)
if (timedWords.length > 0) {
segment.start_time = Math.min(...timedWords.map(w => w.start_time!))
segment.end_time = Math.max(...timedWords.map(w => w.end_time!))
} else {
segment.start_time = null
segment.end_time = null
}
}
return newSegments
})
}, [])
// Check if there are words after cursor that can be unsynced
const canUnsyncFromCursor = useMemo(() => {
const cursorTime = currentTimeRef.current
return allWords.some(w =>
w.start_time !== null && w.start_time > cursorTime
)
}, [allWords, currentTime])
// Open edit lyrics modal
const handleEditLyrics = useCallback(() => {
const text = workingSegments.map(s => s.text).join('\n')
setEditLyricsText(text)
setShowEditLyricsModal(true)
}, [workingSegments])
// Save edited lyrics (warning: resets timing)
const handleSaveEditedLyrics = useCallback(() => {
const lines = editLyricsText.split('\n').filter(l => l.trim())
const newSegments: LyricsSegment[] = lines.map((line, idx) => {
const words = line.trim().split(/\s+/).map((text, wIdx) => ({
id: `word-${idx}-${wIdx}-${Date.now()}`,
text,
start_time: null,
end_time: null,
confidence: 1.0
}))
return {
id: `segment-${idx}-${Date.now()}`,
text: line.trim(),
words,
start_time: null,
end_time: null
}
})
setWorkingSegments(newSegments)
setShowEditLyricsModal(false)
setSyncWordIndex(-1)
}, [editLyricsText])
// Open edit word modal
const handleEditSelectedWord = useCallback(() => {
if (selectedWordIds.size !== 1) return
const wordId = Array.from(selectedWordIds)[0]
const word = allWords.find(w => w.id === wordId)
if (word) {
setEditWordId(wordId)
setEditWordText(word.text)
setShowEditWordModal(true)
}
}, [selectedWordIds, allWords])
// Save edited word
const handleSaveEditedWord = useCallback(() => {
if (!editWordId) return
const newText = editWordText.trim()
if (!newText) return
// Check if we're splitting into multiple words
const newWords = newText.split(/\s+/)
if (newWords.length === 1) {
// Simple rename
const updatedWords = allWords.map(w =>
w.id === editWordId ? { ...w, text: newWords[0] } : w
)
updateWords(updatedWords)
} else {
// Split word - preserve timing for first word, null for rest
const originalWord = allWords.find(w => w.id === editWordId)
if (!originalWord) return
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
for (const segment of newSegments) {
const wordIndex = segment.words.findIndex(w => w.id === editWordId)
if (wordIndex !== -1) {
const newWordObjects = newWords.map((text, idx) => ({
id: idx === 0 ? editWordId : `${editWordId}-split-${idx}`,
text,
start_time: idx === 0 ? originalWord.start_time : null,
end_time: idx === 0 ? originalWord.end_time : null,
confidence: 1.0
}))
segment.words.splice(wordIndex, 1, ...newWordObjects)
segment.text = segment.words.map(w => w.text).join(' ')
break
}
}
return newSegments
})
}
setShowEditWordModal(false)
setEditWordId(null)
setEditWordText('')
setSelectedWordIds(new Set())
}, [editWordId, editWordText, allWords, updateWords])
// Delete selected words
const handleDeleteSelected = useCallback(() => {
if (selectedWordIds.size === 0) return
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
for (const segment of newSegments) {
segment.words = segment.words.filter(w => !selectedWordIds.has(w.id))
segment.text = segment.words.map(w => w.text).join(' ')
// Recalculate segment timing
const timedWords = segment.words.filter(w =>
w.start_time !== null && w.end_time !== null
)
if (timedWords.length > 0) {
segment.start_time = Math.min(...timedWords.map(w => w.start_time!))
segment.end_time = Math.max(...timedWords.map(w => w.end_time!))
} else {
segment.start_time = null
segment.end_time = null
}
}
// Remove empty segments
return newSegments.filter(s => s.words.length > 0)
})
setSelectedWordIds(new Set())
}, [selectedWordIds])
// Handle word click (selection)
const handleWordClick = useCallback((wordId: string, event: React.MouseEvent) => {
if (event.shiftKey || event.ctrlKey || event.metaKey) {
// Add to selection
setSelectedWordIds(prev => {
const newSet = new Set(prev)
if (newSet.has(wordId)) {
newSet.delete(wordId)
} else {
newSet.add(wordId)
}
return newSet
})
} else {
// Single selection
setSelectedWordIds(new Set([wordId]))
}
}, [])
// Handle background click (deselect)
const handleBackgroundClick = useCallback(() => {
setSelectedWordIds(new Set())
}, [])
// Handle single word timing change (from resize)
const handleWordTimingChange = useCallback((wordId: string, newStartTime: number, newEndTime: number) => {
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
for (const segment of newSegments) {
const word = segment.words.find(w => w.id === wordId)
if (word) {
word.start_time = Math.max(0, newStartTime)
word.end_time = Math.max(word.start_time + 0.05, newEndTime)
// Recalculate segment timing
const timedWords = segment.words.filter(w =>
w.start_time !== null && w.end_time !== null
)
if (timedWords.length > 0) {
segment.start_time = Math.min(...timedWords.map(w => w.start_time!))
segment.end_time = Math.max(...timedWords.map(w => w.end_time!))
}
break
}
}
return newSegments
})
}, [])
// Handle moving multiple words (from drag)
const handleWordsMove = useCallback((updates: Array<{ wordId: string; newStartTime: number; newEndTime: number }>) => {
setWorkingSegments(prevSegments => {
const newSegments = cloneSegments(prevSegments)
// Create a map for quick lookup
const updateMap = new Map(updates.map(u => [u.wordId, u]))
for (const segment of newSegments) {
for (const word of segment.words) {
const update = updateMap.get(word.id)
if (update) {
word.start_time = update.newStartTime
word.end_time = update.newEndTime
}
}
// Recalculate segment timing
const timedWords = segment.words.filter(w =>
w.start_time !== null && w.end_time !== null
)
if (timedWords.length > 0) {
segment.start_time = Math.min(...timedWords.map(w => w.start_time!))
segment.end_time = Math.max(...timedWords.map(w => w.end_time!))
}
}
return newSegments
})
}, [])
// Handle time bar click (seek to position without playing)
const handleTimeBarClick = useCallback((time: number) => {
// Scroll the timeline to show this time centered
const newStart = Math.max(0, time - zoomSeconds / 2)
setVisibleStartTime(Math.min(newStart, Math.max(0, audioDuration - zoomSeconds)))
// Seek to the position (this will briefly start playback)
if (onPlaySegment) {
onPlaySegment(time)
// Immediately stop playback after seeking
setTimeout(() => {
if (typeof window.toggleAudioPlayback === 'function' && window.isAudioPlaying) {
window.toggleAudioPlayback()
}
}, 50)
}
}, [zoomSeconds, audioDuration, onPlaySegment])
// Handle selection complete from drag
const handleSelectionComplete = useCallback((wordIds: string[]) => {
setSelectedWordIds(new Set(wordIds))
}, [])
// Handle spacebar for manual sync
const handleKeyDown = useCallback((e: KeyboardEvent) => {
if (e.code !== 'Space') return
if (!isManualSyncing || isPaused) return
if (syncWordIndex < 0 || syncWordIndex >= allWords.length) return
e.preventDefault()
e.stopPropagation()
if (isSpacebarPressed) return
setIsSpacebarPressed(true)
wordStartTimeRef.current = currentTimeRef.current
spacebarPressTimeRef.current = Date.now()
// Set start time for current word
const newWords = [...allWords]
const currentWord = newWords[syncWordIndex]
currentWord.start_time = currentTimeRef.current
// Handle previous word's end time
if (syncWordIndex > 0) {
const prevWord = newWords[syncWordIndex - 1]
if (prevWord.start_time !== null && prevWord.end_time === null) {
const gap = currentTimeRef.current - prevWord.start_time
if (gap > 1.0) {
prevWord.end_time = prevWord.start_time + 0.5
} else {
prevWord.end_time = currentTimeRef.current - 0.005
}
}
}
updateWords(newWords)
}, [isManualSyncing, isPaused, syncWordIndex, allWords, isSpacebarPressed, updateWords])
const handleKeyUp = useCallback((e: KeyboardEvent) => {
if (e.code !== 'Space') return
if (!isManualSyncing || isPaused) return
if (!isSpacebarPressed) return
e.preventDefault()
e.stopPropagation()
setIsSpacebarPressed(false)
const pressDuration = spacebarPressTimeRef.current
? Date.now() - spacebarPressTimeRef.current
: 0
const isTap = pressDuration < 200 // 200ms threshold
const newWords = [...allWords]
const currentWord = newWords[syncWordIndex]
if (isTap) {
// Short tap: default 500ms duration
currentWord.end_time = (wordStartTimeRef.current || currentTimeRef.current) + 0.5
} else {
// Hold: use actual timing
currentWord.end_time = currentTimeRef.current
}
updateWords(newWords)
// Move to next word
if (syncWordIndex < allWords.length - 1) {
setSyncWordIndex(syncWordIndex + 1)
} else {
// All words synced
setIsManualSyncing(false)
setSyncWordIndex(-1)
handleStopAudio()
}
wordStartTimeRef.current = null
spacebarPressTimeRef.current = null
}, [isManualSyncing, isPaused, isSpacebarPressed, syncWordIndex, allWords, updateWords, handleStopAudio])
// Combined spacebar handler
const handleSpacebar = useCallback((e: KeyboardEvent) => {
if (e.type === 'keydown') {
handleKeyDown(e)
} else if (e.type === 'keyup') {
handleKeyUp(e)
}
}, [handleKeyDown, handleKeyUp])
// Keep ref for handler
const spacebarHandlerRef = useRef(handleSpacebar)
spacebarHandlerRef.current = handleSpacebar
// Set up spacebar handler
useEffect(() => {
const handler = (e: KeyboardEvent) => {
if (e.code === 'Space') {
e.preventDefault()
e.stopPropagation()
spacebarHandlerRef.current(e)
}
}
setModalSpacebarHandler(() => handler)
return () => {
setModalSpacebarHandler(undefined)
}
}, [setModalSpacebarHandler])
// Handle save
const handleSave = useCallback(() => {
onSave(workingSegments)
}, [workingSegments, onSave])
// Progress stats
const stats = useMemo(() => {
const total = allWords.length
const synced = allWords.filter(w =>
w.start_time !== null && w.end_time !== null
).length
return { total, synced, remaining: total - synced }
}, [allWords])
// Get instruction text based on state
const getInstructionText = useCallback(() => {
if (isManualSyncing) {
if (isSpacebarPressed) {
// Always include secondary text to prevent layout shift
return { primary: '⏱️ Holding... release when word ends', secondary: 'Release spacebar when the word finishes' }
}
if (stats.remaining === 0) {
return { primary: '✅ All words synced!', secondary: 'Click "Stop Sync" then "Apply" to save' }
}
return { primary: '👆 Press SPACEBAR when you hear each word', secondary: 'Tap for short words, hold for longer words' }
}
if (stats.synced === 0) {
return { primary: 'Click "Start Sync" to begin timing words', secondary: 'Audio will play and you\'ll tap spacebar for each word' }
}
if (stats.remaining > 0) {
return { primary: `${stats.remaining} words remaining to sync`, secondary: 'Click "Start Sync" to continue, or "Unsync from Cursor" to re-sync from a point' }
}
return { primary: '✅ All words synced!', secondary: 'Click "Apply" to save changes, or make adjustments first' }
}, [isManualSyncing, isSpacebarPressed, stats.synced, stats.remaining])
const instruction = getInstructionText()
return (
<Box sx={{ display: 'flex', flexDirection: 'column', height: '100%', gap: 1 }}>
{/* Stats bar - fixed height */}
<Box sx={{ display: 'flex', justifyContent: 'flex-end', alignItems: 'center', height: 24 }}>
<Typography variant="body2" color="text.secondary">
{stats.synced} / {stats.total} words synced
{stats.remaining > 0 && ` (${stats.remaining} remaining)`}
</Typography>
</Box>
{/* Instruction banner - fixed height to prevent layout shifts */}
<Box
sx={{
height: 56,
flexShrink: 0
}}
>
<Paper
sx={{
p: 1.5,
height: '100%',
bgcolor: isManualSyncing ? 'info.main' : 'grey.100',
color: isManualSyncing ? 'info.contrastText' : 'text.primary',
display: 'flex',
flexDirection: 'column',
justifyContent: 'center',
overflow: 'hidden',
boxSizing: 'border-box'
}}
>
<Typography variant="body2" sx={{ fontWeight: 500, lineHeight: 1.3 }}>
{instruction.primary}
</Typography>
<Typography variant="caption" sx={{ opacity: 0.85, display: 'block', lineHeight: 1.3 }}>
{instruction.secondary}
</Typography>
</Paper>
</Box>
{/* Controls - fixed height section */}
<Box sx={{ height: 88, flexShrink: 0 }}>
<SyncControls
isManualSyncing={isManualSyncing}
isPaused={isPaused}
onStartSync={handleStartSync}
onPauseSync={handlePauseSync}
onResumeSync={handleResumeSync}
onClearSync={handleClearSync}
onEditLyrics={handleEditLyrics}
onPlay={handlePlayAudio}
onStop={handleStopAudio}
isPlaying={isPlaying}
hasSelectedWords={selectedWordIds.size > 0}
selectedWordCount={selectedWordIds.size}
onUnsyncFromCursor={handleUnsyncFromCursor}
onEditSelectedWord={handleEditSelectedWord}
onDeleteSelected={handleDeleteSelected}
canUnsyncFromCursor={canUnsyncFromCursor}
/>
</Box>
{/* Upcoming words bar - fixed height, immediately above timeline */}
<Box sx={{ height: 44, flexShrink: 0 }}>
{isManualSyncing && (
<UpcomingWordsBar
words={allWords}
syncWordIndex={syncWordIndex}
isManualSyncing={isManualSyncing}
/>
)}
</Box>
{/* Timeline canvas */}
<Box sx={{ flexGrow: 1, minHeight: 200 }}>
<TimelineCanvas
words={allWords}
segments={workingSegments}
visibleStartTime={visibleStartTime}
visibleEndTime={visibleEndTime}
currentTime={currentTime}
selectedWordIds={selectedWordIds}
onWordClick={handleWordClick}
onBackgroundClick={handleBackgroundClick}
onTimeBarClick={handleTimeBarClick}
onSelectionComplete={handleSelectionComplete}
onWordTimingChange={handleWordTimingChange}
onWordsMove={handleWordsMove}
syncWordIndex={syncWordIndex}
isManualSyncing={isManualSyncing}
onScrollChange={handleScrollChange}
audioDuration={audioDuration}
zoomSeconds={zoomSeconds}
height={200}
/>
</Box>
{/* Zoom slider */}
<Box sx={{ display: 'flex', alignItems: 'center', gap: 2, px: 2 }}>
<ZoomInIcon color="action" fontSize="small" />
<Slider
value={sliderValue}
onChange={handleZoomChange}
min={0}
max={ZOOM_STEPS}
step={1}
sx={{ flexGrow: 1 }}
disabled={isManualSyncing && !isPaused}
/>
<ZoomOutIcon color="action" fontSize="small" />
<Typography variant="caption" color="text.secondary" sx={{ minWidth: 60 }}>
{zoomSeconds.toFixed(1)}s view
</Typography>
</Box>
{/* Action buttons */}
<Box sx={{ display: 'flex', justifyContent: 'flex-end', gap: 2, pt: 2, borderTop: 1, borderColor: 'divider' }}>
<Button onClick={onCancel} color="inherit">
Cancel
</Button>
<Button
onClick={handleSave}
variant="contained"
color="primary"
disabled={isManualSyncing && !isPaused}
>
Apply
</Button>
</Box>
{/* Edit Lyrics Modal */}
<Dialog
open={showEditLyricsModal}
onClose={() => setShowEditLyricsModal(false)}
maxWidth="md"
fullWidth
>
<DialogTitle>Edit Lyrics</DialogTitle>
<DialogContent>
<Alert severity="warning" sx={{ mb: 2 }}>
Editing lyrics will reset all timing data. You will need to re-sync the entire song.
</Alert>
<TextField
multiline
rows={15}
fullWidth
value={editLyricsText}
onChange={(e) => setEditLyricsText(e.target.value)}
placeholder="Enter lyrics, one line per segment..."
/>
</DialogContent>
<DialogActions>
<Button onClick={() => setShowEditLyricsModal(false)}>Cancel</Button>
<Button onClick={handleSaveEditedLyrics} variant="contained" color="warning">
Save & Reset Timing
</Button>
</DialogActions>
</Dialog>
{/* Edit Word Modal */}
<Dialog
open={showEditWordModal}
onClose={() => setShowEditWordModal(false)}
maxWidth="xs"
fullWidth
>
<DialogTitle>Edit Word</DialogTitle>
<DialogContent>
<Typography variant="body2" color="text.secondary" sx={{ mb: 2 }}>
Edit the word text. Enter multiple words separated by spaces to split.
</Typography>
<TextField
fullWidth
value={editWordText}
onChange={(e) => setEditWordText(e.target.value)}
autoFocus
onKeyDown={(e) => {
if (e.key === 'Enter') {
handleSaveEditedWord()
}
}}
/>
</DialogContent>
<DialogActions>
<Button onClick={() => setShowEditWordModal(false)}>Cancel</Button>
<Button onClick={handleSaveEditedWord} variant="contained">
Save
</Button>
</DialogActions>
</Dialog>
</Box>
)
})
export default LyricsSynchronizer
@@ -0,0 +1,127 @@
import {
Dialog,
DialogTitle,
DialogContent,
DialogActions,
IconButton,
Box,
Button,
Typography,
Paper
} from '@mui/material'
import CloseIcon from '@mui/icons-material/Close'
import ContentPasteIcon from '@mui/icons-material/ContentPaste'
import SyncIcon from '@mui/icons-material/Sync'
interface ModeSelectionModalProps {
open: boolean
onClose: () => void
onSelectReplace: () => void // Goes to paste phase for replacing all lyrics
onSelectResync: () => void // Goes directly to sync view with existing lyrics
hasExistingLyrics: boolean // Whether there are existing lyrics to re-sync
}
export default function ModeSelectionModal({
open,
onClose,
onSelectReplace,
onSelectResync,
hasExistingLyrics
}: ModeSelectionModalProps) {
return (
<Dialog
open={open}
onClose={onClose}
maxWidth="sm"
fullWidth
>
<DialogTitle sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
<Box sx={{ flex: 1 }}>
Edit All Lyrics
</Box>
<IconButton onClick={onClose} sx={{ ml: 'auto' }}>
<CloseIcon />
</IconButton>
</DialogTitle>
<DialogContent dividers>
<Typography variant="body1" sx={{ mb: 3 }}>
Choose how you want to edit the lyrics:
</Typography>
<Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
{/* Re-sync Existing option - only show if there are existing lyrics */}
{hasExistingLyrics && (
<Paper
sx={{
p: 2,
cursor: 'pointer',
border: 2,
borderColor: 'primary.main',
'&:hover': {
bgcolor: 'action.hover',
borderColor: 'primary.dark'
}
}}
onClick={onSelectResync}
>
<Box sx={{ display: 'flex', alignItems: 'flex-start', gap: 2 }}>
<SyncIcon color="primary" sx={{ fontSize: 40, mt: 0.5 }} />
<Box>
<Typography variant="h6" color="primary">
Re-sync Existing Lyrics
</Typography>
<Typography variant="body2" color="text.secondary">
Keep the current lyrics text and fix timing issues.
Use this when lyrics are correct but timing has drifted,
especially in the second half of the song.
</Typography>
<Typography variant="caption" color="success.main" sx={{ mt: 1, display: 'block' }}>
Recommended for fixing timing drift
</Typography>
</Box>
</Box>
</Paper>
)}
{/* Replace All option */}
<Paper
sx={{
p: 2,
cursor: 'pointer',
border: 1,
borderColor: 'divider',
'&:hover': {
bgcolor: 'action.hover',
borderColor: 'text.secondary'
}
}}
onClick={onSelectReplace}
>
<Box sx={{ display: 'flex', alignItems: 'flex-start', gap: 2 }}>
<ContentPasteIcon sx={{ fontSize: 40, mt: 0.5, color: 'text.secondary' }} />
<Box>
<Typography variant="h6">
Replace All Lyrics
</Typography>
<Typography variant="body2" color="text.secondary">
Paste completely new lyrics from clipboard and manually
sync timing for all words from scratch.
</Typography>
<Typography variant="caption" color="warning.main" sx={{ mt: 1, display: 'block' }}>
All existing timing data will be lost
</Typography>
</Box>
</Box>
</Paper>
</Box>
</DialogContent>
<DialogActions>
<Button onClick={onClose} color="inherit">
Cancel
</Button>
</DialogActions>
</Dialog>
)
}
@@ -7,19 +7,17 @@ import {
Box,
Button,
Typography,
TextField,
Paper,
Divider
TextField
} from '@mui/material'
import CloseIcon from '@mui/icons-material/Close'
import ContentPasteIcon from '@mui/icons-material/ContentPaste'
import AutoFixHighIcon from '@mui/icons-material/AutoFixHigh'
import ArrowBackIcon from '@mui/icons-material/ArrowBack'
import { LyricsSegment, Word } from '../types'
import { useState, useEffect, useCallback, useMemo, useRef, memo } from 'react'
import { useState, useEffect, useCallback, useMemo } from 'react'
import { nanoid } from 'nanoid'
import useManualSync from '../hooks/useManualSync'
import EditTimelineSection from './EditTimelineSection'
import EditActionBar from './EditActionBar'
import ModeSelectionModal from './ModeSelectionModal'
import LyricsSynchronizer from './LyricsSynchronizer'
// Augment window type for audio functions
declare global {
@@ -30,6 +28,8 @@ declare global {
}
}
type ModalMode = 'selection' | 'replace' | 'resync'
interface ReplaceAllLyricsModalProps {
open: boolean
onClose: () => void
@@ -37,6 +37,7 @@ interface ReplaceAllLyricsModalProps {
onPlaySegment?: (startTime: number) => void
currentTime?: number
setModalSpacebarHandler: (handler: (() => (e: KeyboardEvent) => void) | undefined) => void
existingSegments?: LyricsSegment[] // Current segments for re-sync mode
}
export default function ReplaceAllLyricsModal({
@@ -45,22 +46,21 @@ export default function ReplaceAllLyricsModal({
onSave,
onPlaySegment,
currentTime = 0,
setModalSpacebarHandler
setModalSpacebarHandler,
existingSegments = []
}: ReplaceAllLyricsModalProps) {
const [mode, setMode] = useState<ModalMode>('selection')
const [inputText, setInputText] = useState('')
const [isReplaced, setIsReplaced] = useState(false)
const [globalSegment, setGlobalSegment] = useState<LyricsSegment | null>(null)
const [originalSegments, setOriginalSegments] = useState<LyricsSegment[]>([])
const [currentSegments, setCurrentSegments] = useState<LyricsSegment[]>([])
const [newSegments, setNewSegments] = useState<LyricsSegment[]>([])
// Get the real audio duration, with fallback
const getAudioDuration = useCallback(() => {
if (window.getAudioDuration) {
const duration = window.getAudioDuration()
return duration > 0 ? duration : 600 // Use real duration or 10 min fallback
// Reset state when modal opens
useEffect(() => {
if (open) {
setMode('selection')
setInputText('')
setNewSegments([])
}
return 600 // 10 minute fallback if audio not loaded
}, [])
}, [open])
// Parse the input text to get line and word counts
const parseInfo = useMemo(() => {
@@ -79,61 +79,31 @@ export default function ReplaceAllLyricsModal({
if (!inputText.trim()) return
const lines = inputText.trim().split('\n').filter(line => line.trim().length > 0)
const newSegments: LyricsSegment[] = []
const allWords: Word[] = []
const segments: LyricsSegment[] = []
lines.forEach((line) => {
const words = line.trim().split(/\s+/).filter(word => word.length > 0)
const segmentWords: Word[] = []
const segmentWords: Word[] = words.map((wordText) => ({
id: nanoid(),
text: wordText,
start_time: null,
end_time: null,
confidence: 1.0,
created_during_correction: true
}))
words.forEach((wordText) => {
const word: Word = {
id: nanoid(),
text: wordText,
start_time: null,
end_time: null,
confidence: 1.0,
created_during_correction: true
}
segmentWords.push(word)
allWords.push(word)
})
const segment: LyricsSegment = {
segments.push({
id: nanoid(),
text: line.trim(),
words: segmentWords,
start_time: null,
end_time: null
}
newSegments.push(segment)
})
})
// Create a global segment with all words for manual sync
// Set a very large end time to ensure manual sync doesn't stop prematurely
const audioDuration = getAudioDuration()
const endTime = Math.max(audioDuration, 3600) // At least 1 hour to prevent auto-stop
console.log('ReplaceAllLyricsModal - Creating global segment', {
audioDuration,
endTime,
wordCount: allWords.length
})
const globalSegment: LyricsSegment = {
id: 'global-replacement',
text: allWords.map(w => w.text).join(' '),
words: allWords,
start_time: 0,
end_time: endTime
}
setCurrentSegments(newSegments)
setOriginalSegments(JSON.parse(JSON.stringify(newSegments)))
setGlobalSegment(globalSegment)
setIsReplaced(true)
}, [inputText, getAudioDuration])
setNewSegments(segments)
setMode('resync') // Go to synchronizer with the new segments
}, [inputText])
// Handle paste from clipboard
const handlePasteFromClipboard = useCallback(async () => {
@@ -146,311 +116,90 @@ export default function ReplaceAllLyricsModal({
}
}, [])
// Update segment when words change during manual sync
const updateSegment = useCallback((newWords: Word[]) => {
if (!globalSegment) return
const validStartTimes = newWords.map(w => w.start_time).filter((t): t is number => t !== null)
const validEndTimes = newWords.map(w => w.end_time).filter((t): t is number => t !== null)
const segmentStartTime = validStartTimes.length > 0 ? Math.min(...validStartTimes) : null
const segmentEndTime = validEndTimes.length > 0 ? Math.max(...validEndTimes) : null
const updatedGlobalSegment = {
...globalSegment,
words: newWords,
text: newWords.map(w => w.text).join(' '),
start_time: segmentStartTime,
end_time: segmentEndTime
}
// Batch state updates to prevent multiple re-renders
setGlobalSegment(updatedGlobalSegment)
// Update individual segment timing as words get synced - but only calculate when needed
const updatedSegments = currentSegments.map(segment => {
// Find words that belong to this segment and have been timed
const segmentWordsWithTiming = segment.words.map(segmentWord => {
const globalWord = newWords.find(w => w.id === segmentWord.id)
return globalWord || segmentWord
})
// Calculate segment timing if all words have timing
const wordsWithTiming = segmentWordsWithTiming.filter(w =>
w.start_time !== null && w.end_time !== null
)
if (wordsWithTiming.length === segmentWordsWithTiming.length && wordsWithTiming.length > 0) {
// All words in this segment have timing - update segment timing
const segmentStart = Math.min(...wordsWithTiming.map(w => w.start_time!))
const segmentEnd = Math.max(...wordsWithTiming.map(w => w.end_time!))
return {
...segment,
words: segmentWordsWithTiming,
start_time: segmentStart,
end_time: segmentEnd
}
} else {
// Some words still don't have timing - just update the words
return {
...segment,
words: segmentWordsWithTiming
}
}
})
setCurrentSegments(updatedSegments)
}, [globalSegment, currentSegments])
// Use the manual sync hook
const {
isManualSyncing,
isPaused,
syncWordIndex,
startManualSync,
pauseManualSync,
resumeManualSync,
cleanupManualSync,
handleSpacebar,
isSpacebarPressed
} = useManualSync({
editedSegment: globalSegment,
currentTime,
onPlaySegment,
updateSegment
})
// Handle manual word updates (drag/resize in timeline)
const handleWordUpdate = useCallback((wordIndex: number, updates: Partial<Word>) => {
if (!globalSegment) return
// Only allow manual adjustments when manual sync is paused or not active
if (isManualSyncing && !isPaused) {
console.log('ReplaceAllLyricsModal - Ignoring word update during active manual sync')
return
}
console.log('ReplaceAllLyricsModal - Manual word update', {
wordIndex,
wordText: globalSegment.words[wordIndex]?.text,
updates,
isManualSyncing,
isPaused
})
// Update the word in the global segment
const newWords = [...globalSegment.words]
newWords[wordIndex] = {
...newWords[wordIndex],
...updates
}
// Update the global segment through the existing updateSegment function
updateSegment(newWords)
}, [globalSegment, updateSegment, isManualSyncing, isPaused])
// Handle un-syncing a word (right-click context menu)
const handleUnsyncWord = useCallback((wordIndex: number) => {
if (!globalSegment) return
console.log('ReplaceAllLyricsModal - Un-syncing word', {
wordIndex,
wordText: globalSegment.words[wordIndex]?.text
})
// Update the word to remove timing
const newWords = [...globalSegment.words]
newWords[wordIndex] = {
...newWords[wordIndex],
start_time: null,
end_time: null
}
// Update the global segment through the existing updateSegment function
updateSegment(newWords)
}, [globalSegment, updateSegment])
// Handle modal close
const handleClose = useCallback(() => {
cleanupManualSync()
setMode('selection')
setInputText('')
setIsReplaced(false)
setGlobalSegment(null)
setOriginalSegments([])
setCurrentSegments([])
setNewSegments([])
onClose()
}, [onClose, cleanupManualSync])
}, [onClose])
// Handle save
const handleSave = useCallback(() => {
if (!globalSegment || !currentSegments.length) return
// Distribute the timed words back to their original segments
const finalSegments: LyricsSegment[] = []
let wordIndex = 0
currentSegments.forEach((segment) => {
const originalWordCount = segment.words.length
const segmentWords = globalSegment.words.slice(wordIndex, wordIndex + originalWordCount)
wordIndex += originalWordCount
if (segmentWords.length > 0) {
// Recalculate segment start and end times
const validStartTimes = segmentWords.map(w => w.start_time).filter((t): t is number => t !== null)
const validEndTimes = segmentWords.map(w => w.end_time).filter((t): t is number => t !== null)
const segmentStartTime = validStartTimes.length > 0 ? Math.min(...validStartTimes) : null
const segmentEndTime = validEndTimes.length > 0 ? Math.max(...validEndTimes) : null
finalSegments.push({
...segment,
words: segmentWords,
text: segmentWords.map(w => w.text).join(' '),
start_time: segmentStartTime,
end_time: segmentEndTime
})
}
})
console.log('ReplaceAllLyricsModal - Saving new segments:', {
originalSegmentCount: currentSegments.length,
finalSegmentCount: finalSegments.length,
totalWords: finalSegments.reduce((count, seg) => count + seg.words.length, 0)
})
onSave(finalSegments)
// Handle save from synchronizer
const handleSave = useCallback((segments: LyricsSegment[]) => {
onSave(segments)
handleClose()
}, [globalSegment, currentSegments, onSave, handleClose])
}, [onSave, handleClose])
// Handle reset
const handleReset = useCallback(() => {
if (!originalSegments.length) return
// Handle mode selection
const handleSelectReplace = useCallback(() => {
setMode('replace')
}, [])
console.log('ReplaceAllLyricsModal - Resetting to original state')
// Reset all words to have null timing (ready for fresh manual sync)
const resetWords = originalSegments.flatMap(segment =>
segment.words.map(word => ({
...word,
start_time: null,
end_time: null
}))
)
const audioDuration = getAudioDuration()
const resetGlobalSegment: LyricsSegment = {
id: 'global-replacement',
text: resetWords.map(w => w.text).join(' '),
words: resetWords,
start_time: 0,
end_time: Math.max(audioDuration, 3600) // At least 1 hour to prevent auto-stop
}
const handleSelectResync = useCallback(() => {
setMode('resync')
}, [])
// Also reset the current segments to have null timing
const resetCurrentSegments = originalSegments.map(segment => ({
...segment,
words: segment.words.map(word => ({
...word,
start_time: null,
end_time: null
})),
start_time: null,
end_time: null
}))
// Handle back to selection
const handleBackToSelection = useCallback(() => {
setMode('selection')
setInputText('')
setNewSegments([])
}, [])
setGlobalSegment(resetGlobalSegment)
setCurrentSegments(resetCurrentSegments)
}, [originalSegments, getAudioDuration])
// Determine which segments to use for synchronizer
const segmentsForSync = mode === 'resync' && newSegments.length > 0
? newSegments
: existingSegments
// Keep a ref to the current spacebar handler to avoid closure issues
const spacebarHandlerRef = useRef(handleSpacebar)
spacebarHandlerRef.current = handleSpacebar
// Update the spacebar handler when modal state changes
useEffect(() => {
if (open && isReplaced) {
console.log('ReplaceAllLyricsModal - Setting up spacebar handler')
const handleKeyEvent = (e: KeyboardEvent) => {
if (e.code === 'Space') {
console.log('ReplaceAllLyricsModal - Spacebar captured in modal')
e.preventDefault()
e.stopPropagation()
// Use the ref to get the current handler
spacebarHandlerRef.current(e)
}
}
setModalSpacebarHandler(() => handleKeyEvent)
return () => {
if (!open) {
console.log('ReplaceAllLyricsModal - Clearing spacebar handler')
setModalSpacebarHandler(undefined)
}
}
} else if (open) {
// Clear handler when not in replaced state
setModalSpacebarHandler(undefined)
}
}, [open, isReplaced, setModalSpacebarHandler])
// Memoize timeline range to prevent recalculation
const timeRange = useMemo(() => {
const audioDuration = getAudioDuration()
// Always use full song duration for replace-all mode
return { start: 0, end: audioDuration }
}, [getAudioDuration])
// Memoize the segment progress props to prevent unnecessary re-renders
const segmentProgressProps = useMemo(() => ({
currentSegments,
globalSegment,
syncWordIndex
}), [currentSegments, globalSegment, syncWordIndex])
// Check if we have existing lyrics
const hasExistingLyrics = existingSegments.length > 0 &&
existingSegments.some(s => s.words.length > 0)
return (
<Dialog
open={open}
onClose={handleClose}
maxWidth={false}
fullWidth={true}
onKeyDown={(e) => {
if (e.key === 'Enter' && !e.shiftKey && isReplaced) {
e.preventDefault()
handleSave()
}
}}
PaperProps={{
sx: {
height: '90vh',
margin: '5vh 2vh',
maxWidth: 'calc(100vw - 4vh)',
width: 'calc(100vw - 4vh)'
}
}}
>
<DialogTitle sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
<Box sx={{ flex: 1 }}>
Replace All Lyrics
</Box>
<IconButton onClick={handleClose} sx={{ ml: 'auto' }}>
<CloseIcon />
</IconButton>
</DialogTitle>
<>
{/* Mode Selection Modal */}
<ModeSelectionModal
open={open && mode === 'selection'}
onClose={handleClose}
onSelectReplace={handleSelectReplace}
onSelectResync={handleSelectResync}
hasExistingLyrics={hasExistingLyrics}
/>
<DialogContent
dividers
sx={{
display: 'flex',
flexDirection: 'column',
flexGrow: 1,
overflow: 'hidden'
{/* Replace All Lyrics Modal (Paste Phase) */}
<Dialog
open={open && mode === 'replace'}
onClose={handleClose}
maxWidth="md"
fullWidth
PaperProps={{
sx: {
height: '80vh',
maxHeight: '80vh'
}
}}
>
{!isReplaced ? (
// Step 1: Input new lyrics
<DialogTitle sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
<IconButton onClick={handleBackToSelection} size="small">
<ArrowBackIcon />
</IconButton>
<Box sx={{ flex: 1 }}>
Replace All Lyrics
</Box>
<IconButton onClick={handleClose} sx={{ ml: 'auto' }}>
<CloseIcon />
</IconButton>
</DialogTitle>
<DialogContent
dividers
sx={{
display: 'flex',
flexDirection: 'column',
flexGrow: 1,
overflow: 'hidden'
}}
>
<Box sx={{ display: 'flex', flexDirection: 'column', gap: 2, height: '100%' }}>
<Typography variant="h6" gutterBottom>
Paste your new lyrics below:
@@ -492,197 +241,96 @@ export default function ReplaceAllLyricsModal({
}
}}
/>
<Box sx={{ display: 'flex', justifyContent: 'flex-end', gap: 2 }}>
<Button
variant="contained"
onClick={processLyrics}
disabled={!inputText.trim()}
startIcon={<AutoFixHighIcon />}
>
Replace All Lyrics
</Button>
</Box>
</Box>
) : (
// Step 2: Manual sync interface
<Box sx={{ display: 'flex', flexDirection: 'column', height: '100%', gap: 2 }}>
<Paper sx={{ p: 2, bgcolor: 'background.paper' }}>
<Typography variant="h6" gutterBottom>
Lyrics Replaced Successfully
</Typography>
<Typography variant="body2" color="text.secondary">
Created {currentSegments.length} segments with {globalSegment?.words.length} words total.
Use Manual Sync to set timing for all words.
</Typography>
</Paper>
</DialogContent>
<Divider />
<DialogActions>
<Button onClick={handleClose} color="inherit">
Cancel
</Button>
<Button
variant="contained"
onClick={processLyrics}
disabled={!inputText.trim()}
startIcon={<AutoFixHighIcon />}
>
Continue to Sync
</Button>
</DialogActions>
</Dialog>
{globalSegment && (
<Box sx={{ display: 'flex', gap: 2, flexGrow: 1, minHeight: 0 }}>
{/* Timeline Section */}
<Box sx={{ flex: 2, display: 'flex', flexDirection: 'column', minHeight: 0 }}>
<EditTimelineSection
words={globalSegment.words}
startTime={timeRange.start}
endTime={timeRange.end}
originalStartTime={0}
originalEndTime={getAudioDuration()}
currentStartTime={globalSegment.start_time}
currentEndTime={globalSegment.end_time}
currentTime={currentTime}
isManualSyncing={isManualSyncing}
syncWordIndex={syncWordIndex}
isSpacebarPressed={isSpacebarPressed}
onWordUpdate={handleWordUpdate}
onUnsyncWord={handleUnsyncWord}
onPlaySegment={onPlaySegment}
onStopAudio={() => {
// Stop audio playback using global function
if (window.toggleAudioPlayback && window.isAudioPlaying) {
window.toggleAudioPlayback()
}
}}
startManualSync={startManualSync}
pauseManualSync={pauseManualSync}
resumeManualSync={resumeManualSync}
isPaused={isPaused}
isGlobal={true}
defaultZoomLevel={10} // Show 10 seconds by default
isReplaceAllMode={true} // Prevent zoom changes during sync
/>
</Box>
{/* Segment Progress Section */}
<SegmentProgressPanel
currentSegments={segmentProgressProps.currentSegments}
globalSegment={segmentProgressProps.globalSegment}
syncWordIndex={segmentProgressProps.syncWordIndex}
/>
</Box>
)}
</Box>
)}
</DialogContent>
<DialogActions>
{isReplaced && (
<EditActionBar
onReset={handleReset}
onClose={handleClose}
onSave={handleSave}
editedSegment={globalSegment}
isGlobal={true}
/>
)}
</DialogActions>
</Dialog>
)
}
// Memoized Segment Progress Item to prevent unnecessary re-renders
const SegmentProgressItem = memo(({
segment,
index,
isActive
}: {
segment: LyricsSegment
index: number
isActive: boolean
}) => {
const wordsWithTiming = segment.words.filter(w =>
w.start_time !== null && w.end_time !== null
).length
const totalWords = segment.words.length
const isComplete = wordsWithTiming === totalWords
return (
<Paper
key={segment.id}
ref={isActive ? (el) => {
// Auto-scroll to active segment
if (el) {
el.scrollIntoView({
behavior: 'smooth',
block: 'center'
})
}
} : undefined}
sx={{
p: 1,
mb: 1,
bgcolor: isActive ? 'primary.light' :
isComplete ? 'success.light' : 'background.paper',
border: isActive ? 2 : 1,
borderColor: isActive ? 'primary.main' : 'divider'
}}
>
<Typography
variant="body2"
sx={{
fontWeight: isActive ? 'bold' : 'normal',
mb: 0.5
{/* Synchronizer Modal */}
<Dialog
open={open && mode === 'resync'}
onClose={handleClose}
maxWidth={false}
fullWidth
PaperProps={{
sx: {
height: '90vh',
margin: '5vh 2vw',
maxWidth: 'calc(100vw - 4vw)',
width: 'calc(100vw - 4vw)'
}
}}
>
Segment {index + 1}: {segment.text.slice(0, 50)}
{segment.text.length > 50 ? '...' : ''}
</Typography>
<Typography variant="caption" color="text.secondary">
{wordsWithTiming}/{totalWords} words synced
{isComplete && segment.start_time !== null && segment.end_time !== null && (
<>
<br />
{segment.start_time.toFixed(2)}s - {segment.end_time.toFixed(2)}s
</>
)}
</Typography>
</Paper>
)
})
<DialogTitle sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
<IconButton onClick={handleBackToSelection} size="small">
<ArrowBackIcon />
</IconButton>
<Box sx={{ flex: 1 }}>
{newSegments.length > 0 ? 'Sync New Lyrics' : 'Re-sync Existing Lyrics'}
</Box>
<IconButton onClick={handleClose} sx={{ ml: 'auto' }}>
<CloseIcon />
</IconButton>
</DialogTitle>
// Memoized Segment Progress Panel
const SegmentProgressPanel = memo(({
currentSegments,
globalSegment,
syncWordIndex
}: {
currentSegments: LyricsSegment[]
globalSegment: LyricsSegment | null
syncWordIndex: number
}) => {
return (
<Box sx={{ flex: 1, display: 'flex', flexDirection: 'column', minHeight: 0 }}>
<Typography variant="h6" gutterBottom>
Segment Progress
</Typography>
<Box sx={{
overflow: 'auto',
flexGrow: 1,
border: 1,
borderColor: 'divider',
borderRadius: 1,
p: 1
}}>
{currentSegments.map((segment, index) => {
const isActive = Boolean(
globalSegment &&
syncWordIndex >= 0 &&
syncWordIndex < globalSegment.words.length &&
globalSegment.words[syncWordIndex] &&
segment.words.some(w => w.id === globalSegment.words[syncWordIndex].id)
)
return (
<SegmentProgressItem
key={segment.id}
segment={segment}
index={index}
isActive={isActive}
<DialogContent
dividers
sx={{
display: 'flex',
flexDirection: 'column',
flexGrow: 1,
overflow: 'hidden',
p: 2
}}
>
{segmentsForSync.length > 0 ? (
<LyricsSynchronizer
segments={segmentsForSync}
currentTime={currentTime}
onPlaySegment={onPlaySegment}
onSave={handleSave}
onCancel={handleClose}
setModalSpacebarHandler={setModalSpacebarHandler}
/>
)
})}
</Box>
</Box>
) : (
<Box sx={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
justifyContent: 'center',
height: '100%',
gap: 2
}}>
<Typography variant="h6" color="text.secondary">
No lyrics to sync
</Typography>
<Typography variant="body2" color="text.secondary">
Go back and paste new lyrics, or close this modal.
</Typography>
<Button
variant="outlined"
onClick={handleBackToSelection}
startIcon={<ArrowBackIcon />}
>
Back to Selection
</Button>
</Box>
)}
</DialogContent>
</Dialog>
</>
)
})
}
@@ -1 +1 @@
{"root":["./src/app.tsx","./src/api.ts","./src/main.tsx","./src/theme.ts","./src/types.ts","./src/validation.ts","./src/vite-env.d.ts","./src/components/aifeedbackmodal.tsx","./src/components/addlyricsmodal.tsx","./src/components/agenticcorrectionmetrics.tsx","./src/components/audioplayer.tsx","./src/components/correctedwordwithactions.tsx","./src/components/correctionannotationmodal.tsx","./src/components/correctiondetailcard.tsx","./src/components/correctionmetrics.tsx","./src/components/durationtimelineview.tsx","./src/components/editactionbar.tsx","./src/components/editmodal.tsx","./src/components/edittimelinesection.tsx","./src/components/editwordlist.tsx","./src/components/fileupload.tsx","./src/components/findreplacemodal.tsx","./src/components/header.tsx","./src/components/lyricsanalyzer.tsx","./src/components/metricsdashboard.tsx","./src/components/modeselector.tsx","./src/components/modelselector.tsx","./src/components/previewvideosection.tsx","./src/components/referenceview.tsx","./src/components/replacealllyricsmodal.tsx","./src/components/reviewchangesmodal.tsx","./src/components/segmentdetailsmodal.tsx","./src/components/timelineeditor.tsx","./src/components/timingoffsetmodal.tsx","./src/components/transcriptionview.tsx","./src/components/worddivider.tsx","./src/components/shared/constants.ts","./src/components/shared/styles.ts","./src/components/shared/types.ts","./src/components/shared/components/highlightedtext.tsx","./src/components/shared/components/sourceselector.tsx","./src/components/shared/components/word.tsx","./src/components/shared/hooks/usewordclick.ts","./src/components/shared/utils/keyboardhandlers.ts","./src/components/shared/utils/localstorage.ts","./src/components/shared/utils/referencelinecalculator.ts","./src/components/shared/utils/segmentoperations.ts","./src/components/shared/utils/timingutils.ts","./src/components/shared/utils/wordutils.ts","./src/hooks/usemanualsync.ts","./src/types/global.d.ts"],"version":"5.6.3"}
{"root":["./src/app.tsx","./src/api.ts","./src/main.tsx","./src/theme.ts","./src/types.ts","./src/validation.ts","./src/vite-env.d.ts","./src/components/aifeedbackmodal.tsx","./src/components/addlyricsmodal.tsx","./src/components/agenticcorrectionmetrics.tsx","./src/components/audioplayer.tsx","./src/components/correctedwordwithactions.tsx","./src/components/correctionannotationmodal.tsx","./src/components/correctiondetailcard.tsx","./src/components/correctionmetrics.tsx","./src/components/durationtimelineview.tsx","./src/components/editactionbar.tsx","./src/components/editmodal.tsx","./src/components/edittimelinesection.tsx","./src/components/editwordlist.tsx","./src/components/fileupload.tsx","./src/components/findreplacemodal.tsx","./src/components/header.tsx","./src/components/lyricsanalyzer.tsx","./src/components/metricsdashboard.tsx","./src/components/modeselectionmodal.tsx","./src/components/modeselector.tsx","./src/components/modelselector.tsx","./src/components/previewvideosection.tsx","./src/components/referenceview.tsx","./src/components/replacealllyricsmodal.tsx","./src/components/reviewchangesmodal.tsx","./src/components/segmentdetailsmodal.tsx","./src/components/timelineeditor.tsx","./src/components/timingoffsetmodal.tsx","./src/components/transcriptionview.tsx","./src/components/worddivider.tsx","./src/components/lyricssynchronizer/synccontrols.tsx","./src/components/lyricssynchronizer/timelinecanvas.tsx","./src/components/lyricssynchronizer/upcomingwordsbar.tsx","./src/components/lyricssynchronizer/index.tsx","./src/components/shared/constants.ts","./src/components/shared/styles.ts","./src/components/shared/types.ts","./src/components/shared/components/highlightedtext.tsx","./src/components/shared/components/sourceselector.tsx","./src/components/shared/components/word.tsx","./src/components/shared/hooks/usewordclick.ts","./src/components/shared/utils/keyboardhandlers.ts","./src/components/shared/utils/localstorage.ts","./src/components/shared/utils/referencelinecalculator.ts","./src/components/shared/utils/segmentoperations.ts","./src/components/shared/utils/timingutils.ts","./src/components/shared/utils/wordutils.ts","./src/hooks/usemanualsync.ts","./src/types/global.d.ts"],"version":"5.6.3"}
@@ -0,0 +1 @@
{"version":3,"file":"index-COYImAcx.js","sources":["../../node_modules/react/cjs/react.production.min.js","../../node_modules/react/index.js","../../node_modules/react/cjs/react-jsx-runtime.production.min.js","../../node_modules/react/jsx-runtime.js","../../node_modules/scheduler/cjs/scheduler.production.min.js","../../node_modules/scheduler/index.js","../../node_modules/react-dom/cjs/react-dom.production.min.js","../../node_modules/react-dom/index.js","../../node_modules/react-dom/client.js","../../node_modules/@mui/utils/esm/formatMuiErrorMessage/formatMuiErrorMessage.js","../../node_modules/@mui/material/styles/identifier.js","../../node_modules/@babel/runtime/helpers/esm/extends.js","../../node_modules/@emotion/sheet/dist/emotion-sheet.esm.js","../../node_modules/stylis/src/Enum.js","../../node_modules/stylis/src/Utility.js","../../node_modules/stylis/src/Tokenizer.js","../../node_modules/stylis/src/Parser.js","../../node_modules/stylis/src/Serializer.js","../../node_modules/stylis/src/Middleware.js","../../node_modules/@emotion/memoize/dist/emotion-memoize.esm.js","../../node_modules/@emotion/cache/dist/emotion-cache.browser.esm.js","../../node_modules/react-is/cjs/react-is.production.min.js","../../node_modules/react-is/index.js","../../node_modules/hoist-non-react-statics/dist/hoist-non-react-statics.cjs.js","../../node_modules/@emotion/utils/dist/emotion-utils.browser.esm.js","../../node_modules/@emotion/hash/dist/emotion-hash.esm.js","../../node_modules/@emotion/unitless/dist/emotion-unitless.esm.js","../../node_modules/@emotion/serialize/dist/emotion-serialize.esm.js","../../node_modules/@emotion/use-insertion-effect-with-fallbacks/dist/emotion-use-insertion-effect-with-fallbacks.browser.esm.js","../../node_modules/@emotion/react/dist/emotion-element-f0de968e.browser.esm.js","../../node_modules/@emotion/react/dist/emotion-react.browser.esm.js","../../node_modules/@emotion/is-prop-valid/dist/emotion-is-prop-valid.esm.js","../../node_modules/@emotion/styled/base/dist/emotion-styled-base.browser.esm.js","../../node_modules/@emotion/styled/dist/emotion-styled.browser.esm.js","../../node_modules/@mui/styled-engine/GlobalStyles/GlobalStyles.js","../../node_modules/@mui/styled-engine/index.js","../../node_modules/@mui/utils/node_modules/react-is/cjs/react-is.production.js","../../node_modules/@mui/utils/node_modules/react-is/index.js","../../node_modules/@mui/utils/esm/deepmerge/deepmerge.js","../../node_modules/@mui/system/esm/createBreakpoints/createBreakpoints.js","../../node_modules/@mui/system/esm/cssContainerQueries/cssContainerQueries.js","../../node_modules/@mui/system/esm/createTheme/shape.js","../../node_modules/@mui/system/esm/merge/merge.js","../../node_modules/@mui/system/esm/breakpoints/breakpoints.js","../../node_modules/@mui/utils/esm/capitalize/capitalize.js","../../node_modules/@mui/system/esm/style/style.js","../../node_modules/@mui/system/esm/memoize/memoize.js","../../node_modules/@mui/system/esm/spacing/spacing.js","../../node_modules/@mui/system/esm/createTheme/createSpacing.js","../../node_modules/@mui/system/esm/compose/compose.js","../../node_modules/@mui/system/esm/borders/borders.js","../../node_modules/@mui/system/esm/cssGrid/cssGrid.js","../../node_modules/@mui/system/esm/palette/palette.js","../../node_modules/@mui/system/esm/sizing/sizing.js","../../node_modules/@mui/system/esm/styleFunctionSx/defaultSxConfig.js","../../node_modules/@mui/system/esm/styleFunctionSx/styleFunctionSx.js","../../node_modules/@mui/system/esm/createTheme/applyStyles.js","../../node_modules/@mui/system/esm/createTheme/createTheme.js","../../node_modules/@mui/system/esm/useThemeWithoutDefault/useThemeWithoutDefault.js","../../node_modules/@mui/system/esm/useTheme/useTheme.js","../../node_modules/@mui/system/esm/GlobalStyles/GlobalStyles.js","../../node_modules/@mui/system/esm/styleFunctionSx/extendSxProp.js","../../node_modules/@mui/utils/esm/ClassNameGenerator/ClassNameGenerator.js","../../node_modules/clsx/dist/clsx.mjs","../../node_modules/@mui/system/esm/createBox/createBox.js","../../node_modules/@mui/utils/esm/generateUtilityClass/generateUtilityClass.js","../../node_modules/@mui/utils/esm/generateUtilityClasses/generateUtilityClasses.js","../../node_modules/@mui/system/esm/preprocessStyles.js","../../node_modules/@mui/system/esm/createStyled/createStyled.js","../../node_modules/@mui/system/esm/styled/styled.js","../../node_modules/@mui/utils/esm/resolveProps/resolveProps.js","../../node_modules/@mui/system/esm/useThemeProps/getThemeProps.js","../../node_modules/@mui/system/esm/useThemeProps/useThemeProps.js","../../node_modules/@mui/utils/esm/useEnhancedEffect/useEnhancedEffect.js","../../node_modules/@mui/system/esm/useMediaQuery/useMediaQuery.js","../../node_modules/@mui/utils/esm/clamp/clamp.js","../../node_modules/@mui/system/esm/colorManipulator/colorManipulator.js","../../node_modules/@mui/utils/esm/createChainedFunction/createChainedFunction.js","../../node_modules/@mui/utils/esm/debLine truncated
@@ -1 +0,0 @@
{"version":3,"file":"index-DdJTDWH3.js","sources":["../../node_modules/react/cjs/react.production.min.js","../../node_modules/react/index.js","../../node_modules/react/cjs/react-jsx-runtime.production.min.js","../../node_modules/react/jsx-runtime.js","../../node_modules/scheduler/cjs/scheduler.production.min.js","../../node_modules/scheduler/index.js","../../node_modules/react-dom/cjs/react-dom.production.min.js","../../node_modules/react-dom/index.js","../../node_modules/react-dom/client.js","../../node_modules/@mui/utils/esm/formatMuiErrorMessage/formatMuiErrorMessage.js","../../node_modules/@mui/material/styles/identifier.js","../../node_modules/@babel/runtime/helpers/esm/extends.js","../../node_modules/@emotion/sheet/dist/emotion-sheet.esm.js","../../node_modules/stylis/src/Enum.js","../../node_modules/stylis/src/Utility.js","../../node_modules/stylis/src/Tokenizer.js","../../node_modules/stylis/src/Parser.js","../../node_modules/stylis/src/Serializer.js","../../node_modules/stylis/src/Middleware.js","../../node_modules/@emotion/memoize/dist/emotion-memoize.esm.js","../../node_modules/@emotion/cache/dist/emotion-cache.browser.esm.js","../../node_modules/react-is/cjs/react-is.production.min.js","../../node_modules/react-is/index.js","../../node_modules/hoist-non-react-statics/dist/hoist-non-react-statics.cjs.js","../../node_modules/@emotion/utils/dist/emotion-utils.browser.esm.js","../../node_modules/@emotion/hash/dist/emotion-hash.esm.js","../../node_modules/@emotion/unitless/dist/emotion-unitless.esm.js","../../node_modules/@emotion/serialize/dist/emotion-serialize.esm.js","../../node_modules/@emotion/use-insertion-effect-with-fallbacks/dist/emotion-use-insertion-effect-with-fallbacks.browser.esm.js","../../node_modules/@emotion/react/dist/emotion-element-f0de968e.browser.esm.js","../../node_modules/@emotion/react/dist/emotion-react.browser.esm.js","../../node_modules/@emotion/is-prop-valid/dist/emotion-is-prop-valid.esm.js","../../node_modules/@emotion/styled/base/dist/emotion-styled-base.browser.esm.js","../../node_modules/@emotion/styled/dist/emotion-styled.browser.esm.js","../../node_modules/@mui/styled-engine/GlobalStyles/GlobalStyles.js","../../node_modules/@mui/styled-engine/index.js","../../node_modules/@mui/utils/node_modules/react-is/cjs/react-is.production.js","../../node_modules/@mui/utils/node_modules/react-is/index.js","../../node_modules/@mui/utils/esm/deepmerge/deepmerge.js","../../node_modules/@mui/system/esm/createBreakpoints/createBreakpoints.js","../../node_modules/@mui/system/esm/cssContainerQueries/cssContainerQueries.js","../../node_modules/@mui/system/esm/createTheme/shape.js","../../node_modules/@mui/system/esm/merge/merge.js","../../node_modules/@mui/system/esm/breakpoints/breakpoints.js","../../node_modules/@mui/utils/esm/capitalize/capitalize.js","../../node_modules/@mui/system/esm/style/style.js","../../node_modules/@mui/system/esm/memoize/memoize.js","../../node_modules/@mui/system/esm/spacing/spacing.js","../../node_modules/@mui/system/esm/createTheme/createSpacing.js","../../node_modules/@mui/system/esm/compose/compose.js","../../node_modules/@mui/system/esm/borders/borders.js","../../node_modules/@mui/system/esm/cssGrid/cssGrid.js","../../node_modules/@mui/system/esm/palette/palette.js","../../node_modules/@mui/system/esm/sizing/sizing.js","../../node_modules/@mui/system/esm/styleFunctionSx/defaultSxConfig.js","../../node_modules/@mui/system/esm/styleFunctionSx/styleFunctionSx.js","../../node_modules/@mui/system/esm/createTheme/applyStyles.js","../../node_modules/@mui/system/esm/createTheme/createTheme.js","../../node_modules/@mui/system/esm/useThemeWithoutDefault/useThemeWithoutDefault.js","../../node_modules/@mui/system/esm/useTheme/useTheme.js","../../node_modules/@mui/system/esm/GlobalStyles/GlobalStyles.js","../../node_modules/@mui/system/esm/styleFunctionSx/extendSxProp.js","../../node_modules/@mui/utils/esm/ClassNameGenerator/ClassNameGenerator.js","../../node_modules/clsx/dist/clsx.mjs","../../node_modules/@mui/system/esm/createBox/createBox.js","../../node_modules/@mui/utils/esm/generateUtilityClass/generateUtilityClass.js","../../node_modules/@mui/utils/esm/generateUtilityClasses/generateUtilityClasses.js","../../node_modules/@mui/system/esm/preprocessStyles.js","../../node_modules/@mui/system/esm/createStyled/createStyled.js","../../node_modules/@mui/system/esm/styled/styled.js","../../node_modules/@mui/utils/esm/resolveProps/resolveProps.js","../../node_modules/@mui/system/esm/useThemeProps/getThemeProps.js","../../node_modules/@mui/system/esm/useThemeProps/useThemeProps.js","../../node_modules/@mui/utils/esm/useEnhancedEffect/useEnhancedEffect.js","../../node_modules/@mui/system/esm/useMediaQuery/useMediaQuery.js","../../node_modules/@mui/utils/esm/clamp/clamp.js","../../node_modules/@mui/system/esm/colorManipulator/colorManipulator.js","../../node_modules/@mui/utils/esm/createChainedFunction/createChainedFunction.js","../../node_modules/@mui/utils/esm/debLine truncated
@@ -10,7 +10,7 @@
<link rel="icon" type="image/png" sizes="512x512" href="/android-chrome-512x512.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Nomad Karaoke: Lyrics Review</title>
<script type="module" crossorigin src="/assets/index-DdJTDWH3.js"></script>
<script type="module" crossorigin src="/assets/index-COYImAcx.js"></script>
</head>
<body>
<div id="root"></div>
@@ -629,14 +629,14 @@ class ReviewServer:
else ""
)
# Use hosted review UI by default, can be overridden with LYRICS_REVIEW_UI_URL env var
# Set to "local" to use the bundled local frontend instead
review_ui_url = os.environ.get("LYRICS_REVIEW_UI_URL", "https://lyrics.nomadkaraoke.com")
# Use bundled local frontend by default for local karaoke-gen runs
# Can override with LYRICS_REVIEW_UI_URL env var (e.g., http://localhost:5173 for Vite dev)
review_ui_url = os.environ.get("LYRICS_REVIEW_UI_URL", "local")
if review_ui_url.lower() == "local":
# Use the bundled local frontend
# Use the bundled local frontend served by this FastAPI server
browser_url = f"http://localhost:8000?baseApiUrl={encoded_api_url}{audio_hash_param}"
else:
# Use the hosted/external review UI
# Use an external review UI (dev server or hosted)
browser_url = f"{review_ui_url}?baseApiUrl={encoded_api_url}{audio_hash_param}"
self.logger.info(f"Opening review UI: {browser_url}")
Generated
+403 -407
View File
File diff suppressed because it is too large. Load diff
+2 -1
View File
@@ -1,6 +1,6 @@
[tool.poetry]
name = "karaoke-gen"
version = "0.71.35"
version = "0.73.3"
description = "Generate karaoke videos with synchronized lyrics. Handles the entire process from downloading audio and lyrics to creating the final video with title screens."
authors = ["Andrew Beveridge <andrew@beveridge.uk>"]
license = "MIT"
@@ -10,6 +10,7 @@ packages = [
{ include = "lyrics_transcriber", from = "lyrics_transcriber_temp" }
]
include = [
"karaoke_gen/instrumental_review/static/*",
"lyrics_transcriber_temp/lyrics_transcriber/frontend/web_assets",
"lyrics_transcriber_temp/lyrics_transcriber/frontend/web_assets/**/*",
"lyrics_transcriber_temp/lyrics_transcriber/output/fonts/*",
+249
View File
@@ -0,0 +1,249 @@
#!/usr/bin/env python3
"""
Helper script to run the Instrumental Review UI from an existing karaoke job folder.
This allows iterating on the frontend without running a full karaoke generation.
Usage:
python scripts/run_instrumental_review.py "path/to/Artist - Title"
# Or with optional port:
python scripts/run_instrumental_review.py "path/to/Artist - Title" --port 8888
"""
import argparse
import glob
import logging
import os
import sys
# Add parent directory to path for imports
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from karaoke_gen.instrumental_review import (
AudioAnalyzer,
InstrumentalReviewServer,
WaveformGenerator,
)
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(message)s",
)
logger = logging.getLogger(__name__)
def find_file(directory: str, patterns: list[str]) -> str | None:
"""Find a file matching any of the given patterns."""
for pattern in patterns:
matches = glob.glob(os.path.join(directory, pattern))
if matches:
return matches[0]
return None
def find_audio_files(job_dir: str) -> dict:
"""
Find the required audio files in a karaoke job directory.
Returns dict with paths to:
- backing_vocals: The backing vocals stem (in stems/)
- clean_instrumental: The clean instrumental (no backing vocals) - in job_dir
- with_backing: The instrumental with backing vocals (optional) - in job_dir
- original: The original audio file (optional) - in job_dir
"""
stems_dir = os.path.join(job_dir, "stems")
# Find backing vocals in stems/ directory
backing_vocals = None
if os.path.exists(stems_dir):
backing_vocals = find_file(stems_dir, [
"*Backing Vocals*.flac",
"*Backing Vocals*.mp3",
"*Backing Vocals*.wav",
"*backing_vocals*.flac",
"*backing_vocals*.mp3",
])
# Also check main directory for backing vocals
if not backing_vocals:
backing_vocals = find_file(job_dir, [
"*Backing Vocals*.flac",
"*Backing Vocals*.mp3",
"*Backing Vocals*.wav",
])
if not backing_vocals:
raise FileNotFoundError(f"No backing vocals file found in {job_dir}")
# Find original audio file - look for "(Original)" in name
original = find_file(job_dir, [
"*(Original)*.flac",
"*(Original)*.mp3",
"*(Original)*.wav",
])
# Find instrumentals in main job directory
# Look for "(Instrumental ...)" files - clean ones don't have "+BV" or "Backing"
all_instrumentals = glob.glob(os.path.join(job_dir, "*Instrumental*.flac"))
all_instrumentals += glob.glob(os.path.join(job_dir, "*Instrumental*.mp3"))
# Also check stems/ directory
if os.path.exists(stems_dir):
all_instrumentals += glob.glob(os.path.join(stems_dir, "*Instrumental*.flac"))
all_instrumentals += glob.glob(os.path.join(stems_dir, "*Instrumental*.mp3"))
# Filter: files with "+BV" or "Backing" are combined, others are clean
clean_instrumental = None
with_backing = None
for inst in all_instrumentals:
basename = os.path.basename(inst)
if "+BV" in basename or "Backing" in basename or "backing" in basename:
with_backing = inst
elif "Custom" not in basename: # Skip custom instrumentals from previous runs
clean_instrumental = inst
if not clean_instrumental:
raise FileNotFoundError(f"No clean instrumental file found in {job_dir}")
return {
"backing_vocals": backing_vocals,
"clean_instrumental": clean_instrumental,
"with_backing": with_backing,
"original": original,
}
def main():
parser = argparse.ArgumentParser(
description="Run the Instrumental Review UI from an existing karaoke job folder",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="""
Examples:
python scripts/run_instrumental_review.py "Sabrina Carpenter - Please, Please, Please"
python scripts/run_instrumental_review.py "./output/Artist - Song" --port 9000
""",
)
parser.add_argument(
"job_dir",
help="Path to the karaoke job directory (containing stems/ folder)",
)
parser.add_argument(
"--port",
type=int,
default=8765,
help="Port to run the server on (default: 8765)",
)
parser.add_argument(
"--no-browser",
action="store_true",
help="Don't automatically open browser",
)
args = parser.parse_args()
job_dir = os.path.abspath(args.job_dir)
if not os.path.exists(job_dir):
logger.error(f"Directory not found: {job_dir}")
sys.exit(1)
# Extract base name from directory name
base_name = os.path.basename(job_dir)
logger.info(f"Job directory: {job_dir}")
logger.info(f"Base name: {base_name}")
# Find audio files
try:
files = find_audio_files(job_dir)
except FileNotFoundError as e:
logger.error(str(e))
sys.exit(1)
logger.info(f"Found backing vocals: {os.path.basename(files['backing_vocals'])}")
logger.info(f"Found clean instrumental: {os.path.basename(files['clean_instrumental'])}")
if files["with_backing"]:
logger.info(f"Found with backing: {os.path.basename(files['with_backing'])}")
else:
logger.info("No combined instrumental found (optional)")
if files["original"]:
logger.info(f"Found original: {os.path.basename(files['original'])}")
else:
logger.info("No original audio found (optional)")
# Analyze backing vocals
logger.info("Analyzing backing vocals...")
analyzer = AudioAnalyzer()
analysis = analyzer.analyze(files["backing_vocals"])
logger.info(f" Has audible content: {analysis.has_audible_content}")
logger.info(f" Total duration: {analysis.total_duration_seconds:.1f}s")
logger.info(f" Audible segments: {len(analysis.audible_segments)}")
logger.info(f" Audible percentage: {analysis.audible_percentage:.1f}%")
logger.info(f" Recommendation: {analysis.recommended_selection.value}")
# Generate or find waveform
waveform_path = os.path.join(job_dir, f"{base_name} (Backing Vocals Waveform).png")
if os.path.exists(waveform_path):
logger.info(f"Using existing waveform: {os.path.basename(waveform_path)}")
else:
logger.info("Generating waveform visualization...")
waveform_generator = WaveformGenerator()
waveform_generator.generate(
audio_path=files["backing_vocals"],
output_path=waveform_path,
segments=analysis.audible_segments,
)
logger.info(f"Generated waveform: {os.path.basename(waveform_path)}")
# Create and start server
logger.info(f"Starting instrumental review server on port {args.port}...")
server = InstrumentalReviewServer(
output_dir=job_dir,
base_name=base_name,
analysis=analysis,
waveform_path=waveform_path,
backing_vocals_path=files["backing_vocals"],
clean_instrumental_path=files["clean_instrumental"],
with_backing_path=files["with_backing"],
original_audio_path=files["original"],
)
url = f"http://localhost:{args.port}/"
logger.info(f"Server URL: {url}")
if args.no_browser:
logger.info("Browser auto-open disabled. Open the URL manually.")
# Start server without opening browser
import uvicorn
app = server._create_app()
uvicorn.run(app, host="127.0.0.1", port=args.port, log_level="warning")
else:
logger.info("Opening browser...")
logger.info("Press Ctrl+C to stop the server")
try:
selection = server.start_and_open_browser(port=args.port)
logger.info(f"Selection: {selection}")
if selection == "custom":
custom_path = server.get_custom_instrumental_path()
if custom_path:
logger.info(f"Custom instrumental saved to: {custom_path}")
if selection == "uploaded":
uploaded_path = server.get_uploaded_instrumental_path()
if uploaded_path:
logger.info(f"Uploaded instrumental saved to: {uploaded_path}")
except KeyboardInterrupt:
logger.info("\nServer stopped")
server.stop()
if __name__ == "__main__":
main()
+183
View File
@@ -0,0 +1,183 @@
#!/usr/bin/env python
"""
Test script for the Instrumental Review UI.
Usage:
python scripts/test-instrumental-review.py <backing_vocals_path> <clean_instrumental_path> [with_backing_path]
Example:
python scripts/test-instrumental-review.py \
"/path/to/Artist - Song (Backing Vocals).flac" \
"/path/to/Artist - Song (Instrumental).flac"
This will:
1. Analyze the backing vocals file
2. Generate a waveform visualization
3. Start a local web server
4. Open your browser to the review UI
"""
import argparse
import logging
import os
import sys
import tempfile
# Add the project root to the path
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from karaoke_gen.instrumental_review import (
AudioAnalyzer,
WaveformGenerator,
InstrumentalReviewServer,
)
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(message)s"
)
logger = logging.getLogger(__name__)
def main():
parser = argparse.ArgumentParser(
description="Test the Instrumental Review UI locally"
)
parser.add_argument(
"backing_vocals",
help="Path to backing vocals audio file (e.g., 'Artist - Song (Backing Vocals).flac')"
)
parser.add_argument(
"clean_instrumental",
help="Path to clean instrumental audio file (e.g., 'Artist - Song (Instrumental).flac')"
)
parser.add_argument(
"with_backing",
nargs="?",
default=None,
help="Optional: Path to instrumental with backing vocals file"
)
parser.add_argument(
"--port",
type=int,
default=8765,
help="Port to run the server on (default: 8765)"
)
parser.add_argument(
"--threshold",
type=float,
default=-40.0,
help="Silence threshold in dB (default: -40.0)"
)
args = parser.parse_args()
# Validate files exist
if not os.path.exists(args.backing_vocals):
logger.error(f"Backing vocals file not found: {args.backing_vocals}")
sys.exit(1)
if not os.path.exists(args.clean_instrumental):
logger.error(f"Clean instrumental file not found: {args.clean_instrumental}")
sys.exit(1)
if args.with_backing and not os.path.exists(args.with_backing):
logger.error(f"With backing file not found: {args.with_backing}")
sys.exit(1)
# Extract base name from backing vocals file
base_name = os.path.basename(args.backing_vocals)
# Remove common suffixes
for suffix in [" (Backing Vocals)", "(Backing Vocals)", "_backing_vocals", "-backing"]:
if suffix in base_name:
base_name = base_name.replace(suffix, "")
break
# Remove extension
base_name = os.path.splitext(base_name)[0]
output_dir = os.path.dirname(args.backing_vocals) or "."
logger.info("=" * 60)
logger.info("INSTRUMENTAL REVIEW UI TEST")
logger.info("=" * 60)
logger.info(f"Backing vocals: {args.backing_vocals}")
logger.info(f"Clean instrumental: {args.clean_instrumental}")
if args.with_backing:
logger.info(f"With backing: {args.with_backing}")
logger.info(f"Base name: {base_name}")
logger.info(f"Output dir: {output_dir}")
logger.info("")
# Step 1: Analyze backing vocals
logger.info("[1/3] Analyzing backing vocals...")
analyzer = AudioAnalyzer(silence_threshold_db=args.threshold)
analysis = analyzer.analyze(args.backing_vocals)
logger.info(f" Has audible content: {analysis.has_audible_content}")
logger.info(f" Total duration: {analysis.total_duration_seconds:.1f}s")
logger.info(f" Audible segments: {len(analysis.audible_segments)}")
logger.info(f" Audible duration: {analysis.total_audible_duration_seconds:.1f}s ({analysis.audible_percentage:.1f}%)")
logger.info(f" Recommendation: {analysis.recommended_selection.value}")
if analysis.audible_segments:
logger.info(" Segments:")
for i, seg in enumerate(analysis.audible_segments[:5]):
logger.info(
f" [{i+1}] {seg.start_seconds:.1f}s - {seg.end_seconds:.1f}s "
f"({seg.duration_seconds:.1f}s, avg: {seg.avg_amplitude_db:.1f}dB)"
)
if len(analysis.audible_segments) > 5:
logger.info(f" ... and {len(analysis.audible_segments) - 5} more")
logger.info("")
# Step 2: Generate waveform
logger.info("[2/3] Generating waveform visualization...")
waveform_path = os.path.join(output_dir, f"{base_name}_waveform.png")
generator = WaveformGenerator()
generator.generate(
audio_path=args.backing_vocals,
output_path=waveform_path,
segments=analysis.audible_segments,
)
logger.info(f" Waveform saved to: {waveform_path}")
logger.info("")
# Step 3: Start review server
logger.info("[3/3] Starting review server...")
logger.info(f" URL: http://localhost:{args.port}/")
logger.info("")
logger.info("=" * 60)
logger.info("REVIEW UI READY")
logger.info("=" * 60)
logger.info("")
logger.info("The review UI should open in your browser.")
logger.info("Select your instrumental choice and click 'Submit'.")
logger.info("Press Ctrl+C to stop the server.")
logger.info("")
server = InstrumentalReviewServer(
output_dir=output_dir,
base_name=base_name,
analysis=analysis,
waveform_path=waveform_path,
backing_vocals_path=args.backing_vocals,
clean_instrumental_path=args.clean_instrumental,
with_backing_path=args.with_backing,
)
try:
selection = server.start_and_open_browser(port=args.port)
logger.info("")
logger.info("=" * 60)
logger.info(f"SELECTION: {selection}")
logger.info("=" * 60)
custom_path = server.get_custom_instrumental_path()
if custom_path:
logger.info(f"Custom instrumental created: {custom_path}")
except KeyboardInterrupt:
logger.info("\nServer stopped by user.")
server.stop()
if __name__ == "__main__":
main()
+9 -2
View File
@@ -759,14 +759,20 @@ async def test_full_cli_integration(tmp_path, mocker):
print(f"MOCK process_audio_separation: Creating dummy separated files for {artist_title}")
# Create dummy instrumental files (using a generic model name)
instrumental_file = os.path.join(track_output_dir, f"{artist_title} (Instrumental model_bs_roformer_ep_317_sdr_12.9755.ckpt).flac")
model_name = "model_bs_roformer_ep_317_sdr_12.9755.ckpt"
instrumental_file = os.path.join(track_output_dir, f"{artist_title} (Instrumental {model_name}).flac")
with open(instrumental_file, "w") as f:
f.write("dummy instrumental audio content")
# Return data in the format expected by auto_select_instrumental
return {
"instrumental_path": instrumental_file,
"vocals_path": None, # Not needed for this test
# clean_instrumental is what auto_select_instrumental looks for
"clean_instrumental": {
"instrumental": instrumental_file
},
}
mocker.patch('karaoke_gen.audio_processor.AudioProcessor.process_audio_separation',
@@ -1093,7 +1099,8 @@ async def test_full_cli_integration(tmp_path, mocker):
'--enable_cdg', # Named: enable CDG creation
'--enable_txt', # Named: enable TXT creation
'-y', # Named: auto-confirm (bypass user confirmation)
'--log_level', 'DEBUG' # Named: log level
'--log_level', 'DEBUG', # Named: log level
'--skip_instrumental_review', # Named: skip instrumental review UI (use auto-select)
]
# Now run the actual karaoke generation pipeline
File diff suppressed because it is too large. Load diff
+297
View File
@@ -0,0 +1,297 @@
"""
Tests verifying feature parity between local and remote CLIs.
These tests ensure that both local (karaoke-gen) and remote (karaoke-gen-remote)
CLIs use the same shared core module for instrumental review functionality.
"""
import pytest
from unittest.mock import MagicMock, patch
class TestSharedCoreModuleAccess:
"""Verify both CLIs can access the shared core module."""
def test_local_cli_can_import_analyzer(self):
"""Local CLI should be able to import AudioAnalyzer."""
from karaoke_gen.instrumental_review import AudioAnalyzer
assert AudioAnalyzer is not None
def test_local_cli_can_import_editor(self):
"""Local CLI should be able to import AudioEditor."""
from karaoke_gen.instrumental_review import AudioEditor
assert AudioEditor is not None
def test_local_cli_can_import_waveform_generator(self):
"""Local CLI should be able to import WaveformGenerator."""
from karaoke_gen.instrumental_review import WaveformGenerator
assert WaveformGenerator is not None
def test_local_cli_can_import_review_server(self):
"""Local CLI should be able to import InstrumentalReviewServer."""
from karaoke_gen.instrumental_review import InstrumentalReviewServer
assert InstrumentalReviewServer is not None
def test_backend_can_import_analyzer(self):
"""Backend should be able to import AudioAnalyzer."""
from karaoke_gen.instrumental_review import AudioAnalyzer
# Backend service wrapper imports from the same module
from backend.services.audio_analysis_service import AudioAnalysisService
# Verify they use the same analyzer class
mock_storage = MagicMock()
service = AudioAnalysisService(storage_service=mock_storage)
assert service.analyzer.__class__.__name__ == "AudioAnalyzer"
def test_backend_can_import_editor(self):
"""Backend should be able to import AudioEditor."""
from karaoke_gen.instrumental_review import AudioEditor
from backend.services.audio_editing_service import AudioEditingService
mock_storage = MagicMock()
service = AudioEditingService(storage_service=mock_storage)
assert service.editor.__class__.__name__ == "AudioEditor"
class TestAnalyzerParity:
"""Verify that both CLIs get identical analysis results."""
def test_analyzer_parameters_match(self):
"""Analyzer should have same default parameters for both CLIs."""
from karaoke_gen.instrumental_review import AudioAnalyzer
# Default analyzer for local CLI
local_analyzer = AudioAnalyzer()
# The backend service uses the same analyzer with defaults
from backend.services.audio_analysis_service import AudioAnalysisService
mock_storage = MagicMock()
backend_service = AudioAnalysisService(storage_service=mock_storage)
# Same default threshold
assert local_analyzer.silence_threshold_db == backend_service.analyzer.silence_threshold_db
assert local_analyzer.silence_threshold_db == -40.0
# Same default min segment duration
assert local_analyzer.min_segment_duration_ms == backend_service.analyzer.min_segment_duration_ms
class TestEditorParity:
"""Verify that both CLIs create identical custom instrumentals."""
def test_editor_output_format_match(self):
"""Editor should produce same output format for both CLIs."""
from karaoke_gen.instrumental_review import AudioEditor
# Default editor for local CLI
local_editor = AudioEditor()
# Backend service uses same editor with same defaults
from backend.services.audio_editing_service import AudioEditingService
mock_storage = MagicMock()
backend_service = AudioEditingService(storage_service=mock_storage)
# Same default output format
assert local_editor.output_format == backend_service.editor.output_format
assert local_editor.output_format == "flac"
class TestModelConsistency:
"""Verify that models are consistent across CLIs."""
def test_mute_region_model_shared(self):
"""MuteRegion model should be shared across CLIs."""
from karaoke_gen.instrumental_review import MuteRegion
from backend.models.requests import MuteRegionRequest
# Both should validate start < end
region = MuteRegion(start_seconds=10.0, end_seconds=20.0)
request = MuteRegionRequest(start_seconds=10.0, end_seconds=20.0)
assert region.start_seconds == request.start_seconds
assert region.end_seconds == request.end_seconds
def test_analysis_result_fields_match(self):
"""AnalysisResult should have fields expected by both CLIs."""
from karaoke_gen.instrumental_review import AnalysisResult, RecommendedSelection
# Create an analysis result
result = AnalysisResult(
has_audible_content=True,
total_duration_seconds=180.0,
audible_segments=[],
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
silence_threshold_db=-40.0,
)
# Fields expected by the API response
assert hasattr(result, 'has_audible_content')
assert hasattr(result, 'total_duration_seconds')
assert hasattr(result, 'audible_segments')
assert hasattr(result, 'recommended_selection')
assert hasattr(result, 'total_audible_duration_seconds')
assert hasattr(result, 'audible_percentage')
class TestReviewServerParity:
"""Verify that local review server matches backend API."""
def test_review_server_exists(self):
"""Local review server should exist."""
from karaoke_gen.instrumental_review.server import InstrumentalReviewServer
assert InstrumentalReviewServer is not None
def test_review_server_can_be_instantiated(self):
"""Local review server should be instantiable with proper parameters."""
from karaoke_gen.instrumental_review.server import InstrumentalReviewServer
from karaoke_gen.instrumental_review import AnalysisResult, RecommendedSelection
# Create mock analysis
analysis = AnalysisResult(
has_audible_content=False,
total_duration_seconds=180.0,
audible_segments=[],
recommended_selection=RecommendedSelection.CLEAN,
silence_threshold_db=-40.0,
)
# Should be able to create server instance
server = InstrumentalReviewServer(
output_dir="/tmp",
base_name="Test - Song",
analysis=analysis,
waveform_path="/tmp/waveform.png",
backing_vocals_path="/tmp/backing.flac",
clean_instrumental_path="/tmp/clean.flac",
)
assert server is not None
assert server.output_dir == "/tmp"
assert server.base_name == "Test - Song"
def test_review_server_api_endpoints_match_backend(self):
"""Review server should serve same API endpoints as backend."""
from karaoke_gen.instrumental_review.server import InstrumentalReviewServer
# The server should have methods to create app and register routes
assert hasattr(InstrumentalReviewServer, '_create_app')
assert hasattr(InstrumentalReviewServer, '_register_routes')
assert hasattr(InstrumentalReviewServer, '_get_frontend_html')
# Server should have the main interface methods
assert hasattr(InstrumentalReviewServer, 'start_and_open_browser')
assert hasattr(InstrumentalReviewServer, 'get_selection')
assert hasattr(InstrumentalReviewServer, 'get_custom_instrumental_path')
class TestRemoteCLIAnalysisIntegration:
"""Verify remote CLI uses the analysis API."""
def test_remote_cli_has_analysis_method(self):
"""Remote CLI client should have get_instrumental_analysis method."""
from karaoke_gen.utils.remote_cli import RemoteKaraokeClient
# The client should have the analysis method
assert hasattr(RemoteKaraokeClient, 'get_instrumental_analysis')
def test_remote_cli_has_browser_method(self):
"""Remote CLI should be able to open browser for review."""
from karaoke_gen.utils.remote_cli import JobMonitor
# The job monitor should have browser review method
assert hasattr(JobMonitor, '_open_instrumental_review_and_wait')
def test_remote_cli_handle_instrumental_selection_exists(self):
"""Remote CLI should have handle_instrumental_selection method."""
from karaoke_gen.utils.remote_cli import JobMonitor
assert hasattr(JobMonitor, 'handle_instrumental_selection')
class TestLocalCLIIntegration:
"""Verify local CLI actually integrates the instrumental review UI.
These tests ensure the local CLI (gen_cli.py) actually uses the
InstrumentalReviewServer to provide the interactive review experience,
not just that the classes exist.
"""
def test_gen_cli_has_run_instrumental_review_function(self):
"""gen_cli.py should have run_instrumental_review function."""
from karaoke_gen.utils import gen_cli
# The function should exist
assert hasattr(gen_cli, 'run_instrumental_review')
assert callable(gen_cli.run_instrumental_review)
def test_gen_cli_imports_instrumental_review_components(self):
"""gen_cli.py should import necessary instrumental review components."""
import karaoke_gen.utils.gen_cli as gen_cli
import inspect
# Get the source of the module to verify imports
source = inspect.getsource(gen_cli)
# Should import the key components
assert 'from karaoke_gen.instrumental_review import' in source
assert 'AudioAnalyzer' in source
assert 'WaveformGenerator' in source
assert 'InstrumentalReviewServer' in source
def test_run_instrumental_review_uses_analyzer(self):
"""run_instrumental_review should use AudioAnalyzer."""
import inspect
from karaoke_gen.utils.gen_cli import run_instrumental_review
source = inspect.getsource(run_instrumental_review)
# Should create and use analyzer
assert 'AudioAnalyzer()' in source or 'AudioAnalyzer(' in source
assert 'analyzer.analyze' in source or 'analysis = analyzer' in source
def test_run_instrumental_review_uses_waveform_generator(self):
"""run_instrumental_review should use WaveformGenerator."""
import inspect
from karaoke_gen.utils.gen_cli import run_instrumental_review
source = inspect.getsource(run_instrumental_review)
# Should create and use waveform generator
assert 'WaveformGenerator()' in source or 'WaveformGenerator(' in source
assert 'waveform_generator.generate' in source or 'generator.generate' in source
def test_run_instrumental_review_uses_server(self):
"""run_instrumental_review should use InstrumentalReviewServer."""
import inspect
from karaoke_gen.utils.gen_cli import run_instrumental_review
source = inspect.getsource(run_instrumental_review)
# Should create and use the review server
assert 'InstrumentalReviewServer(' in source
assert 'server.start_and_open_browser' in source
assert 'server.get_selection' in source
def test_gen_cli_has_skip_instrumental_review_flag(self):
"""gen_cli should support --skip_instrumental_review flag."""
from karaoke_gen.utils.cli_args import create_parser
parser = create_parser(prog="test")
# Parse with the flag
args = parser.parse_args(['--skip_instrumental_review', 'Test', 'Song'])
assert hasattr(args, 'skip_instrumental_review')
assert args.skip_instrumental_review == True
def test_gen_cli_skip_instrumental_review_defaults_false(self):
"""skip_instrumental_review should default to False."""
from karaoke_gen.utils.cli_args import create_parser
parser = create_parser(prog="test")
# Parse without the flag
args = parser.parse_args(['Test', 'Song'])
assert hasattr(args, 'skip_instrumental_review')
assert args.skip_instrumental_review == False
+260
View File
@@ -435,6 +435,266 @@ class TestExistingInstrumentalPadding:
assert '3.0' in call_args or 3.0 in call_args
class TestDetectCountdownPaddingFromLRC:
"""Tests for detecting countdown padding from existing LRC files."""
def test_detect_padding_from_lrc_with_padding(self, basic_karaoke_gen, temp_dir):
"""Test that countdown padding is detected when first lyric is after 3 seconds."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
# Create an LRC file with first lyric at 3 seconds (padding was applied)
lrc_content = """[ti:Test Song]
[ar:Test Artist]
[00:03.50]First line of lyrics
[00:06.20]Second line of lyrics
[00:10.00]Third line of lyrics
"""
with open(lrc_file, 'w') as f:
f.write(lrc_content)
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
assert padding_added is True
assert padding_seconds == 3.0
def test_detect_padding_from_lrc_without_padding(self, basic_karaoke_gen, temp_dir):
"""Test that no padding is detected when first lyric is before 3 seconds."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
# Create an LRC file with first lyric at 0.5 seconds (no padding)
lrc_content = """[ti:Test Song]
[ar:Test Artist]
[00:00.50]First line of lyrics
[00:03.20]Second line of lyrics
[00:06.00]Third line of lyrics
"""
with open(lrc_file, 'w') as f:
f.write(lrc_content)
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
assert padding_added is False
assert padding_seconds == 0.0
def test_detect_padding_from_lrc_edge_case(self, basic_karaoke_gen, temp_dir):
"""Test detection at the 2.5 second boundary."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
# Create an LRC file with first lyric at exactly 2.5 seconds (boundary)
lrc_content = """[00:02.50]First line at boundary
[00:05.00]Second line
"""
with open(lrc_file, 'w') as f:
f.write(lrc_content)
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
# 2.5 is the boundary - should be detected as padding
assert padding_added is True
assert padding_seconds == 3.0
def test_detect_padding_from_lrc_just_below_boundary(self, basic_karaoke_gen, temp_dir):
"""Test detection just below the 2.5 second boundary."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
# Create an LRC file with first lyric at 2.4 seconds (just below boundary)
lrc_content = """[00:02.40]First line just below boundary
[00:05.00]Second line
"""
with open(lrc_file, 'w') as f:
f.write(lrc_content)
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
# 2.4 is below boundary - should NOT be detected as padding
assert padding_added is False
assert padding_seconds == 0.0
def test_detect_padding_from_lrc_empty_file(self, basic_karaoke_gen, temp_dir):
"""Test handling of empty LRC file."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
with open(lrc_file, 'w') as f:
f.write('')
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
assert padding_added is False
assert padding_seconds == 0.0
def test_detect_padding_from_lrc_no_timestamps(self, basic_karaoke_gen, temp_dir):
"""Test handling of LRC file with no valid timestamps."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
lrc_content = """[ti:Test Song]
[ar:Test Artist]
Just text without timestamps
More text
"""
with open(lrc_file, 'w') as f:
f.write(lrc_content)
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
assert padding_added is False
assert padding_seconds == 0.0
def test_detect_padding_from_lrc_missing_file(self, basic_karaoke_gen, temp_dir):
"""Test handling of missing LRC file."""
lrc_file = os.path.join(temp_dir, 'nonexistent.lrc')
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
assert padding_added is False
assert padding_seconds == 0.0
def test_detect_padding_from_lrc_three_digit_milliseconds(self, basic_karaoke_gen, temp_dir):
"""Test parsing LRC files with three-digit milliseconds."""
lrc_file = os.path.join(temp_dir, 'test.lrc')
# Some LRC files use [mm:ss.xxx] format
lrc_content = """[00:03.500]First line at 3.5 seconds
[00:06.200]Second line
"""
with open(lrc_file, 'w') as f:
f.write(lrc_content)
padding_added, padding_seconds = basic_karaoke_gen.lyrics_processor._detect_countdown_padding_from_lrc(lrc_file)
assert padding_added is True
assert padding_seconds == 3.0
class TestExistingFilesWithPaddingDetection:
"""Tests for transcribe_lyrics returning padding info from existing files."""
def test_transcribe_lyrics_existing_files_returns_padding_info(self, basic_karaoke_gen, temp_dir):
"""Test that transcribe_lyrics returns padding info when using existing files."""
track_output_dir = temp_dir
artist = "Test Artist"
title = "Test Title"
# Create existing files
video_path = os.path.join(track_output_dir, f"{artist} - {title} (With Vocals).mkv")
lrc_path = os.path.join(track_output_dir, f"{artist} - {title} (Karaoke).lrc")
# Create the video file
with open(video_path, 'w') as f:
f.write('mock video')
# Create LRC file with countdown padding (first lyric at 3.5s)
lrc_content = """[00:03.50]First line with padding
[00:06.00]Second line
"""
with open(lrc_path, 'w') as f:
f.write(lrc_content)
# Call transcribe_lyrics - it should detect existing files and return padding info
result = basic_karaoke_gen.lyrics_processor.transcribe_lyrics(
input_audio_wav=None, # Not needed when existing files found
artist=artist,
title=title,
track_output_dir=track_output_dir,
)
# Should return padding info from LRC detection
assert result['countdown_padding_added'] is True
assert result['countdown_padding_seconds'] == 3.0
assert result['padded_audio_filepath'] is None # Original padded audio not available
def test_transcribe_lyrics_existing_files_no_padding(self, basic_karaoke_gen, temp_dir):
"""Test existing files case when there's no countdown padding."""
track_output_dir = temp_dir
artist = "Test Artist"
title = "Test Title"
# Create existing files
video_path = os.path.join(track_output_dir, f"{artist} - {title} (With Vocals).mkv")
lrc_path = os.path.join(track_output_dir, f"{artist} - {title} (Karaoke).lrc")
# Create the video file
with open(video_path, 'w') as f:
f.write('mock video')
# Create LRC file WITHOUT countdown padding (first lyric at 0.5s)
lrc_content = """[00:00.50]First line starts immediately
[00:03.00]Second line
"""
with open(lrc_path, 'w') as f:
f.write(lrc_content)
result = basic_karaoke_gen.lyrics_processor.transcribe_lyrics(
input_audio_wav=None,
artist=artist,
title=title,
track_output_dir=track_output_dir,
)
# Should return no padding info
assert result['countdown_padding_added'] is False
assert result['countdown_padding_seconds'] == 0.0
class TestScanDirectoryForInstrumentals:
"""Tests for scanning directory for existing instrumentals."""
def test_scan_directory_finds_clean_instrumental(self, basic_karaoke_gen, temp_dir):
"""Test that _scan_directory_for_instrumentals finds clean instrumentals."""
artist_title = "Test Artist - Test Song"
# Create a clean instrumental file
instrumental_file = os.path.join(temp_dir, f"{artist_title} (Instrumental Clean).flac")
with open(instrumental_file, 'w') as f:
f.write('mock instrumental')
result = basic_karaoke_gen._scan_directory_for_instrumentals(temp_dir, artist_title)
assert result['clean_instrumental']['instrumental'] == instrumental_file
def test_scan_directory_finds_combined_instrumentals(self, basic_karaoke_gen, temp_dir):
"""Test that _scan_directory_for_instrumentals finds combined instrumentals."""
artist_title = "Test Artist - Test Song"
# Create combined instrumental files
bv_file = os.path.join(temp_dir, f"{artist_title} (Instrumental +BV HTDemucs).flac")
with open(bv_file, 'w') as f:
f.write('mock instrumental with backing')
result = basic_karaoke_gen._scan_directory_for_instrumentals(temp_dir, artist_title)
assert 'HTDemucs' in result['combined_instrumentals']
assert result['combined_instrumentals']['HTDemucs'] == bv_file
def test_scan_directory_skips_padded_files(self, basic_karaoke_gen, temp_dir):
"""Test that _scan_directory_for_instrumentals skips already-padded files."""
artist_title = "Test Artist - Test Song"
# Create both original and padded files
original_file = os.path.join(temp_dir, f"{artist_title} (Instrumental Clean).flac")
padded_file = os.path.join(temp_dir, f"{artist_title} (Instrumental Clean) (Padded).flac")
with open(original_file, 'w') as f:
f.write('mock original')
with open(padded_file, 'w') as f:
f.write('mock padded')
result = basic_karaoke_gen._scan_directory_for_instrumentals(temp_dir, artist_title)
# Should return original, not padded
assert result['clean_instrumental']['instrumental'] == original_file
assert 'Padded' not in result['clean_instrumental']['instrumental']
def test_scan_directory_empty_directory(self, basic_karaoke_gen, temp_dir):
"""Test _scan_directory_for_instrumentals on empty directory."""
artist_title = "Test Artist - Test Song"
result = basic_karaoke_gen._scan_directory_for_instrumentals(temp_dir, artist_title)
# Should return empty structure
assert result['clean_instrumental'].get('instrumental') is None
assert len(result['combined_instrumentals']) == 0
if __name__ == '__main__':
pytest.main([__file__, '-v'])
+252 -26
View File
@@ -130,7 +130,7 @@ def mock_sleep():
@patch("karaoke_gen.utils.gen_cli.is_url", return_value=True)
@patch("karaoke_gen.utils.gen_cli.is_file", return_value=False)
@patch("karaoke_gen.utils.gen_cli.KaraokePrep") # Use default MagicMock for class
async def test_arg_parsing_url_only(mock_kprep_class, mock_isfile, mock_isurl, mock_base_args, mock_logger, caplog):
async def test_arg_parsing_url_only(mock_kprep_class, mock_isfile, mock_isurl, mock_base_args, mock_logger, capsys):
"""Test URL-only argument parsing."""
mock_base_args.args = ["https://example.com/song.mp3"]
mock_kprep_instance = MagicMock()
@@ -145,8 +145,9 @@ async def test_arg_parsing_url_only(mock_kprep_class, mock_isfile, mock_isurl, m
# Verify that input_media=URL is passed
assert mock_kprep_class.call_args.kwargs["input_media"] == "https://example.com/song.mp3"
mock_kprep_instance.process.assert_awaited_once()
# Verify warning in log
assert "Input media provided without Artist and Title" in caplog.text
# Verify warning in log (captured in stderr since logger.propagate = False)
captured = capsys.readouterr()
assert "Input media provided without Artist and Title" in captured.err
@patch("karaoke_gen.utils.gen_cli.is_url", return_value=True)
@patch("karaoke_gen.utils.gen_cli.is_file", return_value=False)
@@ -194,7 +195,7 @@ async def test_arg_parsing_file_artist_title(mock_kprep_class, mock_isfile, mock
@patch("karaoke_gen.utils.gen_cli.is_file", return_value=False)
@patch("karaoke_gen.utils.gen_cli.os.path.isdir", return_value=False)
@patch("karaoke_gen.utils.gen_cli.KaraokePrep") # Use default MagicMock for class
async def test_arg_parsing_artist_title_only(mock_kprep_class, mock_isdir, mock_isfile, mock_isurl, mock_base_args, mock_logger, caplog):
async def test_arg_parsing_artist_title_only(mock_kprep_class, mock_isdir, mock_isfile, mock_isurl, mock_base_args, mock_logger, capsys):
"""Test Artist and Title only argument parsing."""
mock_base_args.args = ["Test Artist", "Test Title"]
mock_kprep_instance = MagicMock()
@@ -211,8 +212,9 @@ async def test_arg_parsing_artist_title_only(mock_kprep_class, mock_isdir, mock_
assert mock_kprep_class.call_args.kwargs["title"] == "Test Title"
assert mock_kprep_class.call_args.kwargs["input_media"] is None
mock_kprep_instance.process.assert_awaited_once()
# Verify message about flacfetch search is shown
assert "flacfetch will search for" in caplog.text
# Verify message about flacfetch search is shown (in stderr since logger.propagate = False)
captured = capsys.readouterr()
assert "flacfetch will search for" in captured.err
@patch("karaoke_gen.utils.gen_cli.is_url", return_value=False)
@patch("karaoke_gen.utils.gen_cli.is_file", return_value=False)
@@ -281,7 +283,8 @@ async def test_workflow_prep_only(mock_kfinalise, mock_kprep_class, mock_base_ar
@patch("karaoke_gen.utils.gen_cli.KaraokePrep") # Should not be called
@patch("karaoke_gen.utils.gen_cli.KaraokeFinalise")
@patch("builtins.open", new_callable=mock_open) # Mock open for style JSON if CDG enabled
async def test_workflow_finalise_only(mock_open, mock_kfinalise, mock_kprep, mock_base_args, mock_logger):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_workflow_finalise_only(mock_run_review, mock_open, mock_kfinalise, mock_kprep, mock_base_args, mock_logger):
"""Test --finalise-only workflow."""
mock_base_args.finalise_only = True
mock_kfinalise_instance = mock_kfinalise.return_value
@@ -304,7 +307,8 @@ async def test_workflow_finalise_only(mock_open, mock_kfinalise, mock_kprep, moc
@patch("karaoke_gen.utils.gen_cli.os.path.basename", return_value="Edit Artist - Edit Title")
@patch("karaoke_gen.utils.gen_cli.os.getcwd", return_value="/fake/path/Edit Artist - Edit Title")
@patch("builtins.open", new_callable=mock_open) # Mock open for style JSON if CDG enabled
async def test_workflow_edit_lyrics(mock_open, mock_getcwd, mock_basename, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_workflow_edit_lyrics(mock_run_review, mock_open, mock_getcwd, mock_basename, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
"""Test --edit-lyrics workflow."""
mock_base_args.edit_lyrics = True
mock_base_args.enable_cdg = False # Simplify for now
@@ -370,7 +374,8 @@ async def test_workflow_test_email_template(mock_kfinalise, mock_base_args, mock
@patch("karaoke_gen.utils.gen_cli.KaraokePrep") # Use default MagicMock for class
@patch("karaoke_gen.utils.gen_cli.KaraokeFinalise")
async def test_workflow_lyrics_only(mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_workflow_lyrics_only(mock_run_review, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
"""Test --lyrics-only workflow sets environment variables and skips."""
mock_base_args.args = ["Artist", "Title"]
mock_base_args.lyrics_only = True
@@ -404,7 +409,8 @@ async def test_workflow_lyrics_only(mock_kfinalise, mock_kprep_class, mock_base_
@patch("builtins.open", new_callable=mock_open, read_data=SAMPLE_STYLE_JSON)
@patch("karaoke_gen.utils.gen_cli.os.chdir") # Mock chdir
@patch("karaoke_gen.utils.gen_cli.os.path.exists", return_value=True) # Assume track dir exists
async def test_finalise_cdg_style_loading(mock_exists, mock_chdir, mock_open, mock_kfinalise, mock_kprep_class, mock_base_args):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_finalise_cdg_style_loading(mock_run_review, mock_exists, mock_chdir, mock_open, mock_kfinalise, mock_kprep_class, mock_base_args):
"""Test that CDG styles are loaded correctly when --enable_cdg is used."""
mock_base_args.args = ["Artist", "Title"]
mock_base_args.enable_cdg = True
@@ -437,7 +443,8 @@ async def test_finalise_cdg_style_loading(mock_exists, mock_chdir, mock_open, mo
@patch("karaoke_gen.utils.gen_cli.os.chdir")
@patch("karaoke_gen.utils.gen_cli.os.path.exists", return_value=True)
@patch("karaoke_gen.utils.gen_cli.sys.exit")
async def test_finalise_cdg_style_file_not_found(mock_exit, mock_exists, mock_chdir, mock_open, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_finalise_cdg_style_file_not_found(mock_run_review, mock_exit, mock_exists, mock_chdir, mock_open, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
"""Test exit if CDG enabled but style file not found."""
mock_base_args.args = ["Artist", "Title"]
mock_base_args.enable_cdg = True
@@ -465,7 +472,8 @@ async def test_finalise_cdg_style_file_not_found(mock_exit, mock_exists, mock_ch
@patch("karaoke_gen.utils.gen_cli.os.chdir")
@patch("karaoke_gen.utils.gen_cli.os.path.exists", return_value=True)
@patch("karaoke_gen.utils.gen_cli.sys.exit")
async def test_finalise_cdg_style_invalid_json(mock_exit, mock_exists, mock_chdir, mock_open, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_finalise_cdg_style_invalid_json(mock_run_review, mock_exit, mock_exists, mock_chdir, mock_open, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
"""Test exit if CDG enabled but style file has invalid JSON."""
mock_base_args.args = ["Artist", "Title"]
mock_base_args.enable_cdg = True
@@ -490,7 +498,7 @@ async def test_finalise_cdg_style_invalid_json(mock_exit, mock_exists, mock_chdi
@patch("karaoke_gen.utils.gen_cli.KaraokePrep") # Use default MagicMock for class
@patch("karaoke_gen.utils.gen_cli.KaraokeFinalise")
async def test_error_handling_kprep_failure(mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, caplog):
async def test_error_handling_kprep_failure(mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger):
"""Test error handling if KaraokePrep.process fails."""
mock_base_args.args = ["Artist", "Title"]
mock_kprep_instance = MagicMock()
@@ -512,7 +520,8 @@ async def test_error_handling_kprep_failure(mock_kfinalise, mock_kprep_class, mo
@patch("karaoke_gen.utils.gen_cli.KaraokeFinalise")
@patch("karaoke_gen.utils.gen_cli.os.chdir")
@patch("karaoke_gen.utils.gen_cli.os.path.exists", return_value=True)
async def test_error_handling_kfinalise_failure(mock_exists, mock_chdir, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, caplog):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_error_handling_kfinalise_failure(mock_run_review, mock_exists, mock_chdir, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, capsys):
"""Test error handling if KaraokeFinalise.process fails."""
mock_base_args.args = ["Artist", "Title"]
mock_kprep_instance = MagicMock()
@@ -533,13 +542,15 @@ async def test_error_handling_kfinalise_failure(mock_exists, mock_chdir, mock_kf
mock_kfinalise.assert_called_once() # Finalise is called
mock_kfinalise_instance.process.assert_called_once() # Process is called
# Check the error message in log
assert "An error occurred during finalisation, see stack trace below: KFinalise Failed!" in caplog.text
# Check the error message in log (in stderr since logger.propagate = False)
captured = capsys.readouterr()
assert "An error occurred during finalisation, see stack trace below: KFinalise Failed!" in captured.err
@patch("karaoke_gen.utils.gen_cli.KaraokePrep") # Use default MagicMock for class
@patch("karaoke_gen.utils.gen_cli.KaraokeFinalise")
async def test_argument_passthrough(mock_kfinalise, mock_kprep_class, mock_base_args):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_argument_passthrough(mock_run_review, mock_kfinalise, mock_kprep_class, mock_base_args):
"""Test that various arguments are passed correctly to KaraokePrep/Finalise."""
mock_base_args.args = ["Artist", "Title"]
mock_base_args.render_bounding_boxes = True
@@ -595,7 +606,8 @@ async def test_argument_passthrough(mock_kfinalise, mock_kprep_class, mock_base_
@patch("karaoke_gen.utils.gen_cli.os.chdir")
@patch("karaoke_gen.utils.gen_cli.os.path.exists", return_value=True)
@patch("karaoke_gen.utils.gen_cli.pyperclip.copy")
async def test_clipboard_copy_success(mock_copy, mock_exists, mock_chdir, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, caplog):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_clipboard_copy_success(mock_run_review, mock_copy, mock_exists, mock_chdir, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, capsys):
"""Test logging when clipboard copy succeeds."""
mock_base_args.args = ["Artist", "Title"]
@@ -615,9 +627,10 @@ async def test_clipboard_copy_success(mock_copy, mock_exists, mock_chdir, mock_k
await gen_cli.async_main()
mock_kprep_instance.process.assert_awaited_once()
# Check log capture for success messages
assert "(Folder link copied to clipboard)" in caplog.text
assert "(YouTube URL copied to clipboard)" in caplog.text
# Check log capture for success messages (in stderr since logger.propagate = False)
captured = capsys.readouterr()
assert "(Folder link copied to clipboard)" in captured.err
assert "(YouTube URL copied to clipboard)" in captured.err
mock_copy.assert_has_calls([
call("http://share.link/fake"),
@@ -630,7 +643,8 @@ async def test_clipboard_copy_success(mock_copy, mock_exists, mock_chdir, mock_k
@patch("karaoke_gen.utils.gen_cli.os.chdir")
@patch("karaoke_gen.utils.gen_cli.os.path.exists", return_value=True)
@patch("karaoke_gen.utils.gen_cli.pyperclip.copy", side_effect=Exception("Clipboard Error"))
async def test_clipboard_copy_failure(mock_copy, mock_exists, mock_chdir, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, caplog):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_clipboard_copy_failure(mock_run_review, mock_copy, mock_exists, mock_chdir, mock_kfinalise, mock_kprep_class, mock_base_args, mock_logger, capsys):
"""Test logging when clipboard copy fails."""
mock_base_args.args = ["Artist", "Title"]
@@ -650,9 +664,10 @@ async def test_clipboard_copy_failure(mock_copy, mock_exists, mock_chdir, mock_k
await gen_cli.async_main()
mock_kprep_instance.process.assert_awaited_once()
# Check log capture for warning messages
assert "Failed to copy folder link to clipboard: Clipboard Error" in caplog.text
assert "Failed to copy YouTube URL to clipboard: Clipboard Error" in caplog.text
# Check log capture for warning messages (in stderr since logger.propagate = False)
captured = capsys.readouterr()
assert "Failed to copy folder link to clipboard: Clipboard Error" in captured.err
assert "Failed to copy YouTube URL to clipboard: Clipboard Error" in captured.err
# Verify clipboard calls were attempted
mock_copy.assert_has_calls([
@@ -662,7 +677,8 @@ async def test_clipboard_copy_failure(mock_copy, mock_exists, mock_chdir, mock_k
@patch("karaoke_gen.utils.gen_cli.KaraokePrep")
async def test_style_override_parsing(mock_kprep_class, mock_base_args):
@patch("karaoke_gen.utils.gen_cli.run_instrumental_review", return_value="selected_instrumental.flac")
async def test_style_override_parsing(mock_run_review, mock_kprep_class, mock_base_args):
"""Test that --style_override arguments are parsed correctly."""
mock_base_args.args = ["Artist", "Title"]
mock_base_args.style_override = ["intro.background_image=new_image.png", "end.video_duration=10"]
@@ -685,3 +701,213 @@ async def test_style_override_parsing(mock_kprep_class, mock_base_args):
"end.video_duration": "10"
}
assert prep_kwargs["style_overrides"] == expected_overrides
# --- Test _resolve_path_for_cwd helper function ---
class TestResolvePathForCwd:
"""Tests for the _resolve_path_for_cwd helper function.
This function resolves paths that were created relative to the original working
directory after os.chdir(track_dir) has been called.
"""
def test_absolute_path_unchanged(self):
"""Absolute paths should be returned unchanged."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
path = "/absolute/path/to/file.flac"
track_dir = "./Artist - Title"
result = _resolve_path_for_cwd(path, track_dir)
assert result == path
def test_relative_path_starting_with_track_dir(self):
"""Paths starting with track_dir should have track_dir stripped."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
path = "./Artist - Title/stems/file.flac"
track_dir = "./Artist - Title"
result = _resolve_path_for_cwd(path, track_dir)
assert result == "stems/file.flac"
def test_relative_path_with_different_format(self):
"""Paths without ./ prefix should also be handled."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
path = "Artist - Title/stems/file.flac"
track_dir = "Artist - Title"
result = _resolve_path_for_cwd(path, track_dir)
assert result == "stems/file.flac"
def test_path_not_starting_with_track_dir(self):
"""Paths not starting with track_dir should be returned unchanged."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
path = "different/path/to/file.flac"
track_dir = "./Artist - Title"
result = _resolve_path_for_cwd(path, track_dir)
assert result == path
def test_path_with_complex_track_name(self):
"""Test with a track name containing special characters."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
path = "./Four Lanes Male Choir - The White Rose/stems/backing_vocals.flac"
track_dir = "./Four Lanes Male Choir - The White Rose"
result = _resolve_path_for_cwd(path, track_dir)
assert result == "stems/backing_vocals.flac"
def test_path_exactly_matching_track_dir(self):
"""Test when path exactly matches track_dir (edge case)."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
path = "./Artist - Title"
track_dir = "./Artist - Title"
result = _resolve_path_for_cwd(path, track_dir)
assert result == "."
def test_normalized_path_comparison(self):
"""Test that path normalization works correctly."""
from karaoke_gen.utils.gen_cli import _resolve_path_for_cwd
# Paths with extra slashes or dots should be normalized
path = "./Artist - Title//stems/./file.flac"
track_dir = "./Artist - Title/"
result = _resolve_path_for_cwd(path, track_dir)
# After normalization: "Artist - Title/stems/file.flac" vs "Artist - Title"
assert result == "stems/file.flac"
# --- Test auto_select_instrumental helper function ---
class TestAutoSelectInstrumental:
"""Tests for the auto_select_instrumental function.
This function automatically selects the best instrumental file when
--skip_instrumental_review is used.
"""
def test_prefers_padded_combined_over_non_padded(self, tmp_path, mock_logger):
"""Padded combined instrumental should be preferred."""
from karaoke_gen.utils.gen_cli import auto_select_instrumental
# Create test files
combined = tmp_path / "Artist - Title (Instrumental +BV model.ckpt).flac"
combined_padded = tmp_path / "Artist - Title (Instrumental +BV model.ckpt) (Padded).flac"
combined.touch()
combined_padded.touch()
track = {
"track_output_dir": str(tmp_path),
"separated_audio": {
"combined_instrumentals": {
"model.ckpt": str(combined)
}
}
}
# Change to temp directory (simulating the chdir in gen_cli)
original_dir = os.getcwd()
os.chdir(tmp_path)
try:
result = auto_select_instrumental(track, str(tmp_path), mock_logger)
assert "(Padded)" in result
finally:
os.chdir(original_dir)
def test_prefers_combined_over_clean(self, tmp_path, mock_logger):
"""Combined instrumental (+BV) should be preferred over clean."""
from karaoke_gen.utils.gen_cli import auto_select_instrumental
# Create test files
clean = tmp_path / "Artist - Title (Instrumental model.ckpt).flac"
combined = tmp_path / "Artist - Title (Instrumental +BV model.ckpt).flac"
clean.touch()
combined.touch()
track = {
"track_output_dir": str(tmp_path),
"separated_audio": {
"clean_instrumental": {
"instrumental": str(clean)
},
"combined_instrumentals": {
"model.ckpt": str(combined)
}
}
}
original_dir = os.getcwd()
os.chdir(tmp_path)
try:
result = auto_select_instrumental(track, str(tmp_path), mock_logger)
assert "+BV" in result
finally:
os.chdir(original_dir)
def test_falls_back_to_clean_when_no_combined(self, tmp_path, mock_logger):
"""Should use clean instrumental if no combined available."""
from karaoke_gen.utils.gen_cli import auto_select_instrumental
# Create test file
clean = tmp_path / "Artist - Title (Instrumental model.ckpt).flac"
clean.touch()
track = {
"track_output_dir": str(tmp_path),
"separated_audio": {
"clean_instrumental": {
"instrumental": str(clean)
},
"combined_instrumentals": {}
}
}
original_dir = os.getcwd()
os.chdir(tmp_path)
try:
result = auto_select_instrumental(track, str(tmp_path), mock_logger)
assert "Instrumental" in result
finally:
os.chdir(original_dir)
def test_raises_error_when_no_instrumental_found(self, tmp_path, mock_logger):
"""Should raise FileNotFoundError when no instrumental available."""
from karaoke_gen.utils.gen_cli import auto_select_instrumental
track = {
"track_output_dir": str(tmp_path),
"separated_audio": {
"clean_instrumental": {},
"combined_instrumentals": {}
}
}
original_dir = os.getcwd()
os.chdir(tmp_path)
try:
with pytest.raises(FileNotFoundError, match="No instrumental file found"):
auto_select_instrumental(track, str(tmp_path), mock_logger)
finally:
os.chdir(original_dir)
def test_searches_directory_as_fallback(self, tmp_path, mock_logger):
"""Should search directory if separated_audio is missing data."""
from karaoke_gen.utils.gen_cli import auto_select_instrumental
# Create test file in directory but not in separated_audio
instrumental = tmp_path / "Artist - Title (Instrumental model.ckpt).flac"
instrumental.touch()
track = {
"track_output_dir": str(tmp_path),
"separated_audio": {} # Empty - nothing in separated_audio
}
original_dir = os.getcwd()
os.chdir(tmp_path)
try:
result = auto_select_instrumental(track, str(tmp_path), mock_logger)
assert "Instrumental" in result
finally:
os.chdir(original_dir)
@@ -0,0 +1,9 @@
"""
Unit tests for the instrumental_review module.
This package contains comprehensive unit tests for:
- AudioAnalyzer: Audio analysis for backing vocals
- AudioEditor: Custom instrumental creation with mute regions
- WaveformGenerator: Waveform visualization generation
- Models: Pydantic models for data structures
"""
@@ -0,0 +1,189 @@
"""
Test fixtures for instrumental_review tests.
This module provides pytest fixtures that generate test audio files
programmatically using pydub. This avoids the need for static test
audio files in the repository.
"""
import os
import math
import tempfile
from pathlib import Path
from typing import Generator
import pytest
from pydub import AudioSegment
from pydub.generators import Sine, WhiteNoise
@pytest.fixture
def temp_dir() -> Generator[str, None, None]:
"""Create a temporary directory for test files."""
with tempfile.TemporaryDirectory() as temp_dir:
yield temp_dir
@pytest.fixture
def silent_audio_path(temp_dir: str) -> str:
"""
Create a silent audio file (10 seconds).
This represents backing vocals with no audible content.
"""
duration_ms = 10000 # 10 seconds
# Create silent audio
audio = AudioSegment.silent(duration=duration_ms, frame_rate=44100)
# Save to file
output_path = os.path.join(temp_dir, "silent_backing_vocals.flac")
audio.export(output_path, format="flac")
return output_path
@pytest.fixture
def loud_audio_path(temp_dir: str) -> str:
"""
Create an audio file with consistent audible content (10 seconds).
This represents backing vocals with clear, continuous content.
"""
duration_ms = 10000 # 10 seconds
# Create a sine wave tone
tone = Sine(440).to_audio_segment(duration=duration_ms)
# Reduce volume to -10dB
tone = tone - 10
# Save to file
output_path = os.path.join(temp_dir, "loud_backing_vocals.flac")
tone.export(output_path, format="flac")
return output_path
@pytest.fixture
def mixed_audio_path(temp_dir: str) -> str:
"""
Create an audio file with alternating silent and audible sections.
Pattern: 2s silent, 3s audible, 2s silent, 3s audible = 10s total
This represents backing vocals with some good sections and some
sections that might need muting.
"""
# Create segments
silence1 = AudioSegment.silent(duration=2000, frame_rate=44100) # 2s
tone1 = Sine(440).to_audio_segment(duration=3000) - 15 # 3s at -15dB
silence2 = AudioSegment.silent(duration=2000, frame_rate=44100) # 2s
tone2 = Sine(880).to_audio_segment(duration=3000) - 15 # 3s at -15dB
# Combine
audio = silence1 + tone1 + silence2 + tone2
# Save to file
output_path = os.path.join(temp_dir, "mixed_backing_vocals.flac")
audio.export(output_path, format="flac")
return output_path
@pytest.fixture
def quiet_audio_path(temp_dir: str) -> str:
"""
Create an audio file with very quiet content (below -40dB threshold).
This represents backing vocals that technically have content but
are quiet enough to be considered silent.
"""
duration_ms = 10000 # 10 seconds
# Create a very quiet sine wave (-50dB)
tone = Sine(440).to_audio_segment(duration=duration_ms)
tone = tone - 50 # Very quiet
# Save to file
output_path = os.path.join(temp_dir, "quiet_backing_vocals.flac")
tone.export(output_path, format="flac")
return output_path
@pytest.fixture
def clean_instrumental_path(temp_dir: str) -> str:
"""
Create a clean instrumental audio file.
This is used for testing the audio editor.
"""
duration_ms = 10000 # 10 seconds
# Create a chord-like sound (multiple frequencies)
tone1 = Sine(220).to_audio_segment(duration=duration_ms) - 12 # A
tone2 = Sine(277).to_audio_segment(duration=duration_ms) - 12 # C#
tone3 = Sine(330).to_audio_segment(duration=duration_ms) - 12 # E
# Mix the tones
chord = tone1.overlay(tone2).overlay(tone3)
# Save to file
output_path = os.path.join(temp_dir, "clean_instrumental.flac")
chord.export(output_path, format="flac")
return output_path
@pytest.fixture
def backing_vocals_with_issues_path(temp_dir: str) -> str:
"""
Create backing vocals with some sections that should be muted.
Pattern:
- 0-3s: Good backing vocals (harmonies)
- 3-5s: Bad section (lead vocal bleed - louder)
- 5-8s: Good backing vocals
- 8-10s: Bad section (artifacts)
"""
# Good section 1: Quiet harmonies
good1 = Sine(330).to_audio_segment(duration=3000) - 20 # 3s at -20dB
# Bad section 1: Loud lead vocal bleed
bad1 = Sine(440).to_audio_segment(duration=2000) - 5 # 2s at -5dB (loud)
# Good section 2: Quiet harmonies
good2 = Sine(392).to_audio_segment(duration=3000) - 20 # 3s at -20dB
# Bad section 2: Artifacts (noise-like)
bad2 = WhiteNoise().to_audio_segment(duration=2000) - 15 # 2s at -15dB
# Combine
audio = good1 + bad1 + good2 + bad2
# Save to file
output_path = os.path.join(temp_dir, "backing_vocals_with_issues.flac")
audio.export(output_path, format="flac")
return output_path
@pytest.fixture
def stereo_audio_path(temp_dir: str) -> str:
"""
Create a stereo audio file for testing channel handling.
"""
duration_ms = 5000 # 5 seconds
# Create stereo audio
left = Sine(440).to_audio_segment(duration=duration_ms) - 15
right = Sine(550).to_audio_segment(duration=duration_ms) - 15
stereo = AudioSegment.from_mono_audiosegments(left, right)
# Save to file
output_path = os.path.join(temp_dir, "stereo_backing_vocals.flac")
stereo.export(output_path, format="flac")
return output_path
@@ -0,0 +1,321 @@
"""
Unit tests for AudioAnalyzer.
Tests cover:
- Analysis of silent audio
- Analysis of audio with content
- Segment detection and merging
- Threshold behavior
- Recommendation logic
- Edge cases
"""
import os
import pytest
from pydub import AudioSegment
from pydub.generators import Sine
from karaoke_gen.instrumental_review import (
AudioAnalyzer,
AnalysisResult,
AudibleSegment,
RecommendedSelection,
)
class TestAudioAnalyzerInit:
"""Tests for AudioAnalyzer initialization."""
def test_default_parameters(self):
"""Test analyzer creates with sensible defaults."""
analyzer = AudioAnalyzer()
assert analyzer.silence_threshold_db == -40.0
assert analyzer.min_segment_duration_ms == 100
assert analyzer.merge_gap_ms == 500
assert analyzer.window_ms == 50
def test_custom_parameters(self):
"""Test analyzer accepts custom parameters."""
analyzer = AudioAnalyzer(
silence_threshold_db=-35.0,
min_segment_duration_ms=200,
merge_gap_ms=300,
window_ms=100,
)
assert analyzer.silence_threshold_db == -35.0
assert analyzer.min_segment_duration_ms == 200
assert analyzer.merge_gap_ms == 300
assert analyzer.window_ms == 100
class TestAnalyzeSilentAudio:
"""Tests for analyzing silent/near-silent audio."""
def test_silent_audio_returns_no_audible_content(self, silent_audio_path):
"""Silent audio should return has_audible_content=False."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(silent_audio_path)
assert result.has_audible_content is False
assert len(result.audible_segments) == 0
assert result.total_audible_duration_seconds == 0.0
assert result.audible_percentage == 0.0
def test_silent_audio_recommends_clean(self, silent_audio_path):
"""Silent audio should recommend clean instrumental."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(silent_audio_path)
assert result.recommended_selection == RecommendedSelection.CLEAN
def test_quiet_audio_below_threshold_is_silent(self, quiet_audio_path):
"""Audio below threshold should be considered silent."""
analyzer = AudioAnalyzer(silence_threshold_db=-40.0)
result = analyzer.analyze(quiet_audio_path)
# Very quiet audio (-50dB) should be below -40dB threshold
assert result.has_audible_content is False
assert result.recommended_selection == RecommendedSelection.CLEAN
class TestAnalyzeAudibleAudio:
"""Tests for analyzing audio with audible content."""
def test_loud_audio_has_audible_content(self, loud_audio_path):
"""Loud audio should return has_audible_content=True."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(loud_audio_path)
assert result.has_audible_content is True
assert len(result.audible_segments) > 0
assert result.total_audible_duration_seconds > 0
def test_loud_audio_high_audible_percentage(self, loud_audio_path):
"""Consistently loud audio should have high audible percentage."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(loud_audio_path)
# Should be mostly audible
assert result.audible_percentage > 80.0
def test_loud_audio_recommends_review(self, loud_audio_path):
"""Loud audio should recommend review."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(loud_audio_path)
assert result.recommended_selection == RecommendedSelection.REVIEW_NEEDED
class TestSegmentDetection:
"""Tests for segment detection and merging."""
def test_mixed_audio_detects_multiple_segments(self, mixed_audio_path):
"""Mixed audio should detect distinct audible segments."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(mixed_audio_path)
assert result.has_audible_content is True
# Should detect the two audible sections (3s each)
assert len(result.audible_segments) >= 1
def test_segment_timing_is_accurate(self, mixed_audio_path):
"""Detected segment timings should be approximately correct."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(mixed_audio_path)
# First audible section should start around 2s (after 2s silence)
if result.audible_segments:
first_segment = result.audible_segments[0]
# Allow some tolerance for window-based analysis
assert first_segment.start_seconds >= 1.5
assert first_segment.start_seconds <= 2.5
def test_short_segments_are_filtered(self, temp_dir):
"""Segments shorter than min_segment_duration_ms should be filtered."""
# Create audio with very short audible blips
silence1 = AudioSegment.silent(duration=1000, frame_rate=44100)
blip = Sine(440).to_audio_segment(duration=50) - 10 # 50ms blip
silence2 = AudioSegment.silent(duration=1000, frame_rate=44100)
audio = silence1 + blip + silence2
audio_path = os.path.join(temp_dir, "short_blip.flac")
audio.export(audio_path, format="flac")
# Analyzer with 100ms minimum should filter out 50ms blip
analyzer = AudioAnalyzer(min_segment_duration_ms=100)
result = analyzer.analyze(audio_path)
# The short blip should be filtered
assert len(result.audible_segments) == 0
def test_close_segments_are_merged(self, temp_dir):
"""Close segments should be merged based on merge_gap_ms."""
# Create audio with two close audible sections
tone1 = Sine(440).to_audio_segment(duration=1000) - 10 # 1s
gap = AudioSegment.silent(duration=200, frame_rate=44100) # 200ms gap
tone2 = Sine(440).to_audio_segment(duration=1000) - 10 # 1s
audio = tone1 + gap + tone2
audio_path = os.path.join(temp_dir, "close_segments.flac")
audio.export(audio_path, format="flac")
# With 500ms merge gap, the 200ms gap should cause merging
analyzer = AudioAnalyzer(merge_gap_ms=500)
result = analyzer.analyze(audio_path)
# Should merge into one segment
assert len(result.audible_segments) == 1
class TestThresholdBehavior:
"""Tests for silence threshold behavior."""
def test_custom_threshold_affects_detection(self, temp_dir):
"""Different thresholds should detect different content."""
# Create audio at -35dB
tone = Sine(440).to_audio_segment(duration=5000)
tone = tone - 35
audio_path = os.path.join(temp_dir, "threshold_test.flac")
tone.export(audio_path, format="flac")
# With -40dB threshold, -35dB audio should be detected
analyzer_low = AudioAnalyzer(silence_threshold_db=-40.0)
result_low = analyzer_low.analyze(audio_path)
# With -30dB threshold, -35dB audio should NOT be detected
analyzer_high = AudioAnalyzer(silence_threshold_db=-30.0)
result_high = analyzer_high.analyze(audio_path)
assert result_low.has_audible_content is True
assert result_high.has_audible_content is False
def test_threshold_stored_in_result(self, silent_audio_path):
"""The threshold used should be stored in the result."""
threshold = -42.5
analyzer = AudioAnalyzer(silence_threshold_db=threshold)
result = analyzer.analyze(silent_audio_path)
assert result.silence_threshold_db == threshold
class TestRecommendationLogic:
"""Tests for instrumental selection recommendations."""
def test_no_content_recommends_clean(self, silent_audio_path):
"""No audible content should recommend clean."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(silent_audio_path)
assert result.recommended_selection == RecommendedSelection.CLEAN
def test_high_percentage_recommends_review(self, loud_audio_path):
"""High audible percentage (>20%) should recommend review."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(loud_audio_path)
assert result.audible_percentage > 20.0
assert result.recommended_selection == RecommendedSelection.REVIEW_NEEDED
def test_loud_segments_recommend_review(self, temp_dir):
"""Loud segments (>-20dB) should recommend review."""
# Create audio with a loud section
silence = AudioSegment.silent(duration=5000, frame_rate=44100)
loud_section = Sine(440).to_audio_segment(duration=500) - 5 # Very loud
audio = silence + loud_section + silence
audio_path = os.path.join(temp_dir, "loud_section.flac")
audio.export(audio_path, format="flac")
analyzer = AudioAnalyzer()
result = analyzer.analyze(audio_path)
# Even though percentage is low, loud segment should trigger review
assert result.recommended_selection == RecommendedSelection.REVIEW_NEEDED
class TestAmplitudeEnvelope:
"""Tests for amplitude envelope extraction."""
def test_envelope_length_matches_duration(self, loud_audio_path):
"""Envelope should have expected number of points."""
analyzer = AudioAnalyzer()
window_ms = 100
envelope = analyzer.get_amplitude_envelope(loud_audio_path, window_ms=window_ms)
# 10 second audio with 100ms windows = ~100 points
assert len(envelope) >= 90
assert len(envelope) <= 110
def test_envelope_normalized_to_0_1(self, loud_audio_path):
"""Normalized envelope should have values between 0 and 1."""
analyzer = AudioAnalyzer()
envelope = analyzer.get_amplitude_envelope(
loud_audio_path, normalize=True
)
assert all(0.0 <= v <= 1.0 for v in envelope)
def test_envelope_unnormalized_in_db(self, loud_audio_path):
"""Unnormalized envelope should be in dB."""
analyzer = AudioAnalyzer()
envelope = analyzer.get_amplitude_envelope(
loud_audio_path, normalize=False
)
# dB values should be negative (below full scale)
assert all(v <= 0 for v in envelope)
# Most values should be above -60dB for loud audio
assert sum(1 for v in envelope if v > -60) > len(envelope) * 0.5
class TestEdgeCases:
"""Tests for edge cases and error handling."""
def test_nonexistent_file_raises_error(self):
"""Analyzing non-existent file should raise FileNotFoundError."""
analyzer = AudioAnalyzer()
with pytest.raises(FileNotFoundError):
analyzer.analyze("/nonexistent/path/to/audio.flac")
def test_stereo_audio_handled(self, stereo_audio_path):
"""Stereo audio should be converted to mono and analyzed."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(stereo_audio_path)
# Should not raise and should detect content
assert result.has_audible_content is True
def test_total_duration_accurate(self, mixed_audio_path):
"""Total duration should match audio file duration."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(mixed_audio_path)
# Mixed audio is 10 seconds
assert abs(result.total_duration_seconds - 10.0) < 0.5
class TestAnalysisResultMethods:
"""Tests for AnalysisResult methods."""
def test_segment_count_property(self, mixed_audio_path):
"""segment_count should return number of segments."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(mixed_audio_path)
assert result.segment_count == len(result.audible_segments)
def test_get_segments_in_range(self, mixed_audio_path):
"""get_segments_in_range should filter segments correctly."""
analyzer = AudioAnalyzer()
result = analyzer.analyze(mixed_audio_path)
# Get segments in the first 5 seconds
segments_in_range = result.get_segments_in_range(0, 5)
# All returned segments should overlap with [0, 5]
for seg in segments_in_range:
assert not (seg.end_seconds <= 0 or seg.start_seconds >= 5)
@@ -0,0 +1,416 @@
"""
Unit tests for AudioEditor.
Tests cover:
- Muting single and multiple regions
- Region boundary handling
- Custom instrumental creation
- Region normalization and merging
- Error handling
"""
import os
import pytest
from pydub import AudioSegment
from karaoke_gen.instrumental_review import (
AudioEditor,
MuteRegion,
)
from karaoke_gen.instrumental_review.models import CustomInstrumentalResult
class TestAudioEditorInit:
"""Tests for AudioEditor initialization."""
def test_default_output_format(self):
"""Test editor creates with FLAC as default format."""
editor = AudioEditor()
assert editor.output_format == "flac"
def test_custom_output_format(self):
"""Test editor accepts custom output format."""
editor = AudioEditor(output_format="wav")
assert editor.output_format == "wav"
class TestMuteRegionModel:
"""Tests for MuteRegion model."""
def test_duration_property(self):
"""Test duration_seconds property calculation."""
region = MuteRegion(start_seconds=1.0, end_seconds=3.0)
assert region.duration_seconds == 2.0
def test_overlaps_returns_true_for_overlapping(self):
"""Test overlaps method for overlapping regions."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=3.0)
region2 = MuteRegion(start_seconds=2.0, end_seconds=4.0)
assert region1.overlaps(region2) is True
assert region2.overlaps(region1) is True
def test_overlaps_returns_false_for_non_overlapping(self):
"""Test overlaps method for non-overlapping regions."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=2.0)
region2 = MuteRegion(start_seconds=3.0, end_seconds=4.0)
assert region1.overlaps(region2) is False
assert region2.overlaps(region1) is False
def test_overlaps_edge_case_adjacent(self):
"""Test overlaps method for adjacent regions (touching but not overlapping)."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=2.0)
region2 = MuteRegion(start_seconds=2.0, end_seconds=3.0)
# Adjacent regions should not be considered overlapping
assert region1.overlaps(region2) is False
def test_merge_regions(self):
"""Test merge method combines overlapping regions."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=3.0)
region2 = MuteRegion(start_seconds=2.0, end_seconds=4.0)
merged = region1.merge(region2)
assert merged.start_seconds == 1.0
assert merged.end_seconds == 4.0
class TestMuteSingleRegion:
"""Tests for muting a single region."""
def test_mute_single_region_creates_output(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Muting a single region should create output file."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=2.0, end_seconds=4.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(output_path)
assert result.output_path == output_path
def test_mute_single_region_duration_correct(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Output duration should match input duration."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=2.0, end_seconds=4.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
# Check output duration (should be ~10 seconds)
output_audio = AudioSegment.from_file(output_path)
assert abs(len(output_audio) / 1000.0 - 10.0) < 0.5
def test_mute_region_statistics(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Result should include correct mute statistics."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=2.0, end_seconds=4.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert len(result.mute_regions_applied) == 1
assert result.total_muted_duration_seconds == 2.0
class TestMuteMultipleRegions:
"""Tests for muting multiple regions."""
def test_mute_multiple_regions(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Multiple mute regions should all be applied."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [
MuteRegion(start_seconds=1.0, end_seconds=2.0),
MuteRegion(start_seconds=5.0, end_seconds=6.0),
MuteRegion(start_seconds=8.0, end_seconds=9.0),
]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(output_path)
assert len(result.mute_regions_applied) == 3
assert result.total_muted_duration_seconds == 3.0
def test_overlapping_regions_are_merged(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Overlapping mute regions should be merged."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
# These overlap: [1-3] and [2-4] should become [1-4]
mute_regions = [
MuteRegion(start_seconds=1.0, end_seconds=3.0),
MuteRegion(start_seconds=2.0, end_seconds=4.0),
]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
# Should be merged into 1 region
assert len(result.mute_regions_applied) == 1
assert result.mute_regions_applied[0].start_seconds == 1.0
assert result.mute_regions_applied[0].end_seconds == 4.0
class TestMuteRegionBoundaries:
"""Tests for mute region boundary handling."""
def test_mute_at_start(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Muting at the start of audio should work."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=0.0, end_seconds=2.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(output_path)
assert result.total_muted_duration_seconds == 2.0
def test_mute_at_end(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Muting at the end of audio should work."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=8.0, end_seconds=10.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(output_path)
def test_mute_region_clamped_to_audio_length(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Mute region extending beyond audio should be clamped."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
# Region extends beyond 10 second audio
mute_regions = [MuteRegion(start_seconds=8.0, end_seconds=15.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
# Should not raise error
assert os.path.exists(output_path)
class TestCustomInstrumentalCombination:
"""Tests for combining clean instrumental with muted backing vocals."""
def test_output_combines_both_tracks(
self, clean_instrumental_path, mixed_audio_path, temp_dir
):
"""Output should be combination of clean instrumental and edited backing."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=3.0, end_seconds=5.0)]
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=mixed_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(output_path)
output_audio = AudioSegment.from_file(output_path)
# Output should be stereo or have similar properties
assert len(output_audio) > 0
def test_no_mute_regions_still_combines(
self, clean_instrumental_path, mixed_audio_path, temp_dir
):
"""Empty mute regions should still combine tracks."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
result = editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=mixed_audio_path,
mute_regions=[],
output_path=output_path,
)
assert os.path.exists(output_path)
assert len(result.mute_regions_applied) == 0
class TestApplyMuteToSingleTrack:
"""Tests for apply_mute_to_single_track method."""
def test_mute_single_track(self, loud_audio_path, temp_dir):
"""Should mute regions in a single track."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "muted_backing.flac")
mute_regions = [MuteRegion(start_seconds=2.0, end_seconds=4.0)]
result_path = editor.apply_mute_to_single_track(
audio_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(result_path)
assert result_path == output_path
class TestErrorHandling:
"""Tests for error handling."""
def test_nonexistent_clean_instrumental_raises_error(
self, loud_audio_path, temp_dir
):
"""Non-existent clean instrumental should raise FileNotFoundError."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
with pytest.raises(FileNotFoundError):
editor.create_custom_instrumental(
clean_instrumental_path="/nonexistent/clean.flac",
backing_vocals_path=loud_audio_path,
mute_regions=[],
output_path=output_path,
)
def test_nonexistent_backing_vocals_raises_error(
self, clean_instrumental_path, temp_dir
):
"""Non-existent backing vocals should raise FileNotFoundError."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
with pytest.raises(FileNotFoundError):
editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path="/nonexistent/backing.flac",
mute_regions=[],
output_path=output_path,
)
def test_invalid_region_start_raises_error(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Negative region start should raise ValidationError at model level."""
from pydantic import ValidationError
# Pydantic validates at model creation time
with pytest.raises(ValidationError):
MuteRegion(start_seconds=-1.0, end_seconds=2.0)
def test_invalid_region_end_before_start_raises_error(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Region end before start should raise ValueError."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "custom_instrumental.flac")
mute_regions = [MuteRegion(start_seconds=5.0, end_seconds=3.0)]
with pytest.raises(ValueError):
editor.create_custom_instrumental(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
class TestPreviewWithMutes:
"""Tests for preview_with_mutes method."""
def test_preview_returns_audio_segment(
self, clean_instrumental_path, loud_audio_path
):
"""Preview should return AudioSegment in memory."""
editor = AudioEditor()
mute_regions = [MuteRegion(start_seconds=2.0, end_seconds=4.0)]
preview = editor.preview_with_mutes(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
)
assert isinstance(preview, AudioSegment)
assert len(preview) > 0
def test_preview_can_save_to_file(
self, clean_instrumental_path, loud_audio_path, temp_dir
):
"""Preview should optionally save to file."""
editor = AudioEditor()
output_path = os.path.join(temp_dir, "preview.flac")
mute_regions = [MuteRegion(start_seconds=2.0, end_seconds=4.0)]
preview = editor.preview_with_mutes(
clean_instrumental_path=clean_instrumental_path,
backing_vocals_path=loud_audio_path,
mute_regions=mute_regions,
output_path=output_path,
)
assert os.path.exists(output_path)
@@ -0,0 +1,388 @@
"""
Unit tests for instrumental_review models.
Tests cover:
- Model creation and validation
- Property methods
- Serialization/deserialization
- Edge cases
"""
import pytest
from pydantic import ValidationError
from karaoke_gen.instrumental_review import (
AnalysisResult,
AudibleSegment,
MuteRegion,
RecommendedSelection,
)
from karaoke_gen.instrumental_review.models import CustomInstrumentalResult
class TestRecommendedSelection:
"""Tests for RecommendedSelection enum."""
def test_enum_values(self):
"""Test enum has expected values."""
assert RecommendedSelection.CLEAN.value == "clean"
assert RecommendedSelection.WITH_BACKING.value == "with_backing"
assert RecommendedSelection.REVIEW_NEEDED.value == "review_needed"
def test_enum_from_string(self):
"""Test creating enum from string value."""
assert RecommendedSelection("clean") == RecommendedSelection.CLEAN
assert RecommendedSelection("with_backing") == RecommendedSelection.WITH_BACKING
assert RecommendedSelection("review_needed") == RecommendedSelection.REVIEW_NEEDED
class TestAudibleSegment:
"""Tests for AudibleSegment model."""
def test_create_valid_segment(self):
"""Test creating a valid audible segment."""
segment = AudibleSegment(
start_seconds=1.0,
end_seconds=3.0,
duration_seconds=2.0,
avg_amplitude_db=-15.0,
)
assert segment.start_seconds == 1.0
assert segment.end_seconds == 3.0
assert segment.duration_seconds == 2.0
assert segment.avg_amplitude_db == -15.0
def test_default_peak_amplitude(self):
"""Test default peak amplitude is 0.0."""
segment = AudibleSegment(
start_seconds=0.0,
end_seconds=1.0,
duration_seconds=1.0,
avg_amplitude_db=-20.0,
)
assert segment.peak_amplitude_db == 0.0
def test_is_loud_property_true(self):
"""Test is_loud returns True for loud segments."""
segment = AudibleSegment(
start_seconds=0.0,
end_seconds=1.0,
duration_seconds=1.0,
avg_amplitude_db=-15.0, # Louder than -20dB
)
assert segment.is_loud is True
def test_is_loud_property_false(self):
"""Test is_loud returns False for quiet segments."""
segment = AudibleSegment(
start_seconds=0.0,
end_seconds=1.0,
duration_seconds=1.0,
avg_amplitude_db=-25.0, # Quieter than -20dB
)
assert segment.is_loud is False
def test_negative_start_invalid(self):
"""Test negative start_seconds is invalid."""
with pytest.raises(ValidationError):
AudibleSegment(
start_seconds=-1.0,
end_seconds=1.0,
duration_seconds=2.0,
avg_amplitude_db=-15.0,
)
def test_negative_duration_invalid(self):
"""Test negative duration_seconds is invalid."""
with pytest.raises(ValidationError):
AudibleSegment(
start_seconds=0.0,
end_seconds=1.0,
duration_seconds=-1.0,
avg_amplitude_db=-15.0,
)
def test_serialization_to_dict(self):
"""Test segment can be serialized to dict."""
segment = AudibleSegment(
start_seconds=1.0,
end_seconds=3.0,
duration_seconds=2.0,
avg_amplitude_db=-15.0,
peak_amplitude_db=-10.0,
)
data = segment.model_dump()
assert data["start_seconds"] == 1.0
assert data["end_seconds"] == 3.0
assert data["duration_seconds"] == 2.0
assert data["avg_amplitude_db"] == -15.0
assert data["peak_amplitude_db"] == -10.0
class TestMuteRegion:
"""Tests for MuteRegion model."""
def test_create_valid_region(self):
"""Test creating a valid mute region."""
region = MuteRegion(start_seconds=1.0, end_seconds=3.0)
assert region.start_seconds == 1.0
assert region.end_seconds == 3.0
def test_duration_property(self):
"""Test duration_seconds property."""
region = MuteRegion(start_seconds=1.0, end_seconds=3.0)
assert region.duration_seconds == 2.0
def test_overlaps_method(self):
"""Test overlaps method with overlapping regions."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=3.0)
region2 = MuteRegion(start_seconds=2.0, end_seconds=4.0)
assert region1.overlaps(region2) is True
def test_overlaps_method_no_overlap(self):
"""Test overlaps method with non-overlapping regions."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=2.0)
region2 = MuteRegion(start_seconds=3.0, end_seconds=4.0)
assert region1.overlaps(region2) is False
def test_overlaps_contained(self):
"""Test overlaps when one region contains another."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=5.0)
region2 = MuteRegion(start_seconds=2.0, end_seconds=3.0)
assert region1.overlaps(region2) is True
assert region2.overlaps(region1) is True
def test_merge_method(self):
"""Test merge method creates combined region."""
region1 = MuteRegion(start_seconds=1.0, end_seconds=3.0)
region2 = MuteRegion(start_seconds=2.0, end_seconds=4.0)
merged = region1.merge(region2)
assert merged.start_seconds == 1.0
assert merged.end_seconds == 4.0
def test_negative_start_invalid(self):
"""Test negative start_seconds is invalid."""
with pytest.raises(ValidationError):
MuteRegion(start_seconds=-1.0, end_seconds=1.0)
def test_serialization_to_dict(self):
"""Test region can be serialized to dict."""
region = MuteRegion(start_seconds=1.0, end_seconds=3.0)
data = region.model_dump()
assert data["start_seconds"] == 1.0
assert data["end_seconds"] == 3.0
class TestAnalysisResult:
"""Tests for AnalysisResult model."""
def test_create_valid_result(self):
"""Test creating a valid analysis result."""
result = AnalysisResult(
has_audible_content=True,
total_duration_seconds=120.0,
audible_segments=[],
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
)
assert result.has_audible_content is True
assert result.total_duration_seconds == 120.0
assert result.recommended_selection == RecommendedSelection.REVIEW_NEEDED
def test_default_values(self):
"""Test default values are set correctly."""
result = AnalysisResult(
has_audible_content=False,
total_duration_seconds=60.0,
recommended_selection=RecommendedSelection.CLEAN,
)
assert result.audible_segments == []
assert result.silence_threshold_db == -40.0
assert result.total_audible_duration_seconds == 0.0
assert result.audible_percentage == 0.0
assert result.waveform_data is None
def test_segment_count_property(self):
"""Test segment_count property."""
segments = [
AudibleSegment(
start_seconds=0.0, end_seconds=1.0,
duration_seconds=1.0, avg_amplitude_db=-15.0
),
AudibleSegment(
start_seconds=2.0, end_seconds=3.0,
duration_seconds=1.0, avg_amplitude_db=-15.0
),
]
result = AnalysisResult(
has_audible_content=True,
total_duration_seconds=10.0,
audible_segments=segments,
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
)
assert result.segment_count == 2
def test_get_segments_in_range(self):
"""Test get_segments_in_range method."""
segments = [
AudibleSegment(
start_seconds=1.0, end_seconds=2.0,
duration_seconds=1.0, avg_amplitude_db=-15.0
),
AudibleSegment(
start_seconds=5.0, end_seconds=6.0,
duration_seconds=1.0, avg_amplitude_db=-15.0
),
AudibleSegment(
start_seconds=8.0, end_seconds=9.0,
duration_seconds=1.0, avg_amplitude_db=-15.0
),
]
result = AnalysisResult(
has_audible_content=True,
total_duration_seconds=10.0,
audible_segments=segments,
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
)
# Get segments between 0-3 seconds
in_range = result.get_segments_in_range(0.0, 3.0)
assert len(in_range) == 1
assert in_range[0].start_seconds == 1.0
def test_get_segments_in_range_partial_overlap(self):
"""Test get_segments_in_range with partial overlap."""
segments = [
AudibleSegment(
start_seconds=2.0, end_seconds=6.0,
duration_seconds=4.0, avg_amplitude_db=-15.0
),
]
result = AnalysisResult(
has_audible_content=True,
total_duration_seconds=10.0,
audible_segments=segments,
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
)
# Segment overlaps with range [4, 8]
in_range = result.get_segments_in_range(4.0, 8.0)
assert len(in_range) == 1
def test_audible_percentage_validation(self):
"""Test audible_percentage must be 0-100."""
with pytest.raises(ValidationError):
AnalysisResult(
has_audible_content=True,
total_duration_seconds=60.0,
recommended_selection=RecommendedSelection.CLEAN,
audible_percentage=150.0, # Invalid
)
def test_serialization_to_dict(self):
"""Test result can be serialized to dict."""
segments = [
AudibleSegment(
start_seconds=1.0, end_seconds=2.0,
duration_seconds=1.0, avg_amplitude_db=-15.0
),
]
result = AnalysisResult(
has_audible_content=True,
total_duration_seconds=60.0,
audible_segments=segments,
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
total_audible_duration_seconds=1.0,
audible_percentage=1.67,
)
data = result.model_dump()
assert data["has_audible_content"] is True
assert data["total_duration_seconds"] == 60.0
assert len(data["audible_segments"]) == 1
assert data["recommended_selection"] == "review_needed"
def test_serialization_to_json(self):
"""Test result can be serialized to JSON."""
result = AnalysisResult(
has_audible_content=False,
total_duration_seconds=60.0,
recommended_selection=RecommendedSelection.CLEAN,
)
json_str = result.model_dump_json()
assert '"has_audible_content":false' in json_str.lower().replace(" ", "")
assert '"recommended_selection":"clean"' in json_str.lower().replace(" ", "")
class TestCustomInstrumentalResult:
"""Tests for CustomInstrumentalResult model."""
def test_create_valid_result(self):
"""Test creating a valid custom instrumental result."""
mute_regions = [
MuteRegion(start_seconds=1.0, end_seconds=2.0),
]
result = CustomInstrumentalResult(
output_path="/path/to/custom.flac",
mute_regions_applied=mute_regions,
total_muted_duration_seconds=1.0,
output_duration_seconds=60.0,
)
assert result.output_path == "/path/to/custom.flac"
assert len(result.mute_regions_applied) == 1
assert result.total_muted_duration_seconds == 1.0
assert result.output_duration_seconds == 60.0
def test_default_values(self):
"""Test default values are set correctly."""
result = CustomInstrumentalResult(
output_path="/path/to/output.flac",
)
assert result.mute_regions_applied == []
assert result.total_muted_duration_seconds == 0.0
assert result.output_duration_seconds == 0.0
def test_serialization_to_dict(self):
"""Test result can be serialized to dict."""
result = CustomInstrumentalResult(
output_path="/path/to/custom.flac",
mute_regions_applied=[
MuteRegion(start_seconds=1.0, end_seconds=2.0),
],
total_muted_duration_seconds=1.0,
output_duration_seconds=60.0,
)
data = result.model_dump()
assert data["output_path"] == "/path/to/custom.flac"
assert len(data["mute_regions_applied"]) == 1
@@ -0,0 +1,535 @@
"""
Unit tests for the InstrumentalReviewServer module.
Tests the local FastAPI server for instrumental review, including:
- Server initialization
- Request/Response models
- API endpoint logic
"""
import os
import pytest
import tempfile
from pathlib import Path
from unittest.mock import MagicMock, patch, AsyncMock
from karaoke_gen.instrumental_review.server import (
InstrumentalReviewServer,
MuteRegionRequest,
CreateCustomRequest,
SelectionRequest,
)
from karaoke_gen.instrumental_review import (
AnalysisResult,
AudibleSegment,
RecommendedSelection,
)
class TestRequestModels:
"""Test Pydantic request models."""
def test_mute_region_request_valid(self):
"""Test creating a valid MuteRegionRequest."""
region = MuteRegionRequest(start_seconds=1.0, end_seconds=2.0)
assert region.start_seconds == 1.0
assert region.end_seconds == 2.0
def test_mute_region_request_negative_values(self):
"""Test MuteRegionRequest accepts negative values (validation elsewhere)."""
region = MuteRegionRequest(start_seconds=-1.0, end_seconds=2.0)
assert region.start_seconds == -1.0
def test_create_custom_request_valid(self):
"""Test creating a valid CreateCustomRequest."""
request = CreateCustomRequest(
mute_regions=[
MuteRegionRequest(start_seconds=1.0, end_seconds=2.0),
MuteRegionRequest(start_seconds=5.0, end_seconds=6.0),
]
)
assert len(request.mute_regions) == 2
def test_create_custom_request_empty(self):
"""Test CreateCustomRequest with empty mute_regions."""
request = CreateCustomRequest(mute_regions=[])
assert len(request.mute_regions) == 0
def test_selection_request_valid(self):
"""Test creating a valid SelectionRequest."""
request = SelectionRequest(selection="clean")
assert request.selection == "clean"
def test_selection_request_any_string(self):
"""Test SelectionRequest accepts any string (validation in endpoint)."""
request = SelectionRequest(selection="invalid")
assert request.selection == "invalid"
class TestServerInitialization:
"""Test InstrumentalReviewServer initialization."""
@pytest.fixture
def mock_analysis(self):
"""Create a mock analysis result."""
return AnalysisResult(
has_audible_content=True,
total_duration_seconds=180.0,
audible_segments=[
AudibleSegment(
start_seconds=10.0,
end_seconds=15.0,
duration_seconds=5.0,
avg_amplitude_db=-30.0,
peak_amplitude_db=-25.0,
)
],
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
total_audible_duration_seconds=5.0,
audible_percentage=2.78,
silence_threshold_db=-40.0,
)
@pytest.fixture
def temp_files(self, tmp_path):
"""Create temporary audio files for testing."""
backing = tmp_path / "backing.flac"
clean = tmp_path / "clean.flac"
waveform = tmp_path / "waveform.png"
backing.write_bytes(b"fake audio")
clean.write_bytes(b"fake audio")
waveform.write_bytes(b"fake png")
return {
"output_dir": str(tmp_path),
"backing_vocals_path": str(backing),
"clean_instrumental_path": str(clean),
"waveform_path": str(waveform),
}
def test_server_initialization(self, mock_analysis, temp_files):
"""Test server initializes with all required parameters."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
assert server.output_dir == temp_files["output_dir"]
assert server.base_name == "Artist - Title"
assert server.analysis == mock_analysis
assert server.backing_vocals_path == temp_files["backing_vocals_path"]
assert server.clean_instrumental_path == temp_files["clean_instrumental_path"]
assert server.waveform_path == temp_files["waveform_path"]
assert server.with_backing_path is None
assert server.custom_instrumental_path is None
assert server.selection is None
def test_server_initialization_with_optional_paths(self, mock_analysis, temp_files):
"""Test server initializes with optional with_backing_path."""
with_backing = Path(temp_files["output_dir"]) / "with_backing.flac"
with_backing.write_bytes(b"fake audio")
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
with_backing_path=str(with_backing),
)
assert server.with_backing_path == str(with_backing)
def test_get_selection_raises_without_selection(self, mock_analysis, temp_files):
"""Test get_selection raises when no selection made."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
with pytest.raises(ValueError, match="No selection has been made"):
server.get_selection()
def test_get_selection_returns_selection(self, mock_analysis, temp_files):
"""Test get_selection returns the selection after it's set."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
server.selection = "clean"
assert server.get_selection() == "clean"
def test_get_custom_instrumental_path_none_by_default(self, mock_analysis, temp_files):
"""Test custom instrumental path is None by default."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
assert server.get_custom_instrumental_path() is None
def test_get_custom_instrumental_path_returns_path(self, mock_analysis, temp_files):
"""Test custom instrumental path is returned when set."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
server.custom_instrumental_path = "/path/to/custom.flac"
assert server.get_custom_instrumental_path() == "/path/to/custom.flac"
class TestServerAppCreation:
"""Test FastAPI app creation and routes."""
@pytest.fixture
def mock_analysis(self):
"""Create a mock analysis result."""
return AnalysisResult(
has_audible_content=True,
total_duration_seconds=180.0,
audible_segments=[],
recommended_selection=RecommendedSelection.CLEAN,
total_audible_duration_seconds=0.0,
audible_percentage=0.0,
silence_threshold_db=-40.0,
)
@pytest.fixture
def temp_files(self, tmp_path):
"""Create temporary files."""
backing = tmp_path / "backing.flac"
clean = tmp_path / "clean.flac"
waveform = tmp_path / "waveform.png"
backing.write_bytes(b"fake audio")
clean.write_bytes(b"fake audio")
waveform.write_bytes(b"fake png")
return {
"output_dir": str(tmp_path),
"backing_vocals_path": str(backing),
"clean_instrumental_path": str(clean),
"waveform_path": str(waveform),
}
def test_create_app_returns_fastapi_app(self, mock_analysis, temp_files):
"""Test _create_app returns a FastAPI application."""
from fastapi import FastAPI
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
app = server._create_app()
assert isinstance(app, FastAPI)
def test_app_has_cors_middleware(self, mock_analysis, temp_files):
"""Test app has CORS middleware configured."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
app = server._create_app()
# Check middleware is configured (FastAPI stores middleware in user_middleware)
middleware_classes = [m.cls.__name__ for m in app.user_middleware]
assert "CORSMiddleware" in middleware_classes
def test_get_frontend_html_returns_string(self, mock_analysis, temp_files):
"""Test _get_frontend_html returns HTML string."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
html = server._get_frontend_html()
assert isinstance(html, str)
assert "<!DOCTYPE html>" in html
assert "Instrumental Review" in html
def test_get_frontend_html_contains_required_elements(self, mock_analysis, temp_files):
"""Test frontend HTML contains all required UI elements."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
html = server._get_frontend_html()
# Check for key UI components
assert "waveform" in html.lower()
assert "audio" in html.lower()
assert "mute" in html.lower()
assert "selection" in html.lower()
assert "clean" in html.lower()
class TestServerStop:
"""Test server stop functionality."""
@pytest.fixture
def mock_analysis(self):
"""Create a mock analysis result."""
return AnalysisResult(
has_audible_content=False,
total_duration_seconds=180.0,
audible_segments=[],
recommended_selection=RecommendedSelection.CLEAN,
total_audible_duration_seconds=0.0,
audible_percentage=0.0,
silence_threshold_db=-40.0,
)
@pytest.fixture
def temp_files(self, tmp_path):
"""Create temporary files."""
backing = tmp_path / "backing.flac"
clean = tmp_path / "clean.flac"
waveform = tmp_path / "waveform.png"
backing.write_bytes(b"fake audio")
clean.write_bytes(b"fake audio")
waveform.write_bytes(b"fake png")
return {
"output_dir": str(tmp_path),
"backing_vocals_path": str(backing),
"clean_instrumental_path": str(clean),
"waveform_path": str(waveform),
}
def test_stop_sets_shutdown_event(self, mock_analysis, temp_files):
"""Test stop() sets the shutdown event."""
server = InstrumentalReviewServer(
output_dir=temp_files["output_dir"],
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=temp_files["waveform_path"],
backing_vocals_path=temp_files["backing_vocals_path"],
clean_instrumental_path=temp_files["clean_instrumental_path"],
)
assert not server._shutdown_event.is_set()
server.stop()
assert server._shutdown_event.is_set()
class TestServerAPIEndpoints:
"""Test FastAPI endpoint handlers using TestClient."""
@pytest.fixture
def mock_analysis(self):
"""Create a mock analysis result."""
return AnalysisResult(
has_audible_content=True,
total_duration_seconds=180.0,
audible_segments=[
AudibleSegment(
start_seconds=10.0,
end_seconds=15.0,
duration_seconds=5.0,
avg_amplitude_db=-30.0,
peak_amplitude_db=-25.0,
)
],
recommended_selection=RecommendedSelection.REVIEW_NEEDED,
total_audible_duration_seconds=5.0,
audible_percentage=2.78,
silence_threshold_db=-40.0,
)
@pytest.fixture
def server_with_files(self, tmp_path, mock_analysis):
"""Create server with real temp files."""
from pydub import AudioSegment
from pydub.generators import Sine
# Create a real audio file for testing
audio = Sine(440).to_audio_segment(duration=1000) # 1 second of 440Hz sine
backing = tmp_path / "backing.flac"
clean = tmp_path / "clean.flac"
waveform = tmp_path / "waveform.png"
audio.export(str(backing), format="flac")
audio.export(str(clean), format="flac")
waveform.write_bytes(b"\x89PNG\r\n\x1a\n") # PNG magic bytes
server = InstrumentalReviewServer(
output_dir=str(tmp_path),
base_name="Artist - Title",
analysis=mock_analysis,
waveform_path=str(waveform),
backing_vocals_path=str(backing),
clean_instrumental_path=str(clean),
)
return server
@pytest.fixture
def client(self, server_with_files):
"""Create TestClient for the server."""
from fastapi.testclient import TestClient
app = server_with_files._create_app()
return TestClient(app)
def test_root_returns_html(self, client):
"""Test root endpoint returns HTML page."""
response = client.get("/")
assert response.status_code == 200
assert "text/html" in response.headers["content-type"]
assert "Instrumental Review" in response.text
def test_get_analysis_returns_data(self, client, mock_analysis):
"""Test analysis endpoint returns correct data."""
response = client.get("/api/jobs/local/instrumental-analysis")
assert response.status_code == 200
data = response.json()
assert data["job_id"] == "local"
assert data["status"] == "awaiting_instrumental_selection"
assert data["analysis"]["has_audible_content"] == True
assert data["analysis"]["total_duration_seconds"] == 180.0
assert len(data["analysis"]["audible_segments"]) == 1
assert data["audio_urls"]["backing_vocals"] is not None
assert data["audio_urls"]["clean_instrumental"] is not None
def test_get_waveform_data_returns_amplitudes(self, client):
"""Test waveform data endpoint returns amplitudes."""
response = client.get("/api/jobs/local/waveform-data?num_points=100")
assert response.status_code == 200
data = response.json()
assert "amplitudes" in data
assert "duration" in data
assert isinstance(data["amplitudes"], list)
assert len(data["amplitudes"]) == 100
def test_get_waveform_data_validates_num_points(self, client):
"""Test waveform data validates num_points parameter."""
# Test invalid num_points (0)
response = client.get("/api/jobs/local/waveform-data?num_points=0")
assert response.status_code == 400
assert "num_points must be between" in response.json()["detail"]
# Test invalid num_points (negative)
response = client.get("/api/jobs/local/waveform-data?num_points=-10")
assert response.status_code == 400
# Test invalid num_points (too large)
response = client.get("/api/jobs/local/waveform-data?num_points=100000")
assert response.status_code == 400
def test_stream_audio_returns_file(self, client):
"""Test audio streaming endpoint returns audio file."""
response = client.get("/api/audio/backing_vocals")
assert response.status_code == 200
assert "audio/flac" in response.headers["content-type"]
def test_stream_audio_invalid_type(self, client):
"""Test audio streaming with invalid stem type."""
response = client.get("/api/audio/invalid_type")
assert response.status_code == 404
def test_get_waveform_image(self, client):
"""Test waveform image endpoint."""
response = client.get("/api/waveform")
assert response.status_code == 200
assert "image/png" in response.headers["content-type"]
def test_select_instrumental_clean(self, client, server_with_files):
"""Test selecting clean instrumental."""
response = client.post(
"/api/jobs/local/select-instrumental",
json={"selection": "clean"}
)
assert response.status_code == 200
assert response.json()["status"] == "success"
assert server_with_files.selection == "clean"
def test_select_instrumental_with_backing(self, client, server_with_files):
"""Test selecting instrumental with backing vocals."""
response = client.post(
"/api/jobs/local/select-instrumental",
json={"selection": "with_backing"}
)
assert response.status_code == 200
assert server_with_files.selection == "with_backing"
def test_select_instrumental_invalid(self, client):
"""Test selecting invalid option."""
response = client.post(
"/api/jobs/local/select-instrumental",
json={"selection": "invalid"}
)
assert response.status_code == 400
assert "Invalid selection" in response.json()["detail"]
def test_create_custom_instrumental(self, client, server_with_files, tmp_path):
"""Test creating custom instrumental."""
response = client.post(
"/api/jobs/local/create-custom-instrumental",
json={
"mute_regions": [
{"start_seconds": 0.1, "end_seconds": 0.3},
]
}
)
assert response.status_code == 200
data = response.json()
assert data["status"] == "success"
assert data["custom_instrumental_url"] == "/api/audio/custom_instrumental"
assert server_with_files.custom_instrumental_path is not None
def test_create_custom_instrumental_empty_regions(self, client):
"""Test creating custom instrumental with no regions fails."""
response = client.post(
"/api/jobs/local/create-custom-instrumental",
json={"mute_regions": []}
)
assert response.status_code == 400
assert "No mute regions" in response.json()["detail"]
@@ -0,0 +1,415 @@
"""
Unit tests for WaveformGenerator.
Tests cover:
- Waveform image generation
- Segment highlighting
- Mute region highlighting
- Data-only generation
- Error handling
"""
import os
import pytest
from pathlib import Path
from karaoke_gen.instrumental_review import (
WaveformGenerator,
AudibleSegment,
MuteRegion,
)
class TestWaveformGeneratorInit:
"""Tests for WaveformGenerator initialization."""
def test_default_parameters(self):
"""Test generator creates with sensible defaults."""
generator = WaveformGenerator()
assert generator.width == 1200
assert generator.height == 200
assert generator.dpi == 100
assert generator.background_color == "#1a1a2e"
def test_custom_parameters(self):
"""Test generator accepts custom parameters."""
generator = WaveformGenerator(
width=800,
height=150,
background_color="#000000",
waveform_color="#00ff00",
dpi=150,
)
assert generator.width == 800
assert generator.height == 150
assert generator.background_color == "#000000"
assert generator.waveform_color == "#00ff00"
assert generator.dpi == 150
class TestWaveformImageGeneration:
"""Tests for waveform image generation."""
def test_generate_creates_image_file(self, loud_audio_path, temp_dir):
"""Generate should create a PNG image file."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
assert result == output_path
def test_generate_output_is_png(self, loud_audio_path, temp_dir):
"""Generated file should be a valid PNG."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
)
# Check PNG magic bytes
with open(output_path, 'rb') as f:
header = f.read(8)
assert header[:4] == b'\x89PNG'
def test_generate_creates_parent_directories(self, loud_audio_path, temp_dir):
"""Generate should create parent directories if needed."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "subdir", "nested", "waveform.png")
generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
def test_generate_silent_audio(self, silent_audio_path, temp_dir):
"""Generate should work with silent audio."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=silent_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
def test_generate_mixed_audio(self, mixed_audio_path, temp_dir):
"""Generate should work with mixed audio."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=mixed_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
class TestSegmentHighlighting:
"""Tests for audible segment highlighting."""
def test_generate_with_segments(self, loud_audio_path, temp_dir):
"""Generate with segment highlights should work."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
segments = [
AudibleSegment(
start_seconds=2.0,
end_seconds=4.0,
duration_seconds=2.0,
avg_amplitude_db=-15.0,
),
AudibleSegment(
start_seconds=6.0,
end_seconds=8.0,
duration_seconds=2.0,
avg_amplitude_db=-20.0,
),
]
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
segments=segments,
)
assert os.path.exists(output_path)
def test_generate_with_empty_segments(self, loud_audio_path, temp_dir):
"""Generate with empty segment list should work."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
segments=[],
)
assert os.path.exists(output_path)
class TestMuteRegionHighlighting:
"""Tests for mute region highlighting."""
def test_generate_with_mute_regions(self, loud_audio_path, temp_dir):
"""Generate with mute region highlights should work."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
mute_regions = [
MuteRegion(start_seconds=3.0, end_seconds=5.0),
MuteRegion(start_seconds=7.0, end_seconds=8.0),
]
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
mute_regions=mute_regions,
)
assert os.path.exists(output_path)
def test_generate_with_segments_and_mute_regions(
self, loud_audio_path, temp_dir
):
"""Generate with both segments and mute regions should work."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
segments = [
AudibleSegment(
start_seconds=2.0,
end_seconds=6.0,
duration_seconds=4.0,
avg_amplitude_db=-15.0,
),
]
mute_regions = [
MuteRegion(start_seconds=3.0, end_seconds=5.0),
]
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
segments=segments,
mute_regions=mute_regions,
)
assert os.path.exists(output_path)
class TestTimeAxis:
"""Tests for time axis rendering."""
def test_generate_with_time_axis(self, loud_audio_path, temp_dir):
"""Generate with time axis should work."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
show_time_axis=True,
)
assert os.path.exists(output_path)
def test_generate_without_time_axis(self, loud_audio_path, temp_dir):
"""Generate without time axis should work."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
show_time_axis=False,
)
assert os.path.exists(output_path)
class TestDataOnlyGeneration:
"""Tests for data-only waveform generation."""
def test_generate_data_only_returns_tuple(self, loud_audio_path):
"""generate_data_only should return (amplitudes, duration) tuple."""
generator = WaveformGenerator()
result = generator.generate_data_only(loud_audio_path)
assert isinstance(result, tuple)
assert len(result) == 2
def test_generate_data_only_amplitudes_are_list(self, loud_audio_path):
"""Amplitudes should be a list of floats."""
generator = WaveformGenerator()
amplitudes, duration = generator.generate_data_only(loud_audio_path)
assert isinstance(amplitudes, list)
assert all(isinstance(v, float) for v in amplitudes)
def test_generate_data_only_duration_is_float(self, loud_audio_path):
"""Duration should be a float."""
generator = WaveformGenerator()
amplitudes, duration = generator.generate_data_only(loud_audio_path)
assert isinstance(duration, float)
# 10 second audio
assert abs(duration - 10.0) < 0.5
def test_generate_data_only_respects_num_points(self, loud_audio_path):
"""num_points should control number of data points."""
generator = WaveformGenerator()
amplitudes_100, _ = generator.generate_data_only(
loud_audio_path, num_points=100
)
amplitudes_500, _ = generator.generate_data_only(
loud_audio_path, num_points=500
)
# Should be close to requested (may vary slightly due to rounding)
assert len(amplitudes_100) >= 90
assert len(amplitudes_100) <= 110
assert len(amplitudes_500) >= 450
assert len(amplitudes_500) <= 550
def test_generate_data_only_normalized(self, loud_audio_path):
"""Amplitudes should be normalized to 0-1 range."""
generator = WaveformGenerator()
amplitudes, _ = generator.generate_data_only(loud_audio_path)
assert all(0.0 <= v <= 1.0 for v in amplitudes)
class TestStereoHandling:
"""Tests for stereo audio handling."""
def test_generate_handles_stereo(self, stereo_audio_path, temp_dir):
"""Generate should handle stereo audio correctly."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
result = generator.generate(
audio_path=stereo_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
def test_generate_data_only_handles_stereo(self, stereo_audio_path):
"""generate_data_only should handle stereo audio."""
generator = WaveformGenerator()
amplitudes, duration = generator.generate_data_only(stereo_audio_path)
assert len(amplitudes) > 0
assert duration > 0
class TestErrorHandling:
"""Tests for error handling."""
def test_nonexistent_file_raises_error(self, temp_dir):
"""Non-existent audio file should raise FileNotFoundError."""
generator = WaveformGenerator()
output_path = os.path.join(temp_dir, "waveform.png")
with pytest.raises(FileNotFoundError):
generator.generate(
audio_path="/nonexistent/audio.flac",
output_path=output_path,
)
def test_generate_data_only_nonexistent_raises_error(self):
"""generate_data_only with non-existent file should raise."""
generator = WaveformGenerator()
with pytest.raises(FileNotFoundError):
generator.generate_data_only("/nonexistent/audio.flac")
class TestCustomColors:
"""Tests for custom color configuration."""
def test_custom_colors_applied(self, loud_audio_path, temp_dir):
"""Custom colors should be applied without error."""
generator = WaveformGenerator(
background_color="#ffffff",
waveform_color="#ff0000",
segment_color="#00ff00",
mute_color="#0000ff",
time_axis_color="#000000",
)
output_path = os.path.join(temp_dir, "waveform.png")
segments = [
AudibleSegment(
start_seconds=2.0,
end_seconds=4.0,
duration_seconds=2.0,
avg_amplitude_db=-15.0,
),
]
mute_regions = [
MuteRegion(start_seconds=6.0, end_seconds=8.0),
]
result = generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
segments=segments,
mute_regions=mute_regions,
)
assert os.path.exists(output_path)
class TestCustomDimensions:
"""Tests for custom image dimensions."""
def test_different_widths(self, loud_audio_path, temp_dir):
"""Different widths should work."""
for width in [600, 1200, 1920]:
generator = WaveformGenerator(width=width)
output_path = os.path.join(temp_dir, f"waveform_{width}.png")
generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
def test_different_heights(self, loud_audio_path, temp_dir):
"""Different heights should work."""
for height in [100, 200, 300]:
generator = WaveformGenerator(height=height)
output_path = os.path.join(temp_dir, f"waveform_{height}.png")
generator.generate(
audio_path=loud_audio_path,
output_path=output_path,
)
assert os.path.exists(output_path)
Loaded 100 of 103 files, more files were not shown because too many files have changed in this diff. Show more