From 4a74a2cc3adf0d761ba0ff4a8d954aebdd4998b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrew=20Beveridge=20=E2=98=84=EF=B8=8F?= Date: Sat, 27 Dec 2025 17:55:47 -0500 Subject: [PATCH] Add theme system for pre-made video styles (#69) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a comprehensive theme system for karaoke video styles: - Theme selection and customizable color overrides for karaoke jobs - Public Themes API for listing, previewing, and fetching theme details - Theme selector and color-overrides UI in job submission flows - CLI option to specify a theme when preparing/submitting jobs - Thread-safe singleton initialization for ThemeService 🤖 Generated with Claude Code --- backend/api/routes/file_upload.py | 219 +++++++-- backend/api/routes/themes.py | 162 +++++++ backend/main.py | 3 +- backend/models/job.py | 26 +- backend/models/theme.py | 153 ++++++ backend/services/theme_service.py | 469 +++++++++++++++++++ backend/tests/test_file_upload.py | 12 +- backend/tests/test_theme_service.py | 516 +++++++++++++++++++++ frontend/components/job/ColorOverrides.tsx | 190 ++++++++ frontend/components/job/JobSubmission.tsx | 66 ++- frontend/components/job/ThemeSelector.tsx | 133 ++++++ frontend/lib/api.ts | 80 +++- frontend/lib/video-themes.ts | 113 +++++ karaoke_gen/utils/cli_args.py | 10 +- karaoke_gen/utils/remote_cli.py | 39 +- pyproject.toml | 2 +- scripts/upload-theme.sh | 367 +++++++++++++++ 17 files changed, 2505 insertions(+), 55 deletions(-) create mode 100644 backend/api/routes/themes.py create mode 100644 backend/models/theme.py create mode 100644 backend/services/theme_service.py create mode 100644 backend/tests/test_theme_service.py create mode 100644 frontend/components/job/ColorOverrides.tsx create mode 100644 frontend/components/job/ThemeSelector.tsx create mode 100644 frontend/lib/video-themes.ts create mode 100755 scripts/upload-theme.sh diff --git a/backend/api/routes/file_upload.py b/backend/api/routes/file_upload.py index 3d3343cd..dbf25f95 100644 --- a/backend/api/routes/file_upload.py +++ b/backend/api/routes/file_upload.py @@ -22,10 +22,12 @@ from typing import Optional, List, Dict, Any, Tuple from pydantic import BaseModel, Field from backend.models.job import JobCreate, JobStatus +from backend.models.theme import ColorOverrides 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.theme_service import get_theme_service from backend.config import get_settings from backend.version import VERSION from backend.services.metrics import metrics @@ -51,14 +53,18 @@ class CreateJobFromUrlRequest(BaseModel): """Request to create a job from a YouTube/online URL.""" # Required fields url: str = Field(..., description="YouTube or other video URL to download audio from") - + # Optional fields - will be auto-detected from URL if not provided artist: Optional[str] = Field(None, description="Artist name (auto-detected from URL if not provided)") title: Optional[str] = Field(None, description="Song title (auto-detected from URL if not provided)") - - # Processing options (CDG/TXT require style config, disabled by default) - enable_cdg: bool = Field(False, description="Generate CDG+MP3 package (requires style config)") - enable_txt: bool = Field(False, description="Generate TXT+MP3 package (requires style config)") + + # Theme configuration (use pre-made theme from GCS) + theme_id: Optional[str] = Field(None, description="Theme ID to use (e.g., 'nomad', 'default'). If set, CDG/TXT are enabled by default.") + color_overrides: Optional[Dict[str, str]] = Field(None, description="Color overrides: artist_color, title_color, sung_lyrics_color, unsung_lyrics_color (hex #RRGGBB)") + + # Processing options (CDG/TXT require style config or theme, disabled by default unless theme is set) + enable_cdg: Optional[bool] = Field(None, description="Generate CDG+MP3 package. Default: True if theme_id set, False otherwise") + enable_txt: Optional[bool] = Field(None, description="Generate TXT+MP3 package. Default: True if theme_id set, False otherwise") # Finalisation options brand_prefix: Optional[str] = Field(None, description="Brand code prefix (e.g., NOMAD)") @@ -103,9 +109,13 @@ class CreateJobWithUploadUrlsRequest(BaseModel): title: str = Field(..., description="Song title") files: List[FileUploadRequest] = Field(..., description="List of files to upload") - # Processing options (CDG/TXT require style config, disabled by default) - enable_cdg: bool = Field(False, description="Generate CDG+MP3 package (requires style config)") - enable_txt: bool = Field(False, description="Generate TXT+MP3 package (requires style config)") + # Theme configuration (use pre-made theme from GCS) + theme_id: Optional[str] = Field(None, description="Theme ID to use (e.g., 'nomad', 'default'). If set, CDG/TXT are enabled by default.") + color_overrides: Optional[Dict[str, str]] = Field(None, description="Color overrides: artist_color, title_color, sung_lyrics_color, unsung_lyrics_color (hex #RRGGBB)") + + # Processing options (CDG/TXT require style config or theme, disabled by default unless theme is set) + enable_cdg: Optional[bool] = Field(None, description="Generate CDG+MP3 package. Default: True if theme_id set, False otherwise") + enable_txt: Optional[bool] = Field(None, description="Generate TXT+MP3 package. Default: True if theme_id set, False otherwise") # Finalisation options brand_prefix: Optional[str] = Field(None, description="Brand code prefix (e.g., NOMAD)") @@ -226,7 +236,7 @@ ALLOWED_FONT_EXTENSIONS = {'.ttf', '.otf', '.woff', '.woff2'} async def _trigger_workers_parallel(job_id: str) -> None: """ Trigger both audio and lyrics workers in parallel. - + FastAPI's BackgroundTasks runs async tasks sequentially, so we use asyncio.gather to ensure both workers start at the same time. """ @@ -236,6 +246,83 @@ async def _trigger_workers_parallel(job_id: str) -> None: ) +def _resolve_cdg_txt_defaults( + theme_id: Optional[str], + enable_cdg: Optional[bool], + enable_txt: Optional[bool] +) -> Tuple[bool, bool]: + """ + Resolve CDG/TXT settings based on theme and explicit settings. + + When a theme is selected, CDG and TXT are enabled by default. + Explicit True/False values always override the default. + + Args: + theme_id: Theme identifier (if any) + enable_cdg: Explicit CDG setting (None means use default) + enable_txt: Explicit TXT setting (None means use default) + + Returns: + Tuple of (resolved_enable_cdg, resolved_enable_txt) + """ + # Default based on whether theme is set + default_enabled = theme_id is not None + + # Resolve with explicit override taking precedence + resolved_cdg = enable_cdg if enable_cdg is not None else default_enabled + resolved_txt = enable_txt if enable_txt is not None else default_enabled + + return resolved_cdg, resolved_txt + + +def _prepare_theme_for_job( + job_id: str, + theme_id: str, + color_overrides: Optional[Dict[str, str]] = None +) -> Tuple[str, Dict[str, str], Optional[str]]: + """ + Prepare theme style files for a job. + + Args: + job_id: The job ID + theme_id: Theme identifier + color_overrides: Optional color override dict + + Returns: + Tuple of (style_params_gcs_path, style_assets, youtube_description) + + Raises: + HTTPException: If theme not found + """ + theme_service = get_theme_service() + + # Verify theme exists + if not theme_service.theme_exists(theme_id): + raise HTTPException( + status_code=400, + detail=f"Theme not found: {theme_id}. Use GET /api/themes to list available themes." + ) + + # Convert dict to ColorOverrides model if provided + color_overrides_model = None + if color_overrides: + color_overrides_model = ColorOverrides(**color_overrides) + + # Prepare job style from theme + style_params_path, style_assets = theme_service.prepare_job_style( + job_id=job_id, + theme_id=theme_id, + color_overrides=color_overrides_model + ) + + # Get YouTube description template if available + youtube_desc = theme_service.get_youtube_description(theme_id) + + logger.info(f"Prepared theme '{theme_id}' for job {job_id}") + + return style_params_path, style_assets, youtube_desc + + @router.post("/jobs/upload") async def upload_and_create_job( request: Request, @@ -682,9 +769,13 @@ class CreateFinaliseOnlyJobRequest(BaseModel): title: str = Field(..., description="Song title") files: List[FinaliseOnlyFileRequest] = Field(..., description="List of prep output files to upload") - # Processing options (CDG/TXT require style config, disabled by default) - enable_cdg: bool = Field(False, description="Generate CDG+MP3 package (requires style config)") - enable_txt: bool = Field(False, description="Generate TXT+MP3 package (requires style config)") + # Theme configuration (use pre-made theme from GCS) + theme_id: Optional[str] = Field(None, description="Theme ID to use (e.g., 'nomad', 'default'). If set, CDG/TXT are enabled by default.") + color_overrides: Optional[Dict[str, str]] = Field(None, description="Color overrides: artist_color, title_color, sung_lyrics_color, unsung_lyrics_color (hex #RRGGBB)") + + # Processing options (CDG/TXT require style config or theme, disabled by default unless theme is set) + enable_cdg: Optional[bool] = Field(None, description="Generate CDG+MP3 package. Default: True if theme_id set, False otherwise") + enable_txt: Optional[bool] = Field(None, description="Generate TXT+MP3 package. Default: True if theme_id set, False otherwise") # Finalisation options brand_prefix: Optional[str] = Field(None, description="Brand code prefix (e.g., NOMAD)") @@ -859,17 +950,27 @@ async def create_job_with_upload_urls( # Extract request metadata for tracking request_metadata = extract_request_metadata(request, created_from="signed_url_upload") - + # Get original audio filename audio_file = audio_files[0] - + + # Resolve CDG/TXT defaults based on theme + resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults( + body.theme_id, body.enable_cdg, body.enable_txt + ) + + # Check if style_params is being uploaded (overrides theme) + has_style_params_upload = any(f.file_type == 'style_params' for f in body.files) + # Create job job_create = JobCreate( artist=body.artist, title=body.title, filename=audio_file.filename, - enable_cdg=body.enable_cdg, - enable_txt=body.enable_txt, + theme_id=body.theme_id, + color_overrides=body.color_overrides or {}, + enable_cdg=resolved_cdg, + enable_txt=resolved_txt, brand_prefix=body.brand_prefix, enable_youtube_upload=body.enable_youtube_upload, youtube_description=body.youtube_description, @@ -889,11 +990,26 @@ async def create_job_with_upload_urls( ) job = job_manager.create_job(job_create) job_id = job.job_id - + # Record job creation metric metrics.record_job_created(job_id, source="upload") - + logger.info(f"Created job {job_id} for {body.artist} - {body.title} (signed URL upload flow)") + + # If theme is set and no style_params uploaded, prepare theme style now + if body.theme_id and not has_style_params_upload: + style_params_path, style_assets, youtube_desc = _prepare_theme_for_job( + job_id, body.theme_id, body.color_overrides + ) + # Update job with theme style data + update_data = { + 'style_params_gcs_path': style_params_path, + 'style_assets': style_assets, + } + if youtube_desc and not body.youtube_description: + update_data['youtube_description_template'] = youtube_desc + job_manager.update_job(job_id, update_data) + logger.info(f"Applied theme '{body.theme_id}' to job {job_id}") # Generate signed upload URLs for each file upload_urls = [] @@ -1245,19 +1361,26 @@ async def create_job_from_url( # Extract request metadata for tracking request_metadata = extract_request_metadata(request, created_from="url") - + # Use provided artist/title or leave as None (will be auto-detected by audio worker) artist = body.artist title = body.title - + + # Resolve CDG/TXT defaults based on theme + resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults( + body.theme_id, body.enable_cdg, body.enable_txt + ) + # Create job with URL job_create = JobCreate( url=body.url, artist=artist, title=title, filename=None, # No file uploaded - enable_cdg=body.enable_cdg, - enable_txt=body.enable_txt, + theme_id=body.theme_id, + color_overrides=body.color_overrides or {}, + enable_cdg=resolved_cdg, + enable_txt=resolved_txt, brand_prefix=body.brand_prefix, enable_youtube_upload=body.enable_youtube_upload, youtube_description=body.youtube_description, @@ -1277,9 +1400,24 @@ async def create_job_from_url( ) job = job_manager.create_job(job_create) job_id = job.job_id - + # Record job creation metric metrics.record_job_created(job_id, source="url") + + # If theme is set, prepare theme style now + if body.theme_id: + style_params_path, style_assets, youtube_desc = _prepare_theme_for_job( + job_id, body.theme_id, body.color_overrides + ) + # Update job with theme style data + update_data = { + 'style_params_gcs_path': style_params_path, + 'style_assets': style_assets, + } + if youtube_desc and not body.youtube_description: + update_data['youtube_description_template'] = youtube_desc + job_manager.update_job(job_id, update_data) + logger.info(f"Applied theme '{body.theme_id}' to job {job_id}") logger.info(f"Created URL-based job {job_id} for URL: {body.url}") if artist: @@ -1462,14 +1600,24 @@ async def create_finalise_only_job( # Extract request metadata request_metadata = extract_request_metadata(request, created_from="finalise_only_upload") - + + # Resolve CDG/TXT defaults based on theme + resolved_cdg, resolved_txt = _resolve_cdg_txt_defaults( + body.theme_id, body.enable_cdg, body.enable_txt + ) + + # Check if style_params is being uploaded (overrides theme) + has_style_params_upload = any(f.file_type == 'style_params' for f in body.files) + # 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, + theme_id=body.theme_id, + color_overrides=body.color_overrides or {}, + enable_cdg=resolved_cdg, + enable_txt=resolved_txt, brand_prefix=body.brand_prefix, enable_youtube_upload=body.enable_youtube_upload, youtube_description=body.youtube_description, @@ -1482,11 +1630,26 @@ async def create_finalise_only_job( ) job = job_manager.create_job(job_create) job_id = job.job_id - + # Record job creation metric metrics.record_job_created(job_id, source="finalise") - + logger.info(f"Created finalise-only job {job_id} for {body.artist} - {body.title}") + + # If theme is set and no style_params uploaded, prepare theme style now + if body.theme_id and not has_style_params_upload: + style_params_path, style_assets, youtube_desc = _prepare_theme_for_job( + job_id, body.theme_id, body.color_overrides + ) + # Update job with theme style data + update_data = { + 'style_params_gcs_path': style_params_path, + 'style_assets': style_assets, + } + if youtube_desc and not body.youtube_description: + update_data['youtube_description_template'] = youtube_desc + job_manager.update_job(job_id, update_data) + logger.info(f"Applied theme '{body.theme_id}' to job {job_id}") # Generate signed upload URLs for each file upload_urls = [] diff --git a/backend/api/routes/themes.py b/backend/api/routes/themes.py new file mode 100644 index 00000000..182dc72c --- /dev/null +++ b/backend/api/routes/themes.py @@ -0,0 +1,162 @@ +""" +Theme API routes for listing and retrieving theme information. + +Themes are pre-created style configurations that users can select when creating jobs. +These endpoints are public (no authentication required) to allow theme selection +before job creation. +""" + +import logging +from typing import Optional + +from fastapi import APIRouter, HTTPException + +from backend.models.theme import ThemeDetailResponse, ThemesListResponse +from backend.services.theme_service import get_theme_service + +logger = logging.getLogger(__name__) + +router = APIRouter(prefix="/themes", tags=["themes"]) + + +@router.get("", response_model=ThemesListResponse) +async def list_themes() -> ThemesListResponse: + """ + List all available themes. + + Returns a list of themes with their metadata and preview image URLs. + Preview URLs are signed and valid for 60 minutes. + + This endpoint is public and does not require authentication. + """ + try: + theme_service = get_theme_service() + themes = theme_service.list_themes() + return ThemesListResponse(themes=themes) + except Exception as e: + logger.error(f"Error listing themes: {e}") + raise HTTPException( + status_code=500, + detail="Failed to load themes" + ) + + +@router.get("/{theme_id}", response_model=ThemeDetailResponse) +async def get_theme(theme_id: str) -> ThemeDetailResponse: + """ + Get detailed information about a specific theme. + + Returns the full theme details including style parameters. + This can be used to preview theme settings or inspect configuration. + + Args: + theme_id: The unique identifier of the theme + + Returns: + ThemeDetailResponse with full theme details + + Raises: + 404: Theme not found + """ + try: + theme_service = get_theme_service() + theme = theme_service.get_theme(theme_id) + + if theme is None: + raise HTTPException( + status_code=404, + detail=f"Theme not found: {theme_id}" + ) + + return ThemeDetailResponse(theme=theme) + except HTTPException: + raise + except Exception as e: + logger.error(f"Error getting theme {theme_id}: {e}") + raise HTTPException( + status_code=500, + detail="Failed to load theme" + ) + + +@router.get("/{theme_id}/preview") +async def get_theme_preview(theme_id: str) -> dict: + """ + Get a signed URL for the theme's preview image. + + This endpoint is useful when you need just the preview URL + without loading the full theme details. + + Args: + theme_id: The unique identifier of the theme + + Returns: + Object with preview_url field + + Raises: + 404: Theme not found or no preview available + """ + try: + theme_service = get_theme_service() + + if not theme_service.theme_exists(theme_id): + raise HTTPException( + status_code=404, + detail=f"Theme not found: {theme_id}" + ) + + theme = theme_service.get_theme(theme_id) + if theme is None or theme.preview_url is None: + raise HTTPException( + status_code=404, + detail=f"No preview available for theme: {theme_id}" + ) + + return {"preview_url": theme.preview_url} + except HTTPException: + raise + except Exception as e: + logger.error(f"Error getting preview for theme {theme_id}: {e}") + raise HTTPException( + status_code=500, + detail="Failed to load theme preview" + ) + + +@router.get("/{theme_id}/youtube-description") +async def get_theme_youtube_description(theme_id: str) -> dict: + """ + Get the YouTube description template for a theme. + + Some themes include a default YouTube video description template + that can be used when uploading videos. + + Args: + theme_id: The unique identifier of the theme + + Returns: + Object with description field containing the template text, + or null if no template is available + + Raises: + 404: Theme not found + """ + try: + theme_service = get_theme_service() + + if not theme_service.theme_exists(theme_id): + raise HTTPException( + status_code=404, + detail=f"Theme not found: {theme_id}" + ) + + description = theme_service.get_youtube_description(theme_id) + return {"description": description} + except HTTPException: + raise + except Exception as e: + logger.error(f"Error getting YouTube description for theme {theme_id}: {e}") + raise HTTPException( + status_code=500, + detail="Failed to load YouTube description" + ) diff --git a/backend/main.py b/backend/main.py index cc7e6f89..5f10df3f 100644 --- a/backend/main.py +++ b/backend/main.py @@ -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, audio_search +from backend.api.routes import health, jobs, internal, file_upload, review, auth, audio_search, themes from backend.services.tracing import setup_tracing, instrument_app, get_current_trace_id from backend.services.structured_logging import setup_structured_logging @@ -108,6 +108,7 @@ 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.include_router(themes.router, prefix="/api") # Theme selection for styles @app.get("/") diff --git a/backend/models/job.py b/backend/models/job.py index fa9071e2..3be9e051 100644 --- a/backend/models/job.py +++ b/backend/models/job.py @@ -205,7 +205,18 @@ class Job(BaseModel): webhook_url: Optional[str] = None # Webhook for notifications user_email: Optional[str] = None # Email for notifications - # Style configuration (uploaded files) + # Theme configuration (pre-made themes from GCS) + theme_id: Optional[str] = None # Theme identifier (e.g., "nomad", "default") + color_overrides: Dict[str, str] = Field(default_factory=dict) + """ + User color overrides applied on top of theme. Keys: + - artist_color: Hex color for artist name (#RRGGBB) + - title_color: Hex color for song title + - sung_lyrics_color: Hex color for highlighted lyrics + - unsung_lyrics_color: Hex color for unhighlighted lyrics + """ + + # Style configuration (uploaded files - used when theme_id is not set) style_params_gcs_path: Optional[str] = None # GCS path to style_params.json style_assets: Dict[str, str] = Field(default_factory=dict) """ @@ -409,7 +420,18 @@ class JobCreate(BaseModel): webhook_url: Optional[str] = None user_email: Optional[str] = None - # Style configuration (will be populated after file upload) + # Theme configuration (pre-made themes from GCS) + theme_id: Optional[str] = None # Theme identifier (e.g., "nomad", "default") + color_overrides: Dict[str, str] = Field(default_factory=dict) + """ + User color overrides applied on top of theme. Keys: + - artist_color: Hex color for artist name (#RRGGBB) + - title_color: Hex color for song title + - sung_lyrics_color: Hex color for highlighted lyrics + - unsung_lyrics_color: Hex color for unhighlighted lyrics + """ + + # Style configuration (will be populated after file upload, or from theme) style_params_gcs_path: Optional[str] = None style_assets: Dict[str, str] = Field(default_factory=dict) diff --git a/backend/models/theme.py b/backend/models/theme.py new file mode 100644 index 00000000..0028a72d --- /dev/null +++ b/backend/models/theme.py @@ -0,0 +1,153 @@ +""" +Theme data models for karaoke-gen. + +Themes are pre-created style configurations stored in GCS that users can select +when creating karaoke jobs. Each theme includes: +- Style parameters (fonts, colors, backgrounds, layouts) +- Asset files (images, fonts) +- Preview images +- Optional YouTube description template +""" + +from datetime import datetime +from typing import Any, Dict, List, Optional + +from pydantic import BaseModel, Field + + +class ThemeSummary(BaseModel): + """Summary of a theme for listing purposes.""" + + id: str = Field(..., description="Unique theme identifier (e.g., 'nomad', 'default')") + name: str = Field(..., description="Human-readable theme name") + description: str = Field(..., description="Brief description of the theme style") + preview_url: Optional[str] = Field(None, description="Signed URL for preview image") + thumbnail_url: Optional[str] = Field(None, description="Signed URL for smaller thumbnail") + is_default: bool = Field(False, description="Whether this is the default theme") + + +class ThemeMetadata(BaseModel): + """Metadata for a single theme in the registry.""" + + id: str + name: str + description: str + is_default: bool = False + created_at: Optional[datetime] = None + + +class ThemeRegistry(BaseModel): + """Registry of all available themes, stored as _metadata.json in GCS.""" + + version: int = 1 + themes: List[ThemeMetadata] = Field(default_factory=list) + + +class ThemeDetail(BaseModel): + """Full theme details including style parameters.""" + + id: str + name: str + description: str + preview_url: Optional[str] = None + is_default: bool = False + style_params: Dict[str, Any] = Field(default_factory=dict) + has_youtube_description: bool = False + + +class ColorOverrides(BaseModel): + """ + User-customizable color overrides that can be applied on top of a theme. + + All colors are hex format (#RRGGBB). When applied: + - artist_color: Applied to intro.artist_color, end.artist_color, cdg.artist_color + - title_color: Applied to intro.title_color, end.title_color, cdg.title_color + - sung_lyrics_color: Applied to karaoke.primary_color (converted to RGBA), cdg.active_fill + - unsung_lyrics_color: Applied to karaoke.secondary_color (converted to RGBA), cdg.inactive_fill + """ + + artist_color: Optional[str] = Field( + None, + pattern=r"^#[0-9A-Fa-f]{6}$", + description="Hex color for artist name on intro/end screens", + ) + title_color: Optional[str] = Field( + None, + pattern=r"^#[0-9A-Fa-f]{6}$", + description="Hex color for song title on intro/end screens", + ) + sung_lyrics_color: Optional[str] = Field( + None, + pattern=r"^#[0-9A-Fa-f]{6}$", + description="Hex color for lyrics being sung (highlighted)", + ) + unsung_lyrics_color: Optional[str] = Field( + None, + pattern=r"^#[0-9A-Fa-f]{6}$", + description="Hex color for lyrics not yet sung", + ) + + def has_overrides(self) -> bool: + """Check if any color overrides are set.""" + return any( + [ + self.artist_color, + self.title_color, + self.sung_lyrics_color, + self.unsung_lyrics_color, + ] + ) + + def to_dict(self) -> Dict[str, str]: + """Convert to dict, excluding None values.""" + return {k: v for k, v in self.model_dump().items() if v is not None} + + +class ThemesListResponse(BaseModel): + """Response from GET /api/themes endpoint.""" + + themes: List[ThemeSummary] + + +class ThemeDetailResponse(BaseModel): + """Response from GET /api/themes/{theme_id} endpoint.""" + + theme: ThemeDetail + + +# Utility functions for color conversion + + +def hex_to_rgba(hex_color: str, alpha: int = 255) -> str: + """ + Convert hex color (#RRGGBB) to RGBA format for ASS subtitles. + + ASS subtitle format uses "R, G, B, A" string format. + + Args: + hex_color: Hex color string like "#7070F7" + alpha: Alpha value 0-255 (default 255 = opaque) + + Returns: + RGBA string like "112, 112, 247, 255" + """ + hex_color = hex_color.lstrip("#") + r = int(hex_color[0:2], 16) + g = int(hex_color[2:4], 16) + b = int(hex_color[4:6], 16) + return f"{r}, {g}, {b}, {alpha}" + + +def rgba_to_hex(rgba_str: str) -> str: + """ + Convert RGBA format to hex color. + + Args: + rgba_str: RGBA string like "112, 112, 247, 255" + + Returns: + Hex color string like "#7070F7" + """ + parts = [int(x.strip()) for x in rgba_str.split(",")] + r, g, b = parts[0], parts[1], parts[2] + return f"#{r:02x}{g:02x}{b:02x}" diff --git a/backend/services/theme_service.py b/backend/services/theme_service.py new file mode 100644 index 00000000..cf9fbafc --- /dev/null +++ b/backend/services/theme_service.py @@ -0,0 +1,469 @@ +""" +Theme service for managing pre-created style themes. + +Themes are stored in GCS at themes/{theme_id}/ with: +- style_params.json: Complete style configuration +- preview.png: Preview image for theme selection UI +- youtube_description.txt: Optional YouTube description template +- assets/: Fonts, backgrounds, and other assets + +The service provides: +- Theme listing with signed preview URLs +- Theme detail retrieval +- Color override application +- Job style preparation (copying theme to job folder) +""" + +import copy +import json +import logging +import os +import tempfile +import threading +from datetime import datetime, timedelta +from typing import Any, Dict, List, Optional, Tuple + +from backend.models.theme import ( + ColorOverrides, + ThemeDetail, + ThemeMetadata, + ThemeRegistry, + ThemeSummary, + hex_to_rgba, +) +from backend.services.storage_service import StorageService + +logger = logging.getLogger(__name__) + +# GCS paths for themes +THEMES_PREFIX = "themes" +METADATA_FILE = f"{THEMES_PREFIX}/_metadata.json" + + +class ThemeService: + """Service for managing themes from GCS.""" + + def __init__(self, storage: Optional[StorageService] = None): + """ + Initialize the theme service. + + Args: + storage: StorageService instance (creates new one if not provided) + """ + self.storage = storage or StorageService() + self._metadata_cache: Optional[ThemeRegistry] = None + self._cache_time: Optional[datetime] = None + self.CACHE_TTL_SECONDS = 300 # 5 minute cache for theme metadata + + def _get_theme_path(self, theme_id: str, filename: str = "") -> str: + """Get the GCS path for a theme file.""" + if filename: + return f"{THEMES_PREFIX}/{theme_id}/{filename}" + return f"{THEMES_PREFIX}/{theme_id}" + + def _is_cache_valid(self) -> bool: + """Check if the metadata cache is still valid.""" + if self._metadata_cache is None or self._cache_time is None: + return False + age = datetime.now() - self._cache_time + return age.total_seconds() < self.CACHE_TTL_SECONDS + + def _load_metadata(self, force_refresh: bool = False) -> ThemeRegistry: + """ + Load theme metadata from GCS with caching. + + Args: + force_refresh: Force reload from GCS even if cache is valid + + Returns: + ThemeRegistry containing all theme metadata + """ + if not force_refresh and self._is_cache_valid(): + return self._metadata_cache # type: ignore + + try: + data = self.storage.download_json(METADATA_FILE) + self._metadata_cache = ThemeRegistry(**data) + self._cache_time = datetime.now() + logger.info(f"Loaded theme metadata: {len(self._metadata_cache.themes)} themes") + return self._metadata_cache + except Exception as e: + logger.error(f"Failed to load theme metadata: {e}") + # Return empty registry on error + return ThemeRegistry(version=1, themes=[]) + + def list_themes(self) -> List[ThemeSummary]: + """ + List all available themes with signed preview URLs. + + Returns: + List of ThemeSummary objects with preview URLs + """ + metadata = self._load_metadata() + summaries = [] + + for theme in metadata.themes: + try: + # Generate signed URLs for preview images + preview_path = self._get_theme_path(theme.id, "preview.png") + thumbnail_path = self._get_theme_path(theme.id, "preview_thumbnail.png") + + preview_url = None + thumbnail_url = None + + if self.storage.file_exists(preview_path): + preview_url = self.storage.generate_signed_url(preview_path, expiration_minutes=60) + + # Try thumbnail, fall back to main preview + if self.storage.file_exists(thumbnail_path): + thumbnail_url = self.storage.generate_signed_url(thumbnail_path, expiration_minutes=60) + elif preview_url: + thumbnail_url = preview_url + + summaries.append( + ThemeSummary( + id=theme.id, + name=theme.name, + description=theme.description, + preview_url=preview_url, + thumbnail_url=thumbnail_url, + is_default=theme.is_default, + ) + ) + except Exception as e: + logger.warning(f"Error processing theme {theme.id}: {e}") + # Still include theme but without preview URLs + summaries.append( + ThemeSummary( + id=theme.id, + name=theme.name, + description=theme.description, + is_default=theme.is_default, + ) + ) + + return summaries + + def get_theme(self, theme_id: str) -> Optional[ThemeDetail]: + """ + Get full theme details including style parameters. + + Args: + theme_id: The theme identifier + + Returns: + ThemeDetail if found, None otherwise + """ + metadata = self._load_metadata() + + # Find theme in metadata + theme_meta = next((t for t in metadata.themes if t.id == theme_id), None) + if not theme_meta: + logger.warning(f"Theme not found: {theme_id}") + return None + + try: + # Load style_params.json + style_params_path = self._get_theme_path(theme_id, "style_params.json") + style_params = self.storage.download_json(style_params_path) + + # Check for YouTube description + youtube_desc_path = self._get_theme_path(theme_id, "youtube_description.txt") + has_youtube_desc = self.storage.file_exists(youtube_desc_path) + + # Generate preview URL + preview_path = self._get_theme_path(theme_id, "preview.png") + preview_url = None + if self.storage.file_exists(preview_path): + preview_url = self.storage.generate_signed_url(preview_path, expiration_minutes=60) + + return ThemeDetail( + id=theme_id, + name=theme_meta.name, + description=theme_meta.description, + preview_url=preview_url, + is_default=theme_meta.is_default, + style_params=style_params, + has_youtube_description=has_youtube_desc, + ) + except Exception as e: + logger.error(f"Error loading theme {theme_id}: {e}") + return None + + def get_theme_style_params(self, theme_id: str) -> Optional[Dict[str, Any]]: + """ + Get just the style_params.json for a theme. + + Args: + theme_id: The theme identifier + + Returns: + Style parameters dict if found, None otherwise + """ + try: + style_params_path = self._get_theme_path(theme_id, "style_params.json") + return self.storage.download_json(style_params_path) + except Exception as e: + logger.error(f"Error loading style params for theme {theme_id}: {e}") + return None + + def get_youtube_description(self, theme_id: str) -> Optional[str]: + """ + Get the YouTube description template for a theme. + + Args: + theme_id: The theme identifier + + Returns: + YouTube description text if found, None otherwise + """ + try: + youtube_desc_path = self._get_theme_path(theme_id, "youtube_description.txt") + if not self.storage.file_exists(youtube_desc_path): + return None + + # Download to temp file and read + with tempfile.NamedTemporaryFile(mode="w", delete=False, suffix=".txt") as tmp: + tmp_path = tmp.name + + try: + self.storage.download_file(youtube_desc_path, tmp_path) + with open(tmp_path, "r") as f: + return f.read() + finally: + if os.path.exists(tmp_path): + os.remove(tmp_path) + except Exception as e: + logger.error(f"Error loading YouTube description for theme {theme_id}: {e}") + return None + + def apply_color_overrides( + self, style_params: Dict[str, Any], overrides: ColorOverrides + ) -> Dict[str, Any]: + """ + Apply user color overrides to theme style parameters. + + Args: + style_params: Base style parameters from theme + overrides: User color overrides + + Returns: + Modified style parameters with overrides applied + """ + if not overrides.has_overrides(): + return style_params + + # Deep copy to avoid modifying original + result = copy.deepcopy(style_params) + + # Apply artist_color to intro, end, and CDG sections + if overrides.artist_color: + if "intro" in result: + result["intro"]["artist_color"] = overrides.artist_color + if "end" in result: + result["end"]["artist_color"] = overrides.artist_color + if "cdg" in result: + result["cdg"]["artist_color"] = overrides.artist_color + + # Apply title_color to intro, end, and CDG sections + if overrides.title_color: + if "intro" in result: + result["intro"]["title_color"] = overrides.title_color + if "end" in result: + result["end"]["title_color"] = overrides.title_color + if "cdg" in result: + result["cdg"]["title_color"] = overrides.title_color + + # Apply sung_lyrics_color (karaoke uses RGBA, CDG uses hex) + if overrides.sung_lyrics_color: + if "karaoke" in result: + result["karaoke"]["primary_color"] = hex_to_rgba(overrides.sung_lyrics_color) + if "cdg" in result: + result["cdg"]["active_fill"] = overrides.sung_lyrics_color + + # Apply unsung_lyrics_color (karaoke uses RGBA, CDG uses hex) + if overrides.unsung_lyrics_color: + if "karaoke" in result: + result["karaoke"]["secondary_color"] = hex_to_rgba(overrides.unsung_lyrics_color) + if "cdg" in result: + result["cdg"]["inactive_fill"] = overrides.unsung_lyrics_color + + return result + + def prepare_job_style( + self, + job_id: str, + theme_id: str, + color_overrides: Optional[ColorOverrides] = None, + ) -> Tuple[str, Dict[str, str]]: + """ + Prepare style files for a job by copying theme to job folder. + + This method: + 1. Loads the theme's style_params.json + 2. Applies any color overrides + 3. Updates asset paths to point to theme assets (shared, not copied) + 4. Uploads modified style_params.json to job folder + 5. Returns the GCS path and style_assets mapping + + Args: + job_id: The job ID + theme_id: The theme to use + color_overrides: Optional color overrides + + Returns: + Tuple of (style_params_gcs_path, style_assets dict) + + Raises: + ValueError: If theme not found + """ + # Load theme style params + style_params = self.get_theme_style_params(theme_id) + if style_params is None: + raise ValueError(f"Theme not found: {theme_id}") + + # Apply color overrides if provided + if color_overrides: + style_params = self.apply_color_overrides(style_params, color_overrides) + + # Update asset paths to point to theme's shared assets + # Theme assets stay in themes/{theme_id}/assets/ - they're shared + style_assets = self._build_style_assets_mapping(theme_id, style_params) + + # Update style_params to use theme asset paths (not job-specific) + style_params = self._update_asset_paths_in_style(theme_id, style_params) + + # Upload modified style_params.json to job's style folder + job_style_path = f"uploads/{job_id}/style/style_params.json" + self.storage.upload_json(job_style_path, style_params) + + logger.info(f"Prepared job {job_id} style from theme {theme_id}") + + return job_style_path, style_assets + + def _build_style_assets_mapping( + self, theme_id: str, style_params: Dict[str, Any] + ) -> Dict[str, str]: + """ + Build the style_assets mapping for a theme. + + Maps asset keys to their GCS paths in the theme folder. + """ + style_assets = {} + theme_assets_prefix = f"{THEMES_PREFIX}/{theme_id}/assets" + + # Check each potential asset type + asset_checks = [ + ("intro_background", "intro", "background_image"), + ("karaoke_background", "karaoke", "background_image"), + ("end_background", "end", "background_image"), + ("font", "intro", "font"), # Font is typically shared across sections + ("cdg_instrumental_background", "cdg", "instrumental_background"), + ("cdg_title_background", "cdg", "title_screen_background"), + ("cdg_outro_background", "cdg", "outro_background"), + ] + + for asset_key, section, field in asset_checks: + if section in style_params and field in style_params[section]: + value = style_params[section][field] + if value and isinstance(value, str): + # Check if it's a theme asset path or already has the full path + if value.startswith(f"{THEMES_PREFIX}/"): + # Already a full theme path + style_assets[asset_key] = value + elif not value.startswith("/") and not value.startswith("gs://"): + # Relative path - prepend theme assets prefix + asset_path = f"{theme_assets_prefix}/{os.path.basename(value)}" + if self.storage.file_exists(asset_path): + style_assets[asset_key] = asset_path + + return style_assets + + def _update_asset_paths_in_style( + self, theme_id: str, style_params: Dict[str, Any] + ) -> Dict[str, Any]: + """ + Update asset paths in style_params to use full GCS theme paths. + + This ensures the style_loader can find assets when processing. + """ + result = copy.deepcopy(style_params) + theme_assets_prefix = f"{THEMES_PREFIX}/{theme_id}/assets" + + # Fields that contain asset paths + path_fields = { + "intro": ["background_image", "font"], + "end": ["background_image", "font"], + "karaoke": ["background_image", "font_path"], + "cdg": [ + "font_path", + "instrumental_background", + "title_screen_background", + "outro_background", + ], + } + + for section, fields in path_fields.items(): + if section not in result: + continue + for field in fields: + if field not in result[section]: + continue + value = result[section][field] + if value and isinstance(value, str): + # Skip if already a full path or URL + if value.startswith(f"{THEMES_PREFIX}/") or value.startswith("gs://"): + continue + # Skip absolute local paths (shouldn't happen but be safe) + if value.startswith("/"): + continue + # Update to full theme asset path + result[section][field] = f"{theme_assets_prefix}/{os.path.basename(value)}" + + return result + + def theme_exists(self, theme_id: str) -> bool: + """ + Check if a theme exists. + + Args: + theme_id: The theme identifier + + Returns: + True if theme exists, False otherwise + """ + metadata = self._load_metadata() + return any(t.id == theme_id for t in metadata.themes) + + def get_default_theme_id(self) -> Optional[str]: + """ + Get the ID of the default theme. + + Returns: + Default theme ID if one exists, None otherwise + """ + metadata = self._load_metadata() + default_theme = next((t for t in metadata.themes if t.is_default), None) + return default_theme.id if default_theme else None + + def invalidate_cache(self) -> None: + """Force invalidation of the metadata cache.""" + self._metadata_cache = None + self._cache_time = None + logger.info("Theme metadata cache invalidated") + + +# Singleton instance with thread-safe initialization +_theme_service: Optional[ThemeService] = None +_theme_service_lock = threading.Lock() + + +def get_theme_service() -> ThemeService: + """Get or create the singleton ThemeService instance (thread-safe).""" + global _theme_service + if _theme_service is None: + with _theme_service_lock: + # Double-check after acquiring lock + if _theme_service is None: + _theme_service = ThemeService() + return _theme_service diff --git a/backend/tests/test_file_upload.py b/backend/tests/test_file_upload.py index 135a5350..5a1c043d 100644 --- a/backend/tests/test_file_upload.py +++ b/backend/tests/test_file_upload.py @@ -1123,9 +1123,9 @@ class TestFinaliseOnlyModels: ] ) - # CDG/TXT disabled by default (requires style config) - assert request.enable_cdg is False - assert request.enable_txt is False + # CDG/TXT default to None (server resolves based on theme_id) + assert request.enable_cdg is None + assert request.enable_txt is None assert request.brand_prefix is None assert request.keep_brand_code is None assert request.enable_youtube_upload is False @@ -1275,9 +1275,9 @@ class TestCreateJobFromUrlRequest: assert request.url == "https://www.youtube.com/watch?v=dQw4w9WgXcQ" assert request.artist is None assert request.title is None - # CDG/TXT disabled by default (requires style config) - assert request.enable_cdg is False - assert request.enable_txt is False + # CDG/TXT default to None (server resolves based on theme_id) + assert request.enable_cdg is None + assert request.enable_txt is None def test_create_with_artist_and_title(self): """Test creating request with URL, artist, and title.""" diff --git a/backend/tests/test_theme_service.py b/backend/tests/test_theme_service.py new file mode 100644 index 00000000..fa53c726 --- /dev/null +++ b/backend/tests/test_theme_service.py @@ -0,0 +1,516 @@ +""" +Tests for the theme service and API endpoints. + +Tests theme listing, retrieval, color override application, and job style preparation. +""" +import json +import pytest +from unittest.mock import MagicMock, patch, Mock +from datetime import datetime + +from backend.models.theme import ( + ThemeSummary, + ThemeDetail, + ThemeMetadata, + ThemeRegistry, + ColorOverrides, + hex_to_rgba, + rgba_to_hex, +) +from backend.services.theme_service import ThemeService, get_theme_service + + +# ============================================================================= +# Color Conversion Tests +# ============================================================================= + +class TestColorConversion: + """Tests for hex/rgba color conversion utilities.""" + + def test_hex_to_rgba_basic(self): + """Test basic hex to RGBA conversion.""" + result = hex_to_rgba("#7070F7") + assert result == "112, 112, 247, 255" + + def test_hex_to_rgba_with_custom_alpha(self): + """Test hex to RGBA with custom alpha.""" + result = hex_to_rgba("#FF0000", alpha=128) + assert result == "255, 0, 0, 128" + + def test_hex_to_rgba_lowercase(self): + """Test hex with lowercase letters.""" + result = hex_to_rgba("#abcdef") + assert result == "171, 205, 239, 255" + + def test_hex_to_rgba_without_hash(self): + """Test hex without leading hash.""" + result = hex_to_rgba("FFFFFF") + assert result == "255, 255, 255, 255" + + def test_rgba_to_hex_basic(self): + """Test basic RGBA to hex conversion.""" + result = rgba_to_hex("112, 112, 247, 255") + assert result == "#7070f7" + + def test_rgba_to_hex_ignores_alpha(self): + """Test that alpha is ignored in conversion.""" + result = rgba_to_hex("255, 0, 0, 128") + assert result == "#ff0000" + + +# ============================================================================= +# ColorOverrides Model Tests +# ============================================================================= + +class TestColorOverrides: + """Tests for ColorOverrides model.""" + + def test_has_overrides_empty(self): + """Test has_overrides with no overrides set.""" + overrides = ColorOverrides() + assert overrides.has_overrides() is False + + def test_has_overrides_with_artist_color(self): + """Test has_overrides with artist_color set.""" + overrides = ColorOverrides(artist_color="#FF0000") + assert overrides.has_overrides() is True + + def test_has_overrides_with_all_colors(self): + """Test has_overrides with all colors set.""" + overrides = ColorOverrides( + artist_color="#FF0000", + title_color="#00FF00", + sung_lyrics_color="#0000FF", + unsung_lyrics_color="#FFFF00", + ) + assert overrides.has_overrides() is True + + def test_to_dict_excludes_none(self): + """Test to_dict excludes None values.""" + overrides = ColorOverrides(artist_color="#FF0000") + result = overrides.to_dict() + assert result == {"artist_color": "#FF0000"} + assert "title_color" not in result + + def test_color_validation_valid(self): + """Test color validation accepts valid hex colors.""" + overrides = ColorOverrides(artist_color="#AbCdEf") + assert overrides.artist_color == "#AbCdEf" + + def test_color_validation_invalid(self): + """Test color validation rejects invalid colors.""" + with pytest.raises(ValueError): + ColorOverrides(artist_color="red") + + with pytest.raises(ValueError): + ColorOverrides(artist_color="#GGG") + + +# ============================================================================= +# ThemeService Tests +# ============================================================================= + +class TestThemeService: + """Tests for ThemeService.""" + + @pytest.fixture + def mock_storage(self): + """Create a mock storage service.""" + storage = MagicMock() + return storage + + @pytest.fixture + def sample_metadata(self): + """Sample theme metadata for testing.""" + return { + "version": 1, + "themes": [ + { + "id": "nomad", + "name": "Nomad Karaoke", + "description": "Golden artist text, professional look", + "is_default": True, + }, + { + "id": "default", + "name": "Default", + "description": "Clean white text on black background", + "is_default": False, + }, + ], + } + + @pytest.fixture + def sample_style_params(self): + """Sample style params for testing.""" + return { + "intro": { + "artist_color": "#ffdf6b", + "title_color": "#ffffff", + "background_image": "intro_bg.png", + "font": "Montserrat-Bold.ttf", + }, + "end": { + "artist_color": "#ffdf6b", + "title_color": "#ffffff", + "background_image": "end_bg.png", + "font": "Montserrat-Bold.ttf", + }, + "karaoke": { + "primary_color": "112, 112, 247, 255", + "secondary_color": "255, 255, 255, 255", + "background_image": "karaoke_bg.png", + "font_path": "Montserrat-Bold.ttf", + }, + "cdg": { + "active_fill": "#7070F7", + "inactive_fill": "#FFFFFF", + "font_path": "Montserrat-Bold.ttf", + }, + } + + def test_list_themes_returns_summaries(self, mock_storage, sample_metadata): + """Test list_themes returns ThemeSummary objects.""" + mock_storage.download_json.return_value = sample_metadata + mock_storage.file_exists.return_value = True + mock_storage.generate_signed_url.return_value = "https://signed-url.com/preview.png" + + service = ThemeService(storage=mock_storage) + themes = service.list_themes() + + assert len(themes) == 2 + assert themes[0].id == "nomad" + assert themes[0].name == "Nomad Karaoke" + assert themes[0].is_default is True + assert themes[0].preview_url is not None + + def test_list_themes_handles_missing_preview(self, mock_storage, sample_metadata): + """Test list_themes handles missing preview images gracefully.""" + mock_storage.download_json.return_value = sample_metadata + mock_storage.file_exists.return_value = False + + service = ThemeService(storage=mock_storage) + themes = service.list_themes() + + assert len(themes) == 2 + assert themes[0].preview_url is None + + def test_get_theme_returns_detail(self, mock_storage, sample_metadata, sample_style_params): + """Test get_theme returns ThemeDetail with style params.""" + mock_storage.download_json.side_effect = [sample_metadata, sample_style_params] + mock_storage.file_exists.return_value = True + mock_storage.generate_signed_url.return_value = "https://signed-url.com/preview.png" + + service = ThemeService(storage=mock_storage) + theme = service.get_theme("nomad") + + assert theme is not None + assert theme.id == "nomad" + assert theme.name == "Nomad Karaoke" + assert "intro" in theme.style_params + assert theme.style_params["intro"]["artist_color"] == "#ffdf6b" + + def test_get_theme_returns_none_for_unknown(self, mock_storage, sample_metadata): + """Test get_theme returns None for unknown theme ID.""" + mock_storage.download_json.return_value = sample_metadata + + service = ThemeService(storage=mock_storage) + theme = service.get_theme("unknown-theme") + + assert theme is None + + def test_theme_exists_true(self, mock_storage, sample_metadata): + """Test theme_exists returns True for existing theme.""" + mock_storage.download_json.return_value = sample_metadata + + service = ThemeService(storage=mock_storage) + assert service.theme_exists("nomad") is True + + def test_theme_exists_false(self, mock_storage, sample_metadata): + """Test theme_exists returns False for unknown theme.""" + mock_storage.download_json.return_value = sample_metadata + + service = ThemeService(storage=mock_storage) + assert service.theme_exists("unknown") is False + + def test_get_default_theme_id(self, mock_storage, sample_metadata): + """Test get_default_theme_id returns the default theme.""" + mock_storage.download_json.return_value = sample_metadata + + service = ThemeService(storage=mock_storage) + assert service.get_default_theme_id() == "nomad" + + def test_get_default_theme_id_no_default(self, mock_storage): + """Test get_default_theme_id returns None when no default.""" + mock_storage.download_json.return_value = { + "version": 1, + "themes": [{"id": "test", "name": "Test", "description": "Test", "is_default": False}], + } + + service = ThemeService(storage=mock_storage) + assert service.get_default_theme_id() is None + + def test_apply_color_overrides_no_changes(self, sample_style_params): + """Test apply_color_overrides with empty overrides.""" + service = ThemeService() + overrides = ColorOverrides() + + result = service.apply_color_overrides(sample_style_params, overrides) + + # Should return original (no deep copy needed when no changes) + assert result == sample_style_params + + def test_apply_color_overrides_artist_color(self, sample_style_params): + """Test apply_color_overrides applies artist_color.""" + service = ThemeService() + overrides = ColorOverrides(artist_color="#FF0000") + + result = service.apply_color_overrides(sample_style_params, overrides) + + assert result["intro"]["artist_color"] == "#FF0000" + assert result["end"]["artist_color"] == "#FF0000" + assert result["cdg"]["artist_color"] == "#FF0000" + # Original should be unchanged + assert sample_style_params["intro"]["artist_color"] == "#ffdf6b" + + def test_apply_color_overrides_sung_lyrics_color(self, sample_style_params): + """Test apply_color_overrides applies sung_lyrics_color with conversion.""" + service = ThemeService() + overrides = ColorOverrides(sung_lyrics_color="#FF0000") + + result = service.apply_color_overrides(sample_style_params, overrides) + + # Karaoke uses RGBA format + assert result["karaoke"]["primary_color"] == "255, 0, 0, 255" + # CDG uses hex + assert result["cdg"]["active_fill"] == "#FF0000" + + def test_apply_color_overrides_unsung_lyrics_color(self, sample_style_params): + """Test apply_color_overrides applies unsung_lyrics_color.""" + service = ThemeService() + overrides = ColorOverrides(unsung_lyrics_color="#00FF00") + + result = service.apply_color_overrides(sample_style_params, overrides) + + assert result["karaoke"]["secondary_color"] == "0, 255, 0, 255" + assert result["cdg"]["inactive_fill"] == "#00FF00" + + def test_metadata_cache(self, mock_storage, sample_metadata): + """Test metadata caching works.""" + mock_storage.download_json.return_value = sample_metadata + + service = ThemeService(storage=mock_storage) + + # First call loads from GCS + service.list_themes() + assert mock_storage.download_json.call_count == 1 + + # Second call uses cache + service.list_themes() + assert mock_storage.download_json.call_count == 1 + + def test_invalidate_cache(self, mock_storage, sample_metadata): + """Test cache invalidation.""" + mock_storage.download_json.return_value = sample_metadata + + service = ThemeService(storage=mock_storage) + + # Load metadata + service.list_themes() + assert mock_storage.download_json.call_count == 1 + + # Invalidate cache + service.invalidate_cache() + + # Next call should reload + service.list_themes() + assert mock_storage.download_json.call_count == 2 + + def test_prepare_job_style(self, mock_storage, sample_metadata, sample_style_params): + """Test prepare_job_style creates job style from theme.""" + mock_storage.download_json.side_effect = [sample_metadata, sample_style_params] + mock_storage.file_exists.return_value = True + + service = ThemeService(storage=mock_storage) + style_path, style_assets = service.prepare_job_style("job123", "nomad") + + # Should upload modified style_params.json + mock_storage.upload_json.assert_called_once() + assert style_path == "uploads/job123/style/style_params.json" + + def test_prepare_job_style_with_overrides(self, mock_storage, sample_metadata, sample_style_params): + """Test prepare_job_style applies color overrides.""" + # prepare_job_style calls get_theme_style_params which directly downloads style_params.json + # No metadata lookup happens unless we've cached it previously + mock_storage.download_json.return_value = sample_style_params + mock_storage.file_exists.return_value = True + + service = ThemeService(storage=mock_storage) + overrides = ColorOverrides(artist_color="#FF0000") + + style_path, style_assets = service.prepare_job_style("job123", "nomad", overrides) + + # Check that upload_json was called with modified style params + call_args = mock_storage.upload_json.call_args + uploaded_path = call_args[0][0] # First positional arg is the path + uploaded_style = call_args[0][1] # Second positional arg is the data + + assert uploaded_path == "uploads/job123/style/style_params.json" + # Check that artist_color override was applied + assert uploaded_style["intro"]["artist_color"] == "#FF0000" + assert uploaded_style["end"]["artist_color"] == "#FF0000" + + def test_prepare_job_style_unknown_theme_raises(self, mock_storage, sample_metadata): + """Test prepare_job_style raises for unknown theme.""" + # First download_json returns metadata (no unknown theme) + # Second download_json for style_params.json should fail + def download_json_side_effect(path): + if "_metadata.json" in path: + return sample_metadata + # Unknown theme path - raise exception + raise Exception(f"File not found: {path}") + + mock_storage.download_json.side_effect = download_json_side_effect + + service = ThemeService(storage=mock_storage) + + with pytest.raises(ValueError, match="Theme not found"): + service.prepare_job_style("job123", "unknown-theme") + + def test_get_youtube_description(self, mock_storage, sample_metadata): + """Test get_youtube_description returns template text.""" + mock_storage.download_json.return_value = sample_metadata + mock_storage.file_exists.return_value = True + + # Mock the download_file to write content to temp file + def mock_download(gcs_path, local_path): + with open(local_path, "w") as f: + f.write("Thank you for watching!") + + mock_storage.download_file.side_effect = mock_download + + service = ThemeService(storage=mock_storage) + desc = service.get_youtube_description("nomad") + + assert desc == "Thank you for watching!" + + def test_get_youtube_description_not_found(self, mock_storage, sample_metadata): + """Test get_youtube_description returns None when no template.""" + mock_storage.download_json.return_value = sample_metadata + mock_storage.file_exists.return_value = False + + service = ThemeService(storage=mock_storage) + desc = service.get_youtube_description("nomad") + + assert desc is None + + +# ============================================================================= +# API Endpoint Tests +# ============================================================================= + +class TestThemeAPI: + """Tests for theme API endpoints.""" + + @pytest.fixture + def sample_metadata(self): + """Sample theme metadata.""" + return { + "version": 1, + "themes": [ + { + "id": "nomad", + "name": "Nomad Karaoke", + "description": "Golden artist text", + "is_default": True, + } + ], + } + + def test_list_themes_endpoint(self, test_client, sample_metadata): + """Test GET /api/themes returns theme list.""" + with patch("backend.api.routes.themes.get_theme_service") as mock_get_service: + mock_service = MagicMock() + mock_service.list_themes.return_value = [ + ThemeSummary( + id="nomad", + name="Nomad Karaoke", + description="Golden artist text", + preview_url="https://example.com/preview.png", + is_default=True, + ) + ] + mock_get_service.return_value = mock_service + + response = test_client.get("/api/themes") + + assert response.status_code == 200 + data = response.json() + assert len(data["themes"]) == 1 + assert data["themes"][0]["id"] == "nomad" + assert data["themes"][0]["is_default"] is True + + def test_get_theme_endpoint(self, test_client): + """Test GET /api/themes/{theme_id} returns theme detail.""" + with patch("backend.api.routes.themes.get_theme_service") as mock_get_service: + mock_service = MagicMock() + mock_service.get_theme.return_value = ThemeDetail( + id="nomad", + name="Nomad Karaoke", + description="Golden artist text", + is_default=True, + style_params={"intro": {"artist_color": "#ffdf6b"}}, + ) + mock_get_service.return_value = mock_service + + response = test_client.get("/api/themes/nomad") + + assert response.status_code == 200 + data = response.json() + assert data["theme"]["id"] == "nomad" + assert "style_params" in data["theme"] + + def test_get_theme_not_found(self, test_client): + """Test GET /api/themes/{theme_id} returns 404 for unknown theme.""" + with patch("backend.api.routes.themes.get_theme_service") as mock_get_service: + mock_service = MagicMock() + mock_service.get_theme.return_value = None + mock_get_service.return_value = mock_service + + response = test_client.get("/api/themes/unknown") + + assert response.status_code == 404 + + def test_get_theme_preview_endpoint(self, test_client): + """Test GET /api/themes/{theme_id}/preview returns preview URL.""" + with patch("backend.api.routes.themes.get_theme_service") as mock_get_service: + mock_service = MagicMock() + mock_service.theme_exists.return_value = True + mock_service.get_theme.return_value = ThemeDetail( + id="nomad", + name="Nomad Karaoke", + description="Golden artist text", + preview_url="https://example.com/preview.png", + is_default=True, + ) + mock_get_service.return_value = mock_service + + response = test_client.get("/api/themes/nomad/preview") + + assert response.status_code == 200 + data = response.json() + assert "preview_url" in data + + def test_get_youtube_description_endpoint(self, test_client): + """Test GET /api/themes/{theme_id}/youtube-description returns description.""" + with patch("backend.api.routes.themes.get_theme_service") as mock_get_service: + mock_service = MagicMock() + mock_service.theme_exists.return_value = True + mock_service.get_youtube_description.return_value = "Thank you for watching!" + mock_get_service.return_value = mock_service + + response = test_client.get("/api/themes/nomad/youtube-description") + + assert response.status_code == 200 + data = response.json() + assert data["description"] == "Thank you for watching!" diff --git a/frontend/components/job/ColorOverrides.tsx b/frontend/components/job/ColorOverrides.tsx new file mode 100644 index 00000000..ed3afbd6 --- /dev/null +++ b/frontend/components/job/ColorOverrides.tsx @@ -0,0 +1,190 @@ +"use client" + +import { useState } from "react" +import type { ColorOverrides } from "@/lib/video-themes" +import { Label } from "@/components/ui/label" +import { Input } from "@/components/ui/input" +import { Button } from "@/components/ui/button" +import { + Collapsible, + CollapsibleContent, + CollapsibleTrigger, +} from "@/components/ui/collapsible" +import { ChevronDown, ChevronUp, Paintbrush, RotateCcw } from "lucide-react" + +interface ColorOverridesProps { + value: ColorOverrides + onChange: (overrides: ColorOverrides) => void + disabled?: boolean +} + +interface ColorFieldProps { + id: string + label: string + description: string + value?: string + onChange: (value: string | undefined) => void + disabled?: boolean +} + +function ColorField({ id, label, description, value, onChange, disabled }: ColorFieldProps) { + return ( +
+
+ + {value && ( + + )} +
+
+
+ { + const val = e.target.value.trim() + if (val === "") { + onChange(undefined) + } else if (/^#[0-9A-Fa-f]{0,6}$/.test(val)) { + onChange(val) + } + }} + disabled={disabled} + className="bg-slate-800 border-slate-700 text-white placeholder:text-slate-500 font-mono text-sm" + /> + onChange(e.target.value)} + disabled={disabled} + className="w-10 h-8 p-0 border-0 bg-transparent cursor-pointer" + /> +
+

{description}

+
+ ) +} + +export function ColorOverridesPanel({ value, onChange, disabled }: ColorOverridesProps) { + const [isOpen, setIsOpen] = useState(false) + + const hasAnyOverrides = !!( + value.artist_color || + value.title_color || + value.sung_lyrics_color || + value.unsung_lyrics_color + ) + + function handleResetAll() { + onChange({}) + } + + function updateField(field: keyof ColorOverrides, newValue: string | undefined) { + onChange({ + ...value, + [field]: newValue, + }) + } + + return ( + + + + + + +
+
+

+ Override theme colors (optional) +

+ {hasAnyOverrides && ( + + )} +
+ +
+ updateField("artist_color", v)} + disabled={disabled} + /> + + updateField("title_color", v)} + disabled={disabled} + /> + + updateField("sung_lyrics_color", v)} + disabled={disabled} + /> + + updateField("unsung_lyrics_color", v)} + disabled={disabled} + /> +
+
+
+
+ ) +} diff --git a/frontend/components/job/JobSubmission.tsx b/frontend/components/job/JobSubmission.tsx index 54a852f5..14856694 100644 --- a/frontend/components/job/JobSubmission.tsx +++ b/frontend/components/job/JobSubmission.tsx @@ -2,10 +2,14 @@ import { useState } from "react" import { api, ApiError } from "@/lib/api" +import type { ColorOverrides } from "@/lib/video-themes" +import { cleanColorOverrides } from "@/lib/video-themes" import { Button } from "@/components/ui/button" import { Input } from "@/components/ui/input" import { Label } from "@/components/ui/label" import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs" +import { ThemeSelector } from "./ThemeSelector" +import { ColorOverridesPanel } from "./ColorOverrides" import { Upload, Youtube, Music, Loader2 } from "lucide-react" interface JobSubmissionProps { @@ -31,6 +35,10 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) { const [searchArtist, setSearchArtist] = useState("") const [searchTitle, setSearchTitle] = useState("") + // Theme selection (shared across all tabs) + const [selectedTheme, setSelectedTheme] = useState() + const [colorOverrides, setColorOverrides] = useState({}) + async function handleUploadSubmit(e: React.FormEvent) { e.preventDefault() setError("") @@ -46,7 +54,10 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) { setIsSubmitting(true) try { - await api.uploadJob(uploadFile, uploadArtist.trim(), uploadTitle.trim()) + await api.uploadJob(uploadFile, uploadArtist.trim(), uploadTitle.trim(), { + theme_id: selectedTheme, + color_overrides: cleanColorOverrides(colorOverrides), + }) setUploadFile(null) setUploadArtist("") setUploadTitle("") @@ -76,7 +87,11 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) { await api.createJobFromUrl( youtubeUrl.trim(), youtubeArtist.trim() || undefined, - youtubeTitle.trim() || undefined + youtubeTitle.trim() || undefined, + { + theme_id: selectedTheme, + color_overrides: cleanColorOverrides(colorOverrides), + } ) setYoutubeUrl("") setYoutubeArtist("") @@ -104,7 +119,10 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) { setIsSubmitting(true) try { - await api.searchAudio(searchArtist.trim(), searchTitle.trim()) + await api.searchAudio(searchArtist.trim(), searchTitle.trim(), false, { + theme_id: selectedTheme, + color_overrides: cleanColorOverrides(colorOverrides), + }) setSearchArtist("") setSearchTitle("") onJobCreated() @@ -200,6 +218,20 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) {
+ {/* Theme Selection */} +
+ + +
+ {error && activeTab === "upload" && (

{error}

)} @@ -264,6 +296,20 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) { + {/* Theme Selection */} +
+ + +
+ {error && activeTab === "url" && (

{error}

)} @@ -312,6 +358,20 @@ export function JobSubmission({ onJobCreated }: JobSubmissionProps) { + {/* Theme Selection */} +
+ + +
+ {error && activeTab === "search" && (

{error}

)} diff --git a/frontend/components/job/ThemeSelector.tsx b/frontend/components/job/ThemeSelector.tsx new file mode 100644 index 00000000..4d729c1b --- /dev/null +++ b/frontend/components/job/ThemeSelector.tsx @@ -0,0 +1,133 @@ +"use client" + +import { useState, useEffect } from "react" +import { api } from "@/lib/api" +import type { VideoThemeSummary } from "@/lib/video-themes" +import { Label } from "@/components/ui/label" +import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@/components/ui/select" +import { Skeleton } from "@/components/ui/skeleton" +import { Palette, AlertCircle } from "lucide-react" + +interface ThemeSelectorProps { + value?: string + onChange: (themeId: string | undefined) => void + disabled?: boolean +} + +export function ThemeSelector({ value, onChange, disabled }: ThemeSelectorProps) { + const [themes, setThemes] = useState([]) + const [loading, setLoading] = useState(true) + const [error, setError] = useState(null) + + useEffect(() => { + async function loadThemes() { + try { + setLoading(true) + setError(null) + const themeList = await api.listThemes() + setThemes(themeList) + + // If no value is set and there's a default theme, select it + if (!value && themeList.length > 0) { + const defaultTheme = themeList.find(t => t.is_default) + if (defaultTheme) { + onChange(defaultTheme.id) + } else { + onChange(themeList[0].id) + } + } + } catch (err) { + console.error("Failed to load themes:", err) + setError("Failed to load themes") + } finally { + setLoading(false) + } + } + + loadThemes() + }, []) // Only run once on mount + + const selectedTheme = themes.find(t => t.id === value) + + if (loading) { + return ( +
+ + +
+ ) + } + + if (error || themes.length === 0) { + return ( +
+ +
+ + {error || "No themes available"} +
+
+ ) + } + + return ( +
+ + + + + {/* Theme description and preview */} + {selectedTheme && ( +
+

{selectedTheme.description}

+ + {selectedTheme.thumbnail_url && ( +
+ {`${selectedTheme.name} +
+ )} +
+ )} +
+ ) +} diff --git a/frontend/lib/api.ts b/frontend/lib/api.ts index 32ccd7a2..6404f8a6 100644 --- a/frontend/lib/api.ts +++ b/frontend/lib/api.ts @@ -2,6 +2,8 @@ * API client for karaoke-gen backend */ +import type { VideoThemeSummary, VideoThemeDetail, ThemesListResponse, ThemeDetailResponse, ColorOverrides } from './video-themes'; + // In development, use relative URLs to go through Next.js proxy (avoids CORS) // In production (static export), use the full backend URL const API_BASE_URL = typeof window !== 'undefined' && window.location.hostname === 'localhost' @@ -220,13 +222,15 @@ export const api = { enable_txt?: boolean; brand_prefix?: string; enable_youtube_upload?: boolean; + theme_id?: string; + color_overrides?: ColorOverrides; } ): Promise { const formData = new FormData(); formData.append('file', file); formData.append('artist', artist); formData.append('title', title); - + if (options?.enable_cdg !== undefined) { formData.append('enable_cdg', String(options.enable_cdg)); } @@ -239,13 +243,19 @@ export const api = { if (options?.enable_youtube_upload !== undefined) { formData.append('enable_youtube_upload', String(options.enable_youtube_upload)); } - + if (options?.theme_id) { + formData.append('theme_id', options.theme_id); + } + if (options?.color_overrides) { + formData.append('color_overrides', JSON.stringify(options.color_overrides)); + } + const response = await fetch(`${API_BASE_URL}/api/jobs/upload`, { method: 'POST', headers: getAuthHeaders(), body: formData, }); - + return handleResponse(response); }, @@ -261,6 +271,8 @@ export const api = { enable_txt?: boolean; brand_prefix?: string; enable_youtube_upload?: boolean; + theme_id?: string; + color_overrides?: ColorOverrides; } ): Promise<{ status: string; job_id: string; message: string }> { const body: Record = { url }; @@ -270,7 +282,9 @@ export const api = { if (options?.enable_txt !== undefined) body.enable_txt = options.enable_txt; if (options?.brand_prefix) body.brand_prefix = options.brand_prefix; if (options?.enable_youtube_upload !== undefined) body.enable_youtube_upload = options.enable_youtube_upload; - + if (options?.theme_id) body.theme_id = options.theme_id; + if (options?.color_overrides) body.color_overrides = options.color_overrides; + const response = await fetch(`${API_BASE_URL}/api/jobs/create-from-url`, { method: 'POST', headers: { @@ -279,7 +293,7 @@ export const api = { }, body: JSON.stringify(body), }); - + return handleResponse(response); }, @@ -387,6 +401,8 @@ export const api = { enable_txt?: boolean; brand_prefix?: string; enable_youtube_upload?: boolean; + theme_id?: string; + color_overrides?: ColorOverrides; } ): Promise { const body: Record = { artist, title, auto_download: autoDownload }; @@ -394,7 +410,9 @@ export const api = { if (options?.enable_txt !== undefined) body.enable_txt = options.enable_txt; if (options?.brand_prefix) body.brand_prefix = options.brand_prefix; if (options?.enable_youtube_upload !== undefined) body.enable_youtube_upload = options.enable_youtube_upload; - + if (options?.theme_id) body.theme_id = options.theme_id; + if (options?.color_overrides) body.color_overrides = options.color_overrides; + const response = await fetch(`${API_BASE_URL}/api/audio-search/search`, { method: 'POST', headers: { @@ -403,7 +421,7 @@ export const api = { }, body: JSON.stringify(body), }); - + return handleResponse(response); }, @@ -450,6 +468,54 @@ export const api = { }); return handleResponse(response); }, + + // ========================================================================== + // Theme API endpoints + // ========================================================================== + + /** + * List all available video themes + */ + async listThemes(): Promise { + const response = await fetch(`${API_BASE_URL}/api/themes`, { + headers: getAuthHeaders() + }); + const data = await handleResponse(response); + return data.themes; + }, + + /** + * Get full details for a specific theme + */ + async getTheme(themeId: string): Promise { + const response = await fetch(`${API_BASE_URL}/api/themes/${themeId}`, { + headers: getAuthHeaders() + }); + const data = await handleResponse(response); + return data.theme; + }, + + /** + * Get preview URL for a theme + */ + async getThemePreview(themeId: string): Promise { + const response = await fetch(`${API_BASE_URL}/api/themes/${themeId}/preview`, { + headers: getAuthHeaders() + }); + const data = await handleResponse<{ preview_url: string | null }>(response); + return data.preview_url; + }, + + /** + * Get YouTube description template for a theme + */ + async getThemeYoutubeDescription(themeId: string): Promise { + const response = await fetch(`${API_BASE_URL}/api/themes/${themeId}/youtube-description`, { + headers: getAuthHeaders() + }); + const data = await handleResponse<{ description: string | null }>(response); + return data.description; + }, }; export { ApiError }; diff --git a/frontend/lib/video-themes.ts b/frontend/lib/video-themes.ts new file mode 100644 index 00000000..c7e506ca --- /dev/null +++ b/frontend/lib/video-themes.ts @@ -0,0 +1,113 @@ +/** + * Video theme types and utilities for karaoke video styles. + * + * These are pre-made style configurations stored in GCS that control + * the visual appearance of generated karaoke videos. + */ + +/** + * Summary of a theme for listing in the theme selector. + */ +export interface VideoThemeSummary { + id: string; + name: string; + description: string; + preview_url: string | null; + thumbnail_url: string | null; + is_default: boolean; +} + +/** + * Full theme details including style parameters. + */ +export interface VideoThemeDetail { + id: string; + name: string; + description: string; + preview_url: string | null; + is_default: boolean; + style_params: Record; + has_youtube_description: boolean; +} + +/** + * Response from GET /api/themes + */ +export interface ThemesListResponse { + themes: VideoThemeSummary[]; +} + +/** + * Response from GET /api/themes/{theme_id} + */ +export interface ThemeDetailResponse { + theme: VideoThemeDetail; +} + +/** + * User color overrides for customizing a theme. + * All colors are hex format (#RRGGBB). + */ +export interface ColorOverrides { + /** Color for artist name on intro/end screens */ + artist_color?: string; + /** Color for song title on intro/end screens */ + title_color?: string; + /** Color for lyrics being sung (highlighted) */ + sung_lyrics_color?: string; + /** Color for lyrics not yet sung */ + unsung_lyrics_color?: string; +} + +/** + * Check if color overrides has any values set. + */ +export function hasColorOverrides(overrides?: ColorOverrides): boolean { + if (!overrides) return false; + return !!( + overrides.artist_color || + overrides.title_color || + overrides.sung_lyrics_color || + overrides.unsung_lyrics_color + ); +} + +/** + * Get clean color overrides object (only non-null values). + */ +export function cleanColorOverrides(overrides?: ColorOverrides): ColorOverrides | undefined { + if (!overrides) return undefined; + + const clean: ColorOverrides = {}; + if (overrides.artist_color) clean.artist_color = overrides.artist_color; + if (overrides.title_color) clean.title_color = overrides.title_color; + if (overrides.sung_lyrics_color) clean.sung_lyrics_color = overrides.sung_lyrics_color; + if (overrides.unsung_lyrics_color) clean.unsung_lyrics_color = overrides.unsung_lyrics_color; + + return Object.keys(clean).length > 0 ? clean : undefined; +} + +/** + * Validate hex color format. + */ +export function isValidHexColor(color: string): boolean { + return /^#[0-9A-Fa-f]{6}$/.test(color); +} + +/** + * Default color override values based on common themes. + */ +export const DEFAULT_COLOR_PRESETS = { + nomad: { + artist_color: "#ffdf6b", + title_color: "#ffffff", + sung_lyrics_color: "#7070F7", + unsung_lyrics_color: "#ffffff", + }, + classic: { + artist_color: "#ffffff", + title_color: "#ffffff", + sung_lyrics_color: "#00ff00", + unsung_lyrics_color: "#ffffff", + }, +} as const; diff --git a/karaoke_gen/utils/cli_args.py b/karaoke_gen/utils/cli_args.py index ed792594..f1144407 100644 --- a/karaoke_gen/utils/cli_args.py +++ b/karaoke_gen/utils/cli_args.py @@ -242,9 +242,17 @@ def create_parser(prog: str = "karaoke-gen") -> argparse.ArgumentParser: # Style Configuration style_group = parser.add_argument_group("Style Configuration") + style_group.add_argument( + "--theme", + help="Optional: Theme ID for pre-made styles stored in GCS (e.g., 'nomad', 'default'). " + "When using a theme, CDG/TXT are enabled by default. " + "Example: --theme=nomad", + ) style_group.add_argument( "--style_params_json", - help="Optional: Path to JSON file containing style configuration. Example: --style_params_json='/path/to/style_params.json'", + help="Optional: Path to JSON file containing style configuration. " + "Takes precedence over --theme if both are provided. " + "Example: --style_params_json='/path/to/style_params.json'", ) style_group.add_argument( "--style_override", diff --git a/karaoke_gen/utils/remote_cli.py b/karaoke_gen/utils/remote_cli.py index a5108fcd..3a5dd800 100644 --- a/karaoke_gen/utils/remote_cli.py +++ b/karaoke_gen/utils/remote_cli.py @@ -292,6 +292,8 @@ class RemoteKaraokeClient: # Two-phase workflow (Batch 6) prep_only: bool = False, keep_brand_code: Optional[str] = None, + # Theme system + theme_id: Optional[str] = None, ) -> Dict[str, Any]: """ Submit a new karaoke generation job from a YouTube/online URL. @@ -322,6 +324,7 @@ class RemoteKaraokeClient: clean_instrumental_model: Model for clean instrumental separation backing_vocals_models: List of models for backing vocals separation other_stems_models: List of models for other stems (bass, drums, etc.) + theme_id: Theme ID from GCS themes (e.g., 'nomad', 'default') """ self.logger.info(f"Submitting URL-based job: {url}") @@ -367,7 +370,10 @@ class RemoteKaraokeClient: create_request['prep_only'] = prep_only if keep_brand_code: create_request['keep_brand_code'] = keep_brand_code - + # Theme system + if theme_id: + create_request['theme_id'] = theme_id + self.logger.info(f"Creating URL-based job at {self.config.service_url}/api/jobs/create-from-url") response = self._request('POST', '/api/jobs/create-from-url', json=create_request) @@ -396,9 +402,9 @@ class RemoteKaraokeClient: return result def submit_job( - self, - filepath: str, - artist: str, + self, + filepath: str, + artist: str, title: str, style_params_path: Optional[str] = None, enable_cdg: bool = True, @@ -425,6 +431,8 @@ class RemoteKaraokeClient: # Two-phase workflow (Batch 6) prep_only: bool = False, keep_brand_code: Optional[str] = None, + # Theme system + theme_id: Optional[str] = None, ) -> Dict[str, Any]: """ Submit a new karaoke generation job with optional style configuration. @@ -456,6 +464,7 @@ class RemoteKaraokeClient: backing_vocals_models: List of models for backing vocals separation other_stems_models: List of models for other stems (bass, drums, etc.) existing_instrumental: Path to existing instrumental file to use instead of AI separation + theme_id: Theme ID from GCS themes (e.g., 'nomad', 'default') """ file_path = Path(filepath) @@ -574,7 +583,10 @@ class RemoteKaraokeClient: create_request['prep_only'] = prep_only if keep_brand_code: create_request['keep_brand_code'] = keep_brand_code - + # Theme system + if theme_id: + create_request['theme_id'] = theme_id + response = self._request('POST', '/api/jobs/create-with-upload-urls', json=create_request) if response.status_code != 200: @@ -1195,6 +1207,8 @@ class RemoteKaraokeClient: clean_instrumental_model: Optional[str] = None, backing_vocals_models: Optional[list] = None, other_stems_models: Optional[list] = None, + # Theme system + theme_id: Optional[str] = None, ) -> Dict[str, Any]: """ Search for audio by artist and title (Batch 5 - Flacfetch integration). @@ -1247,7 +1261,10 @@ class RemoteKaraokeClient: request_data['backing_vocals_models'] = backing_vocals_models if other_stems_models: request_data['other_stems_models'] = other_stems_models - + # Theme system + if theme_id: + request_data['theme_id'] = theme_id + # Prepare style files for upload if provided style_files = [] local_style_files: Dict[str, str] = {} # file_type -> local_path @@ -3029,6 +3046,8 @@ def main(): logger.info(f"Searching for: {artist} - {title}") if getattr(args, 'auto_download', False) or config.non_interactive: logger.info(f"Auto-download: enabled (will auto-select best source)") + if getattr(args, 'theme', None): + logger.info(f"Theme: {args.theme}") if args.style_params_json: logger.info(f"Style: {args.style_params_json}") logger.info(f"CDG: {args.enable_cdg}, TXT: {args.enable_txt}") @@ -3070,6 +3089,8 @@ def main(): clean_instrumental_model=getattr(args, 'clean_instrumental_model', None), backing_vocals_models=getattr(args, 'backing_vocals_models', None), other_stems_models=getattr(args, 'other_stems_models', None), + # Theme system + theme_id=getattr(args, 'theme', None), ) job_id = result.get('job_id') @@ -3106,6 +3127,8 @@ def main(): logger.info(f"Title: {title}") if not artist and not title and is_url_input: logger.info(f"Artist/Title: (will be auto-detected from URL)") + if getattr(args, 'theme', None): + logger.info(f"Theme: {args.theme}") if args.style_params_json: logger.info(f"Style: {args.style_params_json}") logger.info(f"CDG: {args.enable_cdg}, TXT: {args.enable_txt}") @@ -3206,6 +3229,8 @@ def main(): # Two-phase workflow (Batch 6) prep_only=getattr(args, 'prep_only', False), keep_brand_code=keep_brand_code_value, + # Theme system + theme_id=getattr(args, 'theme', None), ) else: # File-based job submission @@ -3238,6 +3263,8 @@ def main(): # Two-phase workflow (Batch 6) prep_only=getattr(args, 'prep_only', False), keep_brand_code=keep_brand_code_value, + # Theme system + theme_id=getattr(args, 'theme', None), ) job_id = result.get('job_id') style_assets = result.get('style_assets_uploaded', []) diff --git a/pyproject.toml b/pyproject.toml index c3c4b042..999b08a1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "karaoke-gen" -version = "0.76.8" +version = "0.76.10" 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 "] license = "MIT" diff --git a/scripts/upload-theme.sh b/scripts/upload-theme.sh new file mode 100755 index 00000000..5d44e84b --- /dev/null +++ b/scripts/upload-theme.sh @@ -0,0 +1,367 @@ +#!/bin/bash +# Upload a theme to GCS +# Usage: BRANDING_DIR=/path/to/NomadBranding ./upload-theme.sh [theme_id] + +set -e + +THEME_ID="${1:-nomad}" +BUCKET="karaoke-gen-storage-nomadkaraoke" +THEMES_PATH="themes" + +# BRANDING_DIR must be set via environment variable +BRANDING_DIR="${BRANDING_DIR:-}" + +if [ -z "$BRANDING_DIR" ]; then + echo "Error: BRANDING_DIR environment variable must be set" + echo "Example: export BRANDING_DIR=/path/to/NomadBranding" + exit 1 +fi + +if [ ! -d "$BRANDING_DIR" ]; then + echo "Error: BRANDING_DIR does not exist: $BRANDING_DIR" + exit 1 +fi + +echo "=== Uploading theme: $THEME_ID to gs://$BUCKET/$THEMES_PATH/ ===" +echo "Using branding assets from: $BRANDING_DIR" + +# Create temporary directory for processing +TEMP_DIR=$(mktemp -d) +trap 'rm -rf "$TEMP_DIR"' EXIT + +# Function to upload the Nomad theme +upload_nomad_theme() { + echo "" + echo "=== Setting up Nomad theme ===" + + THEME_PATH="$THEMES_PATH/nomad" + + # Create style_params.json with GCS paths + cat > "$TEMP_DIR/style_params.json" << 'EOF' +{ + "intro": { + "video_duration": 5, + "existing_image": null, + "background_color": "#000000", + "background_image": "karaoke-title-screen-background-nomad-4k.png", + "font": "AvenirNext-Bold.ttf", + "artist_color": "#ffdf6b", + "artist_text_transform": "uppercase", + "title_color": "#ffffff", + "title_gradient": null, + "title_text_transform": "uppercase", + "title_region": "370,980,3100,350", + "artist_region": "370,1400,3100,450", + "artist_gradient": null, + "extra_text": null, + "extra_text_color": "#ffffff", + "extra_text_gradient": null, + "extra_text_region": null, + "extra_text_text_transform": "uppercase" + }, + "karaoke": { + "background_image": "karaoke-background-image-nomad-4k.png", + "background_color": "#000000", + "font_path": "AvenirNext-Bold.ttf", + "font": "Avenir Next Bold", + "ass_name": "Nomad", + "primary_color": "112, 112, 247, 255", + "secondary_color": "255, 255, 255, 255", + "outline_color": "26, 58, 235, 255", + "back_color": "0, 255, 0, 255", + "bold": false, + "italic": false, + "underline": false, + "strike_out": false, + "scale_x": 100, + "scale_y": 100, + "spacing": 0, + "angle": 0.0, + "border_style": 1, + "outline": 1, + "shadow": 0, + "margin_l": 0, + "margin_r": 0, + "margin_v": 0, + "encoding": 0 + }, + "end": { + "video_duration": 5, + "existing_image": null, + "background_color": "#000000", + "background_image": "karaoke-background-image-nomad-4k.png", + "font": "AvenirNext-Bold.ttf", + "artist_color": "#ffdf6b", + "artist_text_transform": "uppercase", + "title_color": "#ffffff", + "title_gradient": null, + "title_text_transform": "uppercase", + "title_region": "370,900,3100,350", + "artist_region": "370,1450,3100,200", + "artist_gradient": null, + "extra_text": "THANK YOU FOR SINGING!", + "extra_text_color": "#ff7acc", + "extra_text_region": "370,400,3100,400", + "extra_text_text_transform": "uppercase", + "extra_text_gradient": null + }, + "cdg": { + "clear_mode": "eager", + "sync_offset": 0, + "lead_in_threshold": 300, + "lead_in_duration": 30, + "lead_in_total": 200, + "lead_in_symbols": ["/>", ">", ">", ">"], + "row": 4, + "line_tile_height": 3, + "lines_per_page": 4, + "title_color": "#ffffff", + "artist_color": "#ffdf6b", + "background_color": "#111427", + "border_color": "#111427", + "active_fill": "#7070F7", + "active_stroke": "#000000", + "inactive_fill": "#ff7acc", + "inactive_stroke": "#000000", + "instrumental_font_color": "#ffdf6b", + "font_path": "AvenirNext-Bold.ttf", + "font_size": 18, + "stroke_width": 0, + "stroke_style": "octagon", + "instrumental_gap_threshold": 1500, + "instrumental_text": "INSTRUMENTAL", + "instrumental_background": "cdg-instrumental-background-nomad-notes.png", + "instrumental_transition": "topleftmusicalnotes", + "title_screen_background": "cdg-title-screen-background-nomad-simple.png", + "title_screen_transition": "largecentertexttoplogo", + "title_artist_gap": 10, + "intro_duration_seconds": 5.0, + "first_syllable_buffer_seconds": 3.0, + "outro_background": "cdg-title-screen-background-nomad-simple.png", + "outro_transition": "largecentertexttoplogo", + "outro_text_line1": "THANK YOU FOR SINGING!", + "outro_text_line2": "nomadkaraoke.com", + "outro_line1_color": "#ffffff", + "outro_line2_color": "#ffdf6b", + "outro_line1_line2_gap": 30 + } +} +EOF + + echo "Uploading style_params.json..." + gsutil cp "$TEMP_DIR/style_params.json" "gs://$BUCKET/$THEME_PATH/style_params.json" + + # Validate all required branding files exist before uploading + echo "Validating required branding files..." + REQUIRED_FILES=( + "$BRANDING_DIR/youtube-video-description.txt" + "$BRANDING_DIR/AvenirNext-Bold.ttf" + "$BRANDING_DIR/karaoke-title-screen-background-nomad-4k.png" + "$BRANDING_DIR/karaoke-background-image-nomad-4k.png" + "$BRANDING_DIR/cdg-instrumental-background-nomad-notes.png" + "$BRANDING_DIR/cdg-title-screen-background-nomad-simple.png" + ) + + for file in "${REQUIRED_FILES[@]}"; do + if [ ! -f "$file" ]; then + echo "Error: Required file not found: $file" + exit 1 + fi + done + echo "All required files found." + + echo "Uploading youtube_description.txt..." + gsutil cp "$BRANDING_DIR/youtube-video-description.txt" "gs://$BUCKET/$THEME_PATH/youtube_description.txt" + + echo "Uploading assets..." + # Font + gsutil cp "$BRANDING_DIR/AvenirNext-Bold.ttf" "gs://$BUCKET/$THEME_PATH/assets/AvenirNext-Bold.ttf" + + # Background images + gsutil cp "$BRANDING_DIR/karaoke-title-screen-background-nomad-4k.png" "gs://$BUCKET/$THEME_PATH/assets/karaoke-title-screen-background-nomad-4k.png" + gsutil cp "$BRANDING_DIR/karaoke-background-image-nomad-4k.png" "gs://$BUCKET/$THEME_PATH/assets/karaoke-background-image-nomad-4k.png" + + # CDG assets + gsutil cp "$BRANDING_DIR/cdg-instrumental-background-nomad-notes.png" "gs://$BUCKET/$THEME_PATH/assets/cdg-instrumental-background-nomad-notes.png" + gsutil cp "$BRANDING_DIR/cdg-title-screen-background-nomad-simple.png" "gs://$BUCKET/$THEME_PATH/assets/cdg-title-screen-background-nomad-simple.png" + + # Create preview image (use an existing image as preview for now) + echo "Uploading preview image..." + gsutil cp "$BRANDING_DIR/karaoke-background-image-nomad-4k.png" "gs://$BUCKET/$THEME_PATH/preview.png" + + echo "Nomad theme uploaded successfully!" +} + +# Function to upload the default theme (simple black background) +upload_default_theme() { + echo "" + echo "=== Setting up Default theme ===" + + THEME_PATH="$THEMES_PATH/default" + + # Create a simple default style_params.json (no custom assets) + cat > "$TEMP_DIR/default_style_params.json" << 'EOF' +{ + "intro": { + "video_duration": 5, + "existing_image": null, + "background_color": "#000000", + "background_image": null, + "font": null, + "artist_color": "#ffffff", + "artist_text_transform": "uppercase", + "title_color": "#ffffff", + "title_gradient": null, + "title_text_transform": "uppercase", + "title_region": "370,980,3100,350", + "artist_region": "370,1400,3100,450" + }, + "karaoke": { + "background_image": null, + "background_color": "#000000", + "font_path": null, + "font": null, + "ass_name": "Default", + "primary_color": "0, 255, 0, 255", + "secondary_color": "255, 255, 255, 255", + "outline_color": "0, 0, 0, 255", + "back_color": "0, 0, 0, 255", + "bold": false, + "italic": false, + "underline": false, + "strike_out": false, + "scale_x": 100, + "scale_y": 100, + "spacing": 0, + "angle": 0.0, + "border_style": 1, + "outline": 2, + "shadow": 0, + "margin_l": 0, + "margin_r": 0, + "margin_v": 0, + "encoding": 0 + }, + "end": { + "video_duration": 5, + "existing_image": null, + "background_color": "#000000", + "background_image": null, + "font": null, + "artist_color": "#ffffff", + "artist_text_transform": "uppercase", + "title_color": "#ffffff", + "title_gradient": null, + "title_text_transform": "uppercase", + "title_region": "370,900,3100,350", + "artist_region": "370,1450,3100,200", + "extra_text": null + }, + "cdg": { + "clear_mode": "eager", + "sync_offset": 0, + "lead_in_threshold": 300, + "lead_in_duration": 30, + "lead_in_total": 200, + "lead_in_symbols": ["/>", ">", ">", ">"], + "row": 4, + "line_tile_height": 3, + "lines_per_page": 4, + "title_color": "#ffffff", + "artist_color": "#ffffff", + "background_color": "#000000", + "border_color": "#000000", + "active_fill": "#00ff00", + "active_stroke": "#000000", + "inactive_fill": "#ffffff", + "inactive_stroke": "#000000", + "instrumental_font_color": "#ffff00", + "font_path": null, + "font_size": 18, + "stroke_width": 1, + "stroke_style": "octagon", + "instrumental_gap_threshold": 1500, + "instrumental_text": "INSTRUMENTAL", + "instrumental_background": null, + "instrumental_transition": "default", + "title_screen_background": null, + "title_screen_transition": "default", + "title_artist_gap": 10, + "intro_duration_seconds": 5.0, + "first_syllable_buffer_seconds": 3.0, + "outro_background": null, + "outro_transition": "default", + "outro_text_line1": "THANK YOU FOR SINGING!", + "outro_text_line2": "", + "outro_line1_color": "#ffffff", + "outro_line2_color": "#ffffff", + "outro_line1_line2_gap": 30 + } +} +EOF + + echo "Uploading default style_params.json..." + gsutil cp "$TEMP_DIR/default_style_params.json" "gs://$BUCKET/$THEME_PATH/style_params.json" + + echo "Default theme uploaded successfully!" +} + +# Function to create/update the theme metadata +create_metadata() { + echo "" + echo "=== Creating theme metadata ===" + + cat > "$TEMP_DIR/_metadata.json" << 'EOF' +{ + "version": 1, + "themes": [ + { + "id": "nomad", + "name": "Nomad Karaoke", + "description": "Professional karaoke style with golden artist text, purple sung lyrics, and beautiful backgrounds", + "is_default": true + }, + { + "id": "default", + "name": "Classic", + "description": "Simple black background with white text and green highlighted lyrics", + "is_default": false + } + ] +} +EOF + + echo "Uploading _metadata.json..." + gsutil cp "$TEMP_DIR/_metadata.json" "gs://$BUCKET/$THEMES_PATH/_metadata.json" + + echo "Metadata created successfully!" +} + +# Main execution +case "$THEME_ID" in + "nomad") + upload_nomad_theme + create_metadata + ;; + "default") + upload_default_theme + create_metadata + ;; + "all") + upload_nomad_theme + upload_default_theme + create_metadata + ;; + "metadata") + create_metadata + ;; + *) + echo "Unknown theme: $THEME_ID" + echo "Usage: $0 [nomad|default|all|metadata]" + exit 1 + ;; +esac + +echo "" +echo "=== Theme upload complete! ===" +echo "Verify with: gsutil ls -r gs://$BUCKET/$THEMES_PATH/"