brainwires-hardware 0.10.0

Hardware I/O for the Brainwires Agent Framework — audio, GPIO, Bluetooth, and network
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Wake word detection for the voice assistant pipeline.
//!
//! A wake word is a short phrase (e.g. "hey assistant", "ok computer") that
//! activates the voice assistant from idle. Two backends are supported:
//!
//! - `RustpotterDetector` — pure-Rust, Apache 2.0, no native deps.
//!   Uses DTW or ONNX neural models (`.rpw` files). Feature: `wake-word`.
//!
//! - `PorcupineDetector` — Picovoice Porcupine, maximum accuracy.
//!   Requires a free AccessKey and the native Porcupine library.
//!   Feature: `wake-word-porcupine`.
//!
//! ## Quick start
//!
//! ```rust,no_run,ignore
//! use brainwires_hardware::audio::wake_word::{RustpotterDetector, WakeWordDetector};
//!
//! // Load a .rpw model (record samples with rustpotter-cli to create one)
//! let mut detector = RustpotterDetector::from_model_file("hey_assistant.rpw", 0.5).unwrap();
//! println!("Feed {} i16 samples per frame", detector.frame_size());
//! ```

/// Energy-burst wake trigger — zero-dependency fallback.
pub mod energy_trigger;
#[cfg(feature = "wake-word-porcupine")]
pub mod porcupine;
#[cfg(feature = "wake-word-rustpotter")]
pub mod rustpotter;

pub use self::energy_trigger::EnergyTriggerDetector;
#[cfg(feature = "wake-word-porcupine")]
pub use self::porcupine::PorcupineDetector;
#[cfg(feature = "wake-word-rustpotter")]
pub use self::rustpotter::RustpotterDetector;

/// A wake word detection event.
#[derive(Debug, Clone)]
pub struct WakeWordDetection {
    /// The name of the matched keyword (from the model file).
    pub keyword: String,
    /// Detection confidence score, 0.0–1.0.
    pub score: f32,
    /// Milliseconds since the detector was created.
    pub timestamp_ms: u64,
}

/// A stateful detector that processes fixed-size audio frames and fires on
/// keyword detection.
///
/// All implementations expect 16 kHz mono i16 PCM. Use
/// [`crate::audio::vad::pcm_to_i16_mono`] to convert an `AudioBuffer` first.
pub trait WakeWordDetector: Send + Sync {
    /// The sample rate this detector expects (always 16 000 Hz).
    fn sample_rate(&self) -> u32;

    /// Number of i16 samples that must be provided per `process_frame` call.
    fn frame_size(&self) -> usize;

    /// Process one audio frame. Returns `Some(detection)` when the wake word
    /// is detected in the provided frame.
    fn process_frame(&mut self, samples: &[i16]) -> Option<WakeWordDetection>;
}