Skip to main content

On-Device wake word detection powered by deep learning.

Project description

# Porcupine Wake Word Engine Demos

Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)

Porcupine is a highly-accurate and lightweight wake word engine. It enables building always-listening voice-enabled applications. It is

  • using deep neural networks trained in real-world environments.
  • compact and computationally-efficient making it perfect for IoT.
  • scalable. It can detect multiple always-listening voice commands with no added CPU/memory footprint.
  • self-service. Developers can train custom wake phrases using [Picovoice Console](https://picovoice.ai/console/).

## Compatibility

  • Python 3
  • Runs on Linux (x86_64), Mac (x86_64), Windows (x86_64), Raspberry Pi (all variants), and Beagle Bone.

## Installation

Microphone demo uses [PyAudio](https://people.csail.mit.edu/hubert/pyaudio/) for recording input audio. Consult the installation guide at [PyAudio](https://people.csail.mit.edu/hubert/pyaudio/).

`bash sudo pip3 install pvporcupinedemo `

## Usage

### File Demo

It allows testing Porcupine on a corpus of audio files. It is mainly useful for quantitative performance benchmarking. It accepts 16kHz audio files. Porcupine processes a single-channel audio stream if a stereo file is provided it only processes the first (left) channel. The following processes a file looking for instances of phrase “Picovoice”

`bash porcupine_demo_file --input_audio_path ${AUDIO_PATH} --keywords picovoice `

keywords is a shorthand for using default keyword files shipped with the package. The list of default keyword files can be seen in the usage string

`bash porcupine_demo_file --help `

In order to detect multiple phrases concurrently provide then as separate arguments

`bash porcupine_demo_file --input_audio_path ${AUDIO_PATH} --keywords grasshopper porcupine `

In order to detect non-default keywords (e.g. models created using [Picovoice Console](https://picovoice.ai/console/)) use keyword_file_paths argument

`bash porcupine_demo_file --input_audio_path ${AUDIO_PATH} --keyword_file_paths ${KEYWORD_PATH_ONE} ${KEYWORD_PATH_TWO} `

### Microphone Demo

It opens an audio stream from a microphone and detects utterances of a give wake word(s). The following opens the default microphone and detects the utterances of “Picovoice”.

`bash porcupine_demo_mic --keywords picovoice `

keywords is a shorthand for using default keyword files shipped with the package. The list of default keyword files can be seen in the usage string

`bash porcupine_demo_file --help `

In order to detect multiple phrases concurrently provide then as separate arguments

`bash pvporcupinedemo_mic --keywords picovoice porcupine `

In order to detect non-default keywords (e.g. models created using [Picovoice Console](https://picovoice.ai/console/)) use keyword_file_paths argument

`bash pvporcupinedemo_mic keyword_file_paths ${KEYWORD_PATH_ONE} ${KEYWORD_PATH_TWO} `

It is possible that the default audio input device recognized by PyAudio is not the one being used. There are a couple of debugging facilities baked into the demo application to solve this. First, type the following into the console

`bash pvporcupinedemo_mic --show_audio_devices `

It provides information about various audio input devices on the box. On a Linux box, this is the console output

` 'index': '0', 'name': 'HDA Intel PCH: ALC892 Analog (hw:0,0)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '2' 'index': '1', 'name': 'HDA Intel PCH: ALC892 Alt Analog (hw:0,2)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '2' 'index': '2', 'name': 'HDA NVidia: HDMI 0 (hw:1,3)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '3', 'name': 'HDA NVidia: HDMI 1 (hw:1,7)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '4', 'name': 'HDA NVidia: HDMI 2 (hw:1,8)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '5', 'name': 'HDA NVidia: HDMI 3 (hw:1,9)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '6', 'name': 'HDA NVidia: HDMI 0 (hw:2,3)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '7', 'name': 'HDA NVidia: HDMI 1 (hw:2,7)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '8', 'name': 'HDA NVidia: HDMI 2 (hw:2,8)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '9', 'name': 'HDA NVidia: HDMI 3 (hw:2,9)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '10', 'name': 'Logitech USB Headset: Audio (hw:3,0)', 'defaultSampleRate': '44100.0', 'maxInputChannels': '1' 'index': '11', 'name': 'sysdefault', 'defaultSampleRate': '48000.0', 'maxInputChannels': '128' 'index': '12', 'name': 'front', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '13', 'name': 'surround21', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '14', 'name': 'surround40', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '15', 'name': 'surround41', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '16', 'name': 'surround50', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '17', 'name': 'surround51', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '18', 'name': 'surround71', 'defaultSampleRate': '44100.0', 'maxInputChannels': '0' 'index': '19', 'name': 'pulse', 'defaultSampleRate': '44100.0', 'maxInputChannels': '32' 'index': '20', 'name': 'dmix', 'defaultSampleRate': '48000.0', 'maxInputChannels': '0' 'index': '21', 'name': 'default', 'defaultSampleRate': '44100.0', 'maxInputChannels': '32' `

It can be seen that the last device (index 21) is considered default. But on this machine, a headset is being used as the input device which has an index of 10. After finding the correct index the demo application can be invoked as below

`bash pvporcupinedemo_mic --keywords picovoice --audio_device_index 10 `

If the problem persists we suggest storing the recorded audio into a file for inspection. This can be achieved by

`bash pvporcupinedemo_mic --keywords picovoice --input_audio_device_index 10 --audio_device_index 10 --output_path ~/test.wav `

If after listening to stored file there is no apparent problem detected please open an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pvporcupinedemo, version 1.8.2
Filename, size File type Python version Upload date Hashes
Filename, size pvporcupinedemo-1.8.2.tar.gz (10.1 kB) File type Source Python version None Upload date Hashes View
Filename, size pvporcupinedemo-1.8.2-py3-none-any.whl (14.3 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page