feat(destroy): add destroy method

Author: timmywil

README.md

@@ -16,10 +16,10 @@ import javax.annotation.Nullable
 class SpokestackModule(private val reactContext: ReactApplicationContext): ReactContextBaseJavaModule(reactContext) {
   private val adapter = SpokestackAdapter { event: String, data: WritableMap -> sendEvent(event, data) }
   private var spokestack: Spokestack? = null
+  private var audioPlayer: SpokestackTTSOutput? = null
+  private var downloader: Downloader? = null
   private val promises = mutableMapOf<SpokestackPromise, Promise>()
   private var say: ((url: String) -> Unit)? = null
-  private lateinit var audioPlayer: SpokestackTTSOutput
-  private lateinit var downloader: Downloader
   private val filenameToProp = mapOf(
     "detect.tflite" to "wake-detect-path",
     "encode.tflite" to "wake-encode-path",
@@ -206,7 +206,7 @@ class SpokestackModule(private val reactContext: ReactApplicationContext): React
     // Wakeword needs all three config paths
     if (wakeDownloads.size == 3) {
       Log.d(name, "Building with wakeword.")
-      downloader.downloadAll(wakeDownloads).forEach { (filename, loc) ->
+      downloader!!.downloadAll(wakeDownloads).forEach { (filename, loc) ->
         builder.setProperty(filenameToProp[filename], loc)
       }
     } else {
@@ -253,7 +253,7 @@ class SpokestackModule(private val reactContext: ReactApplicationContext): React
     // Keyword at least needs filter, detect, and encode
     if (keywordDownloads.size >= 3) {
       Log.d(name, "Building with keyword.")
-      downloader.downloadAll(keywordDownloads).forEach { (filename, loc) ->
+      downloader!!.downloadAll(keywordDownloads).forEach { (filename, loc) ->
         builder.setProperty(filenameToProp[filename], loc)
       }
     }
@@ -283,7 +283,7 @@ class SpokestackModule(private val reactContext: ReactApplicationContext): React
 
     if (nluDownloads.size == 3) {
       Log.d(name, "Building with NLU.")
-      downloader.downloadAll(nluDownloads).forEach { (filename, loc) ->
+      downloader!!.downloadAll(nluDownloads).forEach { (filename, loc) ->
         builder.setProperty(filenameToProp[filename], loc)
       }
     } else {
@@ -296,8 +296,8 @@ class SpokestackModule(private val reactContext: ReactApplicationContext): React
 
     // Initialize the audio player for speaking
     audioPlayer = SpokestackTTSOutput(null)
-    audioPlayer.setAndroidContext(reactContext.applicationContext)
-    audioPlayer.addListener(adapter)
+    audioPlayer!!.setAndroidContext(reactContext.applicationContext)
+    audioPlayer!!.addListener(adapter)
 
     spokestack = builder.build()
     promise.resolve(null)
@@ -381,12 +381,16 @@ class SpokestackModule(private val reactContext: ReactApplicationContext): React
 
   @ReactMethod
   fun speak(input: String, format: Int, voice: String, promise: Promise) {
+    if (!initialized()) {
+      promise.reject(Exception("Call Spokestack.initialize() before calling Spokestack.speak()."))
+      return
+    }
     promises[SpokestackPromise.SPEAK] = promise
     say = { url ->
       Log.d(name,"Playing audio from URL: $url")
       val uri = Uri.parse(url)
       val response = AudioResponse(uri)
-      audioPlayer.audioReceived(response)
+      audioPlayer?.audioReceived(response)
 
       // Resolve RN promise
       promise.resolve(null)
@@ -424,4 +428,18 @@ class SpokestackModule(private val reactContext: ReactApplicationContext): React
   fun isActivated(promise: Promise) {
     promise.resolve(activated())
   }
+
+  @ReactMethod
+  fun destroy(promise: Promise) {
+    spokestack?.close()
+    spokestack?.removeListener(adapter)
+    spokestack = null
+
+    audioPlayer?.close()
+    audioPlayer = null
+
+    downloader = null
+
+    promise.resolve(null)
+  }
 }

android/src/main/java/com/reactnativespokestack/SpokestackModule.kt

@@ -37,30 +37,23 @@ export default function App() {
     }
     // This example app demonstrates both ways
     // to pass model files, but we recommend using one or the other.
-    Spokestack.initialize(clientId, clientSecret, {
-      wakeword: {
-        filter: require('../models/filter.tflite'),
-        detect: require('../models/detect.tflite'),
-        encode: require('../models/encode.tflite')
-      },
-      nlu: {
-        model: 'https://s.spokestack.io/u/7fYxV/nlu.tflite',
-        metadata: require('../models/metadata.sjson'),
-        vocab: require('../models/vocab.txt')
-      }
-    })
-      .then(Spokestack.start)
-      .then(async () => {
-        console.log(`Initialized: ${await Spokestack.isInitialized()}`)
-        console.log(`Started: ${await Spokestack.isStarted()}`)
-        console.log(`Activated: ${await Spokestack.isActivated()}`)
-      })
-      .catch((error) => {
-        setError(error.message)
+    try {
+      await Spokestack.initialize(clientId, clientSecret, {
+        wakeword: {
+          filter: require('../models/filter.tflite'),
+          detect: require('../models/detect.tflite'),
+          encode: require('../models/encode.tflite')
+        },
+        nlu: {
+          model: 'https://s.spokestack.io/u/7fYxV/nlu.tflite',
+          metadata: require('../models/metadata.sjson'),
+          vocab: require('../models/vocab.txt')
+        }
       })
-  }
-
-  React.useEffect(() => {
+    } catch (e) {
+      console.error(e)
+      setError(e.message)
+    }
     Spokestack.addEventListener('activate', () => setListening(true))
     Spokestack.addEventListener('deactivate', () => setListening(false))
     Spokestack.addEventListener(
@@ -80,12 +73,22 @@ export default function App() {
     Spokestack.addEventListener('play', ({ playing }: SpokestackPlayEvent) =>
       setPlaying(playing)
     )
+    try {
+      await Spokestack.start()
+      console.log(`Initialized: ${await Spokestack.isInitialized()}`)
+      console.log(`Started: ${await Spokestack.isStarted()}`)
+      console.log(`Activated: ${await Spokestack.isActivated()}`)
+    } catch (e) {
+      console.error(e)
+      setError(e.message)
+    }
+  }
 
+  React.useEffect(() => {
     init()
 
     return () => {
-      Spokestack.removeAllListeners()
-      Spokestack.stop()
+      Spokestack.destroy()
     }
   }, [])
 
@@ -102,21 +105,32 @@ export default function App() {
         <Button
           title={listening ? 'Listening...' : 'Listen'}
           onPress={async () => {
-            if (listening) {
-              Spokestack.deactivate()
-            } else {
-              Spokestack.activate()
+            try {
+              if (listening) {
+                await Spokestack.deactivate()
+              } else {
+                await Spokestack.activate()
+              }
+            } catch (e) {
+              console.error(e)
+              setError(e.message)
             }
           }}
           color="#2f5bea"
         />
         <Button
           title={playing ? 'Playing...' : `Play transcript`}
-          onPress={() => {
-            Spokestack.speak(transcript || noTranscriptMessage)
+          onPress={async () => {
+            try {
+              await Spokestack.speak(transcript || noTranscriptMessage)
+            } catch (e) {
+              console.error(e)
+              setError(e.message)
+            }
           }}
         />
       </View>
+
       {!!error && <Text style={styles.error}>{error}</Text>}
       <View style={styles.results}>
         <Text style={styles.transcript}>Transcript</Text>

example/src/App.tsx

@@ -46,4 +46,7 @@ @interface RCT_EXTERN_REMAP_MODULE(Spokestack, RNSpokestack, RCTEventEmitter)
 RCT_EXTERN_METHOD(isActivated:(RCTPromiseResolveBlock)resolve
                   withRejecter:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(destroy:(RCTPromiseResolveBlock)resolve
+                  withRejecter:(RCTPromiseRejectBlock)reject)
+
 @end

ios/RNSpokestack.m

@@ -470,22 +470,30 @@ class RNSpokestack: RCTEventEmitter, SpokestackDelegate {
             // from the cache and the last one builds the pipeline
             resolvers[RNSpokestackPromise.initialize] = resolve
             rejecters[RNSpokestackPromise.initialize] = reject
-
-            if wakeDownloads.count == 3 {
-                numRequests += wakeDownloads.count
+            let doWakeword = wakeDownloads.count == 3
+            let doKeyword = keywordDownloads.count >= 3
+            let doNLU = nluDownloads.count == 3
+            
+            // Set all request counts up-front
+            // in case some downloads complete synchronously
+            // from cache. This avoids building the pipeline
+            // before all downloads finish.
+            numRequests = (doWakeword ? wakeDownloads.count : 0) +
+                (doKeyword ? keywordDownloads.count : 0) +
+                (doNLU ? nluDownloads.count : 0)
+
+            if doWakeword {
                 wakeDownloads.forEach { (url, complete) in
                     d.downloadModel(url, complete)
                 }
             }
-            if keywordDownloads.count >= 3 {
-                numRequests += keywordDownloads.count
+            if doKeyword {
                 keywordDownloads.forEach { (url, complete) in
                     d.downloadModel(url, complete)
                 }
             }
-            if nluDownloads.count == 3 {
+            if doNLU {
                 makeClassifer = true
-                numRequests += nluDownloads.count
                 nluDownloads.forEach { (url, complete) in
                     d.downloadModel(url, complete)
                 }
@@ -634,4 +642,23 @@ class RNSpokestack: RCTEventEmitter, SpokestackDelegate {
             resolve(false)
         }
     }
+    
+    /// Destroys the speech pipeline and frees up all resources
+    @objc(destroy:withRejecter:)
+    func destroy(resolve: @escaping RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) {
+        if let pipeline = speechPipeline {
+            pipeline.stop()
+            speechPipeline = nil
+            
+            synthesizer?.stopSpeaking()
+            synthesizer = nil
+            
+            classifier = nil
+            
+            downloader = nil
+            
+            speechContext = nil
+        }
+        resolve(nil)
+    }
 }