# 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)
- Android and iOS
- Chrome, Safari, Firefox, and Edge
- Raspberry Pi (5, 4, 3) and NVIDIA Jetson Nano
## Compatibility
- Python 3.7 or higher
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (5, 4, 3), and NVIDIA Jetson Nano.
## 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": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"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/fc/6a/b96926713209cac54e056d2c34c8b868bbd7e185d8956704cdd6384cb2e6/pvkoala-2.0.1.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)\n - Android and iOS\n - Chrome, Safari, Firefox, and Edge\n - Raspberry Pi (5, 4, 3) and NVIDIA Jetson Nano\n\n## Compatibility\n\n- Python 3.7 or higher\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), Raspberry Pi (5, 4, 3), and NVIDIA Jetson Nano.\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": "",
"summary": "Koala Noise Suppression Engine.",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/Picovoice/koala"
},
"split_keywords": [
"noise cancellation",
"noise suppression",
"noise removal",
"speech enhancement",
"speech denoising"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "965ed39fd8af56fc666757b544d2df5f14c0bfc4597a62580db719e32bba5c26",
"md5": "3fbdd0827af6222aa3e9999b7671b19b",
"sha256": "8b153e076b4d14adccdcb4d800aa84e8d2f91e0640b959677582d3128cbcb249"
},
"downloads": -1,
"filename": "pvkoala-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fbdd0827af6222aa3e9999b7671b19b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4618471,
"upload_time": "2024-02-05T22:34:06",
"upload_time_iso_8601": "2024-02-05T22:34:06.485404Z",
"url": "https://files.pythonhosted.org/packages/96/5e/d39fd8af56fc666757b544d2df5f14c0bfc4597a62580db719e32bba5c26/pvkoala-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc6ab96926713209cac54e056d2c34c8b868bbd7e185d8956704cdd6384cb2e6",
"md5": "95c53b89f8d20e29cc496507bfe9ef24",
"sha256": "5e017c671fc1338d42dc20f9dee003d0144bbba1757b6f1fcd6272c5308da242"
},
"downloads": -1,
"filename": "pvkoala-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "95c53b89f8d20e29cc496507bfe9ef24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4620945,
"upload_time": "2024-02-05T22:34:08",
"upload_time_iso_8601": "2024-02-05T22:34:08.561348Z",
"url": "https://files.pythonhosted.org/packages/fc/6a/b96926713209cac54e056d2c34c8b868bbd7e185d8956704cdd6384cb2e6/pvkoala-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 22:34:08",
"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
