brainwires-hardware 0.8.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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

#![deny(missing_docs)]
//! # brainwires-hardware — audio module
//!
//! Audio capture, playback, speech-to-text, and text-to-speech for the
//! Brainwires Agent Framework.

/// Ring buffer for streaming audio data.
pub mod buffer;
/// Audio capture trait and implementations.
pub mod capture;
/// Audio device enumeration and selection.
pub mod device;
/// Error types for audio operations.
pub mod error;
/// Audio playback trait and implementations.
pub mod playback;
/// Speech-to-text trait and implementations.
pub mod stt;
/// Text-to-speech trait and implementations.
pub mod tts;
/// Core audio types, configs, and data structures.
pub mod types;
/// WAV encoding and decoding utilities.
pub mod wav;

/// Native hardware audio backends using cpal.
#[cfg(feature = "audio")]
pub mod hardware;

/// Cloud API integrations (STT/TTS providers).
#[cfg(feature = "audio")]
pub mod api;

/// FLAC encoding utilities.
#[cfg(feature = "flac")]
pub mod flac;

/// Local inference backends (whisper.cpp via whisper-rs).
#[cfg(feature = "local-stt")]
pub mod local;

/// Voice Activity Detection — EnergyVad (always available) + WebRtcVad (`vad` feature).
pub mod vad;

/// Wake word detection — `EnergyTriggerDetector` (`wake-word`), `RustpotterDetector` (`wake-word-rustpotter`), `PorcupineDetector` (`wake-word-porcupine`).
#[cfg(any(
    feature = "wake-word",
    feature = "wake-word-rustpotter",
    feature = "wake-word-porcupine"
))]
pub mod wake_word;

/// Voice Assistant pipeline — orchestrates capture → wake word → VAD → STT → handler → TTS.
#[cfg(feature = "voice-assistant")]
pub mod assistant;

// Re-exports
pub use buffer::AudioRingBuffer;
pub use capture::AudioCapture;
pub use device::{AudioDevice, DeviceDirection};
pub use error::{AudioError, AudioResult};
pub use playback::AudioPlayback;
pub use stt::SpeechToText;
pub use tts::TextToSpeech;
pub use types::{
    AudioBuffer, AudioConfig, OutputFormat, SampleFormat, SttOptions, Transcript,
    TranscriptSegment, TtsOptions, Voice,
};
pub use wav::{decode_wav, encode_wav};

#[cfg(feature = "audio")]
pub use api::{
    AzureStt, AzureTts, CartesiaTts, DeepgramStt, DeepgramTts, ElevenLabsStt, ElevenLabsTts,
    FishStt, FishTts, GoogleTts, MurfTts, OpenAiResponsesStt, OpenAiResponsesTts, OpenAiStt,
    OpenAiTts,
};
#[cfg(feature = "flac")]
pub use flac::{decode_flac, encode_flac};
#[cfg(feature = "audio")]
pub use hardware::{CpalCapture, CpalPlayback};
#[cfg(feature = "local-stt")]
pub use local::WhisperStt;

// ── VAD re-exports ────────────────────────────────────────────────────────────
pub use vad::{EnergyVad, SpeechSegment, VoiceActivityDetector};
#[cfg(feature = "vad")]
pub use vad::{VadMode, WebRtcVad};

// ── Wake word re-exports ──────────────────────────────────────────────────────
#[cfg(feature = "wake-word-porcupine")]
pub use wake_word::PorcupineDetector;
#[cfg(feature = "wake-word-rustpotter")]
pub use wake_word::RustpotterDetector;
#[cfg(any(
    feature = "wake-word",
    feature = "wake-word-rustpotter",
    feature = "wake-word-porcupine"
))]
pub use wake_word::{EnergyTriggerDetector, WakeWordDetection, WakeWordDetector};

// ── Voice assistant re-exports ────────────────────────────────────────────────
#[cfg(feature = "voice-assistant")]
pub use assistant::{
    AssistantState, VoiceAssistant, VoiceAssistantBuilder, VoiceAssistantConfig,
    VoiceAssistantHandler,
};