Skip to main content

Overview

RNNoiseFilter is an audio processor that reduces background noise in real-time audio streams using RNNoise, a recurrent neural network for audio noise reduction. It inherits from BaseAudioFilter and processes audio frames via the pyrnnoise library. RNNoise is a free, open-source noise suppression solution that requires no API keys or external services.

Installation

The RNNoise filter requires additional dependencies:

Constructor Parameters

str | None
default:"None"
deprecated
Deprecated since 1.16.0, removed in 2.0.0. Has no effect. No replacement.

Input Frames

Frame
Specific control frame to toggle filtering on/off. Queue the frame into the pipeline to toggle the filter used as audio_in_filter:

Usage Example

Notes

  • No API key or external service required (fully local processing)
  • RNNoise operates at 48kHz internally; automatic resampling is applied for other sample rates
  • Handles 16-bit PCM audio format
  • Can be dynamically enabled/disabled via FilterEnableFrame
  • Buffers audio to match RNNoise’s required frame length (480 samples)