Merge 2211818bc5 into 3c8ae0ae42

Fixed a panic in SpeechDispatcher.voices()

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     env:
       CARGO_TOKEN: ${{ secrets.CARGO_TOKEN }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: |
           sudo apt-get update
           sudo apt-get install -y libspeechd-dev

.github/workflows/test.yml

@@ -5,6 +5,17 @@ on:
   pull_request:
 
 jobs:
+  check_formatting:
+    name: Check Formatting
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          rustup toolchain install stable
+          cargo fmt --all --check
+          cd examples/web
+          cargo fmt --all --check
+
   check:
     name: Check
     strategy:
@@ -12,41 +23,38 @@ jobs:
         os: [windows-latest, ubuntu-22.04, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: sudo apt-get update; sudo apt-get install -y libspeechd-dev
         if: ${{ runner.os == 'Linux' }}
       - run: |
           rustup toolchain install stable
-          cargo fmt --check
+          cargo clippy --all-targets
-          cargo clippy
 
   check_web:
     name: Check Web
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: |
           rustup target add wasm32-unknown-unknown
           rustup toolchain install stable
-          cargo fmt --all --check
+          cargo clippy --all-targets --target wasm32-unknown-unknown
-          cargo clippy --target wasm32-unknown-unknown
 
   check_android:
     name: Check Android
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: |
+          rustup target add aarch64-linux-android
           rustup toolchain install stable
-          rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
+          cargo clippy --all-targets --target aarch64-linux-android
-          cargo install -f cargo-apk
-          cargo apk build
 
   check_web_example:
     name: Check Web Example
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: |
           rustup target add wasm32-unknown-unknown
           rustup toolchain install stable

Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "tts"
-version = "0.25.6"
+version = "0.26.0"
 authors = ["Nolan Darilek <nolan@thewordnerd.info>"]
 repository = "https://github.com/ndarilek/tts-rs"
 description = "High-level Text-To-Speech (TTS) interface"
+documentation = "https://docs.rs/tts"
 license = "MIT"
 exclude = ["*.cfg", "*.yml"]
 edition = "2021"
@@ -26,11 +27,11 @@ serde = { version = "1", optional = true, features = ["derive"] }
 thiserror = "1"
 
 [dev-dependencies]
-env_logger = "0.10"
+env_logger = "0.11"
 
 [target.'cfg(windows)'.dependencies]
 tolk = { version = "0.5", optional = true }
-windows = { version = "0.51", features = [
+windows = { version = "0.52", features = [
     "Foundation",
     "Foundation_Collections",
     "Media_Core",
@@ -64,7 +65,6 @@ web-sys = { version = "0.3", features = [
 [target.'cfg(target_os="android")'.dependencies]
 jni = "0.21"
 ndk-context = "0.1"
-ndk-glue = "0.7"
 
 [package.metadata.docs.rs]
 no-default-features = true

src/backends/speech_dispatcher.rs

@@ -188,6 +188,7 @@ impl Backend for SpeechDispatcher {
             .0
             .list_synthesis_voices()?
             .iter()
+            .filter(|v| LanguageTag::parse(v.language.clone()).is_ok())
             .map(|v| Voice {
                 id: v.name.clone(),
                 name: v.name.clone(),

src/backends/web.rs

@@ -59,6 +59,7 @@ impl Backend for Web {
             voice: true,
             get_voice: true,
             utterance_callbacks: true,
+            pause_resume: true,
         }
     }
 
@@ -109,6 +110,22 @@ impl Backend for Web {
             mappings.retain(|v| v.1 != utterance_id);
         }) as Box<dyn Fn(_)>);
         utterance.set_onerror(Some(callback.as_ref().unchecked_ref()));
+        let callback = Closure::wrap(Box::new(move |evt: SpeechSynthesisErrorEvent| {
+            let mut callbacks = CALLBACKS.lock().unwrap();
+            let callback = callbacks.get_mut(&id).unwrap();
+            if let Some(f) = callback.utterance_pause.as_mut() {
+                f(utterance_id);
+            }
+        }) as Box<dyn Fn(_)>);
+        utterance.set_onpause(Some(callback.as_ref().unchecked_ref()));
+        let callback = Closure::wrap(Box::new(move |evt: SpeechSynthesisErrorEvent| {
+            let mut callbacks = CALLBACKS.lock().unwrap();
+            let callback = callbacks.get_mut(&id).unwrap();
+            if let Some(f) = callback.utterance_resume.as_mut() {
+                f(utterance_id);
+            }
+        }) as Box<dyn Fn(_)>);
+        utterance.set_onresume(Some(callback.as_ref().unchecked_ref()));
         if interrupt {
             self.stop()?;
         }
@@ -130,6 +147,24 @@ impl Backend for Web {
         Ok(())
     }
 
+    fn pause(&mut self) -> Result<(), Error> {
+        trace!("pause()");
+        if let Some(window) = web_sys::window() {
+            let speech_synthesis = window.speech_synthesis().unwrap();
+            speech_synthesis.pause();
+        }
+        Ok(())
+    }
+
+    fn resume(&mut self) -> Result<(), Error> {
+        trace!("resume()");
+        if let Some(window) = web_sys::window() {
+            let speech_synthesis = window.speech_synthesis().unwrap();
+            speech_synthesis.resume();
+        }
+        Ok(())
+    }
+
     fn min_rate(&self) -> f32 {
         0.1
     }

src/lib.rs

@@ -14,9 +14,10 @@ use std::collections::HashMap;
 #[cfg(target_os = "macos")]
 use std::ffi::CStr;
 use std::fmt;
+use std::rc::Rc;
 #[cfg(windows)]
 use std::string::FromUtf16Error;
-use std::sync::{Arc, Mutex};
+use std::sync::Mutex;
 use std::{boxed::Box, sync::RwLock};
 
 #[cfg(any(target_os = "macos", target_os = "ios"))]
@@ -169,6 +170,7 @@ pub struct Features {
     pub voice: bool,
     pub get_voice: bool,
     pub volume: bool,
+    pub pause_resume: bool,
 }
 
 impl fmt::Display for Features {
@@ -244,6 +246,8 @@ struct Callbacks {
     utterance_begin: Option<Box<dyn FnMut(UtteranceId)>>,
     utterance_end: Option<Box<dyn FnMut(UtteranceId)>>,
     utterance_stop: Option<Box<dyn FnMut(UtteranceId)>>,
+    utterance_pause: Option<Box<dyn FnMut(UtteranceId)>>,
+    utterance_resume: Option<Box<dyn FnMut(UtteranceId)>>,
 }
 
 unsafe impl Send for Callbacks {}
@@ -258,7 +262,7 @@ lazy_static! {
 }
 
 #[derive(Clone)]
-pub struct Tts(Arc<RwLock<Box<dyn Backend>>>);
+pub struct Tts(Rc<RwLock<Box<dyn Backend>>>);
 
 unsafe impl Send for Tts {}
 
@@ -271,18 +275,18 @@ impl Tts {
             #[cfg(target_os = "linux")]
             Backends::SpeechDispatcher => {
                 let tts = backends::SpeechDispatcher::new()?;
-                Ok(Tts(Arc::new(RwLock::new(Box::new(tts)))))
+                Ok(Tts(Rc::new(RwLock::new(Box::new(tts)))))
             }
             #[cfg(target_arch = "wasm32")]
             Backends::Web => {
                 let tts = backends::Web::new()?;
-                Ok(Tts(Arc::new(RwLock::new(Box::new(tts)))))
+                Ok(Tts(Rc::new(RwLock::new(Box::new(tts)))))
             }
             #[cfg(all(windows, feature = "tolk"))]
             Backends::Tolk => {
                 let tts = backends::Tolk::new();
                 if let Some(tts) = tts {
-                    Ok(Tts(Arc::new(RwLock::new(Box::new(tts)))))
+                    Ok(Tts(Rc::new(RwLock::new(Box::new(tts)))))
                 } else {
                     Err(Error::NoneError)
                 }
@@ -290,20 +294,20 @@ impl Tts {
             #[cfg(windows)]
             Backends::WinRt => {
                 let tts = backends::WinRt::new()?;
-                Ok(Tts(Arc::new(RwLock::new(Box::new(tts)))))
+                Ok(Tts(Rc::new(RwLock::new(Box::new(tts)))))
             }
             #[cfg(target_os = "macos")]
-            Backends::AppKit => Ok(Tts(Arc::new(RwLock::new(Box::new(
+            Backends::AppKit => Ok(Tts(Rc::new(RwLock::new(
-                backends::AppKit::new()?
+                Box::new(backends::AppKit::new()?),
-            ))))),
+            )))),
             #[cfg(any(target_os = "macos", target_os = "ios"))]
-            Backends::AvFoundation => Ok(Tts(Arc::new(RwLock::new(Box::new(
+            Backends::AvFoundation => Ok(Tts(Rc::new(RwLock::new(Box::new(
                 backends::AvFoundation::new()?,
             ))))),
             #[cfg(target_os = "android")]
             Backends::Android => {
                 let tts = backends::Android::new()?;
-                Ok(Tts(Arc::new(RwLock::new(Box::new(tts)))))
+                Ok(Tts(Rc::new(RwLock::new(Box::new(tts)))))
             }
         };
         if let Ok(backend) = backend {
@@ -385,6 +389,28 @@ impl Tts {
         }
     }
 
+    /// Pauses current speech.
+    pub fn pause(&mut self) -> Result<&Self, Error> {
+        let Features { pause, .. } = self.supported_features();
+        if pause {
+            self.0.write().unwrap().pause()?;
+            Ok(self)
+        } else {
+            Err(Error::UnsupportedFeature)
+        }
+    }
+
+    /// Resumes current speech.
+    pub fn resume(&mut self) -> Result<&Self, Error> {
+        let Features { resume, .. } = self.supported_features();
+        if resume {
+            self.0.write().unwrap().resume()?;
+            Ok(self)
+        } else {
+            Err(Error::UnsupportedFeature)
+        }
+    }
+
     /// Returns the minimum rate for this speech synthesizer.
     pub fn min_rate(&self) -> f32 {
         self.0.read().unwrap().min_rate()
@@ -640,7 +666,7 @@ impl Tts {
 
 impl Drop for Tts {
     fn drop(&mut self) {
-        if Arc::strong_count(&self.0) <= 1 {
+        if Rc::strong_count(&self.0) <= 1 {
             if let Some(id) = self.0.read().unwrap().id() {
                 let mut callbacks = CALLBACKS.lock().unwrap();
                 callbacks.remove(&id);