Retrieval-based-Voice-Conversion/docs/jp

Retrieval-based-Voice-Conversion

An easy-to-use Voice Conversion framework based on VITS.

---

Note

現在開発中です...rvcのライブラリとAPIを提供する予定です。

Installation and usage

Standard Setup

最初にプロジェクトにディレクトリを作成します。assetsフォルダには推論や学習に必要なモデル、resultフォルダには学習の結果が保存されます。

rvc init

これにより、作業ディレクトリにassetsフォルダと.envが作成されます。

Warning

この時、ディレクトリは空もしくはassetsフォルダおよび.envファイルがない状態にしてください

Custom Setup

既にモデルをダウンロードしている場合や、これらの構成を変更したい場合、.envファイルを編集してください。 まだ.envファイルがない場合、

rvc env create

にて作成できます。

また、モデルをダウンロードするときは

rvc dlmodel

もしくは

rvc dlmodel {download_dir}

にてダウンロードできます。

最後に、envファイルにてモデルの場所などを指定してあげれば、終了です！

CLI Usage

Inference Audio

rvc infer -m {model.pth} -i {input.wav} -o {output.wav}

option	flag	type	default value	description
modelPath	-m	Path	*required	Model path or filename (reads in the directory set in env)
inputPath	-i	Path	*required	Input audio path or folder
outputPath	-o	Path	*required	Output audio path or folder
sid	-s	int	0	Speaker/Singer ID
f0_up_key	-fu	int	0	Transpose (integer, number of semitones, raise by an octave: 12, lower by an octave: -12)
f0_method	-fm	str	rmvpe	pitch extraction algorithm (pm, harvest, crepe, rmvpe
f0_file	-ff	Path | None	None	F0 curve file (optional). One pitch per line. Replaces the default F0 and pitch modulation
index_file	-if	Path | None	None	Path to the feature index file
index_rate	-if	float	0.75	Search feature ratio (controls accent strength, too high has artifacting)
filter_radius	-fr	int	3	If >=3: apply median filtering to the harvested pitch results. The value represents the filter radius and can reduce breathiness
resample_sr	-rsr	int	0	Resample the output audio in post-processing to the final sample rate. Set to 0 for no resampling
rms_mix_rate	-rmr	float	0.25	Adjust the volume envelope scaling. Closer to 0, the more it mimicks the volume of the original vocals. Can help mask noise and make volume sound more natural when set relatively low. Closer to 1 will be more of a consistently loud volume
protect	-p	float	0.33	Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy

API Usage

最初に、サーバーを立ち上げます。

rvc-api

または

poetry run poe rvc-api

にて実行されます。

Inference Audio

blobでレスポンスを受け取る

curl -X 'POST' \
      'http://127.0.0.1:8000/inference?res_type=blob' \
      -H 'accept: application/json' \
      -H 'Content-Type: multipart/form-data' \
      -F 'modelpath={model.pth}' \
      -F 'input={input audio path}'

jsonでレスポンス！(include time)

curl -X 'POST' \
      'http://127.0.0.1:8000/inference?res_type=json' \
      -H 'accept: application/json' \
      -H 'Content-Type: multipart/form-data' \
      -F 'modelpath={model.pth}' \
      -F 'input={input audio path}'