Struct rsubs_lib::ssa::SSAFile

source ·

pub struct SSAFile {
    pub events: Vec<SSAEvent>,
    pub styles: Vec<SSAStyle>,
    pub info: HashMap<String, String>,
    pub format: String,
}

Expand description

Contains the styles,events and info as well as a format mentioning wether it’s .ass or .ssa

Fields§

§events: Vec<SSAEvent>§styles: Vec<SSAStyle>§info: HashMap<String, String>§format: String

Implementations§

source §

impl SSAFile

source

pub fn to_srt(self) -> SRTFile

Converts the SSAFile to a SRTFile. Due to .srt being a far less complex format, most styles are being ignored.

Styling of the text can happen with {i1}aaa{i0} tags where i represents the style and 0/1 represent the on/off triggers.

.srt supports HTML-like tags for i,b,u, representing italic, bold, underline.

If found, ssa specific triggers for those supported tags are replaced with their .srt alternatives.

Examples found in repository ?

examples/shift_srt_by_1s.rs (line 20)

fn main() {
    let mut srt = rsubs_lib::srt::parse_from_file("tests/fixtures/test.srt".to_string())
        .expect("failed parsing");
    for line in srt.lines.iter_mut() {
        line.line_end += 20;
        line.line_start += 50;
        line.line_text.push_str(" Ipsum");
    }
    println!("{srt}");
    let s = Subtitle::from_str("tests/fixtures/test.srt").unwrap();

    let a: SSAFile = s.clone().into(); //convert to `.ass` and then back to `.srt`
    assert_eq!(format!("{}", a.to_srt()), format!("{s}"));
}

source

pub fn to_vtt(self) -> VTTFile

Converts the SSAFile to a VTTFile.

Styling of the text can happen with {i1}aaa{i0} tags where i represents the style and 0/1 represent the on/off triggers.

.vtt supports HTML-like tags for i,b,u, representing italic, bold, underline.

If found, ssa specific triggers for those supported tags are replaced with their .vtt alternatives.

In addition, if an SSAEvent has a related SSAStyle, the SSAStyle is converted to a VTTStyle that will be wrapped around the lines indicating it.

source

pub fn to_file<P: AsRef<Path>>(self, path: P) -> Result<()>

Writes the SSAFile to a file specified by a path String.

Examples found in repository ?

examples/change_style_colors.rs (line 14)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut ssa = rsubs_lib::ssa::parse_from_file("tests/fixtures/test.ass".to_string())
        .expect("Encountered Error parsing file");
    for style in ssa.styles.iter_mut() {
        if style.name == "Default" {
            style.firstcolor = ColorType::SSAColor(color::RED);
        }
    }
    ssa.to_file("result.ass")?;
    Ok(())
}

More examples

Hide additional examples

examples/convert_around.rs (line 13)

fn main() {
    vtt::VTTFile::from(srt::SRTFile::from_str("./tests/fixtures/test.srt").unwrap()) // Can read either a file or a string
        // converts file to WEBVTT
        .to_file("./tests/fixtures/ex_test_1.vtt") // Writes the converted subtitle to a file
        .unwrap();
    ssa::SSAFile::from(vtt::parse_from_file("./tests/fixtures/test.vtt".to_string()).unwrap()) // converts file to SSA/ASS
        .to_file("./tests/fixtures/ex_test_1.ass")
        .unwrap();
    srt::SRTFile::from(ssa::parse_from_file("./tests/fixtures/test.ass".to_string()).unwrap())
        // converts file to SRT
        .to_file("./tests/fixtures/ex_test_1.srt")
        .unwrap();
}