VOICEVOX Core for PHP

Overview

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

If you want to understand how PHP FFI works and its constraints first, see PHP FFI.

PHP FFI is often disabled in web server environments such as FPM (ffi.enable=false). This package is intended for local CLI use.

Requirements

PHP 8.3+
ext-ffi extension 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 for your OS and architecture from voicevox_core releases and run it. It creates a voicevox_core directory in your current directory.The created directory structure:

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

Move to a permanent location

mv voicevox_core ~/.local/voicevox_core

Create a symbolic link (recommended)

Create a symbolic link so the library is found automatically.

Always use absolute paths 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 the library cannot be loaded from /usr/local/lib/, set DYLD_FALLBACK_LIBRARY_PATH in your .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: Use an environment variable

If you cannot create a symbolic link, 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 DYLD_FALLBACK_LIBRARY_PATH does not work, use VOICEVOX_CORE_LIB_PATH instead.

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter Kits

Feeds and RSS

Middleware

Overview

Requirements

Installation

Library Setup

Alternative: Use an environment variable

Documentation

Usage

API Reference

Links

​Overview

​Requirements

​Installation

​Library Setup

​Alternative: Use an environment variable

​Documentation

Usage

API Reference

​Links

Overview

Requirements

Installation

Library Setup

Alternative: Use an environment variable

Documentation

Links