yo-esp 0.1.5

ESP32-S3 client for the yo voice assistant framework (no_std + alloc)
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
#![no_std]

use defmt::{info, debug, error};
use defmt::Debug2Format;
use esp_hal::i2s::master::{I2sRx, I2sTx, asynch::{I2sReadDmaTransferAsync, I2sWriteDmaTransferAsync}};
use esp_hal::Async;
use alloc::vec::Vec;
use alloc::vec;
use alloc::boxed::Box;
use embassy_net::{Stack, tcp::TcpSocket, IpAddress};
use embassy_time::{Duration, Timer, Instant};
use embassy_futures::select::{select, Either};
use embassy_sync::blocking_mutex::raw::CriticalSectionRawMutex;
use embassy_sync::pipe::Pipe;
use core::net::SocketAddr;
use core::future::Future;
use core::pin::Pin;
use libm::sqrtf;

extern crate alloc;

const STEREO_SAMPLES_PER_READ: usize = 256;
const MONO_SAMPLES_PER_READ: usize = STEREO_SAMPLES_PER_READ / 2;
/// MUST MATCH WAKE WORD CHUNK SIZE
pub const OWW_MODEL_CHUNK_SIZE: usize = 1280;


const TCP_RX_BUF_SIZE: usize = 1024;
const TCP_TX_BUF_SIZE: usize = 4096;

pub const SPEAKER_DMA_BUFFER_SIZE: usize = 16368;

const STEREO_SAMPLES_PER_WRITE: usize = 256;
const PLAYBACK_TCP_RX_BUF_SIZE: usize = 4096;
const PLAYBACK_TCP_TX_BUF_SIZE: usize = 2048;
const RING_BUFFER_SIZE: usize = 16384;


fn rms_f32(samples: &[f32]) -> f32 {
    if samples.is_empty() {
        return 0.0;
    }
    let sum_squares: f32 = samples.iter().map(|&x| x * x).sum();
    sqrtf(sum_squares / samples.len() as f32)
}

pub struct Microphone {
    i2s_rx: I2sRx<'static, Async>,
    stereo_buffer: [u8; STEREO_SAMPLES_PER_READ * 2],
    mono_i16: [i16; MONO_SAMPLES_PER_READ],
    mono_f32: [f32; MONO_SAMPLES_PER_READ],
    accum_buffer: Vec<f32>,
    silent: bool,
}

impl Microphone {
    pub fn new(i2s_rx: I2sRx<'static, Async>) -> Self {
        Self {
            i2s_rx,
            stereo_buffer: [0u8; STEREO_SAMPLES_PER_READ * 2],
            mono_i16: [0i16; MONO_SAMPLES_PER_READ],
            mono_f32: [0f32; MONO_SAMPLES_PER_READ],
            accum_buffer: Vec::with_capacity(OWW_MODEL_CHUNK_SIZE),
            silent: false,
        }
    }


    pub async fn read_chunk(&mut self) -> Result<(Vec<f32>, bool), ()> {
        while self.accum_buffer.len() < OWW_MODEL_CHUNK_SIZE {
            match self.i2s_rx.read_dma_async(&mut self.stereo_buffer).await {
                Ok(()) => {}
                Err(e) => {
                    defmt::error!("I2S read_dma_async failed: {}", Debug2Format(&e));
                    return Err(());
                }
            }

            #[cfg(debug_assertions)]
            {
                let stereo = unsafe {
                    core::slice::from_raw_parts(
                        self.stereo_buffer.as_ptr() as *const i16,
                        STEREO_SAMPLES_PER_READ,
                    )
                };
                info!("[MIC i16]: {:?}", &stereo[..8.min(stereo.len())]);
            }

            let stereo = unsafe {
                core::slice::from_raw_parts(
                    self.stereo_buffer.as_ptr() as *const i16,
                    STEREO_SAMPLES_PER_READ,
                )
            };

            for (i, chunk) in stereo.chunks(2).enumerate() {
                self.mono_i16[i] = ((chunk[0] as i32 + chunk[1] as i32) / 2) as i16;
            }

            for (i, &s) in self.mono_i16.iter().enumerate() {
                self.mono_f32[i] = s as f32 / 32768.0;
            }
            self.accum_buffer.extend_from_slice(&self.mono_f32[..MONO_SAMPLES_PER_READ]);
        }

        let chunk: Vec<f32> = self.accum_buffer.drain(..OWW_MODEL_CHUNK_SIZE).collect();

        let all_zero = chunk.iter().all(|&s| s == 0.0);
        if all_zero {
            if !self.silent {
                info!("🎙️⚠️ Mic zero zero zero!");
                self.silent = true;
            }
        } else if self.silent {
            info!("🎙️✅ Mic OK!");
            self.silent = false;
        }
        Ok((chunk, all_zero))
    }
}



pub trait CommandHandler {
    fn on_detected(&mut self) -> Pin<Box<dyn Future<Output = ()> + '_>>;
    fn on_thinking(&mut self) -> Pin<Box<dyn Future<Output = ()> + '_>>;
    fn on_executed(&mut self, elapsed_ms: Option<u64>) -> Pin<Box<dyn Future<Output = ()> + '_>>;
    fn on_failed(&mut self, elapsed_ms: Option<u64>) -> Pin<Box<dyn Future<Output = ()> + '_>>;
}




#[embassy_executor::task]
pub async fn audio_capture_task(
    i2s_rx: I2sRx<'static, Async>,
    stack: &'static Stack<'static>,
    remote_addr: SocketAddr,
    room: &'static str,
    mut handler: alloc::boxed::Box<dyn CommandHandler>,
) {
    let remote_endpoint = match remote_addr {
        SocketAddr::V4(v4) => (IpAddress::Ipv4(v4.ip().octets().into()), v4.port()),
        SocketAddr::V6(_) => {
            error!("IPv6 not supported");
            return;
        }
    };

    stack.wait_link_up().await;
    stack.wait_config_up().await;

    let mut mic = Microphone::new(i2s_rx);
    let room_bytes = room.as_bytes();
    let room_len = room_bytes.len() as u32;

    loop {
        let mut rx_buffer = [0u8; TCP_RX_BUF_SIZE];
        let mut tx_buffer = [0u8; TCP_TX_BUF_SIZE];
        let mut socket = TcpSocket::new(stack.clone(), &mut rx_buffer, &mut tx_buffer);
        socket.set_timeout(Some(Duration::from_secs(10)));

        if let Err(e) = socket.connect(remote_endpoint).await {
            error!("❌ connect error: {:?}, retrying in 15s", e);
            Timer::after(Duration::from_secs(15)).await;
            continue;
        }
        info!("📡 ☑️ 🎙️ to {}", remote_addr);

        let mut handshake_ok = true;
        let len_bytes = room_len.to_le_bytes();
        let mut written = 0;
        while written < len_bytes.len() {
            match socket.write(&len_bytes[written..]).await {
                Ok(n) => written += n,
                Err(e) => {
                    error!("handshake length fail: {:?}", e);
                    handshake_ok = false;
                    break;
                }
            }
        }
        if handshake_ok && room_len > 0 {
            let mut written = 0;
            while written < room_bytes.len() {
                match socket.write(&room_bytes[written..]).await {
                    Ok(n) => written += n,
                    Err(e) => {
                        error!("failed to send room name: {:?}", e);
                        handshake_ok = false;
                        break;
                    }
                }
            }
        }
        if let Err(e) = socket.flush().await {
            error!("failed to flush handshake: {:?}", e);
            handshake_ok = false;
        }
        if !handshake_ok {
            let _ = socket.close();
            Timer::after(Duration::from_secs(15)).await;
            continue;
        }

        let mut command_start: Option<Instant> = None;

        'stream: loop {
            let (chunk, _silent): (Vec<f32>, bool) = match mic.read_chunk().await {
                Ok(pair) => pair,
                Err(_) => {
                    error!("I2S read ERROR");
                    Timer::after(Duration::from_millis(10)).await;
                    continue;
                }
            };

            debug!("RMS: {}", rms_f32(&chunk));

            let mut chunk_buffer = vec![0u8; 4 + OWW_MODEL_CHUNK_SIZE * 4];
            chunk_buffer[0..4].copy_from_slice(&(OWW_MODEL_CHUNK_SIZE as u32).to_le_bytes());
            for (i, &sample) in chunk.iter().enumerate() {
                let offset = 4 + i * 4;
                chunk_buffer[offset..offset + 4].copy_from_slice(&sample.to_le_bytes());
            }

            let mut written = 0;
            while written < chunk_buffer.len() {
                match socket.write(&chunk_buffer[written..]).await {
                    Ok(n) => written += n,
                    Err(e) => {
                        error!("failed to send audio chunk: {:?}", e);
                        break 'stream;
                    }
                }
            }
            if let Err(e) = socket.flush().await {
                error!("Failed to flush! {:?}", e);
                break 'stream;
            }

            let mut byte_buf = [0u8; 1];
            let read_fut = socket.read(&mut byte_buf);
            let timeout_fut = Timer::after(Duration::from_millis(10));
            match select(read_fut, timeout_fut).await {
                embassy_futures::select::Either::First(Ok(1)) => {
                    match byte_buf[0] {
                        0x01 => {
                            info!("💥 DETECTED Wake Word!");
                            handler.on_detected().await;
                        }
                        0x02 => {
                            info!("🧠 THINKING...");
                            command_start = Some(Instant::now());
                            handler.on_thinking().await;
                        }
                        0x03 => {
                            let elapsed = command_start.map(|s| s.elapsed().as_millis());
                            if let Some(ms) = elapsed {
                                info!("✅ Executed command! Took {} ms", ms);
                            } else { info!("✅ Executed command!"); }
                            handler.on_executed(elapsed).await;
                            command_start = None;
                        }
                        0x04 => {
                            let elapsed = command_start.map(|s| s.elapsed().as_millis());
                            if let Some(ms) = elapsed {
                                info!("💩 FAILED execution ({} ms)", ms);
                            } else { info!("💩 FAILED execution!"); }
                            handler.on_failed(elapsed).await;
                            command_start = None;
                        }
                        _ => info!("Unexpected byte: 0x{:02x}", byte_buf[0]),
                    }
                }
                embassy_futures::select::Either::First(Ok(_)) => {}
                embassy_futures::select::Either::First(Err(e)) => {
                    error!("socket read error: {:?}", e);
                    break 'stream;
                }
                embassy_futures::select::Either::Second(_) => {}
            }
        }

        info!("❌ reconnecting to yo...");
        let _ = socket.close();
        Timer::after(Duration::from_secs(15)).await;
    }
}

static PIPE: Pipe<CriticalSectionRawMutex, RING_BUFFER_SIZE> = Pipe::new();


pub fn play(data: &[u8]) -> usize {
    PIPE.try_write(data).unwrap_or(0)
}


pub async fn play_sound(sound: &'static [u8]) {
    let mut offset = 0;
    while offset < sound.len() {
        let written = play(&sound[offset..]);
        if written == 0 {
            Timer::after(Duration::from_millis(1)).await;
        } else {
            offset += written;
        }
    }
}

#[cfg(feature = "sounds")]
const DING_SOUND: &[u8] =
    include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/assets/sound/ding_esp.raw"));
#[cfg(feature = "sounds")]
const DONE_SOUND: &[u8] =
    include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/assets/sound/done_esp.wav"));
#[cfg(feature = "sounds")]
const FAIL_SOUND: &[u8] =
    include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/assets/sound/fail_esp.wav"));

#[cfg(feature = "sounds")]
pub async fn play_ding() { play_sound(DING_SOUND).await; }
#[cfg(feature = "sounds")]
pub async fn play_done() { play_sound(DONE_SOUND).await; }
#[cfg(feature = "sounds")]
pub async fn play_fail() { play_sound(FAIL_SOUND).await; }


#[embassy_executor::task]
pub async fn speaker_task(
    mut transfer: I2sWriteDmaTransferAsync<'static, &'static mut [u8; SPEAKER_DMA_BUFFER_SIZE]>,
) -> ! {
    let mut pipe_buf = [0u8; 1024];
    let silence = [0u8; 256];

    loop {
        let free = transfer.available().await.unwrap();
        if free == 0 {
            Timer::after(Duration::from_micros(100)).await;
            continue;
        }

        let to_read = free.min(pipe_buf.len());
        let read_future = PIPE.read(&mut pipe_buf[..to_read]);
        let timeout = Timer::after(Duration::from_millis(2));

        match select(read_future, timeout).await {
            Either::First(n) if n > 0 => {
                let _ = transfer.push(&pipe_buf[..n]).await;
            }
            _ => {
                let mut remaining = free;
                while remaining > 0 {
                    let chunk = remaining.min(silence.len());
                    let _ = transfer.push(&silence[..chunk]).await;
                    remaining -= chunk;
                }
            }
        }
    }
}


#[embassy_executor::task]
pub async fn stream_speaker(
    stack: &'static Stack<'static>,
    listen_port: u16,
) {
    stack.wait_link_up().await;
    stack.wait_config_up().await;
    info!("📡 ☑️ 🔊 Listening on port {}", listen_port);

    loop {
        let mut rx_buffer = [0u8; PLAYBACK_TCP_RX_BUF_SIZE];
        let mut tx_buffer = [0u8; PLAYBACK_TCP_TX_BUF_SIZE];
        let mut socket = TcpSocket::new(stack.clone(), &mut rx_buffer, &mut tx_buffer);

        if let Err(e) = socket.accept(listen_port).await {
            error!("accept error: {:?}", e);
            Timer::after(Duration::from_secs(1)).await;
            continue;
        }

        info!("🔉 client connected");
        socket.set_timeout(Some(Duration::from_secs(30)));

        let mut buf = [0u8; 1024];
        loop {
            match socket.read(&mut buf).await {
                Ok(0) => break,
                Ok(n) => {
                    let mut written = 0;
                    while written < n {
                        let w = play(&buf[written..n]);
                        if w == 0 {
                            Timer::after(Duration::from_micros(500)).await;
                        } else {
                            written += w;
                        }
                    }
                }
                Err(e) => {
                    error!("read error: {:?}", e);
                    break;
                }
            }
        }
        info!("🔇 client disconnected");
        let _ = socket.close();
    }
}