rsubs-lib 0.3.4

Pure Rust subtitle manipulation and conversion library.
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
use rsubs_lib::{VTTErrorKind, VTT};

const SIMPLE: &str = r"WEBVTT

00:11.000 --> 00:13.000
<v Roger Bingham>We are in New York City

00:13.000 --> 00:16.000
<v Roger Bingham>We’re actually at the Lucern Hotel, just down the street

00:16.000 --> 00:18.000
<v Roger Bingham>from the American Museum of Natural History

00:18.000 --> 00:20.000
<v Roger Bingham>And with me is Neil deGrasse Tyson";

#[test]
fn convert_simple_to_srt() {
    let expected = r"1
00:00:11,000 --> 00:00:13,000
We are in New York City

2
00:00:13,000 --> 00:00:16,000
We’re actually at the Lucern Hotel, just down the street

3
00:00:16,000 --> 00:00:18,000
from the American Museum of Natural History

4
00:00:18,000 --> 00:00:20,000
And with me is Neil deGrasse Tyson"
        .replace('\n', "\r\n");
    let vtt = VTT::parse(SIMPLE).unwrap();
    assert_eq!(vtt.to_srt().to_string(), expected)
}

#[test]
fn convert_simple_to_ssa() {
    let expected = r"[Script Info]

[V4+ Styles]
Format: Name,Fontname,Fontsize,PrimaryColour,SecondaryColour,OutlineColour,BackColour,Bold,Italic,Underline,StrikeOut,ScaleX,ScaleY,Spacing,Angle,BorderStyle,Outline,Shadow,Alignment,MarginL,MarginR,MarginV,Encoding
Style: Default,Arial,20,,,,,0,0,0,0,120,120,0,0,1,1,1,2,0,0,20,0

[Events]
Format: Layer,Start,End,Style,Name,MarginL,MarginR,MarginV,Effect,Text
Dialogue: 0,0:00:11.00,0:00:13.00,Default,Roger Bingham,0,0,0,,We are in New York City
Dialogue: 0,0:00:13.00,0:00:16.00,Default,Roger Bingham,0,0,0,,We’re actually at the Lucern Hotel, just down the street
Dialogue: 0,0:00:16.00,0:00:18.00,Default,Roger Bingham,0,0,0,,from the American Museum of Natural History
Dialogue: 0,0:00:18.00,0:00:20.00,Default,Roger Bingham,0,0,0,,And with me is Neil deGrasse Tyson";
    let vtt = VTT::parse(SIMPLE).unwrap();
    assert_eq!(vtt.to_ssa().to_string(), expected)
}

const STYLING_INLINE: &str = r"WEBVTT

00:32.500 --> 00:33.500 align:left size:50%
<v Neil deGrasse Tyson><i>Laughs</i>

00:35.500 --> 00:38.000
<v Roger Bingham>You know I’m so excited my glasses are falling off here.";

#[test]
fn convert_styling_inline_to_srt() {
    let expected = r"1
00:00:32,500 --> 00:00:33,500
<i>Laughs</i>

2
00:00:35,500 --> 00:00:38,000
You know I’m so excited my glasses are falling off here."
        .replace('\n', "\r\n");
    let vtt = VTT::parse(STYLING_INLINE).unwrap();
    assert_eq!(vtt.to_srt().to_string(), expected)
}

#[test]
fn convert_styling_inline_to_ssa() {
    let expected = r"[Script Info]

[V4+ Styles]
Format: Name,Fontname,Fontsize,PrimaryColour,SecondaryColour,OutlineColour,BackColour,Bold,Italic,Underline,StrikeOut,ScaleX,ScaleY,Spacing,Angle,BorderStyle,Outline,Shadow,Alignment,MarginL,MarginR,MarginV,Encoding
Style: Default,Arial,20,,,,,0,0,0,0,120,120,0,0,1,1,1,2,0,0,20,0

[Events]
Format: Layer,Start,End,Style,Name,MarginL,MarginR,MarginV,Effect,Text
Dialogue: 0,0:00:32.50,0:00:33.50,Default,Neil deGrasse Tyson,0,0,0,,{\i1}Laughs{\i0}
Dialogue: 0,0:00:35.50,0:00:38.00,Default,Roger Bingham,0,0,0,,You know I’m so excited my glasses are falling off here.";
    let vtt = VTT::parse(STYLING_INLINE).unwrap();
    assert_eq!(vtt.to_ssa().to_string(), expected)
}

const STYLING_GLOBAL: &str = r#"WEBVTT

STYLE
::cue {
    color: blue;
    font-family: "Arial", sans-serif;
    font-size: 12px;
}

00:22.000 --> 00:24.000
<v Roger Bingham>at the AMNH.

00:24.000 --> 00:26.000
<v Roger Bingham>Thank you for walking down here.

00:27.000 --> 00:30.000
<v Roger Bingham>And I want to do a follow-up on the last conversation we did.

00:30.000 --> 00:31.500 position:30% left align:right size:50% line:12
<v Roger Bingham>When we e-mailed—"#;

#[test]
fn convert_styling_global_to_srt() {
    let expected = r"1
00:00:22,000 --> 00:00:24,000
at the AMNH.

2
00:00:24,000 --> 00:00:26,000
Thank you for walking down here.

3
00:00:27,000 --> 00:00:30,000
And I want to do a follow-up on the last conversation we did.

4
00:00:30,000 --> 00:00:31,500
When we e-mailed—"
        .replace('\n', "\r\n");
    let vtt = VTT::parse(STYLING_GLOBAL).unwrap();
    assert_eq!(vtt.to_srt().to_string(), expected)
}

#[test]
fn convert_styling_global_to_ssa() {
    let expected = r"[Script Info]

[V4+ Styles]
Format: Name,Fontname,Fontsize,PrimaryColour,SecondaryColour,OutlineColour,BackColour,Bold,Italic,Underline,StrikeOut,ScaleX,ScaleY,Spacing,Angle,BorderStyle,Outline,Shadow,Alignment,MarginL,MarginR,MarginV,Encoding
Style: Default,Arial,12,&HFF0000,,,,0,0,0,0,120,120,0,0,1,1,1,2,0,0,20,0

[Events]
Format: Layer,Start,End,Style,Name,MarginL,MarginR,MarginV,Effect,Text
Dialogue: 0,0:00:22.00,0:00:24.00,Default,Roger Bingham,0,0,0,,at the AMNH.
Dialogue: 0,0:00:24.00,0:00:26.00,Default,Roger Bingham,0,0,0,,Thank you for walking down here.
Dialogue: 0,0:00:27.00,0:00:30.00,Default,Roger Bingham,0,0,0,,And I want to do a follow-up on the last conversation we did.
Dialogue: 0,0:00:30.00,0:00:31.50,Default,Roger Bingham,0,0,0,,When we e-mailed—";
    let vtt = VTT::parse(STYLING_GLOBAL).unwrap();
    assert_eq!(vtt.to_ssa().to_string(), expected)
}

const MULTILINE: &str = r"WEBVTT

00:00.000 --> 00:02.000 align:left size:50% position:030%
Lorem Ipsum 1
Lorem Ipsum 2
Lorem Ipsum 3";

#[test]
fn convert_multiline_to_srt() {
    let expected = r"1
00:00:00,000 --> 00:00:02,000
Lorem Ipsum 1
Lorem Ipsum 2
Lorem Ipsum 3"
        .replace('\n', "\r\n");
    let vtt = VTT::parse(MULTILINE).unwrap();
    assert_eq!(vtt.to_srt().to_string(), expected)
}

#[test]
fn convert_multiline_to_ssa() {
    let expected = r"[Script Info]

[V4+ Styles]
Format: Name,Fontname,Fontsize,PrimaryColour,SecondaryColour,OutlineColour,BackColour,Bold,Italic,Underline,StrikeOut,ScaleX,ScaleY,Spacing,Angle,BorderStyle,Outline,Shadow,Alignment,MarginL,MarginR,MarginV,Encoding
Style: Default,Arial,20,,,,,0,0,0,0,120,120,0,0,1,1,1,2,0,0,20,0

[Events]
Format: Layer,Start,End,Style,Name,MarginL,MarginR,MarginV,Effect,Text
Dialogue: 0,0:00:00.00,0:00:02.00,Default,,0,0,0,,Lorem Ipsum 1\NLorem Ipsum 2\NLorem Ipsum 3";
    let vtt = VTT::parse(MULTILINE).unwrap();
    assert_eq!(vtt.to_ssa().to_string(), expected)
}

#[test]
fn serde() {
    let vtt = r#"WEBVTT

NOTE This is a note

STYLE ::cue {}

REGION
id:test
width:100%
lines:1
regionanchor:10%,10%
viewportanchor:10%,10%
scroll:up
test:test

00:11.000 --> 00:13.000
test
"#;

    let deserialized = serde_json::to_value(VTT::parse(vtt).unwrap()).unwrap();
    let _: VTT = serde_json::from_value(deserialized).unwrap();
}

#[test]
fn invalid_start() {
    let vtt = r#"00:11.000 --> 00:13.000
<v Roger Bingham>We are in New York City
    "#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 1);
    assert_eq!(err.kind(), &VTTErrorKind::InvalidFormat)
}

#[test]
fn region_missing_delimiter() {
    let vtt = r#"WEBVTT

REGION
id
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 4);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn region_invalid_values() {
    let pairs = [
        ("width", "test"),
        ("lines", "test"),
        ("regionanchor", "test"),
        ("regionanchor", "10%,test"),
        ("regionanchor", "test,10%"),
        ("viewportanchor", "test"),
        ("viewportanchor", "10%,test"),
        ("viewportanchor", "test,10%"),
        ("scroll", "test"),
    ];
    for (k, v) in pairs {
        let vtt = format!("WEBVTT\n\nREGION\n{k}:{v}");
        let err = VTT::parse(vtt).unwrap_err();
        assert_eq!(err.line(), 4);
        assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
    }
}

#[test]
fn style_missing_cue_prefix() {
    let vtt = r#"WEBVTT

STYLE {}
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn style_missing_selector_closing_bracket() {
    let vtt = r#"WEBVTT

STYLE ::cue(selector {}
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn style_missing_block_opening_bracket() {
    let vtt = r#"WEBVTT

STYLE ::cue }
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn style_missing_block_closing_bracket() {
    let vtt = r#"WEBVTT

STYLE ::cue {
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn style_missing_value() {
    let vtt = r#"WEBVTT

STYLE
::cue {
  color
}
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 5);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_missing_timing() {
    let vtt = r#"WEBVTT

<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 4);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_missing_timing_with_id() {
    let vtt = r#"WEBVTT

1
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 4);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_missing_start_time() {
    let vtt = r#"WEBVTT

--> 00:13.000
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_missing_end_time() {
    let vtt = r#"WEBVTT

00:11.000 -->
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_timings_minute() {
    let vtt = r#"WEBVTT

00:11.000 --> 00:13.000
<v Roger Bingham>We are in New York City
"#;

    VTT::parse(vtt).unwrap();
}

#[test]
fn cue_timings_hour() {
    let vtt = r#"WEBVTT

00:00:11.000 --> 00:00:13.000
<v Roger Bingham>We are in New York City
"#;

    VTT::parse(vtt).unwrap();
}

#[test]
fn cue_invalid_start_time_minute() {
    let vtt = r#"WEBVTT

00:11 --> 00:13.000
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_invalid_end_time_minute() {
    let vtt = r#"WEBVTT

00:11.000 --> 00:.000
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_invalid_start_time_hour() {
    let vtt = r#"WEBVTT

00:00:11 --> 00:00:13.000
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn cue_invalid_end_time_hour() {
    let vtt = r#"WEBVTT

00:00:11.000 --> 00:00:.000
<v Roger Bingham>We are in New York City
"#;

    let err = VTT::parse(vtt).unwrap_err();
    assert_eq!(err.line(), 3);
    assert!(matches!(err.kind(), &VTTErrorKind::Parse(_)))
}

#[test]
fn parse_bom_content() {
    let bom = format!("\u{FEFF}{}", SIMPLE);
    let bom = VTT::parse(bom).unwrap();
    assert_eq!(bom, VTT::parse(SIMPLE).unwrap());
}