xuning / sherpaonnx

转到一个项目
Toggle navigation Toggle navigation pinning
Fangjun Kuang
Committed by GitHub
4f758e6c 1 parent 2f9553d8

Publish node-addon-api wrapper for sherpa-onnx as npm packages (#829)

内嵌 并排对比
正在显示 27 个修改的文件 包含 773 行增加 和 15 行删除
# Introduction
Please see [sherpa-onnx-node](https://www.npmjs.com/package/sherpa-onnx-node)
... ...
# Introduction
Please see
https://github.com/k2-fsa/sherpa-onnx/blob/master/nodejs-addon-examples/README.md
for usages.
||Method|Support multiple threads|Minimum required node version|
|---|---|---|---|
|this package| https://github.com/nodejs/node-addon-api | Yes | v10|
|https://www.npmjs.com/package/sherpa-onnx| WebAssembly | No | v18|
... ...
module.exports = require('./sherpa-onnx.node');
... ...
# Introduction
See also
- https://github.com/WonderInventions/node-webrtc/blob/develop/package.json
- https://stackoverflow.com/questions/15176082/npm-package-json-os-specific-dependency
- https://github.com/WonderInventions/node-webrtc/blob/develop/lib/binding.js
- cross-compiling https://github.com/nodejs/node-gyp/issues/829#issuecomment-665527032
... ...
{
"name": "sherpa-onnx-PLATFORM-ARCH",
"version": "SHERPA_ONNX_VERSION",
"description": "Speech-to-text and text-to-speech using Next-gen Kaldi without internet connection",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/k2-fsa/sherpa-onnx.git"
},
"keywords": [
"speech to text",
"text to speech",
"transcription",
"real-time speech recognition",
"without internet connection",
"embedded systems",
"open source",
"zipformer",
"asr",
"tts",
"stt",
"c++",
"onnxruntime",
"onnx",
"ai",
"next-gen kaldi",
"offline",
"privacy",
"open source",
"vad",
"speaker id",
"language id",
"node-addon-api",
"streaming speech recognition",
"speech",
"recognition"
],
"author": "The next-gen Kaldi team",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/k2-fsa/sherpa-onnx/issues"
},
"homepage": "https://github.com/k2-fsa/sherpa-onnx#readme",
"os": [
"PLATFORM"
],
"cpu": [
"ARCH"
]
}
... ...
{
"name": "sherpa-onnx-node",
"version": "SHERPA_ONNX_VERSION",
"description": "Speech-to-text and text-to-speech using Next-gen Kaldi without internet connection",
"main": "sherpa-onnx.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/k2-fsa/sherpa-onnx.git"
},
"keywords": [
"speech to text",
"text to speech",
"transcription",
"real-time speech recognition",
"without internet connection",
"embedded systems",
"open source",
"zipformer",
"asr",
"tts",
"stt",
"c++",
"onnxruntime",
"onnx",
"ai",
"next-gen kaldi",
"offline",
"privacy",
"open source",
"vad",
"speaker id",
"language id",
"node-addon-api",
"streaming speech recognition",
"speech",
"recognition"
],
"author": "The next-gen Kaldi team",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/k2-fsa/sherpa-onnx/issues"
},
"homepage": "https://github.com/k2-fsa/sherpa-onnx#readme",
"optionalDependencies": {
"sherpa-onnx-darwin-arm64": "^SHERPA_ONNX_VERSION",
"sherpa-onnx-darwin-x64": "^SHERPA_ONNX_VERSION",
"sherpa-onnx-linux-x64": "^SHERPA_ONNX_VERSION"
}
}
... ...
#!/usr/bin/env bash
sherpa_onnx_dir=$PWD
echo "sherpa_onnx_dir: $sherpa_onnx_dir"
src_dir=$sherpa_onnx_dir/.github/scripts/node-addon
platform=$(node -p "require('os').platform()")
arch=$(node -p "require('os').arch()")
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
echo "SHERPA_ONNX_VERSION $SHERPA_ONNX_VERSION"
if [ -z $owner ]; then
owner=k2-fsa
fi
sed -i.bak s/SHERPA_ONNX_VERSION/$SHERPA_ONNX_VERSION/g $src_dir/package-optional.json
sed -i.bak s/k2-fsa/$owner/g $src_dir/package-optional.json
sed -i.bak s/PLATFORM/$platform/g $src_dir/package-optional.json
sed -i.bak s/ARCH/$arch/g $src_dir/package-optional.json
git diff $src_dir/package-optional.json
dst=$sherpa_onnx_dir/sherpa-onnx-node
mkdir -p $dst
cp $src_dir/package-optional.json $dst/package.json
cp $src_dir/index.js $dst/
cp $src_dir/README-optional.md $dst/README.md
cp -fv build/install/lib/lib* $dst/ || true
cp -fv build/install/lib/*dll $dst/ || true
cp scripts/node-addon-api/build/Release/sherpa-onnx.node $dst/
ls $dst
... ...
#!/usr/bin/env bash
set -ex
d=nodejs-addon-examples
echo "dir: $d"
cd $d
npm install --verbose
git status
ls -lh
ls -lh node_modules
export DYLD_LIBRARY_PATH=$PWD/node_modules/sherpa-onnx-darwin-x64:$DYLD_LIBRARY_PATH
export DYLD_LIBRARY_PATH=$PWD/node_modules/sherpa-onnx-darwin-arm64:$DYLD_LIBRARY_PATH
export LD_LIBRARY_PATH=$PWD/node_modules/sherpa-onnx-linux-x64:$LD_LIBRARY_PATH
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
tar xvf sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
rm sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
node test_asr_streaming_transducer.js
rm -rf sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20
... ...
name: npm-addon-linux-x64
on:
workflow_dispatch:
concurrency:
group: npm-addon-linux-x64-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
id-token: write
jobs:
npm-addon-linux-x64:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: ["3.8"]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- uses: actions/setup-node@v4
with:
registry-url: 'https://registry.npmjs.org'
- name: Display node version
shell: bash
run: |
node --version
- name: Build sherpa-onnx
uses: addnab/docker-run-action@v3
with:
image: quay.io/pypa/manylinux2014_x86_64
options: |
--volume ${{ github.workspace }}/:/shared/
shell: bash
run: |
uname -a
gcc --version
cmake --version
cd /shared
mkdir build
cd build
cmake \
-DCMAKE_INSTALL_PREFIX=./install \
-DBUILD_SHARED_LIBS=ON \
-DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
-DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
-DSHERPA_ONNX_ENABLE_BINARY=OFF \
..
make -j install
- name: Build sherpa-onnx node-addon
shell: bash
run: |
export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
sudo mkdir /shared
sudo ln -s $PWD/build /shared/
ls -lh /shared/build
pkg-config --cflags sherpa-onnx
pkg-config --libs sherpa-onnx
cd scripts/node-addon-api/
npm i
./node_modules/.bin/node-gyp configure build --verbose
- name: Prepare for publish
shell: bash
run: |
export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
owner=${{ github.repository_owner }}
export owner
echo "---"
ls -lh build/install/lib/
sudo chown -R runner ./build
echo "---"
ls -lh build/install/lib/
echo "---"
# find build/install/lib/ -maxdepth 1 -type l
# find build/install/lib/ -maxdepth 1 -type l -delete
#
# echo "---"
# ls -lh build/install/lib/
.github/scripts/node-addon/run.sh
- name: Display files to be published
shell: bash
run: |
ls -lh ./sherpa-onnx-node
- name: Publish
shell: bash
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd ./sherpa-onnx-node
npm install
npm ci
# see https://docs.npmjs.com/generating-provenance-statements
npm publish --provenance --access public
... ...
name: npm-addon-macos
on:
workflow_dispatch:
concurrency:
group: npm-addon-macos-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
id-token: write
jobs:
npm-addon-macos:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [macos-11, macos-14]
python-version: ["3.8"]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- uses: actions/setup-node@v4
with:
registry-url: 'https://registry.npmjs.org'
- name: Display node version
shell: bash
run: |
node --version
- name: ccache
uses: hendrikmuhs/ccache-action@v1.2
with:
key: ${{ matrix.os }}-release-shared
- name: Build sherpa-onnx
shell: bash
run: |
export CMAKE_CXX_COMPILER_LAUNCHER=ccache
export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
mkdir build
cd build
cmake \
-DCMAKE_INSTALL_PREFIX=./install \
-DBUILD_SHARED_LIBS=ON \
-DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
-DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
-DSHERPA_ONNX_ENABLE_BINARY=OFF \
..
make -j install
- name: Build sherpa-onnx node-addon
shell: bash
run: |
export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
pkg-config --cflags sherpa-onnx
pkg-config --libs sherpa-onnx
cd scripts/node-addon-api/
npm i
./node_modules/.bin/node-gyp configure build --verbose
- name: Prepare for publish
shell: bash
run: |
export PKG_CONFIG_PATH=$PWD/build/install:$PKG_CONFIG_PATH
owner=${{ github.repository_owner }}
export owner
ls -lh build/install/lib/
echo "---"
# find build/install/lib/ -maxdepth 1 -type l
# find build/install/lib/ -maxdepth 1 -type l -delete
# echo "---"
# ls -lh build/install/lib/
.github/scripts/node-addon/run.sh
- name: Display files to be published
shell: bash
run: |
ls -lh ./sherpa-onnx-node
- name: Publish
shell: bash
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd ./sherpa-onnx-node
npm install
npm ci
# see https://docs.npmjs.com/generating-provenance-statements
npm publish --provenance --access public
... ...
name: npm-addon
on:
workflow_dispatch:
concurrency:
group: npm-addon-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
id-token: write
jobs:
npm-addon:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: ["3.8"]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- uses: actions/setup-node@v4
with:
registry-url: 'https://registry.npmjs.org'
- name: Display node version
shell: bash
run: |
node --version
- name: ccache
uses: hendrikmuhs/ccache-action@v1.2
with:
key: ${{ matrix.os }}-release-shared
- name: Prepare for publish
shell: bash
run: |
owner=${{ github.repository_owner }}
export owner
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
echo "SHERPA_ONNX_VERSION $SHERPA_ONNX_VERSION"
src_dir=.github/scripts/node-addon
sed -i.bak s/SHERPA_ONNX_VERSION/$SHERPA_ONNX_VERSION/g $src_dir/package.json
sed -i.bak s/k2-fsa/$owner/g $src_dir/package.json
dst=sherpa-onnx-node
mkdir $dst
cp $src_dir/package.json $dst/
cp $src_dir/README.md $dst/
cp scripts/node-addon-api/lib/*.js $dst/
- name: Display files to be published
shell: bash
run: |
ls -lh ./sherpa-onnx-node
- name: Publish
shell: bash
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd ./sherpa-onnx-node
npm install
npm ci
# see https://docs.npmjs.com/generating-provenance-statements
npm publish --provenance --access public
... ...
... ... @@ -5,7 +5,7 @@ on:
branches:
- master
paths:
- '.github/workflows/test-node-addon-api.yaml'
- '.github/workflows/test-nodejs-addon-api.yaml'
- 'CMakeLists.txt'
- 'cmake/**'
- 'sherpa-onnx/csrc/*'
... ... @@ -16,7 +16,7 @@ on:
branches:
- master
paths:
- '.github/workflows/test-node-addon-api.yaml'
- '.github/workflows/test-nodejs-addon-api.yaml'
- 'CMakeLists.txt'
- 'cmake/**'
- 'sherpa-onnx/csrc/*'
... ... @@ -34,12 +34,13 @@ permissions:
jobs:
test-node-addon-api:
name: ${{ matrix.os }}
name: ${{ matrix.os }} ${{ matrix.node-version }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [macos-latest, macos-14]
os: [macos-11, macos-14, ubuntu-20.04, ubuntu-22.04]
node-version: ["16", "17", "18", "19", "21", "22"]
python-version: ["3.8"]
steps:
... ... @@ -55,6 +56,7 @@ jobs:
- uses: actions/setup-node@v4
with:
registry-url: 'https://registry.npmjs.org'
node-version: ${{ matrix.node-version }}
- name: Display node version
shell: bash
... ... @@ -69,9 +71,18 @@ jobs:
- name: Build sherpa-onnx
shell: bash
run: |
export CMAKE_CXX_COMPILER_LAUNCHER=ccache
export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/tmp/sherpa-onnx -DBUILD_SHARED_LIBS=ON ..
cmake \
-DCMAKE_INSTALL_PREFIX=/tmp/sherpa-onnx \
-DBUILD_SHARED_LIBS=ON \
-DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
-DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
-DSHERPA_ONNX_ENABLE_BINARY=OFF \
..
make -j
make install
... ... @@ -87,8 +98,6 @@ jobs:
pkg-config --cflags sherpa-onnx
pkg-config --libs sherpa-onnx
a=$(pkg-config --cflags sherpa-onnx);a=${a:2};echo $a
npm i
./node_modules/.bin/node-gyp configure build --verbose
... ...
name: test-node-addon-npm
on:
push:
branches:
- master
paths:
- '.github/workflows/test-nodejs-addon-npm.yaml'
- 'CMakeLists.txt'
- 'cmake/**'
- 'sherpa-onnx/csrc/*'
- 'sherpa-onnx/c-api/*'
- 'scripts/node-addon-api/**'
- 'scripts/node-addon-api/*.js'
- 'nodejs-addon-examples/package.json'
pull_request:
branches:
- master
paths:
- '.github/workflows/test-nodejs-addon-npm.yaml'
- 'CMakeLists.txt'
- 'cmake/**'
- 'sherpa-onnx/csrc/*'
- 'sherpa-onnx/c-api/*'
- 'scripts/node-addon-api/*.js'
- 'nodejs-addon-examples/package.json'
workflow_dispatch:
concurrency:
group: test-node-addon-npm-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
jobs:
test-node-addon-npm:
name: ${{ matrix.os }} node v${{ matrix.node-version }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [macos-11, macos-14, ubuntu-20.04, ubuntu-22.04]
node-version: ["16", "17", "18", "19", "21", "22"]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
registry-url: 'https://registry.npmjs.org'
node-version: ${{ matrix.node-version }}
- name: Display node version
shell: bash
run: |
node --version
- name: Run tests
shell: bash
run: |
.github/scripts/test-nodejs-addon-npm.sh
... ...
... ... @@ -266,6 +266,7 @@ endif()
add_subdirectory(sherpa-onnx)
if(SHERPA_ONNX_ENABLE_C_API AND SHERPA_ONNX_ENABLE_BINARY)
set(SHERPA_ONNX_PKG_WITH_CARGS "-lcargs")
add_subdirectory(c-api-examples)
endif()
... ...
... ... @@ -13,4 +13,4 @@ Cflags: -I"${includedir}"
# Note: -lcargs is required only for the following file
# https://github.com/k2-fsa/sherpa-onnx/blob/master/c-api-examples/decode-file-c-api.c
# We add it here so that users don't need to specify -lcargs when compiling decode-file-c-api.c
Libs: -L"${libdir}" -lsherpa-onnx-c-api -lsherpa-onnx-core -lkaldi-decoder-core -lsherpa-onnx-kaldifst-core -lsherpa-onnx-fst -lkaldi-native-fbank-core -lcargs -lonnxruntime -Wl,-rpath,${libdir} @SHERPA_ONNX_PKG_CONFIG_EXTRA_LIBS@
Libs: -L"${libdir}" -lsherpa-onnx-c-api -lsherpa-onnx-core -lkaldi-decoder-core -lsherpa-onnx-kaldifst-core -lsherpa-onnx-fst -lkaldi-native-fbank-core -lonnxruntime -Wl,-rpath,${libdir} @SHERPA_ONNX_PKG_WITH_CARGS@ @SHERPA_ONNX_PKG_CONFIG_EXTRA_LIBS@
... ...
... ... @@ -13,4 +13,4 @@ Cflags: -I"${includedir}"
# Note: -lcargs is required only for the following file
# https://github.com/k2-fsa/sherpa-onnx/blob/master/c-api-examples/decode-file-c-api.c
# We add it here so that users don't need to specify -lcargs when compiling decode-file-c-api.c
Libs: -L"${libdir}" -lsherpa-onnx-c-api -lsherpa-onnx-core -lkaldi-decoder-core -lsherpa-onnx-kaldifst-core -lsherpa-onnx-fstfar -lsherpa-onnx-fst -lkaldi-native-fbank-core -lpiper_phonemize -lespeak-ng -lucd -lcargs -lonnxruntime -Wl,-rpath,${libdir} @SHERPA_ONNX_PKG_CONFIG_EXTRA_LIBS@
Libs: -L"${libdir}" -lsherpa-onnx-c-api -lsherpa-onnx-core -lkaldi-decoder-core -lsherpa-onnx-kaldifst-core -lsherpa-onnx-fstfar -lsherpa-onnx-fst -lkaldi-native-fbank-core -lpiper_phonemize -lespeak-ng -lucd -lonnxruntime -Wl,-rpath,${libdir} @SHERPA_ONNX_PKG_WITH_CARGS@ @SHERPA_ONNX_PKG_CONFIG_EXTRA_LIBS@
... ...
# Introduction
Note: You need `Node >= 10`.
This repo contains examples for NodeJS.
It uses [node-addon-api](https://github.com/nodejs/node-addon-api) to wrap
`sherpa-onnx` for NodeJS and it supports multiple threads.
Note: [../nodejs-examples](../nodejs-examples) uses WebAssembly to wrap
`sherpa-onnx` for NodeJS and it does not support multiple threads.
Before you continue, please first run
```bash
npm install
# For macOS x64
export DYLD_LIBRARY_PATH=$PWD/node_modules/sherpa-onnx-darwin-x64:$DYLD_LIBRARY_PATH
# For macOS arm64
export DYLD_LIBRARY_PATH=$PWD/node_modules/sherpa-onnx-darwin-arm64:$DYLD_LIBRARY_PATH
# For Linux x64
export LD_LIBRARY_PATH=$PWD/node_modules/sherpa-onnx-linux-x64:$LD_LIBRARY_PATH
```
## Streaming speech recognition with zipformer transducer
```bash
wget https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
tar xvf sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
rm sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2
```
... ...
{
"dependencies": {
"sherpa-onnx-node": "*",
"perf_hooks": "*"
}
}
... ...
// Copyright (c) 2024 Xiaomi Corporation
const sherpa_onnx = require('sherpa-onnx-node');
const performance = require('perf_hooks').performance;
// Please download test files from
// https://github.com/k2-fsa/sherpa-onnx/releases/tag/asr-models
const config = {
'featConfig': {
'sampleRate': 16000,
'featureDim': 80,
},
'modelConfig': {
'transducer': {
'encoder':
'./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/encoder-epoch-99-avg-1.onnx',
'decoder':
'./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/decoder-epoch-99-avg-1.onnx',
'joiner':
'./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/joiner-epoch-99-avg-1.onnx',
},
'tokens':
'./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/tokens.txt',
'numThreads': 2,
'provider': 'cpu',
'debug': 1,
'modelType': 'zipformer',
}
};
const waveFilename =
'./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/test_wavs/0.wav';
const recognizer = new sherpa_onnx.OnlineRecognizer(config);
console.log('Started')
let start = performance.now();
const stream = recognizer.createStream();
const wave = sherpa_onnx.readWave(waveFilename);
stream.acceptWaveform(wave.samples, wave.sampleRate);
const tailPadding = new Float32Array(wave.sampleRate * 0.4);
stream.acceptWaveform(tailPadding, wave.sampleRate);
while (recognizer.isReady(stream)) {
recognizer.decode(stream);
}
result = recognizer.getResult(stream)
let stop = performance.now();
console.log('Done')
const elapsed_seconds = (stop - start) / 1000;
const duration = wave.samples.length / wave.sampleRate;
const real_time_factor = elapsed_seconds / duration;
console.log('Wave duration', duration.toFixed(3), 'secodns')
console.log('Elapsed', elapsed_seconds.toFixed(3), 'secodns')
console.log('RTF', real_time_factor.toFixed(3))
console.log('result', result.text)
... ...
# Introduction
Note: You need `Node >= 18`.
This directory contains nodejs examples for [sherpa-onnx](https://github.com/k2-fsa/sherpa-onnx).
It uses WebAssembly to wrap `sherpa-onnx` for NodeJS and it does not support multiple threads.
Note: [../nodejs-addon-examples](../nodejs-addon-examples) uses
[node-addon-api](https://github.com/nodejs/node-addon-api) to wrap
`sherpa-onnx` for NodeJS and it supports multiple threads.
Before you continue, please first run
```bash
... ... @@ -13,7 +21,6 @@ npm i
In the following, we describe how to use [sherpa-onnx](https://github.com/k2-fsa/sherpa-onnx)
for text-to-speech and speech-to-text.
Note: You need `Node >= 18`.
# Text-to-speech
... ...
# Introduction
This folder contains `node-addon-api` wrapper for `sherpa-onnx`.
Caution: This folder is for developer only.
## Usage
```bash
git clone https://github.com/k2-fsa/sherpa-onnx
cd sherpa-onnx
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=./install -DBUILD_SHARED_LIBS=ON ..
make -j install
export PKG_CONFIG_PATH=$PWD/install:$PKG_CONFIG_PATH
cd ../scripts/node-addon-api/
./node_modules/.bin/node-gyp build --verbose
# see test/test_asr_streaming_transducer.js
# for usages
```
... ...
{
'targets': [
{
'target_name': 'sherpa-onnx-node-addon-api-native',
'target_name': 'sherpa-onnx',
'sources': [
'src/sherpa-onnx-node-addon-api.cc',
'src/streaming-asr.cc',
... ... @@ -9,7 +9,7 @@
],
'include_dirs': [
"<!@(node -p \"require('node-addon-api').include\")",
"<!@(a=$(pkg-config --cflags sherpa-onnx);echo ${a:2})"
"<!@(pkg-config --variable=includedir sherpa-onnx)"
],
'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
'cflags!': [
... ...
const os = require('os');
const platform_arch = `${os.platform()}-${os.arch()}`;
const possible_paths = [
'../build/Release/sherpa-onnx.node',
'../build/Debug/sherpa-onnx.node',
`./node_modules/sherpa-onnx-${platform_arch}/sherpa-onnx.node`,
`../sherpa-onnx-${platform_arch}/sherpa-onnx.node`,
];
let found = false;
for (const p of possible_paths) {
try {
module.exports = require(p);
found = true;
break;
} catch (error) {
// do nothing; try the next option
;
}
}
if (!found) {
let msg =
`Could not find sherpa-onnx. Tried\n\n ${possible_paths.join('\n ')}\n`
if (os.platform() == 'darwin' && process.env.DYLD_LIBRARY_PATH &&
!process.env.DYLD_LIBRARY_PATH.includes(
`node_modules/sherpa-onnx-${platform_arch}`)) {
msg +=
'Please remeber to set the following environment variable and try again:\n';
msg += `export DYLD_LIBRARY_PATH=${
process.env.PWD}/node_modules/sherpa-onnx-${platform_arch}`;
msg += ':$DYLD_LIBRARY_PATH\n';
}
if (os.platform() == 'linux' && process.env.LD_LIBRARY_PATH &&
!process.env.LD_LIBRARY_PATH.includes(
`node_modules/sherpa-onnx-${platform_arch}`)) {
msg +=
'Please remeber to set the following environment variable and try again:\n';
msg += `export LD_LIBRARY_PATH=${
process.env.PWD}/node_modules/sherpa-onnx-${platform_arch}`;
msg += ':$LD_LIBRARY_PATH\n';
}
throw new Error(msg)
}
... ...
const addon = require('bindings')('sherpa-onnx-node-addon-api-native');
const addon = require('./addon.js')
const streaming_asr = require('./streaming-asr.js');
module.exports = {
... ...
const addon = require('bindings')('sherpa-onnx-node-addon-api-native');
const addon = require('./addon.js');
class OnlineStream {
constructor(handle) {
... ...
... ... @@ -5,7 +5,8 @@
"dependencies": {
"node-addon-api": "^1.1.0",
"bindings": "^1.5.0",
"node-gyp": "^10.1.0"
"perf_hooks": "*",
"node-gyp": "^8.3.0"
},
"scripts": {
"test": "node --napi-modules ./test/test_binding.js"
... ...
// Copyright (c) 2024 Xiaomi Corporation
const sherpa_onnx = require('../lib/sherpa-onnx.js');
const performance = require('perf_hooks').performance;
// Please download test files from
// https://github.com/k2-fsa/sherpa-onnx/releases/tag/asr-models
const config = {
'featConfig': {
'sampleRate': 16000,
... ...