Vendor dependencies for 0.3.0 release

vendor/objc2-foundation/examples/speech_synthesis.rs

@@ -0,0 +1,182 @@
+//! Speak synthethized text.
+//!
+//! This uses `NSSpeechSynthesizer` on macOS, and `AVSpeechSynthesizer` on
+//! other Apple platforms. Note that `AVSpeechSynthesizer` _is_ available on
+//! macOS, but only since 10.15!
+//!
+//! Works on macOS >= 10.7 and iOS > 7.0.
+#![deny(unsafe_op_in_unsafe_fn)]
+#![allow(unused_imports)]
+
+use std::thread;
+use std::time::Duration;
+
+use objc2::mutability::InteriorMutable;
+use objc2::rc::Retained;
+use objc2::{extern_class, msg_send, msg_send_id, ClassType};
+use objc2_foundation::{ns_string, NSObject, NSString};
+
+#[cfg(target_os = "macos")]
+mod implementation {
+    use objc2_foundation::NSCopying;
+    use std::cell::Cell;
+
+    use super::*;
+
+    #[link(name = "AppKit", kind = "framework")]
+    extern "C" {}
+
+    extern_class!(
+        /// <https://developer.apple.com/documentation/appkit/nsspeechsynthesizer?language=objc>
+        pub(crate) struct Synthesizer;
+
+        unsafe impl ClassType for Synthesizer {
+            type Super = NSObject;
+            type Mutability = InteriorMutable;
+            const NAME: &'static str = "NSSpeechSynthesizer";
+        }
+    );
+
+    impl Synthesizer {
+        // Uses default voice
+        pub(crate) fn new() -> Retained<Self> {
+            unsafe { msg_send_id![Self::class(), new] }
+        }
+
+        fn set_rate(&self, rate: f32) {
+            unsafe { msg_send![self, setRate: rate] }
+        }
+
+        fn set_volume(&self, volume: f32) {
+            unsafe { msg_send![self, setVolume: volume] }
+        }
+
+        fn start_speaking(&self, s: &NSString) {
+            let _: bool = unsafe { msg_send![self, startSpeakingString: s] };
+        }
+
+        pub(crate) fn speak(&self, utterance: &Utterance) {
+            // Convert to the range 90-720 that `NSSpeechSynthesizer` seems to
+            // support
+            //
+            // Note that you'd probably want a nonlinear conversion here to
+            // make it match `AVSpeechSynthesizer`.
+            self.set_rate(90.0 + (utterance.rate.get() * (360.0 - 90.0)));
+            self.set_volume(utterance.volume.get());
+            self.start_speaking(&utterance.string);
+        }
+
+        pub(crate) fn is_speaking(&self) -> bool {
+            unsafe { msg_send![self, isSpeaking] }
+        }
+    }
+
+    // Shim to make NSSpeechSynthesizer work similar to AVSpeechSynthesizer
+    pub(crate) struct Utterance {
+        rate: Cell<f32>,
+        volume: Cell<f32>,
+        string: Retained<NSString>,
+    }
+
+    impl Utterance {
+        pub(crate) fn new(string: &NSString) -> Self {
+            Self {
+                rate: Cell::new(0.5),
+                volume: Cell::new(1.0),
+                string: string.copy(),
+            }
+        }
+
+        pub(crate) fn set_rate(&self, rate: f32) {
+            self.rate.set(rate);
+        }
+
+        pub(crate) fn set_volume(&self, volume: f32) {
+            self.volume.set(volume);
+        }
+    }
+}
+
+#[cfg(all(target_vendor = "apple", not(target_os = "macos")))]
+mod implementation {
+    use super::*;
+
+    #[link(name = "AVFoundation", kind = "framework")]
+    extern "C" {}
+
+    extern_class!(
+        /// <https://developer.apple.com/documentation/avfaudio/avspeechsynthesizer?language=objc>
+        #[derive(Debug)]
+        pub(crate) struct Synthesizer;
+
+        unsafe impl ClassType for Synthesizer {
+            type Super = NSObject;
+            type Mutability = InteriorMutable;
+            const NAME: &'static str = "AVSpeechSynthesizer";
+        }
+    );
+
+    impl Synthesizer {
+        pub(crate) fn new() -> Retained<Self> {
+            unsafe { msg_send_id![Self::class(), new] }
+        }
+
+        pub(crate) fn speak(&self, utterance: &Utterance) {
+            unsafe { msg_send![self, speakUtterance: utterance] }
+        }
+
+        pub(crate) fn is_speaking(&self) -> bool {
+            unsafe { msg_send![self, isSpeaking] }
+        }
+    }
+
+    extern_class!(
+        /// <https://developer.apple.com/documentation/avfaudio/avspeechutterance?language=objc>
+        #[derive(Debug)]
+        pub struct Utterance;
+
+        unsafe impl ClassType for Utterance {
+            type Super = NSObject;
+            type Mutability = InteriorMutable;
+            const NAME: &'static str = "AVSpeechUtterance";
+        }
+    );
+
+    impl Utterance {
+        pub(crate) fn new(string: &NSString) -> Retained<Self> {
+            unsafe { msg_send_id![Self::alloc(), initWithString: string] }
+        }
+
+        pub(crate) fn set_rate(&self, rate: f32) {
+            unsafe { msg_send![self, setRate: rate] }
+        }
+
+        pub(crate) fn set_volume(&self, volume: f32) {
+            unsafe { msg_send![self, setVolume: volume] }
+        }
+    }
+}
+
+#[cfg(target_vendor = "apple")]
+use implementation::{Synthesizer, Utterance};
+
+#[cfg(target_vendor = "apple")]
+fn main() {
+    let synthesizer = Synthesizer::new();
+    let utterance = Utterance::new(ns_string!("Hello from Rust!"));
+    utterance.set_rate(0.5);
+    utterance.set_volume(0.5);
+    synthesizer.speak(&utterance);
+
+    // Wait until speech has properly started up
+    thread::sleep(Duration::from_millis(1000));
+    // Wait until finished speaking
+    while synthesizer.is_speaking() {
+        thread::sleep(Duration::from_millis(100));
+    }
+}
+
+#[cfg(not(target_vendor = "apple"))]
+fn main() {
+    panic!("this example is only supported on Apple platforms");
+}