xtts-api-server


Namextts-api-server JSON
Version 0.8.5 PyPI version JSON
download
home_pageNone
SummaryA simple FastAPI server to host XTTSv2
upload_time2024-02-20 20:33:51
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # A simple FastAPI Server to run XTTSv2

This project is inspired by [silero-api-server](https://github.com/ouoertheo/silero-api-server) and utilizes [XTTSv2](https://github.com/coqui-ai/TTS).

This server was created for [SillyTavern](https://github.com/SillyTavern/SillyTavern) but you can use it for your needs

Feel free to make PRs or use the code for your own needs

There's a [google collab version](https://colab.research.google.com/drive/1b-X3q5miwYLVMuiH_T73odMO8cbtICEY?usp=sharing) you can use it if your computer is weak.

If you want to get a high-quality voice clone, I advise you to use [webui for fine-tuning xtts](https://github.com/daswer123/xtts-webui)

If you are looking for an option for normal XTTS use look here [https://github.com/daswer123/xtts-webui](https://github.com/daswer123/xtts-webui)

## Changelog

You can keep track of all changes on the [release page](https://github.com/daswer123/xtts-api-server/releases)

## TODO
- [x] Make it possible to change generation parameters through the generation request and through a different endpoint

## Installation

Simple installation :

```bash
pip install xtts-api-server
```

This will install all the necessary dependencies, including a **CPU support only** version of PyTorch

I recommend that you install the **GPU version** to improve processing speed ( up to 3 times faster )

### Windows
```bash
python -m venv venv
venv\Scripts\activate
pip install xtts-api-server
pip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118
```

### Linux
```bash
python -m venv venv
source venv\bin\activate
pip install xtts-api-server
pip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118
```

### Manual
```bash
# Clone REPO
git clone https://github.com/daswer123/xtts-api-server
cd xtts-api-server
# Create virtual env
python -m venv venv
venv/scripts/activate or source venv/bin/activate
# Install deps
pip install -r requirements.txt
pip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118
# Launch server
python -m xtts_api_server
 
```

# Use Docker image with Docker Compose

A Dockerfile is provided to build a Docker image, and a docker-compose.yml file is provided to run the server with Docker Compose as a service.

You can build the image with the following command:

```bash
mkdir xtts-api-server
cd xtts-api-server
docker run -d daswer123/xtts-api-server

```

OR

```bash
cd docker
docker compose build
```

Then you can run the server with the following command:

```bash
docker compose up # or with -d to run in background
```

## Starting Server

`python -m xtts_api_server` will run on default ip and port (localhost:8020)

Use the `--deepspeed` flag to process the result fast ( 2-3x acceleration )

```
usage: xtts_api_server [-h] [-hs HOST] [-p PORT] [-sf SPEAKER_FOLDER] [-o OUTPUT] [-t TUNNEL_URL] [-ms MODEL_SOURCE] [--listen] [--use-cache] [--lowvram] [--deepspeed] [--streaming-mode] [--stream-play-sync]

Run XTTSv2 within a FastAPI application

options:
  -h, --help show this help message and exit
  -hs HOST, --host HOST
  -p PORT, --port PORT
  -d DEVICE, --device DEVICE `cpu` or `cuda`, you can specify which video card to use, for example, `cuda:0`
  -sf SPEAKER_FOLDER, --speaker-folder The folder where you get the samples for tts
  -o OUTPUT, --output Output folder
  -mf MODELS_FOLDERS, --model-folder Folder where models for XTTS will be stored, finetuned models should be stored in this folder
  -t TUNNEL_URL, --tunnel URL of tunnel used (e.g: ngrok, localtunnel)
  -ms MODEL_SOURCE, --model-source ["api","apiManual","local"]
  -v MODEL_VERSION, --version You can download the official model or your own model, official version you can find [here](https://huggingface.co/coqui/XTTS-v2/tree/main)  the model version name is the same as the branch name [v2.0.2,v2.0.3, main] etc. Or you can load your model, just put model in models folder
  --listen Allows the server to be used outside the local computer, similar to -hs 0.0.0.0
  --use-cache Enables caching of results, your results will be saved and if there will be a repeated request, you will get a file instead of generation
  --lowvram The mode in which the model will be stored in RAM and when the processing will move to VRAM, the difference in speed is small
  --deepspeed allows you to speed up processing by several times, automatically downloads the necessary libraries
  --streaming-mode Enables streaming mode, currently has certain limitations, as described below.
  --streaming-mode-improve Enables streaming mode, includes an improved streaming mode that consumes 2gb more VRAM and uses a better tokenizer and more context.
  --stream-play-sync Additional flag for streaming mod that allows you to play all audio one at a time without interruption
```

You can specify the path to the file as text, then the path counts and the file will be voiced

You can load your own model, for this you need to create a folder in models and load the model with configs, note in the folder should be 3 files `config.json` `vocab.json` `model.pth`

If you want your host to listen, use -hs 0.0.0.0 or use --listen

The -t or --tunnel flag is needed so that when you get speakers via get you get the correct link to hear the preview. More info [here](https://imgur.com/a/MvpFT59)

Model-source defines in which format you want to use xtts:

1. `local` - loads version 2.0.2 by default, but you can specify the version via the -v flag, model saves into the models folder and uses `XttsConfig` and `inference`.
2. `apiManual` - loads version 2.0.2 by default, but you can specify the version via the -v flag, model saves into the models folder and uses the `tts_to_file` function from the TTS api
3. `api` - will load the latest version of the model. The -v flag won't work.

All versions of the XTTSv2 model can be found [here](https://huggingface.co/coqui/XTTS-v2/tree/main)  the model version name is the same as the branch name [v2.0.2,v2.0.3, main] etc.

The first time you run or generate, you may need to confirm that you agree to use XTTS.

# About Streaming mode

Streaming mode allows you to get audio and play it back almost immediately. However, it has a number of limitations.

You can see how this mode works [here](https://www.youtube.com/watch?v=jHylNGQDDA0) and [here](https://www.youtube.com/watch?v=6vhrxuWcV3U)

Now, about the limitations

1. Can only be used on a local computer
2. Playing audio from the your pc
3. Does not work endpoint `tts_to_file` only `tts_to_audio` and it returns 1 second of silence.

You can specify the version of the XTTS model by using the `-v` flag.

Improved streaming mode is suitable for complex languages such as Chinese, Japanese, Hindi or if you want the language engine to take more information into account when processing speech.

`--stream-play-sync` flag - Allows you to play all messages in queue order, useful if you use group chats. In SillyTavern you need to turn off streaming to work correctly

# API Docs

API Docs can be accessed from [http://localhost:8020/docs](http://localhost:8020/docs)

# How to add speaker

By default the `speakers` folder should appear in the folder, you need to put there the wav file with the voice sample, you can also create a folder and put there several voice samples, this will give more accurate results

# Selecting Folder

You can change the folders for speakers and the folder for output via the API.

# Note on creating samples for quality voice cloning

The following post is a quote by user [Material1276 from reddit](https://www.reddit.com/r/Oobabooga/comments/1807tsl/comment/ka5l8w9/?share_id=_5hh4KJTXrEOSP0hR0hCK&utm_content=2&utm_medium=android_app&utm_name=androidcss&utm_source=share&utm_term=1)

> Some suggestions on making good samples
>
> Keep them about 7-9 seconds long. Longer isn't necessarily better.
>
> Make sure the audio is down sampled to a Mono, 22050Hz 16 Bit wav file. You will slow down processing by a large % and it seems cause poor quality results otherwise (based on a few tests). 24000Hz is the quality it outputs at anyway!
>
> Using the latest version of Audacity, select your clip and Tracks > Resample to 22050Hz, then Tracks > Mix > Stereo to Mono. and then File > Export Audio, saving it as a WAV of 22050Hz
>
> If you need to do any audio cleaning, do it before you compress it down to the above settings (Mono, 22050Hz, 16 Bit).
>
> Ensure the clip you use doesn't have background noises or music on e.g. lots of movies have quiet music when many of the actors are talking. Bad quality audio will have hiss that needs clearing up. The AI will pick this up, even if we don't, and to some degree, use it in the simulated voice to some extent, so clean audio is key!
>
> Try make your clip one of nice flowing speech, like the included example files. No big pauses, gaps or other sounds. Preferably one that the person you are trying to copy will show a little vocal range. Example files are in [here](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/coqui_tts/voices)
>
> Make sure the clip doesn't start or end with breathy sounds (breathing in/out etc).
>
> Using AI generated audio clips may introduce unwanted sounds as its already a copy/simulation of a voice, though, this would need testing.

# Credit

1. Thanks to the author **Kolja Beigel** for the repository [RealtimeTTS](https://github.com/KoljaB/RealtimeTTS) , I took some of its code for my project.
2. Thanks **[erew123](https://github.com/oobabooga/text-generation-webui/issues/4712#issuecomment-1825593734)** for the note about creating samples and the code to download the models
3. Thanks **lendot** for helping to fix the multiprocessing bug and adding code to use multiple samples for speakers

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "xtts-api-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "daswer123 <daswerq123@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/1c/b8/6d88021f90021ead5df7abce43291a43d346dcf32ccfe9281977a087d822/xtts_api_server-0.8.5.tar.gz",
    "platform": null,
    "description": "# A simple FastAPI Server to run XTTSv2\n\nThis project is inspired by [silero-api-server](https://github.com/ouoertheo/silero-api-server) and utilizes [XTTSv2](https://github.com/coqui-ai/TTS).\n\nThis server was created for [SillyTavern](https://github.com/SillyTavern/SillyTavern) but you can use it for your needs\n\nFeel free to make PRs or use the code for your own needs\n\nThere's a [google collab version](https://colab.research.google.com/drive/1b-X3q5miwYLVMuiH_T73odMO8cbtICEY?usp=sharing) you can use it if your computer is weak.\n\nIf you want to get a high-quality voice clone, I advise you to use [webui for fine-tuning xtts](https://github.com/daswer123/xtts-webui)\n\nIf you are looking for an option for normal XTTS use look here [https://github.com/daswer123/xtts-webui](https://github.com/daswer123/xtts-webui)\n\n## Changelog\n\nYou can keep track of all changes on the [release page](https://github.com/daswer123/xtts-api-server/releases)\n\n## TODO\n- [x] Make it possible to change generation parameters through the generation request and through a different endpoint\n\n## Installation\n\nSimple installation :\n\n```bash\npip install xtts-api-server\n```\n\nThis will install all the necessary dependencies, including a **CPU support only** version of PyTorch\n\nI recommend that you install the **GPU version** to improve processing speed ( up to 3 times faster )\n\n### Windows\n```bash\npython -m venv venv\nvenv\\Scripts\\activate\npip install xtts-api-server\npip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118\n```\n\n### Linux\n```bash\npython -m venv venv\nsource venv\\bin\\activate\npip install xtts-api-server\npip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118\n```\n\n### Manual\n```bash\n# Clone REPO\ngit clone https://github.com/daswer123/xtts-api-server\ncd xtts-api-server\n# Create virtual env\npython -m venv venv\nvenv/scripts/activate or source venv/bin/activate\n# Install deps\npip install -r requirements.txt\npip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118\n# Launch server\npython -m xtts_api_server\n \n```\n\n# Use Docker image with Docker Compose\n\nA Dockerfile is provided to build a Docker image, and a docker-compose.yml file is provided to run the server with Docker Compose as a service.\n\nYou can build the image with the following command:\n\n```bash\nmkdir xtts-api-server\ncd xtts-api-server\ndocker run -d daswer123/xtts-api-server\n\n```\n\nOR\n\n```bash\ncd docker\ndocker compose build\n```\n\nThen you can run the server with the following command:\n\n```bash\ndocker compose up # or with -d to run in background\n```\n\n## Starting Server\n\n`python -m xtts_api_server` will run on default ip and port (localhost:8020)\n\nUse the `--deepspeed` flag to process the result fast ( 2-3x acceleration )\n\n```\nusage: xtts_api_server [-h] [-hs HOST] [-p PORT] [-sf SPEAKER_FOLDER] [-o OUTPUT] [-t TUNNEL_URL] [-ms MODEL_SOURCE] [--listen] [--use-cache] [--lowvram] [--deepspeed] [--streaming-mode] [--stream-play-sync]\n\nRun XTTSv2 within a FastAPI application\n\noptions:\n  -h, --help show this help message and exit\n  -hs HOST, --host HOST\n  -p PORT, --port PORT\n  -d DEVICE, --device DEVICE `cpu` or `cuda`, you can specify which video card to use, for example, `cuda:0`\n  -sf SPEAKER_FOLDER, --speaker-folder The folder where you get the samples for tts\n  -o OUTPUT, --output Output folder\n  -mf MODELS_FOLDERS, --model-folder Folder where models for XTTS will be stored, finetuned models should be stored in this folder\n  -t TUNNEL_URL, --tunnel URL of tunnel used (e.g: ngrok, localtunnel)\n  -ms MODEL_SOURCE, --model-source [\"api\",\"apiManual\",\"local\"]\n  -v MODEL_VERSION, --version You can download the official model or your own model, official version you can find [here](https://huggingface.co/coqui/XTTS-v2/tree/main)  the model version name is the same as the branch name [v2.0.2,v2.0.3, main] etc. Or you can load your model, just put model in models folder\n  --listen Allows the server to be used outside the local computer, similar to -hs 0.0.0.0\n  --use-cache Enables caching of results, your results will be saved and if there will be a repeated request, you will get a file instead of generation\n  --lowvram The mode in which the model will be stored in RAM and when the processing will move to VRAM, the difference in speed is small\n  --deepspeed allows you to speed up processing by several times, automatically downloads the necessary libraries\n  --streaming-mode Enables streaming mode, currently has certain limitations, as described below.\n  --streaming-mode-improve Enables streaming mode, includes an improved streaming mode that consumes 2gb more VRAM and uses a better tokenizer and more context.\n  --stream-play-sync Additional flag for streaming mod that allows you to play all audio one at a time without interruption\n```\n\nYou can specify the path to the file as text, then the path counts and the file will be voiced\n\nYou can load your own model, for this you need to create a folder in models and load the model with configs, note in the folder should be 3 files `config.json` `vocab.json` `model.pth`\n\nIf you want your host to listen, use -hs 0.0.0.0 or use --listen\n\nThe -t or --tunnel flag is needed so that when you get speakers via get you get the correct link to hear the preview. More info [here](https://imgur.com/a/MvpFT59)\n\nModel-source defines in which format you want to use xtts:\n\n1. `local` - loads version 2.0.2 by default, but you can specify the version via the -v flag, model saves into the models folder and uses `XttsConfig` and `inference`.\n2. `apiManual` - loads version 2.0.2 by default, but you can specify the version via the -v flag, model saves into the models folder and uses the `tts_to_file` function from the TTS api\n3. `api` - will load the latest version of the model. The -v flag won't work.\n\nAll versions of the XTTSv2 model can be found [here](https://huggingface.co/coqui/XTTS-v2/tree/main)  the model version name is the same as the branch name [v2.0.2,v2.0.3, main] etc.\n\nThe first time you run or generate, you may need to confirm that you agree to use XTTS.\n\n# About Streaming mode\n\nStreaming mode allows you to get audio and play it back almost immediately. However, it has a number of limitations.\n\nYou can see how this mode works [here](https://www.youtube.com/watch?v=jHylNGQDDA0) and [here](https://www.youtube.com/watch?v=6vhrxuWcV3U)\n\nNow, about the limitations\n\n1. Can only be used on a local computer\n2. Playing audio from the your pc\n3. Does not work endpoint `tts_to_file` only `tts_to_audio` and it returns 1 second of silence.\n\nYou can specify the version of the XTTS model by using the `-v` flag.\n\nImproved streaming mode is suitable for complex languages such as Chinese, Japanese, Hindi or if you want the language engine to take more information into account when processing speech.\n\n`--stream-play-sync` flag - Allows you to play all messages in queue order, useful if you use group chats. In SillyTavern you need to turn off streaming to work correctly\n\n# API Docs\n\nAPI Docs can be accessed from [http://localhost:8020/docs](http://localhost:8020/docs)\n\n# How to add speaker\n\nBy default the `speakers` folder should appear in the folder, you need to put there the wav file with the voice sample, you can also create a folder and put there several voice samples, this will give more accurate results\n\n# Selecting Folder\n\nYou can change the folders for speakers and the folder for output via the API.\n\n# Note on creating samples for quality voice cloning\n\nThe following post is a quote by user [Material1276 from reddit](https://www.reddit.com/r/Oobabooga/comments/1807tsl/comment/ka5l8w9/?share_id=_5hh4KJTXrEOSP0hR0hCK&utm_content=2&utm_medium=android_app&utm_name=androidcss&utm_source=share&utm_term=1)\n\n> Some suggestions on making good samples\n>\n> Keep them about 7-9 seconds long. Longer isn't necessarily better.\n>\n> Make sure the audio is down sampled to a Mono, 22050Hz 16 Bit wav file. You will slow down processing by a large % and it seems cause poor quality results otherwise (based on a few tests). 24000Hz is the quality it outputs at anyway!\n>\n> Using the latest version of Audacity, select your clip and Tracks > Resample to 22050Hz, then Tracks > Mix > Stereo to Mono. and then File > Export Audio, saving it as a WAV of 22050Hz\n>\n> If you need to do any audio cleaning, do it before you compress it down to the above settings (Mono, 22050Hz, 16 Bit).\n>\n> Ensure the clip you use doesn't have background noises or music on e.g. lots of movies have quiet music when many of the actors are talking. Bad quality audio will have hiss that needs clearing up. The AI will pick this up, even if we don't, and to some degree, use it in the simulated voice to some extent, so clean audio is key!\n>\n> Try make your clip one of nice flowing speech, like the included example files. No big pauses, gaps or other sounds. Preferably one that the person you are trying to copy will show a little vocal range. Example files are in [here](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/coqui_tts/voices)\n>\n> Make sure the clip doesn't start or end with breathy sounds (breathing in/out etc).\n>\n> Using AI generated audio clips may introduce unwanted sounds as its already a copy/simulation of a voice, though, this would need testing.\n\n# Credit\n\n1. Thanks to the author **Kolja Beigel** for the repository [RealtimeTTS](https://github.com/KoljaB/RealtimeTTS) , I took some of its code for my project.\n2. Thanks **[erew123](https://github.com/oobabooga/text-generation-webui/issues/4712#issuecomment-1825593734)** for the note about creating samples and the code to download the models\n3. Thanks **lendot** for helping to fix the multiprocessing bug and adding code to use multiple samples for speakers\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple FastAPI server to host XTTSv2",
    "version": "0.8.5",
    "project_urls": {
        "Bug Tracker": "https://github.com/daswer123/xtts-api-server/issues",
        "Homepage": "https://github.com/daswer123/xtts-api-server"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ec3410439d212bd20f7ce331283c92df7cbb05a1e241a6916130d824ce13e378",
                "md5": "437f898f737fd027a439f38f6d224945",
                "sha256": "4a4c04b750d3b4521941b02a7baf8f78e436ace6cca3ab777ad8e2976446e555"
            },
            "downloads": -1,
            "filename": "xtts_api_server-0.8.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "437f898f737fd027a439f38f6d224945",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 148719,
            "upload_time": "2024-02-20T20:33:48",
            "upload_time_iso_8601": "2024-02-20T20:33:48.821190Z",
            "url": "https://files.pythonhosted.org/packages/ec/34/10439d212bd20f7ce331283c92df7cbb05a1e241a6916130d824ce13e378/xtts_api_server-0.8.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1cb86d88021f90021ead5df7abce43291a43d346dcf32ccfe9281977a087d822",
                "md5": "94fb574fd214c54e9713677d8f7733e0",
                "sha256": "03236a693714c63b0283001052fa0168b757aaed64955471b80d234864891e0a"
            },
            "downloads": -1,
            "filename": "xtts_api_server-0.8.5.tar.gz",
            "has_sig": false,
            "md5_digest": "94fb574fd214c54e9713677d8f7733e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1909831,
            "upload_time": "2024-02-20T20:33:51",
            "upload_time_iso_8601": "2024-02-20T20:33:51.256665Z",
            "url": "https://files.pythonhosted.org/packages/1c/b8/6d88021f90021ead5df7abce43291a43d346dcf32ccfe9281977a087d822/xtts_api_server-0.8.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-20 20:33:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "daswer123",
    "github_project": "xtts-api-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "xtts-api-server"
}
        
Elapsed time: 0.23226s