Skip to content

Latest commit

 

History

History
353 lines (271 loc) · 24.8 KB

README.md

File metadata and controls

353 lines (271 loc) · 24.8 KB
Raw

Icon

Pandrator, a GUI audiobook and dubbing generator with voice cloning and AI text optimisation

Tip

TL;DR:

  • Pandrator is not an AI model itself, but a GUI framework for Text-to-Speech projects. It can generate audiobooks and dubbing by leveraging several AI tools, custom workflows and algorithms. It works on Windows out of the box. It does work on Linux, but you have to perform a manual installation at the moment.
  • The easiest way to use it is to download one of the precompiled archives - simply unpack them and use the included launcher. See this table for their contents and sizes.
  • You can talk to me or share tips/workflows/ideas on the Discord server.

Quick Demonstration

This video shows the process of launching Pandrator, selecting a source file, starting generation, stopping it and previewing the saved file. It has not been sped up as it's intended to illustrate the real performance (you may skip the first 35s when the XTTS server is launching, and please remember to turn on the sound).

pandrator_showcase.mp4

And here you can see the dubbing workflow - from a YT video, through transcription, translation, speech generation to synchronisation.

pandrator_dubbing_demonstration.mp4

About Pandrator

Pandrator aspires to be easy to use and install - it has a one-click installer and a graphical user interface. It is a tool designed to perform two tasks:

  • transform text, PDF, EPUB and SRT files into spoken audio in multiple languages based chiefly on open source software run locally, including preprocessing to make the generated speech sound as natural as possible by, among other things, splitting the text into paragraphs, sentences and smaller logical text blocks (clauses), which the TTS models can process with minimal artifacts. Each sentence can be regenerated if the first attempt is not satisfacory. Voice cloning is possible for models that support it, and text can be additionally preprocessed using LLMs (to remove OCR artifacts or spell out things that the TTS models struggle with, like Roman numerals and abbreviations, for example),
  • generate dubbing either directly from a video file, including transcription (using WhisperX), or from an .srt file. It includes a complete workflow from a video file to a dubbed video file with subtitles - including translation using a variety of APIs and techniques to improve the quality of translation. Subdub, a companion app developed for this purpose, can also be used on its own.

It leverages the XTTS, Silero and VoiceCraft model(s) for text-to-speech conversion and voice cloning, enhanced by RVC_CLI for quality improvement and better voice cloning results, and NISQA for audio quality evaluation. Additionally, it incorporates Text Generation Webui's API for local LLM-based text pre-processing, enabling a wide range of text manipulations before audio generation.

Supported Languages

XTTS supports English (en), Spanish (es), French (fr), German (de), Italian (it), Portuguese (pt), Polish (pl), Turkish (tr), Russian (ru), Dutch (nl), Czech (cs), Arabic (ar), Chinese (zh-cn), Japanese (ja), Hungarian (hu) and Korean (ko). Silero supports

Note

Please note that Pandrator is still in an alpha stage and I'm not an experienced developer (I'm a noob, in fact), so the code is far from perfect in terms of optimisation, features and reliability. Please keep this in mind and contribute, if you want to help me make it better.

Samples

The samples were generated using the minimal settings - no LLM text processing, RVC or TTS evaluation, and no sentences were regenerated. Both XTTS and Silero generations were faster than playback speed.

pandrator_xtts_example.mp4
pandrator_voicecraft_example.mp4
pandrator_silero_example.mp4

Dubbing sample, including translation (video source):

pandrator_example_dubbing.mp4

Requirements

Hardware Requirements

Tool CPU Requirements GPU Requirements
XTTS A reasonably modern CPU with 4+ cores (for CPU-only generation) NVIDIA GPU with 4GB+ of VRAM for good performance
Silero Performs well on most CPUs regardless of core count N/A
VoiceCraft Usable on CPU, but generation will be slow NVIDIA GPU with 8GB+ of VRAM for acceleration (4GB VRAM requires kv cache disabled)

Dependencies

This project relies on several APIs and services (running locally) and libraries, notably:

Required

Optional

Installation

Self-contained packages

I've prepared packages (archives) that you can simply unpack - everything is preinstalled in its own portable conda environment. You can download them from here.

You can use the launcher to start Pandrator, update it and install new features.

Package Contents Unpacked Size
1 Pandrator and Silero 4GB
2 Pandrator and XTTS 14GB
3 Pandrator, XTTS, RVC, WhisperX (for dubbing) and XTTS fine-tuning 36GB

GUI Installer and Launcher (Windows)

pandrator_installer_launcher_KLoHrNDIps

Run pandrator_installer_launcher.exe with administrator priviliges. You will find it under Releases. The executable was created using pyinstaller from pandrator_installer_launcher.py in the repository.

The file may be flagged as a threat by antivirus software, so you may have to add it as an exception.

You can choose which TTS engines to install and whether to install the software that enables RVC voice cloning (RVC Python), dubbing (WhisperX) and XTTS fine-tuning (Easy XTTS Trainer). You may install more components later.

The Installer/Launcher performs the following tasks:

  1. Creates the Pandrator folder
  2. Installs necessary tools if not already present:
    • C++ Build Tools
    • Calibre
    • winget (if necessary)
  3. Installs Miniconda
  4. Clones the following repositories:
    • Pandrator
    • Subdub
    • XTTS API Server (if selected)
    • Silero API Server (if selected)
    • VoiceCraft API (if selected)
  5. Creates required conda environments
  6. Installs all necessary dependencies

Note: You can use the Installer/Launcher to launch Pandrator and all the tools at any moment.

If you want to perform the setup again, remove the Pandrator folder it created. Please allow at least a couple of minutes for the initial setup process to download models and install dependencies. Depending on the options you've chosen, it may take up to 30 minutes.

For additional functionality not yet included in the installer:

  • Install Text Generation Webui and remember to enable the API (add --api to CMD_FLAGS.txt in the main directory of the Webui before starting it).
  • Set up NISQA API for automatic evaluation of generations.

Please refer to the repositories linked under Dependencies for detailed installation instructions. Remember that the APIs must be running to make use of the functionalities they offer.

Manual Installation

Prerequisites

  • Git
  • Miniconda or Anaconda
  • Microsoft Visual C++ Build Tools
  • Calibre

Installation Steps

  1. Install dependencies:

    • Calibre: Download and install from https://calibre-ebook.com/download_windows
    • Microsoft Visual C++ Build Tools: 
      winget install --id Microsoft.VisualStudio.2022.BuildTools --override "--quiet --wait --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended" --accept-package-agreements --accept-source-agreements

  2. Clone the repositories:

    mkdir Pandrator
cd Pandrator
git clone https://github.com/lukaszliniewicz/Pandrator.git
git clone https://github.com/lukaszliniewicz/Subdub.git

  3. Create and activate a conda environment:

    conda create -n pandrator_installer python=3.10 -y
conda activate pandrator_installer

  4. Install Pandrator and Subdub requirements:

    cd Pandrator
pip install -r requirements.txt
cd ../Subdub
pip install -r requirements.txt
cd ..

  5. (Optional) Install XTTS:

    git clone https://github.com/daswer123/xtts-api-server.git
conda create -n xtts_api_server_installer python=3.10 -y
conda activate xtts_api_server_installer
pip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --extra-index-url https://download.pytorch.org/whl/cu118
pip install xtts-api-server

  6. (Optional) Install Silero:

    conda create -n silero_api_server_installer python=3.10 -y
conda activate silero_api_server_installer
pip install silero-api-server

  7. (Optional) Install RVC (Retrieval-based Voice Conversion):

    conda activate pandrator_installer
pip install pip==24
pip install rvc-python
pip install torch==2.1.1+cu118 torchaudio==2.1.1+cu118 --index-url https://download.pytorch.org/whl/cu118

  8. (Optional) Install WhisperX:

    conda create -n whisperx_installer python=3.10 -y
conda activate whisperx_installer
conda install git -c conda-forge -y
pip install torch==2.0.1 torchvision==0.15.2 torchaudio==2.0.2 --index-url https://download.pytorch.org/whl/cu118
conda install cudnn=8.9.7.29 -c conda-forge -y
conda install ffmpeg -c conda-forge -y
pip install git+https://github.com/m-bain/whisperx.git

  9. (Optional) Install XTTS Fine-tuning:

    git clone https://github.com/lukaszliniewicz/easy_xtts_trainer.git
conda create -n easy_xtts_trainer python=3.10 -y
conda activate easy_xtts_trainer
cd easy_xtts_trainer
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
cd ..

Running the Components

  1. Run Pandrator:

    conda activate pandrator_installer
cd Pandrator
python pandrator.py

  2. Run XTTS API Server (if installed):

    conda activate xtts_api_server_installer
python -m xtts_api_server

    Additional options:

    • For CPU only: Add --device cpu
    • For low VRAM: Add --lowvram
    • To use DeepSpeed: Add --deepspeed

  3. Run Silero API Server (if installed):

    conda activate silero_api_server_installer
python -m silero_api_server

Folder Structure

After installation, your folder structure should look like this:

Pandrator/
├── Pandrator/
├── Subdub/
├── xtts-api-server/ (if XTTS is installed)
├── easy_xtts_trainer/ (if XTTS Fine-tuning is installed)

For more detailed information on using specific components or troubleshooting, please refer to the documentation of each individual repository.

Quick Start Guide

Basic Usage: Audiobooks

If you don't want to use the additional features like RVC, you have everything you need in the Session tab.

Session

Either create a new session or load an existing one (select a folder in Outputs to do that).

File selection and preprocessing

Choose a .txt, .srt, .pdf, .epub, .mobi or .docx file. If you choose a PDF or EPUB file, a preview window will open with the extracted text. You may edit it (OCRed books often have poorly recognized text from the title page, for example) and check/add Chapter markers (they will be created automatically for EPUB files). For PDFs, you will have the option to crop the pages to remove headers/footers as well as to remove unneeded pages (like the title page or the table of contents). Files that contain a lot of text, regardless of format, can take a moment to finish preprocessing before generation begins. The GUI will freeze, but as long as there is processor activity, it's simply working.

Selecting the TTS Engline and the voice

  1. Select the TTS server you want to use - XTTS, Silero or VoiceCraft - and the language from the dropdown (VoiceCraft currently supports only English). XTTS is the recommended option.
  2. Choose the voice you want to use.
    1. XTTS, voices are short, 6-12s .wav files (22050hz sample rate, mono) stored in the tts_voices directory (Pandrator/Pandrator/tts_voices). You can upload and select them via the GUI. The XTTS model uses the audio to clone the voice. It doesn't matter what language the sample is in, you will be able to generate speech in all supported languages, but the quality will be best if you provide a sample in your target language. You may use the sample one in the repository or upload your own. Please make sure that the audio is between 6 and 12s, mono, and the sample rate is 22050hz. You may use a tool like Audacity to prepare the files. The less noise, the better. You may use a tool like Resemble AI for denoising and/or enhancement of your samples on Hugging Face.
    2. Silero offers a number of voices for each language it supports. It doesn't support voice cloning. Simply select a voice from the dropdown after choosing the language.
    3. VoiceCraft works similarly to XTTS in that it clones the voice from a .wav sample. However, it needs both a properly formatted .wav file (mono, 16000hz) and a .txt file with the transcription of what is said in the sample. The files must have the same name (apart from the extension, of course). You need to upload them to tts_voices/VoiceCraft and you will be able to select them in the GUI. Currently only English is supported. If you generate with a new voice for the first time, the server will perform the alignment procedure, so the first sentence will be generated with a delay. This won't happen when you use that voice again.

Output options

The default output format is .m4b. You can also select opus, mp3 or wav, choose a cover image and provide metadata.

Generation

Click on "Start Generation" to begin. You may stop and resume it later, or close the programme and load the session later.

Generated sentences

You can play back the generated sentences, also as a playlist, edit them (the text that will be used for regeneration), regenerate or remove individual ones. You can also mark them for regeneration. This is useful when you don't want to stop listening but work on all problematic sentences later. You can use the "m" key to mark the sentence that is currently playing or the right mouse button to mark both the current and the previous sentence (this can be useful if you're listening to the output and not looking at the screen). "Save Output" concatenates the sentences generated so far an encodes them as one file.

Dubbing

Pandrator offers a comprehensive workflow for generating dubbed videos from video files or existing subtitles. This includes transcription, translation, speech generation, and synchronization:

  1. Select a Video or SRT File:
    • Video File: Choose a video file. The audio will be extracted automatically, and transcription will be performed using WhisperX.
    • SRT File: Select an existing SRT subtitle file. In this case, you also need to specify the corresponding video file (unless you only want to translate the subtitles).
  2. Transcription (if using a video file):
    • Language: Select the language spoken in the original video.
    • Model: Choose a WhisperX model for transcription. Smaller models are faster, while larger ones provide higher accuracy. The large-v3 model provides the best results.
    • Pandrator will automatically run WhisperX to generate an SRT file containing the transcription.
  3. Translation (optional):
    • Enable Translation: Toggle this option to translate the subtitles.
    • Original and Target Languages: Select the original language of the subtitles and the language you want to translate them into.
    • Translation Model: Choose a translation model (e.g., haiku, sonnet, gpt-4o-mini, gpt-4o, deepl, local). With the exception of the local option, you have to set an API key in the API Keys tab. Sonnet provides the best results, but is the most expensive. You can translate 500,000 characters for free with DeepL. For local translation, you need to have Text Generation Webui set up and running with the model you want to use loaded.
    • Evaluation (optional): Enable this option to have the translation model evaluate and choose the better of two translation attempts for each subtitle (available only for LLMs, not DeepL).
  4. In order to generate speech, click on Generate Dubbing Audio. You will be able to edit/regenerate the sentences as in the Audiobook workflow. You can also choose to only transcribe the chosen video file or only translate a subtitle file.
  5. Synchronization: When you're happy with the generated audio, click on Add Dubbing to Video. The dubbing will be synchronised with the video, producing a dubbed video file with embedded subtitles.

General Audio Settings

  1. You can change the lenght of silence appended to the end of sentences and paragraphs.
  2. You can enable a fade-in and -out effect and set the duration.
  3. You can enable RVC. For this to work, you have to install RVC_Python. You can do this in the Installer/Launcher at any time. You need to select a model - an RVC model consists of two files. A .pth and an .index file. They need to have the same name (e.g. voicex.pth and voicex.index). For best results, use the same voice for XTTS. You can also fine tune the RVC options such as pitch.

General Text Pre-Processing Settings

  1. You can disable/enable splitting long sentences and set the max lenght a text fragment sent for TTS generation may have (enabled by default; it tries to split sentences whose lenght exceeds the max lenght value; it looks for punctuation marks (, ; : -) and chooses the one closest to the midpoint of the sentence; if there are no punctuation marks, it looks for conjunctions like "and"; it performs this operation twice as some sentence fragments may still be too long after just one split.
  2. You can disable/enable appending short sentences (to preceding or following sentences; disabled by default, may perhaps improve the flow as the lenght of text fragments sent to the model is more uniform).
  3. Remove diacritics (useful when generating a text that contains many foreign words or transliterations from foreign alphabets, e.g. Japanese). Do not enable this if you generate in a language that needs diacritics, like German or Polish! The pronounciation will be wrong then.

LLM Pre-processing

  • Enable LLM processing to use language models for preprocessing the text before sending it to the TTS API. For example, you may ask the LLM to remove OCR artifacts, spell out abbreviations, correct punctuation etc.
  • You can define up to three prompts for text optimization. Each prompt is sent to the LLM API separately, and the output of the last prompt is used for TTS generation.
  • For each prompt, you can enable/disable it, set the prompt text, choose the LLM model to use, and enable/disable evaluation (if enabled, the LLM API will be called twice for each prompt, and then again for the model to choose the better result).
  • Load the available LLM models using the "Load LLM Models" button in the Session tab.

RVC Quality Enhancement and Voice Cloning

  • Enable RVC to enhance the generated audio quality and apply voice cloning.
  • Select the RVC model file (.pth) and the corresponding index file using the "Select RVC Model" and "Select RVC Index" buttons in the Audio Processing tab.
  • When RVC is enabled, the generated audio will be processed using the selected RVC model and index before being saved.

NISQA TTS Evaluation

  • Enable TTS evaluation to assess the quality of the generated audio using the NISQA (Non-Intrusive Speech Quality Assessment) model.
  • Set the target MOS (Mean Opinion Score) value and the maximum number of attempts for each sentence.
  • When TTS evaluation is enabled, the generated audio will be evaluated using the NISQA model, and the best audio (based on the MOS score) will be chosen for each sentence.
  • If the target MOS value is not reached within the maximum number of attempts, the best audio generated so far will be used.

Contributing

Contributions, suggestions for improvements, and bug reports are most welcome!

Tips

  • You can find a collection of voice sample for example here. They are intended for use with ElevenLabs, so you will need to pick an 8-12s fragment and save it as 22050khz mono .wav usuing Audacity, for instance.
  • You can find a collection of RVC models for example here.

To-do

  • Add support for Surya for PDF OCR, layout and redeaing order detection, plus preprocessing of chapters, headers, footers, footnotes and tables.
  • Add support for StyleTTS2
  • Add importing/exporting settings.
  • Add support for proprietary APIs for text pre-processing and TTS generation.
  • Include OCR for PDFs.
  • Add support for a higher quality local TTS model, Tortoise.
  • Add option to record a voice sample and use it for TTS to the GUI.
  • Add support for chapter segmentation
  • Add all API servers to the setup script.
  • Add support for custom XTTS models
  • Add workflow to create dubbing from .srt subtitle files.
  • Include support for PDF files.
  • Integrate editing capabilities for processed sentences within the UI.
  • Add support for a lower quality but faster local TTS model that can easily run on CPU, e.g. Silero or Piper.
  • Add support for EPUB.