omnivoice 0.1.0__tar.gz

omnivoice-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+*.egg
+dist/
+build/
+.venv/
+.env
+.DS_Store
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.so
+/.cache*
+/exp*/
+/.tmp/
+/results/
+/data/
+/download
+/local/
+/run*
+example.py
+results/
+examples/data*
+examples/download*
+examples/exp*/
+.claude/
+*.wav
+*.jsonl

omnivoice-0.1.0/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 2026 Xiaomi Corp.
+
+   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.

omnivoice-0.1.0/PKG-INFO

@@ -0,0 +1,333 @@
+Metadata-Version: 2.4
+Name: omnivoice
+Version: 0.1.0
+Summary: OmniVoice: Towards Omnilingual Zero-Shot Text-to-Speech with Diffusion Language Models
+Project-URL: Homepage, https://github.com/k2-fsa/OmniVoice
+Project-URL: Repository, https://github.com/k2-fsa/OmniVoice
+Project-URL: Bug Tracker, https://github.com/k2-fsa/OmniVoice/issues
+Author: Han Zhu
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: diffusion,multilingual,speech-synthesis,text-to-speech,tts,voice-cloning,zero-shot
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: accelerate
+Requires-Dist: gradio
+Requires-Dist: numpy
+Requires-Dist: pydub
+Requires-Dist: soundfile
+Requires-Dist: tensorboardx
+Requires-Dist: torch==2.8.*
+Requires-Dist: torchaudio==2.8.*
+Requires-Dist: transformers==5.3.0
+Requires-Dist: webdataset
+Provides-Extra: eval
+Requires-Dist: funasr; extra == 'eval'
+Requires-Dist: jiwer==3.1.0; extra == 'eval'
+Requires-Dist: librosa; extra == 'eval'
+Requires-Dist: s3prl; extra == 'eval'
+Requires-Dist: unidecode; extra == 'eval'
+Requires-Dist: zhconv; extra == 'eval'
+Requires-Dist: zhon; extra == 'eval'
+Description-Content-Type: text/markdown
+
+# OmniVoice 🌍
+
+<p align="center">
+  <img width="200" height="200" alt="OmniVoice" src="assets/omnivoice.jpg" />
+</p>
+
+<p align="center">
+  <a href="https://huggingface.co/k2-fsa/OmniVoice"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Model-FFD21E" alt="Hugging Face Model"></a>
+  &nbsp;
+  <a href="https://huggingface.co/spaces/k2-fsa/OmniVoice"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Space-blue" alt="Hugging Face Space"></a>
+  &nbsp;
+  <a href="https://arxiv.org/abs/2604.00688"><img src="https://img.shields.io/badge/arXiv-Paper-B31B1B.svg"></a>
+  &nbsp;
+  <a href="https://zhu-han.github.io/omnivoice"><img src="https://img.shields.io/badge/GitHub.io-Demo_Page-blue?logo=GitHub&style=flat-square"></a>
+</p>
+
+OmniVoice is a state-of-the-art zero-shot multilingual TTS model supporting more than 600 languages. Built on a novel diffusion language model architecture, it generates high-quality speech with superior inference speed, supporting voice cloning and voice design.
+
+**Contents**: [Key Features](#key-features) | [Installation](#installation) | [Quick Start](#quick-start) | [Python API](#python-api) | [Command-Line Tools](#command-line-tools) | [Training & Evaluation](#training--evaluation) | [Discussion](#discussion--communication) | [Citation](#citation)
+
+## Key Features
+
+- **600+ Languages Supported**: The broadest language coverage among zero-shot TTS models ([full list](docs/languages.md))
+- **Voice Cloning**: State-of-the-art voice cloning quality.
+- **Voice Design**: Control voices via assigned speaker attributes (gender, age, pitch, dialect/accent, whisper, etc.).
+- **Fast Inference**: RTF as low as 0.025 (40x faster than real-time).
+- **Diffusion Language Model Architecture**: A clean, streamlined, and scalable design that delivers both quality and speed.
+
+---
+
+## Installation
+
+Choose **one** of the following methods: **pip** or **uv**.
+
+### pip
+
+> We recommend using a fresh virtual environment (e.g., `conda`, `venv`, etc.) to avoid conflicts.
+
+**Step 1**: Install PyTorch
+
+<details>
+<summary>NVIDIA GPU</summary>
+
+```bash
+# Install pytorch with your CUDA version, e.g.
+pip install torch==2.8.0+cu128 torchaudio==2.8.0+cu128 --extra-index-url https://download.pytorch.org/whl/cu128
+```
+> See [PyTorch official site](https://pytorch.org/get-started/locally/) for other versions installation.
+
+</details>
+
+<details>
+<summary>Apple Silicon</summary>
+
+```bash
+pip install torch==2.8.0 torchaudio==2.8.0
+```
+
+</details>
+
+**Step 2**: Install OmniVoice (choose one)
+
+```bash
+# From PyPI (stable release)
+pip install omnivoice
+
+# From the latest source on GitHub (no need to clone)
+pip install git+https://github.com/k2-fsa/OmniVoice.git
+
+# For development (clone first, editable install)
+git clone https://github.com/k2-fsa/OmniVoice.git
+cd OmniVoice
+pip install -e .
+```
+
+### uv
+
+Clone the repository and sync dependencies:
+
+```bash
+git clone https://github.com/k2-fsa/OmniVoice.git
+cd OmniVoice
+uv sync
+```
+
+> **Tip**: Can use mirror with `uv sync --default-index "https://mirrors.aliyun.com/pypi/simple"`
+
+---
+
+## Quick Start
+
+Try OmniVoice without coding:
+
+- Launch the local web UI: `omnivoice-demo --ip 0.0.0.0 --port 8001`
+
+
+- Or try it directly on [HuggingFace Space](https://huggingface.co/spaces/k2-fsa/OmniVoice)
+
+> If you have trouble connecting to HuggingFace when downloading the pre-trained models, set `export HF_ENDPOINT="https://hf-mirror.com"` before running.
+
+For full usage, see the [Python API](#python-api) and [Command-Line Tools](#command-line-tools) sections below.
+
+---
+
+## Python API
+
+The OmniVoice model supports three generation modes. All features in this section are also available via [command-line tools](#command-line-tools).
+
+### Voice Cloning
+
+Clone a voice from a short reference audio. Provide `ref_audio` and `ref_text`:
+
+```python
+from omnivoice import OmniVoice
+import torch
+import torchaudio
+
+model = OmniVoice.from_pretrained(
+    "k2-fsa/OmniVoice",
+    device_map="cuda:0",
+    dtype=torch.float16
+)
+# Apple Silicon users: use device_map="mps" instead
+
+audio = model.generate(
+    text="Hello, this is a test of zero-shot voice cloning.",
+    ref_audio="ref.wav",
+    ref_text="Transcription of the reference audio.",
+) # audio is a list of `torch.Tensor` with shape (1, T) at 24 kHz.
+
+# If you don't want to input `ref_text` manually, you can directly omit the `ref_text`.
+# The model will use Whisper ASR to auto-transcribe it.
+
+torchaudio.save("out.wav", audio[0], 24000)
+```
+
+### Voice Design
+
+Describe the desired voice with speaker attributes — no reference audio needed.
+Supported attributes: **gender** (male/female), **age** (child to elderly),
+**pitch** (very low to very high), **style** (whisper), **English accent**
+(American, British, etc.), and **Chinese dialect** (四川话, 陕西话, etc.).
+Attributes are comma-separated and freely combinable across categories.
+
+```python
+audio = model.generate(
+    text="Hello, this is a test of zero-shot voice design.",
+    instruct="female, low pitch, british accent",
+)
+```
+
+See [docs/voice-design.md](docs/voice-design.md) for the full attribute
+reference, Chinese equivalents, and usage tips.
+
+### Auto Voice
+
+Let the model choose a voice automatically:
+
+```python
+audio = model.generate(text="This is a sentence without any voice prompt.")
+```
+
+### Generation Parameters
+
+All above three modes share the same `model.generate()` API. You can further control the generation behavior via keyword arguments:
+
+```python
+audio = model.generate(
+    text="...",
+    num_step=32,  # diffusion steps (or 16 for faster inference)
+    speed=1.0,     # speed factor (>1.0 faster, <1.0 slower)
+    duration=10.0, # fixed output duration in seconds (overrides speed)
+    # ... more options
+)
+```
+See more detailed control in [docs/generation-parameters.md](docs/generation-parameters.md).
+
+### Non-Verbal & Pronunciation Control
+
+OmniVoice supports inline **non-verbal symbols** and **pronunciation hints** within the input text.
+
+**Non-verbal symbols**: Insert tags like `[laughter]` directly in the text to add expressive non-verbal sounds.
+
+```python
+audio = model.generate(text="[laughter] You really got me. I didn't see that coming at all.")
+```
+
+Supported tags: `[laughter]`, `[confirmation-en]`, `[question-en]`, `[question-ah]`, `[question-oh]`, `[question-ei]`, `[question-yi]`, `[surprise-ah]`, `[surprise-oh]`, `[surprise-wa]`, `[surprise-yo]`, `[dissatisfaction-hnn]`, `[sniff]`, `[sigh]`
+
+**Pronunciation control (Chinese)**: Use pinyin with tone numbers to correct specific character pronunciations.
+
+```python
+audio = model.generate(text="这批货物打ZHE2出售后他严重SHE2本了，再也经不起ZHE1腾了。")
+```
+
+**Pronunciation control (English)**: Use [CMU pronunciation dictionary](https://svn.code.sf.net/p/cmusphinx/code/trunk/cmudict/cmudict.0.7a)  (uppercase, in brackets) to override default English pronunciations.
+
+```python
+audio = model.generate(text="You could probably still make [IH1 T] look good.")
+```
+
+---
+
+## Command-Line Tools
+
+Three CLI entry points are provided. The CLI tools support all features available in the Python API (voice cloning, voice design, auto voice, generation parameters, etc.) — all controlled via command-line arguments.
+
+| Command | Description | Source |
+|---|---|---|
+| `omnivoice-demo` | Interactive Gradio web demo | [omnivoice/cli/demo.py](omnivoice/cli/demo.py) |
+| `omnivoice-infer` | Single-item inference | [omnivoice/cli/infer.py](omnivoice/cli/infer.py) |
+| `omnivoice-infer-batch` | Batch inference across multiple GPUs | [omnivoice/cli/infer_batch.py](omnivoice/cli/infer_batch.py) |
+
+### Demo
+
+```bash
+omnivoice-demo --ip 0.0.0.0 --port 8001
+```
+
+Provides a web UI for voice cloning and voice design. See `omnivoice-demo --help` for all options.
+
+### Single Inference
+
+```bash
+# Voice Cloning
+# ref_text can be omitted (Whisper will auto-transcribe ref_audio to get it).
+omnivoice-infer \
+    --model k2-fsa/OmniVoice \
+    --text "This is a test for text to speech." \
+    --ref_audio ref.wav \
+    --ref_text "Transcription of the reference audio." \
+    --output hello.wav
+
+# Voice Design
+omnivoice-infer --model k2-fsa/OmniVoice \
+    --text "This is a test for text to speech." \
+    --instruct "male, British accent" \
+    --output hello.wav
+
+# Auto Voice
+omnivoice-infer \
+    --model k2-fsa/OmniVoice \
+    --text "This is a test for text to speech."\
+    --output hello.wav
+```
+
+### Batch Inference
+
+`omnivoice-infer-batch` can distribute batch inference across multiple GPUs, designed for large-scale TTS tasks.
+
+```bash
+omnivoice-infer-batch \
+    --model k2-fsa/OmniVoice \
+    --test_list test.jsonl \
+    --res_dir results/
+```
+
+The test list is a JSONL file where each line is a JSON object:
+```json
+{"id": "sample_001", "text": "Hello world", "ref_audio": "/path/to/ref.wav", "ref_text": "Reference transcript", "instruct": "female, british accent", "language_id": "en", "language_name": "English", "duration": 10.0, "speed": 1.0}
+```
+Only `id` and `text` are mandatory fields. `ref_audio` and `ref_text` are used in voice cloning mode. `instruct` is used in voice design mode. If no reference audio or instruct are provided, the model will generate text in a random voice.
+
+`language_id`, `language_name`, `duration`, and `speed` are optional. `duration` (in seconds) fixes the output length; `speed` controls the speaking rate. If `duration` and `speed` are both provided, `speed` will be ignored.
+
+---
+
+## Training & Evaluation
+
+See [examples/](examples/) for the complete pipeline — from data preparation to training, evaluation, and finetuning.
+
+---
+
+## Discussion & Communication
+
+You can directly discuss on [GitHub Issues](https://github.com/k2-fsa/OmniVoice/issues).
+
+You can also scan the QR code to join our wechat group or follow our wechat official account.
+
+| Wechat Group | Wechat Official Account |
+| ------------ | ----------------------- |
+|![wechat](https://k2-fsa.org/zh-CN/assets/pic/wechat_group.jpg) |![wechat](https://k2-fsa.org/zh-CN/assets/pic/wechat_account.jpg) |
+
+---
+
+## Citation
+
+```bibtex
+@article{zhu2026omnivoice,
+      title={OmniVoice: Towards Omnilingual Zero-Shot Text-to-Speech with Diffusion Language Models},
+      author={Zhu, Han and Ye, Lingxuan and Kang, Wei and Yao, Zengwei and Guo, Liyong and Kuang, Fangjun and Han, Zhifeng and Zhuang, Weiji and Lin, Long and Povey, Daniel},
+      journal={arXiv preprint arXiv:2604.00688},
+      year={2026}
+}
+```