Skip to content

Commit 603583e

Browse files
streamer45streamer45
authored
feat: pocket-tts plugin (#33)
* feat: pocket-tts plugin * fix: license * fix: CI docker build * feat: add pocket-tts marketplace manifest and registry entry * Add Apache license
1 parent d58c3c3 commit 603583e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+30114
-86
lines changed

‎.dockerignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ target/
99
# Large local artifacts (not needed for image builds)
1010
models/
1111
.plugins/
12+
!plugins/native/pocket-tts/vendor/pocket-tts/src/models/
13+
!plugins/native/pocket-tts/vendor/pocket-tts/src/models/**
1214

1315
# Node modules
1416
node_modules/

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ samples/audio/system/*.flac
5959
samples/audio/system/*.mp3
6060
samples/audio/system/*.m4a
6161
models
62+
!plugins/native/pocket-tts/vendor/pocket-tts/src/models/
63+
!plugins/native/pocket-tts/vendor/pocket-tts/src/models/**
6264

6365
# Example plugin build outputs
6466
/examples/plugins/*/build/

‎LICENSES/Apache-2.0.txt‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2024 Pocket TTS Contributors
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

‎crates/plugin-native/src/wrapper.rs‎

Lines changed: 75 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -218,15 +218,62 @@ impl ProcessorNode for NativeNodeWrapper {
218218
warn!(error = %e, node = %node_name, "Failed to send initializing state");
219219
}
220220

221-
tracing::debug!(node = %node_name, "Getting input channel");
221+
tracing::debug!(node = %node_name, "Getting input channels");
222222

223-
// Get input channel
224-
let mut input_rx = context.take_input("in").map_err(|e| {
225-
tracing::error!(node = %node_name, error = %e, "Failed to get input channel");
226-
StreamKitError::Runtime(format!("Failed to get input channel: {e}"))
227-
})?;
223+
let mut inputs = std::mem::take(&mut context.inputs);
224+
if inputs.is_empty() {
225+
return Err(StreamKitError::Runtime(
226+
"Engine did not provide any input pin receivers".to_string(),
227+
));
228+
}
229+
230+
let mut input_pin_names = Vec::with_capacity(inputs.len());
231+
let mut input_pin_cstrs = Vec::with_capacity(inputs.len());
232+
let mut input_tasks = Vec::with_capacity(inputs.len());
233+
let (merged_tx, mut merged_rx) =
234+
tokio::sync::mpsc::channel::<(usize, Packet)>(context.batch_size.max(1));
235+
let cancellation_token = context.cancellation_token.clone();
236+
237+
for (pin_name, mut rx) in inputs.drain() {
238+
let pin_cstr = CString::new(pin_name.as_str()).map_err(|e| {
239+
StreamKitError::Runtime(format!("Invalid pin name '{pin_name}': {e}"))
240+
})?;
241+
let pin_index = input_pin_names.len();
242+
input_pin_names.push(pin_name);
243+
input_pin_cstrs.push(Arc::new(pin_cstr));
244+
245+
let tx = merged_tx.clone();
246+
let token = cancellation_token.clone();
247+
let handle = tokio::spawn(async move {
248+
loop {
249+
let packet = if let Some(token) = &token {
250+
tokio::select! {
251+
() = token.cancelled() => None,
252+
packet = rx.recv() => packet,
253+
}
254+
} else {
255+
rx.recv().await
256+
};
257+
258+
let Some(packet) = packet else {
259+
break;
260+
};
261+
262+
if tx.send((pin_index, packet)).await.is_err() {
263+
break;
264+
}
265+
}
266+
});
267+
input_tasks.push(handle);
268+
}
269+
270+
drop(merged_tx);
228271

229-
tracing::debug!(node = %node_name, "Got input channel, entering main loop");
272+
tracing::debug!(
273+
node = %node_name,
274+
inputs = ?input_pin_names,
275+
"Got input channels, entering main loop"
276+
);
230277

231278
// Emit running state
232279
if let Err(e) =
@@ -263,9 +310,6 @@ impl ProcessorNode for NativeNodeWrapper {
263310

264311
// Move the blocking FFI call to spawn_blocking
265312
let state = Arc::clone(&self.state);
266-
// spawn_blocking can only fail with JoinError if the task panics.
267-
// If that happens, it's a serious bug that should crash.
268-
#[allow(clippy::expect_used)]
269313
let error_msg = tokio::task::spawn_blocking(move || {
270314
let handle = state.begin_call()?;
271315

@@ -291,8 +335,11 @@ impl ProcessorNode for NativeNodeWrapper {
291335
error
292336
})
293337
.await
294-
// spawn_blocking only panics if the task panics, which indicates a serious bug
295-
.expect("Update params task panicked");
338+
.map_err(|e| {
339+
StreamKitError::Runtime(format!(
340+
"Update params task panicked: {e}"
341+
))
342+
})?;
296343

297344
if let Some(err) = error_msg {
298345
warn!(node = %node_name, error = %err, "Parameter update failed");
@@ -311,8 +358,8 @@ impl ProcessorNode for NativeNodeWrapper {
311358
}
312359
}
313360

314-
maybe_packet = input_rx.recv() => {
315-
let Some(packet) = maybe_packet else {
361+
maybe_packet = merged_rx.recv() => {
362+
let Some((pin_index, packet)) = maybe_packet else {
316363
// Input closed - flush any buffered data before shutting down
317364
tracing::debug!(node = %node_name, "Native plugin input closed, flushing buffers");
318365

@@ -322,7 +369,6 @@ impl ProcessorNode for NativeNodeWrapper {
322369
let session_id = context.session_id.clone();
323370
let node_id = node_name.clone();
324371

325-
#[allow(clippy::expect_used)]
326372
let (outputs, error) = tokio::task::spawn_blocking(move || {
327373
let Some(handle) = state.begin_call() else {
328374
return (Vec::new(), None);
@@ -371,7 +417,7 @@ impl ProcessorNode for NativeNodeWrapper {
371417
(outputs, error)
372418
})
373419
.await
374-
.expect("Plugin flush task panicked");
420+
.map_err(|e| StreamKitError::Runtime(format!("Plugin flush task panicked: {e}")))?;
375421

376422
// Send flush outputs
377423
for (pin, pkt) in outputs {
@@ -392,9 +438,7 @@ impl ProcessorNode for NativeNodeWrapper {
392438
let telemetry_tx = context.telemetry_tx.clone();
393439
let session_id = context.session_id.clone();
394440
let node_id = node_name.clone();
395-
// spawn_blocking can only fail with JoinError if the task panics.
396-
// If that happens, it's a serious bug that should crash.
397-
#[allow(clippy::expect_used)]
441+
let pin_cstr = Arc::clone(&input_pin_cstrs[pin_index]);
398442
let (outputs, error) = tokio::task::spawn_blocking(move || {
399443
let Some(handle) = state.begin_call() else {
400444
return (Vec::new(), None);
@@ -405,10 +449,6 @@ impl ProcessorNode for NativeNodeWrapper {
405449
// Convert packet to C representation
406450
let packet_repr = conversions::packet_to_c(&packet);
407451

408-
// Prepare input pin name - hardcoded ASCII string "in" can never contain null bytes
409-
#[allow(clippy::expect_used)]
410-
let pin_cstr = CString::new("in").expect("Hardcoded ASCII string is always valid C string");
411-
412452
// Create callback context
413453
let mut callback_ctx = CallbackContext {
414454
output_packets: Vec::new(),
@@ -453,8 +493,9 @@ impl ProcessorNode for NativeNodeWrapper {
453493
(outputs, error)
454494
})
455495
.await
456-
// spawn_blocking only panics if the task panics, which indicates a serious bug
457-
.expect("Plugin processing task panicked");
496+
.map_err(|e| {
497+
StreamKitError::Runtime(format!("Plugin processing task panicked: {e}"))
498+
})?;
458499

459500
// Now send outputs (after dropping c_packet and result)
460501
for (pin, pkt) in outputs {
@@ -479,12 +520,19 @@ impl ProcessorNode for NativeNodeWrapper {
479520
warn!(error = %e, node = %node_name, "Failed to send failed state");
480521
}
481522

482-
return Err(StreamKitError::Runtime(error_msg));
483-
}
523+
for handle in &input_tasks {
524+
handle.abort();
525+
}
526+
return Err(StreamKitError::Runtime(error_msg));
527+
}
484528
}
485529
}
486530
}
487531

532+
for handle in &input_tasks {
533+
handle.abort();
534+
}
535+
488536
// Input closed, emit stopped state
489537
info!(node = %node_name, "Input closed, shutting down");
490538
if let Err(e) = context

0 commit comments

Comments
 (0)