> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Muse 環境で VOICEVOX Core を使う

> Muse の Linux VM で VOICEVOX Core for PHP を使い、日本語テキストを音声合成する手順。

Muse の Linux VM で [`revolution/voicevox-core`](https://github.com/invokable/voicevox-core-php) を使い、チャットで受け取った日本語テキストを音声ファイルに変換する手順です。

> [!NOTE]
>
> VOICEVOX Core は日本語の音声合成に対応しています。このページは VOICEVOX が対応する日本語向けの手順として、日本語版のみを提供します。

> [!WARNING]
>
> `ext-ffi` は Web サーバー環境では無効になっていることが多く、このパッケージは CLI での実行を前提としています。Muse の VM も再作成されることがあるため、必要なファイルはホームディレクトリ配下に置きます。

## 検証環境

この手順は次の組み合わせで検証しています。

| 項目 | バージョン・環境 |
| - | - |
| VOICEVOX Core | 0.17.1 |
| `revolution/voicevox-core` | 0.17.1 |
| 音声モデル | `voicevox_vvm` 0.17.0 の `0.vvm` |
| ONNX Runtime | `voicevox_onnxruntime` 1.23.2（Linux x64、CPU） |
| PHP | 8.3.6（Ubuntu 24.04 のパッケージ） |
| Muse | Linux VM（x86\_64） |

## FFI 用 PHP を用意する

Muse の標準 PHP は `static-php-cli` 製のため、`ext-ffi` が含まれていないことがあります。標準 PHP を置き換えず、FFI 専用の PHP 8.3 をホームディレクトリに展開します。

```bash theme={null}
mkdir -p ~/workspace/tools/php83-ffi/debs
cd ~/workspace/tools/php83-ffi/debs

BASE=http://azure.archive.ubuntu.com/ubuntu/pool/main/p/php8.3
VER=8.3.6-0ubuntu0.24.04.14
for p in php8.3-cli php8.3-common php8.3-opcache php8.3-readline \
         php8.3-mbstring php8.3-xml php8.3-curl; do
  curl -fsSL -O "$BASE/${p}_${VER}_amd64.deb"
done

cd ~/workspace/tools/php83-ffi
for d in debs/*.deb; do dpkg-deb -x "$d" root; done
```

次のラッパーを `~/workspace/tools/bin/php83-ffi` として保存します。

```sh theme={null}
#!/bin/sh
ROOT="$HOME/workspace/tools/php83-ffi/root"
EXT="$ROOT/usr/lib/php/20230831"
exec "$ROOT/usr/bin/php8.3" -n \
  -d extension_dir="$EXT" \
  -d ffi.enable=true \
  -d extension=ffi.so \
  -d extension=phar.so \
  -d extension=mbstring.so \
  -d extension=curl.so \
  -d extension=dom.so \
  -d extension=simplexml.so \
  -d extension=xml.so \
  -d extension=xmlreader.so \
  -d extension=xmlwriter.so \
  -d extension=tokenizer.so \
  -d extension=ctype.so \
  -d extension=fileinfo.so \
  -d extension=iconv.so \
  -d extension=posix.so \
  -d extension=sockets.so \
  "$@"
```

実行権限を付け、FFI が有効になっていることを確認します。

```bash theme={null}
chmod +x ~/workspace/tools/bin/php83-ffi
~/workspace/tools/bin/php83-ffi -v
~/workspace/tools/bin/php83-ffi -r 'var_dump(class_exists("FFI"));'
```

`class_exists("FFI")` が `true` になれば準備完了です。

## VOICEVOX Core のファイルを配置する

公式ダウンローダーが Muse のプロキシを通過できない場合があるため、ダウンローダーが取得する部品を個別に取得し、同じディレクトリ構成に配置します。

```bash theme={null}
mkdir -p ~/workspace/voicevox-test/voicevox_core/{c_api/lib,onnxruntime/lib,models/vvms,dict}
cd ~/workspace/voicevox-test
```

| 部品 | 取得元 | 配置先 |
| - | - | - |
| C API | [`VOICEVOX/voicevox_core` 0.17.1](https://github.com/VOICEVOX/voicevox_core/releases/tag/0.17.1) | `voicevox_core/c_api/lib/` |
| ONNX Runtime | [`VOICEVOX/onnxruntime-builder` 1.23.2](https://github.com/VOICEVOX/onnxruntime-builder/releases/tag/voicevox_onnxruntime-1.23.2) | `voicevox_core/onnxruntime/lib/` |
| OpenJTalk 辞書 | [`r9y9/open_jtalk` v1.11.1](https://github.com/r9y9/open_jtalk/releases/tag/v1.11.1) | `voicevox_core/dict/` |
| 音声モデル | [`VOICEVOX/voicevox_vvm` 0.17.0](https://github.com/VOICEVOX/voicevox_vvm/releases/tag/0.17.0) | `voicevox_core/models/vvms/` |

### C API と ONNX Runtime

```bash theme={null}
curl -fsSL -o /tmp/core.zip \
  https://github.com/VOICEVOX/voicevox_core/releases/download/0.17.1/voicevox_core-linux-x64-0.17.1.zip
unzip -p /tmp/core.zip '*/lib/libvoicevox_core.so' \
  > voicevox_core/c_api/lib/libvoicevox_core.so

curl -fsSL -o /tmp/onnx.tgz \
  https://github.com/VOICEVOX/onnxruntime-builder/releases/download/voicevox_onnxruntime-1.23.2/voicevox_onnxruntime-linux-x64-1.23.2.tgz
tar -xzf /tmp/onnx.tgz --no-same-owner -C /tmp
cp -r /tmp/voicevox_onnxruntime-linux-x64-1.23.2/lib/. \
  voicevox_core/onnxruntime/lib/
```

### OpenJTalk 辞書と音声モデル

```bash theme={null}
curl -fsSL -o /tmp/dict.tar.gz \
  https://github.com/r9y9/open_jtalk/releases/download/v1.11.1/open_jtalk_dic_utf_8-1.11.tar.gz
tar -xzf /tmp/dict.tar.gz --no-same-owner -C voicevox_core/dict

curl -fsSL -o voicevox_core/models/vvms/0.vvm \
  https://github.com/VOICEVOX/voicevox_vvm/releases/download/0.17.0/0.vvm
```

`tar` には `--no-same-owner` を指定します。Muse では所有者の変更が許可されていないためです。

このページの例では `0.vvm` に含まれる、ずんだもんのスタイル ID `3`（ノーマル）を使います。VVM のファイル番号と話者は 1 対 1 ではないため、使用するスタイル ID は VVM のメタデータで確認してください。

## パッケージをインストールする

Composer も FFI 用 PHP で実行します。

```bash theme={null}
cd ~/workspace/voicevox-test
~/workspace/tools/bin/php83-ffi /path/to/composer.phar \
  require revolution/voicevox-core:0.17.1
```

## 日本語テキストを音声合成する

`zundamon.php` を作成します。Muse との会話から実行する場合に扱いやすいよう、入力テキストを第 1 引数、出力ファイルを第 2 引数で受け取ります。引数を省略した場合はサンプルのテキストと `zundamon.wav` を使います。

```php theme={null}
<?php

declare(strict_types=1);

require __DIR__.'/vendor/autoload.php';

use Revolution\Voicevox\Core\Enums\AccelerationMode;
use Revolution\Voicevox\Core\Onnxruntime;
use Revolution\Voicevox\Core\OpenJtalk;
use Revolution\Voicevox\Core\Synthesizer;
use Revolution\Voicevox\Core\VoiceModelFile;

$voicevoxCoreDir = __DIR__.'/voicevox_core';
$onnxruntimeFilename = $voicevoxCoreDir.'/onnxruntime/lib/'.Onnxruntime::libRecommendedVersionedFilename();
$dictDir = $voicevoxCoreDir.'/dict/open_jtalk_dic_utf_8-1.11';
$vvmPath = $voicevoxCoreDir.'/models/vvms/0.vvm';

$text = $argv[1] ?? 'こんにちは、ずんだもんなのだ。';
$styleId = 3;
$outPath = $argv[2] ?? __DIR__.'/zundamon.wav';

$onnxruntime = Onnxruntime::loadOnce($onnxruntimeFilename);
$openJtalk = new OpenJtalk($dictDir);
$synthesizer = new Synthesizer($onnxruntime, $openJtalk, AccelerationMode::Auto);

$model = VoiceModelFile::open($vvmPath);
$synthesizer->loadVoiceModel($model);

// Native モードでは英単語のカタカナ変換がないため、日本語の読みを入力する
$audioQuery = $synthesizer->createAudioQuery($text, $styleId);
$wav = $synthesizer->synthesis($audioQuery, $styleId);

file_put_contents($outPath, $wav);
echo 'Wrote '.$outPath.PHP_EOL;
```

VOICEVOX Core のライブラリを実行時に見つけられるよう、環境変数を設定します。

```bash theme={null}
cd ~/workspace/voicevox-test
export VOICEVOX_CORE_LIB_PATH="$PWD/voicevox_core/c_api/lib/libvoicevox_core.so"
export LD_LIBRARY_PATH="$PWD/voicevox_core/c_api/lib:$PWD/voicevox_core/onnxruntime/lib"
```

引数なしで実行する場合は次のコマンドです。

```bash theme={null}
~/workspace/tools/bin/php83-ffi zundamon.php
```

Muse の会話からテキストと出力先を変える場合は、引数で指定します。

```bash theme={null}
~/workspace/tools/bin/php83-ffi zundamon.php \
  'ミューズの環境で、ピーエイチピーから音声合成できたのだ。' \
  "$PWD/output.wav"
```

`render()` を使ったフレーム単位の PCM 生成など、その他の API は [使い方](https://kawax.biz/jp/packages/voicevox-core-php/usage.md) と [API リファレンス](https://kawax.biz/jp/packages/voicevox-core-php/api.md) を参照してください。

## 検証結果と注意点

共有 CPU の Muse VM では、上記の例から約 7.67 秒の WAV（24 kHz / 16 bit / モノラル）を生成できました。処理時間は約 9 秒でした。

* Muse の VM は再作成されることがあるため、PHP やライブラリは `~/workspace/` など永続化される場所に置きます。
* このパッケージは CLI 専用です。Web サーバーからの実行は `ext-ffi` の設定と PHP バイナリの構成を別途検討してください。
* 生成した音声には VOICEVOX および各音声ライブラリの利用規約が適用されます。ずんだもんを使う場合は `VOICEVOX:ずんだもん` のクレジット表記が必要です。


## Related topics

- [VOICEVOX for Laravel](https://kawax.biz/jp/packages/laravel-voicevox/index.md)
- [VOICEVOX Core for PHP](https://kawax.biz/jp/packages/voicevox-core-php/index.md)
- [使い方 - VOICEVOX Core for PHP](https://kawax.biz/jp/packages/voicevox-core-php/usage.md)
- [インストールと設定 - VOICEVOX for Laravel](https://kawax.biz/jp/packages/laravel-voicevox/installation.md)
- [ネイティブモード：ソング（歌声音声合成） - VOICEVOX for Laravel](https://kawax.biz/jp/packages/laravel-voicevox/native-song.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.