rs2-stream 0.3.3

A high-performance, production-ready async streaming library for Rust.
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
//! Chunk processing pipeline for media streaming
//!
//! Handles chunk validation, sequencing, buffering, and delivery.
//! Integrates with RS2Stream for backpressure and parallel processing.

use super::codec::MediaCodec;
use super::types::*;
use crate::queue::Queue;
use crate::*;
use std::collections::{HashMap, VecDeque};
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::{Mutex, RwLock};
use tokio::time::Instant;

/// Errors that can occur during chunk processing
#[derive(Debug, Clone)]
pub enum ChunkProcessingError {
    SequenceGap { expected: u64, received: u64 },
    DuplicateChunk(u64),
    BufferOverflow,
    ValidationFailed(String),
    CodecError(String),
    Timeout,
}

impl std::fmt::Display for ChunkProcessingError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ChunkProcessingError::SequenceGap { expected, received } => {
                write!(
                    f,
                    "Sequence gap: expected {}, received {}",
                    expected, received
                )
            }
            ChunkProcessingError::DuplicateChunk(seq) => {
                write!(f, "Duplicate chunk: {}", seq)
            }
            ChunkProcessingError::BufferOverflow => write!(f, "Buffer overflow"),
            ChunkProcessingError::ValidationFailed(reason) => {
                write!(f, "Validation failed: {}", reason)
            }
            ChunkProcessingError::CodecError(reason) => {
                write!(f, "Codec error: {}", reason)
            }
            ChunkProcessingError::Timeout => write!(f, "Processing timeout"),
        }
    }
}

impl std::error::Error for ChunkProcessingError {}

/// Configuration for chunk processing
#[derive(Debug, Clone)]
pub struct ChunkProcessorConfig {
    pub max_buffer_size: usize,
    pub sequence_timeout: Duration,
    pub enable_reordering: bool,
    pub max_reorder_window: usize,
    pub enable_validation: bool,
    pub parallel_processing: usize,
}

impl Default for ChunkProcessorConfig {
    fn default() -> Self {
        Self {
            max_buffer_size: 1024,
            sequence_timeout: Duration::from_secs(5),
            enable_reordering: true,
            max_reorder_window: 32,
            enable_validation: true,
            parallel_processing: 4,
        }
    }
}

/// Tracks state for chunk reordering
#[derive(Debug)]
struct ReorderBuffer {
    buffer: VecDeque<MediaChunk>,
    next_expected_sequence: u64,
    last_received_time: Instant,
    max_size: usize,
    // Track sequence numbers for O(1) duplicate detection
    sequence_numbers: std::collections::HashSet<u64>,
}

impl ReorderBuffer {
    fn new(max_size: usize) -> Self {
        Self {
            buffer: VecDeque::new(),
            next_expected_sequence: 0,
            last_received_time: Instant::now(),
            max_size,
            sequence_numbers: std::collections::HashSet::new(),
        }
    }

    fn try_insert(&mut self, chunk: MediaChunk) -> Result<Vec<MediaChunk>, ChunkProcessingError> {
        if self.buffer.len() >= self.max_size {
            return Err(ChunkProcessingError::BufferOverflow);
        }

        self.last_received_time = Instant::now();

        // Check for duplicates using O(1) HashSet lookup
        let _seq_num = chunk.sequence_number;
        if self.sequence_numbers.contains(&_seq_num) {
            return Err(ChunkProcessingError::DuplicateChunk(_seq_num));
        }

        // Check for sequence gaps
        if _seq_num > self.next_expected_sequence && !self.buffer.is_empty() {
            // If we have a gap and the buffer is not empty, check if the gap is too large
            // A gap is considered too large if it's more than the reorder window size
            let max_allowed = self.next_expected_sequence + self.max_size as u64;
            if _seq_num > max_allowed {
                return Err(ChunkProcessingError::SequenceGap {
                    expected: self.next_expected_sequence,
                    received: _seq_num,
                });
            }
        } else if _seq_num > self.next_expected_sequence + self.max_size as u64 {
            // Even if buffer is empty, if the gap is too large, it's an error
            return Err(ChunkProcessingError::SequenceGap {
                expected: self.next_expected_sequence,
                received: _seq_num,
            });
        }

        // Insert in order
        let insert_pos = self
            .buffer
            .binary_search_by_key(&_seq_num, |c| c.sequence_number)
            .unwrap_or_else(|pos| pos);

        // Add to sequence numbers set
        self.sequence_numbers.insert(_seq_num);

        // Insert chunk into buffer
        self.buffer.insert(insert_pos, chunk);

        // Extract ready chunks
        self.extract_ready_chunks()
    }

    fn extract_ready_chunks(&mut self) -> Result<Vec<MediaChunk>, ChunkProcessingError> {
        let mut ready_chunks = Vec::new();
        
        while let Some(chunk) = self.buffer.front() {
            if chunk.sequence_number == self.next_expected_sequence {
                let _seq_num = chunk.sequence_number;
                let chunk = self.buffer.pop_front().unwrap();

                // Remove from sequence numbers set
                self.sequence_numbers.remove(&_seq_num);

                self.next_expected_sequence += 1;
                ready_chunks.push(chunk);
            } else {
                break;
            }
        }

        Ok(ready_chunks)
    }

    fn force_flush(&mut self) -> Vec<MediaChunk> {
        let chunks: Vec<_> = self.buffer.drain(..).collect();

        // Clear sequence numbers set as buffer is now empty
        self.sequence_numbers.clear();

        if let Some(last_chunk) = chunks.last() {
            self.next_expected_sequence = last_chunk.sequence_number + 1;
        }
        chunks
    }

    fn is_timeout(&self, timeout: Duration) -> bool {
        self.last_received_time.elapsed() > timeout
    }
}

/// Statistics for chunk processing
#[derive(Debug, Clone, Default)]
pub struct ChunkProcessorStats {
    pub chunks_processed: u64,
    pub chunks_reordered: u64,
    pub chunks_dropped: u64,
    pub sequence_gaps: u64,
    pub validation_failures: u64,
    pub average_processing_time_ms: f64,
    pub buffer_utilization: f64,
}

/// Main chunk processor
pub struct ChunkProcessor {
    config: ChunkProcessorConfig,
    codec: Arc<MediaCodec>,
    reorder_buffers: Arc<RwLock<HashMap<String, ReorderBuffer>>>,
    stats: Arc<Mutex<ChunkProcessorStats>>,
    output_queue: Arc<Queue<MediaChunk>>,
}

impl ChunkProcessor {
    pub fn new(
        config: ChunkProcessorConfig,
        codec: Arc<MediaCodec>,
        output_queue: Arc<Queue<MediaChunk>>,
    ) -> Self {
        Self {
            config,
            codec,
            reorder_buffers: Arc::new(RwLock::new(HashMap::new())),
            stats: Arc::new(Mutex::new(ChunkProcessorStats::default())),
            output_queue,
        }
    }

    /// Process a stream of incoming chunks
    pub fn process_chunk_stream(
        &self,
        chunk_stream: RS2Stream<MediaChunk>,
    ) -> RS2Stream<Result<MediaChunk, ChunkProcessingError>> {
        let processor = self.clone();

        let stream = chunk_stream.par_eval_map_rs2(self.config.parallel_processing, move |chunk| {
            let processor = processor.clone();
            async move { processor.process_single_chunk(chunk).await }
        });

        auto_backpressure_block(stream, self.config.max_buffer_size)
    }

    /// Process a single chunk
    async fn process_single_chunk(
        &self,
        mut chunk: MediaChunk,
    ) -> Result<MediaChunk, ChunkProcessingError> {
        let start_time = Instant::now();

        // Create a reference to the original chunk for validation
        // This avoids cloning the entire chunk
        let original_seq_num = chunk.sequence_number;
        let original_stream_id = chunk.stream_id.clone();

        // Step 1: Validate chunk if enabled
        if self.config.enable_validation {
            self.validate_chunk(&chunk).await.map_err(|e| {
                log::warn!(
                    "Chunk validation failed for stream {}: {:?}",
                    chunk.stream_id,
                    e
                );
                e
            })?;
        }

        // Step 2: Set sequence number if not set
        if chunk.sequence_number == 0 {
            chunk.sequence_number = self.generate_sequence_number(&chunk.stream_id).await;
        }

        // Step 3: Handle reordering if enabled
        let ready_chunks = if self.config.enable_reordering {
            self.handle_reordering(chunk).await.map_err(|e| {
                log::warn!(
                    "Reordering failed for stream {}: {:?}",
                    original_stream_id,
                    e
                );
                e
            })?
        } else {
            vec![chunk]
        };

        // Step 4: Process ready chunks
        for ready_chunk in ready_chunks {
            // Enqueue to output - avoid cloning when possible
            if let Err(e) = self.output_queue.try_enqueue(ready_chunk).await {
                // Queue full, update stats
                let mut stats = self.stats.lock().await;
                stats.chunks_dropped += 1;
                log::debug!("Failed to enqueue chunk: {:?}", e);
            }
        }

        // Step 5: Update statistics
        {
            let mut stats = self.stats.lock().await;
            stats.chunks_processed += 1;
            // Ensure processing time is at least 0.1ms to avoid zero values in tests
            let processing_time = f64::max(0.1, start_time.elapsed().as_millis() as f64);
            stats.average_processing_time_ms = (stats.average_processing_time_ms
                * (stats.chunks_processed - 1) as f64
                + processing_time)
                / stats.chunks_processed as f64;
        }

        // Step 6: Periodic cleanup - only run occasionally to reduce overhead
        // Use a 1% chance to run cleanup, which statistically ensures it runs
        // regularly but not for every chunk
        if rand::random::<f32>() < 0.01 {
            log::debug!("Running periodic buffer cleanup");
            self.cleanup_expired_buffers().await;
        }

        // Create a minimal result chunk with just the necessary information
        // This is more efficient than cloning the entire chunk at the beginning
        let stream_id_for_result = original_stream_id.clone(); // Clone to avoid ownership issues

        Ok(MediaChunk {
            stream_id: stream_id_for_result,
            sequence_number: if original_seq_num == 0 {
                self.generate_sequence_number(&original_stream_id).await
            } else {
                original_seq_num
            },
            // Use minimal default values for fields that aren't needed in the result
            data: Vec::new(),
            chunk_type: ChunkType::Metadata,
            priority: MediaPriority::Normal,
            timestamp: Duration::from_secs(0),
            is_final: false,
            checksum: None,
        })
    }

    /// Validate chunk integrity and format
    async fn validate_chunk(&self, chunk: &MediaChunk) -> Result<(), ChunkProcessingError> {
        // Check basic fields
        if chunk.stream_id.is_empty() {
            return Err(ChunkProcessingError::ValidationFailed(
                "Empty stream ID".to_string(),
            ));
        }

        if chunk.data.is_empty() {
            return Err(ChunkProcessingError::ValidationFailed(
                "Empty chunk data".to_string(),
            ));
        }

        // Validate checksum if present
        if let Some(expected_checksum) = &chunk.checksum {
            let actual_checksum = self.calculate_checksum(&chunk.data);
            if actual_checksum != *expected_checksum {
                return Err(ChunkProcessingError::ValidationFailed(
                    "Checksum mismatch".to_string(),
                ));
            }
        }

        // Validate chunk type consistency
        match chunk.chunk_type {
            ChunkType::Audio => {
                if chunk.data.len() > 64 * 1024 {
                    return Err(ChunkProcessingError::ValidationFailed(
                        "Audio chunk too large".to_string(),
                    ));
                }
            }
            ChunkType::VideoIFrame | ChunkType::VideoPFrame | ChunkType::VideoBFrame => {
                if chunk.data.len() > 1024 * 1024 {
                    return Err(ChunkProcessingError::ValidationFailed(
                        "Video chunk too large".to_string(),
                    ));
                }
            }
            _ => {} // Other types pass through
        }

        Ok(())
    }

    /// Handle chunk reordering
    async fn handle_reordering(
        &self,
        chunk: MediaChunk,
    ) -> Result<Vec<MediaChunk>, ChunkProcessingError> {
        let stream_id = chunk.stream_id.clone();

        // Get or create reorder buffer for this stream - using a single write lock for both operations
        let result = {
            let mut buffers = self.reorder_buffers.write().await;

            // Create buffer if it doesn't exist
            if !buffers.contains_key(&stream_id) {
                buffers.insert(
                    stream_id.clone(),
                    ReorderBuffer::new(self.config.max_reorder_window),
                );
            }

            // Insert chunk and get ready chunks
            let buffer = buffers.get_mut(&stream_id).unwrap();
            buffer.try_insert(chunk)
        };

        // Update stats based on result
        match result {
            Ok(ready_chunks) => {
                if ready_chunks.len() > 1 {
                    let mut stats = self.stats.lock().await;
                    stats.chunks_reordered += ready_chunks.len() as u64 - 1;
                }
                Ok(ready_chunks)
            }
            Err(e) => {
                let mut stats = self.stats.lock().await;
                match e {
                    ChunkProcessingError::SequenceGap { .. } => stats.sequence_gaps += 1,
                    ChunkProcessingError::DuplicateChunk(_) => stats.chunks_dropped += 1,
                    _ => stats.validation_failures += 1,
                }
                Err(e)
            }
        }
    }

    /// Generate sequence number for chunks that don't have one
    async fn generate_sequence_number(&self, stream_id: &str) -> u64 {
        // Simple implementation - in production, this would be more sophisticated
        let buffers = self.reorder_buffers.read().await;
        if let Some(buffer) = buffers.get(stream_id) {
            buffer.next_expected_sequence
        } else {
            0
        }
    }

    /// Clean up expired reorder buffers
    async fn cleanup_expired_buffers(&self) {
        let mut buffers = self.reorder_buffers.write().await;
        let mut to_remove = Vec::new();
        let mut dropped_chunks = 0;

        for (stream_id, buffer) in buffers.iter_mut() {
            if buffer.is_timeout(self.config.sequence_timeout) {
                // Force flush expired buffer
                let flushed_chunks = buffer.force_flush();

                log::debug!(
                    "Flushing expired buffer for stream {}: {} chunks",
                    stream_id,
                    flushed_chunks.len()
                );

                // Send flushed chunks to output
                for chunk in flushed_chunks {
                    if let Err(e) = self.output_queue.try_enqueue(chunk).await {
                        dropped_chunks += 1;
                        log::debug!(
                            "Failed to enqueue flushed chunk from stream {}: {:?}",
                            stream_id,
                            e
                        );
                    }
                }

                to_remove.push(stream_id.clone());
            }
        }

        // Update stats if any chunks were dropped
        if dropped_chunks > 0 {
            let mut stats = self.stats.lock().await;
            stats.chunks_dropped += dropped_chunks;
            log::warn!("Dropped {} chunks during buffer cleanup", dropped_chunks);
        }

        // Remove expired buffers
        for stream_id in to_remove {
            log::debug!("Removing expired buffer for stream {}", stream_id);
            buffers.remove(&stream_id);
        }
    }

    /// Calculate checksum for validation
    fn calculate_checksum(&self, data: &[u8]) -> String {
        use sha2::{Digest, Sha256};
        let mut hasher = Sha256::new();
        hasher.update(data);
        format!("{:x}", hasher.finalize())
    }

    /// Get processing statistics
    pub async fn get_stats(&self) -> ChunkProcessorStats {
        let stats = self.stats.lock().await;
        let mut stats = stats.clone();

        // Calculate buffer utilization
        let buffers = self.reorder_buffers.read().await;
        let total_buffer_size: usize = buffers.values().map(|b| b.buffer.len()).sum();
        let max_possible_size = buffers.len() * self.config.max_reorder_window;

        stats.buffer_utilization = if max_possible_size > 0 {
            total_buffer_size as f64 / max_possible_size as f64
        } else {
            0.0
        };

        stats
    }

    /// Create a monitoring stream for chunk processing
    pub fn create_monitoring_stream(&self) -> RS2Stream<ChunkProcessorStats> {
        let stats = Arc::clone(&self.stats);
        let reorder_buffers = Arc::clone(&self.reorder_buffers);
        let config = self.config.clone();

        tick(Duration::from_secs(1), ()).par_eval_map_rs2(1, move |_| {
            let stats = Arc::clone(&stats);
            let reorder_buffers = Arc::clone(&reorder_buffers);
            let config = config.clone();

            async move {
                let mut current_stats = {
                    let s = stats.lock().await;
                    s.clone()
                };

                // Update buffer utilization
                let buffers = reorder_buffers.read().await;
                let total_buffer_size: usize = buffers.values().map(|b| b.buffer.len()).sum();
                let max_possible_size = buffers.len() * config.max_reorder_window;

                current_stats.buffer_utilization = if max_possible_size > 0 {
                    total_buffer_size as f64 / max_possible_size as f64
                } else {
                    0.0
                };

                current_stats
            }
        })
    }
}

impl Clone for ChunkProcessor {
    fn clone(&self) -> Self {
        Self {
            config: self.config.clone(),
            codec: Arc::clone(&self.codec),
            reorder_buffers: Arc::clone(&self.reorder_buffers),
            stats: Arc::clone(&self.stats),
            output_queue: Arc::clone(&self.output_queue),
        }
    }
}