Support adding puncutations to text for node-addon-api (#876)

scripts/node-addon-api/CMakeLists.txt

@@ -21,6 +21,7 @@ set(srcs
   src/audio-tagging.cc
   src/non-streaming-asr.cc
   src/non-streaming-tts.cc
+  src/punctuation.cc
   src/sherpa-onnx-node-addon-api.cc
   src/speaker-identification.cc
   src/spoken-language-identification.cc

scripts/node-addon-api/lib/punctuation.js

@@ -0,0 +1,15 @@
+const addon = require('./addon.js');
+
+class Punctuation {
+  constructor(config) {
+    this.handle = addon.createOfflinePunctuation(config);
+    this.config = config;
+  }
+  addPunct(text) {
+    return addon.offlinePunctuationAddPunct(this.handle, text);
+  }
+}
+
+module.exports = {
+  Punctuation,
+}

scripts/node-addon-api/lib/sherpa-onnx.js

@@ -6,6 +6,7 @@ const vad = require('./vad.js');
 const slid = require('./spoken-language-identification.js');
 const sid = require('./speaker-identification.js');
 const at = require('./audio-tagg.js');
+const punct = require('./punctuation.js');
 
 module.exports = {
   OnlineRecognizer: streaming_asr.OnlineRecognizer,
@@ -20,4 +21,5 @@ module.exports = {
   SpeakerEmbeddingExtractor: sid.SpeakerEmbeddingExtractor,
   SpeakerEmbeddingManager: sid.SpeakerEmbeddingManager,
   AudioTagging: at.AudioTagging,
+  Punctuation: punct.Punctuation,
 }

scripts/node-addon-api/src/audio-tagging.cc

@@ -166,7 +166,7 @@ static Napi::Object AudioTaggingComputeWrapper(const Napi::CallbackInfo &info) {
 
   if (!info[1].IsExternal()) {
     Napi::TypeError::New(
-        env, "You should pass a offline stream pointer as the second argument")
+        env, "You should pass an offline stream pointer as the second argument")
         .ThrowAsJavaScriptException();
 
     return {};

scripts/node-addon-api/src/punctuation.cc

@@ -0,0 +1,135 @@
+// scripts/node-addon-api/src/punctuation.cc
+//
+// Copyright (c)  2024  Xiaomi Corporation
+#include <sstream>
+
+#include "macros.h"  // NOLINT
+#include "napi.h"    // NOLINT
+#include "sherpa-onnx/c-api/c-api.h"
+
+static SherpaOnnxOfflinePunctuationModelConfig GetOfflinePunctuationModelConfig(
+    Napi::Object obj) {
+  SherpaOnnxOfflinePunctuationModelConfig c;
+  memset(&c, 0, sizeof(c));
+
+  if (!obj.Has("model") || !obj.Get("model").IsObject()) {
+    return c;
+  }
+
+  Napi::Object o = obj.Get("model").As<Napi::Object>();
+
+  SHERPA_ONNX_ASSIGN_ATTR_STR(ct_transformer, ctTransformer);
+
+  SHERPA_ONNX_ASSIGN_ATTR_INT32(num_threads, numThreads);
+
+  if (o.Has("debug") &&
+      (o.Get("debug").IsNumber() || o.Get("debug").IsBoolean())) {
+    if (o.Get("debug").IsBoolean()) {
+      c.debug = o.Get("debug").As<Napi::Boolean>().Value();
+    } else {
+      c.debug = o.Get("debug").As<Napi::Number>().Int32Value();
+    }
+  }
+  SHERPA_ONNX_ASSIGN_ATTR_STR(provider, provider);
+
+  return c;
+}
+
+static Napi::External<SherpaOnnxOfflinePunctuation>
+CreateOfflinePunctuationWrapper(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  if (info.Length() != 1) {
+    std::ostringstream os;
+    os << "Expect only 1 argument. Given: " << info.Length();
+
+    Napi::TypeError::New(env, os.str()).ThrowAsJavaScriptException();
+
+    return {};
+  }
+
+  if (!info[0].IsObject()) {
+    Napi::TypeError::New(env, "You should pass an object as the only argument.")
+        .ThrowAsJavaScriptException();
+
+    return {};
+  }
+
+  Napi::Object o = info[0].As<Napi::Object>();
+
+  SherpaOnnxOfflinePunctuationConfig c;
+  memset(&c, 0, sizeof(c));
+  c.model = GetOfflinePunctuationModelConfig(o);
+
+  const SherpaOnnxOfflinePunctuation *punct =
+      SherpaOnnxCreateOfflinePunctuation(&c);
+
+  if (c.model.ct_transformer) {
+    delete[] c.model.ct_transformer;
+  }
+
+  if (c.model.provider) {
+    delete[] c.model.provider;
+  }
+
+  if (!punct) {
+    Napi::TypeError::New(env, "Please check your config!")
+        .ThrowAsJavaScriptException();
+
+    return {};
+  }
+
+  return Napi::External<SherpaOnnxOfflinePunctuation>::New(
+      env, const_cast<SherpaOnnxOfflinePunctuation *>(punct),
+      [](Napi::Env env, SherpaOnnxOfflinePunctuation *punct) {
+        SherpaOnnxDestroyOfflinePunctuation(punct);
+      });
+}
+
+static Napi::String OfflinePunctuationAddPunctWraper(
+    const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
+  if (info.Length() != 2) {
+    std::ostringstream os;
+    os << "Expect only 2 arguments. Given: " << info.Length();
+
+    Napi::TypeError::New(env, os.str()).ThrowAsJavaScriptException();
+
+    return {};
+  }
+
+  if (!info[0].IsExternal()) {
+    Napi::TypeError::New(
+        env,
+        "You should pass an offline punctuation pointer as the first argument")
+        .ThrowAsJavaScriptException();
+
+    return {};
+  }
+
+  if (!info[1].IsString()) {
+    Napi::TypeError::New(env, "You should pass a string as the second argument")
+        .ThrowAsJavaScriptException();
+
+    return {};
+  }
+
+  SherpaOnnxOfflinePunctuation *punct =
+      info[0].As<Napi::External<SherpaOnnxOfflinePunctuation>>().Data();
+  Napi::String js_text = info[1].As<Napi::String>();
+  std::string text = js_text.Utf8Value();
+
+  const char *punct_text =
+      SherpaOfflinePunctuationAddPunct(punct, text.c_str());
+
+  Napi::String ans = Napi::String::New(env, punct_text);
+  SherpaOfflinePunctuationFreeText(punct_text);
+  return ans;
+}
+
+void InitPunctuation(Napi::Env env, Napi::Object exports) {
+  exports.Set(Napi::String::New(env, "createOfflinePunctuation"),
+              Napi::Function::New(env, CreateOfflinePunctuationWrapper));
+
+  exports.Set(Napi::String::New(env, "offlinePunctuationAddPunct"),
+              Napi::Function::New(env, OfflinePunctuationAddPunctWraper));
+}

scripts/node-addon-api/src/sherpa-onnx-node-addon-api.cc

@@ -21,6 +21,8 @@ void InitSpeakerID(Napi::Env env, Napi::Object exports);
 
 void InitAudioTagging(Napi::Env env, Napi::Object exports);
 
+void InitPunctuation(Napi::Env env, Napi::Object exports);
+
 Napi::Object Init(Napi::Env env, Napi::Object exports) {
   InitStreamingAsr(env, exports);
   InitNonStreamingAsr(env, exports);
@@ -31,6 +33,7 @@ Napi::Object Init(Napi::Env env, Napi::Object exports) {
   InitSpokenLanguageID(env, exports);
   InitSpeakerID(env, exports);
   InitAudioTagging(env, exports);
+  InitPunctuation(env, exports);
 
   return exports;
 }