@mekuru/coeiroink 0.1.1 → 0.1.2

package/README.jp.md

@@ -0,0 +1,115 @@
+# @mekuru/coeiroink
+
+[English](README.md)
+
+Mekuru Movie Maker のセリフを、COEIROINK v2 で読み上げる `Coeiroink` 部品です。
+
+## セットアップ
+
+[COEIROINK v2](https://coeiroink.com/download) をインストールし、「キャラクターダウンロード」で声を追加して再起動します。接続先は `http://127.0.0.1:50032`。名前・UUID・スタイルは `/v1/speakers` で確認できます。`COEIROINK:つくよみちゃん` などのクレジットを記載し、声の利用規約に従ってください。
+
+Bun 1.4 以上・libx264 付き ffmpeg・ffprobe・日本語フォントを用意し、プロジェクトに追加します。
+
+```sh
+bun add -d @mekuru/core @mekuru/cli @mekuru/coeiroink
+```
+
+`tsconfig.json` に `jsx: "react-jsx"` と `jsxImportSource: "@mekuru/core"` を設定します。`bun create @mekuru` では設定済みです。
+
+## 簡単な使い方
+
+`src/main.tsx` に保存します。
+
+```tsx
+import { writeXml } from "@mekuru/core";
+import { Coeiroink } from "@mekuru/coeiroink";
+
+const text = "こんにちは。";
+
+await writeXml(
+  ".mekuru/main.xml",
+  <mekuru size="1280x720" fps={30}>
+    <stack>
+      <Coeiroink speaker="つくよみちゃん/れいせい">{text}</Coeiroink>
+      <text x="50%" y="50%" anchor="center" size={60} color="#FFFFFF">{text}</text>
+    </stack>
+  </mekuru>,
+);
+```
+
+```sh
+bun src/main.tsx
+bunx mekuru-server .mekuru/main.xml
+```
+
+`http://localhost:3333` でプレビューします。書き出しは `bunx mekuru-compiler .mekuru/main.xml -o video.mp4`。
+
+## キャラクター
+
+`<Coeiroink>` に渡すキャラクターごとの設定をエクスポートしています。展開して使い、ほかの props も追加できます。
+
+```tsx
+import { Coeiroink, tsukuyomi } from "@mekuru/coeiroink";
+
+<Coeiroink {...tsukuyomi}>こんにちは。</Coeiroink>;
+```
+
+| エクスポート | 名前 | `speaker` |
+| --- | --- | --- |
+| `tsukuyomi` | つくよみちゃん | `"つくよみちゃん"` |
+| `mana` | MANA | `"MANA"` |
+| `kana` | KANA | `"KANA"` |
+| `ofutonp` | おふとんP | `"おふとんP"` |
+| `ayaka` | AI声優-朱花 | `"AI声優-朱花"` |
+| `aoba` | AI声優-青葉 | `"AI声優-青葉"` |
+| `ginga` | AI声優-銀芽 | `"AI声優-銀芽"` |
+| `kanae` | AI声優-金苗 | `"AI声優-金苗"` |
+| `dia` | ディアちゃん | `"ディアちゃん"` |
+| `arma` | アルマちゃん | `"アルマちゃん"` |
+| `lilin` | リリンちゃん | `"リリンちゃん"` |
+| `croix` | クロワちゃん | `"クロワちゃん"` |
+| `andzie` | アンジーさん | `"アンジーさん"` |
+| `ameno` | アメノちゃん | `"アメノちゃん"` |
+
+## 詳しい使い方
+
+### 声の設定 (`CoeiroinkProps`)
+
+- `speaker`: 必須: 話者名、`"話者名/スタイル名"`、speakerUuid（`/スタイル名` も指定可）、または数値のスタイル ID。名前・UUID だけなら最初のスタイルを選びます。
+- `speed`: 話す速さの倍率。既定は `1`。
+- `pitch`: COEIROINK の単位での声の高さの調整。既定は `0`。
+- `intonation`: 抑揚の強さ。既定は `1`。
+- `volume`: 合成時の音量の倍率。既定は `1`。
+- `pre`・`post`: 読み上げの前後の無音（秒）。既定はそれぞれ `0.1`。
+- `pause`: 「、」などの句読点の無音（秒）。既定では省略し、エンジンに任せます。
+- `url`: エンジンのベース URL。既定は `http://127.0.0.1:50032`。
+
+話者が見つからない場合は、エラーに利用可能な話者・スタイル名を表示します。`/v1/speakers` とダウンロード状態を確認し、アプリを再起動してください。
+
+### テキストと時間
+
+- `children`: セリフ。文字列・数値・フラグメント・`<br />`。空の読み上げはエラー。
+- `name`: タイムラインの話者名。既定: `speaker`。
+- `reading`: 読みの辞書。例: `{ Mekuru: "めくる" }`。長いキーを優先し、表示は変えない。
+- `gap`: セリフの後の無音（フレーム）。既定: `Math.round(0.3 * fps)`（30 fps で9）。
+- `gain-db`: 再生音量の調整（dB）。既定: 調整なし。
+- `len`: 無音を含む全体のフレーム数。既定: 音声の長さを切り上げた値 + `gap`。話速は変えない。
+- `id`・`at`: 生成する `<dur>` の識別名と開始時刻。[時間の属性](../../docs/reference/Syntax.jp.md#時間の属性)を参照。
+
+ルビ `｜表示《よみ》` は「よみ」を読み、タイムラインには「表示」を残します。半角 `|` と `漢字《かんじ》` も使用できます。`<br />` は空白になり、ほかの要素は入れられません。セリフの連続再生は `<seq>`、字幕との同時表示は `<stack>`、口パクは[立ち絵の `Talk`](../portrait/README.jp.md) を使います。
+
+### キャッシュとプレビュー
+
+- 音声はエンジン・声の設定・読み上げテキストをキーに `.mekuru/cache/tts/` へ保存。キャッシュ済みならエンジン停止中も使用できます。
+- 接続先や再生設定の変更では再合成しません。同名のモデルを更新した場合などは、該当する WAV を削除して再生成します。
+- `writeXml()` は合成中に無音の下書きを出し、完了後に XML を更新します。動画の書き出し前に `await` してください。
+
+### 接続
+
+接続先は `url` → `MEKURU_COEIROINK_URL` → 既定 URL の順で決まります。Bun と同じ環境から確認します。
+
+```sh
+curl http://127.0.0.1:50032/v1/speakers
+```
+
+接続できない場合は起動状態とポートを確認します。Windows のエンジンには [WSL の mirrored ネットワーク](https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking)で `127.0.0.1` から接続できます。

package/README.md

@@ -0,0 +1,115 @@
+# @mekuru/coeiroink
+
+[日本語](README.jp.md)
+
+The `Coeiroink` component reads Mekuru Movie Maker dialogue using COEIROINK v2.
+
+## Setup
+
+Install [COEIROINK v2](https://coeiroink.com/download), download the desired voice from the app, and restart it. The engine listens on `http://127.0.0.1:50032`; `/v1/speakers` lists names, UUIDs, and styles. Include a credit such as `COEIROINK:つくよみちゃん` and follow the voice's terms.
+
+Requires Bun 1.4+, ffmpeg with libx264, ffprobe, and Japanese fonts. Install in the project folder:
+
+```sh
+bun add -d @mekuru/core @mekuru/cli @mekuru/coeiroink
+```
+
+In `tsconfig.json`, set `jsx: "react-jsx"` and `jsxImportSource: "@mekuru/core"` (already set by `bun create @mekuru`).
+
+## Quick start
+
+Save as `src/main.tsx`:
+
+```tsx
+import { writeXml } from "@mekuru/core";
+import { Coeiroink } from "@mekuru/coeiroink";
+
+const text = "こんにちは。";
+
+await writeXml(
+  ".mekuru/main.xml",
+  <mekuru size="1280x720" fps={30}>
+    <stack>
+      <Coeiroink speaker="つくよみちゃん/れいせい">{text}</Coeiroink>
+      <text x="50%" y="50%" anchor="center" size={60} color="#FFFFFF">{text}</text>
+    </stack>
+  </mekuru>,
+);
+```
+
+```sh
+bun src/main.tsx
+bunx mekuru-server .mekuru/main.xml
+```
+
+Preview: `http://localhost:3333`. Export with `bunx mekuru-compiler .mekuru/main.xml -o video.mp4`.
+
+## Characters
+
+The package exports each character's settings for `<Coeiroink>`. Spread one and add other props as needed.
+
+```tsx
+import { Coeiroink, tsukuyomi } from "@mekuru/coeiroink";
+
+<Coeiroink {...tsukuyomi}>こんにちは。</Coeiroink>;
+```
+
+| Export | Name | `speaker` |
+| --- | --- | --- |
+| `tsukuyomi` | つくよみちゃん | `"つくよみちゃん"` |
+| `mana` | MANA | `"MANA"` |
+| `kana` | KANA | `"KANA"` |
+| `ofutonp` | おふとんP | `"おふとんP"` |
+| `ayaka` | AI声優-朱花 | `"AI声優-朱花"` |
+| `aoba` | AI声優-青葉 | `"AI声優-青葉"` |
+| `ginga` | AI声優-銀芽 | `"AI声優-銀芽"` |
+| `kanae` | AI声優-金苗 | `"AI声優-金苗"` |
+| `dia` | ディアちゃん | `"ディアちゃん"` |
+| `arma` | アルマちゃん | `"アルマちゃん"` |
+| `lilin` | リリンちゃん | `"リリンちゃん"` |
+| `croix` | クロワちゃん | `"クロワちゃん"` |
+| `andzie` | アンジーさん | `"アンジーさん"` |
+| `ameno` | アメノちゃん | `"アメノちゃん"` |
+
+## Detailed usage
+
+### Voice (`CoeiroinkProps`)
+
+- `speaker`: Required. A speaker name, `"speaker/style"`, speaker UUID (optionally followed by `/style`), or numeric style ID. A name or UUID alone selects its first style.
+- `speed`: Speaking speed multiplier. Default: `1`.
+- `pitch`: Pitch adjustment in COEIROINK's units. Default: `0`.
+- `intonation`: Intonation strength. Default: `1`.
+- `volume`: Synthesis volume multiplier. Default: `1`.
+- `pre`, `post`: Silence before and after speech, in seconds. Default: `0.1` each.
+- `pause`: Pause length for punctuation such as `、`, in seconds. Omitted by default, leaving it to the engine.
+- `url`: Base URL; default `http://127.0.0.1:50032`.
+
+Unknown speakers are reported with the available speaker/style names. Check `/v1/speakers` and restart the app after downloading a voice.
+
+### Text and timing
+
+- `children`: Dialogue: strings, numbers, fragments, or `<br />`. Empty speech is an error.
+- `name`: Timeline speaker label. Default: `speaker`.
+- `reading`: Pronunciation dictionary, e.g. `{ Mekuru: "めくる" }`. Longer keys win; displayed text is unchanged.
+- `gap`: Trailing silence in frames. Default: `Math.round(0.3 * fps)` (9 at 30 fps).
+- `gain-db`: Playback gain in dB. Default: no adjustment.
+- `len`: Total frames, including the gap. Default: rounded-up audio duration + `gap`. Does not change speaking speed.
+- `id`, `at`: Identifier and start timing for the generated `<dur>`; see [timing](../../docs/reference/Syntax.md#timing-attributes).
+
+Ruby `｜表示《よみ》` reads `よみ` and keeps `表示` in the timeline. ASCII `|` and `漢字《かんじ》` also work. `<br />` becomes a space; other nested elements are rejected. Use `<seq>` for successive lines and `<stack>` for speech with subtitles. For lip sync, wrap a line in a [portrait's `Talk`](../portrait/README.md).
+
+### Cache and preview
+
+- Audio is cached in `.mekuru/cache/tts/` by engine, voice settings, and spoken text. Cached lines work without a running engine.
+- Connection URLs and playback settings do not invalidate audio. Remove the cached WAV to regenerate speech after changing a server or updating a model under the same name.
+- `writeXml()` writes a silent draft while synthesizing, then replaces it with completed XML. Await it before video export.
+
+### Connection
+
+`url` → `MEKURU_COEIROINK_URL` → the default URL, in that order. Check from the same environment as Bun:
+
+```sh
+curl http://127.0.0.1:50032/v1/speakers
+```
+
+For connection errors, check the engine and port. On Windows, use [WSL mirrored networking](https://learn.microsoft.com/en-us/windows/wsl/networking#mirrored-mode-networking) to reach the engine through `127.0.0.1`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mekuru/coeiroink",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "The speech component <Coeiroink> of Mekuru Movie Maker: lines of speech read by COEIROINK",
   "type": "module",
   "exports": {
@@ -11,13 +11,13 @@
   ],
   "sideEffects": false,
   "peerDependencies": {
-    "@mekuru/core": "^0.1.1"
+    "@mekuru/core": "^0.1.2"
   },
   "devDependencies": {
-    "@mekuru/core": "0.1.1"
+    "@mekuru/core": "0.1.2"
   },
   "dependencies": {
-    "@mekuru/speech": "^0.1.1"
+    "@mekuru/speech": "^0.1.2"
   },
   "engines": {
     "bun": ">=1.4"

package/src/characters.ts

@@ -0,0 +1,16 @@
+import type { CoeiroinkProps } from "./index.tsx";
+
+export const tsukuyomi = { name: "つくよみちゃん", speaker: "つくよみちゃん" } satisfies Partial<CoeiroinkProps>;
+export const mana = { name: "MANA", speaker: "MANA" } satisfies Partial<CoeiroinkProps>;
+export const kana = { name: "KANA", speaker: "KANA" } satisfies Partial<CoeiroinkProps>;
+export const ofutonp = { name: "おふとんP", speaker: "おふとんP" } satisfies Partial<CoeiroinkProps>;
+export const ayaka = { name: "AI声優-朱花", speaker: "AI声優-朱花" } satisfies Partial<CoeiroinkProps>;
+export const aoba = { name: "AI声優-青葉", speaker: "AI声優-青葉" } satisfies Partial<CoeiroinkProps>;
+export const ginga = { name: "AI声優-銀芽", speaker: "AI声優-銀芽" } satisfies Partial<CoeiroinkProps>;
+export const kanae = { name: "AI声優-金苗", speaker: "AI声優-金苗" } satisfies Partial<CoeiroinkProps>;
+export const dia = { name: "ディアちゃん", speaker: "ディアちゃん" } satisfies Partial<CoeiroinkProps>;
+export const arma = { name: "アルマちゃん", speaker: "アルマちゃん" } satisfies Partial<CoeiroinkProps>;
+export const lilin = { name: "リリンちゃん", speaker: "リリンちゃん" } satisfies Partial<CoeiroinkProps>;
+export const croix = { name: "クロワちゃん", speaker: "クロワちゃん" } satisfies Partial<CoeiroinkProps>;
+export const andzie = { name: "アンジーさん", speaker: "アンジーさん" } satisfies Partial<CoeiroinkProps>;
+export const ameno = { name: "アメノちゃん", speaker: "アメノちゃん" } satisfies Partial<CoeiroinkProps>;

package/src/index.tsx

@@ -110,3 +110,5 @@ export const Coeiroink = async (props: CoeiroinkProps): Promise<Awaited<JSX.Elem
   const { url, ...voice } = voiceOf(props);
   return line("coeiroink", props, String(props.speaker), voice, (say, out) => engine(url).synthesize(props, say, out));
 };
+
+export * from "./characters.ts";