Dubbing and Audio description Profiles of TTML2

This section is non-normative.

A transcript is a text representation of pre-existing media in another form, for example the dialogue in a video. A script is a text representation of the intended content of media prior to its creation, for example to guide an actor in recording an audio track. Within this specification the term DAPT script is used generically to refer to both transcripts and scripts. DAPT Scripts consist of timed text and associated metadata, such as the character speaking.

In dubbing workflows, a transcript is generated and translated to create a script. In audio description workflows, a transcript describes the video image, and is then used directly as a script for recording an audio equivalent.

DAPT is a TTML-based format for the exchange of transcripts and scripts (i.e. DAPT Scripts) among authoring, prompting and playback tools in the localization and audio description pipelines. A DAPT document is a serializable form of a DAPT Script designed to carry pertinent information for dubbing or audio description such as type of DAPT 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 for DAPT scripts and its representation as a [TTML2] document (see 4. DAPT Data Model and corresponding TTML syntax) with some constraints and restrictions (see 5. Constraints).

A DAPT 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 involving transcripts, including accessibility needs described in [media-accessibility-reqs], as well as supporting users who need dialogue translated into a different language via dubbing.

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 the script is generated, for eventual mixing into the programme audio. That mixing can occur prior to distribution, or in the client directly.

The dubbing process which consists in creating a dubbing script is a complex, multi-step process involving:

Transcribing and timing the dialogue in the original language from a completed programme to create a transcript;
Notating dialogue with character information and other annotations;
Generating localization notes to guide further adaptation;
Translating the dialogue to a target language script;
Adapting the translation to the dubbing; for example matching the actor’s lip movements in the case of dubs.

A dubbing script is a transcript or script (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 of TTML, such as [TTML-IMSC1.2], for example by permitting subtitle styling syntax to be carried in DAPT documents. Alternatively, styling can be applied to assist voice artists when recording scripted dialogue.

Creating audio description content is also a multi-stage process. An audio description, also known as video description or in [media-accessibility-reqs] as described 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 the audio rendition of one or more descriptions mixed with the audio associated with the programme prior to any mixing with audio description (sometimes referred to as main programme audio), at moments when this does not clash with dialogue, to deliver an audio description mixed audio track. A description 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 what audio description is and how it works can be found at [BBC-WHP051].

Writing the audio description script typically involves:

watching the video content of the programme, or series of programmes,
identifying the key moments during which there is an opportunity to speak descriptions,
writing the description text to explain the important visible parts of the programme at that time,
creating an audio version of the descriptions, either by recording a human actor or using text to speech,
defining mixing instructions (applied using [TTML2] audio styling) for combining the audio with the programme audio.

The audio mixing can occur prior to distribution of the media, or in the client player. If the audio description script 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.

The top level structure of a document is as follows:

The <tt> root element in the namespace http://www.w3.org/ns/ttml indicates that this is a TTML document and the ttp:contentProfiles attribute indicates that it adheres to the DAPT content profile defined in this specification.
The daptm:workflowType attribute indicates the type of workflow.
The daptm:scriptType attribute indicates the type of script but in this empty example, it is not relevant, as only the structure of the document is shown.

The structure is applicable to all types of DAPT scripts, dubbing or audio description.

Example 1

<tt xmlns="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"
    xml:lang="en" 
    ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
    daptm:applicationType="dubbing"
    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 -->
  </body>
</tt>

The following examples correspond to the timed text scripts produced at each stage of the workflow described in [DAPT-REQS].

The first example shows a script where timed opportunities for descriptions or transcriptions have been identified but no text has been written:

Example 2

...
  <body>
    <div xml:id="d1" begin="10s" end="13s">
    </div>
    <div xml:id="d2" 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 a Pre Recording Script:

Example 3

...
  <body>
    <div begin="10s" end="13s">
      <p daptm:langSrc="original">
        A woman climbs into a small sailing boat.
      </p>
    </div>
    <div begin="18s" end="20s">
      <p daptm:langSrc="original">
        The woman pulls the tiller and the boat turns.
      </p>
    </div>
  </body>
...

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, smoothly animating the value on the way in and returning it on the way out:

Example 4

...
    <div begin="25s" end="28s">
      <p daptm:langSrc="original">
        <animate begin="0.0s" end="0.3s" tta:gain="1;0.39" fill="freeze"/>
        <animate begin="2.7s" end="3s" tta:gain="0.39;1"/>
        <span begin="0.3s" end="2.7s">
          <audio src="clip3.wav"/>
          The sails billow in the wind.</span>
      </p>
    </div>
...

In the above example, the <div> element's begin time becomes 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> 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 using clipBegin and clipEnd. If we just want to play the part of the audio from file from 5s to 8s it would look like:

Example 5

...
  <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:

Example 6

...
    <div begin="18s" end="20s">
      <p daptm:langSrc="original">
        <span tta: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 all of the script and recorded audio together:

Example 7

...
    <div begin="25s" end="28s">
      <p daptm:langSrc="original">
        <animate begin="0.0s" end="0.3s" tta:gain="1;0.39" fill="freeze"/>
        <animate begin="2.7s" end="3s" tta:gain="0.39;1"/>
        <span begin="0.3s" end="2.7s">
          <audio><source><data type="audio/wave">
            [base64-encoded audio data]
          </data></source></audio>
          The sails billow in the wind.</span>
      </p>
    </div>
...

From the basic structure of Example 1, a transcription of the audio programme produces an original language dubbing script, which can look as follows. No specific style or layout is defined, and here the focus is on the transcription of the dialogs. Characters are identified within the <metadata>.

Example 8

<tt xmlns="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"
    xml:lang="fr" 
    ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
    daptm:applicationType="dubbing"
    daptm:scriptType="originalTranscript">
  <head>
    <metadata>
      <ttm:agent type="character" xml:id="character_1">
        <ttm:name type="alias">ASSANE</ttm:name>
      </ttm:agent>
    </metadata>
  </head>
  <body>
    <div begin="10s" end="13s">
      <p daptm:langSrc="original" ttm: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 language is changed to indicate that the focus is on the translated language:

Example 9

<tt xmlns="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"
    xml:lang="en"
    ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
    daptm:applicationType="dubbing"
    daptm:scriptType="translatedTranscript">
  <head>
    <metadata>
      <ttm:agent type="character" xml:id="character_1">
        <ttm:name type="alias">ASSANE</ttm:name>
      </ttm:agent>
    </metadata>
  </head>
  <body>
    <div begin="10s" end="13s" ttm:agent="character_1">
      <p xml:lang="fr" daptm:langSrc="original">
        <span>Et c'est grâce à ça qu'on va devenir riches.</span>
      </p>
      <p xml:lang="en" daptm:langSrc="translation">
        <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. The daptm:scriptType attribute is also modified, as in the following example:

Example 10

<tt xmlns="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"
    xml:lang="en"
    ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
    daptm:applicationType="dubbing"
    daptm:scriptType="preRecording">
  <head>
    <metadata>
      <ttm:agent type="character" xml:id="character_1">
        <ttm:name type="alias">ASSANE</ttm:name>
      </ttm:agent>
    </metadata>
  </head>
  <body>
    <div begin="10s" end="13s" ttm:agent="character_1" daptm:onScreen="ON_OFF">
      <p xml:lang="fr" daptm:langSrc="original">
        <span>Et c'est grâce à ça qu'on va devenir riches.</span>
      </p>
      <p xml:lang="en" daptm:langSrc="translation">
        <span begin="0s">And thanks to that,</span><span begin="1.5s"> we're gonna get rich.</span>
      </p>
    </div>
  </body>
</tt>

This section specifies the data model for DAPT and its corresponding TTML syntax. In the model, there are objects which can have properties and be associated with other objects. In the TTML 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.

Figure 1 illustrates the DAPT 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].

Figure 1 Class diagram showing main entities in the DAPT data model.

Issue 116: Add non-inlined embedded audio resources to the Data Model? question

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?

A DAPT Script is a transcript or script 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: Workflow Type, Script Type, Primary Language, Script Events and, for Dubbing Scripts, Characters.

A DAPT Document is a TTML Document Instance representing a DAPT Script. A DAPT Document has the structure and constraints defined in the following sections.

The Workflow Type property is a mandatory property of a DAPT Script which indicates if the workflow is for Dubbing or Audio Description.

To represent this property, the daptm:workflowType attribute MUST be present on the <tt> element:

daptm:workflowType
  : "dubbing"
  | "audioDescription"

The Script Type property is a mandatory property of a DAPT 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, the daptm:scriptType attribute MUST be present on the <tt> element:

daptm:scriptType
  : "originalTranscript"
  | "translatedTranscript"
  | "preRecording"
  | "asRecorded"

The definitions of the types of documents and the corresponding daptm:scriptType values are:

Original Language Transcript:
When the daptm:scriptType value is originalTranscript, the document is a literal transcription of the dialogue and on-screen text in their original spoken/written language(s).

Script Events in this type of transcript SHOULD contain Text objects whose Text Language Source is set to Original and SHOULD NOT contain Text objects whose Text Language Source is set to Translation.

Example 11
If a programme contains dialogue in English and Hebrew, the Original Language Transcript will contain some Script Events in English and some in Hebrew, all marked as Original Text Language Source. None of the Script Events is marked as Translation.
Translated Transcript:
When the daptm:scriptType value is translatedTranscript, the document represents a translation of the Original Language Transcript in a common language.

It can be adapted to produce a Pre-Recording Script, and/or used as the basis for a further translation into the Target Recording Language.

Script Events in this type of transcript SHOULD contain Text objects whose Text Language Source is set to Translation. They MAY also contain Original language Text.

Note
A Script Event in this type of transcript has a Translation Text object in the Target Recording Language and can also contain an Original Text object, for context, to assist in the adaption process. It can also have Translation Text objects in other languages, for example used as intermediate ("pivot") translations, or as additional context to assist in the adaptation process.

Example 12
If a programme contains dialogue in English and Hebrew, the French Translated Transcript will contain at least the translation in French of all Script Events. It may still retain text content in Hebrew and English to assist further processing.
Pre-recording Script:
When the daptm:scriptType value is preRecording, the document represents the result of the adaptation of an Original Language Transcript or a Translated 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 of script SHOULD contain Text objects in the Target Recording Language. They MAY also contain Original Text objects from the Original Language Transcript in the case that the Original language is not the Target Recording Language, for context, to assist further processing.

Note
The Script Type of a DAPT Script cannot necessarily be detected by inspecting the text content of the document. For example, the adaptation of a Translated Transcript into a Pre-recording Script can consist in replacing some words in the text content of a Script Event without altering the rest of the document. In either case, Text objects that are translations have Text Language Source properties set to Translation.

Note
The Text objects in Audio Description Script Events are each expected to have a Text Language Source property of Original if their language is the Primary Language or, when representing in-image text, if they are in the same language as that text. If audio description scripts are translated, their translations would be marked as Translation.
As-recorded Script:
When the daptm:scriptType value is asRecorded, the document represents the actual audio recording.

Script Events in this type of script SHOULD contain Text objects in the Target Recording Language and MAY also contain Original Text objects from the Original Language Transcript or Translation Text objects in other languages for context and quality verification. They MAY also contain links to audio and mixing instructions for the purpose of producing an audio track incorporating the recordings.

Note
Even though the output of the dubbing workflow is in the same language as those Text objects with the matching language, the Text Language Source of those Text objects remains Translation since they differ from the original language of the dialogue.

Editor's note

The following example is orphaned - move to the top of the section, before the enumerated script types?

Example 13

<tt daptm:scriptType="originalTranscript">
...
</tt>

The Primary Language is a mandatory property of a DAPT Script which represents the default language for the Text content of Script Events. This language may be the Original language or a Translation language. When it represents a Translation language, it may be the final language for which a dubbing or audio description script is being prepared, called the Target Recording Language or it may be an intermediate, or pivot, language used in the workflow.

The Primary Language is represented in a DAPT Document by the following structure and constraints:

the xml:lang attribute MUST be present on the <tt> element and its value MUST NOT be empty.

Note

All text content in a DAPT Script has a specified language. When multiple languages are used, the Primary Language can correspond to the language of the majority of Script Events, to the language being spoken for the longest duration, or to the language arbitrarily chosen by the author.

Note

Text content is marked either as being either in the Original language or as being a Translation independently of the Primary Language, using the Text Language Source property.

Example 14

An Original Language Transcript script is prepared for a video containing dialogue in Danish and Swedish. The Primary Language is set to Danish by setting xml:lang="da" on the <tt> element. Script Events that contain Swedish Text override this by setting xml:lang="sv" on the <p> element. Script Events that contain Danish Text can set the xml:lang attribute or omit it, since the inherited language is the Primary Language of the document. In both cases the Script Events' Text objects are <p> elements that represent original language text and therefore set their Text Language Source to Original by setting daptm:langSrc="original".

A DAPT Script MAY contain zero or more Script Event objects, each corresponding to dialogue, on screen text, or descriptions for a given time interval.

A DAPT Script MAY contain zero or more Character objects, each describing a character that can be referenced by a Script Event.

Some of the properties in the DAPT data model are common within more than one object type, and carry the same semantic everywhere they occur. These shared properties are listed in this section.

Editor's note

Would it be better to make a "Timed Object" class and subclass Script Event, Mixing Instruction and Audio Recording from it?

The following timing properties define when the entities that contain them are active:

The Begin property defines when an object becomes active, and is relative to the active begin time of the parent object. DAPT Scripts begin at time zero on the media timeline.
The End property defines when an object stops being active, and is relative to the active begin time of the parent object.
The Duration property defines the maximum duration of an object.
Note
If both an End and a Duration property are present, the end time is the earlier of End and Begin + Duration.

Note

If any of the timing properties is omitted, the following rules apply:

The default value for Begin is zero, i.e. the same as the begin time of the parent object.
The default value for End is indefinite, i.e. it resolves to the same as the end time of the parent timed object, if there is one. The end time of a DAPT Script is for practical purposes the end of the Related Media Object.
The default value for Duration is indefinite, i.e. the end time resolves to the same as the end time of the parent object.

In Dubbing Scripts, it is necessary to identify each character in the programme. This is done with a Character object which has the following properties:

a mandatory Identifier which is a unique identifier used to reference the character from elsewhere in the document, for example to indicate when a Character participates in a Script Event, or to link a Character Style to its Character.
a mandatory Name which is the name of the Character in the programme
an optional Talent Name, which is the name of the actor speaking dialogue for this Character
zero or more Character Style objects which can be applied to control the visual appearance of Script Events spoken by the Character, for example during recording by an actor or when transforming the script into subtitles.

A Character is represented in a DAPT Document by the following structure and constraints:

If the Character has a Talent Name property:
- A <ttm:agent> element corresponding to the Talent Name MUST be present at the path /tt/head/metadata/ttm:agent, with the following constraints:
  - its type attribute MUST be set to person
  - its xml:id attribute MUST be set.
  - it MUST have a <ttm:name> child element whose type MUST be set to full and its content set to the Talent Name
- If more than one Character is associated with the same Talent Name there SHOULD be a single <ttm:agent> element corresponding to that Talent Name, referenced separately by each of the Characters.
- Each <ttm:agent> element corresponding to a Talent Name SHOULD appear before any of the Character <ttm:agent> elements whose <ttm:actor> child element references it.
The Character is represented in a DAPT Document by a <ttm:agent> element present at the path /tt/head/metadata/ttm:agent, with the following constraints:
- The type attribute MUST be set to character.
- The xml:id attribute MUST be present on the ttm:agent and set to the Character Identifier.
- The ttm:agent MUST contain a ttm:name element with its type attribute set to alias and its content set to the Character Name.
- If the Character has a Talent Name, it MUST contain a <ttm:actor> child element. That child element MUST have an agent attribute set to the xml:id of the <ttm:agent> element corresponding to the Talent Name, that is, whose type is set to person.
Example 15
```
...
<metadata>
  <ttm:agent type="character" xml:id="character_1">
    <ttm:name type="alias">DESK CLERK</ttm:name>
  </ttm:agent>
</metadata>
...
```
Example 16
```
...
<metadata>
  <ttm:agent type="person" xml:id="actor_A">
    <ttm:name type="full">Matthias Schoenaerts</ttm:name>
  </ttm:agent>
  <ttm:agent type="character" xml:id="character_2">
    <ttm:name type="alias">BOOKER</ttm:name>
    <ttm:actor agent="actor_A"/>
  </ttm:agent>
</metadata>
...
```
All <ttm:agent> elements SHOULD be contained in the first <metadata> element in the <head> element.
Note
There can be multiple <metadata> elements in the <head> element, for example to include proprietary metadata but the above recommends that only one is used to define the characters.

A Character Style is represented in a DAPT Document by the following structure and constraints:

Each Character Style is represented by one or more <style> elements at the path /tt/head/styling/style.
Each such <style> element is associated with the Character by having a ttm:agent attribute whose value is the xml:id of the <ttm:agent> element representing the Character.
A Script Event MAY apply Character Styles by including the xml:id of each style in the style attribute of the <div> element that defines that Script Event.
A Text object MAY apply Character Styles by including the xml:id of each style in the style attribute of the <p> element that defines that Text object.
A Script Event SHOULD NOT apply a Character Style for a Character that is not associated with that Script Event.
A Text object SHOULD NOT apply a Character Style for a Character that is not associated with that Text object's Script Event.

Note

Any style attribute defined in [TTML2] or [TTML-IMSC1.2] (or other profiles using non-W3C namespaces) can be present on the <style> element.

A <style> element MAY omit the ttm:agent attribute if it is not associated with a Character. Such styles MAY be applied in the same way as any other style, via a reference in the style attribute.

Character Styles are applied to Script Events and Text by using the style attribute to specify the set of applicable styles. Presentation Processors MUST NOT apply character styles to text if they are not specified using the style attribute.

Issue 44: [ED issue] Define DAPT-specific conformant implementation types

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:

DAPT Authoring Tool: tool that produces compliant DAPT documents or consumes DAPT compliant document. I don't think they map to TTML2 processors.
DAPT Audio Recorder/Renderer: tool that takes DAPT Audio Description scripts, e.g. with mixing instruction, and produces audio output, e.g. a WAVE file. I think it is a "presentation processor"
DAPT Validator: tool that verify that a DAPT document is compliant to the specification. I'm not sure what it maps to in TTML2 terminology.

Note

Given a document that specifies a <style> element with a ttm:agent attribute, and a Script Event with the same ttm:agent attribute value, but that does not reference (directly or by inheritance) that style using a style attribute, a Presentation Processor would not be conformant if it applied that style anyway, solely on the basis of the ttm:agent being the same.

Example 17

...
<styling>
  <style xml:id="style_a"
         ttm:agent="character_3"
         tts:color="#FFFFFF" tts:backgroundColor="#8F42AD"/>         
</styling>     
...
  <div xml:id="event_6" ttm:agent="character_3" style="style_a" ... >
  <-- Script event contents here, in Character 3's style -->
  </div>

  <div xml:id="event_7" ttm:agent="character_3" style="some_other_style" ... >
  <-- Script event contents here, not in Character 3's style -->
  </div>

A Script Event object represents dialogue, on screen text or audio descriptions to be spoken and has the following properties:

A mandatory Script Event Identifier which is unique in the script
An optional Begin property and an optional End and an optional Duration property that together define the Script Event's time interval in the programme timeline
Note
Typically Script Events do not overlap in time. However, there can be cases where they do, e.g. in Dubbing Scripts when different Characters speak different text at the same time.
An optional Script Event Type used to identify the type of event (e.g. dialogue, on screen text) in Dubbing Scripts.
Zero or more Character Identifiers indicating the Characters involved in this Script Event.
Note
While typically, a Script Event corresponds to one single Character, there are cases where multiple characters can be associated with a Script Event. This is when all Characters speak the same text at the same time.
Zero or more Text objects, each representing either the Original language transcript or Translations of the original language script in other languages.

Note
Empty Text objects can be used to indicate explicitly that there is no text content. It is recommended that empty Text objects are not used as a workflow placeholder to indicate incomplete work.
an optional Script Event Description property, as a human-readable description of the Script Event.
an optional On Screen property, which is an annotation indicating the position of the subject (e.g. a character) of the Script Event
Zero or more Mixing Instruction objects used to adjust playback of the programme audio during the Script Event.

A Script Event is represented in a DAPT Document by the following structure and constraints:

There MUST be one <div> element, with the following constraints:
- The xml:id attribute MUST be present containing the Script Event Identifier.
- The begin, end and dur attributes represent respectively the Begin, End and Duration of the Script Event.
  
  The begin and end attributes SHOULD be present. The dur attribute MAY be present.
  
  Note
  As noted in [TTML2] if both an end attribute and a dur attribute are present, the end time is the earlier of end and (begin + dur).
  Note
  If timing attributes are omitted, the following rules apply:
  - The default value for begin is zero, i.e. the same as the begin time of the parent element.
  - The default value for end is indefinite, i.e. it resolves to the same as the end time of the parent timed element, if there is one. The topmost timed element is the <body> element, whose end time is for practical purposes the end of the Related Media Object.
  - The default value for dur is indefinite, i.e. the end time resolves to the same as the end time of the parent element.
- The ttm:agent attribute MAY be present and if present, MUST contain a reference to each ttm:agent that represents an associated Character.
  Note
  Multiple references are specified using a space-separated list.
  Example 18
```
...
<div xml:id="event_1"
     begin="9663f" end="9682f" 
     ttm:agent="character_4">
...
</div>
...
```
- It MAY contain zero or more <p> elements representing each Text object.
- The style attribute MAY be present. If present, it MAY contain a reference to the <style> defining the Character Style. Additional style references or inline styles MAY be used.
- It MAY contain a <metadata> element representing the On Screen property.

The Text object contains text content typically in a single language. This language may be the Original language or a Translation language.

A Text object may be styled and associated with a Character.

Zero or more Mixing Instruction objects used to modify the programme audio during the Text MAY be present.

A Text object is represented in a DAPT Document by a <p> element with the following constraints:

The text content of the <p> is the Text of the Script Event.
Note
The text content of the paragraph can be structured using TTML elements such as <br> or <span> which can include or reference TTML style attributes such as tts:ruby used to alter the layout or styling of sections of text within each paragraph. Similarly metadata can be added using attributes or <metadata> elements.
The style attribute MAY be present. If present, it MAY contain a reference to the <style> that defines the relevant Character Style. Additional style references or inline styles MAY be used as defined in [TTML2], and MAY be applied to sub-sections of the text defined by <span> elements.
The referenced or inline styles MAY include the tta:speak or tta:pitch attributes representing a Synthesized Audio object.
Note
Synthesized audio styles may be applied to <span> elements within the text content to vary the rate or pitch of specific sub-sections of the text.
The <p> element MUST have one Text Language Source property.
The <p> element SHOULD have an xml:lang attribute corresponding to the language of the Text object.
Note
If a <p> element omits the xml: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 the Primary Language via its xml:lang attribute. Care should be taken if changing the Primary Language of a DAPT Script in case doing so affects descendant elements unexpectedly. Authors can mitigate this risk by explicitly setting xml:lang on all <p> elements.

Note
Within a <div> representing a Script Event the order of <p> children is significant.
Example 19
```
<div xml:id="event_3"
     begin="9663f" end="9682f" 
     style="style_a"
     ttm:agent="character_3">
  <p xml:lang="pt-BR" daptm:langSrc="original" >Você vai ter.</p>
  <p xml:lang="fr" daptm:langSrc="translation" >Bah, il arrive.</p>
</div>
```
Note
In some cases, a single section of original language dialogue can contain some words in other languages. Rather than splitting a Script Event into multiple Script Events to deal with this, Text objects in one language can also contain some words in a different language. This is represented in a DAPT Document by setting the xml:lang attribute on inner <span> elements.
It MAY contain zero or more <audio> elements representing each Audio Recording object.
It MAY contain zero or more <animate> elements representing each Mixing Instruction object.

The Text Language Source property is an annotation indicating whether a Text object is in the same language as the relevant part of the audio's language (original), or if it is a representation in another language (translation):

Original - the Text is any of:
1. the same language as the dialogue that it represents in the original programme audio;
2. a transcription of text visible in the original programme video, in the same language as that text;
3. representative of non-dialogue sound and is in the Primary Language of the DAPT Script;
4. representative of the scene in the original programme video, and is in the Primary Language of the DAPT Script.
Translation - the Text is a representation of the Original language text in a different language.

Note

The language of a Text object whose Text Language Source is Original can be different to the document's Primary Language. For example a transcript of a short piece of dialogue spoken in a different language to the majority of the dialogue would be annotated with both a different xml:lang value and as being Original.

The Text Language Source property is represented in a DAPT Document by a daptm:langSrc attribute with the following constraints:

Editor's note

Should we use an abbreviated attribute name?

Editor's note

Initial design is to use an abbreviated name and original|translation, though I considered using an abbreviated value too, since this attribute will appear on every <p> element. Abbreviating O for Original is probably a bad idea because the letter O and the number 0 can easily be confused. I also considered P for Primary but that caused potential confusion between Primary Language and Primary Text Language Source.

daptm:langSrc
  : "original"
  | "translation"

The On Screen property is an annotation indicating the position in the scene relating to the subject of a Script Event, for example of the character speaking:

ON - the Script Event's subject is on screen for the entire duration
OFF - the Script Event's subject is off screen for the entire duration
ON_OFF - the Script Event's subject starts on screen, but goes off screen at some point
OFF_ON - the Script Event's subject starts off screen, but goes on screen at some point

If omitted, the default value is "ON".

Note

When daptm:workflowType is set to audioDescription the subject of each Script 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.

The On Screen property is represented in a DAPT Document by a daptm:onScreen attribute on the <div> element, with the following constraints:

The following attribute corresponding to the On Screen Script Event property may be present:
```
daptm:onScreen
  : "ON"     # default
  | "OFF"
  | "ON_OFF"
  | "OFF_ON"
```

The Script Event Description property is an annotation providing a human-readable description of a Script Event.

The Script Event Description property is represented in a DAPT Document by a <ttm:desc> element at the <div> level.

Note

The Script Event Description does not need to be unique, i.e. it does not need to have a different value for each Script Event. For example a particular value could be re-used to identify in a human-readable way one or more Script Events that are intended to be processed together, e.g. in a batch recording.

Example 20

...
  <body>
    <div begin="10s" end="13s">
      <ttm:desc>Scene 1</ttm:desc>
      <p daptm:langSrc="original">
        <span>A woman climbs into a small sailing boat.</span>
      </p>
      <p xml:lang="fr" daptm:langSrc="translation">
        <span>Une femme monte à bord d'un petit bateau à voile.</span>
      </p>
    </div>
    <div begin="18s" end="20s">
      <ttm:desc>Scene 1</ttm:desc>
      <p daptm:langSrc="original">
        <span>The woman pulls the tiller and the boat turns.</span>
      </p>
      <p xml:lang="fr" daptm:langSrc="translation">
        <span>La femme tire sur la barre et le bateau tourne.</span>
      </p>
    </div>
  </body>
...

The <ttm:desc> element MAY have a daptm:descType attribute specified to indicate the type of description. The daptm:descType attribute is defined below. Its possible values are as indicated in the registry at YYY.

Editor's note

Registry to be defined.

daptm:descType : string

Example 21

...
  <body>
    <div begin="10s" end="13s">
      <ttm:desc daptm:descType="pronunciationNote">[oːnʲ]</ttm:desc>
      <p daptm:langSrc="original">Eóin looks around at the other assembly members.</p>
    </div>
  </body>
...

Multiple <ttm:desc> elements MAY be present with different values of daptm:descType, as in the following example.

Example 22

...
  <body>
    <div begin="10s" end="13s">
      <ttm:desc daptm:descType="scene">Scene 1</ttm:desc>
      <ttm:desc daptm:descType="plotSignificance">High</ttm:desc>
      <p daptm:langSrc="original">
        <span>A woman climbs into a small sailing boat.</span>
      </p>
      <p xml:lang="fr" daptm:langSrc="translation">
        <span>Une femme monte à bord d'un petit bateau à voile.</span>
      </p>
    </div>
    <div begin="18s" end="20s">
      <ttm:desc daptm:descType="scene">Scene 1</ttm:desc>
      <ttm:desc daptm:descType="plotSignificance">Low</ttm:desc>
      <p daptm:langSrc="original">
        <span>The woman pulls the tiller and the boat turns.</span>
      </p>
      <p xml:lang="fr" daptm:langSrc="translation">
        <span>La femme tire sur la barre et le bateau tourne.</span>
      </p>
    </div>
  </body>
...

The Script Event Type property provides one or more space-separated keywords representing the type of the Script Event, i.e. spoken text, or on-screen text, and in the latter case, the type of on-screen text (title, credit, location, ...). The possible keywords are indicated in the registry at XXXX.

Editor's note

Registry to be defined.

The Script Event Type is represented in a DAPT Document by the following attribute:

daptm:eventType : string

Example 23

...
<div xml:id="event_1"
     begin="9663f" end="9682f" 
     ttm:agent="character_4">
     daptm:eventType="dialogue"
...
</div>
...

An Audio object is used to specify an audio rendering of a Text. The audio rendering can either be a recorded audio resource, as an Audio Recording object, or a directive to synthesize a rendering of the text via a text to speech engine, which is a Synthesized Audio object. Both are types of Audio object.

It is an error for an Audio not to be in the same language as its Text.

A presentation processor that supports audio plays or inserts the Audio at the specified time on the related media object's timeline.

Note

The Audio object is "abstract": it only can exist as one of its sub-types, Audio Recording or Synthesized Audio.

An Audio Recording is an Audio object that references an audio resource. It has the following properties:

One or more alternative Sources, each of which is either 1) a link to an external audio resource or 2) an embedded audio recording;
For each Source, one mandatory Type that specifies the type ([MIME-TYPES]) of the audio resource, for example audio/basic;
An optional Begin property and an optional End and an optional Duration property that together define the Audio Recording's time interval in the programme timeline, in relation to the parent element's time interval;
An optional In Time and an optional Out Time property that together define a temporal subsection of the audio resource;
The default In Time is the beginning of the audio resource.

The default Out Time is the end of the audio resource.

If the temporal subsection of the audio resource is longer than the duration of the Audio Recording's time interval, then playback MUST be truncated to end when the Audio Recording's time interval ends.

Note
"Extended descriptions" (known in [media-accessibility-reqs] as "Extended video descriptions") are longer than the allocated time within the related media. A presentation processor that supports extended descriptions can allow the effective play rate of the audio resource to differ from the play rate of the related media object so that the resulting interval has a long enough duration to accommodate the audio resource's temporal subsection. For example it could pause or slow down playback of the related media object while continuing playback of the audio resource, or it could speed up playback of the audio resource, so that the Audio Recording's time interval does not end before the audio resource's temporal subsection. This behaviour is currently unspecified and therefore implementation-defined.

If the temporal subsection of the audio resource is shorter than the duration of the Audio Recording's time interval, then the audio resource plays once.
Zero or more Mixing Instructions that modify the playback characteristics of the Audio Recording.

When a list of Sources is provided, a presentation processor MUST play no more than one of the Sources for each Audio Recording.

Implementations can use the Type, and if present, any relevant additional formatting information, to decide which Source to play. For example, given two Sources, 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.

An Audio Recording is represented in a DAPT Document by an <audio> element child of a <p> or <span> element corresponding to the Text to which it applies. The following constraints apply to the <audio> element:

The begin, end and dur attributes represent respectively the Begin, End and Duration properties;
The clipBegin and clipEnd attributes represent respectively the In Time and Out Time properties, as illustrated by Example 5;
For each Source, if it is a link to an external audio resource, the Source and Type properties are represented by exactly one of:
1. A src attribute that is not a fragment identifier, and a type attribute respectively;
  This mechanism cannot be used if there is more than one Source.
  Example 24
```
<audio src="https://example.com/audio.wav" type="audio/wave"/>
```
2. A <source> child element with a src attribute that is not a fragment identifier and a type attribute respectively;
  Example 25
```
<audio>
  <source src="https://example.com/audio.wav" type="audio/wave"/>
  <source src="https://example.com/audio.aac" type="audio/aac"/>
</audio>
```
A src attribute that is not a fragment identifier is a URL that references an external audio resource, i.e. one that is not embedded within the DAPT Script. No validation that the resource can be located is specified in DAPT.

Editor's note
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"?
Issue 113: Support both `@src` and `<source>` child of `<audio>` (external resources)? question
```
          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 referencing external audio resources:
1. src attribute in <audio> element.
```
<audio src="https://example.com/audio_recording.wav" type="audio/wave"/>
```
1. <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 a format attribute in case type is inadequate. It also permits multiple <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]
If the Source is an embedded audio resource, the Source and Type properties are represented together by exactly one of:
1. A 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 a type attribute and the xml:id attribute used to reference it;
  This mechanism cannot be used if there is more than one Source.
  Example 26
```
<tt>
  <head>
    <resources>
      <data type="audio/wave" xml:id="audio1">
        [base64-encoded WAV audio resource]
      </data>
    </resources>
  </head>
  <body>
    ..
    <audio src="#audio1"/>
    ..
  </body>
</tt>
```
2. A <source> child element with a 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 a type attribute and the xml:id attribute used to reference it;
  Example 27
```
<tt>
  <head>
    <resources>
      <data type="audio/wave" xml:id="audio1wav">
        [base64-encoded WAV audio resource]
      </data>
      <data type="audio/mpeg" xml:id="audio1mp3">
        [base64-encoded MP3 audio resource]
      </data>
    </resources>
  </head>
  <body>
    ..
    <audio>
      <source src="#audio1wav"/>
      <source src="#audio1mp3"/>
    </audio>
    ..
  </body>
</tt>
```
3. A <source> child element with a <data> element child that specifies a type attribute and contains the audio recording data.
  Example 28
```
<audio>
  <source>
    <data type="audio/wave">
        [base64-encoded WAV audio resource]
    </data>
  </source>
</audio>
```
In each of the cases above the type attribute represents the Type property.

A src attribute that is a fragment identifier is a pointer to an audio resource that is embedded within the DAPT Script

If <data> elements are defined, each one MUST contain either #PCDATA or <chunk> child elements and MUST NOT contain any <source> child elements.

<data> and <source> elements MAY contain a format attribute whose value implementations MAY use in addition to the type attribute value when selecting an appropriate audio resource.

Editor's note
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 in tt/head/resources, which potentially could carry an implementation benefit? Consider marking the embedded data features as "at risk"?
Issue 114: Support both `@src` and `<source>` child of `<audio>` (embedded resources)? question
```
          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 referencing embedded audio resources:
1. src attribute in <audio> element referencing embedded <audio> or <data>:
```
<audio src="#audioRecording1"/>
...
<audio src="#audioRecording2"/>
```
1. <source> element child of <audio> element.
```
<audio>
    <source src="#audioRecording1"/>
</audio>
```
This second option has an additional possibility of specifying a format attribute in case type is inadequate. It also permits multiple <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.
Issue 115: Support both referenced and inline embedded audio recordings? question
```
          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>
```
Issue 116: Add non-inlined embedded audio resources to the Data Model? question
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?
Issue 117: Embedded data: Do we need to support all the permitted encodings? What about length? question
In TTML2's <data> element, an encoding can be specified, being one of:
- base16
- base32
- base32hex
- base64
- base64url
Do we need to require processor support for all of them, or will the default base64 be adequate?

Also, it is possible to specify a length 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?
Mixing Instructions MAY be applied as specified in their TTML representation;
The computed value of xml:lang MUST be identical to the computed value of xml:lang of the parent element and any child <source> elements and any referenced embedded <data> elements.

A Synthesized Audio is an Audio object that represents a machine generated audio rendering of the parent Text content. It has the following properties:

A mandatory Rate that specifies the rate of speech, being normal, fast or slow;
An optional Pitch that allows adjustment of the pitch of the speech.

A Synthesized Audio is represented in a DAPT Document by the application of a tta:speak style attribute on the element representing the Text object to be spoken, where the computed value of the attribute is normal, fast or slow. This attribute also represents the Rate Property.

The tta:pitch style attribute represents the Pitch property.

The TTML representation of a Synthesized Audio is illustrated by Example 6.

Note

A tta:pitch attribute on an element whose computed value of tta:rate is none has no effect. Such an element is not considered to have an associated Synthesized Audio.

A Mixing Instruction object is a static or animated adjustment of the audio relating to the containing object. It has the following properties:

Zero or more Gain properties. The gain acts as a multiplier to be applied to the related Audio;
Zero or more Pan properties. The pan adjusts the stereoscopic (left/right) position;
An optional Begin and an optional End and an optional Duration property that together define the time interval during which the Mixing Instruction applies;
An optional Fill property that specifies whether, at the end time of an animated Mixing Instruction, the specified Gain and Pan properties should be retained (freeze) or reverted (remove).

A Mixing 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:

The tta:gain attribute represents the Gain property;
The tta:pan attribute represents the Pan property.

If the Mixing 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 one Gain or Pan property is needed, or if any timing properties are needed.

The <animate> element(s) MUST be children of the element corresponding to the containing object, and have the following constraints:

The begin, end and dur attributes represent respectively the Begin, End and Duration properties;
The fill attribute represents the Fill property;
The tta:gain attribute represents the Gain property, and uses the animation-value-list syntax to express the list of values to be applied during the animation period;
The tta:pan attribute represents the Pan property, and uses the animation-value-list syntax to express the list of values to be applied during the animation period.

The TTML representation of animated Mixing Instructions is illustrated by Example 4.

See also B. Audio Mixing.

A DAPT Document MUST 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] document MUST NOT contain any of the following physical structures:

entity declarations; and
entity references other than to predefined entities.

Note

The resulting [xml] document can contain character references, and entity references to predefined 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)

Note

A DAPT Document can also be used as an in-memory model for processing, in which case the serialisation requirements do not apply.

A DAPT Document MAY contain elements and attributes that are neither specifically permitted nor forbidden by a profile.

Note

DAPT Documents remain subject to the content conformance requirements specified at Section 3.1 of [TTML2]. In particular, a DAPT Document can contain elements and attributes not in any TT namespace, i.e. in foreign namespaces, since such elements and attributes are pruned by the algorithm at Section 4 of [TTML2] prior to evaluating content conformance.

Note

For validation purposes it is good practice to define and use a content specification for all foreign namespace elements and attributes used within a DAPT Document.

A transformation processor SHOULD preserve such elements or attributes whenever possible.

Editor's note

Do we need to say that a presentation processor may ignore foreign vocab?

Many dubbing and audio description workflows permit annotation of Script Events or documents with proprietary metadata. Metadata vocabulary defined in this specification or in [TTML2] MAY be included. Additional vocabulary in other namespaces MAY also be included.

Note

It is possible to add information such as the title of the programme using [TTML2] constructs.

Example 29

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Error</title>
</head>
<body>
<pre>Cannot GET /examples/metadata-TTML2.xml</pre>
</body>
</html>

Note

It is possible to add workflow-specific information using a foreign namespace. In the following example, a fictitious namespace vendorm from an "example vendor" is used to provide document-level information not defined by DAPT.

Example 30

...
  <metadata xmlns: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>
...

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 Feature	none	`http://www.w3.org/ns/ttml/feature/`	[TTML2]
TT Audio Style	`tta`	`http://www.w3.org/ns/ttml#audio`	[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

The namespace prefix values defined above are for convenience and DAPT Documents MAY use any prefix value that conforms to [xml-names].

The namespaces defined by this proposal document are mutable [namespaceState]; all undefined names in these namespaces are reserved for future standardization by the W3C.

Within DAPT, 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 the Related Media Object that provides the media timeline and is the source of the main programme audio, and any visual timing references needed when adjusting timings relevant to the video image, such as for lip synchronization.

Note

A DAPT document can identify the programme acting as the Related Media Object using metadata. For example, it is possible to use the <ebuttm:sourceMediaIdentifier> element defined in [EBU-TT-3390].

<tt xmlns="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:applicationType="dubbing"
    daptm:scriptType="originalTranscript">
  <head>
    <metadata>
      <ebuttm:sourceMediaIdentifier>https://example.org/programme.mov</ebuttm:sourceMediaIdentifier>
    </metadata>
  </head>
  <body>
    ...
  </body>
</tt>

If the DAPT 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 the DAPT Document is intended to be rendered starting and ending on specific audio samples.

Note

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 presentation SHOULD 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 applications SHOULD 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 on DAPT documents intended for real-time playback mean that content processors SHOULD complete audio presentation changes no more than 35ms before the time specified in the DAPT document and no more than 45ms after the time specified.

This section defines how a TTML Document Instance signals that it is a DAPT Document and how it signals any processing requirements that apply. See also 6.1 Conformance of DAPT Documents, which defines how to establish that a DAPT Document conforms to this specification.

This profile is associated with the following profile designators:

Profile Name	Profile Designator
DAPT 1.0 Content Profile	`http://www.w3.org/ns/ttml/profile/dapt1.0/content`
DAPT 1.0 Processor Profile	`http://www.w3.org/ns/ttml/profile/dapt1.0/processor`

The ttp:contentProfiles attribute is used to declare the [TTML2] profiles to which the document conforms.

TTML documents representing DAPT Scripts MUST specify a ttp:contentProfiles attribute on the <tt> element including one value equal to the DAPT 1.0 Content Profile designator. Other values MAY be present to declare conformance to other profiles of [TTML2], and MAY include profile designators in proprietary namespaces.

The ttp:profile attribute is a mechanism within [TTML1] for declaring the processing requirements for a Document Instance. It has effectively been superceded in [TTML2] by ttp:processorProfiles.

TTML documents representing DAPT Scripts MUST NOT specify a ttp:profile attribute on the <tt> element.

The ttp:processorProfiles attribute is used to declare the processing requirements for a Document Instance.

TTML documents representing DAPT Scripts MAY specify a ttp:processorProfiles attribute on the <tt> element. If present, the ttp:processorProfiles attribute MUST include one value equal to the designator of the DAPT 1.0 Processor Profile. Other values MAY be present to declare additional processing constraints, and MAY include profile designators in proprietary namespaces.

Note

ttp:processorProfiles can be used to signal that features and extensions in additional profiles need to be supported to process the Document 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.

Note

If the content author does not need to signal that additional processor requirements than those defined by DAPT are needed to process the DAPT document then the ttp:processorProfiles is not expected to be present.

[TTML2] specifies a vocabulary and semantics that can be used to define the set of features that a document instance can make use of, or that a processor needs to support, known as a Profile.

Except where specified, it is not a requirement of DAPT 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 the Document Instance successfully. The vocabulary is itself defined in terms of TTML2 features. Those profile-related features are listed within C. Profiles as being optional. They MAY be implemented in processors and their associated vocabulary MAY be present in Document Instances.

Note

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) in DAPT is:

the <ttp:profile> element;
the <ttp:feature> and <ttp:extension> elements;
the ttp:permitFeatureNarrowing attribute;
the ttp:permitFeatureWidening attribute;
the ttp:contentProfileCombination attribute;
the ttp:inferProcessorProfileSource attribute;
the ttp:processorProfileCombination attribute.

Within a DAPT Script, the following constraints apply in relation to time attributes and time expressions:

The only permitted ttp:timeBase value is media, since C. 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 the Related Media Object.

The only permitted value of the timeContainer attribute is the default value, par.

Documents SHOULD omit the timeContainer attribute on all elements.

Documents MUST NOT set the timeContainer attribute to any value other than par on any element.

Note

This means that the begin 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 the f metric, or any time expression that contains a frames component, the ttp:frameRate attribute MUST be present on the <tt> element.

If the document contains any time expression that uses the t metric, the ttp:tickRate attribute MUST be present on the <tt> element.

All time expressions within a document SHOULD use the same syntax, either clock-time or offset-time as defined in [ttml2], with DAPT constraints applied.

Note

A DAPT clock-time has one of the forms:

hh:mm:ss.sss
hh:mm:ss

where hh is hours, mm is minutes, ss is seconds, and ss.sss is seconds with a decimal fraction of seconds (any precision).

Note

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.

Note

An offset-time has one of the forms:

nn metric
nn.nn metric

where nn is an integer, nn.nn is a number with a decimal fraction (any precision), and metric is one of:

h for hours,
m for minutes,
s for seconds,
ms for milliseconds,
f for frames, and
t 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, the content processor SHOULD 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 frame ceiling( 5.1 × ( 1000 / 1001 × 30) ) = 153 of a video that has a frame rate of 1000 / 1001 × 30 ≈ 29.97.

This specification does not put additional constraints on the layout and rendering features defined in [TTML-IMSC1.2].

Note

Layout of the paragraphs may rely on the default TTML region (i.e. if no <layout> element is used in the <head> element) or may be explicit by the use of the region attribute, to refer to a <region> element present at /tt/head/layout/region.

This section defines a [TTML2] content profile and a processor profile by expressing dispositions against a set of features and extensions. The DAPT extensions are defined in D. Extensions.

The Profile Semantics specified in [TTML2] apply.

A TTML Profile specification is a document that lists all the features of TTML that are required / optional / prohibited within “document instances” (files) and “processors” (things that process the files), and any extensions or constraints.

A Document Instance that conforms to the content profile defined herein:

MUST satisfy all normative provisions specified by the profile;
MAY include any vocabulary, syntax or attribute value associated with a feature or extension whose disposition is permitted or optional in the profile;
MUST include any vocabulary, syntax or attribute value associated with a feature or extension whose disposition is required in the profile.
MUST NOT include any vocabulary, syntax or attribute value associated with a feature or extension whose disposition is prohibited in the profile.

Note

A Document Instance, by definition, satisfies the requirements of Section 3.1 at [TTML2], and hence a Document Instance that conforms to a profile defined herein is also a conforming TTML2 Document Instance.

A Presentation processor that conforms to the processor profile defined in this specification:

MUST satisfy the Generic Processor Conformance requirements at Section 3.2.1 of [TTML2]
MUST satisfy all normative provisions specified by the profile; and
MUST implement presentation semantic support for every feature or extension designated as permitted or required by the profile, subject to any additional constraints on each feature as specified by the profile.
MAY implement presentation semantic support for every feature or extension designated as optional or prohibited by the profile, subject to any additional constraints on each feature as specified by the profile.

A Transformation processor that conforms to the processor profile defined in this specification:

MUST satisfy the Generic Processor Conformance requirements at Section 3.2.1 of [TTML2];
MUST satisfy all normative provisions specified by the profile; and
MUST implement transformation semantic support for every feature or extension designated as permitted or required by the profile, subject to any additional constraints on each feature as specified by the profile.
MAY implement transformation semantic support for every feature or extension designated as optional or prohibited by the profile, subject to any additional constraints on each feature as specified by the profile.

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	`<ttp:feature>` or `<ttp:extension>` `value` attribute value in
DAPT disposition	content profile	processor profile
required	required	required
permitted	optional	required
optional	optional	optional
prohibited	prohibited	optional

Note

The use of the terms presentation processor and transformation processor within this document does not imply conformance per se to any of the Standard Profiles defined in [TTML2]. In other words, it is not considered an error for a presentation processor or transformation processor to conform to the profile defined in this document without also conforming to the TTML2 Presentation Profile or the TTML2 Transformation Profile.

Note

The use of the [TTML2] profiling sub-system to describe DAPT conformance within this specification is not intended imply that DAPT processors are required to support any features of that system other than those for which support is explicitly required by DAPT.

Note

This document does not specify presentation processor or transformation processor behavior when processing or transforming a non-conformant Document Instance.

Note

The permitted and prohibited dispositions do not refer to the specification of a <ttp:feature> or <ttp:extension> element as being permitted or prohibited within a <ttp:profile> element.

The features and extensions listed in this section express the minimal requirements for DAPT Documents, Presentation Processors, and Transformation Processors. DAPT Documents MAY additionally conform to other profiles, and include syntax not prohibited by the DAPT content profile. Presentation Processors and Transformation Processors MAY support additional syntax and semantics relating to other profiles.

Note

For example, a DAPT Script can include syntax permitted by the IMSC ([TTML-IMSC1.2]) profiles of [TTML2] to enhance the presentation of scripts to actors recording audio, or to add styling important for later usage in subtitle or caption creation.

Editor's note

Editorial task: go through this list of features 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-minimal`	permitted
`#animate-fill`	permitted
`#animation-out-of-line`	prohibited	See 4.10 Mixing 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`	optional	See 5.6.2 `ttp:contentProfiles` and D.3 #contentProfiles-root.
`#contentProfiles-combined`	optional	See 5.6.5 Other 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	See 5.7.3 `ttp: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	See 5.6.5 Other TTML2 Profile Vocabulary.
`#permitFeatureWidening`	optional	See 5.6.5 Other TTML2 Profile Vocabulary.
`#pitch`	permitted
`#presentation-audio`	permitted
`#processorProfiles`	optional	See 5.6.4 `ttp:processorProfiles`.
`#processorProfiles-combined`	optional	See 5.6.5 Other TTML2 Profile Vocabulary.
`#profile`	partially permitted	See 5.6.3 `ttp:profile`.
`#profile-full-version-2`	partially permitted	See 5.6.5 Other TTML2 Profile Vocabulary.
`#profile-version-2`	partially permitted	See 5.6.5 Other 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	See 5.7.4 `ttp:tickRate`.
`#time-clock`	permitted
`#time-clock-with-frames`	prohibited
`#time-offset-with-frames`	permitted	See 5.7.3 `ttp:frameRate`.
`#time-offset-with-ticks`	permitted	See 5.7.4 `ttp:tickRate`.
`#time-offset`	permitted
`#time-wall-clock`	prohibited
`#timeBase-clock`	prohibited
`#timeBase-media`	required	See 5.7.1 `ttp:timeBase`. NOTE: [TTML1] specifies that the default timebase is `"media"` if `ttp:timeBase` is not specified on `<tt>`.
`#timeBase-smpte`	prohibited
`#timeContainer`	prohibited	See 5.7.2 `timeContainer`.
`#timing`	permitted	See 5.7.5 Time expressions.
`#transformation`	permitted	See constraints at #profile.
Relative to the DAPT Extension namespace
`#agent`	permitted	This is the profile expression of 4.2 Character.
`#contentProfiles-root`	required	This is the profile expression of 5.6.2 `ttp:contentProfiles`.
`#onScreen`	permitted	This is the profile expression of 4.6 On Screen.
`#profile-root`	prohibited	This is the profile expression of 5.6.3 `ttp:profile`.
`#scriptType-root`	required	This is the profile expression of 4.1.2 Script Type.
`#serialization`	required	This is the profile expression of 5.1 Document Encoding.
`#source-data`	prohibited	This is the profile expression of the prohibition of `<source>` child elements of `<data>` elements as specified in 4.9.1 Audio Recording.
`#textLanguageSource`	required	This is the profile expression of 4.5 Text Language Source as required at 4.4 Text.
`#workflowType-root`	required	This is the profile expression of 4.1.1 Workflow Type.
`#xmlId-div`	required	This is the profile expression of 4.3 Script Event.
`#xmlLang-audio-nonMatching`	prohibited	This is the profile expression of the prohibition of `xml:lang` on `<audio>` having a different computed value to the parent element and descendant or referenced `<source>` and `<data>` elements, as specified in 4.9.1 Audio Recording.
`#xmlLang-root`	required	This is the profile expression of 4.1.3 Primary Language.

The DAPT Content Profile expresses the conformance requirements of DAPT Scripts using the profile mechanism of [TTML2]. It can be used by a validating processor that supports the DAPT Processor Profile to validate a DAPT Document.

There is no requirement to include the DAPT Content Profile within a Document Instance.

<?xml version="1.0" encoding="utf-8"?>
<!-- this file defines the "dapt-content" profile of ttml -->
<profile xmlns="http://www.w3.org/ns/ttml#parameter"
  designator="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
  combine="mostRestrictive"
  type="content">
  <features xml:base="http://www.w3.org/ns/ttml/feature/">
    <!-- required (mandatory) feature support -->
    <feature value="required">#structure</feature>
    <feature value="required">#timeBase-media</feature>
    <!-- optional (voluntary) feature support -->
    <feature value="optional">#animate-fill</feature>
    <feature value="optional">#animate-minimal</feature>
    <feature value="optional">#audio</feature>
    <feature value="optional">#audio-description</feature>
    <feature value="optional">#audio-speech</feature>
    <feature value="optional">#bidi</feature>
    <feature value="optional" extends="#bidi">#bidi-version-2</feature>
    <feature value="optional">#chunk</feature>
    <feature value="optional">#content</feature>
    <feature value="optional">#contentProfiles</feature>
    <feature value="optional">#contentProfiles-combined</feature>
    <feature value="optional">#core</feature>
    <feature value="optional">#data</feature>
    <feature value="optional">#direction</feature>
    <feature value="optional">#embedded-audio</feature>
    <feature value="optional">#embedded-data</feature>
    <feature value="optional">#frameRate</feature>
    <feature value="optional">#frameRateMultiplier</feature>
    <feature value="optional">#gain</feature>
    <feature value="optional">#metadata</feature>
    <feature value="optional">#metadata-item</feature>
    <feature value="optional" extends="#metadata">#metadata-version-2</feature>
    <feature value="optional">#pan</feature>
    <feature value="optional">#permitFeatureNarrowing</feature>
    <feature value="optional">#permitFeatureWidening</feature>
    <feature value="optional">#pitch</feature>
    <feature value="optional">#presentation-audio</feature>
    <feature value="optional">#processorProfiles</feature>
    <feature value="optional">#processorProfiles-combined</feature>
    <feature value="optional">#resources</feature>
    <feature value="optional" extends="#animation">#set</feature>
    <feature value="optional">#set-fill</feature>
    <feature value="optional">#set-multiple-styles</feature>
    <feature value="optional">#source</feature>
    <feature value="optional">#speak</feature>
    <feature value="optional">#speech</feature>
    <feature value="optional">#styling</feature>
    <feature value="optional">#styling-chained</feature>
    <feature value="optional">#styling-inheritance-content</feature>
    <feature value="optional">#styling-inline</feature>
    <feature value="optional">#styling-referential</feature>
    <feature value="optional">#tickRate</feature>
    <feature value="optional">#time-clock</feature>
    <feature value="optional">#time-offset</feature>
    <feature value="optional">#time-offset-with-frames</feature>
    <feature value="optional">#time-offset-with-ticks</feature>
    <feature value="optional">#timing</feature>
    <feature value="optional">#unicodeBidi</feature>
    <feature value="optional">#unicodeBidi-isolate</feature>
    <feature value="optional" extends="#unicodeBidi">#unicodeBidi-version-2</feature>
    <feature value="optional">#xlink</feature>
    <!-- prohibited feature support -->
    <feature value="prohibited">#animation-out-of-line</feature>
    <feature value="prohibited">#clockMode</feature>
    <feature value="prohibited">#clockMode-gps</feature>
    <feature value="prohibited">#clockMode-local</feature>
    <feature value="prohibited">#clockMode-utc</feature>
    <feature value="prohibited">#dropMode</feature>
    <feature value="prohibited">#dropMode-dropNTSC</feature>
    <feature value="prohibited">#dropMode-dropPAL</feature>
    <feature value="prohibited">#dropMode-nonDrop</feature>
    <feature value="prohibited">#markerMode</feature>
    <feature value="prohibited">#markerMode-continuous</feature>
    <feature value="prohibited">#markerMode-discontinuous</feature>
    <feature value="prohibited">#subFrameRate</feature>
    <feature value="prohibited">#time-clock-with-frames</feature>
    <feature value="prohibited">#time-wall-clock</feature>
    <feature value="prohibited">#timeBase-clock</feature>
    <feature value="prohibited">#timeBase-smpte</feature>
    <feature value="prohibited">#timeContainer</feature>
  </features>
  <extensions xml:base="http://www.w3.org/ns/ttml/profile/dapt/extension/">
    <!-- required (mandatory) extension support -->
    <extension value="required">#contentProfiles-root</extension>
    <extension value="required">#scriptType-root</extension>
    <extension value="required">#serialization</extension>
    <extension value="required">#textLanguageSource</extension>
    <extension value="required">#workflowType-root</extension>
    <extension value="required">#xmlId-div</extension>
    <extension value="required">#xmlLang-root</extension>
    <!-- optional (voluntary) extension support -->
    <extension value="optional">#agent</extension>
    <extension value="optional">#onScreen</extension>
    <!-- prohibited extension support -->
    <extension value="prohibited">#profile-root</extension>
    <extension value="prohibited">#source-data</extension>
    <extension value="prohibited">#xmlLang-audio-nonMatching</extension>
</extensions>
</profile>

The DAPT Processor Profile expresses the processing requirements of DAPT Scripts using the profile mechanism of [TTML2]. A processor that supports the required features and extensions of the DAPT Processor Profile can, minimally, process all permitted features within a DAPT Document.

There is no requirement to include the DAPT Processor Profile within a Document Instance.

<?xml version="1.0" encoding="utf-8"?>
<!-- this file defines the "dapt-processor" profile of ttml -->
<profile xmlns="http://www.w3.org/ns/ttml#parameter"
  designator="http://www.w3.org/ns/ttml/profile/dapt1.0/processor"
  combine="mostRestrictive"
  type="processor">
  <features xml:base="http://www.w3.org/ns/ttml/feature/">
    <!-- required (mandatory) feature support -->
    <feature value="required">#animate-fill</feature>
    <feature value="required">#animate-minimal</feature>
    <feature value="required">#audio</feature>
    <feature value="required">#audio-description</feature>
    <feature value="required">#audio-speech</feature>
    <feature value="required">#bidi</feature>
    <feature value="required" extends="#bidi">#bidi-version-2</feature>
    <feature value="required">#chunk</feature>
    <feature value="required">#content</feature>
    <feature value="required">#contentProfiles</feature>
    <feature value="required">#core</feature>
    <feature value="required">#data</feature>
    <feature value="required">#direction</feature>
    <feature value="required">#embedded-audio</feature>
    <feature value="required">#embedded-data</feature>
    <feature value="required">#frameRate</feature>
    <feature value="required">#frameRateMultiplier</feature>
    <feature value="required">#gain</feature>
    <feature value="required">#metadata</feature>
    <feature value="required">#metadata-item</feature>
    <feature value="required" extends="#metadata">#metadata-version-2</feature>
    <feature value="required">#pan</feature>
    <feature value="required">#pitch</feature>
    <feature value="required">#presentation-audio</feature>
    <feature value="required">#resources</feature>
    <feature value="required" extends="#animation">#set</feature>
    <feature value="required">#set-fill</feature>
    <feature value="required">#set-multiple-styles</feature>
    <feature value="required">#source</feature>
    <feature value="required">#speak</feature>
    <feature value="required">#speech</feature>
    <feature value="required">#structure</feature>
    <feature value="required">#styling</feature>
    <feature value="required">#styling-chained</feature>
    <feature value="required">#styling-inheritance-content</feature>
    <feature value="required">#styling-inline</feature>
    <feature value="required">#styling-referential</feature>
    <feature value="required">#tickRate</feature>
    <feature value="required">#time-clock</feature>
    <feature value="required">#time-offset</feature>
    <feature value="required">#time-offset-with-frames</feature>
    <feature value="required">#time-offset-with-ticks</feature>
    <feature value="required">#timeBase-media</feature>
    <feature value="required">#timing</feature>
    <feature value="required">#transformation</feature>
    <feature value="required">#unicodeBidi</feature>
    <feature value="required">#unicodeBidi-isolate</feature>
    <feature value="required" extends="#unicodeBidi">#unicodeBidi-version-2</feature>
    <feature value="required">#xlink</feature>
    <!-- optional (voluntary) feature support -->
    <feature value="optional">#animation-out-of-line</feature>
    <feature value="optional">#clockMode</feature>
    <feature value="optional">#clockMode-gps</feature>
    <feature value="optional">#clockMode-local</feature>
    <feature value="optional">#clockMode-utc</feature>
    <feature value="optional">#contentProfiles-combined</feature>
    <feature value="optional">#dropMode</feature>
    <feature value="optional">#dropMode-dropNTSC</feature>
    <feature value="optional">#dropMode-dropPAL</feature>
    <feature value="optional">#dropMode-nonDrop</feature>
    <feature value="optional">#markerMode</feature>
    <feature value="optional">#markerMode-continuous</feature>
    <feature value="optional">#markerMode-discontinuous</feature>
    <feature value="optional">#permitFeatureNarrowing</feature>
    <feature value="optional">#permitFeatureWidening</feature>
    <feature value="optional">#processorProfiles</feature>
    <feature value="optional">#processorProfiles-combined</feature>
    <feature value="optional">#subFrameRate</feature>
    <feature value="optional">#time-clock-with-frames</feature>
    <feature value="optional">#time-wall-clock</feature>
    <feature value="optional">#timeBase-clock</feature>
    <feature value="optional">#timeBase-smpte</feature>
    <feature value="optional">#timeContainer</feature>
  </features>
  <extensions xml:base="http://www.w3.org/ns/ttml/profile/dapt/extension/">
    <!-- required (mandatory) extension support -->
    <extension value="required">#agent</extension>
    <extension value="required">#contentProfiles-root</extension>
    <extension value="required">#onScreen</extension>
    <extension value="required">#scriptType-root</extension>
    <extension value="required">#serialization</extension>
    <extension value="required">#textLanguageSource</extension>
    <extension value="required">#workflowType-root</extension>
    <extension value="required">#xmlId-div</extension>
    <extension value="required">#xmlLang-root</extension>
    <!-- optional (voluntary) extension support -->
    <extension value="optional">#profile-root</extension>
    <extension value="optional">#source-data</extension>
    <extension value="optional">#xmlLang-audio-nonMatching</extension>
</extensions>
</profile>

The following sections define extension designations, expressed as relative URIs (fragment identifiers) relative to the DAPT Extension Namespace base URI. These extension designations are used in C. Profiles to describe the normative provisions of DAPT that are not expressed by [TTML2] profile features.

A transformation 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> element

and if it recognizes and is capable of transforming each of the following value combinations:

<ttm:agent> element with type="person" and child <ttm:name> element with type="full";
<ttm:agent> element with type="character" and child <ttm:name> element with type="alias";

A presentation processor supports the #agent extension if it implements presentation semantic support of the above listed elements, attributes and value combinations.

A transformation processor supports the #contentProfiles-root extension if it recognizes and is capable of transforming values of the ttp:contentProfiles attribute on the <tt> element.

A presentation processor supports the #contentProfiles-root extension if it implements presentation semantic support of the ttp:contentProfiles attribute on the <tt> element.

Note

This extension is defined as a subset of #contentProfiles to avoid requiring processor support for the ttp:profile attribute and processor profile inference semantics.

A transformation processor supports the #onScreen extension if it recognizes and is capable of transforming values of the daptm:onScreen attribute on the <div> element.

A presentation processor supports the #onScreen extension if it implements presentation semantic support of the daptm:onScreen attribute on the <div> element.

A transformation processor supports the #profile-root extension if it recognizes and is capable of transforming values of the ttp:profile attribute on the <tt> element.

A presentation processor supports the #profile-root extension if it implements presentation semantic support of the ttp:profile attribute on the <tt> element.

A transformation processor supports the #scriptType-root extension if it recognizes and is capable of transforming values of the daptm:scriptType attribute on the <tt> element.

A presentation processor supports the #scriptType-root extension if it implements presentation semantic support of the daptm:scriptType attribute on the <tt> element.

An example of a transformation processor that supports this extension is a validating processor that provides appropriate feedback, for example warnings, when the SHOULD requirements defined in 4.1.2 Script Type for a DAPT Document's daptm:scriptType are not met, and that reports an error if the extension is required by a content profile but the Document Instance claiming conformance to that profile either does not have a daptm:scriptType attribute on the <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.

A transformation processor or a presentation processor supports the #serialization extension if it can read a serialized document as defined above.

A transformation processor that writes documents supports the #serialization extension if it can write a serialized document as defined above.

A transformation processor supports the #source-data extension if it recognizes and is capable of transforming values of the <source> element child of a <data> element.

A presentation processor supports the #source-data extension if it implements presentation semantic support of the <source> element child of a <data> element.

A transformation processor supports the #textLanguageSource extension if it recognizes and is capable of transforming values of the daptm:langSrc attribute on the <p> element.

A presentation processor supports the #textLanguageSource extension if it implements presentation semantic support of the daptm:langSrc attribute on the <p> element.

A transformation processor supports the #workflowType-root extension if it recognizes and is capable of transforming values of the daptm:workflowType attribute on the <tt> element.

A presentation processor supports the #workflowType-root extension if it implements presentation semantic support of the daptm:workflowType attribute on the <tt> element.

An example of a transformation processor that supports this extension is a validating processor that reports an error if the extension is required by a content profile but the Document Instance claiming conformance to that profile either does not have a daptm:workflowType attribute on the <tt> element or has one whose value is not defined herein.

A transformation processor supports the #xmlId-div extension if it recognizes and is capable of transforming values of the xml:id attribute on the <div> element.

A presentation processor supports the #xmlId-div extension if it implements presentation semantic support of the xml:id attribute on the <div> element.

A transformation processor supports the #xmlLang-audio-nonMatching extension if it recognizes and is capable of transforming values of the xml: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 as non-matching values.

A presentation processor supports the #xmlLang-audio-nonMatching extension if it implements presentation semantic support of such non-matching xml:lang attribute values.

A transformation processor supports the #xmlLang-root extension if it recognizes and is capable of transforming values of the xml:lang attribute on the <tt> element.

A presentation processor supports the #xmlLang-root extension if it implements presentation semantic support of the xml:lang attribute on the <tt> element.

Dubbing and Audio description Profiles of TTML2

Abstract

Status of This Document

1. Scope

2. Introduction

2.1 Transcripts and Scripts

2.1.1 Dubbing scripts

2.1.2 Audio Description scripts

2.2 Example documents

2.2.1 Basic document structure

2.2.2 Audio Description Examples

2.2.3 Dubbing Examples

3. Documentation Conventions

4. DAPT Data Model and corresponding TTML syntax

4.1 DAPT Script

4.1.1 Workflow Type

4.1.2 Script Type

4.1.3 Primary Language

4.1.4 Script Events

4.1.5 Characters

4.1.6 Shared properties

4.1.6.1 Timing Properties

4.2 Character

4.3 Script Event

4.4 Text

4.5 Text Language Source

4.6 On Screen

4.7 Script Event Description

4.8 Script Event Type

4.9 Audio

4.9.1 Audio Recording

4.9.2 Synthesized Audio

4.10 Mixing Instruction

5. Constraints

5.1 Document Encoding

5.2 Foreign Elements and Attributes

5.2.1 Proprietary Metadata

5.3 Namespaces

5.4 Related Media Object (TTML)

5.5 Synchronization

5.6 Profile Signaling

5.6.1 Profile Designator

5.6.2 ttp:contentProfiles

5.6.3 ttp:profile

5.6.4 ttp:processorProfiles

5.6.5 Other TTML2 Profile Vocabulary

5.7 Timing constraints

5.7.1 ttp:timeBase

5.7.2 timeContainer

5.7.3 ttp:frameRate

5.7.4 ttp:tickRate

5.7.5 Time expressions

5.8 Layout

6. Conformance

6.1 Conformance of DAPT Documents

6.2 Conformance of DAPT Processors

A. Index

A.1 Terms defined by this specification

A.2 Terms defined by reference

B. Audio Mixing

C. Profiles

C.1 Disposition of Features and Extensions

C.2 DAPT Content Profile

C.3 DAPT Processor Profile

D. Extensions

D.1 General

D.2 #agent

D.3 #contentProfiles-root

D.4 #onScreen

D.5 #profile-root

D.6 #scriptType-root

D.7 #serialization

D.8 #source-data

D.9 #textLanguageSource

D.10 #workflowType-root

D.11 #xmlId-div

D.12 #xmlLang-audio-nonMatching

D.13 #xmlLang-root

E. Acknowledgments

F. References

5.6.2 `ttp:contentProfiles`

5.6.3 `ttp:profile`

5.6.4 `ttp:processorProfiles`

5.7.1 `ttp:timeBase`

5.7.2 `timeContainer`

5.7.3 `ttp:frameRate`

5.7.4 `ttp:tickRate`