Koala Binding for Python
Koala Noise Suppression Engine
Made in Vancouver, Canada by Picovoice
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
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 to get your AccessKey.
Usage
Create an instance of the engine and enhance audio:
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.
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 provides command-line utilities for processing audio using Koala.
Metadata
Release files for pvkoala 3.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pvkoala-3.0.1.tar.gz | 5.8 MB | Without provenance | Details for pvkoala-3.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pvkoala-3.0.1-py3-none-any.whl | Python 3 | none | any | Details for pvkoala-3.0.1-py3-none-any.whl |
Total release size: 11.6 MB
Release files / pvkoala-3.0.1.tar.gz
| Download URL | pvkoala-3.0.1.tar.gz |
|---|---|
| Size | 5.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf29a7712c2fb0a5354e2d93cf21a961c439191ae1cdc4b82b9328f6db9b349b
|
|
BLAKE2b-256 checksum How to use checksums |
c20bfa3feb89554d95bb48cc183e434a72396e0286269ac0ec3ff53cede3fa1e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / pvkoala-3.0.1-py3-none-any.whl
| Download URL | pvkoala-3.0.1-py3-none-any.whl |
|---|---|
| Size | 5.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca03d90fe02d7ecf58d5ac2b17ac0d6c893bafce2bee7b76d453f7bf54b12db1
|
|
BLAKE2b-256 checksum How to use checksums |
b132c91821087e3a33c09d4f122b0a60e8c65804116afe037ef783bd6043bdeb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Security for pvkoala 3.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.