livekit-plugins-denoise 0.1.0__py3-none-any.whl

livekit_plugins_denoise-0.1.0.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.5
+Name: livekit-plugins-denoise
+Version: 0.1.0
+Summary: Self-hosted noise and echo suppression for LiveKit SIP telephony
+Project-URL: Source, https://github.com/jaffarjawed/livekit-plugins-denoise
+Project-URL: Issues, https://github.com/jaffarjawed/livekit-plugins-denoise/issues
+Author: BotifyNow
+License-Expression: MIT
+License-File: LICENSE
+License-File: NOTICE
+Keywords: audio,echo-cancellation,livekit,noise-cancellation,sip,telephony,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Telephony
+Classifier: Topic :: Multimedia :: Sound/Audio
+Requires-Python: >=3.10
+Requires-Dist: deepfilter-stream<0.2,>=0.1.0
+Requires-Dist: livekit-agents<2.0,>=1.6.0
+Requires-Dist: livekit<2.0,>=1.1.0
+Requires-Dist: numpy>=1.26
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest-asyncio<2,>=1.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: twine>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# livekit-plugins-denoise
+
+Self-hosted noise suppression and acoustic echo cancellation for LiveKit SIP
+agents.
+
+- Removes background noise with DeepFilterNet3 or low-latency WebRTC noise
+  suppression.
+- Removes the agent's voice when it returns through a caller's handset or
+  carrier path.
+- Runs in your agent process: no per-minute denoising fee and no language
+  dependency.
+
+This is an independent, community-maintained package and is not affiliated
+with or endorsed by LiveKit, Inc.
+
+## Why this exists
+
+LiveKit's managed `BVCTelephony` noise-cancellation option is billed per minute.
+This package is a self-hosted, MIT-licensed alternative for teams that want
+noise suppression and echo cancellation in their own agent process without a
+per-minute denoising charge. You still pay for your own compute, telephony, and
+other services.
+
+## Install
+
+```bash
+python -m pip install livekit-plugins-denoise
+```
+
+For local development:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## Enable noise suppression and echo cancellation
+
+Create one `TelephonyDenoiser` for each call. `EchoReferenceTap` is required
+for echo cancellation because it supplies the agent's outgoing audio as the
+far-end reference.
+
+```python
+from livekit.agents import room_io
+from livekit.plugins import telephony_denoise
+
+denoiser = telephony_denoise.TelephonyDenoiser(
+    telephony_denoise.DenoiseOptions(
+        echo_cancellation=True,
+        noise_suppression=True,
+        high_pass_filter=True,
+        auto_gain_control=True,
+        enhancer="deepfilter",  # use "webrtc" for lower latency
+        stream_delay_ms=120,
+    )
+)
+
+await session.start(
+    agent=agent,
+    room=room,
+    room_options=room_io.RoomOptions(
+        audio_input=room_io.AudioInputOptions(
+            noise_cancellation=denoiser,
+            auto_gain_control=False,  # do not stack AGC
+        ),
+    ),
+)
+
+# Add this after session.start(); RoomIO replaces the output during startup.
+session.output.audio = telephony_denoise.EchoReferenceTap(
+    denoiser, next_in_chain=session.output.audio
+)
+```
+
+To load the neural model before the first call:
+
+```python
+def setup(proc):
+    telephony_denoise.prewarm()
+```
+
+See [examples/sip_agent.py](examples/sip_agent.py) for a complete SIP agent.
+
+## Configuration
+
+`DenoiseOptions` lets you control these features independently:
+
+| Option | Default | Purpose |
+| --- | --- | --- |
+| `echo_cancellation` | `True` | Cancels the agent's returned audio; requires `EchoReferenceTap`. |
+| `noise_suppression` | `True` | Removes background noise. |
+| `enhancer` | `"deepfilter"` | Use `"webrtc"` when minimizing latency is more important. |
+| `high_pass_filter` | `True` | Reduces low-frequency rumble and hum. |
+| `auto_gain_control` | `True` | Helps keep quiet callers audible. |
+| `stream_delay_ms` | `120` | Starting delay estimate for SIP echo paths. |
+
+For tuning, supported formats, model download behavior, and operating notes, see
+[Technical notes](docs/technical-notes.md).
+
+## Community
+
+Issues, documentation improvements, and pull requests are welcome. See
+[CONTRIBUTING.md](CONTRIBUTING.md). This project is MIT licensed; dependency
+attribution is in [NOTICE](NOTICE).

livekit_plugins_denoise-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+livekit/plugins/telephony_denoise/__init__.py,sha256=RpYNx9Ksds_JXLtwdo5IH8tYfE-KSHmj2y8t54VjMlY,948
+livekit/plugins/telephony_denoise/_buffers.py,sha256=L6OnKb3mdTxXtn5faNzT7FaM6QWHObidhmqdOJuwyjs,1780
+livekit/plugins/telephony_denoise/_resample.py,sha256=ruWT114RsroZU9ImQNsOz_oFX8wFCHvwuWZzjdYEz5Y,10689
+livekit/plugins/telephony_denoise/echo_reference.py,sha256=OuFccFmY1TLU9WLbigcZybH7bSb3wJ94NCqMAE2jDCM,5683
+livekit/plugins/telephony_denoise/log.py,sha256=R6UX7a6AqNQQ9vP4GAmETmAvQIkqwDMAwYThJD0D3Gk,83
+livekit/plugins/telephony_denoise/neural.py,sha256=n-TgbqZdOQfp2XhK43s5k1gEjDckAb3-kPr-9V1Ujgw,8825
+livekit/plugins/telephony_denoise/processor.py,sha256=j40tUsnCPb1MqlDYZGa3NU3K_kfSvhoH5WoADO-_vO8,16935
+livekit/plugins/telephony_denoise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+livekit/plugins/telephony_denoise/version.py,sha256=QTYqXqSTHFRkM9TEgpDFcHvwLbvqHDqvqfQ9EiXkcAM,23
+livekit_plugins_denoise-0.1.0.dist-info/METADATA,sha256=-j6vwrWlmqVe92Ltvhfi5DxWJh3zYIgDEuX7UGHl7OM,4563
+livekit_plugins_denoise-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+livekit_plugins_denoise-0.1.0.dist-info/licenses/LICENSE,sha256=e0vEReJqJfrWqD7e0c_aJeVjfzRxbqNRNiDLNd7TU7I,1066
+livekit_plugins_denoise-0.1.0.dist-info/licenses/NOTICE,sha256=76fDv7NQVGpt4tIhW-e2hVsLIrz7m19eQEKRMFUyzKw,454
+livekit_plugins_denoise-0.1.0.dist-info/RECORD,,

livekit_plugins_denoise-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

livekit_plugins_denoise-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BotifyNow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

livekit_plugins_denoise-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,11 @@
+livekit-plugins-denoise
+Copyright 2026 BotifyNow
+
+This package depends on deepfilter-stream, which bundles DeepFilterNet3 model
+weights. deepfilter-stream and DeepFilterNet are dual-licensed under MIT or
+Apache-2.0 at the recipient's option.
+
+DeepFilterNet attribution:
+H. Schröter, T. Rosenkranz, A. N. Escalante-B., and A. Maier,
+"DeepFilterNet: A Low Complexity Speech Enhancement Framework for Full-Band
+Audio based on Deep Filtering", IWAENC 2022.