go

Picovoice Go Demos

This Go module contains demos for processing real-time audio (i.e. microphone) and audio files using the Picovoice Platform.

Requirements

• go 1.16+
• Windows: The Go binding requires cgo, which means that you need to install a gcc compiler like Mingw to build
  • Go versions less than 1.20 requires gcc version 11 or lower

Compatibility

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• Raspberry Pi:
  • Zero
  • 2
  • 3 (32 and 64 bit)
  • 4 (32 and 64 bit)
• NVIDIA Jetson Nano
• BeagleBone

AccessKey

Picovoice requires a valid Picovoice AccessKey at initialization. AccessKey acts as your credentials when using Picovoice 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

NOTE: The working directory for the following go commands is:

cd picovoice/demo/go

File Demo

It allows testing Picovoice on a corpus of audio files. The demo is mainly useful for quantitative performance benchmarking. It accepts 16kHz audio files. Picovoice 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 the wake phrase defined in the file passed to the -keyword_path argument and then infers the follow-on spoken command using the context defined by the file passed to the -context_path argument:

go run filedemo/picovoice_file_demo.go \
-input_audio_path "path/to/input.wav" \
-access_key ${ACCESS_KEY} \
-keyword_path "/path/to/keyword.ppn" \
-context_path "/path/to/context.rhn"

To see all available arguments, use the -h flag:

go run filedemo/picovoice_file_demo.go -h

Microphone Demo

It opens an audio stream from a microphone and detects utterances of a give wake word(s). The following processes incoming audio from the microphone for instances of the wake phrase defined in the file passed to the -keyword_path argument and then infers the follow-on spoken command using the context defined by the file passed to the -context_path argument. Upon completion of the spoken command inference it resumes wake word detection.

go run micdemo/picovoice_mic_demo.go \
-access_key ${ACCESS_KEY} \
-keyword_path "/path/to/keyword.ppn" \
-context_path "/path/to/context.rhn"

To see all available arguments, use the -h flag:

go run micdemo/picovoice_mic_demo.go -h

It is possible that the default audio input device is not the one you wish to use. There are a couple of debugging facilities baked into the demo application to solve this. First, type the following into the console:

go run micdemo/picovoice_mic_demo.go -show_audio_devices

It provides information about various audio input devices on the box. Here is an example output:

index: 0, device name: USB Audio Device
index: 1, device name: MacBook Air Microphone

You can use the device index to specify which microphone to use for the demo. For instance, if you want to use the USB Audio Device in the above example, you can invoke the demo application as below:

go run micdemo/picovoice_mic_demo.go \
-access_key ${ACCESS_KEY} \
-keyword_path "/path/to/keyword.ppn" \
-context_path "/path/to/context.rhn" \
-audio_device_index 0

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

go run micdemo/picovoice_mic_demo.go \
-access_key ${ACCESS_KEY} \
-context_path "/path/to/context.rhn" \
-keyword_path "/path/to/keyword.ppn" \
-audio_device_index 0 \
-output_path ./test.wav

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