[+] feat: support real-time noise reduction

heng30 · heng30 · commit c2aa11438032 · 2025-10-21T15:53:28.000+08:00
diff --git a/lib/recorder/examples/input_recording_demo.rs b/lib/recorder/examples/input_recording_demo.rs
@@ -5,7 +5,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     println!("Input Audio Recording Demo");
     println!("==========================");
 
-    let recorder = AudioRecorder::new(None)?;
+    let recorder = AudioRecorder::new(None)?.with_real_time_denoise(true);
 
     println!("\nAvailable Input Devices:");
     println!("------------------------");
diff --git a/lib/recorder/src/record_audio.rs b/lib/recorder/src/record_audio.rs
@@ -1,10 +1,12 @@
-use crate::{apply_gain, calc_rms_level};
+use crate::{RealTimeDenoise, apply_gain, calc_rms_level, denoise_model};
 use cpal::{
     Device, Host, InputCallbackInfo, SampleFormat, Stream, StreamConfig,
     traits::{DeviceTrait, HostTrait, StreamTrait},
 };
 use crossbeam::channel::{Receiver, Sender, bounded};
 use hound::{WavSpec, WavWriter};
+use nnnoiseless::RnnModel;
+use once_cell::sync::Lazy;
 use std::{
     fs::File,
     io::BufWriter,
@@ -16,6 +18,8 @@ use std::{
 };
 use thiserror::Error;
 
+static DENOISE_MODEL: Lazy<RnnModel> = Lazy::new(|| denoise_model());
+
 /// Audio recording error types.
 ///
 /// This enum represents all possible errors that can occur during
@@ -54,6 +58,9 @@ pub enum AudioError {
     /// Audio sample encoding or format conversion failed
     #[error("Audio encoding error: {0}")]
     EncodingError(String),
+    /// Audio sample denoise failed
+    #[error("Audio denoise error: {0}")]
+    DenoiseError(String),
 }
 
 /// Information about an audio device for recording.
@@ -135,6 +142,8 @@ pub struct AudioRecorder {
 
     // [0, infinity]
     amplification: Option<Arc<AtomicI32>>,
+
+    real_time_denoise: bool,
 }
 
 impl AudioRecorder {
@@ -176,6 +185,7 @@ impl AudioRecorder {
             audio_level_sender,
             audio_level_receiver,
             amplification: None,
+            real_time_denoise: false,
         })
     }
 
@@ -184,6 +194,11 @@ impl AudioRecorder {
         self
     }
 
+    pub fn with_real_time_denoise(mut self, v: bool) -> Self {
+        self.real_time_denoise = v;
+        self
+    }
+
     /// Get the audio level receiver for real-time monitoring.
     ///
     /// This method returns the receiver end of the audio level channel,
@@ -407,12 +422,48 @@ impl StreamingAudioRecorder {
             )?)))
         };
 
+        // Note:
+        //  Without calling `denoise.flush` is not a problem.
+        //  Just losing the last frame of real-time samples.
+        let mut denoiser = if recorder.real_time_denoise && !disable_save_file {
+            let spec = WavSpec {
+                channels: stream_config.channels,
+                sample_rate: stream_config.sample_rate.0,
+                bits_per_sample: 32,
+                sample_format: hound::SampleFormat::Float,
+            };
+
+            Some(
+                RealTimeDenoise::new(&DENOISE_MODEL, spec)
+                    .map_err(|e| AudioError::DenoiseError(e.to_string()))?,
+            )
+        } else {
+            None
+        };
+
         let file_writer_clone = file_writer.clone();
         let audio_level_sender = recorder.audio_level_sender.clone();
         let amplification = recorder.amplification.clone();
+
         let recording_session = recorder.start_input_recording(
             device_name,
             move |f32_samples: &[f32], _info: &_| {
+                let mut denoise_samples = None;
+                let f32_samples = if let Some(ref mut denoiser) = denoiser {
+                    match denoiser.process(f32_samples) {
+                        Ok(v) => denoise_samples = v,
+                        Err(e) => log::warn!("denoise audio samples failed: {e}"),
+                    };
+
+                    if denoise_samples.is_some() {
+                        &denoise_samples.unwrap()
+                    } else {
+                        f32_samples
+                    }
+                } else {
+                    f32_samples
+                };
+
                 let mut f32_sample_amplification = Vec::with_capacity(f32_samples.len());
                 let data = if let Some(ref amplification) = amplification {
                     f32_sample_amplification.extend_from_slice(f32_samples);
diff --git a/lib/recorder/src/recorder.rs b/lib/recorder/src/recorder.rs
@@ -428,7 +428,9 @@ impl RecordingSession {
         .map_err(|e: AudioError| RecorderError::AudioError(e.to_string()))?;
 
         let audio_recorder = if self.config.audio_amplification.is_some() {
-            audio_recorder.with_amplification(self.config.audio_amplification.clone().unwrap())
+            audio_recorder
+                .with_amplification(self.config.audio_amplification.clone().unwrap())
+                .with_real_time_denoise(self.config.enable_denoise && self.config.real_time_denoise)
         } else {
             audio_recorder
         };
@@ -825,7 +827,10 @@ impl RecordingSession {
         }
 
         if !self.config.disable_save_file {
-            if self.config.enable_denoise && self.config.audio_device_name.is_some() {
+            if self.config.enable_denoise
+                && !self.config.real_time_denoise
+                && self.config.audio_device_name.is_some()
+            {
                 let input_file = self
                     .config
                     .output_path
@@ -855,15 +860,17 @@ impl RecordingSession {
             let combine_config = MergeTracksConfig {
                 h264_path: self.config.output_path.with_extension(RAW_VIDEO_EXTENSION),
                 input_wav_path: if self.config.audio_device_name.is_some() {
-                    Some(if self.config.enable_denoise {
-                        self.config
-                            .output_path
-                            .with_extension(INPUT_AUDIO_DENOISE_EXTENSION)
-                    } else {
-                        self.config
-                            .output_path
-                            .with_extension(INPUT_AUDIO_EXTENSION)
-                    })
+                    Some(
+                        if self.config.enable_denoise && !self.config.real_time_denoise {
+                            self.config
+                                .output_path
+                                .with_extension(INPUT_AUDIO_DENOISE_EXTENSION)
+                        } else {
+                            self.config
+                                .output_path
+                                .with_extension(INPUT_AUDIO_EXTENSION)
+                        },
+                    )
                 } else {
                     None
                 },
@@ -918,7 +925,7 @@ impl RecordingSession {
                             .with_extension(INPUT_AUDIO_EXTENSION),
                     );
 
-                    if self.config.enable_denoise {
+                    if self.config.enable_denoise && !self.config.real_time_denoise {
                         _ = fs::remove_file(
                             self.config
                                 .output_path
diff --git a/lib/recorder/src/recorder_config.rs b/lib/recorder/src/recorder_config.rs
@@ -135,6 +135,8 @@ pub struct RecorderConfig {
 
     pub enable_denoise: bool,
 
+    pub real_time_denoise: bool,
+
     pub disable_save_file: bool,
 
     #[setters(strip_option)]
@@ -197,6 +199,7 @@ impl RecorderConfig {
             enable_speaker_channel_user: false,
             enable_preview_mode: false,
             enable_denoise: false,
+            real_time_denoise: true,
             disable_save_file: false,
             audio_amplification: None,
             speaker_amplification: None,
diff --git a/tr-helper/src/tr.rs b/tr-helper/src/tr.rs
@@ -239,8 +239,10 @@ fn cn() -> &'static HashMap<&'static str, &'static str> {
             ("Welcome to use wayshot", "欢迎使用Wayshot"),
             ("screen recording tool for wayland", "Wayland录屏工具"),
             ("Finished Mergeing Tracks", "完成合并轨道"),
-            ("Disabled microphone denoise", "禁用麦克风降噪"),
-            ("Enabled microphone denoise", "启用麦克风降噪"),
+            ("Disabled microphone noise reduction", "已禁用麦克风降噪"),
+            ("Enabled microphone noise reduction", "已启用麦克风降噪"),
+            ("Post-processing noise reduction", "后处理降噪"),
+            ("Real-time noise reduction", "实时降噪"),
             ("create desktop speaker recorder failed", "创建桌面扬声器录制器失败"),
             ("start desktop speaker recorder failed", "启动桌面扬声器录制器失败"),
             ("Convert the microphone audio to mono", "将麦克风音频转换为单声道"),
diff --git a/wayshot/src/config.rs b/wayshot/src/config.rs
@@ -130,6 +130,9 @@ pub struct Recorder {
 
     pub enable_denoise: bool,
 
+    #[derivative(Default(value = "true"))]
+    pub real_time_denoise: bool,
+
     pub convert_input_wav_to_mono: bool,
 
     #[derivative(Default(value = "fps_default()"))]
diff --git a/wayshot/src/logic/recorder.rs b/wayshot/src/logic/recorder.rs
@@ -578,6 +578,7 @@ fn inner_start_recording(ui_weak: Weak<AppWindow>) -> Result<()> {
     .with_enable_frame_channel_user(true)
     .with_enable_preview_mode(all_config.recorder.enable_preview)
     .with_enable_denoise(all_config.recorder.enable_denoise)
+    .with_real_time_denoise(all_config.recorder.real_time_denoise)
     .with_convert_input_wav_to_mono(all_config.recorder.convert_input_wav_to_mono)
     .with_enable_recording_speaker(all_config.control.enable_desktop_speaker)
     .with_include_cursor(all_config.recorder.include_cursor)
@@ -675,8 +676,10 @@ fn inner_start_recording(ui_weak: Weak<AppWindow>) -> Result<()> {
 
     _ = ui_weak.upgrade_in_event_loop(move |ui| {
         global_store!(ui).set_record_status(UIRecordStatus::Stopped);
+        let all_config = config::all();
 
-        if config::all().recorder.enable_denoise
+        if all_config.recorder.enable_denoise
+            && !all_config.recorder.real_time_denoise
             && global_store!(ui).get_denoise_status() != UIDenoiseStatus::Cancelled
         {
             global_store!(ui).set_denoise_status(UIDenoiseStatus::Finished);
@@ -703,7 +706,8 @@ fn stop_recording(ui: &AppWindow) {
         log::warn!("recorder_stop_sig is None");
     }
 
-    if config::all().recorder.enable_denoise {
+    let all_config = config::all();
+    if all_config.recorder.enable_denoise && !all_config.recorder.real_time_denoise {
         global_store!(ui).set_record_status(UIRecordStatus::Denoising);
     } else {
         global_store!(ui).set_record_status(UIRecordStatus::Mergeing);
diff --git a/wayshot/src/logic/tr.rs b/wayshot/src/logic/tr.rs
@@ -241,8 +241,10 @@ fn cn() -> &'static HashMap<&'static str, &'static str> {
             ("Welcome to use wayshot", "欢迎使用Wayshot"),
             ("screen recording tool for wayland", "Wayland录屏工具"),
             ("Finished Mergeing Tracks", "完成合并轨道"),
-            ("Disabled microphone denoise", "禁用麦克风降噪"),
-            ("Enabled microphone denoise", "启用麦克风降噪"),
+            ("Disabled microphone noise reduction", "已禁用麦克风降噪"),
+            ("Enabled microphone noise reduction", "已启用麦克风降噪"),
+            ("Post-processing noise reduction", "后处理降噪"),
+            ("Real-time noise reduction", "实时降噪"),
             ("create desktop speaker recorder failed", "创建桌面扬声器录制器失败"),
             ("start desktop speaker recorder failed", "启动桌面扬声器录制器失败"),
             ("Convert the microphone audio to mono", "将麦克风音频转换为单声道"),
diff --git a/wayshot/ui/panel/setting/components/recorder.slint b/wayshot/ui/panel/setting/components/recorder.slint
@@ -1,6 +1,6 @@
 import { Store, Logic, Theme, DeviceType, Icons, SettingRecorder } from "../../def.slint";
 import { Fps, Resolution } from "../../../store.slint";
-import { SettingDetail, SettingDetailInner, SettingDetailInnerVbox, SettingDetailLabel, LineInput, ConfirmBtn, Label, SettingDetailSwitch, Select } from "../../../base/widgets.slint";
+import { SettingDetail, SettingDetailInner, RadioBtn, SettingDetailInnerVbox, SettingDetailLabel, LineInput, ConfirmBtn, Label, SettingDetailSwitch, Select } from "../../../base/widgets.slint";
 
 export component Recorder inherits SettingDetail {
     callback confirmed();
@@ -10,6 +10,7 @@ export component Recorder inherits SettingDetail {
     private property <bool> include-cursor;
     private property <bool> enable-preview;
     private property <bool> enable-denoise;
+    private property <bool> real-time-denoise;
     private property <bool> convert-input-wav-to-mono;
     private property <Fps> fps;
     private property <Resolution> resolution;
@@ -25,6 +26,7 @@ export component Recorder inherits SettingDetail {
             include-cursor: root.include-cursor,
             enable-preview: root.enable-preview,
             enable-denoise: root.enable-denoise,
+            real-time-denoise: root.real-time-denoise,
             convert-input-wav-to-mono: root.convert-input-wav-to-mono,
             fps: root.fps,
             resolution: root.resolution,
@@ -37,6 +39,7 @@ export component Recorder inherits SettingDetail {
         root.include-cursor = setting.include-cursor;
         root.enable-preview = setting.enable-preview;
         root.enable-denoise = setting.enable-denoise;
+        root.real-time-denoise = setting.real-time-denoise;
         root.convert-input-wav-to-mono = setting.convert-input-wav-to-mono;
         root.fps = setting.fps;
         root.resolution = setting.resolution;
@@ -102,19 +105,6 @@ export component Recorder inherits SettingDetail {
             }
         }
 
-        SettingDetailInnerVbox {
-            SettingDetailSwitch {
-                icon: Icons.denoise-light;
-                text: self.checked ? Logic.tr("Enabled microphone denoise") : Logic.tr("Disabled microphone denoise");
-                checked: root.enable-denoise;
-
-                toggled => {
-                    root.enable-denoise = self.checked;
-                    Logic.set-setting-recorder(root.get());
-                }
-            }
-        }
-
         SettingDetailInnerVbox {
             include-cursor-swicth := SettingDetailSwitch {
                 icon: Icons.cursor-light;
@@ -154,5 +144,44 @@ export component Recorder inherits SettingDetail {
                 }
             }
         }
+
+        SettingDetailInnerVbox {
+            spacing: Theme.spacing * 2;
+
+            SettingDetailSwitch {
+                icon: Icons.denoise-light;
+                text: self.checked ? Logic.tr("Enabled microphone noise reduction") : Logic.tr("Disabled microphone noise reduction");
+                checked: root.enable-denoise;
+
+                toggled => {
+                    root.enable-denoise = self.checked;
+                    Logic.set-setting-recorder(root.get());
+                }
+            }
+
+            if root.enable-denoise: HorizontalLayout {
+                HorizontalLayout {
+                    width: 50%;
+
+                    RadioBtn {
+                        text: Logic.tr("Real-time noise reduction");
+                        checked: root.real-time-denoise;
+                        check => {
+                            root.real-time-denoise = true;
+                            Logic.set-setting-recorder(root.get());
+                        }
+                    }
+                }
+
+                RadioBtn {
+                    text: Logic.tr("Post-processing noise reduction");
+                    checked: !root.real-time-denoise;
+                    check => {
+                        root.real-time-denoise = false;
+                        Logic.set-setting-recorder(root.get());
+                    }
+                }
+            }
+        }
     }
 }
diff --git a/wayshot/ui/store.slint b/wayshot/ui/store.slint
@@ -79,6 +79,7 @@ export struct SettingRecorder {
     include-cursor: bool,
     enable-preview: bool,
     enable-denoise: bool,
+    real-time-denoise: bool,
     convert-input-wav-to-mono: bool,
     fps: Fps,
     resolution: Resolution,
