Node-VOICEVOX-Engine

本ライブラリについて

本ライブラリはヒホ氏によって制作・公開されている、 VOICEVOX Engineの非公式Node.js版、兼 VOICEVOX Coreのラッパーライブラリです。

使用にあたって

本ライブラリの使用にあたっては、利用者自身がVOICEVOX Core公開のサイトより、 VOICEVOX Coreライブラリをダウンロードし、そのライブラリのパスを指定しなければなりません。加えてLibtorchやCUDAなどのインストールも必要です。本ライブラリのみで完結はしませんのでご注意ください。なお、CPU版を利用する場合はCUDA/CUDNNは必要ありません。

なお、このライブラリは現状Linux上でのみ動作確認ができています。 Windows上で動かすとSegmentation Faultなどの問題を起こし、正しく動作しません。更に、その原因が不明です。原因がわかり次第、対応したいと考えています。原因究明にご協力いただける方はこちらのIssueにコメントいただければ幸いです。

ドキュメント

準備中(現状はコード内に含まれるJSDocをご利用ください)

音声合成エンジンとしての利用

本ライブラリはVOICEVOXの音声合成エンジンとして利用可能です。 api.ts内のcore.dllとなっている部分をフルパスに変更し、以下のようなコマンドをご利用ください。なお、音声ライブラリファイル群がcore.dll/libcore.soと同じディレクトリ階層にある前提です。

# ビルドと依存関係・OpenJTalk辞書のダウンロード
# npm なら npm install
yarn inatall
# 実行する、npm なら npm start
# libtorchの存在する場所によってパスを適切に変更してください
LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/libtorch/lib/" yarn start

ライブラリとしての使用例

exampleをご覧ください。なお、実行する際はexample.ts内のcore.dllとなっている部分をフルパスに変更し、以下のようなコマンドをご利用ください。なお、音声ライブラリファイル群がcore.dll/libcore.soと同じディレクトリ階層にある前提です。

# ビルドと依存関係・OpenJTalk辞書のダウンロード
# npm なら npm install
yarn inatall
# 実行する、npm なら npm run example
# libtorchの存在する場所によってパスを適切に変更してください
LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/libtorch/lib/" yarn example

ライセンス

本ライブラリは、本家VOICEVOX Engineのライセンスを継承し、 LGPL-3.0でライセンスされています。