Metadata-Version: 2.4
Name: fasr-enhancement-hush
Version: 0.5.7
Summary: Hush audio enhancement model for fasr
Author-email: fasr <790990241@qq.com>
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
Requires-Dist: fasr
Requires-Dist: numpy>=1.24
Requires-Dist: soxr>=0.5.0

# fasr-enhancement-hush

英文文档地址: [README_EN.md](README_EN.md)

Hush 音频增强插件。该插件使用 Hush 上游提供的 ONNX 模型包
`advanced_dfnet16k_model_best_onnx.tar.gz` 和 `libweya_nc` native runtime，
通过 fasr `EnhancementModel` 暴露离线 `enhance()` 与流式 `push_chunk()`。

## 注册模型

| 注册名 | 类 | 适用场景 |
|---|---|---|
| `hush` | `HushEnhancement` | 16 kHz 语音降噪 / 背景说话人抑制 |

## 使用方式

```python
from fasr.data import Waveform
from fasr_enhancement_hush import HushEnhancement

model = HushEnhancement(sample_rate=16000)
enhanced = model.enhance(Waveform(data=audio, sample_rate=16000))
```

## Confection 配置

```toml
[enhancement_model]
@enhancement_models = "hush"
sample_rate = 16000
attenuation_limit_db = 100.0
```

## 参数

| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| `sample_rate` | `int` | `16000` | 输出采样率；Hush 内部原生 16 kHz，其他输入采样率会先重采样 |
| `model_path` | `str \| None` | `None` | 可选 Hush ONNX tar.gz 模型包路径；为空时使用内置模型 |
| `library_path` | `str \| None` | `None` | 可选 `libweya_nc` / `weya_nc.dll` 路径；为空时按平台使用内置库 |
| `attenuation_limit_db` | `float` | `100.0` | 最大衰减限制；值越大抑制越强，较小值会保留更多背景 |

## Realtime 状态

插件实例只加载一次 Hush native model。每个 `stream_id` 会创建独立 native
session，并在 `is_last=True` 后释放 session 和清理状态，因此可以配合 fasr
realtime 服务的单模型实例并发使用。
