kino-core 0.1.0

Core video player library - HLS/DASH parsing, buffer management, and playback control
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
//! Buffer management for video playback
//!
//! Handles:
//! - Segment prefetching
//! - Buffer level monitoring
//! - Seek buffer management
//! - Memory-efficient storage

use crate::{
    types::*,
    Result,
};
use bytes::Bytes;
use std::collections::{BTreeMap, VecDeque};
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, warn, instrument};

/// Buffered segment data
#[derive(Debug, Clone)]
pub struct BufferedSegment {
    /// Segment metadata
    pub segment: Segment,
    /// Raw segment data
    pub data: Bytes,
    /// Start time in the timeline
    pub start_time: f64,
    /// End time in the timeline
    pub end_time: f64,
    /// Has this segment been consumed
    pub consumed: bool,
}

/// Buffer configuration
#[derive(Debug, Clone)]
pub struct BufferConfig {
    /// Minimum buffer before playback (seconds)
    pub min_buffer_time: f64,
    /// Maximum buffer level (seconds)
    pub max_buffer_time: f64,
    /// Rebuffer threshold (seconds)
    pub rebuffer_threshold: f64,
    /// Maximum memory usage (bytes)
    pub max_memory_bytes: usize,
    /// Enable lookahead prefetching
    pub prefetch_enabled: bool,
    /// Number of segments to prefetch
    pub prefetch_count: usize,
}

impl Default for BufferConfig {
    fn default() -> Self {
        Self {
            min_buffer_time: 10.0,
            max_buffer_time: 30.0,
            rebuffer_threshold: 2.0,
            max_memory_bytes: 256 * 1024 * 1024, // 256 MB
            prefetch_enabled: true,
            prefetch_count: 3,
        }
    }
}

/// Buffer manager for video playback
pub struct BufferManager {
    /// Configuration
    config: BufferConfig,
    /// Buffered segments indexed by sequence number
    segments: RwLock<BTreeMap<u64, BufferedSegment>>,
    /// Current playback position
    playback_position: RwLock<f64>,
    /// Total buffered duration
    buffered_duration: RwLock<f64>,
    /// Total memory used
    memory_used: RwLock<usize>,
    /// Pending fetch queue
    fetch_queue: Mutex<VecDeque<Segment>>,
}

impl BufferManager {
    /// Create a new buffer manager
    pub fn new(config: BufferConfig) -> Self {
        Self {
            config,
            segments: RwLock::new(BTreeMap::new()),
            playback_position: RwLock::new(0.0),
            buffered_duration: RwLock::new(0.0),
            memory_used: RwLock::new(0),
            fetch_queue: Mutex::new(VecDeque::new()),
        }
    }

    /// Add a segment to the buffer
    #[instrument(skip(self, data))]
    pub async fn add_segment(&self, segment: Segment, data: Bytes) -> Result<()> {
        let segment_duration = segment.duration.as_secs_f64();
        let segment_size = data.len();

        // Check memory limit
        let current_memory = *self.memory_used.read().await;
        if current_memory + segment_size > self.config.max_memory_bytes {
            // Evict old segments
            self.evict_segments(segment_size).await?;
        }

        let segments = self.segments.read().await;
        let start_time = if let Some((_, last)) = segments.iter().last() {
            last.end_time
        } else {
            0.0
        };
        drop(segments);

        let buffered_segment = BufferedSegment {
            segment: segment.clone(),
            data,
            start_time,
            end_time: start_time + segment_duration,
            consumed: false,
        };

        // Add to buffer
        let mut segments = self.segments.write().await;
        segments.insert(segment.number, buffered_segment);

        // Update stats
        *self.buffered_duration.write().await += segment_duration;
        *self.memory_used.write().await += segment_size;

        debug!(
            segment = segment.number,
            duration = segment_duration,
            buffer_level = *self.buffered_duration.read().await,
            "Segment added to buffer"
        );

        Ok(())
    }

    /// Get the next segment to play
    pub async fn get_next_segment(&self) -> Option<BufferedSegment> {
        let playback_pos = *self.playback_position.read().await;

        let segments = self.segments.read().await;
        for (_, segment) in segments.iter() {
            if !segment.consumed && segment.end_time > playback_pos {
                return Some(segment.clone());
            }
        }
        None
    }

    /// Get segment at specific time
    pub async fn get_segment_at(&self, time: f64) -> Option<BufferedSegment> {
        let segments = self.segments.read().await;
        for (_, segment) in segments.iter() {
            if time >= segment.start_time && time < segment.end_time {
                return Some(segment.clone());
            }
        }
        None
    }

    /// Mark segment as consumed
    pub async fn consume_segment(&self, sequence: u64) {
        let mut segments = self.segments.write().await;
        if let Some(segment) = segments.get_mut(&sequence) {
            segment.consumed = true;
        }
    }

    /// Update playback position
    pub async fn update_position(&self, position: f64) {
        *self.playback_position.write().await = position;

        // Clean up consumed segments that are far behind
        self.cleanup_consumed(position).await;
    }

    /// Get current buffer level in seconds
    pub async fn buffer_level(&self) -> f64 {
        let playback_pos = *self.playback_position.read().await;
        let segments = self.segments.read().await;

        let mut buffered = 0.0;
        for (_, segment) in segments.iter() {
            if segment.end_time > playback_pos && !segment.consumed {
                let start = segment.start_time.max(playback_pos);
                buffered += segment.end_time - start;
            }
        }
        buffered
    }

    /// Check if buffer is healthy for playback
    pub async fn is_buffer_healthy(&self) -> bool {
        self.buffer_level().await >= self.config.rebuffer_threshold
    }

    /// Check if we need more data
    pub async fn needs_data(&self) -> bool {
        self.buffer_level().await < self.config.max_buffer_time
    }

    /// Can start playback
    pub async fn can_start_playback(&self) -> bool {
        self.buffer_level().await >= self.config.min_buffer_time
    }

    /// Get buffered time ranges
    pub async fn buffered_ranges(&self) -> Vec<(f64, f64)> {
        let segments = self.segments.read().await;
        let mut ranges = Vec::new();

        let mut current_start: Option<f64> = None;
        let mut current_end: f64 = 0.0;

        for (_, segment) in segments.iter() {
            if !segment.consumed {
                match current_start {
                    None => {
                        current_start = Some(segment.start_time);
                        current_end = segment.end_time;
                    }
                    Some(_) => {
                        // Check for gap
                        if (segment.start_time - current_end).abs() < 0.1 {
                            // Contiguous
                            current_end = segment.end_time;
                        } else {
                            // Gap - start new range
                            ranges.push((current_start.unwrap(), current_end));
                            current_start = Some(segment.start_time);
                            current_end = segment.end_time;
                        }
                    }
                }
            }
        }

        if let Some(start) = current_start {
            ranges.push((start, current_end));
        }

        ranges
    }

    /// Seek to position - returns true if position is buffered
    pub async fn seek(&self, position: f64) -> Result<bool> {
        *self.playback_position.write().await = position;

        // Check if position is buffered
        let is_buffered = self.get_segment_at(position).await.is_some();

        if !is_buffered {
            // Clear buffer for fresh fetch
            self.clear().await;
        }

        Ok(is_buffered)
    }

    /// Clear all buffered data
    pub async fn clear(&self) {
        let mut segments = self.segments.write().await;
        segments.clear();

        *self.buffered_duration.write().await = 0.0;
        *self.memory_used.write().await = 0;

        let mut queue = self.fetch_queue.lock().await;
        queue.clear();

        debug!("Buffer cleared");
    }

    /// Evict old segments to free memory
    async fn evict_segments(&self, needed_bytes: usize) -> Result<()> {
        let playback_pos = *self.playback_position.read().await;
        let mut segments = self.segments.write().await;
        let mut memory = self.memory_used.write().await;
        let mut duration = self.buffered_duration.write().await;

        let mut freed = 0;
        let mut to_remove = Vec::new();

        // Find segments to remove (oldest first, already consumed, behind playback)
        for (&seq, segment) in segments.iter() {
            if freed >= needed_bytes {
                break;
            }
            if segment.consumed || segment.end_time < playback_pos - 5.0 {
                to_remove.push(seq);
                freed += segment.data.len();
            }
        }

        // Remove segments
        for seq in to_remove {
            if let Some(segment) = segments.remove(&seq) {
                *memory -= segment.data.len();
                *duration -= segment.segment.duration.as_secs_f64();
                debug!(segment = seq, "Evicted segment from buffer");
            }
        }

        if freed < needed_bytes {
            warn!(
                needed = needed_bytes,
                freed = freed,
                "Could not free enough memory"
            );
        }

        Ok(())
    }

    /// Clean up consumed segments behind playback
    async fn cleanup_consumed(&self, playback_pos: f64) {
        let threshold = playback_pos - 10.0; // Keep 10s behind

        let mut segments = self.segments.write().await;
        let mut memory = self.memory_used.write().await;
        let mut duration = self.buffered_duration.write().await;

        let to_remove: Vec<_> = segments
            .iter()
            .filter(|(_, s)| s.consumed && s.end_time < threshold)
            .map(|(&seq, _)| seq)
            .collect();

        for seq in to_remove {
            if let Some(segment) = segments.remove(&seq) {
                *memory -= segment.data.len();
                *duration -= segment.segment.duration.as_secs_f64();
            }
        }
    }

    /// Get buffer statistics
    pub async fn stats(&self) -> BufferStats {
        let segments = self.segments.read().await;
        let ranges = self.buffered_ranges().await;

        BufferStats {
            segment_count: segments.len(),
            buffer_level: self.buffer_level().await,
            memory_used: *self.memory_used.read().await,
            buffered_ranges: ranges,
            playback_position: *self.playback_position.read().await,
        }
    }

    /// Queue segments for fetching
    pub async fn queue_fetch(&self, segments: Vec<Segment>) {
        let mut queue = self.fetch_queue.lock().await;
        for segment in segments {
            queue.push_back(segment);
        }
    }

    /// Get next segment to fetch
    pub async fn next_fetch(&self) -> Option<Segment> {
        let mut queue = self.fetch_queue.lock().await;
        queue.pop_front()
    }
}

/// Buffer statistics
#[derive(Debug, Clone)]
pub struct BufferStats {
    pub segment_count: usize,
    pub buffer_level: f64,
    pub memory_used: usize,
    pub buffered_ranges: Vec<(f64, f64)>,
    pub playback_position: f64,
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;
    use url::Url;

    fn create_test_segment(num: u64) -> Segment {
        Segment {
            number: num,
            uri: Url::parse(&format!("https://example.com/seg{}.ts", num)).unwrap(),
            duration: Duration::from_secs(4),
            byte_range: None,
            encryption: None,
            discontinuity_sequence: 0,
            program_date_time: None,
        }
    }

    #[tokio::test]
    async fn test_add_segment() {
        let buffer = BufferManager::new(BufferConfig::default());

        let segment = create_test_segment(1);
        let data = Bytes::from(vec![0u8; 1024]);

        buffer.add_segment(segment, data).await.unwrap();

        assert_eq!(buffer.buffer_level().await, 4.0);
    }

    #[tokio::test]
    async fn test_buffer_level() {
        let buffer = BufferManager::new(BufferConfig::default());

        for i in 1..=5 {
            let segment = create_test_segment(i);
            let data = Bytes::from(vec![0u8; 1024]);
            buffer.add_segment(segment, data).await.unwrap();
        }

        assert_eq!(buffer.buffer_level().await, 20.0);

        buffer.update_position(8.0).await;
        assert!((buffer.buffer_level().await - 12.0).abs() < 0.1);
    }

    #[tokio::test]
    async fn test_seek_buffered() {
        let buffer = BufferManager::new(BufferConfig::default());

        for i in 1..=5 {
            let segment = create_test_segment(i);
            let data = Bytes::from(vec![0u8; 1024]);
            buffer.add_segment(segment, data).await.unwrap();
        }

        // Seek within buffered range
        let is_buffered = buffer.seek(10.0).await.unwrap();
        assert!(is_buffered);

        // Seek outside buffered range
        let is_buffered = buffer.seek(100.0).await.unwrap();
        assert!(!is_buffered);
    }
}