react-native-davoice 1.0.4

package/README.md

@@ -0,0 +1,319 @@
+# react-native-davoice
+
+React Native on-device speech package for:
+
+- text to speech
+- speech to text
+- unified speech flows that coordinate STT and TTS together
+
+It supports iOS and Android and is designed for apps that need a local voice pipeline with native audio-session handling.
+
+This package pairs well with `react-native-wakeword`, which covers wake-word, keyword spotting, and related always-listening flows.
+
+## Features
+
+- On-device TTS for React Native
+- On-device STT for React Native
+- Unified `speech/` API that can coordinate STT and TTS together
+- Native event support for speech results, partials, volume, and TTS completion
+- License activation and validation APIs
+- Local model paths, bundled assets, and asset `require(...)` support
+- WAV / audio playback helpers in the unified speech API
+- iOS microphone and speech-recognition permission helpers
+
+## Package Layout
+
+The package exposes three entry points:
+
+- `react-native-davoice`
+  Default TTS entry point.
+- `react-native-davoice/stt`
+  Standalone speech-to-text API.
+- `react-native-davoice/speech`
+  Unified API for apps that use both TTS and STT together.
+
+## Installation
+
+```bash
+npm install react-native-davoice
+```
+
+or
+
+```bash
+yarn add react-native-davoice
+```
+
+For iOS:
+
+```bash
+cd ios
+pod install
+```
+
+React Native autolinking is supported.
+
+## When To Use Which API
+
+Use `react-native-davoice/speech` if your app uses both STT and TTS and you want one bridge managing the flow.
+
+Use `react-native-davoice` if you only need TTS.
+
+Use `react-native-davoice/stt` if you only need speech recognition.
+
+## Quick Start
+
+### Unified Speech API
+
+```ts
+import Speech from 'react-native-davoice/speech';
+
+const model = require('./assets/models/model_ex_ariana.dm');
+
+await Speech.setLicense('YOUR_LICENSE_KEY');
+await Speech.initAll({
+  locale: 'en-US',
+  model,
+});
+
+Speech.onSpeechResults = (event) => {
+  console.log('results', event.value);
+};
+
+Speech.onSpeechPartialResults = (event) => {
+  console.log('partial', event.value);
+};
+
+Speech.onFinishedSpeaking = () => {
+  console.log('finished speaking');
+};
+
+await Speech.start('en-US');
+await Speech.speak('Hello from DaVoice', 0, 1.0);
+```
+
+### TTS Only
+
+```ts
+import { DaVoiceTTSInstance } from 'react-native-davoice';
+
+const tts = new DaVoiceTTSInstance();
+
+await tts.setLicense('YOUR_LICENSE_KEY');
+await tts.initTTS({
+  model: require('./assets/models/model_ex_ariana.dm'),
+});
+
+tts.onFinishedSpeaking(() => {
+  console.log('done');
+});
+
+await tts.speak('Hello world', 0);
+```
+
+### STT Only
+
+```ts
+import STT from 'react-native-davoice/stt';
+
+await STT.setLicense('YOUR_LICENSE_KEY');
+
+STT.onSpeechResults = (event) => {
+  console.log(event.value);
+};
+
+await STT.start('en-US');
+```
+
+## Unified Speech API
+
+The unified API is intended for real voice flows where STT and TTS are part of the same experience.
+
+Common methods:
+
+- `initAll({ locale, model, timeoutMs?, onboardingJsonPath? })`
+- `destroyAll()`
+- `start(locale, options?)`
+- `stop()`
+- `cancel()`
+- `speak(text, speakerId?, speed?)`
+- `stopSpeaking()`
+- `playWav(pathOrURL, markAsLast?)`
+- `playPCM(data, { sampleRate, channels?, interleaved?, format?, markAsLast? })`
+- `playBuffer({ base64, sampleRate, channels?, interleaved?, format, markAsLast? })`
+- `pauseMicrophone()`
+- `unPauseMicrophone()`
+- `pauseSpeechRecognition()`
+- `unPauseSpeechRecognition(times)`
+- `isAvailable()`
+- `isRecognizing()`
+- `setLicense(licenseKey)`
+- `isLicenseValid(licenseKey)`
+
+Unified events:
+
+- `onSpeechStart`
+- `onSpeechRecognized`
+- `onSpeechEnd`
+- `onSpeechError`
+- `onSpeechResults`
+- `onSpeechPartialResults`
+- `onSpeechVolumeChanged`
+- `onFinishedSpeaking`
+- `onNewSpeechWAV`
+  Android-only remote STT flow event.
+
+### iOS Permission Helpers
+
+The unified API also exposes iOS permission helpers:
+
+- `hasIOSMicPermissions()`
+- `requestIOSMicPermissions(waitTimeout)`
+- `hasIOSSpeechRecognitionPermissions()`
+- `requestIOSSpeechRecognitionPermissions(waitTimeout)`
+
+## TTS API
+
+TTS is exposed from the package root.
+
+```ts
+import { DaVoiceTTSInstance } from 'react-native-davoice';
+```
+
+Available methods:
+
+- `initTTS({ model })`
+- `setLicense(licenseKey)`
+- `isLicenseValid(licenseKey)`
+- `speak(text, speakerId?)`
+- `stopSpeaking()`
+- `destroy()`
+- `onFinishedSpeaking(callback)`
+
+## STT API
+
+```ts
+import STT from 'react-native-davoice/stt';
+```
+
+Available methods:
+
+- `start(locale, options?)`
+- `stop()`
+- `cancel()`
+- `destroy()`
+- `isAvailable()`
+- `isRecognizing()`
+- `setLicense(licenseKey)`
+- `isLicenseValid(licenseKey)`
+
+Available event handlers:
+
+- `onSpeechStart`
+- `onSpeechRecognized`
+- `onSpeechEnd`
+- `onSpeechError`
+- `onSpeechResults`
+- `onSpeechPartialResults`
+- `onSpeechVolumeChanged`
+
+## License API
+
+All entry points expose the same license helpers:
+
+```ts
+await Speech.setLicense(key);
+await Speech.isLicenseValid(key);
+
+await tts.setLicense(key);
+await tts.isLicenseValid(key);
+
+await STT.setLicense(key);
+await STT.isLicenseValid(key);
+```
+
+For the unified `speech/` entry point, `setLicense` applies the license to both STT and TTS under the hood.
+
+## Models And Assets
+
+Model arguments can be provided as:
+
+- a local file path
+- a bundled asset via `require(...)`
+- a file URL
+- in some APIs, a remote URL
+
+Typical model formats used by this package include `.dm` and `.onnx`.
+
+If your app bundles model files with Metro, make sure your React Native asset configuration includes the extensions you use.
+
+## Works Well With react-native-wakeword
+
+If your product needs wake word, keyword spotting, or an always-listening front end, pair this package with `react-native-wakeword`.
+
+A common production setup is:
+
+1. `react-native-wakeword` for wake word and wake-phase audio control.
+2. `react-native-davoice/speech` for STT, TTS, and the active voice session.
+
+That separation works well for assistants, hands-free flows, and full on-device voice UX.
+
+## Platform Notes
+
+### iOS
+
+- Run `pod install` after adding or updating the package.
+- Microphone permission is required.
+- Speech recognition permission may also be required for STT flows.
+
+### Android
+
+- Autolinking is supported.
+- The package includes native Android bridge registration.
+- `onNewSpeechWAV` is Android-only.
+
+## Example
+
+This README was aligned with the companion DaVoice React Native example app that demonstrates:
+
+- TTS model selection
+- STT flows
+- combined speech orchestration
+- integration alongside `react-native-wakeword`
+
+## Troubleshooting
+
+### Native module not found
+
+Make sure:
+
+- the package is installed in `node_modules`
+- iOS pods are installed
+- the app was rebuilt after installation
+
+### Model file cannot be resolved
+
+Check:
+
+- the model path is correct
+- the asset was bundled correctly
+- Metro is configured to include the model extension
+
+### TTS or STT fails to initialize
+
+Check:
+
+- the license was set before initialization
+- the model file exists on device
+- required permissions were granted
+
+## Support
+
+For licensing, production integration, or custom deployments:
+
+- Website: [https://davoice.io](https://davoice.io)
+- Email: `info@davoice.io`
+
+## License
+
+MIT for the React Native wrapper. Native model/runtime licensing may require a commercial DaVoice license depending on your deployment.

package/TTSRNBridge.podspec

@@ -0,0 +1,38 @@
+require 'json'
+
+Pod::Spec.new do |s|
+    s.name         = "TTSRNBridge"
+    s.version      = "1.0.184" # Update to your package version
+    s.summary      = "TTS for React Native."
+    s.description  = <<-DESC
+                     A React Native module for tts .
+                     DESC
+    s.homepage     = "https://github.com/frymanofer/KeywordsDetectionAndroidLibrary.git" # Update with your repo URL
+    s.license      = { :type => "MIT" } # Update if different
+    s.author       = { "Your Name" => "ofer@davoice.io" } # Update with your info
+    s.platform     = :ios, "11"
+#   s.source       = { :git => "https://github.com/frymanofer/KeywordsDetectionAndroidLibrary.git", :tag => s.version.to_s } # Update accordingly
+    s.source       = { :path => "." }
+
+#    s.source_files = "ios/*.{h,m,mm,swift}"
+#    s.resources    = "ios/TTSRNBridge/models/*"
+#    s.source_files = 'ios/TTSRNBridge/DaVoiceTTSBridge.m', 'ios/TTSRNBridge/DaVoiceTTSBridge.h'
+    s.source_files = [
+        "ios/TTSRNBridge/DaVoiceTTSBridge.{h,m}",
+        "ios/STTRNBridge/STTBridge.{h,m}",
+        "ios/SpeechBridge/SpeechBridge.{h,m}",
+        "ios/STT/**/*.{swift}"
+    ]
+
+    #s.static_framework = true
+    # Add your static libraries explicitly as vendored_libraries
+    s.vendored_libraries = "ios/TTSRNBridge/libucd.a", "ios/TTSRNBridge/libphonemes.a"
+
+    s.vendored_frameworks = "ios/TTSRNBridge/DavoiceTTS.xcframework"
+  
+    s.dependency "React-Core"
+    s.dependency "onnxruntime-objc", "~> 1.20.0"
+    s.preserve_paths = 'docs', 'CHANGELOG.md', 'LICENSE', 'package.json'
+
+  end
+  

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Thu Sep 11 11:04:24 IDT 2025
+gradle.version=8.9

package/android/build.gradle

@@ -0,0 +1,47 @@
+//android/build.gradle
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+    compileSdkVersion 33
+
+    defaultConfig {
+        minSdkVersion 26
+        targetSdkVersion 33
+        consumerProguardFiles 'consumer-rules.pro'
+    }
+
+    sourceSets {
+        main {
+            assets.srcDirs = [
+                'src/main/assets',
+                ]
+            jniLibs.srcDirs = ['src/main/jniLibs'] // Add this line if needed
+        }
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+    maven {
+        url './libs'
+    }
+    maven {
+        url "$projectDir/libs"
+    }
+    mavenLocal()
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.9.24"  // <-- add
+    implementation "com.facebook.react:react-native:+"
+    api 'com.davoice:tts:1.0.0'
+}
+
+// Run this once to be able to run the application with BUCK
+// puts all compile dependencies into folder libs for BUCK to use
+task copyDownloadableDepsToLibs(type: Copy) { 
+    from configurations.implementation
+    into 'libs'
+}

package/android/libs/com/davoice/tts/1.0.0/tts-1.0.0.aar.md5

@@ -0,0 +1 @@
+dd2b50d07ff256989600f071c66d4227  tts-1.0.0.aar

package/android/libs/com/davoice/tts/1.0.0/tts-1.0.0.aar.sha1

@@ -0,0 +1 @@
+f351faff177e5d8cba9faacd5bf97da0accb10b0  tts-1.0.0.aar

package/android/libs/com/davoice/tts/1.0.0/tts-1.0.0.pom

@@ -0,0 +1,38 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" 
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
+                             http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+
+  <!-- Your Maven coordinates -->
+  <groupId>com.davoice</groupId>
+  <artifactId>tts</artifactId>
+  <version>1.0.0</version>
+  <packaging>aar</packaging>
+
+  <name>DaVoice TTS</name>
+  <description>
+    Advanced text-to-speech (TTS) library by DaVoice for Android, packaged as an AAR.
+  </description>
+  <url>https://davoice.io</url>
+
+  <licenses>
+    <license>
+      <name>Proprietary License</name>
+      <url>https://davoice.io/license</url>
+      <distribution>repo</distribution>
+    </license>
+  </licenses>
+
+  <developers>
+    <developer>
+      <id>davoice</id>
+      <name>DaVoice Team</name>
+      <email>support@davoice.io</email>
+      <organization>DaVoice LTD</organization>
+      <organizationUrl>https://davoice.io</organizationUrl>
+    </developer>
+  </developers>
+
+</project>

package/android/libs/com/davoice/tts/1.0.0/tts-1.0.0.pom.md5

@@ -0,0 +1 @@
+751a7e1f63e63b9ec1832fa597bf4b0c  tts-1.0.0.pom

package/android/libs/com/davoice/tts/1.0.0/tts-1.0.0.pom.sha1

@@ -0,0 +1 @@
+cdae716fc67e3faa885f98c97db85d5ac47751cc  tts-1.0.0.pom

package/android/settings.gradle

@@ -0,0 +1,2 @@
+include ':react-native-davoice-tts'
+project(':react-native-davoice-tts').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-davoice-tts/android')

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,14 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.davoice.tts.rn">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS"/>
+    <uses-permission android:name="android.permission.WAKE_LOCK"/>
+    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
+
+    <!-- Place in the app -->
+    <!-- <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK"/> -->
+
+</manifest>
+

package/android/src/main/java/com/davoice/rn/DaVoicePackage.java

@@ -0,0 +1,29 @@
+package com.davoice.rn;
+
+import com.facebook.react.ReactPackage;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.NativeModule;
+import com.facebook.react.uimanager.ViewManager;
+
+import java.util.Collections;
+import java.util.ArrayList;
+import java.util.List;
+
+import com.davoice.tts.rn.DaVoiceTTSBridge;
+import com.davoice.stt.rn.STTModule;
+
+public class DaVoicePackage implements ReactPackage {
+
+  @Override
+  public List<NativeModule> createNativeModules(ReactApplicationContext rc) {
+    List<NativeModule> modules = new ArrayList<>();
+    modules.add(new DaVoiceTTSBridge(rc)); // "DaVoiceTTSBridge"
+    modules.add(new STTModule(rc));        // "STT"
+    return modules;
+  }
+
+  @Override
+  public List<ViewManager> createViewManagers(ReactApplicationContext rc) {
+    return Collections.emptyList();
+  }
+}