rlx-neutts 0.2.5

NeuTTS voice-cloning TTS — GGUF backbone + NeuCodec decoder for RLX
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// RLX — versatile ML compiler + runtime.
// Copyright (C) 2026 Eugene Hauptmann, Nataliya Kosmyna.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! NeuCodec decoder — FSQ lookup + Vocos backbone + ISTFT head.
//!
//! | Feature     | Path                                      |
//! |-------------|-------------------------------------------|
//! | `codec`     | Eager ndarray CPU ([`eager`]) — default   |
//! | `burn`      | Burn wgpu → NdArray → eager fallback      |
//! | `rlx`       | RLX runtime (eager parity until graph)    |
//!
//! Decoder weights are **not** shipped in this crate. Set [`decoder_weights_path`] via
//! `NEUTTS_DECODER_PATH` (path to `neucodec_decoder.safetensors`).

use std::path::PathBuf;

use anyhow::{Result, bail};

mod eager;

#[cfg(feature = "burn")]
mod burn;

#[cfg(feature = "rlx")]
mod rlx;

pub use eager::{
    ENCODER_DEFAULT_INPUT_SAMPLES, ENCODER_SAMPLE_RATE, ENCODER_SAMPLES_PER_TOKEN, NeuCodecDecoder,
    NeuCodecEncoder, SAMPLE_RATE, SAMPLES_PER_TOKEN,
};

pub use crate::features::{burn_feature_enabled, rlx_feature_enabled, wgpu_feature_enabled};

/// Resolve NeuCodec decoder weights from `NEUTTS_DECODER_PATH`.
pub fn decoder_weights_path() -> Result<PathBuf> {
    let path = std::env::var("NEUTTS_DECODER_PATH")
        .ok()
        .filter(|p| !p.is_empty())
        .map(PathBuf::from)
        .ok_or_else(|| {
            anyhow::anyhow!(
                "NEUTTS_DECODER_PATH is not set (NeuCodec weights are not bundled in rlx-neutts)"
            )
        })?;
    if !path.exists() {
        bail!("NEUTTS_DECODER_PATH does not exist: {}", path.display());
    }
    Ok(path)
}

/// Like [`decoder_weights_path`], but returns `None` when unset or missing (for tests).
pub fn decoder_weights_path_if_available() -> Option<PathBuf> {
    let path = std::env::var("NEUTTS_DECODER_PATH")
        .ok()
        .filter(|p| !p.is_empty())
        .map(PathBuf::from)?;
    if path.exists() { Some(path) } else { None }
}