Upload 16 files

.dockerignore

@@ -0,0 +1,25 @@
+# Ignore Git repository files
+.git/
+
+# Ignore Docker-related files (not needed in the image)
+# Dockerfile
+# .dockerignore
+
+# Ignore cache and temporary files
+.cache
+tmp/*
+
+# Ignore all files and subdirectories in models/ EXCEPT version.txt
+models/*
+!models/version.txt
+
+# Ignore virtual environments (if using venv)
+python_env/
+
+# Ignore compiled Python bytecode
+**/__pycache__/
+
+# Ignore specific directories inside the `audiobooks` project
+audiobooks/cli/*
+audiobooks/gui/gradio/*
+audiobooks/gui/host/*

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+email.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

Dockerfile

@@ -0,0 +1,127 @@
+ARG BASE=python:3.12
+ARG BASE_IMAGE=base
+FROM ${BASE} AS base
+
+# Set environment PATH for local installations
+ENV PATH="/root/.local/bin:$PATH"
+# Set non-interactive mode to prevent tzdata prompt
+ENV DEBIAN_FRONTEND=noninteractive
+# Install system packages
+RUN apt-get update && \
+    apt-get install -y gcc g++ make wget git calibre ffmpeg libmecab-dev mecab mecab-ipadic-utf8 libsndfile1-dev libc-dev curl espeak-ng sox && \
+    curl -fsSL https://deb.nodesource.com/setup_18.x | bash - && \
+    apt-get install -y nodejs && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+# Install Rust compiler
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ENV PATH="/root/.cargo/bin:${PATH}"
+# Copy the application
+WORKDIR /app
+COPY . /app
+# Install UniDic (non-torch dependent)
+RUN pip install --no-cache-dir unidic-lite unidic && \
+    python3 -m unidic download && \
+    mkdir -p /root/.local/share/unidic
+ENV UNIDIC_DIR=/root/.local/share/unidic
+
+# Second stage for PyTorch installation + swappable base image if you want to use a pulled image
+FROM $BASE_IMAGE AS pytorch
+# Add parameter for PyTorch version with a default empty value
+ARG TORCH_VERSION=""
+# Add parameter to control whether to skip the XTTS test
+ARG SKIP_XTTS_TEST="false"
+
+
+# Extract torch versions from requirements.txt or set to empty strings if not found
+RUN TORCH_VERSION_REQ=$(grep -E "^torch==" requirements.txt | cut -d'=' -f3 || echo "") && \
+    TORCHAUDIO_VERSION_REQ=$(grep -E "^torchaudio==" requirements.txt | cut -d'=' -f3 || echo "") && \
+    TORCHVISION_VERSION_REQ=$(grep -E "^torchvision==" requirements.txt | cut -d'=' -f3 || echo "") && \
+    echo "Found in requirements: torch==$TORCH_VERSION_REQ torchaudio==$TORCHAUDIO_VERSION_REQ torchvision==$TORCHVISION_VERSION_REQ"
+
+# Install PyTorch with CUDA support if specified
+RUN if [ ! -z "$TORCH_VERSION" ]; then \
+        # Check if we need to use specific versions or get the latest
+        if [ ! -z "$TORCH_VERSION_REQ" ] && [ ! -z "$TORCHVISION_VERSION_REQ" ] && [ ! -z "$TORCHAUDIO_VERSION_REQ" ]; then \
+            echo "Using specific versions from requirements.txt" && \
+            TORCH_SPEC="torch==${TORCH_VERSION_REQ}" && \
+            TORCHVISION_SPEC="torchvision==${TORCHVISION_VERSION_REQ}" && \
+            TORCHAUDIO_SPEC="torchaudio==${TORCHAUDIO_VERSION_REQ}"; \
+        else \
+            echo "Using latest versions for the selected variant" && \
+            TORCH_SPEC="torch" && \
+            TORCHVISION_SPEC="torchvision" && \
+            TORCHAUDIO_SPEC="torchaudio"; \
+        fi && \
+        \
+        # Check if TORCH_VERSION contains "cuda" and extract version number
+        if echo "$TORCH_VERSION" | grep -q "cuda"; then \
+            CUDA_VERSION=$(echo "$TORCH_VERSION" | sed 's/cuda//g') && \
+            echo "Detected CUDA version: $CUDA_VERSION" && \
+            echo "Attempting to install PyTorch nightly for CUDA $CUDA_VERSION..." && \
+            #if ! pip install --no-cache-dir --pre $TORCH_SPEC $TORCHVISION_SPEC $TORCHAUDIO_SPEC --index-url https://download.pytorch.org/whl/nightly/cu${CUDA_VERSION}; then \
+            if ! pip install --no-cache-dir --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cu${CUDA_VERSION}; then \
+                echo "❌ Nightly build for CUDA $CUDA_VERSION not available or failed" && \
+                echo "🔄 Trying stable release for CUDA $CUDA_VERSION..." && \
+                #if pip install --no-cache-dir $TORCH_SPEC $TORCHVISION_SPEC $TORCHAUDIO_SPEC --extra-index-url https://download.pytorch.org/whl/cu${CUDA_VERSION}; then \
+                if pip install --no-cache-dir torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu${CUDA_VERSION}; then \
+                    echo "✅ Successfully installed stable PyTorch for CUDA $CUDA_VERSION"; \
+                else \
+                    echo "❌ Both nightly and stable builds failed for CUDA $CUDA_VERSION"; \
+                    echo "💡 This CUDA version may not be supported by PyTorch"; \
+                    exit 1; \
+                fi; \
+            else \
+                echo "✅ Successfully installed nightly PyTorch for CUDA $CUDA_VERSION"; \
+            fi; \
+        else \
+            # Handle non-CUDA cases (existing functionality)
+            case "$TORCH_VERSION" in \
+                "rocm") \
+                    # Using the correct syntax for ROCm PyTorch installation
+                    pip install --no-cache-dir $TORCH_SPEC $TORCHVISION_SPEC $TORCHAUDIO_SPEC --extra-index-url https://download.pytorch.org/whl/rocm6.2 \
+                    ;; \
+                "xpu") \
+                    # Install PyTorch with Intel XPU support through IPEX
+                    pip install --no-cache-dir $TORCH_SPEC $TORCHVISION_SPEC $TORCHAUDIO_SPEC && \
+                    pip install --no-cache-dir intel-extension-for-pytorch --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/us/ \
+                    ;; \
+                "cpu") \
+                    pip install --no-cache-dir $TORCH_SPEC $TORCHVISION_SPEC $TORCHAUDIO_SPEC --extra-index-url https://download.pytorch.org/whl/cpu \
+                    ;; \
+                *) \
+                    pip install --no-cache-dir $TORCH_VERSION \
+                    ;; \
+            esac; \
+        fi && \
+        # Install remaining requirements, skipping torch packages that might be there
+        grep -v -E "^torch==|^torchvision==|^torchaudio==|^torchvision$" requirements.txt > requirements_no_torch.txt && \
+        pip install --no-cache-dir --upgrade -r requirements_no_torch.txt && \
+        rm requirements_no_torch.txt; \
+    else \
+        # Install all requirements as specified
+        pip install --no-cache-dir --upgrade -r requirements.txt; \
+    fi
+
+# Do a test run to pre-download and bake base models into the image, but only if SKIP_XTTS_TEST is not true
+RUN if [ "$SKIP_XTTS_TEST" != "true" ]; then \
+        echo "Running XTTS test to pre-download models..."; \
+        if [ "$TORCH_VERSION" = "xpu" ]; then \
+            TORCH_DEVICE_BACKEND_AUTOLOAD=0 python app.py --headless --ebook test.txt --script_mode full_docker; \
+        else \
+            python app.py --headless --language eng --ebook "tools/workflow-testing/test1.txt" --tts_engine XTTSv2 --script_mode full_docker; \
+        fi; \
+    else \
+        echo "Skipping XTTS test run as requested."; \
+    fi
+
+
+# Expose the required port
+EXPOSE 7860
+# Start the Gradio app with the required flag
+ENTRYPOINT ["python", "app.py", "--script_mode", "full_docker"]
+
+
+#docker build --pull --build-arg BASE_IMAGE=athomasson2/ebook2audiobook:latest -t your-image-name .
+#The --pull flag forces Docker to always try to pull the latest version of the image, even if it already exists locally.
+#Without --pull, Docker will only use the local version if it exists, which might not be the latest.

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Mac Ebook2Audiobook Launcher.command

@@ -0,0 +1,9 @@
+#!/bin/zsh
+# Prevent Conda from initializing
+export CONDA_SHLVL=0
+unset CONDA_PREFIX
+unset CONDA_DEFAULT_ENV
+# Change directory to the location of the launcher
+cd "$(dirname "$0")"
+# Execute the ebook2audiobook.sh script
+./ebook2audiobook.sh

README.md

@@ -1,12 +1,530 @@
----
-title: Ebook2audiobook
-emoji: 🏆
-colorFrom: indigo
-colorTo: purple
-sdk: docker
-pinned: false
-license: mit
-short_description: ebook to audiobook
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# 📚 ebook2audiobook
+CPU/GPU Converter from eBooks to audiobooks with chapters and metadata<br/>
+using XTTSv2, Bark, Vits, Fairseq, YourTTS, Tacotron and more. Supports voice cloning and +1110 languages!
+> [!IMPORTANT]
+**This tool is intended for use with non-DRM, legally acquired eBooks only.** <br>
+The authors are not responsible for any misuse of this software or any resulting legal consequences. <br>
+Use this tool responsibly and in accordance with all applicable laws.
+
+[![Discord](https://dcbadge.limes.pink/api/server/https://discord.gg/63Tv3F65k6)](https://discord.gg/63Tv3F65k6)
+
+### Thanks to support ebook2audiobook developers!
+[![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/athomasson2) 
+
+### Run locally
+
+[![Quick Start](https://img.shields.io/badge/Quick%20Start-blue?style=for-the-badge)](#launching-gradio-web-interface)
+
+[![Docker Build](https://github.com/DrewThomasson/ebook2audiobook/actions/workflows/Docker-Build.yml/badge.svg)](https://github.com/DrewThomasson/ebook2audiobook/actions/workflows/Docker-Build.yml)  [![Download](https://img.shields.io/badge/Download-Now-blue.svg)](https://github.com/DrewThomasson/ebook2audiobook/releases/latest)   
+
+
+<a href="https://github.com/DrewThomasson/ebook2audiobook">
+  <img src="https://img.shields.io/badge/Platform-mac%20|%20linux%20|%20windows-lightgrey" alt="Platform">
+</a><a href="https://hub.docker.com/r/athomasson2/ebook2audiobook">
+<img alt="Docker Pull Count" src="https://img.shields.io/docker/pulls/athomasson2/ebook2audiobook.svg"/>
+</a>
+
+### Run Remotely
+[![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Spaces-yellow?style=flat&logo=huggingface)](https://huggingface.co/spaces/drewThomasson/ebook2audiobook)
+[![Free Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/DrewThomasson/ebook2audiobook/blob/main/Notebooks/colab_ebook2audiobook.ipynb) [![Kaggle](https://img.shields.io/badge/Kaggle-035a7d?style=flat&logo=kaggle&logoColor=white)](https://github.com/Rihcus/ebook2audiobookXTTS/blob/main/Notebooks/kaggle-ebook2audiobook.ipynb)
+
+#### GUI Interface
+![demo_web_gui](assets/demo_web_gui.gif)
+
+<details>
+  <summary>Click to see images of Web GUI</summary>
+  <img width="1728" alt="GUI Screen 1" src="assets/gui_1.png">
+  <img width="1728" alt="GUI Screen 2" src="assets/gui_2.png">
+  <img width="1728" alt="GUI Screen 3" src="assets/gui_3.png">
+</details>
+
+## Demos
+
+**New Default Voice Demo**  
+
+https://github.com/user-attachments/assets/750035dc-e355-46f1-9286-05c1d9e88cea  
+
+<details>
+  <summary>More Demos</summary>
+
+**ASMR Voice** 
+
+https://github.com/user-attachments/assets/68eee9a1-6f71-4903-aacd-47397e47e422
+
+**Rainy Day Voice**  
+
+https://github.com/user-attachments/assets/d25034d9-c77f-43a9-8f14-0d167172b080  
+
+**Scarlett Voice**
+
+https://github.com/user-attachments/assets/b12009ee-ec0d-45ce-a1ef-b3a52b9f8693
+
+**David Attenborough Voice** 
+
+https://github.com/user-attachments/assets/81c4baad-117e-4db5-ac86-efc2b7fea921
+
+**Example**
+
+![Example](https://github.com/DrewThomasson/VoxNovel/blob/dc5197dff97252fa44c391dc0596902d71278a88/readme_files/example_in_app.jpeg)
+</details>
+
+## README.md
+
+## Table of Contents
+- [ebook2audiobook](#-ebook2audiobook)
+- [Features](#features)
+- [GUI Interface](#gui-interface)
+- [Demos](#demos)
+- [Supported Languages](#supported-languages)
+- [Minimum Requirements](#hardware-requirements)
+- [Usage](#launching-gradio-web-interface)
+  - [Run Locally](#launching-gradio-web-interface)
+    - [Launching Gradio Web Interface](#launching-gradio-web-interface)
+    - [Basic Headless Usage](#basic--usage)
+    - [Headless Custom XTTS Model Usage](#example-of-custom-model-zip-upload)
+    - [Help command output](#help-command-output)
+  - [Run Remotely](#run-remotely)  
+- [Fine Tuned TTS models](#fine-tuned-tts-models)
+  - [Collection of Fine-Tuned TTS Models](#fine-tuned-tts-collection)
+  - [Train XTTSv2](#fine-tune-your-own-xttsv2-model)
+- [Docker](#docker-gpu-options) 
+  - [GPU options](#docker-gpu-options)
+  - [Docker Run](#running-the-pre-built-docker-container)
+  - [Docker Build](#building-the-docker-container)
+  - [Docker Compose](#docker-compose)
+  - [Docker headless guide](#docker-headless-guide)
+  - [Docker container file locations](#docker-container-file-locations)
+  - [Common Docker issues](#common-docker-issues)
+- [Supported eBook Formats](#supported-ebook-formats)
+- [Output Formats](#output-formats)
+- [Updating to Latest Version](#updating-to-latest-version)
+- [Revert to older Version](#reverting-to-older-versions)
+- [Common Issues](#common-issues)
+- [Special Thanks](#special-thanks)
+- [Table of Contents](#table-of-contents)
+
+
+## Features
+- 📚 Splits eBook into chapters for organized audio.
+- 🎙️ High-quality text-to-speech with [Coqui XTTSv2](https://huggingface.co/coqui/XTTS-v2) and [Fairseq](https://github.com/facebookresearch/fairseq/tree/main/examples/mms) (and more).
+- 🗣️ Optional voice cloning with your own voice file.
+- 🌍 Supports +1110 languages (English by default). [List of Supported languages](https://dl.fbaipublicfiles.com/mms/tts/all-tts-languages.html)
+- 🖥️ Designed to run on 4GB RAM.
+
+
+## Supported Languages
+| **Arabic (ar)**    | **Chinese (zh)**    | **English (en)**   | **Spanish (es)**   |
+|:------------------:|:------------------:|:------------------:|:------------------:|
+| **French (fr)**    | **German (de)**     | **Italian (it)**   | **Portuguese (pt)** |
+| **Polish (pl)**    | **Turkish (tr)**    | **Russian (ru)**   | **Dutch (nl)**     |
+| **Czech (cs)**     | **Japanese (ja)**   | **Hindi (hi)**     | **Bengali (bn)**   |
+| **Hungarian (hu)** | **Korean (ko)**     | **Vietnamese (vi)**| **Swedish (sv)**   |
+| **Persian (fa)**   | **Yoruba (yo)**     | **Swahili (sw)**   | **Indonesian (id)**|
+| **Slovak (sk)**    | **Croatian (hr)**   | **Tamil (ta)**     | **Danish (da)**    |
+- [**+1100 languages and dialects here**](https://dl.fbaipublicfiles.com/mms/tts/all-tts-languages.html)
+
+
+##  Hardware Requirements
+- 4gb RAM minimum, 8GB recommended
+- Virtualization enabled if running on windows (Docker only)
+- CPU (intel, AMD, ARM), GPU (Nvidia, AMD*, Intel*) (Recommended), MPS (Apple Silicon CPU)
+*available very soon
+
+> [!IMPORTANT]
+**Before to post an install or bug issue search carefully to the opened and closed issues TAB<br>
+to be sure your issue does not exist already.**
+
+
+>[!NOTE]
+**Lacking of any standards structure like what is a chapter, paragraph, preface etc.<br>
+you should first remove manually any text you don't want to be converted in audio.**
+
+### Installation Instructions
+1. **Clone repo**
+```bash
+git clone https://github.com/DrewThomasson/ebook2audiobook.git
+cd ebook2audiobook
+```
+
+### Launching Gradio Web Interface  
+1. **Run ebook2audiobook**:  
+   - **Linux/MacOS**  
+     ```bash
+     ./ebook2audiobook.sh  # Run launch script
+     ```
+
+   - **Mac Launcher**  
+     Double click `Mac Ebook2Audiobook Launcher.command`
+
+  
+   - **Windows**  
+     ```bash
+     ebook2audiobook.cmd  # Run launch script or double click on it
+     ```
+     
+   - **Windows Launcher**  
+     Double click `ebook2audiobook.cmd`
+
+
+   - **Manual Python Install**
+     ```bash
+     # (for experts only!)
+     REQUIRED_PROGRAMS=("calibre" "ffmpeg" "nodejs" "mecab" "espeak-ng" "rust" "sox")
+     REQUIRED_PYTHON_VERSION="3.12"
+     pip install -r requirements.txt  # Install Python Requirements
+     python app.py  # Run Ebook2Audiobook
+     ```
+   
+1. **Open the Web App**: Click the URL provided in the terminal to access the web app and convert eBooks. `http://localhost:7860/`
+2. **For Public Link**:
+   `python app.py --share` (all OS)
+   `./ebook2audiobook.sh --share` (Linux/MacOS)
+   `ebook2audiobook.cmd --share` (Windows)
+
+> [!IMPORTANT]
+**If the script is stopped and run again, you need to refresh your gradio GUI interface<br>
+to let the web page reconnect to the new connection socket.**
+
+### Basic  Usage
+   - **Linux/MacOS**:
+     ```bash
+     ./ebook2audiobook.sh --headless --ebook <path_to_ebook_file> \
+         --voice [path_to_voice_file] --language [language_code]
+     ```
+   - **Windows**
+     ```bash
+     ebook2audiobook.cmd --headless --ebook <path_to_ebook_file>
+         --voice [path_to_voice_file] --language [language_code]
+     ```
+     
+  - **[--ebook]**: Path to your eBook file
+  - **[--voice]**: Voice cloning file path (optional)
+  - **[--language]**: Language code in ISO-639-3 (i.e.: ita for italian, eng for english, deu for german...).<br>
+    Default language is eng and --language is optional for default language set in ./lib/lang.py.<br>
+    The ISO-639-1 2 letters codes are also supported.
+
+
+###  Example of Custom Model Zip Upload
+  (must be a .zip file containing the mandatory model files. Example for XTTSv2: config.json, model.pth, vocab.json and ref.wav)
+   - **Linux/MacOS**
+     ```bash
+     ./ebook2audiobook.sh --headless --ebook <ebook_file_path> \
+         --voice <target_voice_file_path> --language <language> --custom_model <custom_model_path>
+     ```
+   - **Windows**
+     ```bash
+     ebook2audiobook.cmd --headless --ebook <ebook_file_path> \
+         --voice <target_voice_file_path> --language <language> --custom_model <custom_model_path>
+     ```
+- **<custom_model_path>**: Path to `model_name.zip` file,
+      which must contain (according to the tts engine) all the mandatory files<br>
+      (see ./lib/models.py).
+
+
+### For Detailed Guide with list of all Parameters to use
+   - **Linux/MacOS**
+     ```bash
+     ./ebook2audiobook.sh --help
+     ```
+   - **Windows**
+     ```bash
+     ebook2audiobook.cmd --help
+     ```
+   - **Or for all OS**
+    ```python
+     app.py --help
+    ```
+
+<a id="help-command-output"></a>
+```bash
+usage: app.py [-h] [--session SESSION] [--share] [--headless] [--ebook EBOOK]
+              [--ebooks_dir EBOOKS_DIR] [--language LANGUAGE] [--voice VOICE]
+              [--device {cpu,gpu,mps}]
+              [--tts_engine {XTTSv2,BARK,VITS,FAIRSEQ,TACOTRON2,YOURTTS,xtts,bark,vits,fairseq,tacotron,yourtts}]
+              [--custom_model CUSTOM_MODEL] [--fine_tuned FINE_TUNED]
+              [--output_format OUTPUT_FORMAT] [--temperature TEMPERATURE]
+              [--length_penalty LENGTH_PENALTY] [--num_beams NUM_BEAMS]
+              [--repetition_penalty REPETITION_PENALTY] [--top_k TOP_K]
+              [--top_p TOP_P] [--speed SPEED] [--enable_text_splitting]
+              [--text_temp TEXT_TEMP] [--waveform_temp WAVEFORM_TEMP]
+              [--output_dir OUTPUT_DIR] [--version]
+
+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
+  --session SESSION     Session to resume the conversion in case of interruption, crash, 
+                            or reuse of custom models and custom cloning voices.
+
+**** The following options are for all modes:
+  Optional
+
+**** The following option are for gradio/gui mode only:
+  Optional
+
+  --share               Enable a public shareable Gradio link.
+
+**** The following options are for --headless mode only:
+  --headless            Run the script in headless mode
+  --ebook EBOOK         Path to the ebook file for conversion. Cannot be used when --ebooks_dir is present.
+  --ebooks_dir EBOOKS_DIR
+                        Relative or absolute path of the directory containing the files to convert. 
+                            Cannot be used when --ebook is present.
+  --language LANGUAGE   Language of the e-book. Default language is set 
+                            in ./lib/lang.py sed as default if not present. All compatible language codes are in ./lib/lang.py
+
+optional parameters:
+  --voice VOICE         (Optional) Path to the voice cloning file for TTS engine. 
+                            Uses the default voice if not present.
+  --device {cpu,gpu,mps}
+                        (Optional) Pprocessor unit type for the conversion. 
+                            Default is set in ./lib/conf.py if not present. Fall back to CPU if GPU not available.
+  --tts_engine {XTTSv2,BARK,VITS,FAIRSEQ,TACOTRON2,YOURTTS,xtts,bark,vits,fairseq,tacotron,yourtts}
+                        (Optional) Preferred TTS engine (available are: ['XTTSv2', 'BARK', 'VITS', 'FAIRSEQ', 'TACOTRON2', 'YOURTTS', 'xtts', 'bark', 'vits', 'fairseq', 'tacotron', 'yourtts'].
+                            Default depends on the selected language. The tts engine should be compatible with the chosen language
+  --custom_model CUSTOM_MODEL
+                        (Optional) Path to the custom model zip file cntaining mandatory model files. 
+                            Please refer to ./lib/models.py
+  --fine_tuned FINE_TUNED
+                        (Optional) Fine tuned model path. Default is builtin model.
+  --output_format OUTPUT_FORMAT
+                        (Optional) Output audio format. Default is set in ./lib/conf.py
+  --temperature TEMPERATURE
+                        (xtts only, optional) Temperature for the model. 
+                            Default to config.json model. Higher temperatures lead to more creative outputs.
+  --length_penalty LENGTH_PENALTY
+                        (xtts only, optional) A length penalty applied to the autoregressive decoder. 
+                            Default to config.json model. Not applied to custom models.
+  --num_beams NUM_BEAMS
+                        (xtts only, optional) Controls how many alternative sequences the model explores. Must be equal or greater than length penalty. 
+                            Default to config.json model.
+  --repetition_penalty REPETITION_PENALTY
+                        (xtts only, optional) A penalty that prevents the autoregressive decoder from repeating itself. 
+                            Default to config.json model.
+  --top_k TOP_K         (xtts only, optional) Top-k sampling. 
+                            Lower values mean more likely outputs and increased audio generation speed. 
+                            Default to config.json model.
+  --top_p TOP_P         (xtts only, optional) Top-p sampling. 
+                            Lower values mean more likely outputs and increased audio generation speed. Default to config.json model.
+  --speed SPEED         (xtts only, optional) Speed factor for the speech generation. 
+                            Default to config.json model.
+  --enable_text_splitting
+                        (xtts only, optional) Enable TTS text splitting. This option is known to not be very efficient. 
+                            Default to config.json model.
+  --text_temp TEXT_TEMP
+                        (bark only, optional) Text Temperature for the model. 
+                            Default to 0.85. Higher temperatures lead to more creative outputs.
+  --waveform_temp WAVEFORM_TEMP
+                        (bark only, optional) Waveform Temperature for the model. 
+                            Default to 0.5. Higher temperatures lead to more creative outputs.
+  --output_dir OUTPUT_DIR
+                        (Optional) Path to the output directory. Default is set in ./lib/conf.py
+  --version             Show the version of the script and exit
+
+Example usage:    
+Windows:
+    Gradio/GUI:
+    ebook2audiobook.cmd
+    Headless mode:
+    ebook2audiobook.cmd --headless --ebook '/path/to/file'
+Linux/Mac:
+    Gradio/GUI:
+    ./ebook2audiobook.sh
+    Headless mode:
+    ./ebook2audiobook.sh --headless --ebook '/path/to/file'
+    
+Tip: to add of silence (1.4 seconds) into your text just use "###" or "[pause]".
+
+```
+
+NOTE: in gradio/gui mode, to cancel a running conversion, just click on the [X] from the ebook upload component.
+
+TIP: if it needs some more pauses, just add '###' or '[pause]' between the words you wish more pause. one [pause] equals to 1.4 seconds
+
+#### Docker GPU Options
+
+Available pre-build tags: `latest` (CUDA 11.8)
+#### Edit: IF GPU isn't detected then you'll have to build the image -> [Building the Docker Container](#building-the-docker-container)
+
+
+
+#### Running the pre-built Docker Container
+
+ -Run with CPU only
+```powershell
+docker run --pull always --rm -p 7860:7860 athomasson2/ebook2audiobook
+```
+ -Run with GPU Speedup (NVIDIA compatible only)
+```powershell
+docker run --pull always --rm --gpus all -p 7860:7860 athomasson2/ebook2audiobook
+```
+
+This command will start the Gradio interface on port 7860.(localhost:7860)
+- For more options add the parameter `--help`
+
+
+#### Building the Docker Container
+- You can build the docker image with the command:
+```powershell
+docker build -t athomasson2/ebook2audiobook .
+```
+#### Avalible Docker Build Arguments
+
+`--build-arg TORCH_VERSION=cuda118` Available tags: [cuda121, cuda118, cuda128, rocm, xpu, cpu] 
+
+All CUDA version numbers should work, Ex: CUDA 11.6-> cuda116
+
+`--build-arg SKIP_XTTS_TEST=true` (Saves space by not baking XTTSv2 model into docker image)
+
+
+## Docker container file locations
+All ebook2audiobooks will have the base dir of `/app/`
+For example:
+`tmp` = `/app/tmp`
+`audiobooks` = `/app/audiobooks`
+
+
+## Docker headless guide
+
+- Before you do run this you need to create a dir named "input-folder" in your current dir
+  which will be linked, This is where you can put your input files for the docker image to see
+```bash
+mkdir input-folder && mkdir Audiobooks
+```
+- In the command below swap out **YOUR_INPUT_FILE.TXT** with the name of your input file 
+```bash
+docker run --pull always --rm \
+    -v $(pwd)/input-folder:/app/input_folder \
+    -v $(pwd)/audiobooks:/app/audiobooks \
+    athomasson2/ebook2audiobook \
+    --headless --ebook /input_folder/YOUR_EBOOK_FILE
+```
+- The output Audiobooks will be found in the Audiobook folder which will also be located
+  in your local dir you ran this docker command in
+
+
+## To get the help command for the other parameters this program has you can run this 
+
+```bash
+docker run --pull always --rm athomasson2/ebook2audiobook --help
+
+```
+That will output this 
+[Help command output](#help-command-output)
+
+
+### Docker Compose
+This project uses Docker Compose to run locally. You can enable or disable GPU support 
+by setting either `*gpu-enabled` or `*gpu-disabled` in `docker-compose.yml`
+
+
+#### Steps to Run
+1. **Clone the Repository** (if you haven't already):
+   ```bash
+   git clone https://github.com/DrewThomasson/ebook2audiobook.git
+   cd ebook2audiobook
+   ```
+2. **Set GPU Support (disabled by default)**
+  To enable GPU support, modify `docker-compose.yml` and change `*gpu-disabled` to `*gpu-enabled`
+3. **Start the service:**
+    ```bash
+    # Docker
+    docker-compose up -d # To update add --build
+
+    # Podman
+    podman compose -f podman-compose.yml up -d # To update add --build
+    ```
+4. **Access the service:**
+  The service will be available at http://localhost:7860.
+
+
+## Common Docker Issues
+
+- My NVIDIA GPU isnt being detected?? -> [GPU ISSUES Wiki Page](https://github.com/DrewThomasson/ebook2audiobook/wiki/GPU-ISSUES)
+
+- `python: can't open file '/home/user/app/app.py': [Errno 2] No such file or directory` (Just remove all post arguments as I replaced the `CMD` with `ENTRYPOINT` in the [Dockerfile](Dockerfile))
+  - Example: `docker run --pull always athomasson2/ebook2audiobook app.py --script_mode full_docker` - > corrected - > `docker run --pull always athomasson2/ebook2audiobook`
+  - Arguments can be easily added like this now `docker run --pull always athomasson2/ebook2audiobook --share`
+
+- Docker gets stuck downloading Fine-Tuned models.
+  (This does not happen for every computer but some appear to run into this issue)
+  Disabling the progress bar appears to fix the issue,
+  as discussed [here in #191](https://github.com/DrewThomasson/ebook2audiobook/issues/191)
+  Example of adding this fix in the `docker run` command
+```Dockerfile
+docker run --pull always --rm --gpus all -e HF_HUB_DISABLE_PROGRESS_BARS=1 -e HF_HUB_ENABLE_HF_TRANSFER=0 \
+    -p 7860:7860 athomasson2/ebook2audiobook
+```
+
+
+## Fine Tuned TTS models
+#### Fine Tune your own XTTSv2 model
+
+[![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Spaces-yellow?style=flat&logo=huggingface)](https://huggingface.co/spaces/drewThomasson/xtts-finetune-webui-gpu) [![Kaggle](https://img.shields.io/badge/Kaggle-035a7d?style=flat&logo=kaggle&logoColor=white)](https://github.com/DrewThomasson/ebook2audiobook/blob/v25/Notebooks/finetune/xtts/kaggle-xtts-finetune-webui-gradio-gui.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/DrewThomasson/ebook2audiobook/blob/v25/Notebooks/finetune/xtts/colab_xtts_finetune_webui.ipynb)
+
+
+
+
+
+#### De-noise training data
+
+[![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Spaces-yellow?style=flat&logo=huggingface)](https://huggingface.co/spaces/drewThomasson/DeepFilterNet2_no_limit) [![GitHub Repo](https://img.shields.io/badge/DeepFilterNet-181717?logo=github)](https://github.com/Rikorose/DeepFilterNet)
+
+
+### Fine Tuned TTS Collection
+
+[![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Models-yellow?style=flat&logo=huggingface)](https://huggingface.co/drewThomasson/fineTunedTTSModels/tree/main)
+
+For an XTTSv2 custom model a ref audio clip of the voice reference is mandatory:
+
+
+## Supported eBook Formats
+- `.epub`, `.pdf`, `.mobi`, `.txt`, `.html`, `.rtf`, `.chm`, `.lit`,
+  `.pdb`, `.fb2`, `.odt`, `.cbr`, `.cbz`, `.prc`, `.lrf`, `.pml`,
+  `.snb`, `.cbc`, `.rb`, `.tcr`
+- **Best results**: `.epub` or `.mobi` for automatic chapter detection
+
+
+## Output Formats
+- Creates a `['m4b', 'm4a', 'mp4', 'webm', 'mov', 'mp3', 'flac', 'wav', 'ogg', 'aac']` (set in ./lib/conf.py) file with metadata and chapters.
+
+## Updating to Latest Version
+```bash
+git pull # Locally/Compose
+
+docker pull athomasson2/ebook2audiobook:latest # For Pre-build docker images
+```
+
+## Reverting to older Versions
+Releases can be found -> [here](https://github.com/DrewThomasson/ebook2audiobook/releases)
+```bash
+git checkout tags/VERSION_NUM # Locally/Compose -> Example: git checkout tags/v25.7.7
+
+athomasson2/ebook2audiobook:VERSION_NUM # For Pre-build docker images -> Example: athomasson2/ebook2audiobook:v25.7.7
+```
+
+## Common Issues:
+- My NVIDIA GPU isnt being detected?? -> [GPU ISSUES Wiki Page](https://github.com/DrewThomasson/ebook2audiobook/wiki/GPU-ISSUES)
+-  CPU is slow (better on server smp CPU) while NVIDIA GPU can have almost real time conversion.
+   [Discussion about this](https://github.com/DrewThomasson/ebook2audiobook/discussions/19#discussioncomment-10879846)
+   For faster multilingual generation I would suggest my other
+   [project that uses piper-tts](https://github.com/DrewThomasson/ebook2audiobookpiper-tts) instead
+   (It doesn't have zero-shot voice cloning though, and is Siri quality voices, but it is much faster on cpu).
+- "I'm having dependency issues" - Just use the docker, its fully self contained and has a headless mode,
+   add `--help` parameter at the end of the docker run command for more information.
+- "Im getting a truncated audio issue!" - PLEASE MAKE AN ISSUE OF THIS,
+   we don't speak every language and need advise from users to fine tune the sentence splitting logic.😊
+
+
+## What we need help with! 🙌 
+## [Full list of things can be found here](https://github.com/DrewThomasson/ebook2audiobook/issues/32)
+- Any help from people speaking any of the supported languages to help us improve the models
+
+## Do you need to rent a GPU to boost service from us?
+- A poll is open here https://github.com/DrewThomasson/ebook2audiobook/discussions/889
+
+## Special Thanks
+- **Coqui TTS**: [Coqui TTS GitHub](https://github.com/idiap/coqui-ai-TTS)
+- **Calibre**: [Calibre Website](https://calibre-ebook.com)
+- **FFmpeg**: [FFmpeg Website](https://ffmpeg.org)
+- [@shakenbake15 for better chapter saving method](https://github.com/DrewThomasson/ebook2audiobook/issues/8) 

VERSION.txt

@@ -0,0 +1 @@
+25.8.18

app.py

@@ -0,0 +1,331 @@
+import argparse
+import filecmp
+import importlib.util
+import os
+import shutil
+import socket
+import subprocess
+import sys
+import tempfile
+
+from pathlib import Path
+from lib import *
+
+def check_virtual_env(script_mode):
+    current_version = sys.version_info[:2]  # (major, minor)
+    if str(os.path.basename(sys.prefix)) == 'python_env' or script_mode == FULL_DOCKER or current_version >= min_python_version and current_version <= max_python_version:
+        return True  
+    error = f'''***********
+Wrong launch! ebook2audiobook must run in its own virtual environment!
+NOTE: If you are running a Docker so you are probably using an old version of ebook2audiobook.
+To solve this issue go to download the new version at https://github.com/DrewThomasson/ebook2audiobook
+If the directory python_env does not exist in the ebook2audiobook root directory,
+run your command with "./ebook2audiobook.sh" for Linux and Mac or "ebook2audiobook.cmd" for Windows
+to install it all automatically.
+{install_info}
+***********'''
+    print(error)
+    return False
+
+def check_python_version():
+    current_version = sys.version_info[:2]  # (major, minor)
+    if current_version < min_python_version or current_version > max_python_version:
+        error = f'''***********
+Wrong launch: Your OS Python version is not compatible! (current: {current_version[0]}.{current_version[1]})
+In order to install and/or use ebook2audiobook correctly you must run 
+"./ebook2audiobook.sh" for Linux and Mac or "ebook2audiobook.cmd" for Windows.
+{install_info}
+***********'''
+        print(error)
+        return False
+    else:
+        return True
+
+def check_and_install_requirements(file_path):
+    if not os.path.exists(file_path):
+        error = f'Warning: File {file_path} not found. Skipping package check.'
+        print(error)
+        return False
+    try:
+        from importlib.metadata import version, PackageNotFoundError
+        try:
+            from packaging.specifiers import SpecifierSet
+        except ImportError:
+            subprocess.check_call([sys.executable, '-m', 'pip', 'install', '--no-cache-dir', 'packaging'])
+            from packaging.specifiers import SpecifierSet
+        import regex as re
+        from tqdm import tqdm
+        with open(file_path, 'r') as f:
+            contents = f.read().replace('\r', '\n')
+            packages = [
+                pkg.strip()
+                for pkg in contents.splitlines()
+                if pkg.strip() and re.search(r'[a-zA-Z0-9]', pkg)
+            ]
+        missing_packages = []
+        for package in packages:
+            # remove extras so '[lang]==x.y' becomes 'pkg==x.y'
+            clean_pkg = re.sub(r'\[.*?\]', '', package)
+            pkg_name  = re.split(r'[<>=]', clean_pkg, 1)[0].strip()
+            try:
+                installed_version = version(pkg_name)
+                if pkg_name == 'num2words':
+                    code = "ZH_CN"
+                    spec = importlib.util.find_spec(f"num2words.lang_{code}")
+                    if spec is None:
+                        missing_packages.append(package)
+            except PackageNotFoundError:
+                error = f'{package} is missing.'
+                print(error)
+                missing_packages.append(package)
+            else:
+                # get specifier from clean_pkg, not from the raw string
+                spec_str = clean_pkg[len(pkg_name):].strip()
+                if spec_str:
+                    spec = SpecifierSet(spec_str)
+                    if installed_version not in spec:
+                        error = (f'{pkg_name} (installed {installed_version}) does not satisfy "{spec_str}".')
+                        print(error)
+                        missing_packages.append(package)
+        if missing_packages:
+            msg = '\nInstalling missing or upgrade packages...\n'
+            print(msg)
+            tmp_dir = tempfile.mkdtemp()
+            os.environ['TMPDIR'] = tmp_dir
+            result = subprocess.call([sys.executable, '-m', 'pip', 'cache', 'purge'])
+            subprocess.check_call([sys.executable, '-m', 'pip', 'install', '--upgrade', 'pip'])
+            with tqdm(total=len(packages),
+                      desc='Installation 0.00%',
+                      bar_format='{desc}: {n_fmt}/{total_fmt} ',
+                      unit='step') as t:
+                for package in tqdm(missing_packages, desc="Installing", unit="pkg"):
+                    try:
+                        if package == 'num2words':
+                            pkgs = ['git+https://github.com/savoirfairelinux/num2words.git', '--force']
+                        else:
+                            pkgs = [package]
+                        subprocess.check_call([
+                            sys.executable, '-m', 'pip', 'install',
+                            '--no-cache-dir', '--use-pep517',
+                            *pkgs
+                        ])
+                        t.update(1)
+                    except subprocess.CalledProcessError as e:
+                        error = f'Failed to install {package}: {e}'
+                        print(error)
+                        return False
+            msg = '\nAll required packages are installed.'
+            print(msg)
+        return True
+    except Exception as e:
+        error = f'check_and_install_requirements() error: {e}'
+        raise SystemExit(error)
+        return False
+       
+def check_dictionary():
+    import unidic
+    unidic_path = unidic.DICDIR
+    dicrc = os.path.join(unidic_path, 'dicrc')
+    if not os.path.exists(dicrc) or os.path.getsize(dicrc) == 0:
+        try:
+            error = 'UniDic dictionary not found or incomplete. Downloading now...'
+            print(error)
+            subprocess.run(['python', '-m', 'unidic', 'download'], check=True)
+        except subprocess.CalledProcessError as e:
+            error = f'Failed to download UniDic dictionary. Error: {e}. Unable to continue without UniDic. Exiting...'
+            raise SystemExit(error)
+            return False
+    return True
+
+def is_port_in_use(port):
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+        return s.connect_ex(('0.0.0.0', port)) == 0
+
+def main():
+    # Argument parser to handle optional parameters with descriptions
+    parser = argparse.ArgumentParser(
+        description='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.',
+        epilog='''
+Example usage:    
+Windows:
+    Gradio/GUI:
+    ebook2audiobook.cmd
+    Headless mode:
+    ebook2audiobook.cmd --headless --ebook '/path/to/file'
+Linux/Mac:
+    Gradio/GUI:
+    ./ebook2audiobook.sh
+    Headless mode:
+    ./ebook2audiobook.sh --headless --ebook '/path/to/file'
+    
+Tip: to add of silence (1.4 seconds) into your text just use "###" or "[pause]".
+        ''',
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    options = [
+        '--script_mode', '--session', '--share', '--headless', 
+        '--ebook', '--ebooks_dir', '--language', '--voice', '--device', '--tts_engine', 
+        '--custom_model', '--fine_tuned', '--output_format',
+        '--temperature', '--length_penalty', '--num_beams', '--repetition_penalty', '--top_k', '--top_p', '--speed', '--enable_text_splitting',
+        '--text_temp', '--waveform_temp',
+        '--output_dir', '--version', '--workflow', '--help'
+    ]
+    tts_engine_list_keys = [k for k in TTS_ENGINES.keys()]
+    tts_engine_list_values = [k for k in TTS_ENGINES.values()]
+    all_group = parser.add_argument_group('**** The following options are for all modes', 'Optional')
+    all_group.add_argument(options[0], type=str, help=argparse.SUPPRESS)
+    parser.add_argument(options[1], type=str, help='''Session to resume the conversion in case of interruption, crash, 
+    or reuse of custom models and custom cloning voices.''')
+    gui_group = parser.add_argument_group('**** The following option are for gradio/gui mode only', 'Optional')
+    gui_group.add_argument(options[2], action='store_true', help='''Enable a public shareable Gradio link.''')
+    headless_group = parser.add_argument_group('**** The following options are for --headless mode only')
+    headless_group.add_argument(options[3], action='store_true', help='''Run the script in headless mode''')
+    headless_group.add_argument(options[4], type=str, help='''Path to the ebook file for conversion. Cannot be used when --ebooks_dir is present.''')
+    headless_group.add_argument(options[5], type=str, help=f'''Relative or absolute path of the directory containing the files to convert. 
+    Cannot be used when --ebook is present.''')
+    headless_group.add_argument(options[6], type=str, default=default_language_code, help=f'''Language of the e-book. Default language is set 
+    in ./lib/lang.py sed as default if not present. All compatible language codes are in ./lib/lang.py''')
+    headless_optional_group = parser.add_argument_group('optional parameters')
+    headless_optional_group.add_argument(options[7], type=str, default=None, help='''(Optional) Path to the voice cloning file for TTS engine. 
+    Uses the default voice if not present.''')
+    headless_optional_group.add_argument(options[8], type=str, default=default_device, choices=device_list, help=f'''(Optional) Pprocessor unit type for the conversion. 
+    Default is set in ./lib/conf.py if not present. Fall back to CPU if GPU not available.''')
+    headless_optional_group.add_argument(options[9], type=str, default=None, choices=tts_engine_list_keys+tts_engine_list_values, help=f'''(Optional) Preferred TTS engine (available are: {tts_engine_list_keys+tts_engine_list_values}.
+    Default depends on the selected language. The tts engine should be compatible with the chosen language''')
+    headless_optional_group.add_argument(options[10], type=str, default=None, help=f'''(Optional) Path to the custom model zip file cntaining mandatory model files. 
+    Please refer to ./lib/models.py''')
+    headless_optional_group.add_argument(options[11], type=str, default=default_fine_tuned, help='''(Optional) Fine tuned model path. Default is builtin model.''')
+    headless_optional_group.add_argument(options[12], type=str, default=default_output_format, help=f'''(Optional) Output audio format. Default is set in ./lib/conf.py''')
+    headless_optional_group.add_argument(options[13], type=float, default=None, help=f"""(xtts only, optional) Temperature for the model. 
+    Default to config.json model. Higher temperatures lead to more creative outputs.""")
+    headless_optional_group.add_argument(options[14], type=float, default=None, help=f"""(xtts only, optional) A length penalty applied to the autoregressive decoder. 
+    Default to config.json model. Not applied to custom models.""")
+    headless_optional_group.add_argument(options[15], type=int, default=None, help=f"""(xtts only, optional) Controls how many alternative sequences the model explores. Must be equal or greater than length penalty. 
+    Default to config.json model.""")
+    headless_optional_group.add_argument(options[16], type=float, default=None, help=f"""(xtts only, optional) A penalty that prevents the autoregressive decoder from repeating itself. 
+    Default to config.json model.""")
+    headless_optional_group.add_argument(options[17], type=int, default=None, help=f"""(xtts only, optional) Top-k sampling. 
+    Lower values mean more likely outputs and increased audio generation speed. 
+    Default to config.json model.""")
+    headless_optional_group.add_argument(options[18], type=float, default=None, help=f"""(xtts only, optional) Top-p sampling. 
+    Lower values mean more likely outputs and increased audio generation speed. Default to config.json model.""")
+    headless_optional_group.add_argument(options[19], type=float, default=None, help=f"""(xtts only, optional) Speed factor for the speech generation. 
+    Default to config.json model.""")
+    headless_optional_group.add_argument(options[20], action='store_true', help=f"""(xtts only, optional) Enable TTS text splitting. This option is known to not be very efficient. 
+    Default to config.json model.""")
+    headless_optional_group.add_argument(options[21], type=float, default=None, help=f"""(bark only, optional) Text Temperature for the model. 
+    Default to {default_engine_settings[TTS_ENGINES['BARK']]['text_temp']}. Higher temperatures lead to more creative outputs.""")
+    headless_optional_group.add_argument(options[22], type=float, default=None, help=f"""(bark only, optional) Waveform Temperature for the model. 
+    Default to {default_engine_settings[TTS_ENGINES['BARK']]['waveform_temp']}. Higher temperatures lead to more creative outputs.""")
+    headless_optional_group.add_argument(options[23], type=str, help=f'''(Optional) Path to the output directory. Default is set in ./lib/conf.py''')
+    headless_optional_group.add_argument(options[24], action='version', version=f'ebook2audiobook version {prog_version}', help='''Show the version of the script and exit''')
+    headless_optional_group.add_argument(options[25], action='store_true', help=argparse.SUPPRESS)
+    
+    for arg in sys.argv:
+        if arg.startswith('--') and arg not in options:
+            error = f'Error: Unrecognized option "{arg}"'
+            print(error)
+            sys.exit(1)
+
+    args = vars(parser.parse_args())
+
+    if not 'help' in args:
+        if not check_virtual_env(args['script_mode']):
+            sys.exit(1)
+
+        if not check_python_version():
+            sys.exit(1)
+
+        # Check if the port is already in use to prevent multiple launches
+        if not args['headless'] and is_port_in_use(interface_port):
+            error = f'Error: Port {interface_port} is already in use. The web interface may already be running.'
+            print(error)
+            sys.exit(1)
+
+        args['script_mode'] = args['script_mode'] if args['script_mode'] else NATIVE
+        args['session'] = 'ba800d22-ee51-11ef-ac34-d4ae52cfd9ce' if args['workflow'] else args['session'] if args['session'] else None
+        args['share'] =  args['share'] if args['share'] else False
+        args['ebook_list'] = None
+
+        print(f"v{prog_version} {args['script_mode']} mode")
+
+        if args['script_mode'] == NATIVE:
+            check_pkg = check_and_install_requirements(requirements_file)
+            if check_pkg:
+                if not check_dictionary():
+                    sys.exit(1)
+            else:
+                error = 'Some packages could not be installed'
+                print(error)
+                sys.exit(1)
+
+        from lib.functions import SessionContext, convert_ebook_batch, convert_ebook, web_interface
+        ctx = SessionContext()
+        # Conditions based on the --headless flag
+        if args['headless']:
+            args['is_gui_process'] = False
+            args['audiobooks_dir'] = os.path.abspath(args['output_dir']) if args['output_dir'] else audiobooks_cli_dir
+            args['device'] = 'cuda' if args['device'] == 'gpu' else args['device']
+            args['tts_engine'] = TTS_ENGINES[args['tts_engine']] if args['tts_engine'] in TTS_ENGINES.keys() else args['tts_engine'] if args['tts_engine'] in TTS_ENGINES.values() else None
+            args['output_split'] = default_output_split
+            args['output_split_hours'] = default_output_split_hours
+            # Condition to stop if both --ebook and --ebooks_dir are provided
+            if args['ebook'] and args['ebooks_dir']:
+                error = 'Error: You cannot specify both --ebook and --ebooks_dir in headless mode.'
+                print(error)
+                sys.exit(1)
+            # convert in absolute path voice, custom_model if any
+            if args['voice']:
+                if os.path.exists(args['voice']):
+                    args['voice'] = os.path.abspath(args['voice'])
+            if args['custom_model']:
+                if os.path.exists(args['custom_model']):
+                    args['custom_model'] = os.path.abspath(args['custom_model'])
+            if not os.path.exists(args['audiobooks_dir']):
+                error = 'Error: --output_dir path does not exist.'
+                print(error)
+                sys.exit(1)                
+            if args['ebooks_dir']:
+                args['ebooks_dir'] = os.path.abspath(args['ebooks_dir'])
+                if not os.path.exists(args['ebooks_dir']):
+                    error = f'Error: The provided --ebooks_dir "{args["ebooks_dir"]}" does not exist.'
+                    print(error)
+                    sys.exit(1)                   
+                args['ebook_list'] = []
+                for file in os.listdir(args['ebooks_dir']):
+                    if any(file.endswith(ext) for ext in ebook_formats):
+                        full_path = os.path.abspath(os.path.join(args['ebooks_dir'], file))
+                        args['ebook_list'].append(full_path)
+                progress_status, passed = convert_ebook_batch(args, ctx)
+                if passed is False:
+                    error = f'Conversion failed: {progress_status}'
+                    print(error)
+                    sys.exit(1)
+            elif args['ebook']:
+                args['ebook'] = os.path.abspath(args['ebook'])
+                if not os.path.exists(args['ebook']):
+                    error = f'Error: The provided --ebook "{args["ebook"]}" does not exist.'
+                    print(error)
+                    sys.exit(1) 
+                progress_status, passed = convert_ebook(args, ctx)
+                if passed is False:
+                    error = f'Conversion failed: {progress_status}'
+                    print(error)
+                    sys.exit(1)
+            else:
+                error = 'Error: In headless mode, you must specify either an ebook file using --ebook or an ebook directory using --ebooks_dir.'
+                print(error)
+                sys.exit(1)       
+        else:
+            args['is_gui_process'] = True
+            passed_arguments = sys.argv[1:]
+            allowed_arguments = {'--share', '--script_mode'}
+            passed_args_set = {arg for arg in passed_arguments if arg.startswith('--')}
+            if passed_args_set.issubset(allowed_arguments):
+                 web_interface(args, ctx)
+            else:
+                error = 'Error: In non-headless mode, no option or only --share can be passed'
+                print(error)
+                sys.exit(1)
+if __name__ == '__main__':
+    main()

docker-compose.yml

@@ -0,0 +1,40 @@
+x-gpu-enabled: &gpu-enabled
+  devices:
+    - driver: nvidia
+      count: all
+      capabilities:
+        - gpu # Enables GPU access for the container.
+
+x-gpu-disabled: &gpu-disabled
+  devices: [] # Disables GPU access (default for systems without an NVIDIA GPU).
+
+services:
+  ebook2audiobook:
+    build:
+      context: .
+      args:
+        #TORCH_VERSION: cuda118 # Available tags: [cuda121, cuda118, cuda128, rocm, xpu, cpu] # All CUDA version numbers should work, Ex: CUDA 11.6-> cuda116
+        SKIP_XTTS_TEST: "true" # (Saves space by not baking xtts model into docker image)
+    # To update ebook2audiobook to the latest you may have to rebuild  
+    entrypoint: ["python", "app.py", "--script_mode", "full_docker"]
+    command: [] # <- Extra ebook2audiobook parameters can be added here
+    tty: true
+    stdin_open: true
+    ports:
+      - 7860:7860 # Maps container's port 7860 to the host's port 7860.
+    deploy:
+      resources:
+        reservations:
+          <<: *gpu-disabled # Use *gpu-enabled if you have an NVIDIA GPU.
+        limits: {} # Keeps limits as an empty mapping to avoid errors. Uncomment and configure below.
+    volumes:
+      - ./:/app  # Maps the local directory to the container.
+
+# Common Issues: ----
+# --> `python: can't open file '/home/user/app/app.py': [Errno 2] No such file or directory`
+# Removed all post arguments as CMD was replaced with ENTRYPOINT in the Dockerfile  
+# Example correction:  
+# Before: command: ["python", "app.py", "--script_mode", "full_docker"] or -> `docker run athomasson2/ebook2audiobook python app.py --script_mode full_docker`
+# After: nothing needed  or just -> `docker run athomasson2/ebook2audiobook`
+# Extra arguments after app.py can still be added to the -> command: [] 
+# Example adding extra arguments -> command: ["--share"] or -> command: ["--help"]

ebook2audiobook.cmd

@@ -0,0 +1,245 @@
+@echo off
+setlocal enabledelayedexpansion
+
+:: Capture all arguments into ARGS
+set "ARGS=%*"
+
+set "NATIVE=native"
+set "FULL_DOCKER=full_docker"
+
+set "SCRIPT_MODE=%NATIVE%"
+set "SCRIPT_DIR=%~dp0"
+
+set "ARCH=%PROCESSOR_ARCHITECTURE%"
+set "PYTHON_VERSION=3.12"
+set "PYTHON_ENV=python_env"
+set "PYTHONUTF8=1"
+set "PYTHONIOENCODING=utf-8"
+set "CURRENT_ENV="
+
+set "PROGRAMS_LIST=calibre-normal ffmpeg nodejs espeak-ng sox"
+
+set "TMP=%SCRIPT_DIR%\tmp"
+set "TEMP=%SCRIPT_DIR%\tmp"
+
+set "ESPEAK_DATA_PATH=%USERPROFILE%\scoop\apps\espeak-ng\current\eSpeak NG\espeak-ng-data"
+
+set "SCOOP_HOME=%USERPROFILE%\scoop"
+set "SCOOP_SHIMS=%SCOOP_HOME%\shims"
+set "SCOOP_APPS=%SCOOP_HOME%\apps"
+
+set "CONDA_URL=https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe"
+set "CONDA_INSTALL_DIR=%USERPROFILE%\Miniforge3"
+set "CONDA_INSTALLER=Miniforge3-Windows-x86_64.exe"
+set "CONDA_ENV=%CONDA_INSTALL_DIR%\condabin\conda.bat"
+set "CONDA_PATH=%CONDA_INSTALL_DIR%\condabin"
+
+set "NODE_PATH=%SCOOP_HOME%\apps\nodejs\current"
+
+set "PATH=%SCOOP_SHIMS%;%SCOOP_APPS%;%CONDA_PATH%;%NODE_PATH%;%PATH%" 2>&1 >nul
+
+set "SCOOP_CHECK=0"
+set "CONDA_CHECK=0"
+set "PROGRAMS_CHECK=0"
+set "DOCKER_CHECK=0"
+
+set "HELP_FOUND=%ARGS:--help=%"
+
+:: Refresh environment variables (append registry Path to current PATH)
+for /f "tokens=2,*" %%A in ('reg query "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /v Path') do (
+    set "PATH=%%B;%PATH%"
+)
+
+cd /d "%SCRIPT_DIR%"
+
+if "%ARCH%"=="x86" (
+	echo Error: 32-bit architecture is not supported.
+	goto :failed
+)
+
+:: Check if running inside Docker
+if defined CONTAINER (
+	set "SCRIPT_MODE=%FULL_DOCKER%"
+	goto :main
+)
+
+goto :scoop_check
+
+:scoop_check
+where /Q scoop
+if %errorlevel% neq 0 (
+	echo Scoop is not installed. 
+	set "SCOOP_CHECK=1"
+	goto :install_components
+)
+goto :conda_check
+exit /b
+
+:conda_check
+where /Q conda
+if %errorlevel% neq 0 (
+	call rmdir /s /q "%CONDA_INSTALL_DIR%" 2>nul
+	echo Miniforge3 is not installed. 
+	set "CONDA_CHECK=1"
+	goto :install_components
+)
+:: Check if running in a Conda environment
+if defined CONDA_DEFAULT_ENV (
+	set "CURRENT_ENV=%CONDA_PREFIX%"
+)
+:: Check if running in a Python virtual environment
+if defined VIRTUAL_ENV (
+	set "CURRENT_ENV=%VIRTUAL_ENV%"
+)
+for /f "delims=" %%i in ('where /Q python') do (
+	if defined CONDA_PREFIX (
+		if /i "%%i"=="%CONDA_PREFIX%\Scripts\python.exe" (
+			set "CURRENT_ENV=%CONDA_PREFIX%"
+			break
+		)
+	) else if defined VIRTUAL_ENV (
+		if /i "%%i"=="%VIRTUAL_ENV%\Scripts\python.exe" (
+			set "CURRENT_ENV=%VIRTUAL_ENV%"
+			break
+		)
+	)
+)
+if not "%CURRENT_ENV%"=="" (
+	echo Current python virtual environment detected: %CURRENT_ENV%. 
+	echo This script runs with its own virtual env and must be out of any other virtual environment when it's launched.
+	goto :failed
+)
+goto :programs_check
+exit /b
+
+:programs_check
+set "missing_prog_array="
+for %%p in (%PROGRAMS_LIST%) do (
+    set "prog=%%p"
+    if "%%p"=="nodejs" set "prog=node"
+	if "%%p"=="calibre-normal" set "prog=calibre"
+    where /Q !prog!
+    if !errorlevel! neq 0 (
+        echo %%p is not installed.
+        set "missing_prog_array=!missing_prog_array! %%p"
+    )
+)
+if not "%missing_prog_array%"=="" (
+    set "PROGRAMS_CHECK=1"
+    goto :install_components
+)
+goto :dispatch
+exit /b
+
+:install_components
+:: Install Scoop if not already installed
+if not "%SCOOP_CHECK%"=="0" (
+	echo Installing Scoop...
+    call powershell -command "Set-ExecutionPolicy RemoteSigned -scope CurrentUser"
+    call powershell -command "iwr -useb get.scoop.sh | iex"
+	call scoop install git
+	call scoop bucket add muggle https://github.com/hu3rror/scoop-muggle.git
+	call scoop bucket add extras
+	call scoop bucket add versions
+	echo Scoop installed successfully.
+	if "%PROGRAMS_CHECK%"=="0" (
+		set "SCOOP_CHECK=0"
+	)
+	start "" cmd /k cd /d "%CD%" ^& call "%~f0"
+	exit
+)
+:: Install Conda if not already installed
+if not "%CONDA_CHECK%"=="0" (
+	echo Installing Miniforge...
+	call powershell -Command "Invoke-WebRequest -Uri %CONDA_URL% -OutFile "%CONDA_INSTALLER%"
+	call start /wait "" "%CONDA_INSTALLER%" /InstallationType=JustMe /RegisterPython=0 /S /D=%UserProfile%\Miniforge3
+	where /Q conda
+	if !errorlevel! neq 0 (
+		echo Conda installation failed.
+		goto :failed
+	)
+	call conda config --set auto_activate_base false
+	call conda update conda -y
+	del "%CONDA_INSTALLER%"
+	set "CONDA_CHECK=0"
+	echo Conda installed successfully.
+	start "" cmd /k cd /d "%CD%" ^& call "%~f0"
+	exit
+)
+:: Install missing packages one by one
+if not "%PROGRAMS_CHECK%"=="0" (
+    echo Installing missing programs...
+	if "%SCOOP_CHECK%"=="0" (
+		call scoop bucket add muggle b https://github.com/hu3rror/scoop-muggle.git
+		call scoop bucket add extras
+		call scoop bucket add versions
+	)
+    for %%p in (%missing_prog_array%) do (
+		call scoop install %%p
+		set "prog=%%p"
+		if "%%p"=="nodejs" (
+			set "prog=node"
+		)
+		if "%%p"=="calibre-normal" set "prog=calibre"
+		where /Q !prog!
+		if !errorlevel! neq 0 (
+			echo %%p installation failed...
+			goto :failed
+		)
+    )
+	call powershell -command "[System.Environment]::SetEnvironmentVariable('Path', [System.Environment]::GetEnvironmentVariable('Path', 'User') + '%SCOOP_SHIMS%;%SCOOP_APPS%;%CONDA_PATH%;%NODE_PATH%;', 'User')"
+	set "SCOOP_CHECK=0"
+    set "PROGRAMS_CHECK=0"
+    set "missing_prog_array="
+)
+goto :dispatch
+exit /b
+
+:dispatch
+if "%SCOOP_CHECK%"=="0" (
+	if "%PROGRAMS_CHECK%"=="0" (
+		if "%CONDA_CHECK%"=="0" (
+			if "%DOCKER_CHECK%"=="0" (
+				goto :main
+			) else (
+				goto :failed
+			)
+		)
+	)
+)
+echo PROGRAMS_CHECK: %PROGRAMS_CHECK%
+echo CONDA_CHECK: %CONDA_CHECK%
+echo DOCKER_CHECK: %DOCKER_CHECK%
+goto :install_components
+exit /b
+
+:main
+if "%SCRIPT_MODE%"=="%FULL_DOCKER%" (
+	call python %SCRIPT_DIR%\app.py --script_mode %SCRIPT_MODE% %ARGS%
+) else (
+	if not exist "%SCRIPT_DIR%\%PYTHON_ENV%" (
+		call conda create --prefix "%SCRIPT_DIR%\%PYTHON_ENV%" python=%PYTHON_VERSION% -y
+		call %CONDA_ENV% activate base
+		call conda activate "%SCRIPT_DIR%\%PYTHON_ENV%"
+		call python -m pip cache purge >nul 2>&1
+		call python -m pip install --upgrade pip
+		for /f "usebackq delims=" %%p in ("requirements.txt") do (
+			echo Installing %%p...
+			call python -m pip install --upgrade --no-cache-dir --use-pep517 --progress-bar=on "%%p"
+		)
+		echo All required packages are installed.
+	) else (
+		call %CONDA_ENV% activate base
+		call conda activate "%SCRIPT_DIR%\%PYTHON_ENV%"
+	)
+	call python "%SCRIPT_DIR%\app.py" --script_mode %SCRIPT_MODE% %ARGS%
+	call conda deactivate
+)
+exit /b
+
+:failed
+echo ebook2audiobook is not correctly installed or run.
+exit /b
+
+endlocal
+pause

ebook2audiobook.sh

@@ -0,0 +1,326 @@
+#!/usr/bin/env bash
+
+if [[ "$OSTYPE" = "darwin"* && -z "$SWITCHED_TO_ZSH" && "$(ps -p $$ -o comm=)" != "zsh" ]]; then
+    export SWITCHED_TO_ZSH=1
+    exec env zsh "$0" "$@"
+fi
+
+unset SWITCHED_TO_ZSH
+
+ARCH=$(uname -m)
+PYTHON_VERSION="3.12"
+
+export PYTHONUTF8="1"
+export PYTHONIOENCODING="utf-8"
+export TTS_CACHE="./models"
+
+ARGS=("$@")
+
+declare -A arguments # associative array
+declare -a programs_missing # indexed array
+
+# Parse arguments
+while [[ "$#" -gt 0 ]]; do
+	case "$1" in
+		--*)
+			key="${1/--/}" # Remove leading '--'
+			if [[ -n "$2" && ! "$2" =~ ^-- ]]; then
+				# If the next argument is a value (not another option)
+				arguments[$key]="$2"
+				shift # Move past the value
+			else
+				# Set to true for flags without values
+				arguments[$key]=true
+			fi
+			;;
+		*)
+			echo "Unknown option: $1"
+			exit 1
+			;;
+	esac
+	shift # Move to the next argument
+done
+
+NATIVE="native"
+FULL_DOCKER="full_docker"
+
+SCRIPT_MODE="$NATIVE"
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+WGET=$(which wget 2>/dev/null)
+REQUIRED_PROGRAMS=("curl" "calibre" "ffmpeg" "nodejs" "espeak-ng" "rust" "sox")
+PYTHON_ENV="python_env"
+CURRENT_ENV=""
+
+if [[ "$OSTYPE" != "linux"* && "$OSTYPE" != "darwin"* ]]; then
+	echo "Error: OS $OSTYPE unsupported."
+	exit 1;
+fi
+
+if [[ "$OSTYPE" = "darwin"* ]]; then
+	CONDA_URL="https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-$(uname -m).sh"
+	CONFIG_FILE="$HOME/.zshrc"
+	if [[ "$ARCH" == "x86_64" ]]; then
+		PYTHON_VERSION="3.11"
+	fi
+elif [[ "$OSTYPE" = "linux"* ]]; then
+	CONDA_URL="https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
+	CONFIG_FILE="$HOME/.bashrc"
+fi
+
+CONDA_INSTALLER="/tmp/Miniforge3.sh"
+CONDA_INSTALL_DIR="$HOME/Miniforge3"
+CONDA_PATH="$CONDA_INSTALL_DIR/bin"
+CONDA_ENV="$CONDA_INSTALL_DIR/etc/profile.d/conda.sh"
+
+export TMPDIR="$SCRIPT_DIR/.cache"
+export PATH="$CONDA_PATH:$PATH"
+
+# Check if the current script is run inside a docker container
+if [[ -n "$container" || -f /.dockerenv ]]; then
+	SCRIPT_MODE="$FULL_DOCKER"
+else
+	if [[ -n "${arguments['script_mode']+exists}" ]]; then
+		if [ "${arguments['script_mode']}" = "$NATIVE" ]; then
+			SCRIPT_MODE="${arguments['script_mode']}"
+		fi
+	fi
+fi
+
+if [[ -n "${arguments['help']+exists}" && ${arguments['help']} = true ]]; then
+	python app.py "${ARGS[@]}"
+else
+	# Check if running in a Conda or Python virtual environment
+	if [[ -n "$CONDA_DEFAULT_ENV" ]]; then
+		CURRENT_ENV="$CONDA_PREFIX"
+	elif [[ -n "$VIRTUAL_ENV" ]]; then
+		CURRENT_ENV="$VIRTUAL_ENV"
+	fi
+
+	# If neither environment variable is set, check Python path
+	if [[ -z "$CURRENT_ENV" ]]; then
+		PYTHON_PATH=$(which python 2>/dev/null)
+		if [[ ( -n "$CONDA_PREFIX" && "$PYTHON_PATH" = "$CONDA_PREFIX/bin/python" ) || ( -n "$VIRTUAL_ENV" && "$PYTHON_PATH" = "$VIRTUAL_ENV/bin/python" ) ]]; then
+			CURRENT_ENV="${CONDA_PREFIX:-$VIRTUAL_ENV}"
+		fi
+	fi
+
+	# Output result if a virtual environment is detected
+	if [[ -n "$CURRENT_ENV" ]]; then
+		echo -e "Current python virtual environment detected: $CURRENT_ENV."
+		echo -e "This script runs with its own virtual env and must be out of any other virtual environment when it's launched."
+		echo -e "If you are using conda then you would type in:"
+		echo -e "conda deactivate"
+		exit 1
+	fi
+	
+	# Check if .cache folder exists inside the eb2ab folder for Miniforge3
+	if [[ ! -d .cache ]]; then
+		mkdir .cache
+	fi
+
+	function required_programs_check {
+		local programs=("$@")
+		programs_missing=()
+		for program in "${programs[@]}"; do
+			if [ "$program" = "nodejs" ]; then
+				bin="node"
+			elif [ "$program" = "rust" ]; then
+				if command -v apt-get &> /dev/null; then
+					bin="rustc"
+				fi
+			else
+				bin="$program"
+			fi
+			if ! command -v "$bin" >/dev/null 2>&1; then
+				echo -e "\e[33m$program is not installed.\e[0m"
+				programs_missing+=("$program")
+			fi
+		done
+		local count=${#programs_missing[@]}
+		if [[ $count -eq 0 ]]; then
+			return 0
+		else
+			return 1
+		fi
+	}
+
+	function install_programs {
+		if [[ "$OSTYPE" = "darwin"* ]]; then
+			echo -e "\e[33mInstalling required programs...\e[0m"
+			if [ ! -d $TMPDIR ]; then
+				mkdir -p $TMPDIR
+			fi
+			SUDO=""
+			PACK_MGR="brew install"
+				if ! command -v brew &> /dev/null; then
+					echo -e "\e[33mHomebrew is not installed. Installing Homebrew...\e[0m"
+					/usr/bin/env bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+					echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> $HOME/.zprofile
+					eval "$(/opt/homebrew/bin/brew shellenv)"
+				fi
+		else
+			SUDO="sudo"
+			echo -e "\e[33mInstalling required programs. NOTE: you must have 'sudo' priviliges to install ebook2audiobook.\e[0m"
+			PACK_MGR_OPTIONS=""
+			if command -v emerge &> /dev/null; then
+				PACK_MGR="emerge"
+			elif command -v dnf &> /dev/null; then
+				PACK_MGR="dnf install"
+				PACK_MGR_OPTIONS="-y"
+			elif command -v yum &> /dev/null; then
+				PACK_MGR="yum install"
+				PACK_MGR_OPTIONS="-y"
+			elif command -v zypper &> /dev/null; then
+				PACK_MGR="zypper install"
+				PACK_MGR_OPTIONS="-y"
+			elif command -v pacman &> /dev/null; then
+				PACK_MGR="pacman -Sy"
+			elif command -v apt-get &> /dev/null; then
+				$SUDO apt-get update
+				PACK_MGR="apt-get install"
+				PACK_MGR_OPTIONS="-y"
+			elif command -v apk &> /dev/null; then
+				PACK_MGR="apk add"
+			else
+				echo "Cannot recognize your applications package manager. Please install the required applications manually."
+				return 1
+			fi
+
+		fi
+		if [ -z "$WGET" ]; then
+			echo -e "\e[33m wget is missing! trying to install it... \e[0m"
+			result=$(eval "$PACK_MGR wget $PACK_MGR_OPTIONS" 2>&1)
+			result_code=$?
+			if [ $result_code -eq 0 ]; then
+				WGET=$(which wget 2>/dev/null)
+			else
+				echo "Cannot 'wget'. Please install 'wget'  manually."
+				return 1
+			fi
+		fi
+		for program in "${programs_missing[@]}"; do
+			if [ "$program" = "calibre" ];then				
+				# avoid conflict with calibre builtin lxml
+				pip uninstall lxml -y 2>/dev/null
+				echo -e "\e[33mInstalling Calibre...\e[0m"
+				if [[ "$OSTYPE" = "darwin"* ]]; then
+					eval "$PACK_MGR --cask calibre"
+				else
+					$WGET -nv -O- https://download.calibre-ebook.com/linux-installer.sh | $SUDO sh /dev/stdin
+				fi
+				if command -v $program >/dev/null 2>&1; then
+					echo -e "\e[32m===============>>> Calibre is installed! <<===============\e[0m"
+				else
+					eval "$SUDO $PACK_MGR $program $PACK_MGR_OPTIONS"				
+					if command -v $program >/dev/null 2>&1; then
+						echo -e "\e[32m===============>>> $program is installed! <<===============\e[0m"
+					else
+						echo "$program installation failed."
+					fi
+				fi	
+			elif [ "$program" = "rust" ]; then
+				if command -v apt-get &> /dev/null; then
+					app="rustc"
+				else
+					app="$program"
+				fi
+				curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+				source $HOME/.cargo/env
+				if command -v $app &>/dev/null; then
+					echo -e "\e[32m===============>>> $program is installed! <<===============\e[0m"
+				else
+					echo "$program installation failed."
+				fi
+			else
+				eval "$SUDO $PACK_MGR $program $PACK_MGR_OPTIONS"				
+				if command -v $program >/dev/null 2>&1; then
+					echo -e "\e[32m===============>>> $program is installed! <<===============\e[0m"
+				else
+					echo "$program installation failed."
+				fi
+			fi
+		done
+		if required_programs_check "${REQUIRED_PROGRAMS[@]}"; then
+			return 0
+		else
+			echo "Some programs didn't install successfuly, please report the log to the support"
+		fi
+	}
+
+	function conda_check {
+		if ! command -v conda &> /dev/null || [ ! -f "$CONDA_ENV" ]; then
+			echo -e "\e[33mDownloading Miniforge3 installer...\e[0m"
+			if [[ "$OSTYPE" = "darwin"* ]]; then
+				curl -fsSLo "$CONDA_INSTALLER" "$CONDA_URL"
+			else
+				wget -O "$CONDA_INSTALLER" "$CONDA_URL"
+			fi
+			if [[ -f "$CONDA_INSTALLER" ]]; then
+				echo -e "\e[33mInstalling Miniforge3...\e[0m"
+				bash "$CONDA_INSTALLER" -b -u -p "$CONDA_INSTALL_DIR"
+				rm -f "$CONDA_INSTALLER"
+				if [[ -f "$CONDA_INSTALL_DIR/bin/conda" ]]; then
+					$CONDA_INSTALL_DIR/bin/conda config --set auto_activate_base false
+					source $CONDA_ENV
+					echo -e "\e[32m===============>>> conda is installed! <<===============\e[0m"
+				else
+					echo -e "\e[31mconda installation failed.\e[0m"		
+					return 1
+				fi
+			else
+				echo -e "\e[31mFailed to download Miniforge3 installer.\e[0m"
+				echo -e "\e[33mI'ts better to use the install.sh to install everything needed.\e[0m"
+				return 1
+			fi
+		fi
+		if [[ ! -d "$SCRIPT_DIR/$PYTHON_ENV" ]]; then
+			# Use this condition to chmod writable folders once
+			chmod -R 777 ./audiobooks ./tmp ./models
+			conda create --prefix "$SCRIPT_DIR/$PYTHON_ENV" python=$PYTHON_VERSION -y
+			conda init > /dev/null 2>&1
+			source $CONDA_ENV
+			conda activate "$SCRIPT_DIR/$PYTHON_ENV"
+			python -m pip cache purge > /dev/null 2>&1
+			python -m pip install --upgrade pip
+			python -m pip install --upgrade --no-cache-dir --use-pep517 --progress-bar=on -r requirements.txt
+			tts_version=$(python -c "import importlib.metadata; print(importlib.metadata.version('coqui-tts'))" 2>/dev/null)
+			if [[ -n "$tts_version" ]]; then
+				if [[ "$(printf '%s\n' "$tts_version" "0.26.1" | sort -V | tail -n1)" == "0.26.1" ]]; then
+					python -m pip install --no-cache-dir --use-pep517 --progress-bar=on 'transformers<=4.51.3'
+				fi
+			fi
+			conda deactivate
+		fi
+		return 0
+	}
+
+	if [ "$SCRIPT_MODE" = "$FULL_DOCKER" ]; then
+		python app.py --script_mode "$SCRIPT_MODE" "${ARGS[@]}"
+		conda deactivate
+		conda deactivate
+	elif [ "$SCRIPT_MODE" = "$NATIVE" ]; then
+		pass=true
+		if [ "$SCRIPT_MODE" = "$NATIVE" ]; then		   
+			if ! required_programs_check "${REQUIRED_PROGRAMS[@]}"; then
+				if ! install_programs; then
+					pass=false
+				fi
+			fi
+		fi
+		if [ $pass = true ]; then
+			if conda_check; then
+				conda init > /dev/null 2>&1
+				source $CONDA_ENV
+				conda activate "$SCRIPT_DIR/$PYTHON_ENV"
+				python app.py --script_mode "$SCRIPT_MODE" "${ARGS[@]}"
+				conda deactivate
+				conda deactivate
+			fi
+		fi
+	else
+		echo -e "\e[33mebook2audiobook is not correctly installed or run.\e[0m"
+	fi
+fi
+
+exit 0

podman-compose.yml

@@ -0,0 +1,34 @@
+x-gpu-enabled: &gpu-enabled
+  devices:
+    - /dev/nvidia0:/dev/nvidia0
+    - /dev/nvidiactl:/dev/nvidiactl
+    - /dev/nvidia-uvm:/dev/nvidia-uvm
+x-gpu-disabled: &gpu-disabled
+  devices: [] # Disables GPU access (default for systems without an NVIDIA GPU).
+
+services:
+  ebook2audiobook:
+    build:
+      context: .
+      args:
+        #TORCH_VERSION: cuda118 # Available tags: [cuda121, cuda118, cuda128, rocm, xpu, cpu] # All CUDA version numbers should work, Ex: CUDA 11.6-> cuda116
+        SKIP_XTTS_TEST: "true" # (Saves space by not baking xtts model into docker image)
+    # To update ebook2audiobook to the latest you may have to rebuild  
+    entrypoint: ["python", "app.py", "--script_mode", "full_docker"]
+    command: [] # <- Extra ebook2audiobook parameters can be added here
+    tty: true
+    stdin_open: true
+    ports:
+      - 7860:7860 # Maps container's port 7860 to the host's port 7860.
+    <<: *gpu-disabled # Use *gpu-enabled if you have an NVIDIA GPU.
+    volumes:
+      - ./:/app  # Maps the local directory to the container.
+
+# Common Issues: ----
+# --> `python: can't open file '/home/user/app/app.py': [Errno 2] No such file or directory`
+# Removed all post arguments as CMD was replaced with ENTRYPOINT in the Dockerfile  
+# Example correction:  
+# Before: command: ["python", "app.py", "--script_mode", "full_docker"] or -> `podman run athomasson2/ebook2audiobook python app.py --script_mode full_docker`
+# After: nothing needed  or just -> `podman run athomasson2/ebook2audiobook`
+# Extra arguments after app.py can still be added to the -> command: [] 
+# Example adding extra arguments -> command: ["--share"] or -> command: ["--help"]

pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+name = "ebook2audiobook"
+requires = ["setuptools >= 64"]
+build-backend = "setuptools.build_meta"
+
+[tool.poetry]
+name = "ebook2audiobook"
+version = "0.0.0"
+
+[tool.setuptools.dynamic]
+version = {file = "VERSION.txt"}
+
+[project]
+name = "ebook2audiobook"
+description = "Convert eBooks to audiobooks with chapters and metadata"
+authors = [
+    { name = "Drew Thomasson" }
+]
+dependencies = [
+	"argostranslate",
+	"beautifulsoup4",
+	"cutlet",
+	"deep_translator",
+	"demucs",
+	"docker",
+	"ebooklib",
+	"fastapi",
+	"fugashi",
+	"gradio>=5.42.0",
+	"hangul-romanize",
+	"indic-nlp-library",
+	"iso-639",
+	"jieba",
+	"soynlp",
+	"pythainlp">
+	"pydub",
+	"pyannote-audio",
+	"mutagen",
+	"nvidia-ml-py",
+	"PyOpenGL",
+	"pypinyin",
+	"ray",
+	"regex",
+	"translate",
+	"tqdm",
+	"unidic",
+	"pymupdf4llm",
+	"sudachipy",
+	"sudachidict_core",
+	"transformers==4.51.3",
+	"coqui-tts[languages]==0.26.0",
+	"torchvggish"
+]
+readme = "README.md"
+requires-python = ">3.9,<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"

requirements.txt

@@ -0,0 +1,35 @@
+argostranslate
+beautifulsoup4
+cutlet
+deep_translator
+demucs
+docker
+ebooklib
+fastapi
+fugashi
+gradio>=5.42.0
+hangul-romanize
+indic-nlp-library
+iso-639
+jieba
+soynlp
+num2words
+pythainlp
+mutagen
+nvidia-ml-py
+phonemizer-fork
+pydub
+pyannote-audio
+PyOpenGL
+pypinyin
+ray
+regex
+translate
+tqdm
+unidic
+pymupdf4llm
+sudachipy
+sudachidict_core
+transformers==4.51.3
+coqui-tts[languages]==0.26.0
+torchvggish

setup.py

@@ -0,0 +1,54 @@
+import subprocess
+import sys
+from setuptools import setup, find_packages
+from setuptools.command.develop import develop
+from setuptools.command.install import install
+import os
+
+cwd = os.path.dirname(os.path.abspath(__file__))
+
+def get_version():
+    with open("VERSION.txt", "r") as f:
+        return f.read().strip()
+
+with open("README.md", "r", encoding='utf-8') as fh:
+    long_description = fh.read()
+
+with open('requirements.txt') as f:
+    requirements = f.read().splitlines()
+
+class PostInstallCommand(install):
+    def run(self):
+        install.run(self)
+        try:
+            subprocess.run([sys.executable, 'python -m', 'unidic', 'download'], check=True)
+        except Exception:
+            print("unidic download failed during installation, but it will be re-attempted a diffrent way when the app itself runs.")
+
+
+setup(
+    name='ebook2audiobook',
+    version=get_version(),
+    python_requires=">3.9,<3.13",
+    author="Drew Thomasson",
+    description="Convert eBooks to audiobooks with chapters and metadata",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/DrewThomasson/ebook2audiobook",
+    packages=find_packages(),
+    install_requires=requirements,
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    include_package_data=True,
+    entry_points={
+        "console_scripts": [
+            "ebook2audiobook = app:main",
+        ],
+    },
+    cmdclass={
+        'install': PostInstallCommand,
+    }
+)