W3C Candidate Recommendation Draft
Copyright © 2025World Wide Web Consortium.W3C®liability,trademark anddocument use rules apply.
This section describes the status of this document at the time of its publication. A list of currentW3C publications and the latest revision of this technical report can be found in theW3C standards and drafts index at https://www.w3.org/TR/.
This document incorporates aregistry section and definesregistry tables, as defined in the [w3c-process] requirements forw3c registries. Updates to the document that only changeregistry tables can be made without meeting other requirements for Recommendation track updates, as set out inUpdating Registry Tables; requirements for updating those registry tables are normatively specified withinH.Registry Section.
Please see the Working Group'simplementation report.
For this specification to exit the CR stage, at least 2 independent implementations of every feature defined in this specification but not already present in [TTML2] need to be documented in the implementation report. The Working Group does not require that implementations are publicly available but encourages them to be so.
A list of the substantive changes applied since theinitial Working Draft is found atsubstantive-changes-summary.txt.
The Working Group has identified the followingat risk features:
Possible resolution to#113.
Possible resolution to#113.
Possible resolution to#114 and#115.
The link to#115 is that this implies the existence of some referenceable embedded audio resource too, which one of the options described in#115.
Possible resolution to#114 and#115.
The link to#115 is that this implies the existence of some referenceable embedded audio resource too, which one of the options described in#115.
Possible resolution to#115.
Possible resolution to#117.
Possible resolution to#117.
Support for the#scriptEventGrouping
and#scriptEventMapping
features, together, is at risk pending implementer feedback.
At risk features may be be removed before advancement to Proposed Recommendation.
This document was published by theTimed Text Working Group as a Candidate Recommendation Draft using theRecommendation track.
Publication as a Candidate Recommendation does not imply endorsement byW3C and its Members. A Candidate Recommendation Draft integrates changes from the previous Candidate Recommendation that the Working Group intends to include in a subsequent Candidate Recommendation Snapshot.
This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress. Future updates to this specification may incorporatenew features.
This document was produced by a group operating under theW3C Patent Policy.W3C maintains apublic list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes containsEssential Claim(s) must disclose the information in accordance withsection 6 of theW3C Patent Policy.
This document is governed by the03 November 2023W3C Process Document.
This specification defines a text-based profile of the Timed Text Markup Language version 2.0 [TTML2] intended to supportdubbing andaudio description workflows worldwide, to meet the requirements defined in [DAPT-REQS], and to permit usage of visual presentation features within [TTML2] and its profiles, for example those in [TTML-IMSC1.2].
This section is non-normative.
In general usage, one meaning of the wordscript is the written text of a film, television programme, play etc. A script can be either a record of the completed production, also known as a transcript, or as a plan for a yet to be created production. In this document, we use domain-specific terms, and define more specifically that:
The termDAPT script is used generically to refer to bothtranscripts andscripts, and is a point of conformance to the formal requirements of this specification.DAPT Scripts consist of timed text and associated metadata, such as the character speaking.
In dubbing workflows, atranscript is generated and translated to create ascript. In audio description workflows, atranscript describes the video image, and is then used directly as ascript for recording an audio equivalent.
DAPT is aTTML-based format for the exchange oftranscripts andscripts (i.e.DAPT Scripts) among authoring, prompting and playback tools in the localization andaudio description pipelines. ADAPT document is a serializable form of aDAPT Script designed to carry pertinent information for dubbing oraudio description such as type ofDAPT script, dialogue, descriptions, timing, metadata, original language transcribed text, translated text, language information, and audio mixing instructions, and to be extensible to allow user-defined annotations or additional future features.
This specification defines the data model forDAPT scripts and its representation as a [TTML2] document (see4.DAPT Data Model and correspondingTTML syntax) with some constraints and restrictions (see5.Constraints).
ADAPT script is expected to be used to make audio visual media accessible or localized for users who cannot understand it in its original form, and to be used as part of the solution for meeting user needs involvingtranscripts, including accessibility needs described in [media-accessibility-reqs], as well as supporting users who need dialogue translated into a different language via dubbing.
Every part of theDAPT script content is required to be marked up with some indication of what it represents in the related media, via theRepresents property; likewise theDAPT Script as a whole is required to list all the types of content that it represents, for example if it represents audio content or visual content, and if visual, then if it represents text or non-text etc. A registry of hierarchical content descriptors is provided.
The authoring workflow for both dubbing and audio description involves similar stages, that share common requirements as described in [DAPT-REQS]. In both cases, the author reviews the content and writes down what is happening, either in the dialogue or in the video image, alongside the time when it happens. Further transformation processes can change the text to a different language and adjust the wording to fit precise timing constraints. Then there is a stage in which an audio rendering of thescript is generated, for eventual mixing into the programme audio. That mixing can occur prior to distribution, or in the player directly.
Thedubbing process which consists in creating adubbing script is a complex, multi-step process involving:
Adubbing script is atranscript orscript (depending on workflow stage) used for recording translated dialogue to be mixed with the non-dialogue programme audio, to generate a localized version of the programme in a different language, known as a dubbed version, or dub for short.
Dubbing scripts can be useful as a starting point for creation of subtitles or closed captions in alternate languages. This specification is designed to facilitate the addition of, and conversion to, subtitle and caption documents in other profiles ofTTML, such as [TTML-IMSC1.2], for example by permitting subtitle styling syntax to be carried inDAPT documents. Alternatively, styling can be applied to assist voice artists when recording scripted dialogue.
Creating audio description content is also a multi-stage process. Anaudio description, also known as video description or in [media-accessibility-reqs] asdescribed video, is an audio service to assist viewers who can not fully see a visual presentation to understand the content. It is the result of mixing themain programme audio with the audio rendition of eachdescription, authored to be timed when it does not clash with dialogue, to deliver an audio description mixed audio track.Main programme audio refers to the audio associated with the programme prior to any further mixing. Adescription is a set of words that describes an aspect of the programme presentation, suitable for rendering into audio by means of vocalisation and recording or used as a text alternative source for text to speech translation, as defined in [WCAG22]. More information about whataudio description is and how it works can be found at [BBC-WHP051].
Writing the audio descriptionscript typically involves:
The audio mixing can occur prior to distribution of the media, or in the client. If theaudio descriptionscript is delivered to the player, the text can be used to provide an alternative rendering, for example on a Braille display, or using the user's configured screen reader.
DAPT Scripts can be useful in other workflows and scenarios. For example,Original language transcripts could be used as:
BothOriginal language transcripts andTranslated transcripts could be used as:
The top level structure of a document is as follows:
<tt>
root element in the namespacehttp://www.w3.org/ns/ttml
indicates that this is aTTML document and thettp:contentProfiles
attribute indicates that it adheres to theDAPTcontent profile defined in this specification.daptm:scriptRepresents
attribute indicates what the contents of the document are an alternative for, within the original programme.daptm:scriptType
attribute indicates the type oftranscript orscript but in this empty example, it is not relevant, since only the structure of the document is shown.daptm:langSrc
attribute indicates the default text language source, for example the original language of the content, while thexml:lang
attribute indicates the default language in this script, which in this case is the same. Both of these attributes are inherited and can be overridden within the content of the document.The structure is applicable to all types ofDAPT scripts, dubbing oraudio description.
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"xml:lang="en"daptm:langSrc="en"daptm:scriptRepresents="audio"daptm:scriptType="originalTranscript"><head><metadata><!-- Additional metadata may be placed here --><!-- Any characters must be defined here as a set of ttm:agent elements --></metadata><styling><!-- Styling is optional and consists of a set of style elements --></styling><layout><!-- Layout is optional and consists of a set of region elements --></layout></head><body><!-- Content goes here and consists of a div for each Script Event --><divxml:id="d1"begin="..."end="..."daptm:represents="audio.dialogue"><p><!-- Text blocks are contained in p elements --></p><pxml:lang="fr"daptm:langSrc="en"><!-- Translation text is related to the source language for the translation --></p></div></body></tt>
The following examples correspond to the timed texttranscripts andscripts produced at each stage of the workflow described in [DAPT-REQS].
The first example shows an early stagetranscript in which timed opportunities for descriptions or transcriptions have been identified but no text has been written; thedaptm:represents
attribute present on the<body>
element here is inherited by the<div>
elements since they do not specify a different value:
...<bodydaptm:represents="..."><divxml:id="id1"begin="10s"end="13s"></div><divxml:id="id2"begin="18s"end="20s"></div></body>...
The following examples will demonstrate different uses in dubbing and audio description workflows.
When descriptions are added this becomes aPre-Recording Script. Note that in this case, to reflect that most of the audio description content transcribes the video image where there is no inherent language, theText Language Source, represented by the
attribute, is set to the empty string at the top level of the document. It would be semantically equivalent to omit the attribute altogether, since the default value is the empty string:daptm:langSrc
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"xmlns:xml="http://www.w3.org/XML/1998/namespace"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"xml:lang="en"daptm:langSrc=""daptm:scriptRepresents="visual.nonText"daptm:scriptType="preRecording"><body><divbegin="10s"end="13s"xml:id="a1"daptm:represents="visual.nonText"><p> A woman climbs into a small sailing boat.</p></div><divbegin="18s"end="20s"xml:id="a2"daptm:represents="visual.nonText"><p> The woman pulls the tiller and the boat turns.</p></div></body></tt>
Audio description content often includes text present in the visual image, for example if the image contains a written sign, a location, etc. The following example demonstrates such a case:Script Represents is extended to show that thescript's contents represent textual visual information in addition to non-textual visual information. Here a more precise value ofRepresents is specified on theScript Event to reflect that the text is in fact a location, which is allowed because the more precise value is asub-type of the new value inScript Represents. Finally, since the text has an inherent language, theText Language Source is set to reflect that language.
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"xmlns:xml="http://www.w3.org/XML/1998/namespace"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"xml:lang="en"daptm:langSrc=""daptm:scriptRepresents="visual.nonText visual.text"daptm:scriptType="preRecording"><body><divbegin="7s"end="8.5s"xml:id="at1"daptm:represents="visual.text.location"daptm:langSrc="en"><p> The Lake District, England</p></div><divbegin="10s"end="13s"xml:id="a1"daptm:represents="visual.nonText"><p> A woman climbs into a small sailing boat.</p></div><divbegin="18s"end="20s"xml:id="a2"daptm:represents="visual.nonText"><p> The woman pulls the tiller and the boat turns.</p></div></body></tt>
After creating audio recordings, if not using text to speech, instructions for playback mixing can be inserted. For example, The gain of "received" audio can be changed before mixing in the audio played from inside the<span>
element, smoothly animating the value on the way in and returning it on the way out:
<tt...daptm:scriptRepresents="visual.nonText"daptm:scriptType="asRecorded"xml:lang="en"daptm:langSrc=""> ...<divbegin="25s"end="28s"xml:id="a3"daptm:represents="visual.nonText"><p><animatebegin="0.0s"end="0.3s"tta:gain="1;0.39"fill="freeze"/><animatebegin="2.7s"end="3s"tta:gain="0.39;1"/><spanbegin="0.3s"end="2.7s"><audiosrc="clip3.wav"/> The sails billow in the wind.</span></p></div>...
At the document level, thedaptm:scriptRepresents
attribute indicates that the document represents both visual text and visual non-text content in the related media. It is possible that there are no Script Events that actually represent visual text, for example because there is no text in the video image.
In the above example, the<div>
element'sbegin
attribute defines the time that is the "syncbase" for its child, so the times on the<animate>
and<span>
elements are relative to 25s here. The first<animate>
element drops the gain from 1 to 0.39 over 0.3s, freezing that value after it ends, and the second one raises it back in the final 0.3s of this description. Then the<span>
element is timed to begin only after the first audio dip has finished.
If the audio recording is long and just a snippet needs to be played, that can be done usingclipBegin
andclipEnd
. If we just want to play the part of the audio from file from 5s to 8s it would look like:
... <span><audio src="long_audio.wav" clipBegin="5s" clipEnd="8s"/> A woman climbs into a small sailing boat.</span>...
Or audio attributes can be added to trigger the text to be spoken:
...<divbegin="18s"end="20s"xml:id="a2"><p><spantta:speak="normal"> The woman pulls the tiller and the boat turns.</span></p></div>...
It is also possible to embed the audio directly, so that a single document contains thescript and recorded audio together:
...<divbegin="25s"end="28s"xml:id="a3"><p><animatebegin="0.0s"end="0.3s"tta:gain="1;0.39"fill="freeze"/><animatebegin="2.7s"end="3s"tta:gain="0.39;1"/><spanbegin="0.3s"end="2.7s"><audio><source><datatype="audio/wave"> [base64-encoded audio data]</data></source></audio> The sails billow in the wind.</span></p></div>...
From the basic structure ofExample 1, transcribing the audio produces an original language dubbingtranscript, which can look as follows. No specific style or layout is defined, and here the focus is on the transcription of the dialogue. Characters are identified within the<metadata>
element. Note that the language and thetext language source are defined usingxml:lang
and
attributes respectively, which have the same value because the transcript is not translated.daptm:langSrc
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttm="http://www.w3.org/ns/ttml#metadata"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"xml:lang="fr"daptm:langSrc="fr"daptm:scriptRepresents="audio.dialogue"daptm:scriptType="originalTranscript"><head><metadata><ttm:agenttype="character"xml:id="character_1"><ttm:nametype="alias">ASSANE</ttm:name></ttm:agent></metadata></head><body><divbegin="10s"end="13s"xml:id="d1"daptm:represents="audio.dialogue"><pttm:agent="character_1"><span>Et c'est grâce à ça qu'on va devenir riches.</span></p></div></body></tt>
After translating the text, the document is modified. It includes translation text, and in this case the original text is preserved. The main document'sdefault language is changed to indicate that the focus is on the translated language. The combination of thexml:lang
and
attributes are used to mark the text as being original or translated. In this case, they are present on both thedaptm:langSrc
<tt>
and<p>
elements to make the example easier to read, but it would also be possible to omit them in some cases, making use of the inheritance model:
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttm="http://www.w3.org/ns/ttml#metadata"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"xml:lang="en"daptm:langSrc="fr"daptm:scriptRepresents="audio.dialogue"daptm:scriptType="translatedTranscript"><head><metadata><ttm:agenttype="character"xml:id="character_1"><ttm:nametype="alias">ASSANE</ttm:name></ttm:agent></metadata></head><body><divbegin="10s"end="13s"xml:id="d1"ttm:agent="character_1"daptm:represents="audio.dialogue"><pxml:lang="fr"daptm:langSrc="fr"><!-- original --><span>Et c'est grâce à ça qu'on va devenir riches.</span></p><pxml:lang="en"daptm:langSrc="fr"><!-- translated --><span>And thanks to that, we're gonna get rich.</span></p></div></body></tt>
The process of adaptation, before recording, could adjust the wording and/or add further timing to assist in the recording. Thedaptm:scriptType
attribute is also modified, as in the following example:
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttm="http://www.w3.org/ns/ttml#metadata"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"xml:lang="en"daptm:langSrc="fr"daptm:scriptRepresents="audio.dialogue"daptm:scriptType="preRecording"><head><metadata><ttm:agenttype="character"xml:id="character_1"><ttm:nametype="alias">ASSANE</ttm:name></ttm:agent></metadata></head><body><divbegin="10s"end="13s"xml:id="d1"ttm:agent="character_1"daptm:onScreen="ON_OFF"daptm:represents="audio.dialogue"><pxml:lang="fr"daptm:langSrc="fr"><span>Et c'est grâce à ça qu'on va devenir riches.</span></p><pxml:lang="en"daptm:langSrc="fr"><spanbegin="0s">And thanks to that,</span><spanbegin="1.5s"> we're gonna get rich.</span></p></div></body></tt>
This document uses the following conventions:
<someElement>
. The entity is also described as an element in the prose. If the name of an element referenced in this specification is not namespace qualified, then the TT namespace applies (seeNamespaces).attributePrefix:attributeName
and those without prefixes are styled asattributeName
. The entity is also described as an attribute in the prose.daptm:foo
as a string with two possible values:bar
andbaz
.daptm:foo : "bar" | "baz"
LocationPath
notation is used. For example, to refer to the first<metadata>
element child of the<head>
element child of the<tt>
element, the following path would be used:/tt/head/metadata[0]
.Content in registry table sections has different requirements for updates than other Recommendation track content, as defined in [w3c-process].
This section specifies the data model forDAPT and its correspondingTTML syntax. In the model, there are objects which can have properties and be associated with other objects. In theTTML syntax, these objects and properties are expressed as elements and attributes, though it is not always the case that objects are expressed as elements and properties as attributes.
Figure1 illustrates theDAPT data model, hyperlinking every object and property to its corresponding section in this document.Shared properties are shown in italics. All other conventions in the diagram are as per [uml].
See also#115 - if we are going to support non-inline embedded audio resources, should we make an object for them and add it into the Data Model?
ADAPT Script is atranscript orscript that corresponds to a document processed within an authoring workflow or processed by a client, and conforms to the constraints of this specification. It has properties and objects defined in the following sections:Script Represents,Script Type,Default Language,Text Language Source,Script Events and, forDubbing Scripts,Characters.
ADAPT Document is a [TTML2]timed text content document instance representing aDAPT Script. ADAPT Document has the structure and constraints defined in this and the following sections.
A [TTML2]timed text content document instance has a root<tt>
element in the TT namespace.
TheScript Represents property is a mandatory property of aDAPT Script which indicates which components of therelated media object the contents of the document represent. The contents of the document could be used as part of a mechanism to provide an accessible alternative for those components.
Script Events have a related property,Represents, and there are constraints about the permitted values of that property that are dependent on the values ofScript Represents.
To represent this property, thedaptm:scriptRepresents
attributeMUST be present on the<tt>
element, with a value conforming to the following syntax:
daptm:scriptRepresents: <content-descriptor
> ( <lwsp>+ <content-descriptor>)*<lwsp> # as TTML2
A dubbing script might havedaptm:scriptRepresents="audio.dialogue"
.
An audio description script might havedaptm:scriptRepresents="visual.nonText visual.text visual.dialogue"
.
A post-production script that could be the precursor to a hard of hearing subtitle document might havedaptm:scriptRepresents="audio.dialogue audio.nonDialogueSounds"
.
TheDefault Language is a mandatory property of aDAPT Script which represents the default language for theText content ofScript Events. This language may be one of the original languages or aTranslation language. When it represents aTranslation language, it may be the final language for which a dubbing or audio descriptionscript is being prepared, called theTarget Recording Language or it may be an intermediate, or pivot, language used in the workflow.
TheDefault Language is represented in aDAPT Document by the following structure and constraints:
xml:lang
attributeMUST be present on the<tt>
element and its valueMUST NOT be empty.All text content in aDAPT Script has a specified language. When multiple languages are used, theDefault Language can correspond to the language of the majority ofScript Events, to the language being spoken for the longest duration, or to a language arbitrarily chosen by the author.
xml:lang="da"
on the<tt>
element.Script Events that contain SwedishText override this by settingxml:lang="sv"
on the<p>
element.Script Events that contain DanishText can set thexml:lang
attribute or omit it, since the inherited language is theDefault Language of the document. In both cases the Script Events'Text objects are<p>
elements that represent untranslated content that had an inherent language (in this case dialogue) and therefore set thedaptm:langSrc
attribute to their source language, implying that they are in theOriginal language.TheScript Type property is a mandatory property of aDAPT Script which describes the type of documents used in Dubbing and Audio Description workflows, among the following:Original Language Transcript,Translated Transcript,Pre-recording Script,As-recorded Script.
To represent this property, thedaptm:scriptType
attributeMUST be present on the<tt>
element:
daptm:scriptType : "originalTranscript" | "translatedTranscript" | "preRecording" | "asRecorded"
The definitions of the types of documents and the correspondingdaptm:scriptType
attribute values are:
When thedaptm:scriptType
attribute value isoriginalTranscript
, the document is a literal transcription of the dialogue and/or on-screen text in their inherent spoken/written language(s), or of non-dialogue sounds and non-linguistic visual content.
Script Events in this type oftranscript:
When thedaptm:scriptType
attribute value istranslatedTranscript
, the document represents a translation of theOriginal Language Transcript in a common language.
It can be adapted to produce aPre-Recording Script, and/or used as the basis for a further translation into theTarget Recording Language.
Script Events in this type oftranscript:
When thedaptm:scriptType
attribute value ispreRecording
, the document represents the result of the adaptation of anOriginal Language Transcript or aTranslated Transcript for recording, e.g. for better lip-sync in a dubbing workflow, or to ensure that the words can fit within the time available in an audio description workflow.
Script Events in this type ofscript:
When thedaptm:scriptType
attribute value isasRecorded
, the document represents the actual audio recording.
Script Events in this type ofscript:
The following example is orphaned - move to the top of the section, before the enumerated script types?
<ttdaptm:scriptType="originalTranscript">...</tt>
ADAPT ScriptMAY contain zero or moreScript Event objects, each corresponding to dialogue, on screen text, or descriptions for a given time interval.
If anyScript Events are present, theDAPT DocumentMUST have one<body>
element child of the<tt>
element.
ADAPT ScriptMAY contain zero or moreCharacter objects, each describing a character that can be referenced by aScript Event.
If anyCharacter objects are present, theDAPT DocumentMUST have one<head>
element child of the<tt>
element, and that<head>
elementMUST have at least one<metadata>
element child.
4.2Character recommends that all theCharacter objects be located within a single<metadata>
element parent, and in the case that there are more than one<metadata>
element children of the<head>
element, that theCharacter objects are located in the first such child.
Some of the properties in theDAPT data model are common within more than one object type, and carry the same semantic everywhere they occur. Theseshared properties are listed in this section.
Some of the value sets inDAPT are reused across more than one property, and have the same constraints everywhere they occur. These shared value sets are also listed in this section.
Would it be better to make a "Timed Object" class and subclass Script Event, Mixing Instruction and Audio Recording from it?
The followingtiming properties define when the entities that contain them are active:
The end time of aDAPT Script is for practical purposes the end of theRelated Media Object.
The values permitted in theScript Represents andRepresents properties depend on the<content-descriptor>
syntactic definition and its associated registry table.
<
has a value conforming to the following syntax:content-descriptor
>
<content-descriptor> # see registry table below: <descriptor-token> ( <descriptor-delimiter> <descriptor-token> )*<descriptor-token>: (descriptorTokenChar)+descriptorTokenChar #xsd:NMtoken without the ".":NameStartChar | "-" | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]<descriptor-delimiter>: "." # FULL STOP U+002E
<
has values that are delimiter separated ordered lists of tokens.content-descriptor
>
A<
valueB is acontent descriptorsub-type (sub-type) of anothercontent-descriptor
><content-descriptor>
valueA if A's ordered list ofdescriptor-tokens
is present at the beginning of B's ordered list ofdescriptor-tokens
.
<content-descriptor> A | <content-descriptor> B | Is B asub-type of A? |
---|---|---|
visual.text | visual | No |
visual.text | visual.text | Yes |
visual.text | visual.text.location | yes |
For example, in this table, A could be one of the values listed inScript Represents property, and B could be the value of aRepresents property.
The permitted values for<
are either those listed in the followingregistry table, or can be user-defined.content-descriptor
>
Valid user-defined valuesMUST begin withx-
or besub-types of values in thecontent-descriptor
registry table, where the first additional<
component begins withdescriptor-token
>x-
.
< | Status | Description | Example usage |
---|---|---|---|
audio | Provisional | Indicates that theDAPT content represents any part of the audio programme. | Dubbing, translation and hard of hearing subtitles and captions, pre- and post- production scripts |
audio.dialogue | Provisional | Indicates that theDAPT content represents verbal communication in the audio programme, for example, a spoken conversation. | Dubbing, translation and hard of hearing subtitles and captions, pre- and post- production scripts |
audio.nonDialogueSounds | Provisional | Indicates that theDAPT content represents a part of the audio programme corresponding to sounds that are not verbal communication, for example, significant sounds, such as a door being slammed in anger. | Translation and hard of hearing subtitles and captions, pre- and post- production scripts |
visual | Provisional | Indicates that theDAPT content represents any part of the visual image of the programme. | Audio Description |
visual.dialogue | Provisional | Indicates that theDAPT content represents verbal communication, within the visual image of the programme, for example, a signed conversation. | Dubbing or Audio Description, translation and hard of hearing subtitles and captions, pre- and post- production scripts |
visual.nonText | Provisional | Indicates that theDAPT content represents non-textual parts of the visual image of the programme, for example, a significant object in the scene. | Audio Description |
visual.text | Provisional | Indicates that theDAPT content represents textual content in the visual image of the programme, for example, a signpost, a clock, a newspaper headline, an instant message etc. | Audio Description |
visual.text.title | Provisional | Asub-type ofvisual.text where the text is the title of the related media. | Audio Description |
visual.text.credit | Provisional | Asub-type ofvisual.text where the text is a credit, e.g. the name of an actor. | Audio Description |
visual.text.location | Provisional | Asub-type ofvisual.text where the text indicates the location where the content is occurring. | Audio Description |
Some entities in the data model include unique identifiers. AUnique Identifier has the following requirements:
it is unique within theDAPT Script, i.e. the value of aUnique Identifier can only be used one time within the document, regardless of which specific kind of identifier it is.
If aCharacter Identifier has the value"abc"
and aScript Event Identifier in the same document has the same value, that is an error.
its value has to conform to the requirements ofName
as defined by [XML]
It cannot begin with a digit, a combining diacritical mark (an accent), or any of the following characters:
. - ·// #xB7 ‿// #x203F ⁀// #x2040
but those characters can be used elsewhere.
AUnique Identifier for an entity is expressed in aDAPT Document by anxml:id
attribute on the corresponding element.
The formal requirements for the semantics and processing ofxml:id
are defined in [xml-id].
This section is mainly relevant toDubbing workflows.
A character in the programme can be described using aCharacter object which has the following properties:
ACharacter is represented in aDAPT Document by the following structure and constraints:
<ttm:agent>
element present at the path/tt/head/metadata/ttm:agent
, with the following constraints:type
attributeMUST be set tocharacter
.xml:id
attributeMUST be present on the<ttm:agent>
element and set to theCharacter Identifier.<ttm:agent>
elementMUST contain a<ttm:name>
element with itstype
attribute set toalias
and its content set to theCharacter Name.If the Character has aTalent Name, itMUST contain a<ttm:actor>
child element. That child elementMUST have anagent
attribute set to the value of thexml:id
attribute of a separate<ttm:agent>
element corresponding to theTalent Name, that is, whosetype
attribute is set toperson
.
The requirement for an additional<ttm:agent>
element corresponding to theTalent Name is defined in the following bullet list.
...<metadata><ttm:agenttype="character"xml:id="character_1"><ttm:nametype="alias">DESK CLERK</ttm:name></ttm:agent></metadata>...
...<metadata><ttm:agenttype="person"xml:id="actor_A"><ttm:nametype="full">Matthias Schoenaerts</ttm:name></ttm:agent><ttm:agenttype="character"xml:id="character_2"><ttm:nametype="alias">BOOKER</ttm:name><ttm:actoragent="actor_A"/></ttm:agent></metadata>...
<ttm:agent>
element corresponding to theTalent NameMUST be present at the path/tt/head/metadata/ttm:agent
, with the following constraints:type
attributeMUST be set toperson
xml:id
attributeMUST be set.<ttm:name>
child element whosetype
MUST be set tofull
and its content set to theTalent Name<ttm:agent>
element corresponding to thatTalent Name, referenced separately by each of theCharacters.<ttm:agent>
element corresponding to aTalent NameSHOULD appear before any of theCharacter<ttm:agent>
elements whose<ttm:actor>
child element references it.<ttm:agent>
elementsSHOULD be contained in the first<metadata>
element in the<head>
element.<metadata>
elements in the<head>
element, for example to includeproprietary metadata but the above recommends that only one is used to define the characters.ttm:agent
elements can have foreign attributes and elements. This can be used to provide additional, proprietary character information.We should define our own classes of conformant implementation types, to avoid using the generic "presentation processor" or "transformation processor" ones. We could link to them.
At the moment, I can think of the following classes:
AScript Event object represents dialogue, on screen text or audio descriptions to be spoken and has the following properties:
TypicallyScript Events do not overlap in time. However, there can be cases where they do, e.g. inDubbing Scripts when differentCharacters speak different text at the same time.
While typically, aScript Event corresponds to one singleCharacter, there are cases where multiplecharacters can be associated with aScript Event. This is when allCharacters speak the same text at the same time.
In atranscript, when the event corresponds to in-image content, for example anaudio description, noCharacter Identifier is needed. However it may be helpful in aPre-recording Script or anAs-recorded Script context to indicate aCharacter signifying who voices the recording.
Zero or moreText objects, each being eitherOriginal orTranslation.
AScript Event with noText objects can be created as part of an initial phase of authoring, in workflows where it is helpful to block out the time intervals during which some content could be present. For example, an emptyScript Event withtiming properties can be created to identify an opportunity for creating an audio description. See also[DAPT-REQS] Process Step 1.
AScript Event is represented in aDAPT Document at the path/tt/head/body//div
, with the following structure and constraints:
Based on discussion at#216 (comment), I think we should have an explicit signal to indicate when a div represents a Script Event.
<div>
element ancestors in the path between the<body>
element and the<div>
element corresponding to theScript Event. No further semantic is defined for such elements.<div>
element corresponding to theScript Event, with the following constraints:xml:id
attributeMUST be present containing theScript Event Identifier.Thebegin
,end
anddur
attributes represent respectively theBegin,End andDuration of theScript Event.
Thebegin
andend
attributesSHOULD be present. Thedur
attributeMAY be present.
See4.1.6.1Timing Properties for additional notes on timing properties.
ttm:agent
attributeMAY be present and if present,MUST contain a reference to eachttm:agent
attribute that represents an associatedCharacter....<divxml:id="event_1"begin="9663f"end="9682f"ttm:agent="character_4">...</div>...
daptm:represents
attributeMAY be present representing theRepresents property....<divxml:id="event_1"begin="9663f"end="9682f"daptm:represents="audio.dialogue">...</div>...
daptm:represents
attributeMUST be a valid non-empty value.daptm:represents
attribute on an ancestor element, sinceRepresents is an inheritable property.<p>
elements representing eachText object.<metadata>
element representing theOn Screen property.<div>
element children.TheText object contains text content typically in a single language. This language may be theOriginal language or aTranslation language.
Text is defined asOriginal if it is any of:
Text is defined asTranslation if it is a representation of anOriginalText object in a different language.
Text can beidentified as beingOriginal orTranslation by inspecting its language and itsText Language Source together, according to the semantics defined inText Language Source.
The source language ofTranslationText objects and, where applicable,OriginalText objects is indicated using theText Language Source property.
AText object may be styled.
Zero or moreMixing Instruction objects used to modify the programme audio during theTextMAY be present.
AText object is represented in aDAPT Document by a<p>
element at the path/tt/head/body//div/p
, with the following constraints:
<p>
element and of all of its<span>
descendant elements, after<metadata>
elements and foreign elements have been pruned, after replacing<br>
elements by line breaks, and after applying White Space Handling as defined in [XML].<br>
or<span>
which can include or referenceTTML style attributes such astts:ruby
used to alter the layout or styling of sections of text within each paragraph. Mixed direction text, for example interleaved left to right (ltr) and right to left (rtl) text, can be specified by using thetts:direction
attribute on<span>
elements. Similarly metadata can be added using attributes or<metadata>
elements.<p>
elementSHOULD have adaptm:langSrc
attribute representing theText object'sText Language Source, that is, indicating whether theText isOriginal or aTranslation and if its source had an inherent language.If a<p>
element omits the
attribute then its computed value is derived by inheritance from its parent element, and so forth up to the rootdaptm:langSrc
<tt>
element.
Inscripts that have very little variation in source language, the
attribute can be set on the root element and omitted fromdaptm:langSrc
<p>
elements except where its value differs.
Care should be taken if using this approach, especially when moving betweenScript Types, because changing it at the root element could affect the interpretation of descendant elements unexpectedly. In tools that allow fine-grained control, authors can mitigate this risk by explicitly setting the
attribute on alldaptm:langSrc
<p>
elements.
Implementers should take care to ensure that, when changing the
attribute on an element, they check down the tree and if appropriate specify the attribute on descendant elements so that their meaning does not change unintentionally.daptm:langSrc
<p>
elementSHOULD have anxml:lang
attribute corresponding to the language of theText object.If a<p>
element omits thexml:lang
attribute then its computed language is derived by inheritance from its parent element, and so forth up to the root<tt>
element, which is required to set theDefault Language via itsxml:lang
attribute.
Care should be taken if changing theDefault Language of aDAPT Script in case doing so affects descendant elements unexpectedly. In tools that allow fine-grained control, authors can mitigate this risk by explicitly setting thexml:lang
attribute on all<p>
elements.
Implementers should take care to ensure that, when changing thexml:lang
attribute on an element, they check down the tree and if appropriate specify the attribute on descendant elements so that their meaning does not change unintentionally.
<divxml:id="event_3"begin="9663f"end="9682f"ttm:agent="character_3"><pxml:lang="pt-BR">Você vai ter.</p><pxml:lang="fr"daptm:langSrc="pt-BR">Bah, il arrive.</p></div>
In some cases, a single section of untranslated dialogue can contain text in more than one language. Rather than splitting aScript Event into multipleScript Events to deal with this,Text objects in one language can also contain some words in a different language. This is represented in aDAPT Document by setting thexml:lang
and
attributes on innerdaptm:langSrc
<span>
elements.
<span>
elements can be used to add specific timing as illustrated inExample 10 to indicate the timing of the audio rendering of the relevant section of text. Per [TTML2], timing of the<span>
element is relative to the parent element's computed begin time.
<audio>
elements representing eachAudio Recording object.<animate>
elements representing eachMixing Instruction object.TheText Language Source property is an annotation indicating the source language of aText object, if applicable, or that the source content had no inherent language:
Text Language Source is an inheritable property.
TheText Language Source property is represented in aDAPT Document by adaptm:langSrc
attribute with the following syntax, constraints and semantics:
daptm:langSrc: <empty-string> | <language-identifier><empty-string>: "" # default<language-identifier> # valid BCP-47 language tag
<p>
and<span>
elements.<tt>
,<p>
and<span>
.daptm:langSrc
attribute is as follows:The inheritance model of the
attribute is intended to match the inheritance model of thedaptm:langSrc
xml:lang
attribute [XML].
xml:lang
attribute, then it indicates that theText isOriginal and sourced from content with an inherent language.xml:lang
attribute), it indicates that theText is atranslation, and the computed value is the language from which theText was translated.An example of the usage ofText Language Source in a document is present in theText section.
Transcript source | Inherent language of the transcript source | xml:lang | daptm:langSrc |
---|---|---|---|
In-image text | English | en | en |
Video image (non text) | none | en | empty |
Sound effect | none | en | empty |
Dialogue | Arabic | ar | ar |
If any of these transcripts were translated, the resultingText would have its
attribute set to the computed value of thedaptm:langSrc
xml:lang
attribute of the source.
For example, if the Arabic dialogue were translated into Japanese, it would result inxml:lang="ja"
anddaptm:langSrc="ar"
.
TheOn Screen property is an annotation indicating the position in the scene relating to the subject of aScript Event, for example of thecharacter speaking:
If omitted, the default value is "ON".
daptm:represents
attribute value begins withvisual
the subject of eachScript Event, i.e. what is being described, is expected to be in the video image, therefore the default of "ON" allows the property to be omitted in those cases without distortion of meaning.TheOn Screen property is represented in aDAPT Document by adaptm:onScreen
attribute on the<div>
element, with the following constraints:
daptm:onScreen : "ON" # default | "OFF" | "ON_OFF" | "OFF_ON"
TheRepresents property indicates which component of therelated media object theScript Event represents.
TheRepresents property is represented in aDAPT Document by adaptm:represents
attribute, whose valueMUST be a single<
.content-descriptor
>
TheRepresents property is inheritable. If it is absent from an element then its computed value is the computed value of theRepresents property on its parent element, or, if it has no parent element, it is the empty string. If it is present on an element then its computed value is the value specified.
Since there is no empty <content-descriptor
>, this implies that an empty computedRepresents property can never be valid; one way to construct a validDAPT Document is to specify aRepresents property on theDAPT Script so that it is inherited by all descendants that do not have aRepresents property.
It is an error for aRepresents property value not to be acontent descriptorsub-type of at least one of the values in theScript Represents property.
TheScript Event Description object is an annotation providing a human-readable description of some aspect of the content of aScript Event. Script Event Descriptions can themselves be classified with aDescription Type.
AScript Event Description object is represented in aDAPT Document by a<ttm:desc>
element at the<div>
element level.
Zero or more<ttm:desc>
elementsMAY be present.
Script Event DescriptionsSHOULD NOT be empty.
TheScript Event Description does not need to be unique, i.e. it does not need to have a different value for eachScript Event. For example a particular value could be re-used to identify in a human-readable way one or moreScript Events that are intended to be processed together, e.g. in a batch recording.
The<ttm:desc>
elementMAY specify its language using thexml:lang
attribute.
xml:lang
attribute the language of theScript Event Description is inherited from the parentScript Event object....<body><divbegin="10s"end="13s"xml:id="a1"><ttm:desc>Scene 1</ttm:desc><pxml:lang="en"><span>A woman climbs into a small sailing boat.</span></p><pxml:lang="fr"daptm:langSrc="en"><span>Une femme monte à bord d'un petit bateau à voile.</span></p></div><divbegin="18s"end="20s"xml:id="a2"><ttm:desc>Scene 1</ttm:desc><pxml:lang="en"><span>The woman pulls the tiller and the boat turns.</span></p><pxml:lang="fr"daptm:langSrc="en"><span>La femme tire sur la barre et le bateau tourne.</span></p></div></body>...
EachScript Event Description can be annotated with one or moreDescription Types to categorise further the purpose of the Script Event Description.
EachDescription Type is represented in aDAPT Document by adaptm:descType
attribute on the<ttm:desc>
element.
The<ttm:desc>
elementMAY have zero or onedaptm:descType
attributes. Thedaptm:descType
attribute is defined below.
daptm:descType : string
The permitted values fordaptm:descType
are either those listed in the followingregistry table, or can be user-defined:
daptm:descType | Status | Description | Notes |
---|---|---|---|
pronunciationNote | Provisional | Notes for how to pronounce the content. | |
scene | Provisional | Contains a scene identifier | |
plotSignificance | Provisional | Defines a measure of how significant the content is to the plot. | Contents are undefined and may be low, medium or high, or a numerical scale. |
Valid user-defined valuesMUST begin withx-
.
...<body><divbegin="10s"end="13s"xml:id="a123"><ttm:descdaptm:descType="pronunciationNote">[oːnʲ]</ttm:desc><p>Eóin looks around at the other assembly members.</p></div></body>...
Amongst a sibling group of<ttm:desc>
elements there are no constraints on the uniqueness of thedaptm:descType
attribute, however it may be useful as a distinguisher as shown in the following example.
...<body><divbegin="10s"end="13s"xml:id="a1"><ttm:descdaptm:descType="scene">Scene 1</ttm:desc><ttm:descdaptm:descType="plotSignificance">High</ttm:desc><pxml:lang="en"><span>A woman climbs into a small sailing boat.</span></p><pxml:lang="fr"daptm:langSrc="en"><span>Une femme monte à bord d'un petit bateau à voile.</span></p></div><divbegin="18s"end="20s"xml:id="a2"><ttm:descdaptm:descType="scene">Scene 1</ttm:desc><ttm:descdaptm:descType="plotSignificance">Low</ttm:desc><pxml:lang="en"><span>The woman pulls the tiller and the boat turns.</span></p><pxml:lang="fr"daptm:langSrc="en"><span>La femme tire sur la barre et le bateau tourne.</span></p></div></body>...
AnAudio object is used to specify an audio rendering of aText. The audio rendering can either be a recorded audio resource, as anAudio Recording object, or a directive to synthesize a rendering of the text via a text to speech engine, which is aSynthesized Audio object. Both are types ofAudio object.
It is an error for anAudio not to be in the same language as itsText.
Apresentation processor that supports audio plays or inserts theAudio at the specified time on therelated media object's timeline.
TheAudio object is "abstract": it only can exist as one of its sub-types,Audio Recording orSynthesized Audio.
AnAudio Recording is anAudio object that references an audio resource. It has the following properties:
audio/basic
;The defaultIn Time is the beginning of the audio resource.
The defaultOut Time is the end of the audio resource.
If the temporal subsection of the audio resource is longer than the duration of theAudio Recording's time interval, then playbackMUST be truncated to end when theAudio Recording's time interval ends.
If the temporal subsection of the audio resource is shorter than the duration of theAudio Recording's time interval, then the audio resource plays once.
When a list ofSources is provided, apresentation processorMUST play no more than one of theSources for eachAudio Recording.
Implementations can use theType, and if present, any relevant additional formatting information, to decide whichSource to play. For example, given twoSources, one being a WAV file, and the other an MP3, an implementation that can play only one of those formats, or is configured to have a preference for one or the other, would select the playable or preferred version.
AnAudio Recording is represented in aDAPT Document by an<audio>
element child of a<p>
or<span>
element corresponding to theText to which it applies. The following constraints apply to the<audio>
element:
begin
,end
anddur
attributes represent respectively theBegin,End andDuration properties;clipBegin
andclipEnd
attributes represent respectively theIn Time andOut Time properties, as illustrated byExample 5;src
attribute that is not a fragment identifier, and atype
attribute respectively;This mechanism cannot be used if there is more than oneSource.
<audio src="https://example.com/audio.wav" type="audio/wave"/>
<source>
child element with asrc
attribute that is not a fragment identifier and atype
attribute respectively;<audio> <source src="https://example.com/audio.wav" type="audio/wave"/> <source src="https://example.com/audio.aac" type="audio/aac"/></audio>
Asrc
attribute that is not a fragment identifier is a URL that references an external audio resource, i.e. one that is not embedded within theDAPT Script. No validation that the resource can be located is specified inDAPT.
Do we need both mechanisms here? It's not clear what semantic advantage the child<source>
element carries in this case. Consider marking use of that child<source>
element as "at risk"?
While working on the specification for adding audio recordings I reminded myself of the various ways in which an audio recording can be embedded and referenced, of which there are at least 5 in total. Requirement R15 of [DAPT](https://www.w3.org/TR/dapt-reqs/#requirements) is clear that both referenced and embedded options need to be available, but should we be syntactically restricting the options for each? Will raise as separate issues.
Originally posted by@nigelmegitt in#105 (comment)
The following two options exist in TTML2 for referencingexternal audio resources:
src
attribute in<audio>
element.<audio src="https://example.com/audio_recording.wav" type="audio/wave"/>
<source>
element child of<audio>
element.<audio> <source src="https://example.com/audio_recording.wav" type="audio/wave"/></audio>
This second option has an additional possibility of specifying aformat
attribute in casetype
is inadequate. It also permitsmultiple<source>
child elements, and we specify that in this case the implementation must choose no more than one.
[Edited 2023-03-29 to account for the "play no more than one" constraint added after the issue was opened]
Possible resolution to#113.
Possible resolution to#113.
src
attribute that is a fragment identifier that references either an<audio>
element or a<data>
element, where the referenced element is a child of/tt/head/resources
and specifies atype
attribute and thexml:id
attribute used to reference it;This mechanism cannot be used if there is more than oneSource.
<tt><head><resources><datatype="audio/wave"xml:id="audio1"> [base64-encoded WAV audio resource]</data></resources></head><body> ..<audiosrc="#audio1"/> ..</body></tt>
<source>
child element with asrc
attribute that is a fragment identifier that references either an<audio>
element or a<data>
element, where the referenced element is a child of/tt/head/resources
and specifies atype
attribute and thexml:id
attribute used to reference it;<tt><head><resources><datatype="audio/wave"xml:id="audio1wav"> [base64-encoded WAV audio resource]</data><datatype="audio/mpeg"xml:id="audio1mp3"> [base64-encoded MP3 audio resource]</data></resources></head><body> ..<audio><sourcesrc="#audio1wav"/><sourcesrc="#audio1mp3"/></audio> ..</body></tt>
<source>
child element with a<data>
element child that specifies atype
attribute and contains the audio recording data.<audio><source><datatype="audio/wave"> [base64-encoded WAV audio resource]</data></source></audio>
In each of the cases above thetype
attribute represents theType property.
Asrc
attribute that is a fragment identifier is a pointer to an audio resource that is embedded within theDAPT Script
If<data>
elements are defined, each oneMUST contain either#PCDATA
or<chunk>
child elements andMUST NOT contain any<source>
child elements.
<data>
and<source>
elementsMAY contain aformat
attribute whose value implementationsMAY use in addition to thetype
attribute value when selecting an appropriate audio resource.
Do we need all 3 mechanisms here? Do we need any? There may be a use case for embedding audio data, since it makes the single document a portable (though large) entity that can be exchanged and transferred with no concern for missing resources, and no need for e.g. manifest files. If we do not need to support referenced embedded audio then only the last option is needed, and is probably the simplest to implement. One case for referenced embedded audio is that it more easily allows reuse of the same audio in different document locations, though that seems like an unlikely requirement in this use case. Another is that it means that all embedded audio is in an easily located part of the document intt/head/resources
, which potentially could carry an implementation benefit? Consider marking the embedded data features as "at risk"?
While working on the specification for adding audio recordings I reminded myself of the various ways in which an audio recording can be embedded and referenced, of which there are at least 5 in total. Requirement R15 of [DAPT](https://www.w3.org/TR/dapt-reqs/#requirements) is clear that both referenced and embedded options need to be available, but should we be syntactically restricting the options for each? Will raise as separate issues.
Originally posted by@nigelmegitt in#105 (comment)
Given some embedded audio resources:
<head> <resources> <audio xml:id="audioRecording1" type="audio/wave"> <source> <data>[base64 encoded audio data]</data> </source> </audio> <data xml:id="audioRecording2" type="audio/wave"> [base64 encoded audio data] </data> </resources></head>
The following two options exist in TTML2 for referencingembedded audio resources:
src
attribute in<audio>
element referencing embedded<audio>
or<data>
:<audio src="#audioRecording1"/>...<audio src="#audioRecording2"/>
<source>
element child of<audio>
element.<audio> <source src="#audioRecording1"/></audio>
This second option has an additional possibility of specifying aformat
attribute in casetype
is inadequate. It also permitsmultiple<source>
child elements, though it is unclear what the semantic is intended to be if multiple resources are specified - presumably, the implementation gets to choose one somehow.
While working on the specification for adding audio recordings I reminded myself of the various ways in which an audio recording can be embedded and referenced, of which there are at least 5 in total. Requirement R15 of [DAPT](https://www.w3.org/TR/dapt-reqs/#requirements) is clear that both referenced and embedded options need to be available, but should we be syntactically restricting the options for each? Will raise as separate issues.
Originally posted by@nigelmegitt in#105 (comment)
If we are going to support embedded audio resources, they can either be defined in/tt/head/resources
and then referenced, or the data can be included inline.
Do we need both options?
Example of embedded:
<head> <resources> <audio xml:id="audioRecording1" type="audio/wave"> <source> <data>[base64 encoded audio data]</data> </source> </audio> <data xml:id="audioRecording2" type="audio/wave"> [base64 encoded audio data] </data> </resources></head>
This would then be referenced in the body content using something like (see also#114):
<audio src="#audioRecording2"/>
Example of inline:
<audio type="audio/wave"> <source type="audio/wave"> <data>[base64 encoded audio data]</data> </source></audio>
Possible resolution to#114 and#115.
The link to#115 is that this implies the existence of some referenceable embedded audio resource too, which one of the options described in#115.
Possible resolution to#114 and#115.
The link to#115 is that this implies the existence of some referenceable embedded audio resource too, which one of the options described in#115.
Possible resolution to#115.
See also#115 - if we are going to support non-inline embedded audio resources, should we make an object for them and add it into the Data Model?
In TTML2's<data>
element, anencoding
can be specified, being one of:
Do we need to require processor support for all of them, or will the defaultbase64
be adequate?
Also, it is possible to specify alength
attribute that provides some feasibility of error checking, since the decoded data must be the specified length in bytes. Is requiring support for this a net benefit? Would it be used?
Possible resolution to#117.
Possible resolution to#117.
xml:lang
attributeMUST be identical to the computed value of thexml:lang
attribute of the parent element and any child<source>
elements and any referenced embedded<data>
elements.ASynthesized Audio is anAudio object that represents a machine generated audio rendering of the parentText content. It has the following properties:
normal
,fast
orslow
;ASynthesized Audio is represented in aDAPT Document by the application of atta:speak
style attribute on the element representing theText object to be spoken, where the computed value of the attribute isnormal
,fast
orslow
. This attribute also represents theRate Property.
Thetta:pitch
style attribute represents thePitch property.
TheTTML representation of aSynthesized Audio is illustrated byExample 6.
Atta:pitch
attribute on an element whose computed value of thetta:rate
attribute isnone
has no effect. Such an element is not considered to have an associatedSynthesized Audio.
The semantics of theSynthesized Audio vocabulary ofDAPT are derived from equivalent features in [SSML] as indicated in [TTML2]. This version of the specification does not specify how other features of [SSML] can be either generated fromDAPT or embedded intoDAPT documents. The option to extend [SSML] support in future versions of this specification is deliberately left open.
AMixing Instruction object is a static or animated adjustment of the audio relating to the containing object. It has the following properties:
freeze
) or reverted (remove
).AMixing Instruction is represented by applying audio style attributes to the element that corresponds to the relevant object, either inline, by reference to a<style>
element, or in a child (inline)<animate>
element:
If theMixing Instruction is animated, that is, if the adjustment properties change during the containing object's active time interval, then it is represented by one or more child<animate>
elements. This representation is required if more than oneGain orPan property is needed, or if anytiming properties are needed.
The<animate>
element(s)MUST be children of the element corresponding to the containing object, and have the following constraints:
begin
,end
anddur
attributes represent respectively theBegin,End andDuration properties;fill
attribute represents theFill property;tta:gain
attribute represents theGain property, and uses theanimation-value-list
syntax to express the list of values to be applied during the animation period;tta:pan
attribute represents thePan property, and uses theanimation-value-list
syntax to express the list of values to be applied during the animation period.TheTTML representation of animatedMixing Instructions is illustrated byExample 4.
See alsoE.Audio Mixing.
ADAPT DocumentMUST be serialised as a well-formed XML 1.0 [xml] document encoded using the UTF-8 character encoding as specified in [UNICODE].
The resulting [xml] documentMUST NOT contain any of the following physical structures:
The resulting [xml] document can containcharacter references, andentity references topredefined entities.
The predefined entities are (including the leading ampersand and trailing semicolon):
&
for an ampersand & (unicode code point U+0026)'
for an apostrophe ' (unicode code point U+0027)>
for a greater than sign > (unicode code point U+003E)<
for a less than sign < (unicode code point U+003C)"
for a quote symbol " (unicode code point U+0022)ADAPT Document can also be used as an in-memory model for processing, in which case the serialisation requirements do not apply.
The requirements in this section are intended to facilitate forwards and backwards compatibility, specifically to permit:
ADAPT document that conforms to more than one version of the specification could specify conformance to multipleDAPTcontent profiles.
Unrecognised vocabulary is the set of elements and attributes that are not associated withfeatures that the processor supports.
Atransformation processorMUST pruneunrecognised vocabulary that is neither an attribute nor a descendant of a<metadata>
element.
Atransformation processorSHOULD preserveunrecognised vocabulary that is either an attribute or a descendant of a<metadata>
element.
See also5.6.2ttp:contentProfiles
which prohibits the signalling of profile conformance to profiles that thetransformation processor does not support.
Afterattribute value computation, apresentation processorSHOULD ignoreunrecognised vocabulary.
The above constraint is specified as being after attribute value computation because it is possible that an implementation recognises and supports attributes present only on particular elements, for example those corresponding to theDAPT data model. As described in6.4Using computed attribute values it is important that processor implementations do not ignore such attributes when present on other elements.
Foreign vocabulary is the subset ofunrecognised vocabulary that consists of those elements and attributes whose namespace is not one of the namespaces listed in5.3Namespaces and those attributes whose namespace has no value that are not otherwise defined inDAPT or in [TTML2].
ADAPT DocumentMAY containforeign vocabulary that is neither specifically permitted nor forbidden by the profiles signalled inttp:contentProfiles
.
For validation purposes it is good practice to define and use a specification for allforeign vocabulary used within aDAPT Document, for example acontent profile.
Many dubbing andaudio description workflows permit annotation ofScript Events or documents with proprietary metadata. Metadata vocabulary defined in this specification or in [TTML2]MAY be included.Foreign vocabularyMAY also be included, either as attributes of<metadata>
elements or as descendant elements of<metadata>
elements.
It is possible to add information such as the title of the programme using [TTML2] constructs.
...<head><metadata><ttm:title>A example document title</ttm:title></metadata></head>...
It is possible to add workflow-specific information using a foreign namespace. In the following example, a fictitious namespacevendorm
from an "example vendor" is used to provide document-level information not defined byDAPT.
...<metadataxmlns:vendorm="http://www.example-vendor.com/ns/ttml#metadata"><vendorm:programType>Episode</vendorm:programType><vendorm:episodeSeason>5</vendorm:episodeSeason><vendorm:episodeNumber>8</vendorm:episodeNumber><vendorm:internalId>15734</vendorm:internalId><vendorm:information>Some proprietary information</vendorm:information></metadata>...
<metadata>
elements.Such data can be invalidated bytransformation processors that modify the contents of the document but preserve metadata while being unaware of their semantics.
This section is non-normative.
Ifforeign vocabulary is included in locations other than<metadata>
elements it will be pruned bytransformation processors that do not support features associated with that vocabulary, as required in5.2.1Unrecognised vocabulary.
A mechanism is provided to prevent such pruning, and to define semantics for suchforeign vocabulary, allowing it to be located outside a<metadata>
element without being pruned, and to indicate content and processor conformance:
ttp:contentProfiles
This allows processors that support the feature to process the vocabulary in whatever way is appropriate, to avoid pruning it, and allows processors that do not support the feature to take appropriate action, for example warning users that some functionality may be lost.
The following namespaces (see [xml-names]) are used in this specification:
Name | Prefix | Value | Defining Specification |
---|---|---|---|
XML | xml | http://www.w3.org/XML/1998/namespace | [xml-names] |
TT | tt | http://www.w3.org/ns/ttml | [TTML2] |
TT Parameter | ttp | http://www.w3.org/ns/ttml#parameter | [TTML2] |
TT Audio Style | tta | http://www.w3.org/ns/ttml#audio | [TTML2] |
TT Metadata | ttm | http://www.w3.org/ns/ttml#metadata | [TTML2] |
TT Feature | none | http://www.w3.org/ns/ttml/feature/ | [TTML2] |
DAPT Metadata | daptm | http://www.w3.org/ns/ttml/profile/dapt#metadata | This specification |
DAPT Extension | none | http://www.w3.org/ns/ttml/profile/dapt/extension/ | This specification |
EBU-TT Metadata | ebuttm | urn:ebu:tt:metadata | [EBU-TT-3390] |
The namespace prefix values defined above are for convenience andDAPT DocumentsMAY use any prefix value that conforms to [xml-names].
The namespaces defined by this specification are mutable as described in [namespaceState]; all undefined names in these namespaces are reserved for future standardization by theW3C.
WithinDAPT, the common language terms audio and video are used in the context of a programme. The audio and video are each a part of what is defined in [TTML2] as theRelated Media Object that provides the media timeline and is the source of themain programme audio, and any visual timing references needed when adjusting timings relevant to the video image, such as for lip synchronization.
ADAPT document can identify the programme acting as theRelated Media Object using metadata. For example, it is possible to use the<ebuttm:sourceMediaIdentifier>
element defined in [EBU-TT-3390].
<ttxmlns="http://www.w3.org/ns/ttml"xmlns:ttp="http://www.w3.org/ns/ttml#parameter"xmlns:daptm="http://www.w3.org/ns/ttml/profile/dapt#metadata"xmlns:ebuttm="urn:ebu:tt:metadata"xml:lang="en"ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"daptm:scriptRepresents="audio.dialogue"daptm:scriptType="originalTranscript"><head><metadata><ebuttm:sourceMediaIdentifier>https://example.org/programme.mov</ebuttm:sourceMediaIdentifier></metadata></head><body> ...</body></tt>
If theDAPT Document is intended to be used as the basis for producing an [TTML-IMSC1.2] document, the synchronization provisions of [TTML-IMSC1.2] apply in relation to the video.
Timed content within theDAPT Document is intended to be rendered starting and ending on specific audio samples.
In the context of this specification rendering could be visual presentation of text, for example to show an actor what words to speak, or could be audible playback of an audio resource, or could be physical or haptic, such as a Braille display.
In constrained applications, such as real-time audio mixing and playback, if accurate synchronization to the audio sample cannot be achieved in the rendered output, the combined effects of authoring and playback inaccuracies in timed changes in presentationSHOULD meet the synchronization requirements of [EBU-R37], i.e. audio changes are not to precede image changes by more than 40ms, and are not to follow them by more than 60ms.
Likewise, authoring applicationsSHOULD allow authors to meet the requirements of [EBU-R37] by defining times with an accuracy such that changes to audio are less than 15ms after any associated change in the video image, and less than 5ms before any associated change in the video image.
Taken together, the above two constraints on overall presentation and onDAPT documents intended for real-time playback mean thatcontent processorsSHOULD complete audio presentation changes no more than 35ms before the time specified in theDAPT document and no more than 45ms after the time specified.
This profile is associated with the following profile designators:
Profile Name | Profile type | Profile Designator |
---|---|---|
DAPT 1.0 Content Profile | content profile | http://www.w3.org/ns/ttml/profile/dapt1.0/content |
DAPT 1.0 Processor Profile | processor profile | http://www.w3.org/ns/ttml/profile/dapt1.0/processor |
Thettp:contentProfiles
attribute is used to declare the [TTML2] profiles to which the document conforms.
DAPT DocumentsMUST specify a
attribute on thettp:contentProfiles
<tt>
element including at least one value equal to acontent profile designator specified at5.6.1Profile Designators. Other valuesMAY be present to declare conformance to other profiles of [TTML2], andMAY include profile designators in proprietary namespaces.
It is an error for aDAPT Document to signal conformance to acontent profile to which it does not conform.
Transformation processorsMUST NOT include values within the
attribute associated with profiles that they (the processors) do not support; by definition they cannot verify conformance of the content to those profiles.ttp:contentProfiles
Thettp:profile
attribute is a mechanism within [TTML1] for declaring the processing requirements for aDocument Instance. It has effectively been superceded in [TTML2] by
.ttp:processorProfiles
DAPT DocumentsMUST NOT specify attp:profile
attribute on the<tt>
element.
Thettp:processorProfiles
attribute is used to declare the processing requirements for aDocument Instance.
DAPT DocumentsMAY specify a
attribute on thettp:processorProfiles
<tt>
element. If present, the
attributeMUST include at least one value equal to aprocessor profile designator specified at5.6.1Profile Designators. Other valuesMAY be present to declare additional processing constraints, andMAY include profile designators in proprietary namespaces.ttp:processorProfiles
The
attribute can be used to signal that features and extensions in additional profiles need to be supported to process theDocument Instance successfully. For example, a local workflow might introduce particular metadata requirements, and signal that the processor needs to support those by using an additional processor profile designator.ttp:processorProfiles
If the content author does not need to signal that additional processor requirements than those defined byDAPT are needed to process theDAPT document then the
attribute is not expected to be present.ttp:processorProfiles
[TTML2] specifies a vocabulary and semantics that can be used to define the set offeatures that adocument instance can make use of, or that a processor needs to support, known as aProfile.
Except where specified, it is not a requirement ofDAPT that this profile vocabulary is supported by processors; nevertheless such support is permitted.
The majority of this profile vocabulary is used to indicate how a processor can compute the set of features that it needs to support in order to process theDocument Instance successfully. The vocabulary is itself defined in terms of TTML2 features. Those profile-related features are listed withinF.Profiles as being optional. TheyMAY be implemented in processors and their associated vocabularyMAY be present inDAPT Documents.
Unless processor support for these features and vocabulary has been arranged (using an out-of-band protocol), the vocabulary is not expected to be present.
The additional profile-related vocabulary for which processor support is not required (but is permitted) inDAPT is:
<ttp:profile>
element;<ttp:feature>
and<ttp:extension>
elements;ttp:permitFeatureNarrowing
attribute;ttp:permitFeatureWidening
attribute;ttp:contentProfileCombination
attribute;ttp:inferProcessorProfileSource
attribute;ttp:processorProfileCombination
attribute.Within aDAPT Script, the following constraints apply in relation to time attributes and time expressions:
The only permittedttp:timeBase
attribute value ismedia
, sinceF.Profiles prohibits all timeBase features other than#timeBase-media
.
This means that the beginning of the document timeline, i.e. time "zero", is the beginning of theRelated Media Object.
The only permitted value of thetimeContainer
attribute is the default value,par
.
DocumentsSHOULD omit thetimeContainer
attribute on all elements.
DocumentsMUST NOT set thetimeContainer
attribute to any value other thanpar
on any element.
This means that thebegin
attribute value for every timed element is relative to the computed begin time of its parent element, or for the<body>
element, to time zero.
If the document contains any time expression that uses thef
metric, or any time expression that contains a frames component, thettp:frameRate
attributeMUST be present on the<tt>
element.
If the document contains any time expression that uses thet
metric, thettp:tickRate
attributeMUST be present on the<tt>
element.
All time expressions within a documentSHOULD use the same syntax, eitherclock-time
oroffset-time
as defined in [TTML2], withDAPT constraints applied.
ADAPTclock-time
has one of the forms:
hh:mm:ss.sss
hh:mm:ss
wherehh
is hours,mm
is minutes,ss
is seconds, andss.sss
is seconds with a decimal fraction of seconds (any precision).
Clock time expressions that use frame components, which look similar to "time code", are prohibited due to the semantic confusion that has been observed elsewhere when they are used, particularly with non-integer frame rates, "drop modes" and sub-frame rates.
Anoffset-time
has one of the forms:
nn metric
nn.nn metric
wherenn
is an integer,nn.nn
is a number with a decimal fraction (any precision), andmetric
is one of:
h
for hours,m
for minutes,s
for seconds,ms
for milliseconds,f
for frames, andt
for ticks.When mapping a media time expression M to a frame F of the video, e.g. for the purpose of accurately timing lip synchronization, thecontent processorSHOULD map M to the frame F with the presentation time that is the closest to, but not less, than M.
A media time expression of 00:00:05.1 corresponds to frameceiling( 5.1 × ( 1000 / 1001 × 30) ) = 153
of a video that has a frame rate of1000 / 1001 × 30 ≈ 29.97
.
This specification does not put additional constraints on the layout and renderingfeatures defined in [TTML-IMSC1.2].
<layout>
element is used in the<head>
element) or may be explicit by the use of theregion
attribute, to refer to a<region>
element present at/tt/head/layout/region
.Style references or inline stylesMAY be used, using any combination ofstyle
attributes,<style>
elements and inline style attributes as defined in [TTML2] or [TTML-IMSC1.2].
The following metadata elements are permitted inDAPT and specified in [TTML2] as containing#PCDATA
, i.e. text data only with no element content. Where bidirectional text is required within the character content within such an element, Unicode control characters can be used to define the base direction within arbitrary ranges of text.
<ttm:copyright>
<ttm:desc>
<ttm:item>
<ttm:name>
<ttm:title>
More guidance about usage of this mechanism is available atInline markup and bidirectional text in HTML.
The<p>
and<span>
content elements permit the direction of text to be specified using thetts:direction
andtts:unicodeBidi
attributes. Document authors should use this more robust mechanism rather than using Unicode control characters.
The following example taken from [TTML2] demonstrates the syntax for bidirectional text markup within the<p>
and<span>
elements.
<p>The title of the book is"<spantts:unicodeBidi="embed"tts:direction="rtl">نشاط التدويل، W3C</span>"</p>
An example rendering of the above fragment is shown below.
4.DAPT Data Model and correspondingTTML syntax defines how objects and properties of theDAPT data model are represented in [TTML2], i.e. in aDAPT Document. However, aDAPT data model instance can be represented by multiple [TTML2]document instances.
For example,4.DAPT Data Model and correspondingTTML syntax does not mandate that a<div>
element representing aScript Event be a direct child of the<body>
element. That<div>
element could be nested in another<div>
element. Therefore, it is possible to serialize the objects and properties of aDAPT Script into variousDAPT Documents. This section defines how to interoperably and unambiguously reconstruct aDAPT model instance from aDAPT Document.
DAPT does not define a complete serialization of theDAPT data model for extensibility reasons, to allow future versions to do so if needed. Additionally, aDAPT Document can contain elements or attributes that are not mentioned in the representations ofDAPT objects or properties. This could be because it has been generated by a processor conformant to some future version ofDAPT, or through a generic [TTML2] process, or because it uses optional features, for example to add styling or layout. This section defines how to process those elements or attributes.
It is also possible to processDAPT Documents using generic [TTML2] processors, which do not necessarily map the documents to theDAPT data model. For example a generic TTML2presentation processor could render an audio mix based on aDAPT document without needing to model Script Eventsper se. In that case, this section can be ignored.
This section is non-normative.
Normative provisions relating to this section are defined in [TTML2].
Since it is a requirement ofDAPT thatDAPT Documents include attp:contentProfiles
attribute on the root element, and that the attribute includes aDAPTcontent profile designator, as specified at5.6.2ttp:contentProfiles
, it follows that anyTTML document that does not include such an attribute, or does not include such a profile designator, can be considered not to be aDAPT Document; therefore a processor requiring strict adherence toDAPT could stop processing such a document.
A processor that takes as its input aDAPT document that contains vocabulary relating to features that it does support, but where support for those features is excluded from the content profiles to which the document claims conformance,SHOULD NOT implement those features in the context of that document.
[TTML2] allows<div>
elements to contain any combination of<div>
elements and<p>
elements. TheDAPT data model describes how eachScript Event is represented by a<div>
element that contains zero or more<p>
elements. It also permits other intermediate<div>
elements in the path between the<body>
element and thoseScript Event<div>
elements. In addition, attributes not corresponding to properties in theDAPT data model are permitted.
This gives rise to possibilities such as:
<div>
elements that contain children that are notText objects, for example other<div>
elements or<metadata>
elements;<div>
elements that do not have attributes required forScript Events, likexml:id
;<div>
elements that have attributes absent from theDAPT data model forScript Events, likexml:space
;<p>
elements whose parent<div>
element does not appear to be aScript Event.The following processing rules resolve these cases.
Rules for identifyingScript Events:
<div>
element that has no<div>
element children and includes theTTML representations of all the mandatory properties of aScript EventMUST be mapped to aScript Event, such as having a validxml:id
representing theScript Event Identifier, even if it also contains additionalunrecognised vocabulary;<div>
element that contains any<div>
element childrenMUST NOT be mapped to aScript Event; the processor insteadMUST iterate through those<div>
element children (recursively, in a depth-first traversal) and consider if each one meets the requirements of aScript Event;<div>
elementsMUST NOT be mapped to aScript Event.Rules for identifyingText objects:
<p>
element that is a child of a<div>
element that maps to aScript EventMUST be mapped to aText object.<p>
element that is not a child of a<div>
element that maps to aScript EventMUST NOT be mapped to aText object.<body><divxml:id="d1"><!-- This is a Script Event --><p><!-- This is a Text --></p></div><div><!-- This cannot be a Script Event because it has no xml:id --><p><!-- Would be a Text if its parent were a Script Event --></p></div><divxml:id="d2_1"><!-- div parent of another div --><divxml:id="d2"><!-- Possibly a Script Event --></div></div><divxml:id="d3_1"><!-- double layer of nesting --><divxml:id="d3_1_1"><divxml:id="d3"begin="..."end="..."xml:lang="ja"foo:bar="baz"><!-- A Script Event with possibly unexpected attributes --></div></div></div><divxml:id="d4_1"><!-- mixed div and p children --><divxml:id="d4_2"><!-- This possible Script Event has a sibling <p> --></div><p><!-- Possible Text, but not if its parent is not a Script Event --></p></div></body>
The result of applying the above rules to this example is:
d1
is aScript Event and its child<p>
element is aText object;<div>
element betweend1
andd2
's parent<div>
element is not aScript Event and its child<p>
element is not aText object;d2
is aScript Event and its parent<div>
element is not;d3
is aScript Event and its parent and its grandparent<div>
elements are not;d4_1
is not aScript Event and its child<p>
element is not aText object;d4_2
is aScript Event.Some attributes have semantics for computing their value that depend on the computed value of the attribute on some other element. For example if thexml:lang
attribute is not specified on an element then its computed value is the computed value of the same attribute on the element's parent.
Or, for another example, the computed times of an element in aDAPT document are relative to the begin time of the element's parent. If a<div>
element specifies abegin
attribute, then the computed times of its child<div>
elements are relative to that parent<div>
element's begin time, and so on down the hierarchy. It is important to include those "intermediate"<div>
elements' times in the computation even if the processing target is an instance of theDAPT data model in which they have no direct equivalent; otherwise theScript EventBegin andEnd times would be wrong.
Considering this situation more generally, it is possible that, within aDAPT document, there can beTTML elements that do not directly correspond to objects in theDAPT data model, and those elements can specify attributes that affect the computation of attribute values that apply to elements that do correspond to objects in theDAPT data model.
The semantics defined by [TTML2] or, for vocabulary defined herein, this specification, take precedence in this scenario. ImplementationsMUST compute attribute values based on the contents of thedocument instancebefore applying those computed values toDAPT data model objects. For example a processor that supports TTML2 styling features would need to implement the TTML2 semantics for inheritance and computing relative values of attributes liketts:fontSize
.
This example demonstrates these possibilities, which a processor might need to handle:
<tt...xml:lang="en"><body><divxml:id="d1"begin="00:01:00"end="00:01:10"><!-- Script Event beginning at 1 minute, duration 10 seconds --><p><!-- This is a Text, language "en" --></p></div><divbegin="00:10:00"xml:lang="fr"><!-- div that is not a Script Event --><divxml:id="d2"begin="00:01:00"end="00:01:10"><!-- Script Event beginning at 11 minutes, duration 10 seconds --><p><!-- This is a Text, language "fr" --></p></div></div></body></tt>
Here, the<div>
elements that correspond toScript Events, which have idsd1
andd2
, are otherwise (apart from their identifiers) identical, yet their language andBegin properties have different computed values, due to the attributes specified on the<div>
element parent ofd2
.
If an implementation internally createsDAPT data model objects, such as theScript Events shown in the example above, it is important for interoperability that they use the computed values.
This section is non-normative.
As per5.2.1Unrecognised vocabulary, implementers ofDAPT processors are encouraged to maintainunrecognised vocabulary within<metadata>
elements inDAPT Documents. In practice it is possible that an implementation which both inputsDAPT documents and outputsDAPT documents might modify the input document structure and contents, and while doing so, effectively prune those entities withunrecognised vocabulary from the output document.
Normative provisions relating to this section are defined in [TTML2].
[TTML2] defines avalidation processor, a class of implementation whose purpose is to assess adocument instance and decide if it is valid or not. Typically this would be used within a processing workflow to check that documents are acceptable for onward usage. A real world example would likely not return simply "good" or "bad", but also output informational, warning and error messages describing unusual, unexpected or problematic contents in the input document.
When implementing avalidation processor for aDAPT document, strict [TTML2] validation processing rules can be applied. Doing this involves checking for the presence and semantic validity of syntax and content associated with required or optional features defined in the profile, and checking for the absence of syntax associated with prohibited features.
The [TTML2] mechanism for dealing with vocabulary in unrecognised namespaces is to prune it prior to validation. This approach can be used; additionally it could be reasonable for an implementation to report as information those attributes and elements that have been pruned.
The term "vocabulary" here refers to XML elements and attributes.
Validation warnings could be issued when unsupported or deprecated vocabulary in recognised namespaces is encountered after pruning, or when supported vocabulary contains unexpected but not invalid content, but in these scenarios errors are not expected.
Validation errors are expected when prohibited vocabulary is present, or when semantically invalid content within permitted vocabulary is encountered.
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The key wordsMAY,MUST,MUST NOT,SHOULD, andSHOULD NOT in this document are to be interpreted as described inBCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
[TTML2] specifies a formal language for expressing document and processor requirements, within theProfiling sub-system. The normative requirements of this specification are defined using the conformance terminology described above, and are also defined using this TTML2 profile mechanism. Where TTML2 vocabulary is referenced, the syntactic and semantic requirements relating to that vocabulary as defined in [TTML2] apply.
Whilst there is no requirement for aDAPT processor to implement the TTML2 profile processing semantics in general, implementers can use the TTML2 profiles defined inF.Profiles as a means of verifying that their implementations meet the normative requirements ofDAPT, for example as a checklist.
Conversely, a general purpose [TTML2] processor that does support the TTML2 profile processing semantics can use the TTML2 profiles defined inF.Profiles directly to determine if it is capable of processing aDAPT document.
ConformantDAPT Documents are [TTML2]timed text content document instances that conform to the normative provisions of this specification. Those provisions are expressed using theprofile vocabulary of [TTML2] in thecontent profile defined inF.Profiles.
DAPT Documents remain subject to the content conformance requirements specified at Section 3.1 of [TTML2]. In particular, aDAPT Document can containforeign vocabulary, since such elements and attributes are pruned by the algorithm at Section 4 of [TTML2] prior to evaluating content conformance.
ConformantDAPT Processors are [TTML2]content processors that conform to the normative provisions of this specification. Those provisions are expressed using theprofile vocabulary of [TTML2] in theprocessor profile defined inF.Profiles.
content-descriptor
§4.1.6.2This section is non-normative.
With the exception of the following, the privacy considerations of [ttml2] apply:
<audio>
element apply.condition
attribute is required.DAPT documents typically contain the names of characters or people who feature within the associated media, either fictional or real. In general this information would be present within the media itself or be public via other routes. If there is sensitivity associated with their being known to people with access to theDAPT documents in which their identity is contained, then such access should be managed with appropriate confidentiality. For example those documents could be available within a closed authoring environment and edited to remove the sensitive information prior to distribution to a wider audience. If this scenario arises, information security good practices within the closed environment should be applied, such as encryption of the document "at rest" and when being moved, access controlled by authentication platforms, etc.
This section is non-normative.
The security considerations of [ttml2] apply.
DAPT Documents express time asmedia time, which assumes that there is a reference start time (zero) on a media timeline, and a fixed playrate. An alternative scheme that is used in some other script formats is to synchronise media components using timecode, that match time stamps that are applied, for example to each frame of video.
Workflows that createDAPT documents from such timecode-based non-DAPT script formats need to map those timecode values onto theDAPT document's timeline.
If this mapping is not correct, presentation of theDAPT Document will not be synchronised with therelated media object. A reference timecode that matches a known point on theDAPT document timeline can be used to achieve correct synchronisation, for example the timecode corresponding to the start of the programme, which should matchDAPT time zero.
In this scenario, if such a reference point is not known, but timecodes corresponding toScript Events are known, it is still possible to construct aDAPT Document, albeit one whose synchronisation with the related media has not yet been resolved.
The optionalDAPT Origin Timecode andStart of Programme Timecode properties can be used to identify when there is a possible synchronisation error, and to resynchronise the document when all the required information is known.
These properties are provided as metadata only and are not intended to be used to perform direct synchronisation offsets during presentation. In particular, when the related media object uses timecode, the presence of the timecode properties does not mean that the player needs to relate these timecode values with any timecode value embedded in the related media resource.
If either aDAPT Origin Timecode object or aStart of Programme Timecode object is present, theDAPT DocumentMUST have one<head>
element child of the<tt>
element, and that<head>
elementMUST have at least one<metadata>
element child.
The optionalDAPT Origin Timecode allows a timecode value to be declared that corresponds to the zero point of theDAPT document timeline, that is, the time of a hypotheticalScript Event whoseBegin is zero seconds.
The properties can be used to provide timecodes from the related media object or from any other script format used to produce theDAPT document, and are informational. However, when they are both provided and differ, it is an indication that theDAPT document is not synchronized with the related media object and that processing of the script event begins is needed. To achieve synchronization, the following needs to be done:
ADAPT ScriptMAY contain zero or oneDAPT Origin Timecode objects.
TheDAPT Origin Timecode object is represented in aDAPT Document by a<
daptm:daptOriginTimecode
>
element present at the path/tt/head/metadata/daptm:daptOriginTimecode
, with the following constraints:
clock-time
with aframes
component, as defined in<time-expression>.See also5.7.3ttp:frameRate
. No mechanism is defined here for declaring a different frame rate for theDAPT Origin Timecode than is used for other frame-based time expressions.
If the related media object contains a timecode for the video frame synchronized to the origin of theDAPT document timeline, theDAPT origin timecode is equal that timecode.
...<head><metadata><daptm:daptOriginTimecode>10:01:20:12</daptm:daptOriginTimecode></metadata></head><body><divxml:id="se1"begin="0s"end="1.8s"><!-- This script event was generated from a source whose begin timecode was 10:01:20:12 --></div></body>...
When converting legacy formats that store the equivalent of each Script Event, for example adescription, with SMPTE timecodes, but where theStart of Programme Timecode is not stored, and is not immediately available, theDAPT Origin Timecode can be used to defer synchronisation with the media until that media begin timecode is known.
One approach to deferring synchronisation usingDAPT Origin Timecode is as follows, assuming that a legacy source file is being converted to aDAPT Document and relates to media with continuous timecode:
ttp:frameRate
attribute of the<tt>
element to the applicable frame rate;When the related media's timecode is later dicovered, the times of theScript Events can be adjusted so that media time zero is coincident with theStart of Programme Timecode, and theDAPT Origin Timecode can be removed or set to the now-known value.
The above algorithm can be used to align the begin times of theDAPT Script and therelated media object. It does not address progressive synchronisation errors caused by incorrect frame rates or differing playback rates.
The optionalStart of Programme Timecode allows a timecode value to be declared that corresponds to the beginning of the related media object's programme content.
In combination withDAPT Origin Timecode, the value ofStart of Programme Timecode can be used to infer whether or not the media times in theDAPT Script are likely to be correctly synchronised with theRelated Media Object.
If bothDAPT Origin Timecode andStart of Programme Timecode are present, but their values are different, it is likely that the media times are not synchronised with theRelated Media Object, since this implies that the equivalent time code to zero seconds in media time is not the start of the programme, which is the requirement for correctly synchronised media time.
ADAPT ScriptMAY contain zero or oneStart of Programme Timecode objects.
TheStart of Programme Timecode object is represented in aDAPT Document by a<ebuttm:documentStartOfProgramme>
element present at the path/tt/head/metadata/ebuttm:documentStartOfProgramme
, with the syntactic constraints as defined in [EBU-TT-3390].
...<head><metadata><daptm:daptOriginTimecode>10:01:20:12</daptm:daptOriginTimecode><ebuttm:documentStartOfProgramme>10:00:00:00<ebuttm:documentStartOfProgramme><!-- It is likely that this document is 1 minute, 20 seconds and 12 frames too early, compared to the related media --></metadata></head><body><divxml:id="se1"begin="0s"end="1.8s"><!-- This script event was generated from a source whose begin timecode was 10:01:20:12 --></div></body>...
If the times of theScript Events are adjusted to bring the media time into synchronisation with theRelated Media Object, as noted inDAPT Origin Timecode, theStart of Programme TimecodeSHOULD NOT be changed, since it is an invariant feature of theRelated Media Object, and does not describe the times in theDAPT Document.
This section is non-normative.
Applying theMixing Instructions can be implemented using [webaudio].Figure2 shows the flow of programme audio, and how, when audio-generating elements are active, the pan and gain (if set) on theScript Event are applied, then the output is passed to theText, which mixes in the audio from any activeAudio Recording, itself subject to its ownMixing Instructions, then the result has theText'sMixing Instructions applied, prior to the output being mixed on to the master bus.
This example is shown as [webaudio] nodes inFigure3.
The above examples are simplified in at least two ways:
<span>
elements that themselves haveMixing Instructions applied, then additional nodes would be needed;<animate>
element semantics directly into [webaudio] API calls to achieve the equivalent effect.This section defines a [TTML2]content profile and aprocessor profile by expressing dispositions against a set offeatures andextensions. TheDAPT extensions are defined inG.Extensions.
The Profile Semantics specified in [TTML2] apply.
ATTMLProfile specification is a document that lists all the features ofTTML that are required / optional / prohibited within “document instances” (files) and “processors” (things that process the files), and any extensions or constraints.
Atimed text content document instance that conforms to thecontent profile defined herein:
Atimed text content document instance, by definition, satisfies the requirements of Section 3.1 at [TTML2], and hence atimed text content document instance that conforms to a profile defined herein is also a conforming TTML2Document Instance.
APresentation processor that conforms to theprocessor profile defined in this specification:
ATransformation processor that conforms to theprocessor profile defined in this specification:
The dispositions required, permitted, optional and prohibited as used in this specification map to the [TTML2]<ttp:feature>
and<ttp:extension>
elements'value
attribute values as follows:
DAPT disposition | or elementvalue attribute value in | |
---|---|---|
content profile | processor profile | |
required | required | required |
permitted | optional | required |
optional | optional | optional |
prohibited | prohibited | optional |
The use of the termspresentation processor andtransformation processor within this document does not imply conformanceper se to any of the Standard Profiles defined in [TTML2]. In other words, it is not considered an error for apresentation processor ortransformation processor to conform to the profile defined in this document without also conforming to the TTML2 Presentation Profile or the TTML2 Transformation Profile.
The use of the [TTML2]profiling sub-system to describeDAPT conformance within this specification is not intended imply thatDAPT processors are required to support any features of that system other than those for which support is explicitly required byDAPT.
This document does not specifypresentation processor ortransformation processor behavior when processing or transforming a non-conformanttimed text content document instance.
The permitted and prohibited dispositions do not refer to the specification of a
or<ttp:feature>
element as being permitted or prohibited within a<ttp:extension>
<ttp:profile>
element.
Thefeatures andextensions listed in this section express the minimal requirements forDAPT Documents,Presentation Processors, andTransformation Processors.DAPT DocumentsMAY additionally conform to other profiles, and include syntax not prohibited by theDAPTcontent profile.Presentation Processors andTransformation ProcessorsMAY support additional syntax and semantics relating to other profiles.
For example, aDAPT Script can include syntax permitted by the IMSC ([TTML-IMSC1.2]) profiles of [TTML2] to enhance the presentation ofscripts to actors recording audio, or to add styling important for later usage in subtitle or caption creation.
Editorial task: go through this list offeatures and check the disposition of each. There should be no prohibited features that are permitted in IMSC.
Feature or Extension | Disposition | Additional provision |
---|---|---|
Relative to the TT Feature namespace | ||
#animate-fill | permitted | |
#animate-minimal | permitted | |
#animation-out-of-line | prohibited | See4.10Mixing Instruction. |
#audio | permitted | |
#audio-description | permitted | |
#audio-speech | permitted | |
#bidi | permitted | |
#bidi-version-2 | permitted | |
#chunk | permitted | |
#clockMode | prohibited | |
#clockMode-gps | prohibited | |
#clockMode-local | prohibited | |
#clockMode-utc | prohibited | |
#content | permitted | |
#contentProfiles | permitted | See5.6.2ttp:contentProfiles andG.3#contentProfiles-root. |
#contentProfiles-combined | optional | See5.6.5Other TTML2 Profile Vocabulary. |
#core | permitted | |
#data | permitted | |
#direction | permitted | |
#dropMode | prohibited | |
#dropMode-dropNTSC | prohibited | |
#dropMode-dropPAL | prohibited | |
#dropMode-nonDrop | prohibited | |
#embedded-audio | permitted | |
#embedded-data | permitted | |
#frameRate | permitted | See5.7.3ttp:frameRate . |
#frameRateMultiplier | permitted | |
#gain | permitted | |
#markerMode | prohibited | |
#markerMode-continuous | prohibited | |
#markerMode-discontinuous | prohibited | |
#metadata | permitted | |
#metadata-item | permitted | |
#metadata-version-2 | permitted | |
#pan | permitted | |
#permitFeatureNarrowing | optional | See5.6.5Other TTML2 Profile Vocabulary. |
#permitFeatureWidening | optional | See5.6.5Other TTML2 Profile Vocabulary. |
#pitch | permitted | |
#presentation-audio | permitted | |
#processorProfiles | optional | See5.6.4ttp:processorProfiles . |
#processorProfiles-combined | optional | See5.6.5Other TTML2 Profile Vocabulary. |
#profile | partially permitted | See5.6.3ttp:profile . |
#profile-full-version-2 | partially permitted | See5.6.5Other TTML2 Profile Vocabulary. |
#profile-version-2 | partially permitted | See5.6.5Other TTML2 Profile Vocabulary. |
#resources | permitted | |
#set | permitted | |
#set-fill | permitted | |
#set-multiple-styles | permitted | |
#source | permitted | |
#speak | permitted | |
#speech | permitted | |
#structure | required | |
#styling | permitted | |
#styling-chained | permitted | |
#styling-inheritance-content | permitted | |
#styling-inline | permitted | |
#styling-referential | permitted | |
#subFrameRate | prohibited | |
#tickRate | permitted | See5.7.4ttp:tickRate . |
#time-clock | permitted | |
#time-clock-with-frames | prohibited | |
#time-offset-with-frames | permitted | See5.7.3ttp:frameRate . |
#time-offset-with-ticks | permitted | See5.7.4ttp:tickRate . |
#time-offset | permitted | |
#time-wall-clock | prohibited | |
#timeBase-clock | prohibited | |
#timeBase-media | required | NOTE: [TTML1] specifies that the default timebase is |
#timeBase-smpte | prohibited | |
#timeContainer | prohibited | See5.7.2timeContainer . |
#timing | permitted | See5.7.5Time expressions. |
#transformation | permitted | See constraints at#profile. |
#unicodeBidi | permitted | |
#unicodeBidi-isolate | permitted | |
#unicodeBidi-version-2 | permitted | |
#xlink | permitted | |
Relative to theDAPT Extension namespace | ||
#agent | permitted | This is the profile expression of4.2Character. |
#contentProfiles-root | required | This is the profile expression of5.6.2ttp:contentProfiles . |
#daptOriginTimecode | permitted | This is the profile expression ofD.1DAPT Origin Timecode. |
#descType | permitted | This is the profile expression of . |
#onScreen | permitted | This is the profile expression of4.6On Screen. |
#profile-root | prohibited | This is the profile expression of the prohibition of thettp:profile attribute on the<tt> element as specified in5.6.3ttp:profile . |
#represents | required | This is the profile expression ofRepresents as applied toScript Event. |
#scriptEventGrouping | permitted | This is the profile expression of the permission to nest<div> elements described in4.3Script Event. |
#scriptEventMapping | optional | This is the profile expression of6.3Handling<div> and<p> elements. |
#scriptRepresents | required | This is the profile expression ofScript Represents. |
#scriptType-root | required | This is the profile expression of4.1.3Script Type. |
#serialization | required | This is the profile expression of5.1Document Encoding. |
#source-data | prohibited | This is the profile expression of the prohibition of<source> child elements of<data> elements as specified in4.9.1Audio Recording. |
#textLanguageSource | permitted | This is the profile expression of4.5Text Language Source as required at4.4Text. |
#xmlId-div | required | This is the profile expression of4.3Script Event. |
#xmlLang-audio-nonMatching | prohibited | This is the profile expression of the prohibition of thexml:lang attribute on the<audio> element having a different computed value to the parent element and descendant or referenced<source> and<data> elements, as specified in4.9.1Audio Recording. |
#xmlLang-root | required | This is the profile expression of4.1.2Default Language. |
TheDAPT Content Profile expresses the conformance requirements ofDAPT Scripts using the profile mechanism of [TTML2]. It can be used by a validating processor that supports theDAPT Processor Profile to validate aDAPT Document.
There is no requirement to include theDAPT Content Profile within aDAPT Document.
<?xml version="1.0" encoding="utf-8"?><!-- this file defines the "dapt-content" profile of ttml --><profilexmlns="http://www.w3.org/ns/ttml#parameter"designator="http://www.w3.org/ns/ttml/profile/dapt1.0/content"combine="mostRestrictive"type="content"><featuresxml:base="http://www.w3.org/ns/ttml/feature/"><!-- required (mandatory) feature support --><featurevalue="required">#structure</feature><featurevalue="required">#timeBase-media</feature><!-- optional (voluntary) feature support --><featurevalue="optional">#animate-fill</feature><featurevalue="optional">#animate-minimal</feature><featurevalue="optional">#audio</feature><featurevalue="optional">#audio-description</feature><featurevalue="optional">#audio-speech</feature><featurevalue="optional">#bidi</feature><featurevalue="optional"extends="#bidi">#bidi-version-2</feature><featurevalue="optional">#chunk</feature><featurevalue="optional">#content</feature><featurevalue="optional">#contentProfiles</feature><featurevalue="optional">#contentProfiles-combined</feature><featurevalue="optional">#core</feature><featurevalue="optional">#data</feature><featurevalue="optional">#direction</feature><featurevalue="optional">#embedded-audio</feature><featurevalue="optional">#embedded-data</feature><featurevalue="optional">#frameRate</feature><featurevalue="optional">#frameRateMultiplier</feature><featurevalue="optional">#gain</feature><featurevalue="optional">#metadata</feature><featurevalue="optional">#metadata-item</feature><featurevalue="optional"extends="#metadata">#metadata-version-2</feature><featurevalue="optional">#pan</feature><featurevalue="optional">#permitFeatureNarrowing</feature><featurevalue="optional">#permitFeatureWidening</feature><featurevalue="optional">#pitch</feature><featurevalue="optional">#presentation-audio</feature><featurevalue="optional">#processorProfiles</feature><featurevalue="optional">#processorProfiles-combined</feature><featurevalue="optional">#resources</feature><featurevalue="optional"extends="#animation">#set</feature><featurevalue="optional">#set-fill</feature><featurevalue="optional">#set-multiple-styles</feature><featurevalue="optional">#source</feature><featurevalue="optional">#speak</feature><featurevalue="optional">#speech</feature><featurevalue="optional">#styling</feature><featurevalue="optional">#styling-chained</feature><featurevalue="optional">#styling-inheritance-content</feature><featurevalue="optional">#styling-inline</feature><featurevalue="optional">#styling-referential</feature><featurevalue="optional">#tickRate</feature><featurevalue="optional">#time-clock</feature><featurevalue="optional">#time-offset</feature><featurevalue="optional">#time-offset-with-frames</feature><featurevalue="optional">#time-offset-with-ticks</feature><featurevalue="optional">#timing</feature><featurevalue="optional">#transformation</feature><featurevalue="optional">#unicodeBidi</feature><featurevalue="optional">#unicodeBidi-isolate</feature><featurevalue="optional"extends="#unicodeBidi">#unicodeBidi-version-2</feature><featurevalue="optional">#xlink</feature><!-- prohibited feature support --><featurevalue="prohibited">#animation-out-of-line</feature><featurevalue="prohibited">#clockMode</feature><featurevalue="prohibited">#clockMode-gps</feature><featurevalue="prohibited">#clockMode-local</feature><featurevalue="prohibited">#clockMode-utc</feature><featurevalue="prohibited">#dropMode</feature><featurevalue="prohibited">#dropMode-dropNTSC</feature><featurevalue="prohibited">#dropMode-dropPAL</feature><featurevalue="prohibited">#dropMode-nonDrop</feature><featurevalue="prohibited">#markerMode</feature><featurevalue="prohibited">#markerMode-continuous</feature><featurevalue="prohibited">#markerMode-discontinuous</feature><featurevalue="prohibited">#subFrameRate</feature><featurevalue="prohibited">#time-clock-with-frames</feature><featurevalue="prohibited">#time-wall-clock</feature><featurevalue="prohibited">#timeBase-clock</feature><featurevalue="prohibited">#timeBase-smpte</feature><featurevalue="prohibited">#timeContainer</feature></features><extensionsxml:base="http://www.w3.org/ns/ttml/profile/dapt/extension/"><!-- required (mandatory) extension support --><extensionvalue="required">#contentProfiles-root</extension><extensionvalue="required">#represents</extension><extensionvalue="required">#scriptRepresents</extension><extensionvalue="required">#scriptType-root</extension><extensionvalue="required">#serialization</extension><extensionvalue="required">#xmlId-div</extension><extensionvalue="required">#xmlLang-root</extension><!-- optional (voluntary) extension support --><extensionvalue="optional">#agent</extension><extensionvalue="optional">#daptOriginTimecode</extension><extensionvalue="optional">#descType</extension><extensionvalue="optional">#onScreen</extension><extensionvalue="optional">#scriptEventGrouping</extension><extensionvalue="optional">#scriptEventMapping</extension><extensionvalue="optional">#textLanguageSource</extension><!-- prohibited extension support --><extensionvalue="prohibited">#profile-root</extension><extensionvalue="prohibited">#source-data</extension><extensionvalue="prohibited">#xmlLang-audio-nonMatching</extension></extensions></profile>
TheDAPT Processor Profile expresses the processing requirements ofDAPT Scripts using the profile mechanism of [TTML2]. A processor that supports the required features and extensions of theDAPT Processor Profile can, minimally, process all permitted features within aDAPT Document.
There is no requirement to include theDAPT Processor Profile within aDAPT Document.
<?xml version="1.0" encoding="utf-8"?><!-- this file defines the "dapt-processor" profile of ttml --><profilexmlns="http://www.w3.org/ns/ttml#parameter"designator="http://www.w3.org/ns/ttml/profile/dapt1.0/processor"combine="mostRestrictive"type="processor"><featuresxml:base="http://www.w3.org/ns/ttml/feature/"><!-- required (mandatory) feature support --><featurevalue="required">#animate-fill</feature><featurevalue="required">#animate-minimal</feature><featurevalue="required">#audio</feature><featurevalue="required">#audio-description</feature><featurevalue="required">#audio-speech</feature><featurevalue="required">#bidi</feature><featurevalue="required"extends="#bidi">#bidi-version-2</feature><featurevalue="required">#chunk</feature><featurevalue="required">#content</feature><featurevalue="required">#contentProfiles</feature><featurevalue="required">#core</feature><featurevalue="required">#data</feature><featurevalue="required">#direction</feature><featurevalue="required">#embedded-audio</feature><featurevalue="required">#embedded-data</feature><featurevalue="required">#frameRate</feature><featurevalue="required">#frameRateMultiplier</feature><featurevalue="required">#gain</feature><featurevalue="required">#metadata</feature><featurevalue="required">#metadata-item</feature><featurevalue="required"extends="#metadata">#metadata-version-2</feature><featurevalue="required">#pan</feature><featurevalue="required">#pitch</feature><featurevalue="required">#presentation-audio</feature><featurevalue="required">#resources</feature><featurevalue="required"extends="#animation">#set</feature><featurevalue="required">#set-fill</feature><featurevalue="required">#set-multiple-styles</feature><featurevalue="required">#source</feature><featurevalue="required">#speak</feature><featurevalue="required">#speech</feature><featurevalue="required">#structure</feature><featurevalue="required">#styling</feature><featurevalue="required">#styling-chained</feature><featurevalue="required">#styling-inheritance-content</feature><featurevalue="required">#styling-inline</feature><featurevalue="required">#styling-referential</feature><featurevalue="required">#tickRate</feature><featurevalue="required">#time-clock</feature><featurevalue="required">#time-offset</feature><featurevalue="required">#time-offset-with-frames</feature><featurevalue="required">#time-offset-with-ticks</feature><featurevalue="required">#timeBase-media</feature><featurevalue="required">#timing</feature><featurevalue="required">#transformation</feature><featurevalue="required">#unicodeBidi</feature><featurevalue="required">#unicodeBidi-isolate</feature><featurevalue="required"extends="#unicodeBidi">#unicodeBidi-version-2</feature><featurevalue="required">#xlink</feature><!-- optional (voluntary) feature support --><featurevalue="optional">#animation-out-of-line</feature><featurevalue="optional">#clockMode</feature><featurevalue="optional">#clockMode-gps</feature><featurevalue="optional">#clockMode-local</feature><featurevalue="optional">#clockMode-utc</feature><featurevalue="optional">#contentProfiles-combined</feature><featurevalue="optional">#dropMode</feature><featurevalue="optional">#dropMode-dropNTSC</feature><featurevalue="optional">#dropMode-dropPAL</feature><featurevalue="optional">#dropMode-nonDrop</feature><featurevalue="optional">#markerMode</feature><featurevalue="optional">#markerMode-continuous</feature><featurevalue="optional">#markerMode-discontinuous</feature><featurevalue="optional">#permitFeatureNarrowing</feature><featurevalue="optional">#permitFeatureWidening</feature><featurevalue="optional">#processorProfiles</feature><featurevalue="optional">#processorProfiles-combined</feature><featurevalue="optional">#subFrameRate</feature><featurevalue="optional">#time-clock-with-frames</feature><featurevalue="optional">#time-wall-clock</feature><featurevalue="optional">#timeBase-clock</feature><featurevalue="optional">#timeBase-smpte</feature><featurevalue="optional">#timeContainer</feature></features><extensionsxml:base="http://www.w3.org/ns/ttml/profile/dapt/extension/"><!-- required (mandatory) extension support --><extensionvalue="required">#agent</extension><extensionvalue="required">#contentProfiles-root</extension><extensionvalue="required">#daptOriginTimecode</extension><extensionvalue="required">#descType</extension><extensionvalue="required">#onScreen</extension><extensionvalue="required">#represents</extension><extensionvalue="required">#scriptEventGrouping</extension><extensionvalue="required">#scriptRepresents</extension><extensionvalue="required">#scriptType-root</extension><extensionvalue="required">#serialization</extension><extensionvalue="required">#textLanguageSource</extension><extensionvalue="required">#xmlId-div</extension><extensionvalue="required">#xmlLang-root</extension><!-- optional (voluntary) extension support --><extensionvalue="optional">#profile-root</extension><extensionvalue="optional">#scriptEventMapping</extension><extensionvalue="optional">#source-data</extension><extensionvalue="optional">#xmlLang-audio-nonMatching</extension></extensions></profile>
The following sections defineextension designations, expressed as relative URIs (fragment identifiers) relative to theDAPT Extension Namespace base URI. These extension designations are used inF.Profiles to describe the normative provisions ofDAPT that are not expressed by [TTML2] profile features.
Atransformation processor supports the#agent
extension if it recognizes and is capable of transforming values of the following elements and attributes on the<ttm:agent>
element:
xml:id
attribute<ttm:name>
elementand if it recognizes and is capable of transforming each of the following value combinations:
<ttm:agent>
element withtype="person"
and child<ttm:name>
element withtype="full"
;<ttm:agent>
element withtype="character"
and child<ttm:name>
element withtype="alias"
;Apresentation processor supports the#agent
extension if it implements presentation semantic support of the above listed elements, attributes and value combinations.
Atransformation processor supports the#contentProfiles-root
extension if it recognizes and is capable of transforming values of the
attribute on thettp:contentProfiles
<tt>
element.
Apresentation processor supports the#contentProfiles-root
extension if it implements presentation semantic support of the
attribute on thettp:contentProfiles
<tt>
element.
#contentProfiles
to avoid requiring processor support for thettp:profile
attribute and processor profile inference semantics.Atransformation processor supports the#daptOriginTimecode
extension if it recognizes and is capable of transforming values of the<
daptm:daptOriginTimecode
>
element.
Nopresentation processor behaviour is defined for the#daptOriginTimecode
extension.
Atransformation processor supports the#descType
extension if it recognizes and is capable of transforming values of the
attribute on thedaptm:descType
<ttm:desc>
element.
Apresentation processor supports the#descType
extension if it implements presentation semantic support of the
attribute on thedaptm:descType
<ttm:desc>
element.
Atransformation processor supports the#onScreen
extension if it recognizes and is capable of transforming values of the
attribute on thedaptm:onScreen
<div>
element.
Apresentation processor supports the#onScreen
extension if it implements presentation semantic support of the
attribute on thedaptm:onScreen
<div>
element.
Atransformation processor supports the#profile-root
extension if it recognizes and is capable of transforming values of the
attribute on thettp:profile
<tt>
element.
Apresentation processor supports the#profile-root
extension if it implements presentation semantic support of the
attribute on thettp:profile
<tt>
element.
Atransformation processor supports the#represents
extension if it recognizes and is capable of transforming values of the
attribute.daptm:represents
Apresentation processor supports the#represents
extension if it implements presentation semantic support of the
attribute.daptm:represents
An example of atransformation processor that supports this extension is a validating processor that reports an error if the extension is permitted by acontent profile but thetimed text content document instance claiming conformance to that profile has a<div>
element with a
attribute whose value is not conformant with the requirements defined herein.daptm:represents
Atransformation processor supports the#scriptEventGrouping
extension if it recognises and is capable of transforming<div>
elements that contain<div>
elements.
Support for the#scriptEventGrouping
extension does not imply support for the#scriptEventMapping
extension.
Apresentation processor supports the#scriptEventGrouping
extension if it implements presentation semantic support for<div>
elements that contain<div>
elements.
Atransformation processor supports the#scriptEventMapping
extension if, when mapping aDAPT document into an internal representation of theDAPT data model, it implements the processing requirements specified at6.3Handling<div>
and<p>
elements.
No support for the#scriptEventMapping
extension is required forpresentation processors because there are no presentation semantics that either require, or depend upon, mapping aDAPT document into an internal representation of theDAPT data model. A presentation processor that does perform such a mapping can also be considered to be atransformation processor for the purpose of this extension.
Atransformation processor supports the#scriptRepresents
extension if it recognizes and is capable of transforming values of the
attribute on thedaptm:scriptRepresents
<tt>
element.
Apresentation processor supports the#scriptRepresents
extension if it implements presentation semantic support of the
attribute on thedaptm:scriptRepresents
<tt>
element.
An example of atransformation processor that supports this extension is a validating processor that reports an error if the extension is required by acontent profile but thetimed text content document instance claiming conformance to that profile either does not have a
attribute on thedaptm:scriptRepresents
<tt>
element or has one whose value is not conformant with the requirements defined herein.
Atransformation processor supports the#scriptType-root
extension if it recognizes and is capable of transforming values of the
attribute on thedaptm:scriptType
<tt>
element.
Apresentation processor supports the#scriptType-root
extension if it implements presentation semantic support of the
attribute on thedaptm:scriptType
<tt>
element.
An example of atransformation processor that supports this extension is a validating processor that provides appropriate feedback, for example warnings, when theSHOULD requirements defined in4.1.3Script Type for aDAPT Document's
are not met, and that reports an error if the extension is required by acontent profile but thetimed text content document instance claiming conformance to that profile either does not have adaptm:scriptType
attribute on thedaptm:scriptType
<tt>
element or has one whose value is not defined herein.
A serialized document that is valid with respect to the#serialization
extension is an XML 1.0 [xml] document encoded using UTF-8 character encoding as specified in [UNICODE], that contains no entity declarations and no entity references other than to predefined entities.
Atransformation processor or apresentation processor supports the#serialization
extension if it can read a serialized document as defined above.
Atransformation processor that writes documents supports the#serialization
extension if it can write a serialized document as defined above.
Atransformation processor supports the#source-data
extension if it recognizes and is capable of transforming values of the<source> element child of a<data> element.
Apresentation processor supports the#source-data
extension if it implements presentation semantic support of the<source> element child of a<data> element.
Atransformation processor supports the#textLanguageSource
extension if it recognizes and is capable of transforming values of the
attribute.daptm:langSrc
Apresentation processor supports the#textLanguageSource
extension if it implements presentation semantic support of the
attribute.daptm:langSrc
Atransformation processor supports the#xmlId-div
extension if it recognizes and is capable of transforming values of thexml:id
attribute on the<div>
element.
Apresentation processor supports the#xmlId-div
extension if it implements presentation semantic support of thexml:id
attribute on the<div>
element.
Atransformation processor supports the#xmlLang-audio-nonMatching
extension if it recognizes and is capable of transforming values of thexml:lang
attribute on the<audio>
element that differ from the computed value of the same attribute of its parent element or any of its descendant or referenced<source>
or<data>
elements, known asnon-matching values.
Apresentation processor supports the#xmlLang-audio-nonMatching
extension if it implements presentation semantic support of suchnon-matchingxml:lang
attribute values.
Atransformation processor supports the#xmlLang-root
extension if it recognizes and is capable of transforming values of thexml:lang
attribute on the<tt>
element and the additional semantics specified in4.1.2Default Language.
Apresentation processor supports the#xmlLang-root
extension if it implements presentation semantic support of thexml:lang
attribute on the<tt>
element and the additional semantics specified in4.1.2Default Language.
This section specifies theregistry definition, consisting of the custodianship, change process and the core requirements of theregistry tables defined in this document.
Thecustodian of thisw3c registry is theTimed Text Working Group (TTWG). If theTTWG is unable to fulfil the role ofcustodian, for example if it has beenclosed, thecustodian in lieu is theW3C Team.
Changes to thisW3C RegistryMUST be requested (thechange request) using any one of the following options:
Thechange requestMUST include enough information for thecustodian to be able to identify all of:
provisional
registry entries for which changes are being proposed, if any;The proposer of the changeMAY open a pull request (or equivalent) on theversion control system, with that pull request containing the proposed changes. If a pull request is opened then a corresponding issueMUST also be opened and the pull requestMUST be linked to that issue.
The process for assessing achange request depends on thecustodian.
An approvedchange request is enacted by merging its related pull request into theversion control system and publishing the updated version of this document.
If thecustodian is theW3C Team, the TeamMUST seekwide review of thechange request and offer a review period of at least 4 weeks, before assessing from the responses received if there is consensus amongst the respondents.
The TeamMAY require a pull request on theversion control system to be opened as the basis of the review.
If there is such consensus, the TeamMUST make the proposed changes.
This section defines constraints on theregistry tables defined in this document. Eachregistry table consists of a set ofregistry entries. Eachregistry table has an associatedregistry table definition inH.2Registry Table Definitions, which lists thefields present in eachregistry entry.
Eachregistry entry has astatus, a uniquekey, and if appropriate, otherfields, for example any notes, a description, or a reference to some other defining entity.
Theregistry table definitionMUST define thefields and thekey to be used in eachregistry entry.
Theregistry entrystatus field reflects the maturity of that entry. Permitted values are:
ProvisionalFinalDeprecated
No other values are permitted.
Registry entries with astatus ofProvisional
MAY be changed or deleted. Theirstatus may be changed to
orFinal
.Deprecated
Registry entrykeys in
entries that were later deletedMAY be reused.Provisional
Newly createdregistry entriesSHOULD havestatus
.Provisional
Registry entries with astatus ofFinal
MUST NOT be deleted or changed. TheirstatusMAY be changed to
.Deprecated
Registry entrykeys in
entriesMUST NOT be reused.Final
Newly createdregistry entriesMAY havestatus
.Final
Registry entries with astatus ofDeprecated
MUST NOT be deleted or changed. TheirstatusMAY be changed to
unless that would result in a duplicatekey within the set of entries whosestatus is eitherFinal
orProvisional
.Final
Registry entrykeys in
entries that were previouslyDeprecated
Provisional
and never
MAY be reused.Final
Registry entrykeys in
entries that were previouslyDeprecated
MUST NOT be reused.Final
Newly createdregistry entriesMUST NOT havestatus
.Deprecated
This section definesregistry tables and locates theirregistry entries.
Theregistry table fordaptm:descType
defines a set of values that can be used in thedaptm:descType
attribute.
Thekey is the "daptm:descType
" field. The "description" field describes the intended purpose of each value.
Theregistry entries for thisregistry table are located in4.8Script Event Description.
Thekey values for thisregistry tableMUST NOT begin withx-
which is reserved for user extensions.
Theregistry table for<content-descriptor>
defines a set of values that can be used in thedaptm:represents
attribute.
Thekey is the "<content-descriptor>
" field. The "Description" field describes the type of media content represented by each value. The "Example usage" field describes the type of script in which the content type described are commonly found.
Theregistry entries for thisregistry table are located in4.1.6.2<content-descriptor>
values.
Thekey values for thisregistry tableMUST NOT begin withx-
which is reserved for user extensions.
The Editors acknowledge the current and former members of the Timed Text Working Group, the members of otherW3C Working Groups, the members of the Audio Description Community Group, and industry experts in other forums who have contributed directly or indirectly to the process or content of this document.
The Editors wish to especially acknowledge the following contributions by members: Glenn Adams, Skynav; Pierre-Anthony Lemieux, MovieLabs; Hewson Maxwell, Ericsson; Chris Needham, British Broadcasting Corporation; Atsushi Shimono,W3C; Matt Simpson, Invited Expert; Andreas Tai, Invited Expert.
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in: