Koala Noise Suppression
Python Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• Raspberry Pi (3, 4, 5)

Requirements

• Picovoice Account & AccessKey
• Python 3.5 or higher
• PIP

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Python 3 (3.5 or higher).

2. Install the pvkoala Python package using PIP:

pip3 install pvkoala

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())

In case the next audio frame does not directly follow the previous one, reset Koala Noise Suppression's internal state:

koala.reset()
while True:
    enhanced_audio = koala.process(get_next_audio_frame())

Free resources used by Koala Noise Suppression:

koala.delete()

Demos

For the Koala Noise Suppression Python SDK, we offer demo applications that demonstrate how to use the Noise Suppression engine on real-time audio streams (i.e. microphone input).

Setup

Install the pvkoalademo Python package using PIP:

pip3 install pvkoalademo

This package installs command-line utilities for the Koala Noise Suppression Python demos.

Usage

Use the --help flag to see the usage options for the demos:

koala_demo_mic --help
koala_demo_file --help

Run the following command to record microphone input, remove noise, and write the cleaned audio to a file:

koala_demo_mic --access_key ${ACCESS_KEY} --output_path ${WAV_OUTPUT_PATH}

Run the following command to remove noise from an existing .wav file and store the result in a separate file:

koala_demo_file --access_key ${ACCESS_KEY} --input_path ${WAV_INPUT_PATH} --output_path ${WAV_OUTPUT_PATH}

For more information on our Koala Noise Suppression demos for Python, head over to our GitHub repository.

Resources