95 lines
4.5 KiB
Markdown
95 lines
4.5 KiB
Markdown
# ComfyUI Dia TTS Nodes
|
|
|
|
This node pack integrates the [Nari-Labs Dia](https://github.com/nari-labs/dia) 1.6b text-to-speech model into ComfyUI using the safetensors file nari-labs provided.
|
|
|
|
Dia allows generating dialogue with speaker tags (`[S1]`, `[S2]`) and non-verbal sounds (`(laughs)`, etc.).
|
|
|
|
It **requires a CUDA-enabled GPU**.
|
|
|
|
**Note:** This version is specifically configured for the `nari-labs/Dia-1.6B` model architecture.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
1. Ensure you have a CUDA-enabled GPU and the necessary NVIDIA drivers installed.
|
|
2. Download the Dia-1.6B model safetensors file from Hugging Face:
|
|
* **Direct Download URL:** [https://huggingface.co/nari-labs/Dia-1.6B/blob/main/model.safetensors](https://huggingface.co/nari-labs/Dia-1.6B/resolve/main/model.safetensors?download=true)
|
|
3. Place the downloaded `.safetensors` file into the `diffusion_models` directory (e.g., `ComfyUI/models/diffusion_models/`).
|
|
4. You might want to rename it to `Dia-1.6B.safetensors` for clarity.
|
|
5. Navigate to your `ComfyUI/custom_nodes/` directory.
|
|
6. Clone this repository:
|
|
```bash
|
|
git clone https://github.com/BobRandomNumber/ComfyUI-DiaTest.git
|
|
```
|
|
Alternatively, download the ZIP and extract it into `custom_nodes`.
|
|
7. Install the required dependencies:
|
|
* Activate ComfyUI's Python environment (e.g., `source ./venv/bin/activate`).
|
|
* Navigate to the node directory: `cd ComfyUI/custom_nodes/ComfyUI-DiaTest`
|
|
* Install requirements: `pip install -r requirements.txt`
|
|
8. Restart ComfyUI.
|
|
|
|
## Nodes
|
|
|
|
### Dia 1.6b Loader (`DiaLoader`)
|
|
|
|
Loads the Dia-1.6B TTS model from a local `.safetensors` file located in your `diffusion_models` directory. Loads the model weights and the required DAC codec onto the GPU.
|
|
|
|
**Inputs:**
|
|
|
|
* `ckpt_name`: Dropdown list of found `.safetensors` files within your `diffusion_models` directory. Select the file corresponding to the Dia-1.6B model.
|
|
|
|
**Outputs:**
|
|
|
|
* `dia_model`: A custom `DIA_MODEL` object containing the loaded Dia model instance, ready for the `DiaGenerate` node.
|
|
|
|
### Dia TTS Generate (`DiaGenerate`)
|
|
|
|
Generates audio using a pre-loaded Dia model provided by the `DiaLoader` node. Displays a progress bar during generation.
|
|
|
|
**Inputs:**
|
|
|
|
* `dia_model`: The `DIA_MODEL` output from the `DiaLoader` node.
|
|
* `text`: The main text transcript to generate audio for. Use `[S1]`, `[S2]` for speaker turns and parentheses for non-verbals like `(laughs)`.
|
|
* `max_tokens`: Maximum number of audio tokens to generate (controls length).
|
|
* `cfg_scale`: Classifier-Free Guidance scale.
|
|
* `temperature`: Sampling temperature.
|
|
* `top_p`: Nucleus sampling probability.
|
|
* `cfg_filter_top_k`: Top-K filtering applied during CFG.
|
|
* `speed_factor`: Adjusts the speed of the generated audio (1.0 = original speed).
|
|
* `seed`: Random seed for reproducibility.
|
|
|
|
**Outputs:**
|
|
|
|
* `audio`: The generated audio (`AUDIO` format: `{'waveform': tensor[B,C,T], 'sample_rate': sr}`), ready to be saved or previewed. Sample rate is 44100 Hz.
|
|
|
|
## Usage Example
|
|
|
|
1. Add the `Dia 1.6b Loader` node from the `audio/DiaTTS` category.
|
|
2. Select your Dia model file (e.g., `dia-1.6B.safetensors`) from the `ckpt_name` dropdown.
|
|
3. Add the `Dia TTS Generate` node (also from `audio/DiaTTS`).
|
|
4. Connect the `dia_model` output of the Loader node to the `dia_model` input of the Generate node.
|
|
5. Enter your dialogue script into the `text` input on the Generate node.
|
|
|
|
Control speaker dialogue via `[S1]` and `[S2]` ect., tags.
|
|
|
|
Add tags like `(laughs)`, `(clears throat)`, `(sighs)`, `(gasps)`, `(coughs)`, `(singing)`, `(sings)`, `(mumbles)`, `(beep)`, `(groans)`, `(sniffs)`, `(claps)`, `(screams)`, `(inhales)`, `(exhales)`, `(applause)`, `(burps)`, `(humming)`, `(sneezes)`, `(chuckle)`, `(whistles)`
|
|
|
|
These verbal tags will be recognized, but may result in unexpected output.
|
|
|
|
7. Adjust generation parameters on the Generate node as needed.
|
|
8. Connect the `audio` output of the Generate node to a `SaveAudio` or `PreviewAudio` node.
|
|
9. Queue the prompt.
|
|
|
|
## Notes
|
|
|
|
* This node pack **requires a CUDA-enabled GPU**.
|
|
* Only the `.safetensors` weights file is required.
|
|
* The first run of the nodes descript-audio-codec may take slightly longer. Subsequent runs will be faster.
|
|
* Dependencies `descript-audio-codec` must be installed via `requirements.txt`.
|
|
|
|
## To Do
|
|
|
|
- [x] Remove huggingface download and add safetensor support
|
|
- [ ] add audio propmpt support
|