SMPTE RP 428-22a, Minimal Timed Text XML Requirements - OSS Tool (Empty TT)

This repository is public.

Please consult CONTRIBUTING.md, CONFIDENTIALITY.md, LICENSE.md and PATENTS.md for important notices.

Reporting issues

Please report issues at https://github.com/SMPTE/rp428-22a/issues or at the 27C Chairs 27c-chair@smpte.org.

Project details

Empty TT

A tool that enables a user to create a minimal ST 428-7 Subtitle XML Document in accordance with SMPTE Public CD of SMPTE RP 428-22 1ED - D-Cinema Distribution Master – Minimal Timed Text XML Requirements as per requirements stipulated in RDD 52 - SMPTE DCP Bv2.1 Application Profile available at 10.5594/SMPTE.RDD52.2020.

Installation & Build

Empty TT is a multi-platform tool and has been built under Windows/x86_64, Darwin/x86_64 (macOS 10.12 or higher) and linux/x86_64. It relies on ASDCPlib if you want to wrap the generated XML and anciliary resources into D-Cinema MXF track files. ASDCPlib can be found here.

The tt library can be used in two ways;

With the command line wrapper ''empty-tt'
Or with the API directly. See /tt/tt.go or the Go reference for details.

Pre-compiled binaries are provided for convenience and can be found under Releases.

To build from source using Go

go get -u
sh build.sh

Usage

  -T            - write MXF trackfile, requires '-d'  

  -d <int>      - set the duration of the track file. (default 24)  

  -e            - encrypt trackfile  

  -image        - Inidcate that image profile is to be used.  

  -l <string>   - set the RFC 5646 Language subtag (default "en")  

  -m <int>      - set the DisplayType.'0'=MainSubtitle,'1'=ClosedCaption. (default "0")  

  -o <string>   - set the output path, Default is StdOut  

  -p <string>   - set the frame rate of the track file. (default "24")  

  -r <int>      - set the ReelNumber (default 1)  

  -t <string>   - set the ContentTitleText value. (default "No Title")  

  -text         - Inidcate that text profile is to be used. (default true)  

  -x <string>   - path to 428-7 XML to use as template

Examples

The following examples showcase the different command expressions that can be used.

1. Create a MainSubtitle Text profile document

$ empty-tt -text -p 24 -m 0 -r 1 -t "MyTitle"

2. Create an MainSubtitle Image profile document

$ empty-tt -image -p 24 -m 0 -r 1 -t "MyTitle"

3. Create a MainSubtitle Text profile document and MXF track file

$ empty-tt -text -T -p 24 -m 0 -r 1 -t "MyTitle" -d 48 -o <path-to-dir>

4. Create a ClosedCaption Text profile document from XML template and encrypted MXF track file

$ empty-tt -text -T -e -p 24 -m -r 1 -t "MyTitle" -d 48 -x <path-to-xml-file> -o <path-to-dir>

Notes

Writes to StdOut if no output path is specified.
When writing to StdOut, no anciliary resources are generated.
Using the MXF option "-T" also requires "-o".
Generates a unique PNG image every execution.
Any integer value greater than 1 for option "-m" results in a ClosedCaption DisplayType.
An template document with a DCST 2007 namespace will be rejected.
Documents are written with a DCST 2014 namespace by default.
The shipped bundled default Font is Arial Unicode with no glyph structures present. It has a file name of constant = "232c45d8-fde8-4e5e-86b9-86e96354daf3".
Available flags can be invoked out of order.
The TimeIn value will adjust automatically depending if the Reel number is >= 1.
file prefix and suffix are handled automatically and are structed as follows:
1. XML: uuid_reelNo.xml
2. MXF: uuid_reelNo_sub.mxf | uuid_reelNo_cap.mxf

Disclaimer

Although care has been taken to ensure that default behaviour of this program conforms to the constraints defined in the ST 429-2 and RDD 52 documents, it is permissible for non-compliant files to be generated. The sole purpose of this tool is to fulfil testing and educational criteria. Where there is any reliance on its use in production, the following notice is to be observed.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

SMPTE / rp428-22a

readme