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

# VOICEVOX Core for PHP

> 使用 PHP FFI 包裝 VOICEVOX CORE C 動態函式庫的 Pure PHP 套件。可直接從 PHP 使用文字轉語音（TTS）。

## 概覽

[revolution/voicevox-core](https://github.com/invokable/voicevox-core-php) 是使用 PHP FFI 包裝 [VOICEVOX CORE](https://github.com/VOICEVOX/voicevox_core) C 動態函式庫的 Pure PHP 套件。

VOICEVOX 是高品質的日文文字轉語音（TTS）引擎，透過此套件可以從 PHP 直接進行語音合成。

<Info>
  若想先了解 PHP FFI 本身的機制與限制，請參閱 [PHP FFI](/zh-TW/advanced/ffi)。
</Info>

<Tip>
  若要從 Laravel 應用程式使用，一併閱讀 [VOICEVOX for Laravel](/zh-TW/packages/laravel-voicevox)，可以把用戶端模式與原生模式的差異也一起整理清楚。
</Tip>

<Warning>
  PHP FFI 在 Web 伺服器環境（如 FPM）中通常會被停用（`ffi.enable=false`），因此本套件**以本機 CLI 使用為前提**。
</Warning>

## 需求

* PHP 8.3+
* 需啟用 `ext-ffi` 擴充功能
* VOICEVOX CORE 0.16+

## 安裝

```bash theme={null}
composer require revolution/voicevox-core
```

## 函式庫設定

使用本套件需要 VOICEVOX CORE 的動態函式庫（`.so` / `.dylib`）、ONNX Runtime 函式庫，以及 OpenJTalk 字典。

<Steps>
  <Step title="下載 voicevox_core">
    從 [voicevox\_core releases](https://github.com/VOICEVOX/voicevox_core/releases) 下載並執行符合作業系統／架構的下載器。執行後會在目前目錄下建立 `voicevox_core` 目錄。

    產生的目錄結構：

    ```
    voicevox_core/
    ├── dict/open_jtalk_dic_*/     # OpenJTalk 字典
    ├── c_api/lib/                 # 動態函式庫（.so、.dylib）
    ├── models/vvms/               # 聲音模型檔案（.vvm）
    └── onnxruntime/               # ONNX Runtime 函式庫
    ```
  </Step>

  <Step title="移到永久位置">
    ```bash theme={null}
    mv voicevox_core ~/.local/voicevox_core
    ```
  </Step>

  <Step title="建立符號連結（推薦）">
    建立符號連結讓函式庫可被自動找到。

    <Warning>
      `ln -s` 必須使用**絕對路徑**。
    </Warning>

    **macOS：**

    ```bash theme={null}
    # 請將 [VOICEVOX_CORE_DIR] 替換為 voicevox_core 的絕對路徑
    ln -s [VOICEVOX_CORE_DIR]/libvoicevox_core.dylib /usr/local/lib/libvoicevox_core.dylib
    ```

    若無法從 `/usr/local/lib/` 載入，請在 `.zshrc` 等處設定 `DYLD_FALLBACK_LIBRARY_PATH`：

    ```bash theme={null}
    export DYLD_FALLBACK_LIBRARY_PATH="$HOME/lib:/usr/local/lib:/usr/lib"
    ```

    **Linux：**

    ```bash theme={null}
    ln -s [VOICEVOX_CORE_DIR]/libvoicevox_core.so /usr/local/lib/libvoicevox_core.so
    ```
  </Step>
</Steps>

### 替代方案：以環境變數指定

若無法建立符號連結，可將函式庫檔案的完整路徑設定到 `VOICEVOX_CORE_LIB_PATH` 環境變數：

```bash theme={null}
export VOICEVOX_CORE_LIB_PATH=/path/to/libvoicevox_core.dylib
```

```bash theme={null}
export VOICEVOX_CORE_LIB_PATH="$HOME/.local/voicevox_core/c_api/lib/libvoicevox_core.dylib"
```

<Info>
  在 macOS 上若使用 `DYLD_FALLBACK_LIBRARY_PATH` 仍無法載入，請改以 `VOICEVOX_CORE_LIB_PATH` 設定。
</Info>

## 文件

<Columns cols={2}>
  <Card title="使用方式" href="/zh-TW/packages/voicevox-core-php/usage" icon="play">
    文字轉語音、語音合成的基本用法與程式碼範例。
  </Card>

  <Card title="API 參考" href="/zh-TW/packages/voicevox-core-php/api" icon="code">
    所有類別、方法與 enum 的詳細參考。
  </Card>
</Columns>

## 參考連結

* GitHub: [invokable/voicevox-core-php](https://github.com/invokable/voicevox-core-php)
* VOICEVOX CORE: [VOICEVOX/voicevox\_core](https://github.com/VOICEVOX/voicevox_core)


## Related topics

- [VOICEVOX Core for PHP](/es/packages/voicevox-core-php/index.md)