subtitler 2.5.0

Parse, convert, validate, edit, and generate subtitles in 15 formats (SRT, VTT, ASS/SSA, MicroDVD, SubViewer, TTML, SBV, LRC, SAMI, MPL2, SCC, EBU STL, DFXP, Whisper JSON). Full CLI included.
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

//! DFXP (Distribution Format Exchange Profile) parser and generator.
//!
//! DFXP is the W3C predecessor to TTML. It shares the same XML structure
//! but uses a different namespace: `xmlns="http://www.w3.org/2006/04/ttaf1"`.
//! This module delegates all parsing and serialization to the TTML module.

use crate::model::{Format, Subtitle, SubtitleFile};
use crate::types::AnyResult;

/// Detect DFXP by the TT AF 1.0 namespace.
///
/// DFXP has two namespace variants:
/// - `http://www.w3.org/2006/04/ttaf1` (DFXP 0.4, older)
/// - `http://www.w3.org/2006/10/ttaf1` (DFXP 1.0, newer)
pub fn detect_format(data: &[u8]) -> Option<Format> {
  let text = crate::encoding::try_decode_for_detection(data)?;
  if text.contains("http://www.w3.org/2006/04/ttaf1")
    || text.contains("http://www.w3.org/2006/10/ttaf1")
  {
    return Some(Format::Dfxp);
  }
  None
}

/// Parse DFXP content — delegates to TTML parser.
pub fn parse_content(content: &str) -> AnyResult<SubtitleFile> {
  let file = crate::ttml::parse_content(content)?;
  // Wrap as Dfxp variant, preserving subtitle content.
  match file {
    SubtitleFile::Ttml { header, subtitles } => Ok(SubtitleFile::Dfxp { header, subtitles }),
    _ => Ok(file),
  }
}

/// Parse DFXP bytes — auto-detect encoding then parse.
pub fn parse_bytes(data: &[u8]) -> AnyResult<SubtitleFile> {
  let content = crate::encoding::decode_to_string(data)?;
  parse_content(&content)
}

/// Parse DFXP from file.
#[cfg(not(target_arch = "wasm32"))]
pub async fn parse_file(path: impl AsRef<std::path::Path>) -> AnyResult<SubtitleFile> {
  let text = tokio::fs::read_to_string(path).await?;
  parse_content(&text)
}

/// Parse DFXP from URL (requires `http` feature).
#[cfg(feature = "http")]
pub async fn parse_url(url: &str) -> AnyResult<SubtitleFile> {
  let response = reqwest::get(url).await?;
  let text = response.text().await?;
  parse_content(&text)
}

/// Serialize subtitles to DFXP format — delegates to TTML serializer.
pub fn to_string(subtitles: &[Subtitle], header: Option<&str>) -> String {
  crate::ttml::to_string(subtitles, header)
}

/// Write subtitles to a file in DFXP format.
#[cfg(not(target_arch = "wasm32"))]
pub async fn generate(
  subtitles: &[Subtitle],
  file_path: impl AsRef<std::path::Path>,
  policy: Option<crate::model::WritePolicy>,
) -> AnyResult<String> {
  let content = to_string(subtitles, None);
  let path = file_path.as_ref();
  crate::io::write_with_policy(path, content.as_bytes(), policy).await?;
  Ok(path.to_string_lossy().into_owned())
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::model::SubtitleFormat;

  #[test]
  fn test_detect_dfxp() {
    let data = br#"<?xml version="1.0" encoding="UTF-8"?>
<tt xmlns="http://www.w3.org/2006/04/ttaf1"
    xmlns:tts="http://www.w3.org/2006/04/ttaf1#styling">
  <body>
    <div>
      <p begin="00:00:01.000" end="00:00:03.500">Hello DFXP</p>
    </div>
  </body>
</tt>"#;
    assert_eq!(detect_format(data), Some(Format::Dfxp));
  }

  #[test]
  fn test_detect_dfxp_v10() {
    // DFXP 1.0 namespace (http://www.w3.org/2006/10/ttaf1)
    let data = br#"<?xml version="1.0" encoding="UTF-8"?>
<tt xmlns="http://www.w3.org/2006/10/ttaf1">
  <body>
    <div>
      <p begin="00:00:01.000" end="00:00:04.000">Hello, this is a test.</p>
    </div>
  </body>
</tt>"#;
    assert_eq!(detect_format(data), Some(Format::Dfxp));
  }

  #[test]
  fn test_detect_dfxp_not_ttml() {
    let data = br#"<?xml version="1.0"?>
<tt xmlns="http://www.w3.org/ns/ttml">
  <body><div><p begin="00:00:01.000" end="00:00:03.500">Hello</p></div></body>
</tt>"#;
    assert_eq!(detect_format(data), None); // TTML namespace, not DFXP
  }

  #[test]
  fn test_parse_round_trip() {
    let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<tt xmlns="http://www.w3.org/2006/04/ttaf1"
    xmlns:tts="http://www.w3.org/2006/04/ttaf1#styling">
  <body>
    <div>
      <p begin="00:00:01.000" end="00:00:03.500">Hello DFXP</p>
    </div>
  </body>
</tt>"#;
    let file = parse_content(xml).unwrap();
    assert_eq!(file.subtitles().len(), 1);
    assert_eq!(file.subtitles()[0].text, "Hello DFXP");
    let out = to_string(file.subtitles(), None);
    assert!(!out.is_empty());
  }
}