rustPorcupine — Rust Quick Start

Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)
  • BeagleBone
  • NVIDIA Jetson Nano
  • Raspberry Pi (Zero, 2, 3, 4)

Requirements

Picovoice Account & AccessKey

  1. Login or signup for a free account on the Picovoice Console.
  2. Go to the AccessKey tab to create one or use an existing AccessKey. Be sure to keep your AccessKey secret.

Quick Start

Setup

  1. Download and install Rust.

  2. Add pv_porcupine to the Cargo.toml manifest:

[dependencies]
pv_porcupine = "*"

Usage

Create an instance of Porcupine that detects the included built-in wake words porcupine and bumblebee:

use porcupine::{Porcupine, BuiltinKeywords, PorcupineBuilder};
let porcupine: Porcupine = PorcupineBuilder::new_with_keywords(
"${ACCESS_KEY}",
&[BuiltinKeywords::Porcupine, BuiltinKeywords::Bumblebee],
)
.init()
.expect("Unable to create Porcupine");

Pass in frames of audio to the .process function:

fn next_audio_frame() -> Vec<i16> {
// ..
}
loop {
let audio_frame: Vec<i16> = next_audio_frame();
if let Ok(keyword_index) = porcupine.process(&audio_frame) {
if keyword_index == 0 {
// `porcupine` detected
} else if keyword_index == 1 {
// `bumblebee` detected
}
}
}

Custom Keywords

Create custom keywords using the Picovoice Console. Download the custom wake word file (.ppn) and create an instance of Porcupine using the new_with_keyword_paths builder method:

let porcupine: Porcupine = PorcupineBuilder::new_with_keyword_paths(
"${ACCESS_KEY}",
&["${KEYWORD_FILE_PATH}"],
)
.init()
.expect("Unable to create Porcupine");

Non-English Languages

Use the corresponding model file (.pv) to detect non-English wake words. The model files for all supported languages are available on the Porcupine GitHub repository.

Pass in the model file using the model_path builder method to change the detection language:

let porcupine: Porcupine = PorcupineBuilder::new_with_keyword_paths(
"${ACCESS_KEY}",
&["${KEYWORD_FILE_PATH}"],
)
.model_path("${MODEL_FILE_PATH}")
.init()
.expect("Unable to create Porcupine");

Demo

For the Porcupine Rust SDK, we offer demo applications that demonstrate how to use the Wake Word engine on real-time audio streams (i.e. microphone input) and audio files.

Setup

Clone the Porcupine GitHub Repository:

git clone --recurse-submodules https://github.com/Picovoice/porcupine.git

Usage

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

cd porcupine/demo/rust/micdemo
cargo run --release -- --help

Ensure you have a working microphone connected to your system and run the following command to detect the built-in keyword porcupine:

cargo run --release -- --access_key "${ACCESS_KEY}" --keywords porcupine

For more information on our Porcupine demos for Rust, head over to our GitHub repository.

Resources

Packages

API

GitHub

Benchmark


Issue with this doc? Please let us know.