subforge
Version:
High-performance subtitle toolkit for parsing, converting, and authoring across 20+ formats.
49 lines (45 loc) • 1.53 kB
text/typescript
// SMPTE-TT (SMPTE Timed Text) support
// SMPTE-TT is a profile of TTML used in broadcast and professional video
import type { SubtitleDocument } from '../../../core/types.ts'
import type { ParseResult } from '../../../core/errors.ts'
import { parseTTML } from './parser.ts'
import { toTTML, type TTMLSerializeOptions } from './serializer.ts'
/**
* Parse SMPTE-TT (SMPTE Timed Text) format subtitle file
*
* SMPTE-TT is a profile of TTML used in broadcast and professional video production.
* It extends TTML with broadcast-specific features and uses timecode format.
*
* @param input - SMPTE-TT file content as string
* @returns ParseResult containing the document and any errors/warnings
*
* @example
* ```ts
* const smpte = `<?xml version="1.0"?>
* <tt xmlns="http://www.w3.org/ns/ttml">
* <body><div>
* <p begin="00:00:01:00" end="00:00:03:00">Hello world</p>
* </div></body>
* </tt>`
* const result = parseSMPTETT(smpte)
* ```
*/
export function parseSMPTETT(input: string): ParseResult {
return parseTTML(input)
}
/**
* Serialize subtitle document to SMPTE-TT format
*
* @param doc - Subtitle document to serialize
* @param opts - Serialization options (format is forced to 'clock')
* @returns SMPTE-TT formatted string
*
* @example
* ```ts
* const smpte = toSMPTETT(doc)
* ```
*/
export function toSMPTETT(doc: SubtitleDocument, opts: TTMLSerializeOptions = {}): string {
// SMPTE-TT uses SMPTE namespace and timecode format
return toTTML(doc, { ...opts, format: 'clock' })
}