VOICEVOX Core for PHP

Overview

revolution/voicevox-core is a pure PHP package that wraps VOICEVOX CORE’s C dynamic library via PHP FFI. VOICEVOX is a high-quality Japanese text-to-speech (TTS) engine, and this package lets you perform synthesis directly from PHP.

If you want to first review how PHP FFI works and its limitations, see PHP FFI.

If you’re working from a Laravel app, also read VOICEVOX for Laravel to compare the client and native modes.

PHP FFI is often disabled (ffi.enable=false) in web server environments such as FPM, so this package assumes use from a local CLI.

Requirements

PHP 8.3+
ext-ffi enabled
VOICEVOX CORE 0.16+

Installation

composer require revolution/voicevox-core

Library setup

To use this package, you need the VOICEVOX CORE dynamic library (.so / .dylib), the ONNX Runtime library, and the OpenJTalk dictionary.

Download voicevox_core

Download the downloader that matches your OS and architecture from the voicevox_core releases and run it. A voicevox_core directory is created in the current directory.The generated directory structure:

voicevox_core/
├── dict/open_jtalk_dic_*/     # OpenJTalk dictionary
├── c_api/lib/                 # Dynamic library (.so, .dylib)
├── models/vvms/               # Voice model files (.vvm)
└── onnxruntime/               # ONNX Runtime library

Move it to a permanent location

mv voicevox_core ~/.local/voicevox_core

Create a symlink (recommended)

Create a symlink so the library can be located automatically.

Always use an absolute path with ln -s.

macOS:

# Replace [VOICEVOX_CORE_DIR] with the absolute path to voicevox_core
ln -s [VOICEVOX_CORE_DIR]/libvoicevox_core.dylib /usr/local/lib/libvoicevox_core.dylib

If loading from /usr/local/lib/ fails, set DYLD_FALLBACK_LIBRARY_PATH in .zshrc or similar:

export DYLD_FALLBACK_LIBRARY_PATH="$HOME/lib:/usr/local/lib:/usr/lib"

Linux:

ln -s [VOICEVOX_CORE_DIR]/libvoicevox_core.so /usr/local/lib/libvoicevox_core.so

Alternative: specifying via environment variable

If you can’t create a symlink, set the full path to the library file in the VOICEVOX_CORE_LIB_PATH environment variable:

export VOICEVOX_CORE_LIB_PATH=/path/to/libvoicevox_core.dylib

export VOICEVOX_CORE_LIB_PATH="$HOME/.local/voicevox_core/c_api/lib/libvoicevox_core.dylib"

On macOS, if loading still fails even with DYLD_FALLBACK_LIBRARY_PATH, set VOICEVOX_CORE_LIB_PATH instead.

Documentation

Usage

Basic usage and code samples for text-to-speech and audio synthesis.

API reference

Detailed reference for every class, method, and enum.

Reference links

GitHub: invokable/voicevox-core-php
VOICEVOX CORE: VOICEVOX/voicevox_core

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter Kits

Feeds and RSS

Middleware

Overview

Requirements

Installation

Library setup

Alternative: specifying via environment variable

Documentation

Usage

API reference

Reference links

​Overview

​Requirements

​Installation

​Library setup

​Alternative: specifying via environment variable

​Documentation

Usage

API reference

​Reference links

Overview

Requirements

Installation

Library setup

Alternative: specifying via environment variable

Documentation

Reference links