mirror of
https://github.com/denizsafak/abogen.git
synced 2026-09-20 11:40:57 +02:00
Artem Akymenko
953bef1e71
Domain config types (domain/config_types.py): - PronunciationConfig: pronunciation/heteronym/normalization overrides - SubtitleConfig: mode, format, max_words - CoverConfig: path, mime Domain functions now accept config objects: - build_tts_context(subtitle=, pronunciation=) instead of 9 individual params - make_subtitle_writer(subtitle=) instead of 3 params - process_and_write_subtitles(subtitle=) instead of 2 params - embed_m4b_metadata(cover=) instead of 2 params - build_epub3_package(cover=) instead of 2 params ConversionRequest: 18 flat fields + 8 config objects Application/config.py re-exports domain types All tests updated to new API
136 lines
4.4 KiB
Python
136 lines
4.4 KiB
Python
"""ConversionRequest — normalized input for a conversion job.
|
|
|
|
This is NOT a WebUI Job and NOT a PyQt ConversionThread state.
|
|
It describes the TASK, not the UI.
|
|
|
|
UI adapters are responsible for converting their respective state
|
|
into a ConversionRequest before calling ConversionService.run().
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import dataclasses
|
|
from dataclasses import dataclass, field
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
from abogen.application.conversion_config import (
|
|
ChapterChunkConfig,
|
|
CoverConfig,
|
|
Epub3ExportConfig,
|
|
PronunciationConfig,
|
|
SaveConfig,
|
|
SubtitleConfig,
|
|
SubtitleInputConfig,
|
|
WordSubstitutionConfig,
|
|
)
|
|
from abogen.domain.enums import Language, OutputFormat
|
|
|
|
|
|
class ConversionRequestError(ValueError):
|
|
"""Raised when ConversionRequest has invalid field values."""
|
|
|
|
|
|
# Numeric field constraints: attr -> (min, max)
|
|
_NUMERIC_CONSTRAINTS: dict[str, tuple[float, float | None]] = {
|
|
"speed": (0.5, 3.0),
|
|
"supertonic_total_steps": (2, 15),
|
|
"silence_between_chapters": (0.0, None),
|
|
"chapter_intro_delay": (0.0, None),
|
|
}
|
|
|
|
|
|
@dataclass
|
|
class ConversionRequest:
|
|
"""Normalized request for a conversion job.
|
|
|
|
Only contains fields that describe the conversion task itself.
|
|
UI-only fields (display, logging, user prompts) stay in adapters.
|
|
|
|
Feature toggles use config objects (None = disabled):
|
|
- word_substitution, subtitle_input, chapter_chunk, epub3_export
|
|
- pronunciation (raw data, compiled by app layer)
|
|
- subtitle, save, cover (grouped parameters)
|
|
|
|
Validation runs on creation via __post_init__:
|
|
- None values → replaced with field default (from declaration)
|
|
- Numeric fields → clamped to valid range
|
|
"""
|
|
|
|
# --- Source ---
|
|
source_path: Optional[Path] = None
|
|
direct_text: Optional[str] = None
|
|
original_filename: str = ""
|
|
|
|
# --- TTS Settings ---
|
|
language: Language = Language.EN_US
|
|
tts_provider: str = "kokoro"
|
|
voice: str = "M1"
|
|
voice_profile: Optional[str] = None
|
|
speed: float = 1.0
|
|
use_gpu: bool = True
|
|
supertonic_total_steps: int = 5
|
|
|
|
# --- Output Format ---
|
|
output_format: OutputFormat = OutputFormat.WAV
|
|
|
|
# --- Timing ---
|
|
silence_between_chapters: float = 2.0
|
|
chapter_intro_delay: float = 0.0
|
|
|
|
# --- Content Processing ---
|
|
replace_single_newlines: bool = False
|
|
read_title_intro: bool = False
|
|
read_closing_outro: bool = True
|
|
auto_prefix_chapter_titles: bool = True
|
|
normalize_chapter_opening_caps: bool = False
|
|
|
|
# --- Metadata ---
|
|
metadata_tags: Dict[str, Any] = field(default_factory=dict)
|
|
|
|
# --- Grouped configs ---
|
|
subtitle: SubtitleConfig = field(default_factory=SubtitleConfig)
|
|
save: SaveConfig = field(default_factory=SaveConfig)
|
|
cover: CoverConfig = field(default_factory=CoverConfig)
|
|
pronunciation: PronunciationConfig = field(default_factory=PronunciationConfig)
|
|
|
|
# --- Feature configs (None = disabled) ---
|
|
epub3_export: Optional[Epub3ExportConfig] = None
|
|
word_substitution: Optional[WordSubstitutionConfig] = None
|
|
subtitle_input: Optional[SubtitleInputConfig] = None
|
|
chapter_chunk: Optional[ChapterChunkConfig] = None
|
|
|
|
def __post_init__(self) -> None:
|
|
"""Resolve None → default, then validate and clamp."""
|
|
_apply_none_defaults(self)
|
|
if not self.tts_provider:
|
|
self.tts_provider = "kokoro"
|
|
_clamp_numerics(self)
|
|
|
|
|
|
def _apply_none_defaults(obj: ConversionRequest) -> None:
|
|
"""Replace None values with field defaults from dataclass declaration."""
|
|
for f in dataclasses.fields(obj):
|
|
if getattr(obj, f.name) is not None:
|
|
continue
|
|
if f.default is not dataclasses.MISSING:
|
|
setattr(obj, f.name, f.default)
|
|
elif f.default_factory is not dataclasses.MISSING:
|
|
setattr(obj, f.name, f.default_factory())
|
|
|
|
|
|
def _clamp_numerics(obj: ConversionRequest) -> None:
|
|
"""Clamp numeric fields to valid ranges."""
|
|
for attr, (min_v, max_v) in _NUMERIC_CONSTRAINTS.items():
|
|
val = getattr(obj, attr)
|
|
if val is None:
|
|
continue
|
|
if not isinstance(val, (int, float)):
|
|
raise ConversionRequestError(
|
|
f"{attr} must be a number, got {type(val).__name__}"
|
|
)
|
|
clamped = max(min_v, float(val))
|
|
if max_v is not None:
|
|
clamped = min(max_v, clamped)
|
|
setattr(obj, attr, clamped)
|