Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ _ttconv_ works by mapping the input document, whatever its format, into an
internal canonical model, which is then optionally transformed by document
filters, and finally mapped to the format of the output document is derived. The
canonical model closely follows the [TTML 2](https://www.w3.org/TR/ttml2) data
model, as constrained by the [IMSC 1.1 Text
Profile](https://www.w3.org/TR/ttml-imsc1.1/#text-profile) specification.
model, as constrained by the [IMSC 1.3 Text
Profile](https://www.w3.org/TR/ttml-imsc1.3/#profiles) specification.

## Online demo

Expand All @@ -44,15 +44,15 @@ suggestions/contributions are welcome.
### Input Formats

* [CTA 608/.scc](https://en.wikipedia.org/wiki/EIA-608)
* [IMSC 1.1 Text Profile/.ttml](https://www.w3.org/TR/ttml-imsc1.1/#text-profile)
* [IMSC 1.3 Text Profile](https://www.w3.org/TR/ttml-imsc1.3/#profiles)
* [EBU STL](https://tech.ebu.ch/docs/tech/tech3264.pdf)
* [SubRip/.srt](https://en.wikipedia.org/wiki/SubRip)
* [WebVTT](https://www.w3.org/TR/webvtt1/)

### Output Formats

* [SubRip/.srt](https://en.wikipedia.org/wiki/SubRip)
* [IMSC 1.1 Text Profile/.ttml](https://www.w3.org/TR/ttml-imsc1.1/#text-profile)
* [IMSC 1.3 Text Profile](https://www.w3.org/TR/ttml-imsc1.3/#profiles)
* [WebVTT](https://www.w3.org/TR/webvtt1/)
* [CTA 608/.scc](https://en.wikipedia.org/wiki/EIA-608)

Expand Down
3 changes: 2 additions & 1 deletion doc/data_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Overall

The canonical model closely follows the [TTML 2](https://www.w3.org/TR/ttml2) data model, as constrained by the [IMSC 1.1 Text Profile](https://www.w3.org/TR/ttml-imsc1.1/#text-profile) specification. This includes both the static structure of the model as well as temporal, layout and style processing. The objective is for a valid IMSC 1.1 Text Profile document to be mapped into a canonical model instance such that presenting instance results in the same outout as the input IMSC document.
The canonical model closely follows the [TTML 2](https://www.w3.org/TR/ttml2) data model, as constrained by the [IMSC 1.3 Text
Profile](https://www.w3.org/TR/ttml-imsc1.3/#profiles) specification. This includes both the static structure of the model as well as temporal, layout and style processing. The objective is for a valid IMSC 1.3 Text Profile document to be mapped into a canonical model instance such that presenting instance results in the same outout as the input IMSC document.

The canonical model is specified in `ttconv.model`.

Expand Down
6 changes: 4 additions & 2 deletions doc/imsc_reader.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ preserve rendering fidelity but not necessarily structure, e.g. referential styl

## Limitations

The IMSC reader primarily converting TTML documents that conform to the [IMSC 1.1 Text Profile](https://www.w3.org/TR/ttml-imsc1.1/#text-profile), with a few exceptions:
The IMSC reader primarily converting TTML documents that conform to the [IMSC 1.3 Text
Profile](https://www.w3.org/TR/ttml-imsc1.3/#profiles), with a few exceptions:
* `ttp:timeBase="smpte"` is supported with `ttp:dropMode="dropNTSC" | "nonDrop"` (the timecode timestamp are converted to media time in the model)
* the following features introduced in IMSC 1.2 are not supported: `#font`, `#resources` and `#source`.

## Usage

Expand All @@ -27,7 +29,7 @@ doc = imsc_reader.to_model(xml_doc)

The input XML document is traversed using depth-first search (DFS). Each XML element encountered is processed using the `from_xml()`
method of the corresponding class in `ttconv/imsc/elements.py`. For example,
`ttconv.imsc.elements.PElement.from_xml()` is applied to each `<p>` element. Since the data model is a subset of the IMSC 1.1 model,
`ttconv.imsc.elements.PElement.from_xml()` is applied to each `<p>` element. Since the data model is a subset of the IMSC 1.3 model,
additional parsing state is preserved across calls to `from_xml()` by associating each parsed XML element in an instance of the
`ttconv.imsc.elements.TTMLElement.ParsingContext` structure and its subclasses.

Expand Down
4 changes: 2 additions & 2 deletions doc/references.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
| [Line 21 Data Services (ANSI/CTA-608-E S-2019)](https://shop.cta.tech/products/line-21-data-services) | Mapping of SCC into the data model |
| [ST 2052-1:2013 - SMPTE Standard - Timed Text Format (SMPTE-TT)](https://ieeexplore.ieee.org/document/7291854) | Mapping of SCC into the data model |
| [ST 2052-1:2013 - SMPTE Standard - Timed Text Format (SMPTE-TT)](https://ieeexplore.ieee.org/document/7291854) | Mapping of SCC into the data model |
| [IMSC 1.1](https://www.w3.org/TR/ttml-imsc1.1/) | Basis for the data model and specification for the IMSC format |
| [TTML 2](https://www.w3.org/TR/ttml2/) | Parent of IMSC 1.1 |
| [IMSC 1.3](https://www.w3.org/TR/ttml-imsc1.3/) | Basis for the data model and specification for the IMSC format |
| [TTML 2](https://www.w3.org/TR/ttml2/) | Parent of IMSC 1.3 |
| [47 CFR 15.119](https://www.govinfo.gov/app/details/CFR-2010-title47-vol1/CFR-2010-title47-vol1-sec15-119) | Closed caption decoder requirements for analog television receivers |
| [SCC](https://docs.inqscribe.com/2.2/format_scc.html) | Specification of the SCC file format |
| [EBU Tech 3264](https://tech.ebu.ch/docs/tech/tech3264.pdf) | Specification of the EBU Subtitling data exchange format |
Expand Down