# 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 (3, 4, 5)
## Compatibility
- Python 3.8+
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), and Raspberry Pi (3, 4, 5).
## 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": null,
"docs_url": null,
"requires_python": ">=3.8",
"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/17/00/63c91a4dfe504921b4f3bb4477f8950345af1b29f5f310988f1859291369/pvkoalademo-2.0.2.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 (3, 4, 5)\n\n## Compatibility\n\n- Python 3.8+\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64), and Raspberry Pi (3, 4, 5).\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": null,
"summary": "Koala Noise Suppression Engine demos",
"version": "2.0.2",
"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": "bce4ac0cbd5acd9f1ebd8fe87e8a5d14acb5ca4aefa919cc2adc28f845242bcc",
"md5": "ecd3051341086f52787de1ea4c4c9594",
"sha256": "6f2dea74a1d420ee3738a6facb1e01a8b96d366f4ec9bbf0d14f4199dcdef850"
},
"downloads": -1,
"filename": "pvkoalademo-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecd3051341086f52787de1ea4c4c9594",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10237,
"upload_time": "2024-09-04T17:23:55",
"upload_time_iso_8601": "2024-09-04T17:23:55.938500Z",
"url": "https://files.pythonhosted.org/packages/bc/e4/ac0cbd5acd9f1ebd8fe87e8a5d14acb5ca4aefa919cc2adc28f845242bcc/pvkoalademo-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "170063c91a4dfe504921b4f3bb4477f8950345af1b29f5f310988f1859291369",
"md5": "e4c23d6a6649c8404123c6edf60c33ba",
"sha256": "b25f42fde386b11bb21ef51dbbb1aee99e78afb6e8b5072e1ab4c9fd742f2134"
},
"downloads": -1,
"filename": "pvkoalademo-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "e4c23d6a6649c8404123c6edf60c33ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9811,
"upload_time": "2024-09-04T17:23:57",
"upload_time_iso_8601": "2024-09-04T17:23:57.356389Z",
"url": "https://files.pythonhosted.org/packages/17/00/63c91a4dfe504921b4f3bb4477f8950345af1b29f5f310988f1859291369/pvkoalademo-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 17:23:57",
"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
