整理: エンジンマニフェストをAPI向けと内部向けで分離

build_util/make_docs.py

@@ -50,7 +50,7 @@ def generate_api_docs_html(schema: str) -> str:
     engine_manifest = load_manifest(engine_manifest_path())
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,  # NOTE: `engine_manifest.supported_vvlib_manifest_version` を実装予定
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

run.py

@@ -329,7 +329,7 @@ def main() -> None:
 
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,  # NOTE: `engine_manifest.supported_vvlib_manifest_version` を実装予定
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

test/benchmark/engine_preparation.py

@@ -29,7 +29,7 @@ def _generate_engine_fake_server(root_dir: Path) -> TestClient:
     engine_manifest = load_manifest(engine_manifest_path())
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,  # NOTE: `engine_manifest.supported_vvlib_manifest_version` を実装予定
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

test/e2e/conftest.py

@@ -48,7 +48,7 @@ def app_params(tmp_path: Path) -> dict[str, Any]:
     engine_manifest = load_manifest(engine_manifest_path())
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,  # NOTE: `engine_manifest.supported_vvlib_manifest_version` を実装予定
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

test/unit/test_engine_manifest.py

@@ -0,0 +1,18 @@
+"""エンジンマニフェストのテスト"""
+
+from pathlib import Path
+
+from voicevox_engine.engine_manifest import EngineManifestInternal
+
+
+def test_manifest_internal_init() -> None:
+    """`EngineManifestInternal.from_file()` でインスタンスが生成される。"""
+    EngineManifestInternal.from_file(Path("engine_manifest.json"))
+    assert True
+
+
+def test_manifest_internal_relative_path() -> None:
+    """`EngineManifestInternal.root` を用いて相対パスが解決できる。"""
+    wrapper = EngineManifestInternal.from_file(Path("engine_manifest.json"))
+    tos_path = wrapper.root / wrapper.terms_of_service
+    assert tos_path.exists()

voicevox_engine/app/application.py

@@ -20,7 +20,7 @@
 from voicevox_engine.app.routers.user_dict import generate_user_dict_router
 from voicevox_engine.cancellable_engine import CancellableEngine
 from voicevox_engine.core.core_initializer import CoreManager
-from voicevox_engine.engine_manifest import EngineManifest
+from voicevox_engine.engine_manifest import EngineManifestInternal
 from voicevox_engine.library.library_manager import LibraryManager
 from voicevox_engine.metas.MetasStore import MetasStore
 from voicevox_engine.preset.preset_manager import PresetManager
@@ -37,7 +37,7 @@ def generate_app(
     setting_loader: SettingHandler,
     preset_manager: PresetManager,
     user_dict: UserDictionary,
-    engine_manifest: EngineManifest,
+    engine_manifest: EngineManifestInternal,
     library_manager: LibraryManager,
     cancellable_engine: CancellableEngine | None = None,
     speaker_info_dir: Path | None = None,
@@ -73,7 +73,7 @@ def generate_app(
     app.include_router(
         generate_speaker_router(core_manager, metas_store, speaker_info_dir)
     )
-    if engine_manifest.supported_features.manage_library:
+    if engine_manifest.supported_features.manage_library.value:
         app.include_router(generate_library_router(library_manager))
     app.include_router(generate_user_dict_router(user_dict))
     app.include_router(generate_engine_info_router(core_manager, engine_manifest))
@@ -83,7 +83,7 @@ def generate_app(
     app.include_router(generate_portal_page_router(engine_manifest.name))
 
     app = configure_openapi_schema(
-        app, engine_manifest.supported_features.manage_library
+        app, engine_manifest.supported_features.manage_library.value
     )
 
     return app

voicevox_engine/app/routers/engine_info.py

@@ -1,5 +1,7 @@
 """エンジンの情報機能を提供する API Router"""
 
+import json
+from base64 import b64encode
 from typing import Self
 
 from fastapi import APIRouter, HTTPException
@@ -9,7 +11,11 @@
 from voicevox_engine import __version__
 from voicevox_engine.core.core_adapter import DeviceSupport
 from voicevox_engine.core.core_initializer import CoreManager
-from voicevox_engine.engine_manifest import EngineManifest
+from voicevox_engine.engine_manifest import (
+    BrandName,
+    EngineManifestInternal,
+    EngineName,
+)
 
 
 class SupportedDevicesInfo(BaseModel):
@@ -31,8 +37,118 @@ def generate_from(cls, device_support: DeviceSupport) -> Self:
         )
 
 
+class UpdateInfo(BaseModel):
+    """
+    エンジンのアップデート情報
+    """
+
+    version: str = Field(title="エンジンのバージョン名")
+    descriptions: list[str] = Field(title="アップデートの詳細についての説明")
+    contributors: list[str] | SkipJsonSchema[None] = Field(
+        default=None, title="貢献者名"
+    )
+
+
+class LicenseInfo(BaseModel):
+    """
+    依存ライブラリのライセンス情報
+    """
+
+    name: str = Field(title="依存ライブラリ名")
+    version: str | SkipJsonSchema[None] = Field(
+        default=None, title="依存ライブラリのバージョン"
+    )
+    license: str | SkipJsonSchema[None] = Field(
+        default=None, title="依存ライブラリのライセンス名"
+    )
+    text: str = Field(title="依存ライブラリのライセンス本文")
+
+
+class SupportedFeatures(BaseModel):
+    """
+    エンジンが持つ機能の一覧
+    """
+
+    adjust_mora_pitch: bool = Field(title="モーラごとの音高の調整")
+    adjust_phoneme_length: bool = Field(title="音素ごとの長さの調整")
+    adjust_speed_scale: bool = Field(title="全体の話速の調整")
+    adjust_pitch_scale: bool = Field(title="全体の音高の調整")
+    adjust_intonation_scale: bool = Field(title="全体の抑揚の調整")
+    adjust_volume_scale: bool = Field(title="全体の音量の調整")
+    interrogative_upspeak: bool = Field(title="疑問文の自動調整")
+    synthesis_morphing: bool = Field(
+        title="2種類のスタイルでモーフィングした音声を合成"
+    )
+    sing: bool | SkipJsonSchema[None] = Field(default=None, title="歌唱音声合成")
+    manage_library: bool | SkipJsonSchema[None] = Field(
+        default=None, title="音声ライブラリのインストール・アンインストール"
+    )
+
+
+class EngineManifest(BaseModel):
+    """
+    エンジン自体に関する情報
+    """
+
+    manifest_version: str = Field(title="マニフェストのバージョン")
+    name: EngineName = Field(title="エンジン名")
+    brand_name: BrandName = Field(title="ブランド名")
+    uuid: str = Field(title="エンジンのUUID")
+    url: str = Field(title="エンジンのURL")
+    icon: str = Field(title="エンジンのアイコンをBASE64エンコードしたもの")
+    default_sampling_rate: int = Field(title="デフォルトのサンプリング周波数")
+    frame_rate: float = Field(title="エンジンのフレームレート")
+    terms_of_service: str = Field(title="エンジンの利用規約")
+    update_infos: list[UpdateInfo] = Field(title="エンジンのアップデート情報")
+    dependency_licenses: list[LicenseInfo] = Field(title="依存関係のライセンス情報")
+    supported_vvlib_manifest_version: str | SkipJsonSchema[None] = Field(
+        default=None, title="エンジンが対応するvvlibのバージョン"
+    )
+    supported_features: SupportedFeatures = Field(title="エンジンが持つ機能")
+
+
+def generate_engine_manifest(
+    internal_manifest: EngineManifestInternal,
+) -> EngineManifest:
+    """API 向けのエンジンマニフェストオブジェクトを生成する。"""
+    root_dir = internal_manifest.root
+    manifest = internal_manifest.model_dump()
+
+    return EngineManifest(
+        manifest_version=manifest["manifest_version"],
+        name=manifest["name"],
+        brand_name=manifest["brand_name"],
+        uuid=manifest["uuid"],
+        url=manifest["url"],
+        default_sampling_rate=manifest["default_sampling_rate"],
+        frame_rate=manifest["frame_rate"],
+        icon=b64encode((root_dir / manifest["icon"]).read_bytes()).decode("utf-8"),
+        terms_of_service=(root_dir / manifest["terms_of_service"]).read_text("utf-8"),
+        update_infos=[
+            UpdateInfo(**update_info)
+            for update_info in json.loads(
+                (root_dir / manifest["update_infos"]).read_text("utf-8")
+            )
+        ],
+        # supported_vvlib_manifest_versionを持たないengine_manifestのために
+        # キーが存在しない場合はNoneを返すgetを使う
+        supported_vvlib_manifest_version=manifest.get(
+            "supported_vvlib_manifest_version"
+        ),
+        dependency_licenses=[
+            LicenseInfo(**license_info)
+            for license_info in json.loads(
+                (root_dir / manifest["dependency_licenses"]).read_text("utf-8")
+            )
+        ],
+        supported_features={
+            key: item["value"] for key, item in manifest["supported_features"].items()
+        },
+    )
+
+
 def generate_engine_info_router(
-    core_manager: CoreManager, engine_manifest_data: EngineManifest
+    core_manager: CoreManager, engine_manifest_data: EngineManifestInternal
 ) -> APIRouter:
     """エンジン情報 API Router を生成する"""
     router = APIRouter(tags=["その他"])
@@ -60,6 +176,6 @@ def supported_devices(
     @router.get("/engine_manifest")
     async def engine_manifest() -> EngineManifest:
         """エンジンマニフェストを取得します。"""
-        return engine_manifest_data
+        return generate_engine_manifest(engine_manifest_data)
 
     return router