Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/VOICEVOX/voicevox_core

無料で使える中品質なテキスト読み上げソフトウェア、VOICEVOXのコア
https://github.com/VOICEVOX/voicevox_core
Last synced: 14 days ago
JSON representation
無料で使える中品質なテキスト読み上げソフトウェア、VOICEVOXのコア
Host: GitHub
URL: https://github.com/VOICEVOX/voicevox_core
Owner: VOICEVOX
License: mit
Created: 2021-08-31T14:19:32.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-10-26T08:11:57.000Z (18 days ago)
Last Synced: 2024-10-27T03:57:05.927Z (17 days ago)
Language: Rust
Homepage: https://voicevox.hiroshiba.jp/
Size: 312 MB
Stars: 866
Watchers: 16
Forks: 117
Open Issues: 94
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # VOICEVOX CORE

## **現在の main ブランチは工事中なので正しく動かないことがあります。[バージョン 0.15.4](https://github.com/VOICEVOX/voicevox_core/tree/0.15.4)をご利用ください。**

[![releases](https://img.shields.io/github/v/release/VOICEVOX/voicevox_core?label=release)](https://github.com/VOICEVOX/voicevox_core/releases)

[![test](https://github.com/VOICEVOX/voicevox_core/actions/workflows/test.yml/badge.svg)](https://github.com/VOICEVOX/voicevox_core/actions/workflows/test.yml)

[![dependency status](https://deps.rs/repo/github/VOICEVOX/voicevox_core/status.svg)](https://deps.rs/repo/github/VOICEVOX/voicevox_core)

[![discord](https://img.shields.io/discord/879570910208733277?color=5865f2&label=&logo=discord&logoColor=ffffff)](https://discord.gg/WMwWetrzuh)

[VOICEVOX](https://voicevox.hiroshiba.jp/) の音声合成コア。  

[Releases](https://github.com/VOICEVOX/voicevox_core/releases) にビルド済みのコアライブラリ（.so/.dll/.dylib）があります。

（エディターは [VOICEVOX](https://github.com/VOICEVOX/voicevox/) 、

エンジンは [VOICEVOX ENGINE](https://github.com/VOICEVOX/voicevox_engine/) 、

全体構成は [こちら](https://github.com/VOICEVOX/voicevox/blob/main/docs/%E5%85%A8%E4%BD%93%E6%A7%8B%E6%88%90.md) に詳細があります。）

## API

[API ドキュメント](https://voicevox.github.io/voicevox_core/apis/)をご覧ください。

## ユーザーガイド

[VOICEVOX コア ユーザーガイド](./docs/guide/user/usage.md)をご覧ください。

## 環境構築

> [!NOTE]

> 音声モデル（VVM ファイル）には利用規約が存在します。詳しくはダウンロードしたファイル内の README に記載されています。

Downloader を用いて環境構築を行う場合

### Windows の場合

PowerShell で下記コマンドを実行してください

```PowerShell

Invoke-WebRequest https://github.com/VOICEVOX/voicevox_core/releases/latest/download/download-windows-x64.exe -OutFile ./download.exe

./download.exe

```

### Linux/macOS の場合

[最新のリリース](https://github.com/VOICEVOX/voicevox_core/releases/latest)から環境に合わせてダウンローダーのバイナリをダウンロードしてください。

現在利用可能なのは以下の 4 つです。

- download-linux-arm64

- download-linux-x64

- download-osx-arm64

- download-osx-x64

以下は Linux の x64 での実行例です。

```bash

binary=download-linux-x64

curl -sSfL https://github.com/VOICEVOX/voicevox_core/releases/latest/download/${binary} -o download

chmod +x download

./download

```

詳細な Downloader の使い方については [こちら](./docs/guide/user/downloader.md) を参照してください

 Downloader を使わない場合

1. まず [Releases](https://github.com/VOICEVOX/voicevox_core/releases/latest) からダウンロードしたコアライブラリの zip を、適当なディレクトリ名で展開します。CUDA 版、DirectML 版はかならずその zip ファイルをダウンロードしてください。

2. 同じく Releases から音声モデルの zip をダウンロードしてください。

3. [Open JTalk から配布されている辞書ファイル](https://jaist.dl.sourceforge.net/project/open-jtalk/Dictionary/open_jtalk_dic-1.11/open_jtalk_dic_utf_8-1.11.tar.gz) をダウンロードしてコアライブラリを展開したディレクトリに展開してください。

4. CUDA や DirectML を利用する場合は、 [追加ライブラリ](https://github.com/VOICEVOX/voicevox_additional_libraries/releases/latest) をダウンロードして、コアライブラリを展開したディレクトリに展開してください。

### 注意

#### GPU の使用について

##### CUDA

nvidia 製 GPU を搭載した Windows, Linux PC では CUDA を用いた合成が可能です。

CUDA 版を利用するには Downloader の実行が必要です。  

詳細は [CUDA 版をダウンロードする場合](./docs/guide/user/downloader.md#cuda) を参照してください

##### DirectML

DirectX12 に対応した GPU を搭載した Windows PC では DirectML を用いた合成が可能です  

DirectML 版を利用するには Downloader の実行が必要です。  

詳細は [DirectML 版をダウンロードする場合](./docs/guide/user/downloader.md#directml) を参照してください

macOS の場合、CUDA の macOS サポートは現在終了しているため、VOICEVOX CORE の macOS 向けコアライブラリも CUDA, CUDNN を利用しない CPU 版のみの提供となります。

## サンプル実行

現在このリポジトリでは次のサンプルが提供されています。実行方法についてはそれぞれのディレクトリ内にある README を参照してください

- [Python(pip)](./example/python)

- [C++(UNIX CMake)](./example/cpp/unix)

- [C++(Windows Visual Studio)](./example/cpp/windows)

### その他の言語

- [Go(Windows)](https://github.com/yerrowTail/voicevox_core_go_sample) @yerrowTail

- [C#](https://github.com/yamachu/VoicevoxCoreSharp) @yamachu

サンプルコードを実装された際はぜひお知らせください。こちらに追記させて頂きます。

## 貢献者の方へ

Issue を解決するプルリクエストを作成される際は、別の方と同じ Issue に取り組むことを避けるため、

Issue 側で取り組み始めたことを伝えるか、最初に Draft プルリクエストを作成してください。

[VOICEVOX 非公式 Discord サーバー](https://discord.gg/WMwWetrzuh)にて、開発の議論や雑談を行っています。気軽にご参加ください。

### Rust 以外の言語の API に関する方針

VOICEVOX CORE の主要機能は Rust で実装されることを前提としており、他の言語のラッパーでのみの機能追加はしない方針としています。これは機能の一貫性を保つための方針です。

各言語の特性に応じた追加実装（例えば、Python での `style_id` の [`NewType`](https://docs.python.org/ja/3/library/typing.html#newtype) 化など）は許容されます。

## コアライブラリのビルド

ビルドには [Rust](https://www.rust-lang.org/ja) ([Windows での Rust 開発環境構築手順はこちら](https://docs.microsoft.com/ja-jp/windows/dev-environment/rust/setup)) と [cmake](https://cmake.org/download/) が必要です。

[Releases](https://github.com/VOICEVOX/voicevox_core/releases) にあるビルド済みのコアライブラリを利用せず、自分で一からビルドした場合は、model フォルダにある onnx モデルのみが利用できます。

このモデルはダミーのため、ノイズの混じった音声が出力されます。

```bash

# DLLをビルド

cargo build --release -p voicevox_core_c_api --features load-onnxruntime

```

DLL 用のヘッダファイルの雛形は [crates/voicevox_core_c_api/include/voicevox_core.h](https://github.com/VOICEVOX/voicevox_core/tree/main/crates/voicevox_core_c_api/include/voicevox_core.h) にあります。

詳しくは[feature-options.md](./docs/guide/user/feature-options.md)を参照してください。

```bash

# ヘッダファイルを加工し、マクロ`VOICEVOX_LOAD_ONNXRUNTIME`を宣言

sed 's:^//\(#define VOICEVOX_LOAD_ONNXRUNTIME\)$:\1:' \

  crates/voicevox_core_c_api/include/voicevox_core.h \

  > ./voicevox_core.h

```

## コアライブラリのテスト

```bash

cargo test

```

## ダウンローダーの実行

```bash

cargo run -p downloader

# ヘルプを表示

cargo run -p downloader -- -h

```

## ヘッダファイルの更新

```bash

cargo xtask update-c-header

```

[cbindgen](https://crates.io/crates/cbindgen) が手元にインストールされているなら、それを使いヘッダファイルを生成することもできます。

## タイポチェック

[typos](https://github.com/crate-ci/typos) を使ってタイポのチェックを行っています。

[typos をインストール](https://github.com/crate-ci/typos#install) した後

```bash

typos

```

## 事例紹介

**[voicevox.rb](https://github.com/sevenc-nanashi/voicevox.rb) [@sevenc-nanashi](https://github.com/sevenc-nanashi)** ･･･ VOICEVOX CORE の Ruby 向け FFI ラッパー  

**[Node VOICEVOX Engine](https://github.com/y-chan/node-voicevox-engine) [@y-chan](https://github.com/y-chan)** ･･･ VOICEVOX ENGINE の Node.js/C++ 実装  

**[VOICEVOX ENGINE SHARP](https://github.com/yamachu/VoicevoxEngineSharp) [@yamachu](https://github.com/yamachu)** ･･･ VOICEVOX ENGINE の C# 実装  

**[voicevoxcore4s](https://github.com/windymelt/voicevoxcore4s) [@windymelt](https://github.com/windymelt)** ･･･ VOICEVOX CORE の Scala(JVM) 向け FFI ラッパー  

**[voicevox_flutter](https://github.com/char5742/voicevox_flutter) [@char5742](https://github.com/char5742)** ･･･ VOICEVOX CORE の Flutter 向け FFI ラッパー  

**[voicevoxcore.go](https://github.com/sh1ma/voicevoxcore.go) [@sh1ma](https://github.com/sh1ma)** ･･･ VOICEVOX CORE の Go 言語 向け FFI ラッパー  

**[VoicevoxCoreSharp](https://github.com/yamachu/VoicevoxCoreSharp) [@yamachu](https://github.com/yamachu)** ･･･ VOICEVOX CORE の C# 向け FFI ラッパー

## ライセンス

ソースコードのライセンスは [MIT LICENSE](./LICENSE) です。

[Releases](https://github.com/VOICEVOX/voicevox_core/releases) にあるビルド済みのコアライブラリは別ライセンスなのでご注意ください。