Skip to content

Commit 550447a

Browse files
jbgjbg
committedMay 16, 2023
Initial
0 parents  commit 550447a

10 files changed

+505
-0
lines changed
 

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target
2+
/Cargo.lock

‎Cargo.toml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
[package]
2+
name = "gst-ttssink"
3+
version = "0.1.0"
4+
edition = "2021"
5+
license = "MIT/Apache-2.0"
6+
readme = "README.md"
7+
authors = ["Jasper Hugo <jasper@avstack.io>"]
8+
description = "A GStreamer sink implementing text-to-speech via platform APIs"
9+
repository = "https://github.com/avstack/gst-ttssink"
10+
11+
[dependencies]
12+
gstreamer = { version = "0.20", default-features = false }
13+
gstreamer-base = { version = "0.20", default-features = false }
14+
gstreamer-audio = { version = "0.20", default-features = false }
15+
once_cell = { version = "1", default-features = false, features = ["std"] }
16+
tts = { version = "0.25", default-features = false, features = ["speech_dispatcher_0_11"] }
17+
18+
[dev-dependencies]
19+
gstreamer-check = { version = "0.20", default-features = false }
20+
21+
[build-dependencies]
22+
gst-plugin-version-helper = { version = "0.7", default-features = false }
23+
24+
[lib]
25+
name = "gstttssink"
26+
crate-type = ["cdylib", "rlib"]
27+
path = "src/lib.rs"
28+
29+
[features]
30+
static = []
31+
capi = []
32+
doc = ["gstreamer/v1_22"]
33+
34+
[package.metadata.capi]
35+
min_version = "0.8.0"
36+
37+
[package.metadata.capi.header]
38+
enabled = false
39+
40+
[package.metadata.capi.library]
41+
install_subdir = "gstreamer-1.0"
42+
versioning = false
43+
44+
[package.metadata.capi.pkg_config]
45+
requires_private = "gstreamer-1.0, gstreamer-base-1.0, gstreamer-audio-1.0, gobject-2.0, glib-2.0, gmodule-2.0"

‎LICENSE-APACHE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎LICENSE-MIT

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Permission is hereby granted, free of charge, to any
2+
person obtaining a copy of this software and associated
3+
documentation files (the "Software"), to deal in the
4+
Software without restriction, including without
5+
limitation the rights to use, copy, modify, merge,
6+
publish, distribute, sublicense, and/or sell copies of
7+
the Software, and to permit persons to whom the Software
8+
is furnished to do so, subject to the following
9+
conditions:
10+
11+
The above copyright notice and this permission notice
12+
shall be included in all copies or substantial portions
13+
of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
16+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
17+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
18+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
19+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
22+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23+
DEALINGS IN THE SOFTWARE.

‎README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# gst-ttssink: A GStreamer sink implementing text-to-speech via platform APIs
2+
3+
Accepts text buffers on its sink pad and plays them back as speech via platform APIs.
4+
5+
Supported platforms are those of the [tts crate](https://crates.io/crates/tts):
6+
7+
* Windows
8+
* Screen readers / SAPI via tolk (requires enabling the `tolk` feature)
9+
* WinRT
10+
* Linux (via Speech Dispatcher)
11+
* macOS
12+
* iOS
13+
* Android
14+
* WebAssembly (if you can manage to compile GStreamer for WebAssembly...)
15+
16+
Example usage (type text and it will be played when you press enter):
17+
18+
```
19+
gst-launch-1.0 --quiet fdsrc ! 'text/x-raw,format=utf8' ! ttssink
20+
```
21+
22+
Combine it with our [gst-whisper](https://github.com/avstack/gst-whisper) and [gst-openaichat](https://github.com/avstack/gst-openaichat) elements and use GPT as a voice assistant! (Beware: if you don't use headphones, GPT may start responding to itself.)
23+
24+
```
25+
OPENAI_API_KEY=... gst-launch-1.0 --quiet autoaudiosrc ! audioconvert ! audioresample ! queue ! whisper ! openaichat model=gpt-3.5-turbo ! ttssink
26+
```
27+
28+
## License
29+
30+
gst-ttssink is licensed under either of
31+
32+
* Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
33+
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
34+
35+
at your option.
36+
37+
## Contribution
38+
39+
Any kinds of contributions are welcome as a pull request.
40+
41+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in these crates by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
42+
43+
## Acknowledgements
44+
45+
gst-ttssink development is sponsored by [AVStack](https://avstack.io/). We provide globally-distributed, scalable, managed Jitsi Meet backends.

‎build.rs

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
fn main() {
2+
gst_plugin_version_helper::info()
3+
}

‎shell.nix

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
with import <nixpkgs> {};
2+
mkShell {
3+
name = "gst-ttssink";
4+
buildInputs = [
5+
cargo
6+
cargo-c
7+
cmake
8+
pkg-config
9+
git
10+
glib
11+
gst_all_1.gstreamer
12+
gst_all_1.gst-plugins-base
13+
] ++ (if stdenv.isDarwin then [
14+
darwin.apple_sdk.frameworks.AppKit
15+
darwin.apple_sdk.frameworks.AVFoundation
16+
] else []);
17+
}

‎src/lib.rs

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
use gstreamer::glib;
2+
3+
mod sink;
4+
5+
fn plugin_init(plugin: &gstreamer::Plugin) -> Result<(), glib::BoolError> {
6+
sink::register(plugin)?;
7+
Ok(())
8+
}
9+
10+
gstreamer::plugin_define!(
11+
ttssink,
12+
env!("CARGO_PKG_DESCRIPTION"),
13+
plugin_init,
14+
concat!(env!("CARGO_PKG_VERSION"), "-", env!("COMMIT_ID")),
15+
"MIT/Apache-2.0",
16+
env!("CARGO_PKG_NAME"),
17+
env!("CARGO_PKG_NAME"),
18+
env!("CARGO_PKG_REPOSITORY"),
19+
env!("BUILD_REL_DATE")
20+
);

‎src/sink.rs

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
mod imp;
2+
3+
use gstreamer::{glib, prelude::StaticType, Rank};
4+
5+
glib::wrapper! {
6+
pub struct TtsSink(ObjectSubclass<imp::TtsSink>) @extends gstreamer_base::BaseTransform, gstreamer::Element, gstreamer::Object;
7+
}
8+
9+
pub fn register(plugin: &gstreamer::Plugin) -> Result<(), glib::BoolError> {
10+
gstreamer::Element::register(
11+
Some(plugin),
12+
"ttssink",
13+
Rank::None,
14+
TtsSink::static_type(),
15+
)
16+
}

‎src/sink/imp.rs

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
use std::{str, sync::Mutex};
2+
3+
use gstreamer::{
4+
glib::{self, ParamSpec, Value},
5+
subclass::{
6+
prelude::{ElementImpl, GstObjectImpl, ObjectImpl, ObjectSubclass},
7+
ElementMetadata,
8+
},
9+
Buffer, Caps, DebugCategory, ErrorMessage, FlowError, FlowSuccess,
10+
PadTemplate,
11+
};
12+
use gstreamer_base::{
13+
BaseSink,
14+
subclass::{
15+
prelude::BaseSinkImpl,
16+
},
17+
};
18+
use once_cell::sync::Lazy;
19+
use tts::Tts;
20+
21+
static CAT: Lazy<DebugCategory> = Lazy::new(|| {
22+
DebugCategory::new(
23+
"ttssink",
24+
gstreamer::DebugColorFlags::empty(),
25+
Some("Text to speech sink using platform APIs"),
26+
)
27+
});
28+
29+
static CAPS: Lazy<Caps> = Lazy::new(|| Caps::builder("text/x-raw").field("format", "utf8").build());
30+
31+
#[derive(Debug, Clone)]
32+
struct Settings {}
33+
34+
struct State {
35+
tts: Tts,
36+
}
37+
38+
pub struct TtsSink {
39+
#[allow(dead_code)]
40+
settings: Mutex<Settings>,
41+
state: Mutex<Option<State>>,
42+
}
43+
44+
#[glib::object_subclass]
45+
impl ObjectSubclass for TtsSink {
46+
type ParentType = BaseSink;
47+
type Type = super::TtsSink;
48+
49+
const NAME: &'static str = "GstTtsSink";
50+
51+
fn new() -> Self {
52+
Self {
53+
settings: Mutex::new(Settings {}),
54+
state: Mutex::new(None),
55+
}
56+
}
57+
}
58+
59+
impl ObjectImpl for TtsSink {
60+
fn properties() -> &'static [ParamSpec] {
61+
static PROPERTIES: Lazy<Vec<ParamSpec>> = Lazy::new(|| {
62+
vec![]
63+
});
64+
PROPERTIES.as_ref()
65+
}
66+
67+
fn set_property(&self, _id: usize, _value: &Value, pspec: &ParamSpec) {
68+
match pspec.name() {
69+
_ => unimplemented!(),
70+
}
71+
}
72+
73+
fn property(&self, _id: usize, pspec: &ParamSpec) -> Value {
74+
match pspec.name() {
75+
name => panic!("No getter for {name}"),
76+
}
77+
}
78+
}
79+
80+
impl GstObjectImpl for TtsSink {}
81+
82+
impl ElementImpl for TtsSink {
83+
fn metadata() -> Option<&'static ElementMetadata> {
84+
static ELEMENT_METADATA: Lazy<ElementMetadata> = Lazy::new(|| {
85+
ElementMetadata::new(
86+
"TTS element",
87+
"Converter/Text/Audio",
88+
"Sink a text buffer, synthesise speech using platform APIs, and source audio buffers",
89+
"Jasper Hugo <jasper@avstack.io>",
90+
)
91+
});
92+
93+
Some(&*ELEMENT_METADATA)
94+
}
95+
96+
fn pad_templates() -> &'static [PadTemplate] {
97+
static PAD_TEMPLATES: Lazy<Vec<PadTemplate>> = Lazy::new(|| {
98+
let sink_pad_template = gstreamer::PadTemplate::new(
99+
"sink",
100+
gstreamer::PadDirection::Sink,
101+
gstreamer::PadPresence::Always,
102+
&CAPS,
103+
)
104+
.unwrap();
105+
106+
vec![sink_pad_template]
107+
});
108+
109+
PAD_TEMPLATES.as_ref()
110+
}
111+
}
112+
113+
impl BaseSinkImpl for TtsSink {
114+
fn start(&self) -> Result<(), ErrorMessage> {
115+
gstreamer::debug!(CAT, "start()");
116+
*self.state.lock().unwrap() = Some(State {
117+
tts: Tts::default().unwrap(),
118+
});
119+
Ok(())
120+
}
121+
122+
fn stop(&self) -> Result<(), ErrorMessage> {
123+
gstreamer::debug!(CAT, "stop()");
124+
Ok(())
125+
}
126+
127+
fn render(&self, buffer: &Buffer) -> Result<FlowSuccess, FlowError> {
128+
let buffer_reader = buffer.as_ref().map_readable().map_err(|_| FlowError::Error)?;
129+
let text = str::from_utf8(buffer_reader.as_slice()).map_err(|_| FlowError::Error)?;
130+
self.state.lock().unwrap().as_mut().unwrap().tts.speak(text, false).map_err(|_| FlowError::Error)?;
131+
Ok(FlowSuccess::Ok)
132+
}
133+
}

0 commit comments

Comments
 (0)
Please sign in to comment.