flockspeech 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,76 @@
1
+ """Flock Speech: tiny text-to-speech that runs on your own device.
2
+
3
+ from flockspeech import Junco
4
+ tts = Junco()
5
+ audio = tts("Hello there.") # float32 numpy array, 24 kHz mono
6
+ tts.save("Hello there.", "hi.wav")
7
+ for chunk in tts.stream(long_text): # one sentence at a time, for low latency
8
+ ...
9
+ """
10
+ import time
11
+ import wave
12
+
13
+ import numpy as np
14
+
15
+ from .engine import Engine, default_threads
16
+ from .text import Phonemizer, split_sentences, to_ids
17
+
18
+ __version__ = "0.1.0"
19
+ __all__ = ["Junco", "write_wav", "__version__"]
20
+
21
+
22
+ def write_wav(path, audio, sr=24000):
23
+ """16-bit PCM mono WAV, standard library only."""
24
+ pcm = (np.clip(audio, -1.0, 1.0) * 32767.0).astype("<i2")
25
+ with wave.open(str(path), "wb") as f:
26
+ f.setnchannels(1)
27
+ f.setsampwidth(2)
28
+ f.setframerate(sr)
29
+ f.writeframes(pcm.tobytes())
30
+
31
+
32
+ class Junco:
33
+ """Junco v0.1: one English (US) voice, 24 kHz. Thread-safe for reading; create one per process and reuse it.
34
+
35
+ threads: CPU threads for ONNX Runtime (default: up to 4).
36
+ coreml: run the vocoder with CoreML on Apple silicon (default off: faster on one thread, twice the memory).
37
+ model_dir: a folder with other exported graphs (default: the ones shipped in the package)."""
38
+
39
+ sample_rate = 24000
40
+
41
+ def __init__(self, threads=None, coreml=False, model_dir=None):
42
+ self.engine = Engine(model_dir, threads=threads, coreml=coreml)
43
+ self.version = self.engine.meta["version"]
44
+ self._ph = None
45
+
46
+ def _phonemes(self, sentences):
47
+ if self._ph is None:
48
+ self._ph = Phonemizer()
49
+ return self._ph(sentences)
50
+
51
+ def stream(self, text, speed=1.0, steps=None, seed=0, pause=0.25):
52
+ """Yield float32 audio sentence by sentence (a short pause after each but the last)."""
53
+ sents = split_sentences(text)
54
+ if not sents:
55
+ return
56
+ rng = np.random.default_rng(seed)
57
+ gap = np.zeros(int(pause * self.sample_rate), np.float32)
58
+ phs = self._phonemes(sents)
59
+ for k, ph in enumerate(phs):
60
+ ids = to_ids(ph)
61
+ if len(ids) < 3:
62
+ continue
63
+ mel, n = self.engine.mel(ids, steps=steps, speed=speed, rng=rng)
64
+ wav = self.engine.vocode(mel, n)
65
+ yield np.concatenate([wav, gap]) if k < len(phs) - 1 else wav
66
+
67
+ def __call__(self, text, speed=1.0, steps=None, seed=0, pause=0.25):
68
+ """Speak text; returns float32 audio at 24 kHz. speed>1 talks faster; steps (default 8) trades speed for
69
+ quality; seed fixes the random voice variation."""
70
+ parts = list(self.stream(text, speed=speed, steps=steps, seed=seed, pause=pause))
71
+ return np.concatenate(parts) if parts else np.zeros(0, np.float32)
72
+
73
+ def save(self, text, path, **kw):
74
+ audio = self(text, **kw)
75
+ write_wav(path, audio, self.sample_rate)
76
+ return audio
@@ -0,0 +1,3 @@
1
+ from .cli import main
2
+
3
+ main()
flockspeech/cli.py ADDED
@@ -0,0 +1,65 @@
1
+ """flockspeech "Hello there." -o hello.wav [--speed 1.0] [--steps 8] [--seed 0] [--threads N] [--play]
2
+ Text can also come from a file (-f) or standard input (-)."""
3
+ import argparse
4
+ import os
5
+ import platform
6
+ import shutil
7
+ import subprocess
8
+ import sys
9
+ import time
10
+
11
+
12
+ def _play(path):
13
+ for cmd in (["afplay"], ["aplay", "-q"], ["paplay"], ["ffplay", "-nodisp", "-autoexit", "-loglevel", "quiet"]):
14
+ if shutil.which(cmd[0]):
15
+ subprocess.run(cmd + [path])
16
+ return
17
+ if platform.system() == "Windows":
18
+ import winsound
19
+ winsound.PlaySound(path, winsound.SND_FILENAME)
20
+ return
21
+ print("no audio player found; open", path, file=sys.stderr)
22
+
23
+
24
+ def main(argv=None):
25
+ from . import Junco, __version__, write_wav
26
+
27
+ ap = argparse.ArgumentParser(prog="flockspeech", description="Tiny on-device text to speech (Junco voice).")
28
+ ap.add_argument("text", nargs="?", help='text to speak, or "-" to read standard input')
29
+ ap.add_argument("-f", "--file", help="read the text from a file")
30
+ ap.add_argument("-o", "--out", default="out.wav", help="output WAV (24 kHz, 16-bit); default out.wav")
31
+ ap.add_argument("--speed", type=float, default=1.0, help="1.2 talks 20%% faster")
32
+ ap.add_argument("--steps", type=int, default=None, help="flow steps (default 8; 4 is faster, a little rougher)")
33
+ ap.add_argument("--seed", type=int, default=0)
34
+ ap.add_argument("--threads", type=int, default=None, help="CPU threads (default: up to 4)")
35
+ ap.add_argument("--coreml", action="store_true", help="Apple silicon: run the vocoder with CoreML")
36
+ ap.add_argument("--play", action="store_true", help="play the result")
37
+ ap.add_argument("-q", "--quiet", action="store_true")
38
+ ap.add_argument("--version", action="version", version=f"flockspeech {__version__}")
39
+ a = ap.parse_args(argv)
40
+ if a.file:
41
+ with open(a.file, encoding="utf-8") as f:
42
+ text = f.read()
43
+ elif a.text == "-" or (a.text is None and not sys.stdin.isatty()):
44
+ text = sys.stdin.read()
45
+ else:
46
+ text = a.text
47
+ if not text or not text.strip():
48
+ ap.error('give some text, e.g. flockspeech "Hello there." --play')
49
+ t = time.perf_counter()
50
+ tts = Junco(threads=a.threads, coreml=a.coreml)
51
+ t_load = time.perf_counter() - t
52
+ t = time.perf_counter()
53
+ audio = tts(text, speed=a.speed, steps=a.steps, seed=a.seed)
54
+ t_gen = time.perf_counter() - t
55
+ write_wav(a.out, audio, tts.sample_rate)
56
+ if not a.quiet:
57
+ dur = len(audio) / tts.sample_rate
58
+ print(f"Junco {tts.version}: {dur:.1f} s of audio in {t_gen:.2f} s ({dur / max(t_gen, 1e-9):.1f}x real time, "
59
+ f"load {t_load:.2f} s) -> {os.path.abspath(a.out)}", file=sys.stderr)
60
+ if a.play:
61
+ _play(a.out)
62
+
63
+
64
+ if __name__ == "__main__":
65
+ main()
flockspeech/engine.py ADDED
@@ -0,0 +1,120 @@
1
+ """ONNX Runtime engine for Junco: phoneme ids -> encoder -> durations -> guided flow steps -> Vocos -> 24 kHz audio.
2
+ Needs only numpy and onnxruntime; no PyTorch.
3
+
4
+ Shipped graphs (made by tools/export_onnx.py in the training repo):
5
+ encoder ids (1, T) int64 -> mu (1, 100, T), logw (1, 1, T) fp16 weights, fp32 compute
6
+ decoder-int8 x, cond (1, 100, F), mask (1, 1, F), t (1,), w (1,) -> v int8 weights (dynamic quantisation)
7
+ vocoder mel (1, 100, F) -> real, imag (1, 513, F); ISTFT in numpy fp16 weights, fp32 compute
8
+ """
9
+ import json
10
+ import os
11
+
12
+ import numpy as np
13
+
14
+ HERE = os.path.dirname(os.path.abspath(__file__))
15
+ MODELS = os.path.join(HERE, "models")
16
+
17
+
18
+ def default_threads():
19
+ return max(1, min(4, os.cpu_count() or 1))
20
+
21
+
22
+ def _hann(n):
23
+ return (0.5 - 0.5 * np.cos(2 * np.pi * np.arange(n) / n)).astype(np.float32) # periodic, as torch.hann_window
24
+
25
+
26
+ _ENV = {}
27
+
28
+
29
+ def istft(real, imag, n_fft=1024, hop=256):
30
+ """torch.istft(center=True, periodic Hann) for one (n_fft//2+1, F) spectrogram -> (F-1)*hop samples."""
31
+ frames = np.fft.irfft(real + 1j * imag, n_fft, axis=0).astype(np.float32) # (n_fft, F)
32
+ win = _hann(n_fft)
33
+ F_ = frames.shape[1]
34
+ frames *= win[:, None]
35
+ r = n_fft // hop # overlap factor: add r strided slabs instead of looping over frames
36
+ n = n_fft + hop * (F_ - 1)
37
+ y = np.zeros(n + n_fft, np.float32)
38
+ f = frames.T.reshape(F_, r, hop)
39
+ for j in range(r):
40
+ y[j * hop:j * hop + F_ * hop] += f[:, j].reshape(-1)
41
+ y = y[:n]
42
+ key = (n_fft, hop, F_)
43
+ env = _ENV.get(key)
44
+ if env is None:
45
+ w2 = np.tile((win * win).reshape(1, r, hop), (F_, 1, 1))
46
+ env = np.zeros(n + n_fft, np.float32)
47
+ for j in range(r):
48
+ env[j * hop:j * hop + F_ * hop] += w2[:, j].reshape(-1)
49
+ env = env[:n]
50
+ if len(_ENV) > 64:
51
+ _ENV.clear()
52
+ _ENV[key] = env
53
+ p = n_fft // 2
54
+ return y[p:n - p] / np.maximum(env[p:n - p], 1e-11)
55
+
56
+
57
+ def _providers(kind, use_coreml):
58
+ """Optional CoreML for the vocoder on Apple silicon (same output; faster on one thread, but twice the memory).
59
+ The decoder always stays on the CPU: CoreML gives wrong values for it, and its int8 graph is CPU-only."""
60
+ if kind == "vocoder" and use_coreml:
61
+ import onnxruntime as ort
62
+ if "CoreMLExecutionProvider" in ort.get_available_providers():
63
+ return [("CoreMLExecutionProvider", {"ModelFormat": "MLProgram", "MLComputeUnits": "CPUOnly"}),
64
+ "CPUExecutionProvider"]
65
+ return ["CPUExecutionProvider"]
66
+
67
+
68
+ class Engine:
69
+ def __init__(self, model_dir=None, threads=None, coreml=None):
70
+ import onnxruntime as ort
71
+ d = model_dir or MODELS
72
+ with open(os.path.join(d, "junco.json")) as f:
73
+ self.meta = json.load(f)
74
+ self.sr, self.hop = self.meta["sample_rate"], self.meta["hop"]
75
+ self.mean = np.float32(self.meta["mean"])
76
+ self.std = np.float32(self.meta["std"])
77
+ coreml = bool(coreml) # off by default: on an M1 it gains little and doubles memory
78
+ so = ort.SessionOptions()
79
+ so.intra_op_num_threads = threads or default_threads()
80
+ so.inter_op_num_threads = 1
81
+ so.graph_optimization_level = ort.GraphOptimizationLevel.ORT_ENABLE_ALL
82
+ so.log_severity_level = 3
83
+ files = self.meta.get("files", {"encoder": "encoder.onnx", "decoder": "decoder.onnx",
84
+ "vocoder": "vocoder.onnx"})
85
+ self.enc, self.dec, self.voc = (
86
+ ort.InferenceSession(os.path.join(d, files[k]), so, providers=_providers(k, coreml))
87
+ for k in ("encoder", "decoder", "vocoder"))
88
+
89
+ def mel(self, ids, steps=None, cfg=None, temp=None, sway=None, speed=1.0, rng=None):
90
+ """Phoneme ids -> (normalised mel (100, F) padded to a multiple of 4, n frames of speech)."""
91
+ dflt = self.meta["defaults"]
92
+ steps = dflt["n_steps"] if steps is None else int(steps)
93
+ cfg = dflt["cfg_w"] if cfg is None else cfg
94
+ temp = dflt["temp"] if temp is None else temp
95
+ sway = dflt["sway"] if sway is None else sway
96
+ rng = np.random.default_rng(0) if rng is None else rng
97
+ mu, logw = self.enc.run(None, {"ids": np.asarray(ids, np.int64)[None]})
98
+ w = np.ceil(np.exp(logw[0, 0]) / speed).astype(np.int64)
99
+ tot = int(w.sum())
100
+ n = max(tot, 4)
101
+ F_ = (n + 3) // 4 * 4 # the decoder halves the frame rate inside: keep the length a multiple of 4
102
+ cond = np.zeros((1, 100, F_), np.float32)
103
+ cond[0, :, :tot] = np.repeat(mu[0], w, axis=1)
104
+ mask = np.zeros((1, 1, F_), np.float32)
105
+ mask[..., :n] = 1.0
106
+ x = rng.standard_normal((1, 100, F_)).astype(np.float32) * np.float32(temp)
107
+ ts = np.linspace(0, 1, steps + 1).astype(np.float32)
108
+ if sway:
109
+ ts = (ts + sway * (np.cos(np.pi / 2 * ts) - 1 + ts)).astype(np.float32)
110
+ wv = np.array([cfg], np.float32)
111
+ for i in range(steps):
112
+ v = self.dec.run(None, {"x": x, "cond": cond, "mask": mask, "t": ts[i:i + 1], "w": wv})[0]
113
+ x = x + (ts[i + 1] - ts[i]) * v
114
+ return (x * mask)[0], n
115
+
116
+ def vocode(self, mel, n=None):
117
+ """Normalised mel (100, F) -> float32 audio, trimmed to n * hop samples (n: frames of speech)."""
118
+ n = mel.shape[1] if n is None else n
119
+ real, imag = self.voc.run(None, {"mel": (mel * self.std + self.mean)[None].astype(np.float32)})
120
+ return istft(real[0], imag[0], self.meta["n_fft"], self.hop)[:n * self.hop]
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Charactr Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
Binary file
Binary file
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "junco",
3
+ "version": "v0.1",
4
+ "sample_rate": 24000,
5
+ "hop": 256,
6
+ "n_fft": 1024,
7
+ "mean": -1.49140640330624,
8
+ "std": 2.024339073543612,
9
+ "defaults": {
10
+ "n_steps": 8,
11
+ "cfg_w": 1.0,
12
+ "temp": 0.667,
13
+ "sway": -1.0
14
+ },
15
+ "files": {
16
+ "encoder": "encoder.onnx",
17
+ "decoder": "decoder-int8.onnx",
18
+ "vocoder": "vocoder.onnx"
19
+ }
20
+ }
Binary file
flockspeech/text.py ADDED
@@ -0,0 +1,56 @@
1
+ """Text -> phoneme ids. Phonemes come from espeak-ng (the copy bundled by espeakng-loader) through phonemizer."""
2
+ import re
3
+
4
+ _pad = "_"
5
+ _punct = ';:,.!?¡¿—…"«»“” '
6
+ _letters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
7
+ _ipa = "ɑɐɒæɓʙβɔɕçɗɖðʤəɘɚɛɜɝɞɟʄɡɠɢʛɦɧħɥʜɨɪʝɭɬɫɮʟɱɯɰŋɳɲɴøɵɸθœɶʘɹɺɾɻʀʁɽʂʃʈʧʉʊʋⱱʌɣɤʍχʎʏʑʐʒʔʡʕʢǀǁǂǃˈˌːˑʼʴʰʱʲʷˠˤ˞↓↑→↗↘'̩ᵻ"
8
+
9
+ SYMBOLS = list(dict.fromkeys([_pad] + list(_punct) + list(_letters) + list(_ipa)))
10
+ SYM2ID = {s: i for i, s in enumerate(SYMBOLS)}
11
+
12
+
13
+ def to_ids(phonemes):
14
+ """Phoneme string -> ids with a blank (0) between every symbol, as the model was trained."""
15
+ ids = [SYM2ID[c] for c in phonemes if c in SYM2ID]
16
+ out = [0] * (2 * len(ids) + 1)
17
+ out[1::2] = ids
18
+ return out
19
+
20
+
21
+ def split_sentences(text, max_chars=300):
22
+ """Sentences (on . ! ? ;), and over-long ones split again at commas so no chunk runs away."""
23
+ out = []
24
+ for s in re.split(r"(?<=[.!?;])\s+", text.strip()):
25
+ if not re.search(r"\w", s):
26
+ continue
27
+ while len(s) > max_chars:
28
+ cut = max((s.rfind(c, 0, max_chars) for c in ",:—"), default=-1)
29
+ if cut < max_chars // 3:
30
+ cut = s.rfind(" ", 0, max_chars)
31
+ if cut <= 0:
32
+ break
33
+ out.append(s[:cut + 1].strip())
34
+ s = s[cut + 1:].strip()
35
+ if s:
36
+ out.append(s)
37
+ return out
38
+
39
+
40
+ class Phonemizer:
41
+ """espeak-ng en-us IPA with stress marks and punctuation kept. Created once: the backend costs ~200 ms."""
42
+
43
+ def __init__(self):
44
+ try:
45
+ import espeakng_loader
46
+ from phonemizer.backend.espeak.wrapper import EspeakWrapper
47
+ EspeakWrapper.set_library(espeakng_loader.get_library_path())
48
+ EspeakWrapper.set_data_path(espeakng_loader.get_data_path())
49
+ except ImportError: # fall back to a system espeak-ng
50
+ pass
51
+ from phonemizer.backend import EspeakBackend
52
+ self.backend = EspeakBackend("en-us", preserve_punctuation=True, with_stress=True,
53
+ language_switch="remove-flags")
54
+
55
+ def __call__(self, sentences):
56
+ return self.backend.phonemize(list(sentences), strip=True, njobs=1)
@@ -0,0 +1,110 @@
1
+ Metadata-Version: 2.5
2
+ Name: flockspeech
3
+ Version: 0.1.0
4
+ Summary: Tiny on-device text to speech: the Junco voice, 44 MB, runs faster than real time on one CPU thread.
5
+ Project-URL: Homepage, https://huggingface.co/flockspeech/junco
6
+ Author: Flock Speech
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ License-File: NOTICE
10
+ License-File: src/flockspeech/models/LICENSE-vocos
11
+ Keywords: edge,offline,on-device,onnx,speech-synthesis,text-to-speech,tts
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Operating System :: MacOS
15
+ Classifier: Operating System :: Microsoft :: Windows
16
+ Classifier: Operating System :: POSIX :: Linux
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
19
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
20
+ Requires-Python: >=3.10
21
+ Requires-Dist: espeakng-loader>=0.2.4
22
+ Requires-Dist: numpy>=1.22
23
+ Requires-Dist: onnxruntime>=1.17
24
+ Requires-Dist: phonemizer>=3.2
25
+ Description-Content-Type: text/markdown
26
+
27
+ # flockspeech
28
+
29
+ Tiny text to speech that runs on your own device. No GPU, no cloud and no PyTorch: just ONNX Runtime and numpy.
30
+
31
+ This first release ships **Junco v0.1**, one English (US) voice at 24 kHz.
32
+
33
+ ```sh
34
+ pip install flockspeech
35
+ flockspeech "Hello! I'm Junco, and I run on your own computer." -o hello.wav --play
36
+ ```
37
+
38
+ ```python
39
+ from flockspeech import Junco
40
+
41
+ tts = Junco() # loads in under a second
42
+ audio = tts("Hello there.") # float32 numpy array, 24 kHz mono
43
+ tts.save("Hello there.", "hello.wav")
44
+
45
+ for chunk in tts.stream(long_text): # sentence by sentence: the first audio arrives fast
46
+ play(chunk)
47
+ ```
48
+
49
+ ## Why it suits small devices
50
+
51
+ | | |
52
+ |---|---|
53
+ | Model files | 44 MB, bundled in the package; nothing is downloaded at run time |
54
+ | Runtime | onnxruntime + numpy; works offline |
55
+ | Memory | about 265 MB peak |
56
+ | Start-up | about 0.7 s |
57
+ | Speed on an Apple M1 | 8.7× real time on 1 thread, 19× on 4 threads |
58
+ | First audio when streaming | about 0.25 s on 4 threads |
59
+
60
+ Speed was measured on typical one-sentence replies, vocoder included. Add `steps=4` (CLI `--steps 4`) for 1.5× more
61
+ speed with slightly rougher audio.
62
+
63
+ ## Quality
64
+
65
+ Quality was measured on 40 unseen LibriTTS-R sentences with UTMOS (a predictor of listener ratings from 1 to 5):
66
+
67
+ | Version | UTMOS |
68
+ |---|---|
69
+ | Original model (PyTorch, fp32) | 4.21 |
70
+ | **This package** (int8 decoder, fp16 storage) | **4.18** (difference not significant) |
71
+ | This package with `steps=4` | 4.12 |
72
+
73
+ In our wider benchmark of 150 sentences, Junco scored a word error rate of 1.71% with Whisper. Real recordings of the same
74
+ sentences scored 2.30%.
75
+
76
+ ## Options
77
+
78
+ | Option | CLI | Default | Effect |
79
+ |---|---|---|---|
80
+ | `speed` | `--speed` | 1.0 | 1.2 talks 20% faster |
81
+ | `steps` | `--steps` | 8 | flow-matching steps: fewer is faster |
82
+ | `seed` | `--seed` | 0 | fixes the small random variation in delivery |
83
+ | `threads` | `--threads` | up to 4 | CPU threads for ONNX Runtime |
84
+ | `coreml` | `--coreml` | off | Apple silicon only: runs the vocoder with CoreML. Faster on 1 thread, but uses twice the memory |
85
+
86
+ The CLI also reads text from a file (`-f story.txt`) or from standard input (`echo hi | flockspeech -`).
87
+
88
+ ## Limits
89
+
90
+ - One voice, English (US) only, in a read-aloud style.
91
+ - No text normalisation yet. Write numbers, money and abbreviations out in words ("five dollars", not "$5"; "Doctor",
92
+ not "Dr.").
93
+ - Long text is split into sentences, and very long sentences are split at commas.
94
+ - Platforms: macOS (Apple silicon and Intel), Linux (x86-64 and ARM64, which includes a 64-bit Raspberry Pi OS) and
95
+ Windows, wherever onnxruntime and espeakng-loader have wheels.
96
+
97
+ ## How it works
98
+
99
+ 1. espeak-ng turns the text into phonemes.
100
+ 2. A transformer encoder and a duration predictor read the phonemes.
101
+ 3. A flow-matching decoder draws a mel spectrogram in 8 guided steps.
102
+ 4. The Vocos vocoder turns the spectrogram into sound.
103
+
104
+ The acoustic model has 11.4M parameters and was trained from scratch on LJ Speech.
105
+
106
+ ## Licence
107
+
108
+ The code and the Junco weights are Apache-2.0. The bundled Vocos vocoder weights are MIT (Charactr Inc.). Phonemes come
109
+ from `phonemizer` and espeak-ng (through `espeakng-loader`). Both are GPL-3.0 and are installed as separate dependencies,
110
+ not included in this package. See `NOTICE`.
@@ -0,0 +1,17 @@
1
+ flockspeech/__init__.py,sha256=PlMnV4Op-InU03AIka1QF-LhnSUwP_HvYn41oP3dOAk,2902
2
+ flockspeech/__main__.py,sha256=bYt9eEaoRQWdejEHFD8REx9jxVEdZptECFsV7F49Ink,30
3
+ flockspeech/cli.py,sha256=JHgRLbI0KV-5DdZ1cJxTHo_LCzoIePItEYU8OedQNyQ,2819
4
+ flockspeech/engine.py,sha256=MLGmUgF8bfvjiP-fB-L6PnilR1FHNNrhkV3ALw272aQ,5545
5
+ flockspeech/text.py,sha256=4Oppv6VWqHG2lbfS-yRtg7HH1zHqtXijatOEDKQVpRs,2328
6
+ flockspeech/models/LICENSE-vocos,sha256=jza6DCFNT0h__X7guFKNqbZ7RZvvLRFd6c0AExZYn0Y,1069
7
+ flockspeech/models/decoder-int8.onnx,sha256=yUD93Ot7Iv6i0cOLS5ZvwVd04JMVLIwxnH0P-_pAnNY,9936441
8
+ flockspeech/models/encoder.onnx,sha256=-uem1iew0zlhp47DAtZCsdYJ_mi1MfghZKVbJ3oV5T0,7174680
9
+ flockspeech/models/junco.json,sha256=sP96-6JDeh_3IklJtigo7KwT1yOkaLBVTmQ34ANa-I0,337
10
+ flockspeech/models/vocoder.onnx,sha256=F4GrkDiw7Hx7RNwE0Ayo_mDd4OkhXvc741NigIWhiHM,27099450
11
+ flockspeech-0.1.0.dist-info/METADATA,sha256=-dT8IxlsIH65VpyZ8ir2UWEKP2-zgjCy6WgRMYgKon8,4364
12
+ flockspeech-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
13
+ flockspeech-0.1.0.dist-info/entry_points.txt,sha256=eXGjKlyi7Yrv0zcBBEKQJG6EPCZeVQJ7R4UwIGh1pY0,53
14
+ flockspeech-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
15
+ flockspeech-0.1.0.dist-info/licenses/NOTICE,sha256=4Fiu4eM3K0fNjnu-SZYkkJxPh_AupONznA43q0pVOZg,746
16
+ flockspeech-0.1.0.dist-info/licenses/src/flockspeech/models/LICENSE-vocos,sha256=jza6DCFNT0h__X7guFKNqbZ7RZvvLRFd6c0AExZYn0Y,1069
17
+ flockspeech-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.33.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ flockspeech = flockspeech.cli:main
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,16 @@
1
+ Flock Speech (flockspeech)
2
+ Copyright 2026 Flock Speech
3
+
4
+ Licensed under the Apache License, Version 2.0 (see LICENSE). This covers the package code and the Junco
5
+ acoustic model weights (src/flockspeech/models/encoder.onnx, decoder-int8.onnx).
6
+
7
+ Third-party components:
8
+
9
+ - Vocos vocoder (src/flockspeech/models/vocoder.onnx): converted from charactr/vocos-mel-24khz,
10
+ Copyright (c) 2023 Charactr Inc., MIT License (see src/flockspeech/models/LICENSE-vocos).
11
+ - Training data: LJ Speech Dataset (Keith Ito and Linda Johnson), public domain.
12
+
13
+ Dependencies installed by pip, not included in this package:
14
+
15
+ - phonemizer (GPL-3.0) and espeak-ng (GPL-3.0, shipped by espeakng-loader) turn text into phonemes.
16
+ - onnxruntime (MIT) and numpy (BSD-3-Clause).
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Charactr Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.