xybrid-core 0.1.0

Core runtime for hybrid cloud-edge AI inference: model execution, pipeline orchestration, and routing primitives.
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
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
413
414
415
416
417
418
419
420
421
422
423
424
//! Audio buffer for streaming ASR.
//!
//! Manages audio chunks with ring buffer semantics for efficient
//! streaming inference.

use std::collections::VecDeque;
use std::time::{Duration, Instant};

/// Configuration for audio buffering.
#[derive(Debug, Clone)]
pub struct AudioBufferConfig {
    /// Sample rate of audio (default: 16000 Hz for ASR)
    pub sample_rate: u32,
    /// Chunk duration for processing (default: 30s for Whisper)
    pub chunk_duration_secs: f32,
    /// Overlap between chunks for continuity (default: 1s)
    pub overlap_secs: f32,
    /// Maximum buffer duration before oldest samples are discarded
    pub max_buffer_secs: f32,
}

impl Default for AudioBufferConfig {
    fn default() -> Self {
        Self {
            sample_rate: 16000,
            chunk_duration_secs: 30.0, // Whisper's 30-second window
            overlap_secs: 1.0,         // 1 second overlap for continuity
            max_buffer_secs: 120.0,    // 2 minutes max buffer
        }
    }
}

impl AudioBufferConfig {
    /// Create config for Whisper ASR (30s chunks, 16kHz)
    pub fn whisper() -> Self {
        Self::default()
    }

    /// Create config for Wav2Vec2 ASR (shorter chunks, 16kHz)
    pub fn wav2vec2() -> Self {
        Self {
            sample_rate: 16000,
            chunk_duration_secs: 10.0, // Wav2Vec2 works better with shorter chunks
            overlap_secs: 0.5,
            max_buffer_secs: 60.0,
        }
    }

    /// Samples per chunk
    pub fn chunk_samples(&self) -> usize {
        (self.sample_rate as f32 * self.chunk_duration_secs) as usize
    }

    /// Overlap samples
    pub fn overlap_samples(&self) -> usize {
        (self.sample_rate as f32 * self.overlap_secs) as usize
    }

    /// Maximum buffer samples
    pub fn max_buffer_samples(&self) -> usize {
        (self.sample_rate as f32 * self.max_buffer_secs) as usize
    }
}

/// A chunk of audio ready for processing.
#[derive(Debug, Clone)]
pub struct AudioChunk {
    /// PCM samples (f32, mono)
    pub samples: Vec<f32>,
    /// Timestamp when this chunk starts (relative to stream start)
    pub start_time: Duration,
    /// Timestamp when this chunk ends
    pub end_time: Duration,
    /// Sequence number for ordering
    pub sequence: u64,
    /// Whether this is the final chunk (stream ended)
    pub is_final: bool,
}

impl AudioChunk {
    /// Duration of this chunk
    pub fn duration(&self) -> Duration {
        self.end_time - self.start_time
    }

    /// Number of samples
    pub fn len(&self) -> usize {
        self.samples.len()
    }

    /// Check if empty
    pub fn is_empty(&self) -> bool {
        self.samples.is_empty()
    }
}

/// Ring buffer for streaming audio with chunk extraction.
#[derive(Debug)]
pub struct AudioBuffer {
    /// Configuration
    config: AudioBufferConfig,
    /// Sample buffer (ring buffer)
    samples: VecDeque<f32>,
    /// Total samples received (for timing)
    total_samples_received: u64,
    /// Samples already processed (for chunk extraction)
    samples_processed: u64,
    /// Next chunk sequence number
    next_sequence: u64,
    /// Stream start time
    stream_start: Instant,
    /// Whether the stream has ended
    stream_ended: bool,
}

impl AudioBuffer {
    /// Create a new audio buffer with default configuration.
    pub fn new() -> Self {
        Self::with_config(AudioBufferConfig::default())
    }

    /// Create a new audio buffer with custom configuration.
    pub fn with_config(config: AudioBufferConfig) -> Self {
        Self {
            samples: VecDeque::with_capacity(config.max_buffer_samples()),
            config,
            total_samples_received: 0,
            samples_processed: 0,
            next_sequence: 0,
            stream_start: Instant::now(),
            stream_ended: false,
        }
    }

    /// Push audio samples into the buffer.
    ///
    /// # Arguments
    ///
    /// * `samples` - PCM samples (f32, mono, at configured sample rate)
    pub fn push(&mut self, samples: &[f32]) {
        // Add samples to buffer
        for &sample in samples {
            // If buffer is full, remove oldest samples
            if self.samples.len() >= self.config.max_buffer_samples() {
                self.samples.pop_front();
                // Increment processed to maintain timing
                if self.samples_processed < self.total_samples_received {
                    self.samples_processed += 1;
                }
            }
            self.samples.push_back(sample);
        }
        self.total_samples_received += samples.len() as u64;
    }

    /// Mark the stream as ended (no more samples will arrive).
    pub fn end_stream(&mut self) {
        self.stream_ended = true;
    }

    /// Check if stream has ended.
    pub fn is_ended(&self) -> bool {
        self.stream_ended
    }

    /// Get the number of unprocessed samples available.
    pub fn available_samples(&self) -> usize {
        let processed_in_buffer = self
            .samples_processed
            .saturating_sub(self.total_samples_received - self.samples.len() as u64);
        self.samples
            .len()
            .saturating_sub(processed_in_buffer as usize)
    }

    /// Check if a full chunk is ready for processing.
    pub fn has_chunk_ready(&self) -> bool {
        self.available_samples() >= self.config.chunk_samples()
    }

    /// Check if any audio is available (for final flush).
    pub fn has_audio(&self) -> bool {
        self.available_samples() > 0
    }

    /// Extract the next chunk for processing.
    ///
    /// Returns `None` if not enough samples are available.
    /// Use `force = true` to get a partial chunk (e.g., at end of stream).
    pub fn extract_chunk(&mut self, force: bool) -> Option<AudioChunk> {
        let available = self.available_samples();
        let chunk_size = self.config.chunk_samples();

        // Check if we have enough samples (or forcing partial chunk)
        if !force && available < chunk_size {
            return None;
        }

        if available == 0 {
            return None;
        }

        // Calculate how many samples to extract
        let extract_size = if force {
            available.min(chunk_size)
        } else {
            chunk_size
        };

        // Calculate timing
        let sample_rate = self.config.sample_rate as f64;
        let start_sample = self.samples_processed;
        let start_time = Duration::from_secs_f64(start_sample as f64 / sample_rate);
        let end_time =
            Duration::from_secs_f64((start_sample + extract_size as u64) as f64 / sample_rate);

        // Extract samples (keeping overlap)
        let overlap = self.config.overlap_samples();
        let samples: Vec<f32> = self
            .samples
            .iter()
            .skip(self.get_buffer_offset())
            .take(extract_size)
            .copied()
            .collect();

        // Advance processed counter (minus overlap for next chunk)
        let advance = if force {
            extract_size // No overlap on final chunk
        } else {
            extract_size.saturating_sub(overlap)
        };
        self.samples_processed += advance as u64;

        // Create chunk
        let chunk = AudioChunk {
            samples,
            start_time,
            end_time,
            sequence: self.next_sequence,
            is_final: force && self.stream_ended,
        };

        self.next_sequence += 1;

        Some(chunk)
    }

    /// Flush remaining audio as a final chunk.
    pub fn flush(&mut self) -> Option<AudioChunk> {
        if !self.has_audio() {
            return None;
        }
        self.extract_chunk(true)
    }

    /// Reset the buffer state.
    pub fn reset(&mut self) {
        self.samples.clear();
        self.total_samples_received = 0;
        self.samples_processed = 0;
        self.next_sequence = 0;
        self.stream_start = Instant::now();
        self.stream_ended = false;
    }

    /// Get buffer statistics.
    pub fn stats(&self) -> AudioBufferStats {
        AudioBufferStats {
            total_received: self.total_samples_received,
            total_processed: self.samples_processed,
            buffer_size: self.samples.len(),
            available: self.available_samples(),
            chunks_extracted: self.next_sequence,
            elapsed: self.stream_start.elapsed(),
        }
    }

    /// Get current buffer offset for extraction.
    fn get_buffer_offset(&self) -> usize {
        // Calculate offset into buffer for unprocessed samples
        let buffer_start_sample = self
            .total_samples_received
            .saturating_sub(self.samples.len() as u64);
        self.samples_processed.saturating_sub(buffer_start_sample) as usize
    }

    /// Get the configuration.
    pub fn config(&self) -> &AudioBufferConfig {
        &self.config
    }
}

impl Default for AudioBuffer {
    fn default() -> Self {
        Self::new()
    }
}

/// Statistics about the audio buffer state.
#[derive(Debug, Clone)]
pub struct AudioBufferStats {
    /// Total samples received
    pub total_received: u64,
    /// Total samples processed (sent to inference)
    pub total_processed: u64,
    /// Current buffer size
    pub buffer_size: usize,
    /// Available unprocessed samples
    pub available: usize,
    /// Number of chunks extracted
    pub chunks_extracted: u64,
    /// Time elapsed since stream start
    pub elapsed: Duration,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_buffer_config_defaults() {
        let config = AudioBufferConfig::default();
        assert_eq!(config.sample_rate, 16000);
        assert_eq!(config.chunk_duration_secs, 30.0);
        assert_eq!(config.chunk_samples(), 480000); // 30s * 16000
    }

    #[test]
    fn test_buffer_push() {
        let mut buffer = AudioBuffer::new();
        let samples = vec![0.1, 0.2, 0.3];
        buffer.push(&samples);

        assert_eq!(buffer.available_samples(), 3);
        assert!(!buffer.has_chunk_ready()); // Need 480000 samples
    }

    #[test]
    fn test_buffer_extract_forced() {
        let mut buffer = AudioBuffer::new();
        let samples: Vec<f32> = (0..1000).map(|i| i as f32 / 1000.0).collect();
        buffer.push(&samples);
        buffer.end_stream();

        // Force extract partial chunk
        let chunk = buffer.extract_chunk(true).unwrap();
        assert_eq!(chunk.samples.len(), 1000);
        assert!(chunk.is_final);
        assert_eq!(chunk.sequence, 0);
    }

    #[test]
    fn test_buffer_full_chunk() {
        let config = AudioBufferConfig {
            sample_rate: 16000,
            chunk_duration_secs: 0.1, // 100ms = 1600 samples
            overlap_secs: 0.01,       // 10ms = 160 samples overlap
            max_buffer_secs: 1.0,
        };
        let mut buffer = AudioBuffer::with_config(config);

        // Push enough for one chunk
        let samples: Vec<f32> = (0..1600).map(|i| i as f32 / 1600.0).collect();
        buffer.push(&samples);

        assert!(buffer.has_chunk_ready());

        let chunk = buffer.extract_chunk(false).unwrap();
        assert_eq!(chunk.samples.len(), 1600);
        assert_eq!(chunk.sequence, 0);
        assert!(!chunk.is_final);
    }

    #[test]
    fn test_buffer_overlap() {
        let config = AudioBufferConfig {
            sample_rate: 1000, // Simplified for testing
            chunk_duration_secs: 1.0,
            overlap_secs: 0.2, // 200 sample overlap
            max_buffer_secs: 10.0,
        };
        let mut buffer = AudioBuffer::with_config(config);

        // Push 2 chunks worth
        let samples: Vec<f32> = (0..2000).map(|i| i as f32).collect();
        buffer.push(&samples);

        // Extract first chunk
        let chunk1 = buffer.extract_chunk(false).unwrap();
        assert_eq!(chunk1.samples.len(), 1000);

        // Second chunk should start 200 samples before end of first (overlap)
        let chunk2 = buffer.extract_chunk(false).unwrap();
        assert_eq!(chunk2.samples.len(), 1000);
        // First sample of chunk2 should be sample 800 (1000 - 200 overlap)
        assert_eq!(chunk2.samples[0], 800.0);
    }

    #[test]
    fn test_buffer_reset() {
        let mut buffer = AudioBuffer::new();
        buffer.push(&[1.0, 2.0, 3.0]);

        buffer.reset();

        assert_eq!(buffer.available_samples(), 0);
        assert!(!buffer.has_audio());
    }

    #[test]
    fn test_chunk_duration() {
        let chunk = AudioChunk {
            samples: vec![0.0; 16000],
            start_time: Duration::from_secs(0),
            end_time: Duration::from_secs(1),
            sequence: 0,
            is_final: false,
        };

        assert_eq!(chunk.duration(), Duration::from_secs(1));
        assert_eq!(chunk.len(), 16000);
    }
}