diff --git a/.github/scripts/test-kws.sh b/.github/scripts/test-kws.sh
new file mode 100755
index 0000000000..710a193fce
--- /dev/null
+++ b/.github/scripts/test-kws.sh
@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+set -e
+
+log() {
+ # This function is from espnet
+ local fname=${BASH_SOURCE[1]##*/}
+ echo -e "$(date '+%Y-%m-%d %H:%M:%S') (${fname}:${BASH_LINENO[0]}:${FUNCNAME[1]}) $*"
+}
+
+echo "EXE is $EXE"
+echo "PATH: $PATH"
+
+which $EXE
+
+log "------------------------------------------------------------"
+log "Run Chinese keyword spotting (Wenetspeech)"
+log "------------------------------------------------------------"
+
+repo_url=https://www.modelscope.cn/pkufool/sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.git
+log "Start testing ${repo_url}"
+repo=sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01
+log "Download pretrained model and test-data from $repo_url"
+
+GIT_LFS_SKIP_SMUDGE=1 git clone $repo_url
+pushd $repo
+git lfs pull --include "*.onnx"
+ls -lh *.onnx
+popd
+
+time $EXE \
+ --tokens=$repo/tokens.txt \
+ --encoder=$repo/encoder-epoch-12-avg-2-chunk-16-left-64.onnx \
+ --decoder=$repo/decoder-epoch-12-avg-2-chunk-16-left-64.onnx \
+ --joiner=$repo/joiner-epoch-12-avg-2-chunk-16-left-64.onnx \
+ --keywords-file=$repo/test_wavs/test_keywords.txt \
+ --max-active-paths=4 \
+ --num-threads=4 \
+ $repo/test_wavs/3.wav $repo/test_wavs/4.wav $repo/test_wavs/5.wav $repo/test_wavs/6.wav
+
+rm -rf $repo
+
+log "------------------------------------------------------------"
+log "Run English keyword spotting (Gigaspeech)"
+log "------------------------------------------------------------"
+
+repo_url=https://www.modelscope.cn/pkufool/sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01.git
+log "Start testing ${repo_url}"
+repo=sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01
+log "Download pretrained model and test-data from $repo_url"
+
+GIT_LFS_SKIP_SMUDGE=1 git clone $repo_url
+pushd $repo
+git lfs pull --include "*.onnx"
+ls -lh *.onnx
+popd
+
+time $EXE \
+ --tokens=$repo/tokens.txt \
+ --encoder=$repo/encoder-epoch-12-avg-2-chunk-16-left-64.onnx \
+ --decoder=$repo/decoder-epoch-12-avg-2-chunk-16-left-64.onnx \
+ --joiner=$repo/joiner-epoch-12-avg-2-chunk-16-left-64.onnx \
+ --keywords-file=$repo/test_wavs/test_keywords.txt \
+ --max-active-paths=4 \
+ --num-threads=4 \
+ $repo/test_wavs/0.wav $repo/test_wavs/1.wav
+
+rm -rf $repo
diff --git a/.github/workflows/apk-kws.yaml b/.github/workflows/apk-kws.yaml
new file mode 100644
index 0000000000..b920e20268
--- /dev/null
+++ b/.github/workflows/apk-kws.yaml
@@ -0,0 +1,67 @@
+name: apk-kws
+
+on:
+ push:
+ branches:
+ - apk-kws
+ tags:
+ - '*'
+
+ workflow_dispatch:
+
+concurrency:
+ group: apk-kws-${{ github.ref }}
+ cancel-in-progress: true
+
+permissions:
+ contents: write
+
+jobs:
+ apk:
+ runs-on: ${{ matrix.os }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [ubuntu-latest]
+
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: ccache
+ uses: hendrikmuhs/ccache-action@v1.2
+ with:
+ key: ${{ matrix.os }}-android
+
+ - name: Display NDK HOME
+ shell: bash
+ run: |
+ echo "ANDROID_NDK_LATEST_HOME: ${ANDROID_NDK_LATEST_HOME}"
+ ls -lh ${ANDROID_NDK_LATEST_HOME}
+
+ - name: build APK
+ shell: bash
+ run: |
+ export CMAKE_CXX_COMPILER_LAUNCHER=ccache
+ export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+ cmake --version
+
+ export ANDROID_NDK=$ANDROID_NDK_LATEST_HOME
+ ./build-kws-apk.sh
+
+ - name: Display APK
+ shell: bash
+ run: |
+ ls -lh ./apks/
+
+ - uses: actions/upload-artifact@v3
+ with:
+ path: ./apks/*.apk
+
+ - name: Release APK
+ uses: svenstaro/upload-release-action@v2
+ with:
+ file_glob: true
+ file: apks/*.apk
+ overwrite: true
diff --git a/.github/workflows/linux.yaml b/.github/workflows/linux.yaml
index 3c1c167501..8c2c6749a7 100644
--- a/.github/workflows/linux.yaml
+++ b/.github/workflows/linux.yaml
@@ -107,6 +107,14 @@ jobs:
name: release-static
path: build/bin/*
+ - name: Test transducer kws
+ shell: bash
+ run: |
+ export PATH=$PWD/build/bin:$PATH
+ export EXE=sherpa-onnx-keyword-spotter
+
+ .github/scripts/test-kws.sh
+
- name: Test online CTC
shell: bash
run: |
diff --git a/.github/workflows/macos.yaml b/.github/workflows/macos.yaml
index b73b0a5043..7c3b9940ab 100644
--- a/.github/workflows/macos.yaml
+++ b/.github/workflows/macos.yaml
@@ -98,6 +98,14 @@ jobs:
otool -L build/bin/sherpa-onnx
otool -l build/bin/sherpa-onnx
+ - name: Test transducer kws
+ shell: bash
+ run: |
+ export PATH=$PWD/build/bin:$PATH
+ export EXE=sherpa-onnx-keyword-spotter
+
+ .github/scripts/test-kws.sh
+
- name: Test online CTC
shell: bash
run: |
@@ -106,7 +114,6 @@ jobs:
.github/scripts/test-online-ctc.sh
-
- name: Test offline TTS
shell: bash
run: |
diff --git a/.github/workflows/run-python-test.yaml b/.github/workflows/run-python-test.yaml
index 351c38ebff..be59076f6f 100644
--- a/.github/workflows/run-python-test.yaml
+++ b/.github/workflows/run-python-test.yaml
@@ -62,7 +62,7 @@ jobs:
- name: Install Python dependencies
shell: bash
run: |
- python3 -m pip install --upgrade pip numpy sentencepiece==0.1.96 soundfile
+ python3 -m pip install --upgrade pip numpy pypinyin sentencepiece==0.1.96 soundfile
- name: Install sherpa-onnx
shell: bash
diff --git a/.github/workflows/test-python-offline-websocket-server.yaml b/.github/workflows/test-python-offline-websocket-server.yaml
index a8415ea072..58e36e5db3 100644
--- a/.github/workflows/test-python-offline-websocket-server.yaml
+++ b/.github/workflows/test-python-offline-websocket-server.yaml
@@ -45,7 +45,7 @@ jobs:
- name: Install Python dependencies
shell: bash
run: |
- python3 -m pip install --upgrade pip numpy sentencepiece
+ python3 -m pip install --upgrade pip numpy pypinyin sentencepiece
- name: Install sherpa-onnx
shell: bash
diff --git a/.github/workflows/test-python-online-websocket-server.yaml b/.github/workflows/test-python-online-websocket-server.yaml
index e32366990d..60fbbdf8dc 100644
--- a/.github/workflows/test-python-online-websocket-server.yaml
+++ b/.github/workflows/test-python-online-websocket-server.yaml
@@ -45,7 +45,7 @@ jobs:
- name: Install Python dependencies
shell: bash
run: |
- python3 -m pip install --upgrade pip numpy sentencepiece
+ python3 -m pip install --upgrade pip numpy pypinyin sentencepiece
- name: Install sherpa-onnx
shell: bash
diff --git a/android/SherpaOnnxKws/.gitignore b/android/SherpaOnnxKws/.gitignore
new file mode 100644
index 0000000000..aa724b7707
--- /dev/null
+++ b/android/SherpaOnnxKws/.gitignore
@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
diff --git a/android/SherpaOnnxKws/app/.gitignore b/android/SherpaOnnxKws/app/.gitignore
new file mode 100644
index 0000000000..42afabfd2a
--- /dev/null
+++ b/android/SherpaOnnxKws/app/.gitignore
@@ -0,0 +1 @@
+/build
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/build.gradle b/android/SherpaOnnxKws/app/build.gradle
new file mode 100644
index 0000000000..d64be8079c
--- /dev/null
+++ b/android/SherpaOnnxKws/app/build.gradle
@@ -0,0 +1,44 @@
+plugins {
+ id 'com.android.application'
+ id 'org.jetbrains.kotlin.android'
+}
+
+android {
+ namespace 'com.k2fsa.sherpa.onnx'
+ compileSdk 32
+
+ defaultConfig {
+ applicationId "com.k2fsa.sherpa.onnx"
+ minSdk 21
+ targetSdk 32
+ versionCode 1
+ versionName "1.0"
+
+ testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+ }
+
+ buildTypes {
+ release {
+ minifyEnabled false
+ proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+ }
+ }
+ compileOptions {
+ sourceCompatibility JavaVersion.VERSION_1_8
+ targetCompatibility JavaVersion.VERSION_1_8
+ }
+ kotlinOptions {
+ jvmTarget = '1.8'
+ }
+}
+
+dependencies {
+
+ implementation 'androidx.core:core-ktx:1.7.0'
+ implementation 'androidx.appcompat:appcompat:1.5.1'
+ implementation 'com.google.android.material:material:1.7.0'
+ implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
+ testImplementation 'junit:junit:4.13.2'
+ androidTestImplementation 'androidx.test.ext:junit:1.1.4'
+ androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.0'
+}
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/proguard-rules.pro b/android/SherpaOnnxKws/app/proguard-rules.pro
new file mode 100644
index 0000000000..481bb43481
--- /dev/null
+++ b/android/SherpaOnnxKws/app/proguard-rules.pro
@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+# http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+# public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/androidTest/java/com/k2fsa/sherpa/onnx/ExampleInstrumentedTest.kt b/android/SherpaOnnxKws/app/src/androidTest/java/com/k2fsa/sherpa/onnx/ExampleInstrumentedTest.kt
new file mode 100644
index 0000000000..1833832023
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/androidTest/java/com/k2fsa/sherpa/onnx/ExampleInstrumentedTest.kt
@@ -0,0 +1,24 @@
+package com.k2fsa.sherpa.onnx
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+ @Test
+ fun useAppContext() {
+ // Context of the app under test.
+ val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+ assertEquals("com.k2fsa.sherpa.onnx", appContext.packageName)
+ }
+}
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/AndroidManifest.xml b/android/SherpaOnnxKws/app/src/main/AndroidManifest.xml
new file mode 100644
index 0000000000..935fb0e958
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/AndroidManifest.xml
@@ -0,0 +1,32 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/android/SherpaOnnxKws/app/src/main/assets/.gitkeep b/android/SherpaOnnxKws/app/src/main/assets/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/MainActivity.kt b/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/MainActivity.kt
new file mode 100644
index 0000000000..83c8abe311
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/MainActivity.kt
@@ -0,0 +1,207 @@
+package com.k2fsa.sherpa.onnx
+
+import android.Manifest
+import android.content.pm.PackageManager
+import android.media.AudioFormat
+import android.media.AudioRecord
+import android.media.MediaRecorder
+import android.os.Bundle
+import android.text.method.ScrollingMovementMethod
+import android.util.Log
+import android.widget.Button
+import android.widget.EditText
+import android.widget.TextView
+import android.widget.Toast
+import androidx.appcompat.app.AppCompatActivity
+import androidx.core.app.ActivityCompat
+import com.k2fsa.sherpa.onnx.*
+import kotlin.concurrent.thread
+
+private const val TAG = "sherpa-onnx"
+private const val REQUEST_RECORD_AUDIO_PERMISSION = 200
+
+class MainActivity : AppCompatActivity() {
+ private val permissions: Array = arrayOf(Manifest.permission.RECORD_AUDIO)
+
+ private lateinit var model: SherpaOnnxKws
+ private var audioRecord: AudioRecord? = null
+ private lateinit var recordButton: Button
+ private lateinit var textView: TextView
+ private lateinit var inputText: EditText
+ private var recordingThread: Thread? = null
+
+ private val audioSource = MediaRecorder.AudioSource.MIC
+ private val sampleRateInHz = 16000
+ private val channelConfig = AudioFormat.CHANNEL_IN_MONO
+
+ // Note: We don't use AudioFormat.ENCODING_PCM_FLOAT
+ // since the AudioRecord.read(float[]) needs API level >= 23
+ // but we are targeting API level >= 21
+ private val audioFormat = AudioFormat.ENCODING_PCM_16BIT
+ private var idx: Int = 0
+ private var lastText: String = ""
+
+ @Volatile
+ private var isRecording: Boolean = false
+
+ override fun onRequestPermissionsResult(
+ requestCode: Int, permissions: Array, grantResults: IntArray
+ ) {
+ super.onRequestPermissionsResult(requestCode, permissions, grantResults)
+ val permissionToRecordAccepted = if (requestCode == REQUEST_RECORD_AUDIO_PERMISSION) {
+ grantResults[0] == PackageManager.PERMISSION_GRANTED
+ } else {
+ false
+ }
+
+ if (!permissionToRecordAccepted) {
+ Log.e(TAG, "Audio record is disallowed")
+ finish()
+ }
+
+ Log.i(TAG, "Audio record is permitted")
+ }
+
+ override fun onCreate(savedInstanceState: Bundle?) {
+ super.onCreate(savedInstanceState)
+ setContentView(R.layout.activity_main)
+
+ ActivityCompat.requestPermissions(this, permissions, REQUEST_RECORD_AUDIO_PERMISSION)
+
+ Log.i(TAG, "Start to initialize model")
+ initModel()
+ Log.i(TAG, "Finished initializing model")
+
+ recordButton = findViewById(R.id.record_button)
+ recordButton.setOnClickListener { onclick() }
+
+ textView = findViewById(R.id.my_text)
+ textView.movementMethod = ScrollingMovementMethod()
+
+ inputText = findViewById(R.id.input_text)
+ }
+
+ private fun onclick() {
+ if (!isRecording) {
+ var keywords = inputText.text.toString()
+
+ Log.i(TAG, keywords)
+ keywords = keywords.replace("\n", "/")
+ // If keywords is an empty string, it just resets the decoding stream
+ // always returns true in this case.
+ // If keywords is not empty, it will create a new decoding stream with
+ // the given keywords appended to the default keywords.
+ // Return false if errors occured when adding keywords, true otherwise.
+ val status = model.reset(keywords)
+ if (!status) {
+ Log.i(TAG, "Failed to reset with keywords.")
+ Toast.makeText(this, "Failed to set keywords.", Toast.LENGTH_LONG).show();
+ return
+ }
+
+ val ret = initMicrophone()
+ if (!ret) {
+ Log.e(TAG, "Failed to initialize microphone")
+ return
+ }
+ Log.i(TAG, "state: ${audioRecord?.state}")
+ audioRecord!!.startRecording()
+ recordButton.setText(R.string.stop)
+ isRecording = true
+ textView.text = ""
+ lastText = ""
+ idx = 0
+
+ recordingThread = thread(true) {
+ processSamples()
+ }
+ Log.i(TAG, "Started recording")
+ } else {
+ isRecording = false
+ audioRecord!!.stop()
+ audioRecord!!.release()
+ audioRecord = null
+ recordButton.setText(R.string.start)
+ Log.i(TAG, "Stopped recording")
+ }
+ }
+
+ private fun processSamples() {
+ Log.i(TAG, "processing samples")
+
+ val interval = 0.1 // i.e., 100 ms
+ val bufferSize = (interval * sampleRateInHz).toInt() // in samples
+ val buffer = ShortArray(bufferSize)
+
+ while (isRecording) {
+ val ret = audioRecord?.read(buffer, 0, buffer.size)
+ if (ret != null && ret > 0) {
+ val samples = FloatArray(ret) { buffer[it] / 32768.0f }
+ model.acceptWaveform(samples, sampleRate=sampleRateInHz)
+ while (model.isReady()) {
+ model.decode()
+ }
+
+ val text = model.keyword
+
+ var textToDisplay = lastText;
+
+ if(text.isNotBlank()) {
+ if (lastText.isBlank()) {
+ textToDisplay = "${idx}: ${text}"
+ } else {
+ textToDisplay = "${idx}: ${text}\n${lastText}"
+ }
+ lastText = "${idx}: ${text}\n${lastText}"
+ idx += 1
+ }
+
+ runOnUiThread {
+ textView.text = textToDisplay
+ }
+ }
+ }
+ }
+
+ private fun initMicrophone(): Boolean {
+ if (ActivityCompat.checkSelfPermission(
+ this, Manifest.permission.RECORD_AUDIO
+ ) != PackageManager.PERMISSION_GRANTED
+ ) {
+ ActivityCompat.requestPermissions(this, permissions, REQUEST_RECORD_AUDIO_PERMISSION)
+ return false
+ }
+
+ val numBytes = AudioRecord.getMinBufferSize(sampleRateInHz, channelConfig, audioFormat)
+ Log.i(
+ TAG, "buffer size in milliseconds: ${numBytes * 1000.0f / sampleRateInHz}"
+ )
+
+ audioRecord = AudioRecord(
+ audioSource,
+ sampleRateInHz,
+ channelConfig,
+ audioFormat,
+ numBytes * 2 // a sample has two bytes as we are using 16-bit PCM
+ )
+ return true
+ }
+
+ private fun initModel() {
+ // Please change getModelConfig() to add new models
+ // See https://k2-fsa.github.io/sherpa/onnx/kws/pretrained_models/index.html
+ // for a list of available models
+ val type = 0
+ Log.i(TAG, "Select model type ${type}")
+ val config = KeywordSpotterConfig(
+ featConfig = getFeatureConfig(sampleRate = sampleRateInHz, featureDim = 80),
+ modelConfig = getModelConfig(type = type)!!,
+ keywordsFile = getKeywordsFile(type = type)!!,
+ )
+
+ model = SherpaOnnxKws(
+ assetManager = application.assets,
+ config = config,
+ )
+ }
+}
diff --git a/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/SherpaOnnx.kt b/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/SherpaOnnx.kt
new file mode 100644
index 0000000000..d40692665a
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/SherpaOnnx.kt
@@ -0,0 +1,162 @@
+// Copyright (c) 2024 Xiaomi Corporation
+package com.k2fsa.sherpa.onnx
+
+import android.content.res.AssetManager
+
+data class OnlineTransducerModelConfig(
+ var encoder: String = "",
+ var decoder: String = "",
+ var joiner: String = "",
+)
+
+data class OnlineModelConfig(
+ var transducer: OnlineTransducerModelConfig = OnlineTransducerModelConfig(),
+ var tokens: String,
+ var numThreads: Int = 1,
+ var debug: Boolean = false,
+ var provider: String = "cpu",
+ var modelType: String = "",
+)
+
+data class FeatureConfig(
+ var sampleRate: Int = 16000,
+ var featureDim: Int = 80,
+)
+
+data class KeywordSpotterConfig(
+ var featConfig: FeatureConfig = FeatureConfig(),
+ var modelConfig: OnlineModelConfig,
+ var maxActivePaths: Int = 4,
+ var keywordsFile: String = "keywords.txt",
+ var keywordsScore: Float = 1.5f,
+ var keywordsThreshold: Float = 0.25f,
+ var numTrailingBlanks: Int = 2,
+)
+
+class SherpaOnnxKws(
+ assetManager: AssetManager? = null,
+ var config: KeywordSpotterConfig,
+) {
+ private val ptr: Long
+
+ init {
+ if (assetManager != null) {
+ ptr = new(assetManager, config)
+ } else {
+ ptr = newFromFile(config)
+ }
+ }
+
+ protected fun finalize() {
+ delete(ptr)
+ }
+
+ fun acceptWaveform(samples: FloatArray, sampleRate: Int) =
+ acceptWaveform(ptr, samples, sampleRate)
+
+ fun inputFinished() = inputFinished(ptr)
+ fun decode() = decode(ptr)
+ fun isReady(): Boolean = isReady(ptr)
+ fun reset(keywords: String): Boolean = reset(ptr, keywords)
+
+ val keyword: String
+ get() = getKeyword(ptr)
+
+ private external fun delete(ptr: Long)
+
+ private external fun new(
+ assetManager: AssetManager,
+ config: KeywordSpotterConfig,
+ ): Long
+
+ private external fun newFromFile(
+ config: KeywordSpotterConfig,
+ ): Long
+
+ private external fun acceptWaveform(ptr: Long, samples: FloatArray, sampleRate: Int)
+ private external fun inputFinished(ptr: Long)
+ private external fun getKeyword(ptr: Long): String
+ private external fun reset(ptr: Long, keywords: String): Boolean
+ private external fun decode(ptr: Long)
+ private external fun isReady(ptr: Long): Boolean
+
+ companion object {
+ init {
+ System.loadLibrary("sherpa-onnx-jni")
+ }
+ }
+}
+
+fun getFeatureConfig(sampleRate: Int, featureDim: Int): FeatureConfig {
+ return FeatureConfig(sampleRate = sampleRate, featureDim = featureDim)
+}
+
+/*
+Please see
+https://k2-fsa.github.io/sherpa/onnx/kws/pretrained_models/index.html
+for a list of pre-trained models.
+
+We only add a few here. Please change the following code
+to add your own. (It should be straightforward to add a new model
+by following the code)
+
+@param type
+0 - sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01 (Chinese)
+ https://www.modelscope.cn/models/pkufool/sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01/summary
+
+1 - sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01 (English)
+ https://www.modelscope.cn/models/pkufool/sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01/summary
+
+ */
+fun getModelConfig(type: Int): OnlineModelConfig? {
+ when (type) {
+ 0 -> {
+ val modelDir = "sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01"
+ return OnlineModelConfig(
+ transducer = OnlineTransducerModelConfig(
+ encoder = "$modelDir/encoder-epoch-12-avg-2-chunk-16-left-64.onnx",
+ decoder = "$modelDir/decoder-epoch-12-avg-2-chunk-16-left-64.onnx",
+ joiner = "$modelDir/joiner-epoch-12-avg-2-chunk-16-left-64.onnx",
+ ),
+ tokens = "$modelDir/tokens.txt",
+ modelType = "zipformer2",
+ )
+ }
+
+ 1 -> {
+ val modelDir = "sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01"
+ return OnlineModelConfig(
+ transducer = OnlineTransducerModelConfig(
+ encoder = "$modelDir/encoder-epoch-12-avg-2-chunk-16-left-64.onnx",
+ decoder = "$modelDir/decoder-epoch-12-avg-2-chunk-16-left-64.onnx",
+ joiner = "$modelDir/joiner-epoch-12-avg-2-chunk-16-left-64.onnx",
+ ),
+ tokens = "$modelDir/tokens.txt",
+ modelType = "zipformer2",
+ )
+ }
+
+ }
+ return null;
+}
+
+/*
+ * Get the default keywords for each model.
+ * Caution: The types and modelDir should be the same as those in getModelConfig
+ * function above.
+ */
+fun getKeywordsFile(type: Int) : String {
+ when (type) {
+ 0 -> {
+ val modelDir = "sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01"
+ return "$modelDir/keywords.txt"
+ }
+
+ 1 -> {
+ val modelDir = "sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01"
+ return "$modelDir/keywords.txt"
+ }
+
+ }
+ return "";
+}
diff --git a/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/WaveReader.kt b/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/WaveReader.kt
new file mode 100644
index 0000000000..dca3998404
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx/WaveReader.kt
@@ -0,0 +1,29 @@
+// Copyright (c) 2023 Xiaomi Corporation
+package com.k2fsa.sherpa.onnx
+
+import android.content.res.AssetManager
+
+class WaveReader {
+ companion object {
+ // Read a mono wave file asset
+ // The returned array has two entries:
+ // - the first entry contains an 1-D float array
+ // - the second entry is the sample rate
+ external fun readWaveFromAsset(
+ assetManager: AssetManager,
+ filename: String,
+ ): Array
+
+ // Read a mono wave file from disk
+ // The returned array has two entries:
+ // - the first entry contains an 1-D float array
+ // - the second entry is the sample rate
+ external fun readWaveFromFile(
+ filename: String,
+ ): Array
+
+ init {
+ System.loadLibrary("sherpa-onnx-jni")
+ }
+ }
+}
diff --git a/android/SherpaOnnxKws/app/src/main/jniLibs/.gitignore b/android/SherpaOnnxKws/app/src/main/jniLibs/.gitignore
new file mode 100644
index 0000000000..949c039f10
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/jniLibs/.gitignore
@@ -0,0 +1,4 @@
+*.so
+*.txt
+*.onnx
+*.wav
diff --git a/android/SherpaOnnxKws/app/src/main/jniLibs/arm64-v8a/.gitkeep b/android/SherpaOnnxKws/app/src/main/jniLibs/arm64-v8a/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/android/SherpaOnnxKws/app/src/main/jniLibs/armeabi-v7a/.gitkeep b/android/SherpaOnnxKws/app/src/main/jniLibs/armeabi-v7a/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/android/SherpaOnnxKws/app/src/main/jniLibs/x86/.gitkeep b/android/SherpaOnnxKws/app/src/main/jniLibs/x86/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/android/SherpaOnnxKws/app/src/main/jniLibs/x86_64/.gitkeep b/android/SherpaOnnxKws/app/src/main/jniLibs/x86_64/.gitkeep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/android/SherpaOnnxKws/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/android/SherpaOnnxKws/app/src/main/res/drawable-v24/ic_launcher_foreground.xml
new file mode 100644
index 0000000000..2b068d1146
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/drawable-v24/ic_launcher_foreground.xml
@@ -0,0 +1,30 @@
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/drawable/ic_launcher_background.xml b/android/SherpaOnnxKws/app/src/main/res/drawable/ic_launcher_background.xml
new file mode 100644
index 0000000000..07d5da9cbf
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/drawable/ic_launcher_background.xml
@@ -0,0 +1,170 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/android/SherpaOnnxKws/app/src/main/res/layout/activity_main.xml b/android/SherpaOnnxKws/app/src/main/res/layout/activity_main.xml
new file mode 100644
index 0000000000..fe5442809b
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/layout/activity_main.xml
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/android/SherpaOnnxKws/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml
new file mode 100644
index 0000000000..eca70cfe52
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml
@@ -0,0 +1,5 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/android/SherpaOnnxKws/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml
new file mode 100644
index 0000000000..eca70cfe52
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml
@@ -0,0 +1,5 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-hdpi/ic_launcher.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-hdpi/ic_launcher.webp
new file mode 100644
index 0000000000..c209e78ecd
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-hdpi/ic_launcher.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp
new file mode 100644
index 0000000000..b2dfe3d1ba
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-mdpi/ic_launcher.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-mdpi/ic_launcher.webp
new file mode 100644
index 0000000000..4f0f1d64e5
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-mdpi/ic_launcher.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp
new file mode 100644
index 0000000000..62b611da08
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-xhdpi/ic_launcher.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-xhdpi/ic_launcher.webp
new file mode 100644
index 0000000000..948a3070fe
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-xhdpi/ic_launcher.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp
new file mode 100644
index 0000000000..1b9a6956b3
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp
new file mode 100644
index 0000000000..28d4b77f9f
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp
new file mode 100644
index 0000000000..9287f50836
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp
new file mode 100644
index 0000000000..aa7d6427e6
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp
new file mode 100644
index 0000000000..9126ae37cb
Binary files /dev/null and b/android/SherpaOnnxKws/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp differ
diff --git a/android/SherpaOnnxKws/app/src/main/res/values-night/themes.xml b/android/SherpaOnnxKws/app/src/main/res/values-night/themes.xml
new file mode 100644
index 0000000000..7fc53e53e4
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/values-night/themes.xml
@@ -0,0 +1,16 @@
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/values/colors.xml b/android/SherpaOnnxKws/app/src/main/res/values/colors.xml
new file mode 100644
index 0000000000..f8c6127d32
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/values/colors.xml
@@ -0,0 +1,10 @@
+
+
+ #FFBB86FC
+ #FF6200EE
+ #FF3700B3
+ #FF03DAC5
+ #FF018786
+ #FF000000
+ #FFFFFFFF
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/values/strings.xml b/android/SherpaOnnxKws/app/src/main/res/values/strings.xml
new file mode 100644
index 0000000000..1fba032f9e
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/values/strings.xml
@@ -0,0 +1,12 @@
+
+ KWS with Next-gen Kaldi
+ Click the Start button to play keyword spotting with Next-gen Kaldi.
+ \n
+ \n\n\n
+ The source code and pre-trained models are publicly available.
+ Please see https://github.com/k2-fsa/sherpa-onnx for details.
+
+ Input your keywords here, one keyword perline.
+ Start
+ Stop
+
diff --git a/android/SherpaOnnxKws/app/src/main/res/values/themes.xml b/android/SherpaOnnxKws/app/src/main/res/values/themes.xml
new file mode 100644
index 0000000000..b573f87485
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/values/themes.xml
@@ -0,0 +1,16 @@
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/xml/backup_rules.xml b/android/SherpaOnnxKws/app/src/main/res/xml/backup_rules.xml
new file mode 100644
index 0000000000..fa0f996d2c
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/xml/backup_rules.xml
@@ -0,0 +1,13 @@
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/main/res/xml/data_extraction_rules.xml b/android/SherpaOnnxKws/app/src/main/res/xml/data_extraction_rules.xml
new file mode 100644
index 0000000000..9ee9997b0b
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/main/res/xml/data_extraction_rules.xml
@@ -0,0 +1,19 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/app/src/test/java/com/k2fsa/sherpa/onnx/ExampleUnitTest.kt b/android/SherpaOnnxKws/app/src/test/java/com/k2fsa/sherpa/onnx/ExampleUnitTest.kt
new file mode 100644
index 0000000000..05dfcd635f
--- /dev/null
+++ b/android/SherpaOnnxKws/app/src/test/java/com/k2fsa/sherpa/onnx/ExampleUnitTest.kt
@@ -0,0 +1,17 @@
+package com.k2fsa.sherpa.onnx
+
+import org.junit.Test
+
+import org.junit.Assert.*
+
+/**
+ * Example local unit test, which will execute on the development machine (host).
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+class ExampleUnitTest {
+ @Test
+ fun addition_isCorrect() {
+ assertEquals(4, 2 + 2)
+ }
+}
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/build.gradle b/android/SherpaOnnxKws/build.gradle
new file mode 100644
index 0000000000..2536974232
--- /dev/null
+++ b/android/SherpaOnnxKws/build.gradle
@@ -0,0 +1,6 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+plugins {
+ id 'com.android.application' version '7.3.1' apply false
+ id 'com.android.library' version '7.3.1' apply false
+ id 'org.jetbrains.kotlin.android' version '1.7.20' apply false
+}
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/gradle.properties b/android/SherpaOnnxKws/gradle.properties
new file mode 100644
index 0000000000..3c5031eb7d
--- /dev/null
+++ b/android/SherpaOnnxKws/gradle.properties
@@ -0,0 +1,23 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+# Kotlin code style for this project: "official" or "obsolete":
+kotlin.code.style=official
+# Enables namespacing of each library's R class so that its R class includes only the
+# resources declared in the library itself and none from the library's dependencies,
+# thereby reducing the size of the R class for that library
+android.nonTransitiveRClass=true
\ No newline at end of file
diff --git a/android/SherpaOnnxKws/gradle/wrapper/gradle-wrapper.jar b/android/SherpaOnnxKws/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 0000000000..e708b1c023
Binary files /dev/null and b/android/SherpaOnnxKws/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/android/SherpaOnnxKws/gradle/wrapper/gradle-wrapper.properties b/android/SherpaOnnxKws/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 0000000000..7bc67b5bfe
--- /dev/null
+++ b/android/SherpaOnnxKws/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,6 @@
+#Thu Feb 23 11:09:06 CST 2023
+distributionBase=GRADLE_USER_HOME
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
diff --git a/android/SherpaOnnxKws/gradlew b/android/SherpaOnnxKws/gradlew
new file mode 100755
index 0000000000..4f906e0c81
--- /dev/null
+++ b/android/SherpaOnnxKws/gradlew
@@ -0,0 +1,185 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+## Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+ ls=`ls -ld "$PRG"`
+ link=`expr "$ls" : '.*-> \(.*\)$'`
+ if expr "$link" : '/.*' > /dev/null; then
+ PRG="$link"
+ else
+ PRG=`dirname "$PRG"`"/$link"
+ fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+ echo "$*"
+}
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+ CYGWIN* )
+ cygwin=true
+ ;;
+ Darwin* )
+ darwin=true
+ ;;
+ MINGW* )
+ msys=true
+ ;;
+ NONSTOP* )
+ nonstop=true
+ ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD="$JAVA_HOME/jre/sh/java"
+ else
+ JAVACMD="$JAVA_HOME/bin/java"
+ fi
+ if [ ! -x "$JAVACMD" ] ; then
+ die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+else
+ JAVACMD="java"
+ which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+ MAX_FD_LIMIT=`ulimit -H -n`
+ if [ $? -eq 0 ] ; then
+ if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+ MAX_FD="$MAX_FD_LIMIT"
+ fi
+ ulimit -n $MAX_FD
+ if [ $? -ne 0 ] ; then
+ warn "Could not set maximum file descriptor limit: $MAX_FD"
+ fi
+ else
+ warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+ fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+ GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+ APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+ CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
+ JAVACMD=`cygpath --unix "$JAVACMD"`
+
+ # We build the pattern for arguments to be converted via cygpath
+ ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+ SEP=""
+ for dir in $ROOTDIRSRAW ; do
+ ROOTDIRS="$ROOTDIRS$SEP$dir"
+ SEP="|"
+ done
+ OURCYGPATTERN="(^($ROOTDIRS))"
+ # Add a user-defined pattern to the cygpath arguments
+ if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+ OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+ fi
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ i=0
+ for arg in "$@" ; do
+ CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+ CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
+
+ if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
+ eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+ else
+ eval `echo args$i`="\"$arg\""
+ fi
+ i=`expr $i + 1`
+ done
+ case $i in
+ 0) set -- ;;
+ 1) set -- "$args0" ;;
+ 2) set -- "$args0" "$args1" ;;
+ 3) set -- "$args0" "$args1" "$args2" ;;
+ 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+ 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+ 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+ 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+ 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+ 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+ esac
+fi
+
+# Escape application args
+save () {
+ for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+ echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"
diff --git a/android/SherpaOnnxKws/gradlew.bat b/android/SherpaOnnxKws/gradlew.bat
new file mode 100644
index 0000000000..ac1b06f938
--- /dev/null
+++ b/android/SherpaOnnxKws/gradlew.bat
@@ -0,0 +1,89 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/android/SherpaOnnxKws/settings.gradle b/android/SherpaOnnxKws/settings.gradle
new file mode 100644
index 0000000000..59443eb2e5
--- /dev/null
+++ b/android/SherpaOnnxKws/settings.gradle
@@ -0,0 +1,16 @@
+pluginManagement {
+ repositories {
+ gradlePluginPortal()
+ google()
+ mavenCentral()
+ }
+}
+dependencyResolutionManagement {
+ repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+ repositories {
+ google()
+ mavenCentral()
+ }
+}
+rootProject.name = "SherpaOnnxKws"
+include ':app'
diff --git a/build-kws-apk.sh b/build-kws-apk.sh
new file mode 100755
index 0000000000..cf85cf6c36
--- /dev/null
+++ b/build-kws-apk.sh
@@ -0,0 +1,139 @@
+#!/usr/bin/env bash
+
+# Please set the environment variable ANDROID_NDK
+# before running this script
+
+# Inside the $ANDROID_NDK directory, you can find a binary ndk-build
+# and some other files like the file "build/cmake/android.toolchain.cmake"
+
+set -e
+
+log() {
+ # This function is from espnet
+ local fname=${BASH_SOURCE[1]##*/}
+ echo -e "$(date '+%Y-%m-%d %H:%M:%S') (${fname}:${BASH_LINENO[0]}:${FUNCNAME[1]}) $*"
+}
+
+SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
+
+log "Building keyword spotting APK for sherpa-onnx v${SHERPA_ONNX_VERSION}"
+
+log "====================arm64-v8a================="
+./build-android-arm64-v8a.sh
+log "====================armv7-eabi================"
+./build-android-armv7-eabi.sh
+log "====================x86-64===================="
+./build-android-x86-64.sh
+log "====================x86===================="
+./build-android-x86.sh
+
+mkdir -p apks
+
+# Download the model
+repo=sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01
+
+if [ ! -d ./android/SherpaOnnxKws/app/src/main/assets/$repo ]; then
+ repo_url=https://www.modelscope.cn/pkufool/sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.git
+ log "Start testing ${repo_url}"
+ log "Download pretrained model and test-data from $repo_url"
+ GIT_LFS_SKIP_SMUDGE=1 git clone $repo_url
+ pushd $repo
+ git lfs pull --include "*.onnx"
+
+ # remove .git to save spaces
+ rm -rf .git
+ rm *.int8.onnx
+ rm README.md configuration.json .gitattributes
+ rm -rfv test_wavs
+ ls -lh
+ popd
+
+ mv -v $repo ./android/SherpaOnnxKws/app/src/main/assets/
+fi
+
+tree ./android/SherpaOnnxKws/app/src/main/assets/
+
+for arch in arm64-v8a armeabi-v7a x86_64 x86; do
+ log "------------------------------------------------------------"
+ log "build apk for $arch"
+ log "------------------------------------------------------------"
+ src_arch=$arch
+ if [ $arch == "armeabi-v7a" ]; then
+ src_arch=armv7-eabi
+ elif [ $arch == "x86_64" ]; then
+ src_arch=x86-64
+ fi
+
+ ls -lh ./build-android-$src_arch/install/lib/*.so
+
+ cp -v ./build-android-$src_arch/install/lib/*.so ./android/SherpaOnnxKws/app/src/main/jniLibs/$arch/
+
+ pushd ./android/SherpaOnnxKws
+ ./gradlew build
+ popd
+
+ mv android/SherpaOnnxKws/app/build/outputs/apk/debug/app-debug.apk ./apks/sherpa-onnx-kws-wenetspeech-zh-${SHERPA_ONNX_VERSION}-$arch.apk
+ ls -lh apks
+ rm -v ./android/SherpaOnnxKws/app/src/main/jniLibs/$arch/*.so
+done
+
+git checkout .
+
+rm -rf ./android/SherpaOnnxKws/app/src/main/assets/$repo
+
+# English model
+repo=sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01
+
+if [ ! -d ./android/SherpaOnnxKws/app/src/main/assets/$repo ]; then
+ repo_url=https://www.modelscope.cn/pkufool/sherpa-onnx-kws-zipformer-gigaspeech-3.3M-2024-01-01.git
+ log "Start testing ${repo_url}"
+ log "Download pretrained model and test-data from $repo_url"
+ GIT_LFS_SKIP_SMUDGE=1 git clone $repo_url
+ pushd $repo
+ git lfs pull --include "*.onnx"
+
+ # remove .git to save spaces
+ rm -rf .git
+ rm *.int8.onnx
+ rm README.md configuration.json .gitattributes
+ rm -rfv test_wavs
+ ls -lh
+ popd
+
+ mv -v $repo ./android/SherpaOnnxKws/app/src/main/assets/
+fi
+
+tree ./android/SherpaOnnxKws/app/src/main/assets/
+
+pushd android/SherpaOnnxKws/app/src/main/java/com/k2fsa/sherpa/onnx
+sed -i.bak s/"type = 0"/"type = 1"/ ./MainActivity.kt
+git diff
+popd
+
+for arch in arm64-v8a armeabi-v7a x86_64 x86; do
+ log "------------------------------------------------------------"
+ log "build apk for $arch"
+ log "------------------------------------------------------------"
+ src_arch=$arch
+ if [ $arch == "armeabi-v7a" ]; then
+ src_arch=armv7-eabi
+ elif [ $arch == "x86_64" ]; then
+ src_arch=x86-64
+ fi
+
+ ls -lh ./build-android-$src_arch/install/lib/*.so
+
+ cp -v ./build-android-$src_arch/install/lib/*.so ./android/SherpaOnnxKws/app/src/main/jniLibs/$arch/
+
+ pushd ./android/SherpaOnnxKws
+ ./gradlew build
+ popd
+
+ mv android/SherpaOnnxKws/app/build/outputs/apk/debug/app-debug.apk ./apks/sherpa-onnx-kws-gigaspeech-en-${SHERPA_ONNX_VERSION}-$arch.apk
+ ls -lh apks
+ rm -v ./android/SherpaOnnxKws/app/src/main/jniLibs/$arch/*.so
+done
+
+git checkout .
+
+rm -rf ./android/SherpaOnnxKws/app/src/main/assets/$repo
diff --git a/cmake/cmake_extension.py b/cmake/cmake_extension.py
index c081cfe422..e62706e614 100644
--- a/cmake/cmake_extension.py
+++ b/cmake/cmake_extension.py
@@ -151,6 +151,7 @@ def build_extension(self, ext: setuptools.extension.Extension):
# Remember to also change setup.py
binaries = ["sherpa-onnx"]
+ binaries += ["sherpa-onnx-keyword-spotter"]
binaries += ["sherpa-onnx-offline"]
binaries += ["sherpa-onnx-microphone"]
binaries += ["sherpa-onnx-microphone-offline"]
diff --git a/scripts/text2token.py b/scripts/text2token.py
index 6ba3795f21..71026d9821 100755
--- a/scripts/text2token.py
+++ b/scripts/text2token.py
@@ -36,13 +36,44 @@
from sherpa_onnx import text2token
+
def get_args():
parser = argparse.ArgumentParser()
parser.add_argument(
"--text",
type=str,
required=True,
- help="Path to the input texts",
+ help="""Path to the input texts.
+
+ Each line in the texts contains the original phrase, it might also contain some
+ extra items, for example, the boosting score (startting with :), the triggering
+ threshold (startting with #, only used in keyword spotting task) and the original
+ phrase (startting with @). Note: extra items will be kept in the output.
+
+ example input 1 (tokens_type = ppinyin):
+
+ 小爱同学 :2.0 #0.6 @小爱同学
+ 你好问问 :3.5 @你好问问
+ 小艺小艺 #0.6 @小艺小艺
+
+ example output 1:
+
+ x iǎo ài t óng x ué :2.0 #0.6 @小爱同学
+ n ǐ h ǎo w èn w èn :3.5 @你好问问
+ x iǎo y ì x iǎo y ì #0.6 @小艺小艺
+
+ example input 2 (tokens_type = bpe):
+
+ HELLO WORLD :1.5 #0.4
+ HI GOOGLE :2.0 #0.8
+ HEY SIRI #0.35
+
+ example output 2:
+
+ ▁HE LL O ▁WORLD :1.5 #0.4
+ ▁HI ▁GO O G LE :2.0 #0.8
+ ▁HE Y ▁S I RI #0.35
+ """,
)
parser.add_argument(
@@ -56,7 +87,11 @@ def get_args():
"--tokens-type",
type=str,
required=True,
- help="The type of modeling units, should be cjkchar, bpe or cjkchar+bpe",
+ choices=["cjkchar", "bpe", "cjkchar+bpe", "fpinyin", "ppinyin"],
+ help="""The type of modeling units, should be cjkchar, bpe, cjkchar+bpe, fpinyin or ppinyin.
+ fpinyin means full pinyin, each cjkchar has a pinyin(with tone).
+ ppinyin means partial pinyin, it splits pinyin into initial and final,
+ """,
)
parser.add_argument(
@@ -79,9 +114,21 @@ def main():
args = get_args()
texts = []
+ # extra information like boosting score (start with :), triggering threshold (start with #)
+ # original keyword (start with @)
+ extra_info = []
with open(args.text, "r", encoding="utf8") as f:
for line in f:
- texts.append(line.strip())
+ extra = []
+ text = []
+ toks = line.strip().split()
+ for tok in toks:
+ if tok[0] == ":" or tok[0] == "#" or tok[0] == "@":
+ extra.append(tok)
+ else:
+ text.append(tok)
+ texts.append(" ".join(text))
+ extra_info.append(extra)
encoded_texts = text2token(
texts,
tokens=args.tokens,
@@ -89,7 +136,8 @@ def main():
bpe_model=args.bpe_model,
)
with open(args.output, "w", encoding="utf8") as f:
- for txt in encoded_texts:
+ for i, txt in enumerate(encoded_texts):
+ txt += extra_info[i]
f.write(" ".join(txt) + "\n")
diff --git a/setup.py b/setup.py
index 3757c617dd..fc2f567704 100644
--- a/setup.py
+++ b/setup.py
@@ -51,6 +51,7 @@ def get_binaries_to_install():
# Remember to also change cmake/cmake_extension.py
binaries = ["sherpa-onnx"]
+ binaries += ["sherpa-onnx-keyword-spotter"]
binaries += ["sherpa-onnx-offline"]
binaries += ["sherpa-onnx-microphone"]
binaries += ["sherpa-onnx-microphone-offline"]
diff --git a/sherpa-onnx/csrc/CMakeLists.txt b/sherpa-onnx/csrc/CMakeLists.txt
index c889f8cee1..033174d933 100644
--- a/sherpa-onnx/csrc/CMakeLists.txt
+++ b/sherpa-onnx/csrc/CMakeLists.txt
@@ -19,6 +19,8 @@ set(sources
features.cc
file-utils.cc
hypothesis.cc
+ keyword-spotter-impl.cc
+ keyword-spotter.cc
offline-ctc-fst-decoder-config.cc
offline-ctc-fst-decoder.cc
offline-ctc-greedy-search-decoder.cc
@@ -87,6 +89,7 @@ set(sources
stack.cc
symbol-table.cc
text-utils.cc
+ transducer-keyword-decoder.cc
transpose.cc
unbind.cc
utils.cc
@@ -173,12 +176,14 @@ if(NOT BUILD_SHARED_LIBS AND CMAKE_SYSTEM_NAME STREQUAL Linux)
endif()
add_executable(sherpa-onnx sherpa-onnx.cc)
+add_executable(sherpa-onnx-keyword-spotter sherpa-onnx-keyword-spotter.cc)
add_executable(sherpa-onnx-offline sherpa-onnx-offline.cc)
add_executable(sherpa-onnx-offline-parallel sherpa-onnx-offline-parallel.cc)
add_executable(sherpa-onnx-offline-tts sherpa-onnx-offline-tts.cc)
set(main_exes
sherpa-onnx
+ sherpa-onnx-keyword-spotter
sherpa-onnx-offline
sherpa-onnx-offline-parallel
sherpa-onnx-offline-tts
diff --git a/sherpa-onnx/csrc/context-graph-test.cc b/sherpa-onnx/csrc/context-graph-test.cc
index 6ad7a5c734..5c45b69e49 100644
--- a/sherpa-onnx/csrc/context-graph-test.cc
+++ b/sherpa-onnx/csrc/context-graph-test.cc
@@ -5,6 +5,7 @@
#include "sherpa-onnx/csrc/context-graph.h"
#include // NOLINT
+#include
#include