pvkoalademo


Namepvkoalademo JSON
Version 2.0.4 PyPI version JSON
download
home_pagehttps://github.com/Picovoice/koala
SummaryKoala Noise Suppression Engine demos
upload_time2025-02-06 00:09:19
maintainerNone
docs_urlNone
authorPicovoice
requires_python>=3.9
licenseNone
keywords noise cancellation noise suppression noise removal speech enhancement speech denoising
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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, arm64)
  - Android and iOS
  - Chrome, Safari, Firefox, and Edge
  - Raspberry Pi (3, 4, 5)

## Compatibility

- Python 3.9+
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64, arm64), 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.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/c1/2c/392713f535c3a2cc8ae83d7077a2602232558088073381be21a8795eeee7/pvkoalademo-2.0.4.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, 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+\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 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.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": "2792cee204107bad62e12903f40170d3762b574fdca9a6000037e30c02e07511",
                "md5": "f05ad5210fb20c800b5e9f8d11cabab3",
                "sha256": "5bce9af81195947a9c87ee45acab42bb9fb193b2c8c97624ea7f248b347e3e00"
            },
            "downloads": -1,
            "filename": "pvkoalademo-2.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f05ad5210fb20c800b5e9f8d11cabab3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 10237,
            "upload_time": "2025-02-06T00:09:18",
            "upload_time_iso_8601": "2025-02-06T00:09:18.625203Z",
            "url": "https://files.pythonhosted.org/packages/27/92/cee204107bad62e12903f40170d3762b574fdca9a6000037e30c02e07511/pvkoalademo-2.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c12c392713f535c3a2cc8ae83d7077a2602232558088073381be21a8795eeee7",
                "md5": "712c5ec481e7957adf434929ea74f37e",
                "sha256": "1c72e02d4b5a9d8c063057f37d4c0d4124bd623f2205f89f758a9264c655c714"
            },
            "downloads": -1,
            "filename": "pvkoalademo-2.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "712c5ec481e7957adf434929ea74f37e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 9911,
            "upload_time": "2025-02-06T00:09:19",
            "upload_time_iso_8601": "2025-02-06T00:09:19.849324Z",
            "url": "https://files.pythonhosted.org/packages/c1/2c/392713f535c3a2cc8ae83d7077a2602232558088073381be21a8795eeee7/pvkoalademo-2.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-06 00:09:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Picovoice",
    "github_project": "koala",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pvkoalademo"
}
        
Elapsed time: 5.75524s