substudy 0.5.2

Language-learning tools for working with parallel, bilingual subtitles and media 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

//! Export to web-page based "review" format.

use handlebars::Handlebars;
use serde::Serialize;

use crate::{export::Exporter, lang::Lang, time::Period, Result};

/// Information about a subtitle for use by our Handlebars HTML template.
#[derive(Debug, Serialize)]
struct SubtitleInfo {
    index: usize,
    image_path: String,
    audio_path: String,
    foreign_text: Option<String>,
    native_text: Option<String>,
}

/// Export-related information for use by our Handlebars HTML template.
#[derive(Debug, Serialize)]
struct ExportInfo {
    filename: String,
    subtitles: Vec<SubtitleInfo>,
    foreign_lang: Option<Lang>,
    native_lang: Option<Lang>,
}

/// Export the video and subtitles as a web page in "reviewable" format.
pub fn export_review(exporter: &mut Exporter) -> Result<()> {
    let foreign_lang = exporter.foreign().language;
    // Start preparing information we'll pass to our HTML template.
    let mut bindings = ExportInfo {
        filename: exporter.title().to_owned(),
        subtitles: vec![],
        foreign_lang: foreign_lang,
        native_lang: exporter.native().and_then(|n| n.language),
    };

    // Align our input files and iterate.
    let aligned = exporter.align();
    for sub in aligned.iter().enumerate() {
        let (i, &(ref foreign, ref native)) = sub;
        let index = i + 1;
        let period = Period::from_union_opt(
            foreign.as_ref().map(|s| s.period),
            native.as_ref().map(|s| s.period),
        )
        .expect("subtitle pair must not be empty")
        .grow(0.5, 0.5);

        let image_path = exporter.schedule_image_export(period.midpoint());
        let audio_path = exporter.schedule_audio_export(foreign_lang, period);

        bindings.subtitles.push(SubtitleInfo {
            index: index,
            image_path: image_path,
            audio_path: audio_path,
            foreign_text: foreign.as_ref().map(|s| s.plain_text()),
            native_text: native.as_ref().map(|s| s.plain_text()),
        });
    }

    // Write out our support files.
    exporter.export_data_file("style.css", include_bytes!("style.css"))?;
    exporter.export_data_file("play.svg", include_bytes!("play.svg"))?;

    // Render and write out our HTML.
    let template = include_str!("review.html.hbs");
    let mut handlebars = Handlebars::new();
    handlebars.register_template_string("review", template.to_owned())?;
    let html = handlebars.render("review", &bindings)?;
    exporter.export_data_file("index.html", html.as_bytes())?;

    // Extract our media files.
    exporter.finish_exports()?;

    Ok(())
}