ass-core 0.1.1

High-performance ASS subtitle format parser and analyzer
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
//! Event timing overlap detection using sweep-line algorithm
//!
//! Provides efficient O(n log n) overlap detection for ASS dialogue events
//! using a sweep-line algorithm instead of naive O(n²) approaches.
//!
//! # Algorithm
//!
//! Uses sweep-line technique with start/end events sorted by time.
//! Maintains active event set to detect overlaps in optimal time complexity.
//!
//! # Performance
//!
//! - Time complexity: O(n log n) due to sorting
//! - Space complexity: O(n) for sweep events and active set
//! - Target: <1ms for 1000 events on typical hardware
//!
//! # Example
//!
//! ```rust
//! use ass_core::analysis::events::overlap::find_overlapping_events;
//! use ass_core::parser::Event;
//!
//! let events = vec![
//!     Event { start: "0:00:00.00", end: "0:00:05.00", ..Default::default() },
//!     Event { start: "0:00:03.00", end: "0:00:08.00", ..Default::default() },
//! ];
//!
//! let overlaps = find_overlapping_events(&events)?;
//! assert_eq!(overlaps.len(), 1);
//! assert_eq!(overlaps[0], (0, 1));
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```

use crate::{
    parser::Event,
    utils::{parse_ass_time, CoreError},
    Result,
};
use alloc::vec::Vec;
use core::cmp::Ordering;

/// Event type discriminant for sweep-line algorithm
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum SweepEventType {
    /// Event represents dialogue start time
    Start,
    /// Event represents dialogue end time
    End,
}

/// Sweep-line event for overlap detection algorithm
#[derive(Debug, Clone)]
struct SweepEvent {
    /// Time of this sweep event in centiseconds
    time: u32,
    /// Type of event (start or end)
    event_type: SweepEventType,
    /// Index of the original event in the input vector
    event_index: usize,
}

impl PartialEq for SweepEvent {
    fn eq(&self, other: &Self) -> bool {
        self.time == other.time && self.event_type == other.event_type
    }
}

impl Eq for SweepEvent {}

impl PartialOrd for SweepEvent {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for SweepEvent {
    fn cmp(&self, other: &Self) -> Ordering {
        match self.time.cmp(&other.time) {
            Ordering::Equal => match (self.event_type, other.event_type) {
                (SweepEventType::End, SweepEventType::Start) => Ordering::Less,
                (SweepEventType::Start, SweepEventType::End) => Ordering::Greater,
                _ => Ordering::Equal,
            },
            other => other,
        }
    }
}

/// Generic overlap detection using sweep-line algorithm
///
/// Internal helper function that implements the core sweep-line algorithm
/// for detecting overlapping time ranges. Works with any iterator that
/// provides start and end times.
fn find_overlaps_generic<I, F>(events: I, get_times: F) -> Result<Vec<(usize, usize)>>
where
    I: ExactSizeIterator,
    F: Fn(usize, I::Item) -> Result<(u32, u32)>,
{
    if events.len() < 2 {
        return Ok(Vec::new());
    }

    let mut sweep_events = Vec::with_capacity(events.len() * 2);

    for (index, event) in events.enumerate() {
        let (start_time, end_time) = get_times(index, event)?;

        sweep_events.push(SweepEvent {
            time: start_time,
            event_type: SweepEventType::Start,
            event_index: index,
        });

        sweep_events.push(SweepEvent {
            time: end_time,
            event_type: SweepEventType::End,
            event_index: index,
        });
    }

    sweep_events.sort();

    let mut active_events = Vec::new();
    let mut overlaps = Vec::new();

    for sweep_event in sweep_events {
        match sweep_event.event_type {
            SweepEventType::Start => {
                for &active_index in &active_events {
                    overlaps.push((active_index, sweep_event.event_index));
                }
                active_events.push(sweep_event.event_index);
            }
            SweepEventType::End => {
                if let Some(pos) = active_events
                    .iter()
                    .position(|&x| x == sweep_event.event_index)
                {
                    active_events.remove(pos);
                }
            }
        }
    }

    Ok(overlaps)
}

/// Find overlapping events using sweep-line algorithm
///
/// Efficiently detects all pairs of events with overlapping time ranges.
/// Returns vector of (`event1_index`, `event2_index`) pairs where events overlap.
///
/// # Arguments
///
/// * `events` - Slice of events to analyze for overlaps
///
/// # Returns
///
/// Vector of index pairs representing overlapping events, or error if
/// time parsing fails.
///
/// # Example
///
/// ```rust
/// # use ass_core::analysis::events::overlap::find_overlapping_events;
/// # use ass_core::parser::Event;
/// let events = vec![
///     Event { start: "0:00:00.00", end: "0:00:05.00", ..Default::default() },
///     Event { start: "0:00:03.00", end: "0:00:08.00", ..Default::default() },
///     Event { start: "0:00:10.00", end: "0:00:15.00", ..Default::default() },
/// ];
///
/// let overlaps = find_overlapping_events(&events)?;
/// assert_eq!(overlaps, vec![(0, 1)]);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
///
/// # Errors
///
/// Returns an error if any event has invalid time format that cannot be parsed.
pub fn find_overlapping_events(events: &[Event]) -> Result<Vec<(usize, usize)>> {
    find_overlaps_generic(events.iter(), |_index, event| {
        let start_time = parse_ass_time(event.start)
            .map_err(|_| CoreError::parse("Invalid start time format"))?;
        let end_time =
            parse_ass_time(event.end).map_err(|_| CoreError::parse("Invalid end time format"))?;
        Ok((start_time, end_time))
    })
}

/// Find overlapping events from event references
///
/// Memory-efficient version that works with Event references instead of
/// owned Event structs. Useful when working with large event collections.
///
/// # Arguments
///
/// * `events` - Slice of event references to analyze
///
/// # Returns
///
/// Vector of index pairs for overlapping events, or parsing error.
///
/// # Errors
///
/// Returns an error if any event has invalid time format that cannot be parsed.
pub fn find_overlapping_event_refs(events: &[&Event]) -> Result<Vec<(usize, usize)>> {
    find_overlaps_generic(events.iter(), |_index, event| {
        let start_time = parse_ass_time(event.start)
            .map_err(|_| CoreError::parse("Invalid start time format"))?;
        let end_time =
            parse_ass_time(event.end).map_err(|_| CoreError::parse("Invalid end time format"))?;
        Ok((start_time, end_time))
    })
}

/// Count overlapping event pairs efficiently
///
/// Returns only the count without generating the full list of overlap pairs.
/// More memory efficient when only the count is needed.
///
/// # Arguments
///
/// * `events` - Events to check for overlaps
///
/// # Returns
///
/// Number of overlapping event pairs found.
///
/// # Errors
///
/// Returns an error if any event has invalid time format that cannot be parsed.
pub fn count_overlapping_events(events: &[Event]) -> Result<usize> {
    Ok(find_overlapping_events(events)?.len())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::parser::ast::Span;
    #[cfg(not(feature = "std"))]
    use alloc::{string::ToString, vec};

    fn create_test_event(start: &'static str, end: &'static str) -> Event<'static> {
        Event {
            event_type: crate::parser::ast::EventType::Dialogue,
            start,
            end,
            text: "Test",
            layer: "0",
            style: "Default",
            name: "",
            margin_l: "0",
            margin_r: "0",
            margin_v: "0",
            margin_t: None,
            margin_b: None,
            effect: "",
            span: Span::new(0, 0, 0, 0),
        }
    }

    #[test]
    fn no_overlaps_empty_list() {
        let events = vec![];
        let result = find_overlapping_events(&events).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn no_overlaps_single_event() {
        let events = vec![create_test_event("0:00:00.00", "0:00:05.00")];
        let result = find_overlapping_events(&events).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn no_overlaps_sequential_events() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:05.00"),
            create_test_event("0:00:05.00", "0:00:10.00"),
            create_test_event("0:00:10.00", "0:00:15.00"),
        ];
        let result = find_overlapping_events(&events).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn simple_overlap() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:05.00"),
            create_test_event("0:00:03.00", "0:00:08.00"),
        ];
        let result = find_overlapping_events(&events).unwrap();
        assert_eq!(result, vec![(0, 1)]);
    }

    #[test]
    fn multiple_overlaps() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:10.00"),
            create_test_event("0:00:02.00", "0:00:05.00"),
            create_test_event("0:00:03.00", "0:00:08.00"),
        ];
        let result = find_overlapping_events(&events).unwrap();
        assert_eq!(result, vec![(0, 1), (0, 2), (1, 2)]);
    }

    #[test]
    fn count_overlaps() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:05.00"),
            create_test_event("0:00:03.00", "0:00:08.00"),
        ];
        let count = count_overlapping_events(&events).unwrap();
        assert_eq!(count, 1);
    }

    #[test]
    fn test_sweep_event_ordering() {
        let start_event = SweepEvent {
            time: 1000,
            event_type: SweepEventType::Start,
            event_index: 0,
        };
        let end_event = SweepEvent {
            time: 1000,
            event_type: SweepEventType::End,
            event_index: 1,
        };

        // End events should come before start events at the same time
        assert!(end_event < start_event);
        assert_eq!(start_event.partial_cmp(&end_event), Some(Ordering::Greater));
    }

    #[test]
    fn test_sweep_event_equality() {
        let event1 = SweepEvent {
            time: 1000,
            event_type: SweepEventType::Start,
            event_index: 0,
        };
        let event2 = SweepEvent {
            time: 1000,
            event_type: SweepEventType::Start,
            event_index: 1,
        };

        assert_eq!(event1, event2);
    }

    #[test]
    fn find_overlapping_event_refs_test() {
        let event1 = create_test_event("0:00:00.00", "0:00:05.00");
        let event2 = create_test_event("0:00:03.00", "0:00:08.00");
        let event3 = create_test_event("0:00:10.00", "0:00:15.00");

        let event_refs = vec![&event1, &event2, &event3];
        let result = find_overlapping_event_refs(&event_refs).unwrap();
        assert_eq!(result, vec![(0, 1)]);
    }

    #[test]
    fn find_overlapping_event_refs_empty() {
        let event_refs: Vec<&Event> = vec![];
        let result = find_overlapping_event_refs(&event_refs).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn find_overlapping_event_refs_single() {
        let event1 = create_test_event("0:00:00.00", "0:00:05.00");
        let event_refs = vec![&event1];
        let result = find_overlapping_event_refs(&event_refs).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn test_overlaps_with_identical_times() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:05.00"),
            create_test_event("0:00:00.00", "0:00:05.00"),
        ];
        let result = find_overlapping_events(&events).unwrap();
        assert_eq!(result, vec![(0, 1)]);
    }

    #[test]
    fn test_adjacent_events_no_overlap() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:05.00"),
            create_test_event("0:00:05.00", "0:00:10.00"),
        ];
        let result = find_overlapping_events(&events).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    fn test_complex_overlap_scenario() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:10.00"), // Event 0
            create_test_event("0:00:02.00", "0:00:05.00"), // Event 1 - overlaps with 0
            create_test_event("0:00:03.00", "0:00:08.00"), // Event 2 - overlaps with 0, 1
            create_test_event("0:00:06.00", "0:00:09.00"), // Event 3 - overlaps with 0, 2
            create_test_event("0:00:11.00", "0:00:15.00"), // Event 4 - no overlaps
        ];
        let result = find_overlapping_events(&events).unwrap();

        // Expected overlaps: (0,1), (0,2), (0,3), (1,2), (2,3)
        assert_eq!(result.len(), 5);
        assert!(result.contains(&(0, 1)));
        assert!(result.contains(&(0, 2)));
        assert!(result.contains(&(0, 3)));
        assert!(result.contains(&(1, 2)));
        assert!(result.contains(&(2, 3)));
    }

    #[test]
    fn test_sweep_event_ordering_different_times() {
        let early_event = SweepEvent {
            time: 500,
            event_type: SweepEventType::Start,
            event_index: 0,
        };
        let late_event = SweepEvent {
            time: 1000,
            event_type: SweepEventType::End,
            event_index: 1,
        };

        assert!(early_event < late_event);
    }

    #[test]
    fn test_invalid_start_time_format_error() {
        let events = vec![
            create_test_event("invalid_time", "0:00:05.00"),
            create_test_event("0:00:03.00", "0:00:08.00"),
        ];
        let result = find_overlapping_events(&events);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Invalid start time format"));
    }

    #[test]
    fn test_invalid_end_time_format_error() {
        let events = vec![
            create_test_event("0:00:00.00", "invalid_time"),
            create_test_event("0:00:03.00", "0:00:08.00"),
        ];
        let result = find_overlapping_events(&events);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Invalid end time format"));
    }

    #[test]
    fn test_invalid_time_formats_in_multiple_events() {
        let events = vec![
            create_test_event("0:00:00.00", "0:00:05.00"), // Valid
            create_test_event("bad_start", "0:00:08.00"),  // Invalid start
            create_test_event("0:00:03.00", "bad_end"),    // Invalid end
        ];
        let result = find_overlapping_events(&events);
        assert!(result.is_err());
        // Should fail on first invalid time encountered
    }

    #[test]
    fn test_count_overlapping_events_with_invalid_times() {
        let events = vec![
            create_test_event("invalid_time", "0:00:05.00"),
            create_test_event("0:00:03.00", "0:00:08.00"),
        ];
        let result = count_overlapping_events(&events);
        assert!(result.is_err());
    }

    #[test]
    fn test_find_overlapping_event_refs_with_invalid_times() {
        let event1 = create_test_event("invalid_start", "0:00:05.00");
        let event2 = create_test_event("0:00:03.00", "0:00:08.00");
        let event_refs = vec![&event1, &event2];
        let result = find_overlapping_event_refs(&event_refs);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Invalid start time format"));
    }

    #[test]
    fn test_find_overlaps_generic_error_propagation() {
        let events = ["valid", "invalid"];
        let result = find_overlaps_generic(events.iter(), |_index, event| {
            if *event == "invalid" {
                Err(CoreError::parse("Test error"))
            } else {
                Ok((1000u32, 2000u32))
            }
        });
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("Test error"));
    }

    #[test]
    fn test_malformed_time_formats_various() {
        let test_cases = vec![
            ("invalid", "0:00:05.00"),       // Non-time format
            ("0:60:00.00", "0:00:05.00"),    // Invalid minute (60)
            ("0:00:60.00", "0:00:05.00"),    // Invalid second (60)
            ("0:00:00.100", "0:00:05.00"),   // Invalid centiseconds (100)
            ("0:00:00.00", "invalid"),       // Invalid end time
            ("0:00:00.00", "0:60:00.00"),    // Invalid end minute
            ("abc:def:gh.ij", "0:00:05.00"), // Non-numeric components
        ];

        for (start, end) in test_cases {
            // Need at least 2 events to trigger time parsing in overlap detection
            let events = vec![
                create_test_event(start, end), // Event with invalid time
                create_test_event("0:00:10.00", "0:00:15.00"), // Valid event for comparison
            ];
            let result = find_overlapping_events(&events);
            assert!(
                result.is_err(),
                "Expected error for time format: {start} -> {end}, got: {result:?}"
            );
        }
    }

    #[test]
    fn test_find_overlapping_event_refs_with_invalid_end_time() {
        let event1 = create_test_event("0:00:00.00", "invalid_end");
        let event2 = create_test_event("0:00:03.00", "0:00:08.00");
        let event_refs = vec![&event1, &event2];
        let result = find_overlapping_event_refs(&event_refs);
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Invalid end time format"));
    }
}