# Koala Binding for Python
## Koala Noise Suppression Engine
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Koala is an on-device noise suppression engine. Koala is:
- Private; All voice processing runs locally.
- Cross-Platform:
- Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64)
- Android and iOS
- Chrome, Safari, Firefox, and Edge
- Raspberry Pi (3, 4, 5)
## Compatibility
- Python 3.9 or higher
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64), and Raspberry Pi (3, 4, 5).
## Installation
```console
pip3 install pvkoala
```
## AccessKey
Koala requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Koala
SDKs. You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
### Usage
Create an instance of the engine and enhance audio:
```python
import pvkoala
koala = pvkoala.create(access_key='${ACCESS_KEY}')
def get_next_audio_frame():
pass
while True:
enhanced_audio = koala.process(get_next_audio_frame())
```
Replace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/).
The input audio must come from a single-channel stream with integer 16-bit encoding. The sample rate must be identical
to `koala.sample_rate`. The stream must be split into *frames* with a fixed length in samples that can be obtained
from `koala.frame_length`.
The output of `koala.process()` is a frame of enhanced audio with the same 16-bit integer encoding. The delay in
samples between the start time of the input frame and the start time of the output frame can be attained from
`koala.delay_sample`.
In case the next audio frame does not directly follow the previous one, call `koala.reset()`.
When done be sure to explicitly release the resources using `koala.delete()`.
## Demos
[pvkoalademo](https://pypi.org/project/pvkoalademo/) provides command-line utilities for processing audio using Koala.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/koala",
"name": "pvkoala",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Noise Cancellation, Noise Suppression, Noise Removal, Speech Enhancement, Speech Denoising",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/61/6a/335943102e9e0340b22136df23163cd1470df91a9cb34a2e1f6f6b5726f9/pvkoala-2.0.4.tar.gz",
"platform": null,
"description": "# Koala Binding for Python\n\n## Koala Noise Suppression Engine\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\n\nKoala is an on-device noise suppression engine. Koala is:\n\n- Private; All voice processing runs locally.\n- Cross-Platform:\n - Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64)\n - Android and iOS\n - Chrome, Safari, Firefox, and Edge\n - Raspberry Pi (3, 4, 5)\n\n## Compatibility\n\n- Python 3.9 or higher\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64), and Raspberry Pi (3, 4, 5).\n\n## Installation\n\n```console\npip3 install pvkoala\n```\n\n## AccessKey\n\nKoala requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Koala\nSDKs. You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.\nSignup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.\n\n### Usage\n\nCreate an instance of the engine and enhance audio:\n\n```python\nimport pvkoala\n\nkoala = pvkoala.create(access_key='${ACCESS_KEY}')\n\ndef get_next_audio_frame():\n pass\n\nwhile True:\n enhanced_audio = koala.process(get_next_audio_frame())\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from [Picovoice Console](https://console.picovoice.ai/).\nThe input audio must come from a single-channel stream with integer 16-bit encoding. The sample rate must be identical\nto `koala.sample_rate`. The stream must be split into *frames* with a fixed length in samples that can be obtained\nfrom `koala.frame_length`.\n\nThe output of `koala.process()` is a frame of enhanced audio with the same 16-bit integer encoding. The delay in\nsamples between the start time of the input frame and the start time of the output frame can be attained from\n`koala.delay_sample`.\n\nIn case the next audio frame does not directly follow the previous one, call `koala.reset()`.\nWhen done be sure to explicitly release the resources using `koala.delete()`.\n\n## Demos\n\n[pvkoalademo](https://pypi.org/project/pvkoalademo/) provides command-line utilities for processing audio using Koala.\n",
"bugtrack_url": null,
"license": null,
"summary": "Koala Noise Suppression Engine.",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://github.com/Picovoice/koala"
},
"split_keywords": [
"noise cancellation",
" noise suppression",
" noise removal",
" speech enhancement",
" speech denoising"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "16c810c4c4799df9baface5cfc58b59683b771d656d32555ada5080e92a7cd03",
"md5": "4283b40835bc0a19bc847323d702a84b",
"sha256": "9c0781f7a79ed8d3e89c1d18251cf8fb59d0e57827ea76deefe7efd15bf5e59c"
},
"downloads": -1,
"filename": "pvkoala-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4283b40835bc0a19bc847323d702a84b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4654902,
"upload_time": "2025-02-06T00:08:41",
"upload_time_iso_8601": "2025-02-06T00:08:41.262901Z",
"url": "https://files.pythonhosted.org/packages/16/c8/10c4c4799df9baface5cfc58b59683b771d656d32555ada5080e92a7cd03/pvkoala-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "616a335943102e9e0340b22136df23163cd1470df91a9cb34a2e1f6f6b5726f9",
"md5": "20e518aef14f5ac7efd54d0e8dfab0d0",
"sha256": "056917315bbb97224788d5efac3ec9e5ae8e154bad8e4101dd409d7e5c7e5bab"
},
"downloads": -1,
"filename": "pvkoala-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "20e518aef14f5ac7efd54d0e8dfab0d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4657799,
"upload_time": "2025-02-06T00:08:43",
"upload_time_iso_8601": "2025-02-06T00:08:43.750235Z",
"url": "https://files.pythonhosted.org/packages/61/6a/335943102e9e0340b22136df23163cd1470df91a9cb34a2e1f6f6b5726f9/pvkoala-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-06 00:08:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "koala",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvkoala"
}
JSON
