README.md

<div align = "center">

# Easy Voice Toolkit

<img src="https://github.com/Spr-Aachen/Easy-Voice-Toolkit/blob/main/docs/media/Title.png" width="90%"/>

[![Releases](https://img.shields.io/github/v/release/Spr-Aachen/Easy-Voice-Toolkit?color=green&label=Release&logo=Github&logoColor=white&style=for-the-badge)](https://github.com/Spr-Aachen/Easy-Voice-Toolkit/releases/latest)&nbsp;
[![Bilibili](https://img.shields.io/badge/Bilibili-v1.0%20Intro-blue?logo=Bilibili&style=for-the-badge)](https://www.bilibili.com/video/BV1uJ4m157P2)&nbsp;
[![YouTube](https://img.shields.io/badge/YouTube-v1.0%20Intro-red?logo=YouTube&style=for-the-badge)](https://www.youtube.com/watch?v=)

</div>

<p align = "center">
    <a href = "https://ko-fi.com/spr_aachen">

        <img src = "https://cdn.ko-fi.com/cdn/kofi3.png?v=2" width = "150">

    </a>

</p>



<div align = "center">

[**简体中文**](./docs/README_CN.md) | **English**

</div>


## Description

### Overview

A toolkit based on open source voice projects，which provides a variety of automated audio tools including speech model training

Functions that are currently included in the toolkit are as follows:

- [Audio Processing](/docs/EN/Audio-Processor.md)

- [Voice Recognition](/docs/EN/Voice-Recognizer.md)

- [Voice Transcription](/docs/EN/Voice-Transcriber.md)

- [Dataset Creating (For Voice Conversion)](/docs/EN/Dataset-Creator.md)

- [Model Training (For Voice Conversion)](/docs/EN/Voice-Trainer.md)

- [Voice Conversion](/docs/EN/Voice-Converter.md)

<br>These functions can be seamlessly integrated to form a complete workflow
<br>Users can use these tools selectively according to their own needs, or use them in sequence to gradually transform raw audio files into ideal speech models

### Frame

[![Pytorch](https://img.shields.io/badge/PYtorch-test?style=for-the-badge&logo=pytorch&logoColor=white&color=orange)](https://pytorch.org/)[![Static Badge](https://img.shields.io/badge/Pyside6-test?style=for-the-badge&logo=qt&logoColor=white)](https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/index.html)

### Acknowledgement

I'd like to express my sincere gratitude to the authors of the following projects, as their excellent work has contributed to the implementation of this toolkit

- [audio-slicer](https://github.com/openvpi/audio-slicer)
- [VoiceprintRecognition](https://github.com/yeyupiaoling/VoiceprintRecognition-Pytorch/tree/release/1.0)
- [whisper](https://github.com/openai/whisper)
- [SRT-to-CSV-and-audio-split](https://github.com/tobiasrordorf/SRT-to-CSV-and-audio-split)
- [vits](https://github.com/CjangCjengh/vits)
- [GPT-SoVITS](https://github.com/RVC-Boss/GPT-SoVITS)


## Consideration

### System

Currently the released versions only support Windows system

### Language

Languages that are currently supported/unsupported by the toolkit are shown as follows:

<table cellspacing = "0" cellpadding = "0">
    <tr>

        <td style="background-image: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiPjxsaW5lIHgxPSIwIiB5MT0iMCIgeDI9IjEwMCUiIHkyPSIxMDAlIiBzdHJva2U9ImJsYWNrIiBzdHJva2Utd2lkdGg9IjEiLz48L3N2Zz4=);">

            <span style = "float:left; margin-top:20px;">Tool</span>

            <span style = "float:right; margin-top:-10px;">Language</span>

        </td>

        <th style = "text-align:center;">Chinese</th>

        <th style = "text-align:center;">English</th>

        <th style = "text-align:center;">Japnese</th>

    </tr>

    <tr>

        <th style = "text-align:center;">Audio Processor</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

    </tr>

    <tr>

        <th style = "text-align:center;">Voice Recognizer</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

    </tr>

    <tr>

        <th style = "text-align:center;">Voice Transcriber</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

    </tr>

    <tr>

        <th style = "text-align:center;">DataSet Creator</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

    </tr>

    <tr>

        <th style = "text-align:center;">Model Trainer</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

    </tr>

    <tr>

        <th style = "text-align:center;">Voice Converter</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

        <th style = "text-align:center;">&#10004</th>

    </tr>

</table>



## Future Features

### ToDo
- Add chatbot (LLM) integration
- Refactor client with C++ (Qt)

### WIP
- Backend development
- Internationalization
- Add support for Linux OS


## FAQ

-   **Q**: What should I do if the client update / dependency download always fails or gives an error?
<br>**A**: Use a proxy or switch to the Ready-to-use portable package.

-   **Q**: There are many parameter settings that I don't know how to deal with, what should I do?
<br>**A**: Just use the default values.

-   **Q**: Free and open source ?
<br>**A**: Natürlich~♪


## Terms of Use

**Please solve the authorization problem of the dataset on your own. You shall be solely responsible for any problems caused by the use of non-authorized datasets for training and all consequences thereof.The repository and its maintainer have nothing to do with the consequences!**

1. This project is established for academic exchange purposes only and is intended for communication and learning purposes. It is not intended for production environments.

2. Any videos based on Easy Voice Toolkit that are published on video platforms must clearly indicate in the description that they are used for voice changing and specify the input source of the voice or audio, for example, using videos or audios published by others and separating the vocals as input source for conversion, which must provide clear original video links. If your own voice or other synthesized voices from other commercial vocal synthesis software are used as the input source for conversion, you must also explain it in the description.

3. You shall be solely responsible for any infringement problems caused by the input source. When using other commercial vocal synthesis software as input source, please ensure that you comply with the terms of use of the software. Note that many vocal synthesis engines clearly state in their terms of use that they cannot be used for input source conversion.

4. Continuing to use this project is deemed as agreeing to the relevant provisions stated in this repository README. This repository README has the obligation to persuade, and is not responsible for any subsequent problems that may arise.

5. If you distribute this repository's code or publish any results produced by this project publicly (including but not limited to video sharing platforms), please indicate the original author and code source (this repository).

6. If you use this project for any other plan, please contact and inform the author of this repository in advance. Thank you very much.

Reference: [so-vits-svc](https://github.com/svc-develop-team/so-vits-svc)