react-native-tts-kit 0.1.0

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.
Files changed (64) hide show
  1. package/ATTRIBUTIONS.md +87 -0
  2. package/LICENSE +21 -0
  3. package/README.md +231 -0
  4. package/android/build.gradle +50 -0
  5. package/android/src/main/AndroidManifest.xml +3 -0
  6. package/android/src/main/java/expo/modules/ttskit/RNTTSKitModule.kt +158 -0
  7. package/android/src/main/java/expo/modules/ttskit/supertonic/AudioEngine.kt +158 -0
  8. package/android/src/main/java/expo/modules/ttskit/supertonic/ModelLocator.kt +372 -0
  9. package/android/src/main/java/expo/modules/ttskit/supertonic/SupertonicSession.kt +373 -0
  10. package/android/src/main/java/expo/modules/ttskit/supertonic/TextFrontend.kt +154 -0
  11. package/android/src/main/java/expo/modules/ttskit/supertonic/VoicePack.kt +47 -0
  12. package/build/engines/BufferedStreamEmitter.d.ts +26 -0
  13. package/build/engines/BufferedStreamEmitter.d.ts.map +1 -0
  14. package/build/engines/BufferedStreamEmitter.js +68 -0
  15. package/build/engines/BufferedStreamEmitter.js.map +1 -0
  16. package/build/engines/Engine.d.ts +15 -0
  17. package/build/engines/Engine.d.ts.map +1 -0
  18. package/build/engines/Engine.js +2 -0
  19. package/build/engines/Engine.js.map +1 -0
  20. package/build/engines/SupertonicEngine.d.ts +14 -0
  21. package/build/engines/SupertonicEngine.d.ts.map +1 -0
  22. package/build/engines/SupertonicEngine.js +183 -0
  23. package/build/engines/SupertonicEngine.js.map +1 -0
  24. package/build/engines/SystemEngine.d.ts +13 -0
  25. package/build/engines/SystemEngine.d.ts.map +1 -0
  26. package/build/engines/SystemEngine.js +78 -0
  27. package/build/engines/SystemEngine.js.map +1 -0
  28. package/build/index.d.ts +46 -0
  29. package/build/index.d.ts.map +1 -0
  30. package/build/index.js +118 -0
  31. package/build/index.js.map +1 -0
  32. package/build/types.d.ts +77 -0
  33. package/build/types.d.ts.map +1 -0
  34. package/build/types.js +2 -0
  35. package/build/types.js.map +1 -0
  36. package/build/voices/catalog.d.ts +12 -0
  37. package/build/voices/catalog.d.ts.map +1 -0
  38. package/build/voices/catalog.js +28 -0
  39. package/build/voices/catalog.js.map +1 -0
  40. package/build/voices/prosody.d.ts +8 -0
  41. package/build/voices/prosody.d.ts.map +1 -0
  42. package/build/voices/prosody.js +28 -0
  43. package/build/voices/prosody.js.map +1 -0
  44. package/expo-module.config.json +9 -0
  45. package/ios/RNTTSKit.podspec +28 -0
  46. package/ios/RNTTSKitModule.swift +133 -0
  47. package/ios/Supertonic/AudioEngine.swift +110 -0
  48. package/ios/Supertonic/ModelLocator.swift +416 -0
  49. package/ios/Supertonic/SupertonicSession.swift +405 -0
  50. package/ios/Supertonic/TextFrontend.swift +216 -0
  51. package/ios/Supertonic/VoicePack.swift +51 -0
  52. package/licenses/OpenRAIL-M.txt +209 -0
  53. package/package.json +77 -0
  54. package/src/engines/BufferedStreamEmitter.ts +50 -0
  55. package/src/engines/Engine.ts +28 -0
  56. package/src/engines/SupertonicEngine.ts +250 -0
  57. package/src/engines/SystemEngine.ts +96 -0
  58. package/src/engines/__tests__/BufferedStreamEmitter.test.ts +65 -0
  59. package/src/index.ts +156 -0
  60. package/src/types.ts +95 -0
  61. package/src/voices/__tests__/catalog.test.ts +46 -0
  62. package/src/voices/__tests__/prosody.test.ts +63 -0
  63. package/src/voices/catalog.ts +32 -0
  64. package/src/voices/prosody.ts +39 -0
@@ -0,0 +1,209 @@
1
+ BigScience Open RAIL-M License
2
+ dated August 18, 2022
3
+
4
+ Section I: PREAMBLE
5
+
6
+ This Open RAIL-M License was created by BigScience, a collaborative open innovation project aimed at
7
+ the responsible development and use of large multilingual datasets and Large Language Models
8
+ (“LLMs”). While a similar license was originally designed for the BLOOM model, we decided to adapt it
9
+ and create this license in order to propose a general open and responsible license applicable to other
10
+ machine learning based AI models (e.g. multimodal generative models).
11
+ In short, this license strives for both the open and responsible downstream use of the accompanying
12
+ model. When it comes to the open character, we took inspiration from open source permissive licenses
13
+ regarding the grant of IP rights. Referring to the downstream responsible use, we added use-based
14
+ restrictions not permitting the use of the Model in very specific scenarios, in order for the licensor to be
15
+ able to enforce the license in case potential misuses of the Model may occur. Even though downstream
16
+ derivative versions of the model could be released under different licensing terms, the latter will always
17
+ have to include - at minimum - the same use-based restrictions as the ones in the original license (this
18
+ license).
19
+ The development and use of artificial intelligence (“AI”), does not come without concerns. The world has
20
+ witnessed how AI techniques may, in some instances, become risky for the public in general. These risks
21
+ come in many forms, from racial discrimination to the misuse of sensitive information.
22
+ BigScience believes in the intersection between open and responsible AI development; thus, this License
23
+ aims to strike a balance between both in order to enable responsible open-science in the field of AI.
24
+ This License governs the use of the model (and its derivatives) and is informed by the model card
25
+ associated with the model.
26
+
27
+ NOW THEREFORE, You and Licensor agree as follows:
28
+
29
+ 1. Definitions
30
+ (a) "License" means the terms and conditions for use, reproduction, and Distribution as defined in
31
+ this document.
32
+ (b) “Data” means a collection of information and/or content extracted from the dataset used with the
33
+ Model, including to train, pretrain, or otherwise evaluate the Model. The Data is not licensed under
34
+ this License.
35
+ (c)“Output” means the results of operating a Model as embodied in informational content resulting
36
+ therefrom.
37
+ (d)“Model” means any accompanying machine-learning based assemblies (including checkpoints),
38
+ consisting of learnt weights, parameters (including optimizer states), corresponding to the model
39
+ architecture as embodied in the Complementary Material, that have been trained or tuned, in whole or
40
+ in part on the Data, using the Complementary Material.
41
+ (e) “Derivatives of the Model” means all modifications to the Model, works based on the Model, or any
42
+ other model which is created or initialized by transfer of patterns of the weights, parameters,
43
+ activations or output of the Model, to the other model, in order to cause the other model to perform
44
+ similarly to the Model, including - but not limited to - distillation methods entailing the use of
45
+ intermediate data representations or methods based on the generation of synthetic data by the Model
46
+ for training the other model.
47
+ (f)“Complementary Material” means the accompanying source code and scripts used to define,
48
+ run, load, benchmark or evaluate the Model, and used to prepare data for training or evaluation, if
49
+ any. This includes any accompanying documentation, tutorials, examples, etc, if any.
50
+ (g) “Distribution” means any transmission, reproduction, publication or other sharing of the Model or
51
+ Derivatives of the Model to a third party, including providing the Model as a hosted service made
52
+ available by electronic or other remote means - e.g. API-based or web access.
53
+ (h) “Licensor” means the copyright owner or entity authorized by the copyright owner that is
54
+ granting the License, including the persons or entities that may have rights in the Model and/or
55
+ distributing the Model.
56
+ (i) "You" (or "Your") means an individual or Legal Entity exercising permissions granted by this
57
+ License and/or making use of the Model for whichever purpose and in any field of use, including
58
+ usage of the Model in an end-use application - e.g. chatbot, translator, image generator.
59
+ (j) “Third Parties” means individuals or legal entities that are not under common control with
60
+ Licensor or You.
61
+ (k) "Contribution" means any work of authorship, including the original version of the Model and
62
+ any modifications or additions to that Model or Derivatives of the Model thereof, that is
63
+ intentionally submitted to Licensor for inclusion in the Model by the copyright owner or by an
64
+ individual or Legal Entity authorized to submit on behalf of the copyright owner. For the
65
+ purposes of this definition,
66
+ “submitted” means any form of electronic, verbal, or written
67
+ communication sent to the Licensor or its representatives, including but not limited to
68
+ communication on electronic mailing lists, source code control systems, and issue tracking
69
+ systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and
70
+ improving the Model, but excluding communication that is conspicuously marked or otherwise
71
+ designated in writing by the copyright owner as "Not a Contribution."
72
+ (l) "Contributor" means Licensor and any individual or Legal Entity on behalf of whom a
73
+ Contribution has been received by Licensor and subsequently incorporated within the Model.
74
+
75
+
76
+ Section II: INTELLECTUAL PROPERTY RIGHTS
77
+
78
+ Both copyright and patent grants apply to the Model, Derivatives of the Model and Complementary
79
+ Material. The Model and Derivatives of the Model are subject to additional terms as described in Section III.
80
+
81
+ 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor
82
+ hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare, publicly display, publicly perform, sublicense, and distribute the
83
+ Complementary Material, the Model, and Derivatives of the Model.
84
+
85
+ 3. Grant of Patent License. Subject to the terms and conditions of this License and where and as
86
+ applicable, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
87
+ royalty-free, irrevocable (except as stated in this paragraph) patent license to make, have made, use, offer
88
+ to sell, sell, import, and otherwise transfer the Model and the Complementary Material, where such
89
+ license applies only to those patent claims licensable by such Contributor that are necessarily infringed by
90
+ their Contribution(s) alone or by combination of their Contribution(s) with the Model to which such
91
+ Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim
92
+ or counterclaim in a lawsuit) alleging that the Model and/or Complementary Material or a Contribution
93
+ incorporated within the Model and/or Complementary Material constitutes direct or contributory patent
94
+ infringement, then any patent licenses granted to You under this License for the Model and/or Work shall
95
+ terminate as of the date such litigation is asserted or filed.
96
+ Section III: CONDITIONS OF USAGE, DISTRIBUTION AND REDISTRIBUTION
97
+
98
+ 4. Distribution and Redistribution. You may host for Third Party remote access purposes (e.g.
99
+ software-as-a-service), reproduce and distribute copies of the Model or Derivatives of the Model thereof
100
+ in any medium, with or without modifications, provided that You meet the following conditions:
101
+
102
+ a. Use-based restrictions as referenced in paragraph 5 MUST be included as an enforceable provision
103
+ by You in any type of legal agreement (e.g. a license) governing the use and/or distribution of the
104
+ Model or Derivatives of the Model, and You shall give notice to subsequent users You Distribute to,
105
+ that the Model or Derivatives of the Model are subject to paragraph 5. This provision does not apply
106
+ to the use of Complementary Material.
107
+
108
+ b. You must give any Third Party recipients of the Model or Derivatives of the Model a copy of this
109
+ License;
110
+
111
+ c. You must cause any modified files to carry prominent notices stating that You changed the files;
112
+
113
+ d. You must retain all copyright, patent, trademark, and attribution notices excluding those notices
114
+ that do not pertain to any part of the Model, Derivatives of the Model.
115
+ You may add Your own copyright statement to Your modifications and may provide additional or
116
+ different license terms and conditions - respecting paragraph 4.a.
117
+ - for use, reproduction, or Distribution
118
+ of Your modifications, or for any such Derivatives of the Model as a whole, provided Your use,
119
+ reproduction, and Distribution of the Model otherwise complies with the conditions stated in this License.
120
+
121
+ 5. Use-based restrictions. The restrictions set forth in Attachment A are considered Use-based restrictions.
122
+ Therefore You cannot use the Model and the Derivatives of the Model for the specified restricted uses. You
123
+ may use the Model subject to this License, including only for lawful purposes and in accordance with the
124
+ License. Use may include creating any content with, finetuning, updating, running, training, evaluating and/or
125
+ reparametrizing the Model. You shall require all of Your users who use the Model or a Derivative of the Model
126
+ to comply with the terms of this paragraph (paragraph 5).
127
+
128
+ 6. The Output You Generate. Except as set forth herein, Licensor claims no rights in the Output You
129
+ generate using the Model. You are accountable for the Output you generate and its subsequent uses. No
130
+ use of the output can contravene any provision as stated in the License.
131
+
132
+ Section IV: OTHER PROVISIONS
133
+
134
+ 7. Updates and Runtime Restrictions. To the maximum extent permitted by law, Licensor reserves the
135
+ right to restrict (remotely or otherwise) usage of the Model in violation of this License, update the Model
136
+ through electronic means, or modify the Output of the Model based on updates. You shall undertake
137
+ reasonable efforts to use the latest version of the Model.
138
+
139
+ 8. Trademarks and related. Nothing in this License permits You to make use of Licensors’ trademarks,
140
+ trade names, logos or to otherwise suggest endorsement or misrepresent the relationship between the
141
+ parties; and any rights not expressly granted herein are reserved by the Licensors.
142
+
143
+ 9. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides
144
+ the Model and the Complementary Material (and each Contributor provides its Contributions) on an "AS
145
+ IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
146
+ including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
147
+ MERCHANTABILITY , or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
148
+ determining the appropriateness of using or redistributing the Model, Derivatives of the Model, and the
149
+ Complementary Material and assume any risks associated with Your exercise of permissions under this
150
+ License.
151
+
152
+ 10. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence),
153
+ contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
154
+ agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect,
155
+ special, incidental, or consequential damages of any character arising as a result of this License or out of
156
+ the use or inability to use the Model and the Complementary Material (including but not limited to
157
+ damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other
158
+ commercial damages or losses), even if such Contributor has been advised of the possibility of such
159
+ damages.
160
+
161
+ 11. Accepting Warranty or Additional Liability. While redistributing the Model, Derivatives of the
162
+ Model and the Complementary Material thereof, You may choose to offer, and charge a fee for, acceptance
163
+ of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License.
164
+ However, in accepting such obligations, You may act only on Your own behalf and on Your sole
165
+ responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and
166
+ hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor
167
+ by reason of your accepting any such warranty or additional liability.
168
+
169
+ 12. If any provision of this License is held to be invalid, illegal or unenforceable, the remaining
170
+ provisions shall be unaffected thereby and remain valid as if such provision had not been set forth herein.
171
+
172
+ END OF TERMS AND CONDITIONS
173
+
174
+ Attachment A
175
+
176
+ Use Restrictions
177
+
178
+ You agree not to use the Model or Derivatives of the Model:
179
+ (a) In any way that violates any applicable national, federal, state, local or international law
180
+ or regulation;
181
+ (b) For the purpose of exploiting, harming or attempting to exploit or harm minors in any
182
+ way;
183
+ (c) To generate or disseminate verifiably false information and/or content with the purpose of
184
+ harming others;
185
+ (d) To generate or disseminate personal identifiable information that can be used to harm an
186
+ individual;
187
+ (e) To generate or disseminate information and/or content (e.g. images, code, posts, articles),
188
+ and place the information and/or content in any context (e.g. bot generating tweets)
189
+ without expressly and intelligibly disclaiming that the information and/or content is
190
+ machine generated;
191
+ (f) To defame, disparage or otherwise harass others;
192
+ (g) To impersonate or attempt to impersonate (e.g. deepfakes) others without their consent;
193
+ (h) For fully automated decision making that adversely impacts an individual’s legal rights or
194
+ otherwise creates or modifies a binding, enforceable obligation;
195
+ (i) For any use intended to or which has the effect of discriminating against or harming
196
+ individuals or groups based on online or offline social behavior or known or predicted
197
+ personal or personality characteristics;
198
+ (j) To exploit any of the vulnerabilities of a specific group of persons based on their age,
199
+ social, physical or mental characteristics, in order to materially distort the behavior of a
200
+ person pertaining to that group in a manner that causes or is likely to cause that person or
201
+ another person physical or psychological harm;
202
+ (k) For any use intended to or which has the effect of discriminating against individuals or
203
+ groups based on legally protected characteristics or categories;
204
+ (l) To provide medical advice and medical results interpretation;
205
+ (m) To generate or disseminate information for the purpose to be used for administration of
206
+ justice, law enforcement, immigration or asylum processes, such as predicting an
207
+ individual will commit fraud/crime commitment (e.g. by text profiling, drawing causal
208
+ relationships between assertions made in documents, indiscriminate and
209
+ arbitrarily-targeted use).
package/package.json ADDED
@@ -0,0 +1,77 @@
1
+ {
2
+ "name": "react-native-tts-kit",
3
+ "version": "0.1.0",
4
+ "description": "On-device neural TTS for React Native and Expo. Multi-engine, sub-second TTFA, 31 languages, fully offline.",
5
+ "main": "build/index.js",
6
+ "types": "build/index.d.ts",
7
+ "scripts": {
8
+ "build": "expo-module build",
9
+ "clean": "expo-module clean",
10
+ "lint": "expo-module lint",
11
+ "test": "jest",
12
+ "prepare": "expo-module prepare",
13
+ "prepublishOnly": "expo-module prepublishOnly",
14
+ "expo-module": "expo-module"
15
+ },
16
+ "keywords": [
17
+ "react-native",
18
+ "expo",
19
+ "tts",
20
+ "text-to-speech",
21
+ "speech",
22
+ "speech-synthesis",
23
+ "supertonic",
24
+ "neural-tts",
25
+ "on-device",
26
+ "offline",
27
+ "offline-first",
28
+ "voice",
29
+ "ai",
30
+ "onnx",
31
+ "onnxruntime",
32
+ "ios",
33
+ "android"
34
+ ],
35
+ "repository": {
36
+ "type": "git",
37
+ "url": "https://github.com/ahk-d/react-native-tts-kit"
38
+ },
39
+ "bugs": {
40
+ "url": "https://github.com/ahk-d/react-native-tts-kit/issues"
41
+ },
42
+ "author": "ahk-d",
43
+ "license": "MIT",
44
+ "homepage": "https://github.com/ahk-d/react-native-tts-kit",
45
+ "files": [
46
+ "build",
47
+ "src",
48
+ "ios",
49
+ "android",
50
+ "licenses",
51
+ "expo-module.config.json",
52
+ "RNTTSKit.podspec",
53
+ "ATTRIBUTIONS.md",
54
+ "LICENSE",
55
+ "README.md"
56
+ ],
57
+ "peerDependencies": {
58
+ "expo": ">=51.0.0",
59
+ "expo-modules-core": ">=1.12.0",
60
+ "react": ">=18.2.0",
61
+ "react-native": ">=0.74.0"
62
+ },
63
+ "peerDependenciesMeta": {
64
+ "expo-speech": {
65
+ "optional": true
66
+ }
67
+ },
68
+ "devDependencies": {
69
+ "@types/react": "~19.0.10",
70
+ "expo-module-scripts": "^4.0.0",
71
+ "expo-modules-core": "~2.5.0",
72
+ "expo-speech": "~13.1.0",
73
+ "react": "19.0.0",
74
+ "react-native": "0.79.5",
75
+ "typescript": "~5.8.3"
76
+ }
77
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Per-stream emitter that buffers events emitted before any listener attaches.
3
+ *
4
+ * The native side of `stream()` starts producing chunks the moment we kick it
5
+ * off, but the JS caller usually attaches `.on('chunk')` immediately after —
6
+ * there's a small async gap. Without buffering, early chunks would be silently
7
+ * dropped. Once a listener is attached, queued events drain to it.
8
+ *
9
+ * This class is exported separately from SupertonicEngine so it can be unit
10
+ * tested without needing the native module to load.
11
+ */
12
+ export class BufferedStreamEmitter {
13
+ private chunkListeners: Array<(pcm: Uint8Array) => void> = [];
14
+ private endListeners: Array<() => void> = [];
15
+ private errorListeners: Array<(err: Error) => void> = [];
16
+ private pendingChunks: Uint8Array[] = [];
17
+ private pendingEnd = false;
18
+ private pendingError: Error | null = null;
19
+
20
+ on(event: 'chunk', listener: (pcm: Uint8Array) => void): void;
21
+ on(event: 'end', listener: () => void): void;
22
+ on(event: 'error', listener: (err: Error) => void): void;
23
+ on(event: 'chunk' | 'end' | 'error', listener: (...args: any[]) => void): void {
24
+ if (event === 'chunk') {
25
+ this.chunkListeners.push(listener);
26
+ const drained = this.pendingChunks;
27
+ this.pendingChunks = [];
28
+ for (const pcm of drained) listener(pcm);
29
+ } else if (event === 'end') {
30
+ this.endListeners.push(listener);
31
+ if (this.pendingEnd) { this.pendingEnd = false; listener(); }
32
+ } else if (event === 'error') {
33
+ this.errorListeners.push(listener);
34
+ if (this.pendingError) { const e = this.pendingError; this.pendingError = null; listener(e); }
35
+ }
36
+ }
37
+
38
+ emitChunk(pcm: Uint8Array): void {
39
+ if (this.chunkListeners.length === 0) { this.pendingChunks.push(pcm); return; }
40
+ for (const l of this.chunkListeners) l(pcm);
41
+ }
42
+ emitEnd(): void {
43
+ if (this.endListeners.length === 0) { this.pendingEnd = true; return; }
44
+ for (const l of this.endListeners) l();
45
+ }
46
+ emitError(err: Error): void {
47
+ if (this.errorListeners.length === 0) { this.pendingError = err; return; }
48
+ for (const l of this.errorListeners) l(err);
49
+ }
50
+ }
@@ -0,0 +1,28 @@
1
+ import type {
2
+ ClonedVoice,
3
+ CloneOptions,
4
+ EngineCapabilities,
5
+ EngineId,
6
+ PrefetchProgress,
7
+ SpeakOptions,
8
+ StreamHandle,
9
+ Voice,
10
+ } from '../types';
11
+
12
+ export interface Engine {
13
+ readonly id: EngineId;
14
+ readonly capabilities: EngineCapabilities;
15
+
16
+ isAvailable(): Promise<boolean>;
17
+ prefetch(onProgress?: (p: PrefetchProgress) => void): Promise<void>;
18
+
19
+ getVoices(): Promise<Voice[]>;
20
+ speak(text: string, options?: SpeakOptions): Promise<void>;
21
+ stream(text: string, options?: SpeakOptions): StreamHandle;
22
+ stop(): Promise<void>;
23
+
24
+ /** Delete any locally cached model files so the next prefetch re-downloads. */
25
+ clearCache?(): Promise<void>;
26
+
27
+ cloneVoice?(options: CloneOptions): Promise<ClonedVoice>;
28
+ }
@@ -0,0 +1,250 @@
1
+ import { requireNativeModule } from 'expo-modules-core';
2
+ import { Platform } from 'react-native';
3
+
4
+ import type {
5
+ EngineCapabilities,
6
+ EngineId,
7
+ PrefetchProgress,
8
+ SpeakOptions,
9
+ StreamHandle,
10
+ Voice,
11
+ } from '../types';
12
+
13
+ // iOS has CoreML/ANE fp16 acceleration; even an 8-step diffusion takes ~1s.
14
+ // Android relies on NNAPI + commodity SoCs (e.g. Snapdragon 720G in mid-tier
15
+ // phones) and tops out around 1-1.2s per diffusion step at fp32, so 8 steps
16
+ // stretches synthesis to 10-14s. Supertonic-3 was trained for 2-8 step
17
+ // inference; 6 steps is the quality/speed sweet spot on Android — audibly
18
+ // closer to 8-step than to 4-step, while still ~25% faster than 8.
19
+ // Callers can override per-call via SpeakOptions.totalStep.
20
+ const DEFAULT_TOTAL_STEP = Platform.OS === 'android' ? 6 : 8;
21
+ import { BufferedStreamEmitter } from './BufferedStreamEmitter';
22
+ import {
23
+ DEFAULT_LANGUAGE,
24
+ DEFAULT_VOICE_ID,
25
+ SUPERTONIC_LANGUAGES,
26
+ SUPERTONIC_VOICES,
27
+ findVoice,
28
+ } from '../voices/catalog';
29
+ import { stripProsody } from '../voices/prosody';
30
+ import type { Engine } from './Engine';
31
+
32
+ type Subscription = { remove(): void };
33
+ type ChunkPayload = { id: string; pcm: string };
34
+ type IdPayload = { id: string };
35
+ type ErrorPayload = { id: string; message: string };
36
+
37
+ interface TTSKitNative {
38
+ isAvailable(): Promise<boolean>;
39
+ prefetch(): Promise<void>;
40
+ speak(
41
+ id: string,
42
+ text: string,
43
+ voiceId: string,
44
+ lang: string,
45
+ totalStep: number,
46
+ speed: number,
47
+ volume: number
48
+ ): Promise<void>;
49
+ stream(
50
+ id: string,
51
+ text: string,
52
+ voiceId: string,
53
+ lang: string,
54
+ totalStep: number,
55
+ speed: number,
56
+ volume: number
57
+ ): Promise<void>;
58
+ stop(): Promise<void>;
59
+ clearCache(): Promise<void>;
60
+ addListener(name: string, listener: (event: any) => void): Subscription;
61
+ }
62
+
63
+ let nativeModule: TTSKitNative | null = null;
64
+ function getNative(): TTSKitNative {
65
+ if (!nativeModule) {
66
+ nativeModule = requireNativeModule<TTSKitNative>('RNTTSKit');
67
+ }
68
+ return nativeModule;
69
+ }
70
+
71
+ let counter = 0;
72
+ const newId = () => `op_${Date.now().toString(36)}_${(++counter).toString(36)}`;
73
+
74
+ function decodeBase64(b64: string): Uint8Array {
75
+ if (typeof atob === 'function') {
76
+ const bin = atob(b64);
77
+ const out = new Uint8Array(bin.length);
78
+ for (let i = 0; i < bin.length; i++) out[i] = bin.charCodeAt(i);
79
+ return out;
80
+ }
81
+ const lookup = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
82
+ const cleaned = b64.replace(/=+$/, '');
83
+ const out = new Uint8Array((cleaned.length * 3) >> 2);
84
+ let o = 0;
85
+ for (let i = 0; i < cleaned.length; i += 4) {
86
+ const a = lookup.indexOf(cleaned[i]);
87
+ const b = lookup.indexOf(cleaned[i + 1]);
88
+ const c = lookup.indexOf(cleaned[i + 2] ?? 'A');
89
+ const d = lookup.indexOf(cleaned[i + 3] ?? 'A');
90
+ out[o++] = (a << 2) | (b >> 4);
91
+ if (cleaned[i + 2]) out[o++] = ((b & 15) << 4) | (c >> 2);
92
+ if (cleaned[i + 3]) out[o++] = ((c & 3) << 6) | d;
93
+ }
94
+ return out.subarray(0, o);
95
+ }
96
+
97
+ // BufferedStreamEmitter is exported from its own module so we can unit-test
98
+ // it without needing the native module to load. See ./BufferedStreamEmitter.ts
99
+
100
+ function resolveLang(options: SpeakOptions): string {
101
+ const lang = options.language ?? DEFAULT_LANGUAGE;
102
+ if (!SUPERTONIC_LANGUAGES.includes(lang)) {
103
+ throw new Error(`[ttskit] Unsupported language for Supertonic: ${lang}`);
104
+ }
105
+ return lang;
106
+ }
107
+
108
+ export class SupertonicEngine implements Engine {
109
+ readonly id: EngineId = 'supertonic';
110
+ readonly capabilities: EngineCapabilities = {
111
+ streaming: true,
112
+ cloning: false,
113
+ emotionTags: false,
114
+ offline: true,
115
+ languages: [...SUPERTONIC_LANGUAGES],
116
+ };
117
+
118
+ async isAvailable(): Promise<boolean> {
119
+ try {
120
+ return await getNative().isAvailable();
121
+ } catch {
122
+ return false;
123
+ }
124
+ }
125
+
126
+ async prefetch(onProgress?: (p: PrefetchProgress) => void): Promise<void> {
127
+ const native = getNative();
128
+ const sub = onProgress
129
+ ? native.addListener('onPrefetchProgress', (e: PrefetchProgress) => onProgress(e))
130
+ : null;
131
+ try {
132
+ await native.prefetch();
133
+ } finally {
134
+ sub?.remove();
135
+ }
136
+ }
137
+
138
+ async getVoices(): Promise<Voice[]> {
139
+ return SUPERTONIC_VOICES;
140
+ }
141
+
142
+ async speak(text: string, options: SpeakOptions = {}): Promise<void> {
143
+ const voiceId = options.voice ?? DEFAULT_VOICE_ID;
144
+ if (!findVoice(voiceId)) throw new Error(`[ttskit] Unknown voice: ${voiceId}`);
145
+ const lang = resolveLang(options);
146
+ const id = newId();
147
+ const native = getNative();
148
+ const cleanText = stripProsody(text);
149
+
150
+ const subs: Subscription[] = [];
151
+ if (options.onStart) {
152
+ subs.push(native.addListener('onSpeakStart', (e: IdPayload) => {
153
+ if (e.id === id) options.onStart?.();
154
+ }));
155
+ }
156
+ if (options.onDone) {
157
+ subs.push(native.addListener('onSpeakDone', (e: IdPayload) => {
158
+ if (e.id === id) options.onDone?.();
159
+ }));
160
+ }
161
+ try {
162
+ await native.speak(
163
+ id,
164
+ cleanText,
165
+ voiceId,
166
+ lang,
167
+ options.totalStep ?? DEFAULT_TOTAL_STEP,
168
+ options.rate ?? 1.05,
169
+ options.volume ?? 1
170
+ );
171
+ } catch (err) {
172
+ options.onError?.(err as Error);
173
+ throw err;
174
+ } finally {
175
+ subs.forEach((s) => s.remove());
176
+ }
177
+ }
178
+
179
+ stream(text: string, options: SpeakOptions = {}): StreamHandle {
180
+ const voiceId = options.voice ?? DEFAULT_VOICE_ID;
181
+ if (!findVoice(voiceId)) throw new Error(`[ttskit] Unknown voice: ${voiceId}`);
182
+ const lang = resolveLang(options);
183
+
184
+ const id = newId();
185
+ const native = getNative();
186
+ const emitter = new BufferedStreamEmitter();
187
+ const cleanText = stripProsody(text);
188
+ let cleanedUp = false;
189
+
190
+ const chunkSub = native.addListener('onStreamChunk', (e: ChunkPayload) => {
191
+ if (e.id !== id) return;
192
+ emitter.emitChunk(decodeBase64(e.pcm));
193
+ });
194
+ const endSub = native.addListener('onStreamEnd', (e: IdPayload) => {
195
+ if (e.id !== id) return;
196
+ emitter.emitEnd();
197
+ cleanup();
198
+ });
199
+ const errSub = native.addListener('onStreamError', (e: ErrorPayload) => {
200
+ if (e.id !== id) return;
201
+ emitter.emitError(new Error(e.message));
202
+ cleanup();
203
+ });
204
+
205
+ function cleanup() {
206
+ if (cleanedUp) return;
207
+ cleanedUp = true;
208
+ chunkSub.remove();
209
+ endSub.remove();
210
+ errSub.remove();
211
+ }
212
+
213
+ native
214
+ .stream(
215
+ id,
216
+ cleanText,
217
+ voiceId,
218
+ lang,
219
+ options.totalStep ?? DEFAULT_TOTAL_STEP,
220
+ options.rate ?? 1.05,
221
+ options.volume ?? 1
222
+ )
223
+ .catch((err: Error) => {
224
+ emitter.emitError(err);
225
+ cleanup();
226
+ });
227
+
228
+ const handle: StreamHandle = {
229
+ id,
230
+ on(event: 'chunk' | 'end' | 'error', listener: (...args: any[]) => void) {
231
+ // @ts-expect-error: emitter has overloaded signatures, runtime forwards correctly
232
+ emitter.on(event, listener);
233
+ return handle;
234
+ },
235
+ async cancel() {
236
+ cleanup();
237
+ await native.stop();
238
+ },
239
+ };
240
+ return handle;
241
+ }
242
+
243
+ async stop(): Promise<void> {
244
+ await getNative().stop();
245
+ }
246
+
247
+ async clearCache(): Promise<void> {
248
+ await getNative().clearCache();
249
+ }
250
+ }