subcue 0.1.1

Parse, compose, and convert SRT, WebVTT, and ASS/SSA subtitle files
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

//! Conversions go through the inline span model and round-trip through it.

use subcue::text::{self, Rgb, Span};
use subcue::{parse_ass, parse_srt, parse_vtt, Format, Warning};

fn text(value: &str) -> Span {
    Span::Text(value.to_owned())
}

#[test]
fn srt_formatting_survives_a_trip_through_ass() {
    let source = parse_srt(
        b"1\n00:00:01,000 --> 00:00:02,000\n<b>a <i>b</i></b>\n<font color=\"#ff0000\">c</font>\n\n",
    )
    .unwrap();
    let ass = source.convert(Format::Ass);
    assert_eq!(
        ass.cues[0].text,
        "{\\b1}a {\\i1}b{\\i0}{\\b0}\\N{\\c&H0000FF&}c{\\c}"
    );
    assert!(ass.warnings.is_empty(), "{:?}", ass.warnings);
    let back = ass.convert(Format::Srt);
    assert_eq!(back.cues[0].text, source.cues[0].text);
    assert_eq!(
        text::parse(&back.cues[0].text, Format::Srt).spans,
        text::parse(&source.cues[0].text, Format::Srt).spans
    );
}

#[test]
fn crossing_tags_are_normalized_to_a_tree() {
    let source = parse_srt(b"1\n00:00:01,000 --> 00:00:02,000\n<b><i>x</b>y</i>\n\n").unwrap();
    let vtt = source.convert(Format::Vtt);
    assert_eq!(vtt.cues[0].text, "<b><i>x</i></b><i>y</i>");
    assert_eq!(
        text::parse(&vtt.cues[0].text, Format::Vtt).spans,
        vec![
            Span::Bold(vec![Span::Italic(vec![text("x")])]),
            Span::Italic(vec![text("y")]),
        ]
    );
}

#[test]
fn vtt_voice_and_class_tags_take_their_documented_paths() {
    let source =
        parse_vtt(b"WEBVTT\n\n00:00:01.000 --> 00:00:02.000\n<v Bob><c.x>hi</c> &amp; bye\n\n")
            .unwrap();
    let ass = source.convert(Format::Ass);
    assert_eq!(ass.cues[0].text, "hi & bye");
    assert_eq!(ass.cues[0].ass.as_ref().unwrap().name, "Bob");
    assert_eq!(
        ass.warnings,
        vec![Warning::LossyTag {
            cue: 1,
            tag: "c.x".to_owned()
        }]
    );
    let srt = source.convert(Format::Srt);
    assert_eq!(srt.cues[0].text, "hi &amp; bye");
    assert_eq!(
        srt.warnings,
        vec![
            Warning::LossyTag {
                cue: 1,
                tag: "v Bob".to_owned()
            },
            Warning::LossyTag {
                cue: 1,
                tag: "c.x".to_owned()
            },
        ]
    );
}

#[test]
fn ass_overrides_map_to_settings_text_and_warnings() {
    let source = parse_ass(
        b"[Events]\nFormat: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\nDialogue: 0,0:00:01.00,0:00:02.00,Default,Ann,0,0,0,,{\\an8\\pos(1,2)}a & b\\N<c>\n",
    )
    .unwrap();
    let vtt = source.convert(Format::Vtt);
    assert_eq!(
        vtt.cues[0].settings.as_deref(),
        Some("line:0% align:center")
    );
    assert_eq!(vtt.cues[0].text, "<v Ann>a &amp; b\n&lt;c&gt;");
    assert_eq!(
        vtt.warnings,
        vec![Warning::LossyTag {
            cue: 1,
            tag: "pos(1,2)".to_owned()
        }]
    );
    let srt = source.convert(Format::Srt);
    assert_eq!(srt.cues[0].text, "a & b\n<c>");
    assert_eq!(srt.cues[0].settings, None);
    assert_eq!(
        srt.warnings,
        vec![
            Warning::LossyTag {
                cue: 1,
                tag: "an8".to_owned()
            },
            Warning::LossyTag {
                cue: 1,
                tag: "pos(1,2)".to_owned()
            },
        ]
    );
}

#[test]
fn spans_are_a_public_model_with_colour_values() {
    let parsed = text::parse("{\\c&H0080FF&}warm{\\c}", Format::Ass);
    assert_eq!(
        parsed.spans,
        vec![Span::Color(
            Rgb {
                red: 255,
                green: 128,
                blue: 0
            },
            vec![text("warm")]
        )]
    );
    let rendered = text::render(&parsed.spans, Format::Vtt);
    assert_eq!(rendered.text, "warm");
    assert_eq!(rendered.dropped, vec!["font"]);
}

#[test]
fn converted_text_with_repeated_breaks_reparses_to_the_same_cues() {
    let source = parse_ass(
        b"[Events]\nFormat: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\nDialogue: 0,0:00:01.00,0:00:02.00,Default,,0,0,0,,\\Nfirst\\N\\Nsecond\\N\n",
    )
    .unwrap();
    for target in [Format::Srt, Format::Vtt] {
        let converted = source.convert(target);
        let composed = converted.compose().0;
        let reparsed = subcue::parse(&composed, target).unwrap();
        assert_eq!(reparsed.cues, converted.cues, "{target:?}");
        assert_eq!(reparsed.compose().0, composed, "{target:?}");
    }
}