# Koala Noise Suppression Demos
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
## Koala
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+
- 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 pvkoalademo
```
## 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
### Microphone Demo
The microphone demo collects audio from a microphone connected to your machine. The audio is passed through the Koala
noise suppression engine and stored in a `.wav` file.
Run the following in the terminal:
```console
koala_demo_mic --access_key ${ACCESS_KEY} --output-path ${WAV_OUTPUT_PATH}
```
Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console and `${WAV_OUTPUT_PATH}` with a path to a `.wav` file
where the enhanced audio will be stored. Terminate the demo with `Ctrl+C`.
### File Demo
The file demo passes audio stored in a `.wav` file through the Koala noise suppression engine. The result is shifted to
compensate for the delay introduced by Koala and stored in a separate `.wav` file that will have the same length as the
input file without any delay.
Run the following in the terminal:
```console
koala_demo_file --access_key ${ACCESS_KEY} --input_path ${WAV_INPUT_PATH} --output_path ${WAV_OUTPUT_PATH}
```
Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${WAV_INPUT_PATH}` with a path to a compatible
(single-channel, 16 kHz, 16-bit PCM) `.wav` file you wish to enhance, and `${WAV_OUTPUT_PATH}` with a path to a `.wav`
file where the enhanced audio will be stored.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/koala",
"name": "pvkoalademo",
"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/14/1b/857336ecc738d96eaedd5460b604e8b3f6cb412e970575a5540d89250743/pvkoalademo-2.0.1.tar.gz",
"platform": null,
"description": "# Koala Noise Suppression Demos\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\n\n## Koala\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+\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 pvkoalademo\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\n### Microphone Demo\n\nThe microphone demo collects audio from a microphone connected to your machine. The audio is passed through the Koala\nnoise suppression engine and stored in a `.wav` file.\nRun the following in the terminal:\n\n```console\nkoala_demo_mic --access_key ${ACCESS_KEY} --output-path ${WAV_OUTPUT_PATH}\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from Picovoice Console and `${WAV_OUTPUT_PATH}` with a path to a `.wav` file\nwhere the enhanced audio will be stored. Terminate the demo with `Ctrl+C`.\n\n### File Demo\n\nThe file demo passes audio stored in a `.wav` file through the Koala noise suppression engine. The result is shifted to\ncompensate for the delay introduced by Koala and stored in a separate `.wav` file that will have the same length as the\ninput file without any delay.\nRun the following in the terminal:\n\n```console\nkoala_demo_file --access_key ${ACCESS_KEY} --input_path ${WAV_INPUT_PATH} --output_path ${WAV_OUTPUT_PATH}\n```\n\nReplace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${WAV_INPUT_PATH}` with a path to a compatible\n(single-channel, 16 kHz, 16-bit PCM) `.wav` file you wish to enhance, and `${WAV_OUTPUT_PATH}` with a path to a `.wav` \nfile where the enhanced audio will be stored.\n",
"bugtrack_url": null,
"license": "",
"summary": "Koala Noise Suppression Engine demos",
"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": "6eb1f031185c5c80dfd50938920da167c37ba62e98b6dbee236c92f62ddd0513",
"md5": "ba8ea7c648ae1b4b30a8e2239afb000e",
"sha256": "ef8cea51bba128f64afc45bbfdb823b37d49a993601377abe9b21437c86586ff"
},
"downloads": -1,
"filename": "pvkoalademo-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba8ea7c648ae1b4b30a8e2239afb000e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10258,
"upload_time": "2024-02-05T22:34:44",
"upload_time_iso_8601": "2024-02-05T22:34:44.343289Z",
"url": "https://files.pythonhosted.org/packages/6e/b1/f031185c5c80dfd50938920da167c37ba62e98b6dbee236c92f62ddd0513/pvkoalademo-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "141b857336ecc738d96eaedd5460b604e8b3f6cb412e970575a5540d89250743",
"md5": "16806e7457c59660d9355a1a3895d188",
"sha256": "fe0df96d361dfd10054e65448925fde6c55a155ebc016d40ee277d24a36a47a1"
},
"downloads": -1,
"filename": "pvkoalademo-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "16806e7457c59660d9355a1a3895d188",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9846,
"upload_time": "2024-02-05T22:34:46",
"upload_time_iso_8601": "2024-02-05T22:34:46.032195Z",
"url": "https://files.pythonhosted.org/packages/14/1b/857336ecc738d96eaedd5460b604e8b3f6cb412e970575a5540d89250743/pvkoalademo-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 22:34:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "koala",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvkoalademo"
}
JSON
