react-native-sherpa-onnx 0.2.0 → 0.3.0

package/lib/module/tts/types.js

@@ -1,4 +1,89 @@
 "use strict";
 
-export {};
+/**
+ * Supported TTS model types.
+ *
+ * - 'vits': VITS models (includes Piper, Coqui, MeloTTS, MMS variants)
+ * - 'matcha': Matcha models (acoustic model + vocoder)
+ * - 'kokoro': Kokoro models (multi-speaker, multi-language)
+ * - 'kitten': KittenTTS models (lightweight, multi-speaker)
+ * - 'pocket': Pocket TTS models
+ * - 'zipvoice': Zipvoice models (voice cloning capable)
+ * - 'auto': Auto-detect model type based on files present (default)
+ */
+
+/** Runtime list of supported TTS model types. */
+export const TTS_MODEL_TYPES = ['vits', 'matcha', 'kokoro', 'kitten', 'pocket', 'zipvoice', 'auto'];
+
+// ========== Model-specific options (only applied when that model type is loaded) ==========
+
+/** Options for VITS models. Applied only when modelType is 'vits'. Kotlin OfflineTtsVitsModelConfig. */
+
+/** Options for Matcha models. Applied only when modelType is 'matcha'. Kotlin OfflineTtsMatchaModelConfig. */
+
+/** Options for Kokoro models. Applied only when modelType is 'kokoro'. Kotlin OfflineTtsKokoroModelConfig. */
+
+/** Options for KittenTTS models. Applied only when modelType is 'kitten'. Kotlin OfflineTtsKittenModelConfig. */
+
+/** Options for Pocket TTS models. Applied only when modelType is 'pocket'. Kotlin has no init-time model config for pocket; reserved for future use. */
+
+/**
+ * Model-specific TTS options. Only the block for the actually loaded model type is applied;
+ * others are ignored (e.g. vits options have no effect when a kokoro model is loaded).
+ */
+
+/**
+ * Configuration for TTS initialization.
+ */
+
+/**
+ * Options for updating TTS model parameters at runtime.
+ * Only the block for the given modelType is applied; flattened to native noiseScale / noiseScaleW / lengthScale.
+ */
+
+/**
+ * Options for TTS generation. Maps to Kotlin GenerationConfig when reference
+ * audio or advanced options are used; otherwise simple sid/speed are used.
+ */
+
+/**
+ * Generated audio data from TTS synthesis.
+ *
+ * The samples are normalized float values in the range [-1.0, 1.0].
+ * To save as a WAV file or play the audio, you'll need to convert
+ * these samples to the appropriate format for your use case.
+ */
+
+/**
+ * Subtitle/timestamp item for synthesized speech.
+ */
+
+/**
+ * Generated audio with subtitle/timestamp metadata.
+ */
+
+/**
+ * Streaming chunk event payload for TTS generation.
+ */
+
+/**
+ * Streaming end event payload.
+ */
+
+/**
+ * Streaming error event payload.
+ */
+
+/**
+ * Handlers for TTS streaming generation (chunk, end, error).
+ */
+
+/**
+ * Instance-based TTS engine returned by createTTS().
+ * Call destroy() when done to free native resources.
+ */
+
+/**
+ * Information about TTS model capabilities.
+ */
 //# sourceMappingURL=types.js.map

package/lib/module/tts/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sourceRoot":"..\\..\\..\\src","sources":["tts/types.ts"],"mappings":"","ignoreList":[]}
+{"version":3,"names":["TTS_MODEL_TYPES"],"sourceRoot":"../../../src","sources":["tts/types.ts"],"mappings":";;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA,OAAO,MAAMA,eAAwC,GAAG,CACtD,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,MAAM,CACE;;AAEV;;AAEA;;AAUA;;AAQA;;AAMA;;AAMA;;AAKA;AACA;AACA;AACA;;AASA;AACA;AACA;;AAuEA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;;AAsDA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;;AAkBA;AACA;AACA;;AAaA;AACA;AACA;;AAUA;AACA;AACA;;AAOA;AACA;AACA;;AAOA;AACA;AACA;;AAOA;AACA;AACA;AACA;;AA8BA;AACA;AACA","ignoreList":[]}

package/lib/module/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sourceRoot":"..\\..\\src","sources":["types.ts"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sourceRoot":"../../src","sources":["types.ts"],"mappings":"","ignoreList":[]}

package/lib/module/utils.js

@@ -3,22 +3,17 @@
 import { Platform } from 'react-native';
 import SherpaOnnx from "./NativeSherpaOnnx.js";
 
-/**
- * Utility functions for model path handling
+/**
+ * Utility functions for model path handling
  */
 
-/**
- * Predefined model identifiers
- */
-export const MODELS = {
-  ZIPFORMER_EN: 'sherpa-onnx-zipformer-small-en',
-  PARAFORMER_ZH: 'sherpa-onnx-paraformer-zh-small'
-};
-/**
- * Get the default model directory path for the current platform.
- * This is a helper for apps that want to use a standard location.
- *
- * @returns Platform-specific default path
+/**
+ * Get the default model directory path for the current platform.
+ * This is a logical name (e.g. `'Documents/models'` on iOS), not an absolute path.
+ * On iOS, when using file-based models without PAD, pass an absolute base path to
+ * `getFileModelPath` instead (e.g. `DocumentDirectoryPath + '/models'` from react-native-fs).
+ *
+ * @returns Platform-specific default path
  */
 export function getDefaultModelPath() {
   if (Platform.OS === 'ios') {
@@ -30,12 +25,12 @@ export function getDefaultModelPath() {
   }
 }
 
-/**
- * Create a model path configuration for asset models.
- * Use this when models are bundled in your app's assets.
- *
- * @param assetPath - Path relative to assets (e.g., "models/sherpa-onnx-model")
- * @returns Model path configuration
+/**
+ * Create a model path configuration for asset models.
+ * Use this when models are bundled in your app's assets.
+ *
+ * @param assetPath - Path relative to assets (e.g., "models/sherpa-onnx-model")
+ * @returns Model path configuration
  */
 export function assetModelPath(assetPath) {
   return {
@@ -44,12 +39,14 @@ export function assetModelPath(assetPath) {
   };
 }
 
-/**
- * Create a model path configuration for file system models.
- * Use this when models are downloaded or stored in file system.
- *
- * @param filePath - Absolute path to model directory
- * @returns Model path configuration
+/**
+ * Create a model path configuration for file system models.
+ * Use this when models are downloaded or stored in file system.
+ *
+ * @param filePath - Absolute path to model directory. On iOS, use an absolute path
+ *   (e.g. from react-native-fs: `DocumentDirectoryPath + '/models/' + modelName` when
+ *   using getFileModelPath without PAD).
+ * @returns Model path configuration
  */
 export function fileModelPath(filePath) {
   return {
@@ -58,12 +55,12 @@ export function fileModelPath(filePath) {
   };
 }
 
-/**
- * Create a model path configuration with auto-detection.
- * Tries asset first, then file system.
- *
- * @param path - Path to try (will be checked as both asset and file)
- * @returns Model path configuration
+/**
+ * Create a model path configuration with auto-detection.
+ * Tries asset first, then file system.
+ *
+ * @param path - Path to try (will be checked as both asset and file)
+ * @returns Model path configuration
  */
 export function autoModelPath(path) {
   return {
@@ -72,54 +69,70 @@ export function autoModelPath(path) {
   };
 }
 
-/**
- * Resolve model path based on configuration.
- * This handles different path types (asset, file, auto) and returns
- * a platform-specific absolute path that can be used by native code.
- *
- * @param config - Model path configuration or simple string path
- * @returns Promise resolving to absolute path usable by native code
+/**
+ * Resolve model path based on configuration.
+ * This handles different path types (asset, file, auto) and returns
+ * a platform-specific absolute path that can be used by native code.
+ *
+ * @param config - Model path configuration
+ * @returns Promise resolving to absolute path usable by native code
  */
 export async function resolveModelPath(config) {
-  // Backward compatibility: if string is passed, treat as auto
-  if (typeof config === 'string') {
-    return SherpaOnnx.resolveModelPath({
-      type: 'auto',
-      path: config
-    });
-  }
   return SherpaOnnx.resolveModelPath(config);
 }
 
-/**
- * List all model folders in the assets/models directory.
- * Scans the platform-specific model directory and returns folder names.
- *
- * This is useful for discovering models at runtime without hardcoding paths.
- * You can then use the returned folder names with resolveModelPath and initialize.
- *
- * @returns Promise resolving to array of model info objects
- *
- * @example
- * ```typescript
- * import { listAssetModels, resolveModelPath } from 'react-native-sherpa-onnx';
- *
- * // Get all model folders
- * const models = await listAssetModels();
- * console.log('Found models:', models);
- * // Example output: [{ folder: 'sherpa-onnx-streaming-zipformer-en-2023-06-26', hint: 'stt' }, { folder: 'sherpa-onnx-matcha-icefall-en_US-ljspeech', hint: 'tts' }]
- *
- * // Initialize each model to detect types
- * for (const model of models) {
- *   const path = await resolveModelPath({ type: 'asset', path: `models/${model.folder}` });
- *   const result = await initializeSherpaOnnx(path);
- *   if (result.success) {
- *     console.log(`Found models in ${model.folder}:`, result.detectedModels);
- *   }
- * }
- * ```
+/**
+ * List all model folders in the assets/models directory.
+ * Scans the platform-specific model directory and returns folder names.
+ *
+ * This is useful for discovering models at runtime without hardcoding paths.
+ * You can then use the returned folder names with resolveModelPath and initialize.
+ *
+ * @returns Promise resolving to array of model info objects
+ *
+ * @example
+ * ```typescript
+ * import { listAssetModels, resolveModelPath } from 'react-native-sherpa-onnx';
+ *
+ * // Get all model folders
+ * const models = await listAssetModels();
+ * console.log('Found models:', models);
+ * // Example output: [{ folder: 'sherpa-onnx-streaming-zipformer-en-2023-06-26', hint: 'stt' }, { folder: 'sherpa-onnx-matcha-icefall-en_US-ljspeech', hint: 'tts' }]
+ *
+ * // Initialize each model to detect types
+ * for (const model of models) {
+ *   const path = await resolveModelPath({ type: 'asset', path: `models/${model.folder}` });
+ *   const result = await initializeStt(path);
+ *   if (result.success) {
+ *     console.log(`Found models in ${model.folder}:`, result.detectedModels);
+ *   }
+ * }
+ * ```
  */
 export async function listAssetModels() {
   return SherpaOnnx.listAssetModels();
 }
+
+/**
+ * List model folders under a specific filesystem path.
+ * When recursive is true, returns relative folder paths under the base path.
+ */
+export async function listModelsAtPath(path, recursive = false) {
+  return SherpaOnnx.listModelsAtPath(path, recursive);
+}
+
+/**
+ * **Play Asset Delivery (PAD):** Returns the path to the models directory inside an
+ * Android asset pack, or null if the pack is not available.
+ * Use this to list and load models delivered via PAD (e.g. pack "sherpa_models").
+ * On iOS returns null.
+ */
+export async function getAssetPackPath(packName) {
+  return SherpaOnnx.getAssetPackPath(packName);
+}
+
+/**
+ * Alias for {@link getAssetPackPath}. Use for PAD (Play Asset Delivery) model discovery.
+ */
+export const getPlayAssetDeliveryModelsPath = getAssetPackPath;
 //# sourceMappingURL=utils.js.map

package/lib/module/utils.js.map

@@ -1 +1 @@
-{"version":3,"names":["Platform","SherpaOnnx","MODELS","ZIPFORMER_EN","PARAFORMER_ZH","getDefaultModelPath","OS","assetModelPath","assetPath","type","path","fileModelPath","filePath","autoModelPath","resolveModelPath","config","listAssetModels"],"sourceRoot":"..\\..\\src","sources":["utils.ts"],"mappings":";;AAAA,SAASA,QAAQ,QAAQ,cAAc;AAEvC,OAAOC,UAAU,MAAM,uBAAoB;;AAE3C;AACA;AACA;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,MAAM,GAAG;EACpBC,YAAY,EAAE,gCAAgC;EAC9CC,aAAa,EAAE;AACjB,CAAU;AAIV;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAW;EAC5C,IAAIL,QAAQ,CAACM,EAAE,KAAK,KAAK,EAAE;IACzB;IACA,OAAO,kBAAkB;EAC3B,CAAC,MAAM;IACL;IACA,OAAO,QAAQ;EACjB;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACC,SAAiB,EAAmB;EACjE,OAAO;IACLC,IAAI,EAAE,OAAO;IACbC,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,aAAaA,CAACC,QAAgB,EAAmB;EAC/D,OAAO;IACLH,IAAI,EAAE,MAAM;IACZC,IAAI,EAAEE;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACH,IAAY,EAAmB;EAC3D,OAAO;IACLD,IAAI,EAAE,MAAM;IACZC,IAAI,EAAEA;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeI,gBAAgBA,CACpCC,MAAgC,EACf;EACjB;EACA,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;IAC9B,OAAOd,UAAU,CAACa,gBAAgB,CAAC;MACjCL,IAAI,EAAE,MAAM;MACZC,IAAI,EAAEK;IACR,CAAC,CAAC;EACJ;EAEA,OAAOd,UAAU,CAACa,gBAAgB,CAACC,MAAM,CAAC;AAC5C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,eAAeA,CAAA,EAEnC;EACA,OAAOf,UAAU,CAACe,eAAe,CAAC,CAAC;AACrC","ignoreList":[]}
+{"version":3,"names":["Platform","SherpaOnnx","getDefaultModelPath","OS","assetModelPath","assetPath","type","path","fileModelPath","filePath","autoModelPath","resolveModelPath","config","listAssetModels","listModelsAtPath","recursive","getAssetPackPath","packName","getPlayAssetDeliveryModelsPath"],"sourceRoot":"../../src","sources":["utils.ts"],"mappings":";;AAAA,SAASA,QAAQ,QAAQ,cAAc;AAEvC,OAAOC,UAAU,MAAM,uBAAoB;;AAE3C;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAW;EAC5C,IAAIF,QAAQ,CAACG,EAAE,KAAK,KAAK,EAAE;IACzB;IACA,OAAO,kBAAkB;EAC3B,CAAC,MAAM;IACL;IACA,OAAO,QAAQ;EACjB;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACC,SAAiB,EAAmB;EACjE,OAAO;IACLC,IAAI,EAAE,OAAO;IACbC,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,aAAaA,CAACC,QAAgB,EAAmB;EAC/D,OAAO;IACLH,IAAI,EAAE,MAAM;IACZC,IAAI,EAAEE;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACH,IAAY,EAAmB;EAC3D,OAAO;IACLD,IAAI,EAAE,MAAM;IACZC,IAAI,EAAEA;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeI,gBAAgBA,CACpCC,MAAuB,EACN;EACjB,OAAOX,UAAU,CAACU,gBAAgB,CAACC,MAAM,CAAC;AAC5C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,eAAeA,CAAA,EAEnC;EACA,OAAOZ,UAAU,CAACY,eAAe,CAAC,CAAC;AACrC;;AAEA;AACA;AACA;AACA;AACA,OAAO,eAAeC,gBAAgBA,CACpCP,IAAY,EACZQ,SAAS,GAAG,KAAK,EACoD;EACrE,OAAOd,UAAU,CAACa,gBAAgB,CAACP,IAAI,EAAEQ,SAAS,CAAC;AACrD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,gBAAgBA,CACpCC,QAAgB,EACQ;EACxB,OAAOhB,UAAU,CAACe,gBAAgB,CAACC,QAAQ,CAAC;AAC9C;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,8BAA8B,GAAGF,gBAAgB","ignoreList":[]}

package/lib/module/vad/index.js

@@ -12,7 +12,7 @@
  * // Future usage:
  * import { initializeVAD, detectVoiceActivity } from 'react-native-sherpa-onnx/vad';
  *
- * await initializeVAD({ modelPath: 'models/vad-model' });
+ * await initializeVAD({ modelPath: { type: 'auto', path: 'models/vad-model' } });
  * const segments = await detectVoiceActivity('path/to/audio.wav');
  * ```
  */

package/lib/module/vad/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["initializeVAD","_options","Error","detectVoiceActivity","_filePath","unloadVAD"],"sourceRoot":"..\\..\\..\\src","sources":["vad/index.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAMA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeA,aAAaA,CACjCC,QAA8B,EACf;EACf,MAAM,IAAIC,KAAK,CACb,mEACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CACjCC,SAAiB,EACQ;EACzB,MAAM,IAAIF,KAAK,CACb,mEACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,SAASA,CAAA,EAAkB;EACzC,MAAM,IAAIH,KAAK,CACb,mEACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"names":["initializeVAD","_options","Error","detectVoiceActivity","_filePath","unloadVAD"],"sourceRoot":"../../../src","sources":["vad/index.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA;AACA;;AAMA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeA,aAAaA,CACjCC,QAA8B,EACf;EACf,MAAM,IAAIC,KAAK,CACb,mEACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CACjCC,SAAiB,EACQ;EACzB,MAAM,IAAIF,KAAK,CACb,mEACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,SAASA,CAAA,EAAkB;EACzC,MAAM,IAAIH,KAAK,CACb,mEACF,CAAC;AACH","ignoreList":[]}