Upload 4 files

packages.txt

@@ -0,0 +1,7 @@
+wget
+git
+calibre
+ffmpeg
+libmecab-dev 
+mecab 
+mecab-ipadic

pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+name = "ebook2audiobook"
+version = "2.0.0"
+requires = ["setuptools >= 64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ebook2audiobook"
+version = "2.0.0"
+description = "Convert eBooks to audiobooks with chapters and metadata"
+authors = [
+    { name = "Drew Thomasson" }
+]
+dependencies = [
+    "beautifulsoup4",
+    "coqui-tts",
+    "cutlet",
+	"deep_translator",
+    "docker",
+    "ebooklib",
+    "gensim",
+    "gradio>=4.44",
+    "hangul-romanize",
+    "indic-nlp-library",
+	"iso-639",
+    "jieba",
+    "pydub",
+    "pypinyin",
+	"ray",
+	"transformers",
+    "translate",
+    "tqdm"
+]
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+scripts = { "ebook2audiobook" = "app:main" }
+
+[project.urls]
+"Homepage" = "https://github.com/DrewThomasson/ebook2audiobook"

readme/README_CN.md

@@ -0,0 +1,420 @@
+# 📚 ebook2audiobook
+
+使用Calibre和Coqui XTTS将电子书转换为包含章节和元数据的有声读物。支持可选的语音克隆和多种语言！
+> [!IMPORTANT]  
+**本工具仅适用于非DRM、合法获取的电子书。**  
+作者对软件的任何误用或由此产生的法律后果概不负责。  
+请负责任地使用本工具，并遵守所有适用法律。
+
+#### 🖥️ Web GUI界面
+![demo_web_gui](https://github.com/user-attachments/assets/85af88a7-05dd-4a29-91de-76a14cf5ef06)
+
+<details>
+  <summary>点击查看Web GUI的图片</summary>
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/b36c71cf-8e06-484c-a252-934e6b1d0c2f">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/c0dab57a-d2d4-4658-bff9-3842ec90cb40">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/0a99eeac-c521-4b21-8656-e064c1adc528">
+</details>
+
+## 🌟 特征
+
+- 📖 使用Calibre将电子书转换为文本格式。
+- 📚 将电子书拆分为章节，以获得有组织的音频。
+- 🎙️ 使用Coqui XTTS实现高质量的文本到语音转换。
+- 🗣️ 可选择使用您自己的语音文件进行语音克隆。
+- 🌍 支持多种语言（默认为英语）。
+- 🖥️ 基于4GB RAM运行。
+
+## 🛠️ 环境要求
+
+- Python 3.10
+- `coqui-tts` Python package
+- Calibre (用于电子书转换)
+- FFmpeg (用于有声读物创作)
+- Optional: 用于语音克隆的自定义语音文件
+
+### 🔧 安装说明
+
+1. **安装 Python 3.x** from [Python.org](https://www.python.org/downloads/).
+
+2. **安装 Calibre**:
+   - **Ubuntu**: `sudo apt-get install -y calibre`
+   - **macOS**: `brew install calibre`
+   - **Windows** (Admin Powershell): `choco install calibre`
+
+3. **安装 FFmpeg**:
+   - **Ubuntu**: `sudo apt-get install -y ffmpeg`
+   - **macOS**: `brew install ffmpeg`
+   - **Windows** (Admin Powershell): `choco install ffmpeg`
+
+4. **可选: Install Mecab** (非拉丁语言):
+   - **Ubuntu**: `sudo apt-get install -y mecab libmecab-dev mecab-ipadic-utf8`
+   - **macOS**: `brew install mecab`, `brew install mecab-ipadic`
+   - **Windows**: [mecab-website-to-install-manually](https://taku910.github.io/mecab/#download) (注：日语支持有限)
+
+5. **安装 Python packages**:
+   ```bash
+   pip install coqui-tts==0.24.2 pydub nltk beautifulsoup4 ebooklib tqdm gradio==4.44.0
+
+   python -m nltk.downloader punkt
+   python -m nltk.downloader punkt_tab
+   ```
+
+   **For non-Latin languages**:
+   ```bash
+   pip install mecab mecab-python3 unidic
+
+   python -m unidic download
+   ```
+
+## 🌐 支持的语言
+
+- **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)**
+- **Korean (ko)**
+
+在无头模式下运行脚本时指定语言代码。
+## 🚀 使用
+
+### 🖥️ 启动Gradio Web界面
+
+1. **运行脚本**:
+   ```bash
+   python app.py
+   ```
+
+2. **打开web应用程序**: 点击终端中提供的URL访问web应用程序并转换电子书.
+3. **公共链接**: 在末尾添加“--share True”，如下所示：`python app.py--share True`
+- **[更多参数]**: 使用`-h`参数，如`python app.py-h`
+
+### 📝 基本的无头用法
+
+```bash
+python app.py --headless True --ebook <path_to_ebook_file> --voice [path_to_voice_file] --language [language_code]
+```
+
+- **<path_to_ebook_file>**: 电子书文件的路径。
+- **[path_to_voice_file]**: 指定转换的语音文件，可选。
+- **[language_code]**: 指定转换的语言，可选。
+- **[更多参数]**: 使用 `-h` 参数，如 `python app.py -h`
+
+### 🧩 自定义XTTS模型的无头用法
+
+```bash
+python app.py --headless True --use_custom_model True --ebook <ebook_file_path> --voice <target_voice_file_path> --language <language> --custom_model <custom_model_path> --custom_config <custom_config_path> --custom_vocab <custom_vocab_path>
+```
+
+- **<ebook_file_path>**: 电子书文件的路径。
+- **<target_voice_file_path>**: 指定转换的语音文件，可选。
+- **<language>**: 指定转换的语言，可选。
+- **<custom_model_path>**: `model.pth`的路径。
+- **<custom_config_path>**: `config.json`的路径。
+- **<custom_vocab_path>**: `vocab.json`的路径。
+- **[更多参数]**: 使用 `-h` 参数，如 `python app.py -h`
+
+### 🧩 自定义XTTS Fine-Tune 模型的无头用法 🌐
+
+```bash
+python app.py --headless True --use_custom_model True --ebook <ebook_file_path> --voice <target_voice_file_path> --language <language> --custom_model_url <custom_model_URL_ZIP_path>
+```
+
+- **<ebook_file_path>**: 电子书文件的路径。
+- **<target_voice_file_path>**: 指定转换的语音文件，可选。
+- **<language>**: 指定转换的语言，可选。
+- **<custom_model_URL_ZIP_path>**: 模型文件夹压缩包的URL路径。例如
+ [xtts_David_Attenborough_fine_tune](https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/tree/main) `https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true`
+- **[更多参数]**: 使用 `-h` 参数，如 `python app.py -h`
+
+### 🔍 详细指南，包括所有要使用的参数列表
+```bash
+python app.py -h
+```
+- 这将输出以下内容:
+```bash
+usage: app.py [-h] [--share] [--headless [HEADLESS]] [--ebook EBOOK]
+              [--ebooks_dir [EBOOKS_DIR]] [--voice VOICE] [--language LANGUAGE]
+              [--device {cpu,gpu}] [--use_custom_model] [--custom_model CUSTOM_MODEL]
+              [--custom_config CUSTOM_CONFIG] [--custom_vocab CUSTOM_VOCAB]
+              [--custom_model_url CUSTOM_MODEL_URL] [--temperature TEMPERATURE]
+              [--length_penalty LENGTH_PENALTY]
+              [--repetition_penalty REPETITION_PENALTY] [--top_k TOP_K] [--top_p TOP_P]
+              [--speed SPEED] [--enable_text_splitting]
+
+Convert eBooks to Audiobooks using a Text-to-Speech model. You can either launch the Gradio interface or run the script in headless mode for direct conversion.
+
+options:
+  -h, --help            show this help message and exit
+  --share               Enable a public shareable Gradio link. Defaults to False.
+  --headless [HEADLESS]
+                        Run in headless mode. Defaults to True if the flag is present without a value, False otherwise.
+  --ebook EBOOK         Path to the ebook file for conversion. Required in headless mode.
+  --ebooks_dir [EBOOKS_DIR]
+                        Path to the directory containing ebooks for batch conversion. Defaults to './ebooks' if 'default' value is provided.
+  --voice VOICE         Path to the target voice file for TTS. Optional, uses a default voice if not provided.
+  --language LANGUAGE   Language for the audiobook conversion. Options: en, es, fr, de, it, pt, pl, tr, ru, nl, cs, ar, zh-cn, ja, hu, ko. Defaults to English (en).
+  --device {cpu,gpu}    Type of processor unit for the audiobook conversion. Defaults to cpu.
+  --use_custom_model    Use a custom TTS model. Defaults to False. Must be True to use custom models.
+  --custom_model CUSTOM_MODEL
+                        Path to the custom model file (.pth). Required if using a custom model.
+  --custom_config CUSTOM_CONFIG
+                        Path to the custom config file (config.json). Required if using a custom model.
+  --custom_vocab CUSTOM_VOCAB
+                        Path to the custom vocab file (vocab.json). Required if using a custom model.
+  --custom_model_url CUSTOM_MODEL_URL
+                        URL to download the custom model as a zip file. Optional, but will be used if provided. Examples include David Attenborough's model: 'https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true'. More XTTS fine-tunes can be found on my Hugging Face at 'https://huggingface.co/drewThomasson'.
+  --temperature TEMPERATURE
+                        Temperature for the model. Defaults to 0.65. Higher temperatures lead to more creative outputs.
+  --length_penalty LENGTH_PENALTY
+                        A length penalty applied to the autoregressive decoder. Defaults to 1.0. Not applied to custom models.
+  --repetition_penalty REPETITION_PENALTY
+                        A penalty that prevents the autoregressive decoder from repeating itself. Defaults to 2.0.
+  --top_k TOP_K         Top-k sampling. Lower values mean more likely outputs and increased audio generation speed. Defaults to 50.
+  --top_p TOP_P         Top-p sampling. Lower values mean more likely outputs and increased audio generation speed. Defaults to 0.8.
+  --speed SPEED         Speed factor for the speech generation. Defaults to 1.0.
+  --enable_text_splitting
+                        Enable splitting text into sentences. Defaults to False.
+
+Example usage:    
+Windows:
+    headless:
+    ./ebook2audiobook.cmd --headless --ebook 'path_to_ebook' --voice 'path_to_voice' --language en --use_custom_model --custom_model 'model.zip' --custom_config config.json --custom_vocab vocab.json
+    Graphic Interface:
+    ./ebook2audiobook.cmd
+Linux/Mac:
+    headless:
+    ./ebook2audiobook.sh --headless --ebook 'path_to_ebook' --voice 'path_to_voice' --language en --use_custom_model --custom_model 'model.zip' --custom_config config.json --custom_vocab vocab.json
+    Graphic Interface:
+    ./ebook2audiobook.sh
+```
+
+<details>
+  <summary>⚠️ 遗留的旧版使用说明</summary>
+
+## 🚀 使用
+
+----> `ebook2audiobookXTTS/legacy/`
+
+### 🖥️ Web界面
+
+1. **运行脚本**:
+   ```bash
+   python custom_model_ebook2audiobookXTTS_gradio.py
+   ```
+
+2. **打开web应用程序**: 单击终端中提供的URL以访问web应用程序并转换电子书。
+
+### 📝 基础用法
+
+```bash
+python ebook2audiobook.py <path_to_ebook_file> [path_to_voice_file] [language_code]
+```
+
+- **<path_to_ebook_file>**: 电子书文件的路径。
+- **[path_to_voice_file]**: 指定转换的语音文件，可选。
+- **[language_code]**: 指定转换的语言，可选。
+
+### 🧩 自定义XTTS模型
+
+```bash
+python custom_model_ebook2audiobookXTTS.py <ebook_file_path> <target_voice_file_path> <language> <custom_model_path> <custom_config_path> <custom_vocab_path>
+```
+
+- **<ebook_file_path>**: 电子书文件的路径。
+- **<target_voice_file_path>**: 指定转换的语音文件，可选。
+- **<language>**: 指定转换的语言，可选。
+- **<custom_model_path>**: `model.pth`的路径。
+- **<custom_config_path>**: `config.json`的路径。
+- **<custom_vocab_path>**: `vocab.json`的路径。
+</details>
+
+### 🐳 使用Docker
+
+您还可以使用Docker运行电子书到有声读物的转换器。这种方法确保了不同环境之间的一致性，并简化了设置。
+
+#### 🚀 运行Docker容器
+
+要运行Docker容器并启动Gradio接口，请使用以下命令：
+
+ -仅使用CPU运行
+```powershell
+docker run -it --rm -p 7860:7860 --platform=linux/amd64 athomasson2/ebook2audiobookxtts:huggingface python app.py
+```
+ -使用GPU加速运行（仅限Nvida显卡）
+```powershell
+docker run -it --rm --gpus all -p 7860:7860 --platform=linux/amd64 athomasson2/ebook2audiobookxtts:huggingface python app.py
+```
+
+此命令将启动7860端口上的Gradio接口(localhost:7860)
+- 对于更多选项，如以无头模式运行docker或公开gradio链接，请在docker启动命令中的`app.py`后添加`-h`参数
+<details>
+  <summary><strong>在无头模式下使用docker或使用额外参数修改任何内容的示例+完整指南</strong></summary>
+
+## 在无头模式下使用docker的示例
+
+首先是docker pull的最新版本
+```bash
+docker pull athomasson2/ebook2audiobookxtts:huggingface
+```
+
+- 在运行此命令之前，您需要在当前目录中创建一个名为“input folder”的目录，该目录将被链接，您可以在此处放置docker镜像的输入文件
+```bash
+mkdir input-folder && mkdir Audiobooks
+```
+
+- 运行下面命令需要将 **YOUR_INPUT_FILE.TXT** 替换为您创建的输入文件的名称
+
+```bash
+docker run -it --rm \
+    -v $(pwd)/input-folder:/home/user/app/input_folder \
+    -v $(pwd)/Audiobooks:/home/user/app/Audiobooks \
+    --platform linux/amd64 \
+    athomasson2/ebook2audiobookxtts:huggingface \
+    python app.py --headless True --ebook /home/user/app/input_folder/YOUR_INPUT_FILE.TXT
+```
+
+- 应该就是这样了！
+
+- 输出Audiobooks将在Audiobook文件夹中找到，该文件夹也位于您运行此docker命令的本地目录中
+
+
+## 要获取此程序中其他参数的帮助命令，可以运行以下命令
+
+```bash
+docker run -it --rm \
+    --platform linux/amd64 \
+    athomasson2/ebook2audiobookxtts:huggingface \
+    python app.py -h
+
+```
+
+
+这将输出以下内容
+
+```bash
+user/app/ebook2audiobookXTTS/input-folder -v $(pwd)/Audiobooks:/home/user/app/ebook2audiobookXTTS/Audiobooks --memory="4g" --network none --platform linux/amd64 athomasson2/ebook2audiobookxtts:huggingface python app.py -h
+starting...
+usage: app.py [-h] [--share SHARE] [--headless HEADLESS] [--ebook EBOOK] [--voice VOICE]
+              [--language LANGUAGE] [--use_custom_model USE_CUSTOM_MODEL]
+              [--custom_model CUSTOM_MODEL] [--custom_config CUSTOM_CONFIG]
+              [--custom_vocab CUSTOM_VOCAB] [--custom_model_url CUSTOM_MODEL_URL]
+              [--temperature TEMPERATURE] [--length_penalty LENGTH_PENALTY]
+              [--repetition_penalty REPETITION_PENALTY] [--top_k TOP_K] [--top_p TOP_P]
+              [--speed SPEED] [--enable_text_splitting ENABLE_TEXT_SPLITTING]
+
+Convert eBooks to Audiobooks using a Text-to-Speech model. You can either launch the
+Gradio interface or run the script in headless mode for direct conversion.
+
+options:
+  -h, --help            show this help message and exit
+  --share SHARE         Set to True to enable a public shareable Gradio link. Defaults
+                        to False.
+  --headless HEADLESS   Set to True to run in headless mode without the Gradio
+                        interface. Defaults to False.
+  --ebook EBOOK         Path to the ebook file for conversion. Required in headless
+                        mode.
+  --voice VOICE         Path to the target voice file for TTS. Optional, uses a default
+                        voice if not provided.
+  --language LANGUAGE   Language for the audiobook conversion. Options: en, es, fr, de,
+                        it, pt, pl, tr, ru, nl, cs, ar, zh-cn, ja, hu, ko. Defaults to
+                        English (en).
+  --use_custom_model USE_CUSTOM_MODEL
+                        Set to True to use a custom TTS model. Defaults to False. Must
+                        be True to use custom models, otherwise you'll get an error.
+  --custom_model CUSTOM_MODEL
+                        Path to the custom model file (.pth). Required if using a custom
+                        model.
+  --custom_config CUSTOM_CONFIG
+                        Path to the custom config file (config.json). Required if using
+                        a custom model.
+  --custom_vocab CUSTOM_VOCAB
+                        Path to the custom vocab file (vocab.json). Required if using a
+                        custom model.
+  --custom_model_url CUSTOM_MODEL_URL
+                        URL to download the custom model as a zip file. Optional, but
+                        will be used if provided. Examples include David Attenborough's
+                        model: 'https://huggingface.co/drewThomasson/xtts_David_Attenbor
+                        ough_fine_tune/resolve/main/Finished_model_files.zip?download=tr
+                        ue'. More XTTS fine-tunes can be found on my Hugging Face at
+                        'https://huggingface.co/drewThomasson'.
+  --temperature TEMPERATURE
+                        Temperature for the model. Defaults to 0.65. Higher Tempatures
+                        will lead to more creative outputs IE: more Hallucinations.
+                        Lower Tempatures will be more monotone outputs IE: less
+                        Hallucinations.
+  --length_penalty LENGTH_PENALTY
+                        A length penalty applied to the autoregressive decoder. Defaults
+                        to 1.0. Not applied to custom models.
+  --repetition_penalty REPETITION_PENALTY
+                        A penalty that prevents the autoregressive decoder from
+                        repeating itself. Defaults to 2.0.
+  --top_k TOP_K         Top-k sampling. Lower values mean more likely outputs and
+                        increased audio generation speed. Defaults to 50.
+  --top_p TOP_P         Top-p sampling. Lower values mean more likely outputs and
+                        increased audio generation speed. Defaults to 0.8.
+  --speed SPEED         Speed factor for the speech generation. IE: How fast the
+                        Narrerator will speak. Defaults to 1.0.
+  --enable_text_splitting ENABLE_TEXT_SPLITTING
+                        Enable splitting text into sentences. Defaults to True.
+
+Example: python script.py --headless --ebook path_to_ebook --voice path_to_voice
+--language en --use_custom_model True --custom_model model.pth --custom_config
+config.json --custom_vocab vocab.json
+```
+</details>
+
+#### 🖥️ Docker图形用户界面
+![demo_web_gui](https://github.com/user-attachments/assets/85af88a7-05dd-4a29-91de-76a14cf5ef06)
+
+<details>
+  <summary>点击查看Web界面的图片</summary>
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/b36c71cf-8e06-484c-a252-934e6b1d0c2f">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/c0dab57a-d2d4-4658-bff9-3842ec90cb40">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/0a99eeac-c521-4b21-8656-e064c1adc528">
+</details>
+
+### 🛠️ 关于自定义XTTS模型
+
+为更好地处理特定声音而构建的模型。查看我的Hugging Face页面 [here](https://huggingface.co/drewThomasson).
+
+要使用自定义模型，请粘贴“Finished_model_files.zip”文件的链接，如下所示：
+
+[David Attenborough fine tuned Finished_model_files.zip](https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true)
+
+
+
+
+更多详细信息请访问 [Dockerfile Hub Page]([https://github.com/DrewThomasson/ebook2audiobookXTTS](https://hub.docker.com/repository/docker/athomasson2/ebook2audiobookxtts/general)).
+
+## 🌐 微调XTTS模型
+
+要查找已经过微调的XTTS型号，请访问[Hugging Face](https://huggingface.co/drewThomasson) 🌐. 模型搜索需要包含“xtts fine tune”的关键字。
+
+## 🎥 Demos
+
+https://github.com/user-attachments/assets/8486603c-38b1-43ce-9639-73757dfb1031
+
+## 🤗 [Huggingface space demo](https://huggingface.co/spaces/drewThomasson/ebook2audiobookXTTS)
+- Huggingface空间正在空闲cpu层上运行，所以预计会非常慢或超时，哈哈，只是不要给它大文件
+- 最好复制空间或在本地运行。
+## 📚 支持的电子书格式
+
+- `.epub`, `.pdf`, `.mobi`, `.txt`, `.html`, `.rtf`, `.chm`, `.lit`, `.pdb`, `.fb2`, `.odt`, `.cbr`, `.cbz`, `.prc`, `.lrf`, `.pml`, `.snb`, `.cbc`, `.rb`, `.tcr`
+- **最佳结果**: `.epub` 或者 `.mobi`格式可以进行自动章节检测。
+
+## 📂 输出
+
+- 创建一个包含元数据和章节的“.m4b”文件。
+- **例子**: ![Example](https://github.com/DrewThomasson/VoxNovel/blob/dc5197dff97252fa44c391dc0596902d71278a88/readme_files/example_in_app.jpeg)

readme/README_RU.md

@@ -0,0 +1,391 @@
+# 📚 ebook2audiobook
+
+Конвертация электронных книг в аудиокниги с сохранением глав и метаданных, используются механизмы Calibre и XTTS. Поддерживаются опциональное клонирование голоса и множественные языки!
+> [!IMPORTANT]
+**Этот инструмент предназначен для использования только с электронными книгами, не защищёнными DRM, приобретёнными законным путём.**  
+Авторы не несут ответственности за неправильное использование этого программного обеспечения или любые юридические последствия, связанные с его использованием.  
+Используйте этот инструмент ответственно и в соответствии с действующим законодательством.
+
+
+#### 🖥️ Web-интерфейс
+![demo_web_gui](https://github.com/user-attachments/assets/85af88a7-05dd-4a29-91de-76a14cf5ef06)
+
+<details>
+  <summary>Больше картинок Web-интерфейса</summary>
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/b36c71cf-8e06-484c-a252-934e6b1d0c2f">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/c0dab57a-d2d4-4658-bff9-3842ec90cb40">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/0a99eeac-c521-4b21-8656-e064c1adc528">
+</details>
+
+## README.md
+- en [English](README.md)
+- zh_CN [简体中文](readme/README_CN.md)
+- ru [Русский](readme/README_RU.md)
+
+
+## 🌟 Возможности
+
+- 📖 Преобразование электронных книг в текстовой формат при помощи Calibre.
+- 📚 Разбитие электронных книг по главам для аудиоформата.
+- 🎙️ Высококачественное преобразование текста в голос при помощи Coqui XTTS.
+- 🗣️ Опциональное клонирование голоса на основе вашего голосового файла.
+- 🌍 Многоязыковая поддержка (Английский по умолчанию).
+- 🖥️ Для работы достаточно всего 4 Гб ОЗУ.
+
+## 🤗 [Демонстрация на Huggingface](https://huggingface.co/spaces/drewThomasson/ebook2audiobookXTTS)
+- Пространство на Huggingface работает на бесплатном процессорном уровне, посему не стоит ожидать от него высокой скорости обработки или отсутствие сообщений о таймаутах. Даже и не пытайтесь обработать большие файлы.
+- Лучше всего скопировать пространство или запустить приложение локально.
+
+## Бесплатный Google Colab [![Бесплатный Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/DrewThomasson/ebook2audiobookXTTS/blob/main/Notebooks/colab_ebook2audiobookxtts.ipynb)
+
+
+## 🛠️ Требования
+
+- Python 3.10
+- `coqui-tts` Python package
+- Calibre (для конвертации электронных книг)
+- FFmpeg (для создания аудиокниг)
+- Опционально: собственный файл с голосом для начитки
+
+
+### 🔧 Установка
+
+1. **Установить Python 3.x** из [Python.org](https://www.python.org/downloads/).
+
+2. **Установить Calibre**:
+   - **Ubuntu**: `sudo apt-get install -y calibre`
+   - **macOS**: `brew install calibre`
+   - **Windows** (Admin Powershell): `choco install calibre`
+
+3. **Установить FFmpeg**:
+   - **Ubuntu**: `sudo apt-get install -y ffmpeg`
+   - **macOS**: `brew install ffmpeg`
+   - **Windows** (Admin Powershell): `choco install ffmpeg`
+
+4. **Опционально: установить Mecab** (для не латинских языков):
+   - **Ubuntu**: `sudo apt-get install -y mecab libmecab-dev mecab-ipadic-utf8`
+   - **macOS**: `brew install mecab`, `brew install mecab-ipadic`
+   - **Windows**: [mecab-website-to-install-manually](https://taku910.github.io/mecab/#download) (Замечание: Японский язык поддерживается ограничено)
+
+5. **Установить пакеты Python**:
+   ```bash
+   pip install coqui-tts==0.24.2 pydub nltk beautifulsoup4 ebooklib tqdm gradio==4.44.0
+   
+   python -m nltk.downloader punkt
+   python -m nltk.downloader punkt_tab
+   ```
+
+   **Для не латинских языков**:
+   ```bash
+   pip install mecab mecab-python3 unidic
+   
+   python -m unidic download
+   ```
+
+## 🌐 Поддерживаемые языки
+
+- **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)**
+- **Korean (ko)**
+
+Указывайте код нужного языка при запуске в безинтерфейсном режиме (в коммандной строке).
+## 🚀 Использование
+
+### 🖥️ Запуск Gradio Web-интерфейса
+
+1. **Запустите скрипт**:
+   ```bash
+   python app.py
+   ```
+
+2. **Откройте Web-приложение**: нажмите на ссылку появившуся в окне терминала для доступа к Web-приложению и конвертированию электронных книг.
+3. **Для доступа из сети**: добавьте `--share True` в конец команды, наподобие: `python app.py --share True`
+- **[Для большего количества параметров]**: используйте `-h` ключ, наподобие: `python app.py -h`
+
+### 📝 Типовое использование в безинтерфейсном режиме
+
+```bash
+python app.py --headless True --ebook <path_to_ebook_file> --voice [path_to_voice_file] --language [language_code]
+```
+
+- **<path_to_ebook_file>**: путь к файлу электронной книги.
+- **[path_to_voice_file]**: путь к примеру голоса, для опционального клонирования голоса для начитки.
+- **[language_code]**: по желанию, выбрать язык.
+- **[Для большего количества парамтеров]**: используйте `-h` ключ, наподобие `python app.py -h`
+
+### 🧩 Безинтерфейсное использование с индивиуальной моделью XTTS
+
+```bash
+python app.py --headless True --use_custom_model True --ebook <ebook_file_path> --voice <target_voice_file_path> --language <language> --custom_model <custom_model_path> --custom_config <custom_config_path> --custom_vocab <custom_vocab_path>
+```
+
+- **<ebook_file_path>**: путь к файлу электронной книги.
+- **<target_voice_file_path>**: путь к примеру голоса, для опционального клонирования.
+- **\<language>**: по желанию, выбрать язык.
+- **<custom_model_path>**: путь к `model.pth`.
+- **<custom_config_path>**: путь к `config.json`.
+- **<custom_vocab_path>**: путь к `vocab.json`.
+- **[Для большего количества парамтеров]**: используйте `-h` ключ, наподобие `python app.py -h`
+
+
+### 🧩 Безинтерфейсое использование с индивидуальной моделью XTTS со ссылкой на Zip-архив содержащий модель тонкой настройки XTTS 🌐
+
+```bash
+python app.py --headless True --use_custom_model True --ebook <ebook_file_path> --voice <target_voice_file_path> --language <language> --custom_model_url <custom_model_URL_ZIP_path>
+```
+
+- **<ebook_file_path>**: путь к файлу eBook.
+- **<target_voice_file_path>**: путь к примеру голоса, для опционального клонирования.
+- **\<language>**: по желанию, выбрать язык.
+- **<custom_model_URL_ZIP_path>**: путь в виде URL к архиву формата zip с папкой модели. Например, [xtts_David_Attenborough_fine_tune](https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/tree/main) `https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true`
+- Для индивидуальной модели все равно потребуется референсный аудиофайл с голосом:
+[референсный аудиофайл с голосом David Attenborough](https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/blob/main/ref.wav)
+- **[Для большего количества парамтеров]**: используйте `-h` ключ, наподобие `python app.py -h`
+
+### 🔍 Для подробного списка всех параметров используйте
+```bash
+python app.py -h
+```
+- Будет выведен примерно следующий сприсок ключей:
+```bash
+использование: app.py [-h] [--share SHARE] [--headless HEADLESS] [--ebook EBOOK] [--voice VOICE]
+              [--language LANGUAGE] [--use_custom_model USE_CUSTOM_MODEL]
+              [--custom_model CUSTOM_MODEL] [--custom_config CUSTOM_CONFIG]
+              [--custom_vocab CUSTOM_VOCAB] [--custom_model_url CUSTOM_MODEL_URL]
+              [--temperature TEMPERATURE] [--length_penalty LENGTH_PENALTY]
+              [--repetition_penalty REPETITION_PENALTY] [--top_k TOP_K] [--top_p TOP_P]
+              [--speed SPEED] [--enable_text_splitting ENABLE_TEXT_SPLITTING]
+
+Преобразование электронных книг в аудиокниги с использованием модели Text-to-Speech (TTS). Вы можете либо использовать
+интерфейс Gradio, либо запустить скрипт в безинтерфейсном режиме (командная строка) для прямого конвертирования.
+
+опции:
+  -h, --help            Отобразить этот список и выйти
+  --share SHARE         Установить в True для включения публичного доступа к Web-интерфейсу Gradio. По умолчанию False.
+  --headless HEADLESS   Установить в True для использования безинтерфейсного режима. По умолчанию False.
+  --ebook EBOOK         Путь к электронной книге для конвертации. Необходимо для безинтерфейсного режима.
+  --voice VOICE         Путь к целевому голосовому файлу для TTS (текст-в-голос). Опционально, используется голос по умолчанию, если путь не указан.
+  --language LANGUAGE   Язык для конвертации в аудиокнигу. Варианты: en, es, fr, de,
+                        it, pt, pl, tr, ru, nl, cs, ar, zh-cn, ja, hu, ko. По умолчанию English (en).
+  --use_custom_model USE_CUSTOM_MODEL
+                        Установить в True для использования индивидуальной модели TTS. По умолчанию False. Необходимо переключить в
+                        True для использования индивидулаьной модели, в противном случае возникнет ошибка.
+  --custom_model CUSTOM_MODEL
+                        Путь к файлу индивидуальной модели (.pth). Требуется, если используется индивидуальная модель.
+  --custom_config CUSTOM_CONFIG
+                        Путь к конфигурационнмоу файлу индивидуальной модели (config.json). Требуется, если используется индивидуальная модель.
+  --custom_vocab CUSTOM_VOCAB
+                        Путь к словарю индивидуальной модели (vocab.json). Требуется, если используется индивидуальная модель.
+  --custom_model_url CUSTOM_MODEL_URL
+                        URL для скачивания индивидуальной модели в виде zip-архива. Опционально, но если указано, то будет использовано.
+                        Примеры включающие модель David Attenborough: 'https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true'. Больше точно-настроенных моделей XTTS можно найти на Hugging Face 'https://huggingface.co/drewThomasson'.
+  --temperature TEMPERATURE
+                        Температура для модели. По умолчанию 0.65. Чем выше температура, тем более креативным будет синтез голоса, с большим наваждением. Чем меньше, тем более монотонным и спокойным.
+  --length_penalty LENGTH_PENALTY
+                        Ограничение длинны авторегрессионного декодреа. По умолчанию 1.0. Не применяется к индивидуальным моделям.
+  --repetition_penalty REPETITION_PENALTY
+                        Ограниечение предотвращающее повторение авторегрессивным декодером за собой. По умолчанию 2.0
+  --top_k TOP_K         Сэмплирование Top-k. Меньшее значние приводит к более вероятностному выводу и ускоряют генерацию аудио. По умолчанию 50.
+  --top_p TOP_P         Сэмплирование Top-p. Меньшее значние приводит к более вероятностному выводу и ускоряют генерацию аудио. По у��олчанию 0.8.
+  --speed SPEED         Фактор скорости начитки. Чем больше значение, тем быстрее диктор будет читать текст. По умолчанию 1.0.
+  --enable_text_splitting ENABLE_TEXT_SPLITTING
+                        Включает разбиение текста на предложения. По умолчаниею True.
+
+Пример: python script.py --headless --ebook path_to_ebook --voice path_to_voice --language en --use_custom_model True --custom_model model.pth --custom_config config.json --custom_vocab vocab.json
+```
+
+
+
+### 🐳 Использование Docker
+
+Помимо всего прочего, можно использовать Docker для использования конвертера электронных книг в аудиокниги. Этот метод обеспечивает согласованность в различных средах и упрощает настройку.
+
+#### 🚀 Запуск контейнера Docker
+
+Для запуска контейнера Docker и интерфейса Gradio используйте следующую команду:
+
+ -Запуск с использованием только CPU (процессора)
+```powershell
+docker run -it --rm -p 7860:7860 --platform=linux/amd64 athomasson2/ebook2audiobookxtts:huggingface python app.py
+```
+ -Запуск с использованием ускорения на GPU (графической карты), поддерживаются только видеокарты NVIDIA
+```powershell
+docker run -it --rm --gpus all -p 7860:7860 --platform=linux/amd64 athomasson2/ebook2audiobookxtts:huggingface python app.py
+```
+
+Эта команда запускает интерфейс Gradio на порту 7860. (localhost:7860)
+- Для получения большей информации о доступных командах в безинтерфейсном режиме или предоставление доступа к Gradio в сети, используйте ключ `-h` после имени команды `app.py` в терминале Docker
+<details>
+  <summary><strong>Пример использования Docker в безинтерфейсном режиме или модификаций параметров + полный гид</strong></summary>
+   
+## Пример использования Docker в безинтерфейсном режиме
+
+- Сперва необходимо получить свежий контейнер с приложением
+```bash 
+docker pull athomasson2/ebook2audiobookxtts:huggingface
+```
+
+- Прежде чем запустить команду на исполнение, необходимо создать директрую с именем "input-folder" в текущей папке, которая будет подтянута к использованию. В эту папку необходимо помещать файлы, которые будут видны образу Docker
+```bash
+mkdir input-folder && mkdir Audiobooks
+```
+
+- В команде ниже замените **YOUR_INPUT_FILE.TXT** именем файла, который необходимо начитать 
+
+```bash
+docker run -it --rm \
+    -v $(pwd)/input-folder:/home/user/app/input_folder \
+    -v $(pwd)/Audiobooks:/home/user/app/Audiobooks \
+    --platform linux/amd64 \
+    athomasson2/ebook2audiobookxtts:huggingface \
+    python app.py --headless True --ebook /home/user/app/input_folder/YOUR_INPUT_FILE.TXT
+```
+
+- И на этом это все! 
+
+- Начитанная аудиокнига будет сформирована в папке Audiobooks, которая будет создана в вашей локальной директории, в которой был осуществлен запуск Docker
+
+
+## Для получения помощи по параметрам, необходимо запустить следующую команду 
+
+```bash
+docker run -it --rm \
+    --platform linux/amd64 \
+    athomasson2/ebook2audiobookxtts:huggingface \
+    python app.py -h
+
+```
+
+
+и вывод будет следующим
+
+```bash
+user/app/ebook2audiobookXTTS/input-folder -v $(pwd)/Audiobooks:/home/user/app/ebook2audiobookXTTS/Audiobooks --memory="4g" --network none --platform linux/amd64 athomasson2/ebook2audiobookxtts:huggingface python app.py -h
+starting...
+Преобразование электронных книг в аудиокниги с использованием модели Text-to-Speech (TTS). Вы можете либо использовать
+интерфейс Gradio, либо запустить скрипт в безинтерфейсном режиме (командная строка) для прямого конвертирования.
+
+опции:
+  -h, --help            Отобразить этот список и выйти
+  --share SHARE         Установить в True для включения публичного доступа к Web-интерфейсу Gradio. По умолчанию False.
+  --headless HEADLESS   Установить в True для использования безинтерфейсного режима. По умолчанию False.
+  --ebook EBOOK         Путь к электронной книге для конвертации. Необходимо для безинтерфейсного режима.
+  --voice VOICE         Путь к целевому голосовому файлу для TTS (текст-в-голос). Опционально, используется голос по умолчанию, если путь не указан.
+  --language LANGUAGE   Язык для конвертации в аудиокнигу. Варианты: en, es, fr, de,
+                        it, pt, pl, tr, ru, nl, cs, ar, zh-cn, ja, hu, ko. По умолчанию English (en).
+  --use_custom_model USE_CUSTOM_MODEL
+                        Установить в True для использования индивидуальной модели TTS. По умолчанию False. Необходимо переключить в
+                        True для использования индивидулаьной модели, в противном случае возникнет ошибка.
+  --custom_model CUSTOM_MODEL
+                        Путь к файлу индивидуальной модели (.pth). Требуется, если используется индивидуальная модель.
+  --custom_config CUSTOM_CONFIG
+                        Путь к конфигурационнмоу файлу индивидуальной модели (config.json). Требуется, если используется индивидуальная модель.
+  --custom_vocab CUSTOM_VOCAB
+                        Путь к словарю индивидуальной модели (vocab.json). Требуется, если используется индивидуальная модель.
+  --custom_model_url CUSTOM_MODEL_URL
+                        URL для скачивания индивидуальной модели в виде zip-архива. Опционально, но если указано, то будет использовано.
+                        Примеры включающие модель David Attenborough: 'https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true'. Больше точно-настроенных моделей XTTS можно найти на Hugging Face 'https://huggingface.co/drewThomasson'.
+  --temperature TEMPERATURE
+                        Температура для модели. По умолчанию 0.65. Чем выше температура, тем более креативным будет синтез голоса, с большим наваждением. Чем меньше, тем более монотонным и спокойным.
+  --length_penalty LENGTH_PENALTY
+                        Ограничение длинны авторегрессионного декодреа. По умолчанию 1.0. Не применяется к индивидуальным моделям.
+  --repetition_penalty REPETITION_PENALTY
+                        Ограниечение предотвращающее повторение авторегрессивным декодером за собой. По умолчанию 2.0
+  --top_k TOP_K         Сэмплирование Top-k. Меньшее значние приводит к более вероятностному выводу и ускоряют генерацию аудио. По умолчанию 50.
+  --top_p TOP_P         Сэмплирование Top-p. Меньшее значние приводит к более вероятностному выводу и ускоряют генерацию аудио. По умолчанию 0.8.
+  --speed SPEED         Фактор скорости начитки. Чем больше значение, тем быстрее диктор будет читать текст. По умолчанию 1.0.
+  --enable_text_splitting ENABLE_TEXT_SPLITTING
+                        Включает разбиение текста на предложения. По умолчаниею True.
+
+Пример: python script.py --headless --ebook path_to_ebook --voice path_to_voice --language en --use_custom_model True --custom_model model.pth --custom_config config.json --custom_vocab vocab.json
+```
+</details>
+
+#### 🖥️ Docker Web-интерфейс 
+![demo_web_gui](https://github.com/user-attachments/assets/85af88a7-05dd-4a29-91de-76a14cf5ef06)
+
+<details>
+  <summary>Нажмите для просмотра изображений Web-интерфейса</summary>
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/b36c71cf-8e06-484c-a252-934e6b1d0c2f">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/c0dab57a-d2d4-4658-bff9-3842ec90cb40">
+<img width="1728" alt="image" src="https://github.com/user-attachments/assets/0a99eeac-c521-4b21-8656-e064c1adc528">
+</details>
+
+### 🛠️ Для индивидуальных Xtts моделей
+
+Модели создаются для лучшего использования с конкретным голосом. Проверьте различные модели на страничке Hugging Face [тут](https://huggingface.co/drewThomasson).
+
+Для использования индивидуальных моделей, используйте ссылку на архив с моделью `Finished_model_files.zip`, например:
+[David Attenborough точно настроенный голос Finished_model_files.zip](https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/resolve/main/Finished_model_files.zip?download=true)
+
+Для индивидуальной модели также необходим файл с голосом:
+[файл с голосом David Attenborough](https://huggingface.co/drewThomasson/xtts_David_Attenborough_fine_tune/blob/main/ref.wav)
+
+
+
+Больше информации можно найти на [странице Dockerfile Hub]([https://github.com/DrewThomasson/ebook2audiobookXTTS](https://hub.docker.com/repository/docker/athomasson2/ebook2audiobookxtts/general)).
+
+## 🌐 Точно отстроенные модели Xtts models
+
+Для поиска уже подготовленных точно настроенных моделей XTTS обратитесь к [этой страничке на Hugging Face](https://huggingface.co/drewThomasson) 🌐. Ищите модели которые имеют в наименовании "xtts fine tune".
+
+## 🎥 Демонстрация
+
+Голос ненастного дня
+
+https://github.com/user-attachments/assets/8486603c-38b1-43ce-9639-73757dfb1031
+
+Голос David Attenborough
+
+https://github.com/user-attachments/assets/47c846a7-9e51-4eb9-844a-7460402a20a8
+
+
+## 🤗 [Демонстрация в пространстве Huggingface](https://huggingface.co/spaces/drewThomasson/ebook2audiobookXTTS)
+- Пространства на Huggingface работают на бесплатном уровне процессоров, поэтому выполнение очень медленное и частво возникают ошибки связанные с истечением времени. Не пытайтесь преобразовывать большие файлы.
+- Лучше всего клонировать пространство или запускать его локально.
+
+## Бесплатный Google Colab [![Бесплатный Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/DrewThomasson/ebook2audiobookXTTS/blob/main/Notebooks/colab_ebook2audiobookxtts.ipynb)
+
+
+
+## 📚 Поддерживаемые форматы электронных книг
+
+- **Можно**: `.epub`, `.pdf`, `.mobi`, `.txt`, `.html`, `.rtf`, `.chm`, `.lit`, `.pdb`, `.fb2`, `.odt`, `.cbr`, `.cbz`, `.prc`, `.lrf`, `.pml`, `.snb`, `.cbc`, `.rb`, `.tcr`
+- **Лучше**: `.epub` или `.mobi` для автоматического определения глав.
+
+## 📂 Вывод
+
+- Создается файл с расширением `.m4b`, содержащий метаданные и главы.
+- **Пример вывода**: ![Пример](https://github.com/DrewThomasson/VoxNovel/blob/dc5197dff97252fa44c391dc0596902d71278a88/readme_files/example_in_app.jpeg)
+
+## 🛠️ Частые проблемы:
+- "Очень медленно!" - При конвертации только на CPU она происходит медленно, единственный способ ускорения - использовать GPU от NVIDIA: [Обсуждение](https://github.com/DrewThomasson/ebook2audiobookXTTS/discussions/19#discussioncomment-10879846). Для быстрой многоязыковой генерации аудио, рекомендуется использовать другой проект [использующий piper-tts](https://github.com/DrewThomasson/ebook2audiobookpiper-tts). (Тем не менее, в нем нет функции клонирования голоса без лишней суеты и он воспроизводит голоса в качестве siri, но он намного быстрее работает на CPU.)
+- "У меня проблема с зависимостями" - Просто используейте Docker. Образы в Docker самодостаточны, имеют, в том числе режим работы с конмандной строкой, клю�� для вывода помощи.
+- "У меня проблема с обрезаным аудио!" - создайте запись о проблеме, автор не говорит на каждом из поддерживаемых языков и ему требуется помощь по автоматическому разбиению текста на предложения в поддерживаемых языках.😊
+- "Процесс застопорился на 30% в Web-интерфейсе!" - Отображение прогресса в Web-интерфейсе выполнено на базовом уровне и содержит всего 3 шага, для контроллирования процесса посматривайте в терминальный вывод, где и отображается обработка текущего предложения.
+
+## С чем требуется помощь! 🙌 
+## [Полный список тут](https://github.com/DrewThomasson/ebook2audiobookXTTS/issues/32)
+- Любая помощь от людей говорящий на поддерживаемых языках для более корретного разбиения текста на предложения.
+- Потенциальная помощь в создании инструкций для разных языков (автор знает только английский 😔).
+
+## 🙏 Отдельные спасибо
+
+- **Coqui TTS**: [Coqui TTS GitHub](https://github.com/coqui-ai/TTS)
+- **Calibre**: [Calibre Website](https://calibre-ebook.com)
+
+- [@shakenbake15 за лучший способ сохранения глав](https://github.com/DrewThomasson/ebook2audiobookXTTS/issues/8) 
+