Release Rust package for offline/online speech denoiser (k2-fsa#3328)

csukuangfj · web-flow · commit 33dc6b246e0d · 2026-03-17T12:25:04.000+08:00
diff --git a/android/SherpaOnnxAar/sherpa_onnx/src/main/java/com/k2fsa/sherpa/onnx/DenoisedAudio.kt b/android/SherpaOnnxAar/sherpa_onnx/src/main/java/com/k2fsa/sherpa/onnx/DenoisedAudio.kt
@@ -0,0 +1 @@
+../../../../../../../../../../sherpa-onnx/kotlin-api/DenoisedAudio.kt
diff --git a/dotnet-examples/speech-enhancement-dpdfnet/run.sh b/dotnet-examples/speech-enhancement-dpdfnet/run.sh
diff --git a/dotnet-examples/streaming-speech-enhancement-dpdfnet/run.sh b/dotnet-examples/streaming-speech-enhancement-dpdfnet/run.sh
diff --git a/dotnet-examples/streaming-speech-enhancement-gtcrn/run.sh b/dotnet-examples/streaming-speech-enhancement-gtcrn/run.sh
diff --git a/kotlin-api-examples/DenoisedAudio.kt b/kotlin-api-examples/DenoisedAudio.kt
@@ -0,0 +1 @@
+../sherpa-onnx/kotlin-api/DenoisedAudio.kt
diff --git a/kotlin-api-examples/run.sh b/kotlin-api-examples/run.sh
@@ -471,6 +471,7 @@ function testOfflineSpeechDenoiser() {
   kotlinc-jvm -include-runtime -d $out_filename \
     test_offline_speech_denoiser.kt \
     OfflineSpeechDenoiser.kt \
+    DenoisedAudio.kt \
     WaveReader.kt \
     faked-asset-manager.kt \
     faked-log.kt
@@ -483,6 +484,7 @@ function testOfflineSpeechDenoiser() {
   kotlinc-jvm -include-runtime -d $out_filename \
     test_offline_speech_denoiser_dpdfnet.kt \
     OfflineSpeechDenoiser.kt \
+    DenoisedAudio.kt \
     WaveReader.kt \
     faked-asset-manager.kt \
     faked-log.kt
diff --git a/rust-api-examples/Cargo.lock b/rust-api-examples/Cargo.lock
diff --git a/rust-api-examples/Cargo.toml b/rust-api-examples/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
 name = "rust-api-examples"
-version = "0.1.10"
+version = "0.1.11"
 edition = "2021"
 
 [dependencies]
 anyhow = "1.0"
 clap = { version = "4.5", features = ["derive"] }
-sherpa-onnx = "0.1.10"
+sherpa-onnx = "0.1.11"
 # sherpa-onnx = { path = "../sherpa-onnx/rust/sherpa-onnx" }
 serde_json = "1.0"
 
diff --git a/sherpa-onnx/kotlin-api/DenoisedAudio.kt b/sherpa-onnx/kotlin-api/DenoisedAudio.kt
@@ -0,0 +1,15 @@
+package com.k2fsa.sherpa.onnx
+
+class DenoisedAudio(
+    val samples: FloatArray,
+    val sampleRate: Int,
+) {
+    fun save(filename: String) =
+        saveImpl(filename = filename, samples = samples, sampleRate = sampleRate)
+
+    private external fun saveImpl(
+        filename: String,
+        samples: FloatArray,
+        sampleRate: Int
+    ): Boolean
+}
diff --git a/sherpa-onnx/kotlin-api/OfflineSpeechDenoiser.kt b/sherpa-onnx/kotlin-api/OfflineSpeechDenoiser.kt
@@ -22,20 +22,6 @@ data class OfflineSpeechDenoiserConfig(
     var model: OfflineSpeechDenoiserModelConfig = OfflineSpeechDenoiserModelConfig(),
 )
 
-class DenoisedAudio(
-    val samples: FloatArray,
-    val sampleRate: Int,
-) {
-    fun save(filename: String) =
-        saveImpl(filename = filename, samples = samples, sampleRate = sampleRate)
-
-    private external fun saveImpl(
-        filename: String,
-        samples: FloatArray,
-        sampleRate: Int
-    ): Boolean
-}
-
 class OfflineSpeechDenoiser(
     assetManager: AssetManager? = null,
     config: OfflineSpeechDenoiserConfig,
diff --git a/sherpa-onnx/rust/sherpa-onnx-sys/Cargo.toml b/sherpa-onnx/rust/sherpa-onnx-sys/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sherpa-onnx-sys"
-version = "0.1.10"
+version = "0.1.11"
 edition = "2021"
 description = "Raw FFI bindings to the sherpa-onnx C API"
 license = "Apache-2.0"
diff --git a/sherpa-onnx/rust/sherpa-onnx/Cargo.toml b/sherpa-onnx/rust/sherpa-onnx/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sherpa-onnx"
-version = "0.1.10"
+version = "0.1.11"
 edition = "2021"
 description = "Safe Rust wrapper for sherpa-onnx speech recognition toolkit"
 license = "Apache-2.0"
@@ -20,6 +20,6 @@ include = [
 ]
 
 [dependencies]
-sherpa-onnx-sys = { path = "../sherpa-onnx-sys", version = "0.1.10" }
+sherpa-onnx-sys = { path = "../sherpa-onnx-sys", version = "0.1.11" }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
diff --git a/sherpa-onnx/rust/sherpa-onnx/src/lib.rs b/sherpa-onnx/rust/sherpa-onnx/src/lib.rs
@@ -1,6 +1,8 @@
 mod display;
 mod offline_asr;
+mod offline_speech_denoiser;
 mod online_asr;
+mod online_speech_denoiser;
 mod speech_denoiser;
 mod tts;
 mod utils;
@@ -9,7 +11,9 @@ mod wave;
 
 pub use display::*;
 pub use offline_asr::*;
+pub use offline_speech_denoiser::*;
 pub use online_asr::*;
+pub use online_speech_denoiser::*;
 pub use speech_denoiser::*;
 pub use tts::*;
 pub use utils::*;
diff --git a/sherpa-onnx/rust/sherpa-onnx/src/offline_speech_denoiser.rs b/sherpa-onnx/rust/sherpa-onnx/src/offline_speech_denoiser.rs
@@ -0,0 +1,61 @@
+use crate::speech_denoiser::{DenoisedAudio, OfflineSpeechDenoiserModelConfig};
+use sherpa_onnx_sys as sys;
+use std::ffi::CString;
+use std::ptr;
+
+#[derive(Clone, Debug, Default)]
+pub struct OfflineSpeechDenoiserConfig {
+    pub model: OfflineSpeechDenoiserModelConfig,
+}
+
+impl OfflineSpeechDenoiserConfig {
+    fn to_sys(&self, cstrings: &mut Vec<CString>) -> sys::OfflineSpeechDenoiserConfig {
+        sys::OfflineSpeechDenoiserConfig {
+            model: self.model.to_sys(cstrings),
+        }
+    }
+}
+
+pub struct OfflineSpeechDenoiser {
+    ptr: *const sys::OfflineSpeechDenoiser,
+}
+
+impl OfflineSpeechDenoiser {
+    pub fn create(config: &OfflineSpeechDenoiserConfig) -> Option<Self> {
+        let mut cstrings = Vec::new();
+        let sys_config = config.to_sys(&mut cstrings);
+        let ptr = unsafe { sys::SherpaOnnxCreateOfflineSpeechDenoiser(&sys_config) };
+        if ptr.is_null() {
+            None
+        } else {
+            Some(Self { ptr })
+        }
+    }
+
+    pub fn run(&self, samples: &[f32], sample_rate: i32) -> DenoisedAudio {
+        let samples_ptr = if samples.is_empty() {
+            ptr::null()
+        } else {
+            samples.as_ptr()
+        };
+        let ptr = unsafe {
+            sys::SherpaOnnxOfflineSpeechDenoiserRun(
+                self.ptr,
+                samples_ptr,
+                samples.len() as i32,
+                sample_rate,
+            )
+        };
+        DenoisedAudio::from_ptr(ptr)
+    }
+
+    pub fn sample_rate(&self) -> i32 {
+        unsafe { sys::SherpaOnnxOfflineSpeechDenoiserGetSampleRate(self.ptr) }
+    }
+}
+
+impl Drop for OfflineSpeechDenoiser {
+    fn drop(&mut self) {
+        unsafe { sys::SherpaOnnxDestroyOfflineSpeechDenoiser(self.ptr) }
+    }
+}
diff --git a/sherpa-onnx/rust/sherpa-onnx/src/online_speech_denoiser.rs b/sherpa-onnx/rust/sherpa-onnx/src/online_speech_denoiser.rs
@@ -0,0 +1,74 @@
+use crate::speech_denoiser::{DenoisedAudio, OfflineSpeechDenoiserModelConfig};
+use sherpa_onnx_sys as sys;
+use std::ffi::CString;
+use std::ptr;
+
+#[derive(Clone, Debug, Default)]
+pub struct OnlineSpeechDenoiserConfig {
+    pub model: OfflineSpeechDenoiserModelConfig,
+}
+
+impl OnlineSpeechDenoiserConfig {
+    fn to_sys(&self, cstrings: &mut Vec<CString>) -> sys::OnlineSpeechDenoiserConfig {
+        sys::OnlineSpeechDenoiserConfig {
+            model: self.model.to_sys(cstrings),
+        }
+    }
+}
+
+pub struct OnlineSpeechDenoiser {
+    ptr: *const sys::OnlineSpeechDenoiser,
+}
+
+impl OnlineSpeechDenoiser {
+    pub fn create(config: &OnlineSpeechDenoiserConfig) -> Option<Self> {
+        let mut cstrings = Vec::new();
+        let sys_config = config.to_sys(&mut cstrings);
+        let ptr = unsafe { sys::SherpaOnnxCreateOnlineSpeechDenoiser(&sys_config) };
+        if ptr.is_null() {
+            None
+        } else {
+            Some(Self { ptr })
+        }
+    }
+
+    pub fn run(&self, samples: &[f32], sample_rate: i32) -> DenoisedAudio {
+        let samples_ptr = if samples.is_empty() {
+            ptr::null()
+        } else {
+            samples.as_ptr()
+        };
+        let ptr = unsafe {
+            sys::SherpaOnnxOnlineSpeechDenoiserRun(
+                self.ptr,
+                samples_ptr,
+                samples.len() as i32,
+                sample_rate,
+            )
+        };
+        DenoisedAudio::from_ptr(ptr)
+    }
+
+    pub fn flush(&self) -> DenoisedAudio {
+        let ptr = unsafe { sys::SherpaOnnxOnlineSpeechDenoiserFlush(self.ptr) };
+        DenoisedAudio::from_ptr(ptr)
+    }
+
+    pub fn reset(&self) {
+        unsafe { sys::SherpaOnnxOnlineSpeechDenoiserReset(self.ptr) }
+    }
+
+    pub fn sample_rate(&self) -> i32 {
+        unsafe { sys::SherpaOnnxOnlineSpeechDenoiserGetSampleRate(self.ptr) }
+    }
+
+    pub fn frame_shift_in_samples(&self) -> i32 {
+        unsafe { sys::SherpaOnnxOnlineSpeechDenoiserGetFrameShiftInSamples(self.ptr) }
+    }
+}
+
+impl Drop for OnlineSpeechDenoiser {
+    fn drop(&mut self) {
+        unsafe { sys::SherpaOnnxDestroyOnlineSpeechDenoiser(self.ptr) }
+    }
+}
diff --git a/sherpa-onnx/rust/sherpa-onnx/src/speech_denoiser.rs b/sherpa-onnx/rust/sherpa-onnx/src/speech_denoiser.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+../../../../../../../../../../sherpa-onnx/kotlin-api/DenoisedAudio.kt`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+../sherpa-onnx/kotlin-api/DenoisedAudio.kt`