react-native-sherpa-onnx 0.2.0 → 0.3.0

package/lib/module/stt/index.js

@@ -2,81 +2,148 @@
 
 import SherpaOnnx from "../NativeSherpaOnnx.js";
 import { resolveModelPath } from "../utils.js";
+let sttInstanceCounter = 0;
+function normalizeSttResult(raw) {
+  return {
+    text: typeof raw.text === 'string' ? raw.text : '',
+    tokens: Array.isArray(raw.tokens) ? raw.tokens : [],
+    timestamps: Array.isArray(raw.timestamps) ? raw.timestamps : [],
+    lang: typeof raw.lang === 'string' ? raw.lang : '',
+    emotion: typeof raw.emotion === 'string' ? raw.emotion : '',
+    event: typeof raw.event === 'string' ? raw.event : '',
+    durations: Array.isArray(raw.durations) ? raw.durations : []
+  };
+}
+
+/**
+ * Detect STT model type and structure without initializing the recognizer.
+ * Uses the same native file-based detection as createSTT. Stateless; no instance required.
+ *
+ * @param modelPath - Model path configuration (asset, file, or auto)
+ * @param options - Optional preferInt8 and modelType (default: auto)
+ * @returns Object with success, detectedModels (array of { type, modelDir }), and modelType (primary detected type)
+ * @example
+ * ```typescript
+ * const path = { type: 'asset' as const, path: 'models/sherpa-onnx-whisper-tiny-en' };
+ * const result = await detectSttModel(path);
+ * if (result.success && result.detectedModels.length > 0) {
+ *   console.log('Detected type:', result.modelType, result.detectedModels);
+ * }
+ * ```
+ */
+export async function detectSttModel(modelPath, options) {
+  const resolvedPath = await resolveModelPath(modelPath);
+  return SherpaOnnx.detectSttModel(resolvedPath, options?.preferInt8, options?.modelType);
+}
 
-/**
- * Initialize Speech-to-Text (STT) with model directory.
- *
- * Supports multiple model source types:
- * - Asset models (bundled in app)
- * - File system models (downloaded or user-provided)
- * - Auto-detection (tries asset first, then file system)
- *
- * @param options - STT initialization options or model path configuration
- * @returns Object with success status and array of detected models (each with type and modelDir)
- * @example
- * ```typescript
- * // Simple string (auto-detect)
- * const result = await initializeSTT('models/sherpa-onnx-model');
- * console.log('Detected models:', result.detectedModels);
- * // result.detectedModels = [{ type: 'transducer', modelDir: '/path/to/model' }]
- *
- * // Asset model
- * const result = await initializeSTT({
- *   modelPath: { type: 'asset', path: 'models/sherpa-onnx-model' }
- * });
- *
- * // File system model with preferInt8 option
- * const result = await initializeSTT({
- *   modelPath: { type: 'file', path: '/path/to/model' },
- *   preferInt8: true  // Prefer quantized int8 models (smaller, faster)
- * });
- *
- * // With explicit model type
- * const result = await initializeSTT({
- *   modelPath: { type: 'asset', path: 'models/sherpa-onnx-nemo-parakeet-tdt-ctc-en' },
- *   modelType: 'nemo_ctc'
- * });
- * ```
+/**
+ * Create an STT engine instance. Call destroy() on the returned engine when done to free native resources.
+ *
+ * @param options - STT initialization options or model path configuration
+ * @returns Promise resolving to an SttEngine instance
+ * @example
+ * ```typescript
+ * const stt = await createSTT({
+ *   modelPath: { type: 'asset', path: 'models/whisper-tiny' },
+ * });
+ * const result = await stt.transcribeFile('/path/to/audio.wav');
+ * console.log(result.text);
+ * await stt.destroy();
+ * ```
  */
-export async function initializeSTT(options) {
-  // Handle both object syntax and direct path syntax
+export async function createSTT(options) {
+  const instanceId = `stt_${++sttInstanceCounter}`;
   let modelPath;
   let preferInt8;
   let modelType;
-  if (typeof options === 'object' && 'modelPath' in options) {
+  let hotwordsFile;
+  let hotwordsScore;
+  let numThreads;
+  let provider;
+  let ruleFsts;
+  let ruleFars;
+  let dither;
+  let modelOptions;
+  let modelingUnit;
+  let bpeVocab;
+  if ('modelPath' in options) {
     modelPath = options.modelPath;
     preferInt8 = options.preferInt8;
     modelType = options.modelType;
+    hotwordsFile = options.hotwordsFile;
+    hotwordsScore = options.hotwordsScore;
+    numThreads = options.numThreads;
+    provider = options.provider;
+    ruleFsts = options.ruleFsts;
+    ruleFars = options.ruleFars;
+    dither = options.dither;
+    modelOptions = options.modelOptions;
+    modelingUnit = options.modelingUnit;
+    bpeVocab = options.bpeVocab;
   } else {
     modelPath = options;
     preferInt8 = undefined;
     modelType = undefined;
+    hotwordsFile = undefined;
+    hotwordsScore = undefined;
+    numThreads = undefined;
+    provider = undefined;
+    ruleFsts = undefined;
+    ruleFars = undefined;
+    dither = undefined;
+    modelOptions = undefined;
+    modelingUnit = undefined;
+    bpeVocab = undefined;
   }
+  const debug = 'modelPath' in options ? options.debug : undefined;
   const resolvedPath = await resolveModelPath(modelPath);
-  return SherpaOnnx.initializeSherpaOnnx(resolvedPath, preferInt8, modelType);
-}
-
-/**
- * Transcribe an audio file.
- *
- * @param filePath - Path to WAV file (16kHz, mono, 16-bit PCM)
- * @returns Promise resolving to transcribed text
- * @example
- * ```typescript
- * const transcription = await transcribeFile('path/to/audio.wav');
- * console.log('Transcription:', transcription);
- * ```
- */
-export function transcribeFile(filePath) {
-  return SherpaOnnx.transcribeFile(filePath);
+  const result = await SherpaOnnx.initializeStt(instanceId, resolvedPath, preferInt8, modelType, debug, hotwordsFile, hotwordsScore, numThreads, provider, ruleFsts, ruleFars, dither, modelOptions, modelingUnit, bpeVocab);
+  if (!result.success) {
+    throw new Error(`STT initialization failed: ${JSON.stringify(result.detectedModels ?? [])}`);
+  }
+  let destroyed = false;
+  const guard = () => {
+    if (destroyed) {
+      throw new Error(`STT instance ${instanceId} has been destroyed; cannot call methods on it.`);
+    }
+  };
+  const engine = {
+    get instanceId() {
+      return instanceId;
+    },
+    async transcribeFile(filePath) {
+      guard();
+      const raw = await SherpaOnnx.transcribeFile(instanceId, filePath);
+      return normalizeSttResult(raw);
+    },
+    async transcribeSamples(samples, sampleRate) {
+      guard();
+      const raw = await SherpaOnnx.transcribeSamples(instanceId, samples, sampleRate);
+      return normalizeSttResult(raw);
+    },
+    async setConfig(config) {
+      guard();
+      const map = {};
+      if (config.decodingMethod != null) map.decodingMethod = config.decodingMethod;
+      if (config.maxActivePaths != null) map.maxActivePaths = config.maxActivePaths;
+      if (config.hotwordsFile != null) map.hotwordsFile = config.hotwordsFile;
+      if (config.hotwordsScore != null) map.hotwordsScore = config.hotwordsScore;
+      if (config.blankPenalty != null) map.blankPenalty = config.blankPenalty;
+      if (config.ruleFsts != null) map.ruleFsts = config.ruleFsts;
+      if (config.ruleFars != null) map.ruleFars = config.ruleFars;
+      return SherpaOnnx.setSttConfig(instanceId, map);
+    },
+    async destroy() {
+      if (destroyed) return;
+      destroyed = true;
+      await SherpaOnnx.unloadStt(instanceId);
+    }
+  };
+  return engine;
 }
 
-/**
- * Release STT resources.
- */
-export function unloadSTT() {
-  return SherpaOnnx.unloadSherpaOnnx();
-}
+// Export types and runtime type list
 
-// Export types
+export { STT_MODEL_TYPES, STT_HOTWORDS_MODEL_TYPES, sttSupportsHotwords } from "./types.js";
+export { getWhisperLanguages, WHISPER_LANGUAGES, getSenseVoiceLanguages, SENSEVOICE_LANGUAGES, getCanaryLanguages, CANARY_LANGUAGES, getFunasrNanoLanguages, FUNASR_NANO_LANGUAGES, getFunasrMltNanoLanguages, FUNASR_MLT_NANO_LANGUAGES } from "./sttModelLanguages.js";
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"names":["SherpaOnnx","resolveModelPath","initializeSTT","options","modelPath","preferInt8","modelType","undefined","resolvedPath","initializeSherpaOnnx","transcribeFile","filePath","unloadSTT","unloadSherpaOnnx"],"sourceRoot":"..\\..\\..\\src","sources":["stt/index.ts"],"mappings":";;AAAA,OAAOA,UAAU,MAAM,wBAAqB;AAG5C,SAASC,gBAAgB,QAAQ,aAAU;;AAE3C;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;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,aAAaA,CACjCC,OAA8D,EAI7D;EACD;EACA,IAAIC,SAAyC;EAC7C,IAAIC,UAA+B;EACnC,IAAIC,SAA6B;EAEjC,IAAI,OAAOH,OAAO,KAAK,QAAQ,IAAI,WAAW,IAAIA,OAAO,EAAE;IACzDC,SAAS,GAAGD,OAAO,CAACC,SAAS;IAC7BC,UAAU,GAAGF,OAAO,CAACE,UAAU;IAC/BC,SAAS,GAAGH,OAAO,CAACG,SAAS;EAC/B,CAAC,MAAM;IACLF,SAAS,GAAGD,OAAyC;IACrDE,UAAU,GAAGE,SAAS;IACtBD,SAAS,GAAGC,SAAS;EACvB;EAEA,MAAMC,YAAY,GAAG,MAAMP,gBAAgB,CAACG,SAAS,CAAC;EACtD,OAAOJ,UAAU,CAACS,oBAAoB,CAACD,YAAY,EAAEH,UAAU,EAAEC,SAAS,CAAC;AAC7E;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,cAAcA,CAACC,QAAgB,EAAmB;EAChE,OAAOX,UAAU,CAACU,cAAc,CAACC,QAAQ,CAAC;AAC5C;;AAEA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAAA,EAAkB;EACzC,OAAOZ,UAAU,CAACa,gBAAgB,CAAC,CAAC;AACtC;;AAEA","ignoreList":[]}
+{"version":3,"names":["SherpaOnnx","resolveModelPath","sttInstanceCounter","normalizeSttResult","raw","text","tokens","Array","isArray","timestamps","lang","emotion","event","durations","detectSttModel","modelPath","options","resolvedPath","preferInt8","modelType","createSTT","instanceId","hotwordsFile","hotwordsScore","numThreads","provider","ruleFsts","ruleFars","dither","modelOptions","modelingUnit","bpeVocab","undefined","debug","result","initializeStt","success","Error","JSON","stringify","detectedModels","destroyed","guard","engine","transcribeFile","filePath","transcribeSamples","samples","sampleRate","setConfig","config","map","decodingMethod","maxActivePaths","blankPenalty","setSttConfig","destroy","unloadStt","STT_MODEL_TYPES","STT_HOTWORDS_MODEL_TYPES","sttSupportsHotwords","getWhisperLanguages","WHISPER_LANGUAGES","getSenseVoiceLanguages","SENSEVOICE_LANGUAGES","getCanaryLanguages","CANARY_LANGUAGES","getFunasrNanoLanguages","FUNASR_NANO_LANGUAGES","getFunasrMltNanoLanguages","FUNASR_MLT_NANO_LANGUAGES"],"sourceRoot":"../../../src","sources":["stt/index.ts"],"mappings":";;AAAA,OAAOA,UAAU,MAAM,wBAAqB;AAU5C,SAASC,gBAAgB,QAAQ,aAAU;AAE3C,IAAIC,kBAAkB,GAAG,CAAC;AAE1B,SAASC,kBAAkBA,CAACC,GAQ3B,EAAwB;EACvB,OAAO;IACLC,IAAI,EAAE,OAAOD,GAAG,CAACC,IAAI,KAAK,QAAQ,GAAGD,GAAG,CAACC,IAAI,GAAG,EAAE;IAClDC,MAAM,EAAEC,KAAK,CAACC,OAAO,CAACJ,GAAG,CAACE,MAAM,CAAC,GAAIF,GAAG,CAACE,MAAM,GAAgB,EAAE;IACjEG,UAAU,EAAEF,KAAK,CAACC,OAAO,CAACJ,GAAG,CAACK,UAAU,CAAC,GACpCL,GAAG,CAACK,UAAU,GACf,EAAE;IACNC,IAAI,EAAE,OAAON,GAAG,CAACM,IAAI,KAAK,QAAQ,GAAGN,GAAG,CAACM,IAAI,GAAG,EAAE;IAClDC,OAAO,EAAE,OAAOP,GAAG,CAACO,OAAO,KAAK,QAAQ,GAAGP,GAAG,CAACO,OAAO,GAAG,EAAE;IAC3DC,KAAK,EAAE,OAAOR,GAAG,CAACQ,KAAK,KAAK,QAAQ,GAAGR,GAAG,CAACQ,KAAK,GAAG,EAAE;IACrDC,SAAS,EAAEN,KAAK,CAACC,OAAO,CAACJ,GAAG,CAACS,SAAS,CAAC,GAAIT,GAAG,CAACS,SAAS,GAAgB;EAC1E,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,cAAcA,CAClCC,SAA0B,EAC1BC,OAA4D,EAK3D;EACD,MAAMC,YAAY,GAAG,MAAMhB,gBAAgB,CAACc,SAAS,CAAC;EACtD,OAAOf,UAAU,CAACc,cAAc,CAC9BG,YAAY,EACZD,OAAO,EAAEE,UAAU,EACnBF,OAAO,EAAEG,SACX,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,SAASA,CAC7BJ,OAA+C,EAC3B;EACpB,MAAMK,UAAU,GAAG,OAAO,EAAEnB,kBAAkB,EAAE;EAEhD,IAAIa,SAA0B;EAC9B,IAAIG,UAA+B;EACnC,IAAIC,SAAmC;EACvC,IAAIG,YAAgC;EACpC,IAAIC,aAAiC;EACrC,IAAIC,UAA8B;EAClC,IAAIC,QAA4B;EAChC,IAAIC,QAA4B;EAChC,IAAIC,QAA4B;EAChC,IAAIC,MAA0B;EAC9B,IAAIC,YAAyC;EAC7C,IAAIC,YAAgC;EACpC,IAAIC,QAA4B;EAEhC,IAAI,WAAW,IAAIf,OAAO,EAAE;IAC1BD,SAAS,GAAGC,OAAO,CAACD,SAAS;IAC7BG,UAAU,GAAGF,OAAO,CAACE,UAAU;IAC/BC,SAAS,GAAGH,OAAO,CAACG,SAAS;IAC7BG,YAAY,GAAGN,OAAO,CAACM,YAAY;IACnCC,aAAa,GAAGP,OAAO,CAACO,aAAa;IACrCC,UAAU,GAAGR,OAAO,CAACQ,UAAU;IAC/BC,QAAQ,GAAGT,OAAO,CAACS,QAAQ;IAC3BC,QAAQ,GAAGV,OAAO,CAACU,QAAQ;IAC3BC,QAAQ,GAAGX,OAAO,CAACW,QAAQ;IAC3BC,MAAM,GAAGZ,OAAO,CAACY,MAAM;IACvBC,YAAY,GAAGb,OAAO,CAACa,YAAY;IACnCC,YAAY,GAAGd,OAAO,CAACc,YAAY;IACnCC,QAAQ,GAAGf,OAAO,CAACe,QAAQ;EAC7B,CAAC,MAAM;IACLhB,SAAS,GAAGC,OAAO;IACnBE,UAAU,GAAGc,SAAS;IACtBb,SAAS,GAAGa,SAAS;IACrBV,YAAY,GAAGU,SAAS;IACxBT,aAAa,GAAGS,SAAS;IACzBR,UAAU,GAAGQ,SAAS;IACtBP,QAAQ,GAAGO,SAAS;IACpBN,QAAQ,GAAGM,SAAS;IACpBL,QAAQ,GAAGK,SAAS;IACpBJ,MAAM,GAAGI,SAAS;IAClBH,YAAY,GAAGG,SAAS;IACxBF,YAAY,GAAGE,SAAS;IACxBD,QAAQ,GAAGC,SAAS;EACtB;EAEA,MAAMC,KAAK,GAAG,WAAW,IAAIjB,OAAO,GAAGA,OAAO,CAACiB,KAAK,GAAGD,SAAS;EAChE,MAAMf,YAAY,GAAG,MAAMhB,gBAAgB,CAACc,SAAS,CAAC;EAEtD,MAAMmB,MAAM,GAAG,MAAMlC,UAAU,CAACmC,aAAa,CAC3Cd,UAAU,EACVJ,YAAY,EACZC,UAAU,EACVC,SAAS,EACTc,KAAK,EACLX,YAAY,EACZC,aAAa,EACbC,UAAU,EACVC,QAAQ,EACRC,QAAQ,EACRC,QAAQ,EACRC,MAAM,EACNC,YAAY,EACZC,YAAY,EACZC,QACF,CAAC;EAED,IAAI,CAACG,MAAM,CAACE,OAAO,EAAE;IACnB,MAAM,IAAIC,KAAK,CACb,8BAA8BC,IAAI,CAACC,SAAS,CAC1CL,MAAM,CAACM,cAAc,IAAI,EAC3B,CAAC,EACH,CAAC;EACH;EAEA,IAAIC,SAAS,GAAG,KAAK;EAErB,MAAMC,KAAK,GAAGA,CAAA,KAAM;IAClB,IAAID,SAAS,EAAE;MACb,MAAM,IAAIJ,KAAK,CACb,gBAAgBhB,UAAU,iDAC5B,CAAC;IACH;EACF,CAAC;EAED,MAAMsB,MAAiB,GAAG;IACxB,IAAItB,UAAUA,CAAA,EAAG;MACf,OAAOA,UAAU;IACnB,CAAC;IAED,MAAMuB,cAAcA,CAACC,QAAgB,EAAiC;MACpEH,KAAK,CAAC,CAAC;MACP,MAAMtC,GAAG,GAAG,MAAMJ,UAAU,CAAC4C,cAAc,CAACvB,UAAU,EAAEwB,QAAQ,CAAC;MACjE,OAAO1C,kBAAkB,CAACC,GAAG,CAAC;IAChC,CAAC;IAED,MAAM0C,iBAAiBA,CACrBC,OAAiB,EACjBC,UAAkB,EACa;MAC/BN,KAAK,CAAC,CAAC;MACP,MAAMtC,GAAG,GAAG,MAAMJ,UAAU,CAAC8C,iBAAiB,CAC5CzB,UAAU,EACV0B,OAAO,EACPC,UACF,CAAC;MACD,OAAO7C,kBAAkB,CAACC,GAAG,CAAC;IAChC,CAAC;IAED,MAAM6C,SAASA,CAACC,MAAwB,EAAiB;MACvDR,KAAK,CAAC,CAAC;MACP,MAAMS,GAAoC,GAAG,CAAC,CAAC;MAC/C,IAAID,MAAM,CAACE,cAAc,IAAI,IAAI,EAC/BD,GAAG,CAACC,cAAc,GAAGF,MAAM,CAACE,cAAc;MAC5C,IAAIF,MAAM,CAACG,cAAc,IAAI,IAAI,EAC/BF,GAAG,CAACE,cAAc,GAAGH,MAAM,CAACG,cAAc;MAC5C,IAAIH,MAAM,CAAC5B,YAAY,IAAI,IAAI,EAAE6B,GAAG,CAAC7B,YAAY,GAAG4B,MAAM,CAAC5B,YAAY;MACvE,IAAI4B,MAAM,CAAC3B,aAAa,IAAI,IAAI,EAC9B4B,GAAG,CAAC5B,aAAa,GAAG2B,MAAM,CAAC3B,aAAa;MAC1C,IAAI2B,MAAM,CAACI,YAAY,IAAI,IAAI,EAAEH,GAAG,CAACG,YAAY,GAAGJ,MAAM,CAACI,YAAY;MACvE,IAAIJ,MAAM,CAACxB,QAAQ,IAAI,IAAI,EAAEyB,GAAG,CAACzB,QAAQ,GAAGwB,MAAM,CAACxB,QAAQ;MAC3D,IAAIwB,MAAM,CAACvB,QAAQ,IAAI,IAAI,EAAEwB,GAAG,CAACxB,QAAQ,GAAGuB,MAAM,CAACvB,QAAQ;MAC3D,OAAO3B,UAAU,CAACuD,YAAY,CAAClC,UAAU,EAAE8B,GAAG,CAAC;IACjD,CAAC;IAED,MAAMK,OAAOA,CAAA,EAAkB;MAC7B,IAAIf,SAAS,EAAE;MACfA,SAAS,GAAG,IAAI;MAChB,MAAMzC,UAAU,CAACyD,SAAS,CAACpC,UAAU,CAAC;IACxC;EACF,CAAC;EAED,OAAOsB,MAAM;AACf;;AAEA;;AAUA,SACEe,eAAe,EACfC,wBAAwB,EACxBC,mBAAmB,QACd,YAAS;AAChB,SACEC,mBAAmB,EACnBC,iBAAiB,EACjBC,sBAAsB,EACtBC,oBAAoB,EACpBC,kBAAkB,EAClBC,gBAAgB,EAChBC,sBAAsB,EACtBC,qBAAqB,EACrBC,yBAAyB,EACzBC,yBAAyB,QACpB,wBAAqB","ignoreList":[]}