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
96 lines
3.0 KiB
Python
96 lines
3.0 KiB
Python
"""Feature config objects for ConversionRequest.
|
|
|
|
Each config object groups parameters for a specific feature.
|
|
If the object is None, the feature is disabled.
|
|
|
|
This keeps ConversionRequest clean: no boolean flags for feature toggles,
|
|
no scattered parameters across unrelated fields.
|
|
|
|
Domain config types (PronunciationConfig, SubtitleConfig) live in
|
|
domain/config_types.py — domain defines the contract, app fills them.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass, field
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
from abogen.domain.config_types import CoverConfig, PronunciationConfig, SubtitleConfig
|
|
from abogen.domain.enums import OutputFormat, SaveMode
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class WordSubstitutionConfig:
|
|
"""Word substitution settings.
|
|
|
|
When present on ConversionRequest, word substitution is applied
|
|
to the source text before chapter parsing.
|
|
"""
|
|
substitutions_list: str = ""
|
|
case_sensitive: bool = False
|
|
replace_caps: bool = False
|
|
replace_numerals: bool = False
|
|
fix_punctuation: bool = False
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class SubtitleInputConfig:
|
|
"""Subtitle file input settings.
|
|
|
|
When present on ConversionRequest, the source is treated as a
|
|
subtitle file (.srt/.ass/.vtt) or timestamp text, and the
|
|
subtitle-to-audio pipeline is used instead of normal text conversion.
|
|
"""
|
|
is_timestamp_text: bool = False
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class Epub3ExportConfig:
|
|
"""EPUB3 export settings.
|
|
|
|
When present on ConversionRequest, an EPUB3 package with
|
|
synchronized audio narration is generated after conversion.
|
|
"""
|
|
book_id: str = ""
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class ChapterChunkConfig:
|
|
"""Chapter and chunk configuration.
|
|
|
|
Groups chapter overrides, chunk data, and speaker settings
|
|
used by the planner to build segments.
|
|
"""
|
|
chapter_overrides: List[Dict[str, Any]] = field(default_factory=list)
|
|
chunks: List[Dict[str, Any]] = field(default_factory=list)
|
|
chunk_level: str = "paragraph"
|
|
speaker_mode: str = "single"
|
|
speakers: Dict[str, Any] = field(default_factory=dict)
|
|
|
|
def __post_init__(self) -> None:
|
|
_VALID_CHUNK_LEVELS = ("paragraph", "sentence")
|
|
_VALID_SPEAKER_MODES = ("single", "multi")
|
|
if self.chunk_level not in _VALID_CHUNK_LEVELS:
|
|
raise ValueError(
|
|
f"chunk_level must be one of {_VALID_CHUNK_LEVELS}, got {self.chunk_level!r}"
|
|
)
|
|
if self.speaker_mode not in _VALID_SPEAKER_MODES:
|
|
raise ValueError(
|
|
f"speaker_mode must be one of {_VALID_SPEAKER_MODES}, got {self.speaker_mode!r}"
|
|
)
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class SaveConfig:
|
|
"""Save/output settings.
|
|
|
|
Groups save mode, output folder, chapter splitting, and merge options.
|
|
"""
|
|
mode: SaveMode = SaveMode.SAVE_NEXT_TO_INPUT
|
|
output_folder: Optional[Path] = None
|
|
save_chapters_separately: bool = False
|
|
merge_chapters_at_end: bool = True
|
|
separate_chapters_format: OutputFormat = OutputFormat.WAV
|
|
save_as_project: bool = False
|