Source: lib/text/ttml_text_parser.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.text.TtmlTextParser');
  9. goog.require('goog.asserts');
  10. goog.require('goog.Uri');
  11. goog.require('shaka.log');
  12. goog.require('shaka.text.Cue');
  13. goog.require('shaka.text.CueRegion');
  14. goog.require('shaka.text.TextEngine');
  15. goog.require('shaka.util.ArrayUtils');
  16. goog.require('shaka.util.Error');
  17. goog.require('shaka.util.StringUtils');
  18. goog.require('shaka.util.TXml');
  21. /**
  22.  * @implements {shaka.extern.TextParser}
  23.  * @export
  24.  */
  25. shaka.text.TtmlTextParser = class {
  26.   /**
  27.    * @override
  28.    * @export
  29.    */
  30.   parseInit(data) {
  31.     goog.asserts.assert(false, 'TTML does not have init segments');
  32.   }
  34.   /**
  35.    * @override
  36.    * @export
  37.    */
  38.   setSequenceMode(sequenceMode) {
  39.     // Unused.
  40.   }
  42.   /**
  43.    * @override
  44.    * @export
  45.    */
  46.   setManifestType(manifestType) {
  47.     // Unused.
  48.   }
  50.   /**
  51.    * @override
  52.    * @export
  53.    */
  54.   parseMedia(data, time, uri, images) {
  55.     const TtmlTextParser = shaka.text.TtmlTextParser;
  56.     const TXml = shaka.util.TXml;
  57.     const ttpNs = TtmlTextParser.parameterNs_;
  58.     const ttsNs = TtmlTextParser.styleNs_;
  59.     const str = shaka.util.StringUtils.fromUTF8(data);
  60.     const cues = [];
  62.     // dont try to parse empty string as
  63.     // DOMParser will not throw error but return an errored xml
  64.     if (str == '') {
  65.       return cues;
  66.     }
  68.     const tt = TXml.parseXmlString(str, 'tt', /* includeParent= */ true);
  69.     if (!tt) {
  70.       throw new shaka.util.Error(
  71.           shaka.util.Error.Severity.CRITICAL,
  72.           shaka.util.Error.Category.TEXT,
  73.           shaka.util.Error.Code.INVALID_XML,
  74.           'Failed to parse TTML.');
  75.     }
  77.     const body = TXml.getElementsByTagName(tt, 'body')[0];
  78.     if (!body) {
  79.       return [];
  80.     }
  82.     // Get the framerate, subFrameRate and frameRateMultiplier if applicable.
  83.     const frameRate = TXml.getAttributeNSList(tt, ttpNs, 'frameRate');
  84.     const subFrameRate = TXml.getAttributeNSList(
  85.         tt, ttpNs, 'subFrameRate');
  86.     const frameRateMultiplier =
  87.         TXml.getAttributeNSList(tt, ttpNs, 'frameRateMultiplier');
  88.     const tickRate = TXml.getAttributeNSList(tt, ttpNs, 'tickRate');
  90.     const cellResolution = TXml.getAttributeNSList(
  91.         tt, ttpNs, 'cellResolution');
  92.     const spaceStyle = tt.attributes['xml:space'] || 'default';
  93.     const extent = TXml.getAttributeNSList(tt, ttsNs, 'extent');
  95.     if (spaceStyle != 'default' && spaceStyle != 'preserve') {
  96.       throw new shaka.util.Error(
  97.           shaka.util.Error.Severity.CRITICAL,
  98.           shaka.util.Error.Category.TEXT,
  99.           shaka.util.Error.Code.INVALID_XML,
  100.           'Invalid xml:space value: ' + spaceStyle);
  101.     }
  102.     const collapseMultipleSpaces = spaceStyle == 'default';
  104.     const rateInfo = new TtmlTextParser.RateInfo_(
  105.         frameRate, subFrameRate, frameRateMultiplier, tickRate);
  107.     const cellResolutionInfo =
  108.       TtmlTextParser.getCellResolution_(cellResolution);
  110.     const metadata = TXml.getElementsByTagName(tt, 'metadata')[0];
  111.     const metadataElements =
  112.         (metadata ? metadata.children : []).filter((c) => c != '\n');
  113.     const styles = TXml.getElementsByTagName(tt, 'style');
  114.     const regionElements = TXml.getElementsByTagName(tt, 'region');
  116.     const cueRegions = [];
  117.     for (const region of regionElements) {
  118.       const cueRegion =
  119.           TtmlTextParser.parseCueRegion_(region, styles, extent);
  120.       if (cueRegion) {
  121.         cueRegions.push(cueRegion);
  122.       }
  123.     }
  125.     // A <body> element should only contain <div> elements, not <p> or <span>
  126.     // elements.  We used to allow this, but it is non-compliant, and the
  127.     // loose nature of our previous parser made it difficult to implement TTML
  128.     // nesting more fully.
  129.     if (TXml.findChildren(body, 'p').length) {
  130.       throw new shaka.util.Error(
  131.           shaka.util.Error.Severity.CRITICAL,
  132.           shaka.util.Error.Category.TEXT,
  133.           shaka.util.Error.Code.INVALID_TEXT_CUE,
  134.           '<p> can only be inside <div> in TTML');
  135.     }
  137.     for (const div of TXml.findChildren(body, 'div')) {
  138.       // A <div> element should only contain <p>, not <span>.
  139.       if (TXml.findChildren(div, 'span').length) {
  140.         throw new shaka.util.Error(
  141.             shaka.util.Error.Severity.CRITICAL,
  142.             shaka.util.Error.Category.TEXT,
  143.             shaka.util.Error.Code.INVALID_TEXT_CUE,
  144.             '<span> can only be inside <p> in TTML');
  145.       }
  146.     }
  148.     const cue = TtmlTextParser.parseCue_(
  149.         body, time, rateInfo, metadataElements, styles,
  150.         regionElements, cueRegions, collapseMultipleSpaces,
  151.         cellResolutionInfo, /* parentCueElement= */ null,
  152.         /* isContent= */ false, uri, images);
  153.     if (cue) {
  154.       // According to the TTML spec, backgrounds default to transparent.
  155.       // So default the background of the top-level element to transparent.
  156.       // Nested elements may override that background color already.
  157.       if (!cue.backgroundColor) {
  158.         cue.backgroundColor = 'transparent';
  159.       }
  160.       cues.push(cue);
  161.     }
  163.     return cues;
  164.   }
  166.   /**
  167.    * Parses a TTML node into a Cue.
  168.    *
  169.    * @param {!shaka.extern.xml.Node} cueNode
  170.    * @param {shaka.extern.TextParser.TimeContext} timeContext
  171.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  172.    * @param {!Array.<!shaka.extern.xml.Node>} metadataElements
  173.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  174.    * @param {!Array.<!shaka.extern.xml.Node>} regionElements
  175.    * @param {!Array.<!shaka.text.CueRegion>} cueRegions
  176.    * @param {boolean} collapseMultipleSpaces
  177.    * @param {?{columns: number, rows: number}} cellResolution
  178.    * @param {?shaka.extern.xml.Node} parentCueElement
  179.    * @param {boolean} isContent
  180.    * @param {?(string|undefined)} uri
  181.    * @param {!Array.<string>} images
  182.    * @return {shaka.text.Cue}
  183.    * @private
  184.    */
  185.   static parseCue_(
  186.       cueNode, timeContext, rateInfo, metadataElements, styles, regionElements,
  187.       cueRegions, collapseMultipleSpaces, cellResolution, parentCueElement,
  188.       isContent, uri, images) {
  189.     const TXml = shaka.util.TXml;
  190.     const StringUtils = shaka.util.StringUtils;
  191.     /** @type {shaka.extern.xml.Node} */
  192.     let cueElement;
  193.     /** @type {?shaka.extern.xml.Node} */
  194.     let parentElement = parentCueElement;
  196.     if (TXml.isText(cueNode)) {
  197.       if (!isContent) {
  198.         // Ignore text elements outside the content. For example, whitespace
  199.         // on the same lexical level as the <p> elements, in a document with
  200.         // xml:space="preserve", should not be renderer.
  201.         return null;
  202.       }
  203.       // This should generate an "anonymous span" according to the TTML spec.
  204.       // So pretend the element was a <span>.  parentElement was set above, so
  205.       // we should still be able to correctly traverse up for timing
  206.       // information later.
  207.       /** @type {shaka.extern.xml.Node} */
  208.       const span = {
  209.         tagName: 'span',
  210.         children: [TXml.getTextContents(cueNode)],
  211.         attributes: {},
  212.         parent: null,
  213.       };
  214.       cueElement = span;
  215.     } else {
  216.       cueElement = cueNode;
  217.     }
  218.     goog.asserts.assert(cueElement, 'cueElement should be non-null!');
  220.     let imageElement = null;
  221.     for (const nameSpace of shaka.text.TtmlTextParser.smpteNsList_) {
  222.       imageElement = shaka.text.TtmlTextParser.getElementsFromCollection_(
  223.           cueElement, 'backgroundImage', metadataElements, '#',
  224.           nameSpace)[0];
  225.       if (imageElement) {
  226.         break;
  227.       }
  228.     }
  230.     let imageUri = null;
  231.     const backgroundImage = TXml.getAttributeNSList(
  232.         cueElement,
  233.         shaka.text.TtmlTextParser.smpteNsList_,
  234.         'backgroundImage');
  235.     const imsc1ImgUrnTester =
  236.         /^(urn:)(mpeg:[a-z0-9][a-z0-9-]{0,31}:)(subs:)([0-9]+)$/;
  237.     if (backgroundImage && imsc1ImgUrnTester.test(backgroundImage)) {
  238.       const index = parseInt(backgroundImage.split(':').pop(), 10) -1;
  239.       if (index >= images.length) {
  240.         return null;
  241.       }
  242.       imageUri = images[index];
  243.     } else if (uri && backgroundImage && !backgroundImage.startsWith('#')) {
  244.       const baseUri = new goog.Uri(uri);
  245.       const relativeUri = new goog.Uri(backgroundImage);
  246.       const newUri = baseUri.resolve(relativeUri).toString();
  247.       if (newUri) {
  248.         imageUri = newUri;
  249.       }
  250.     }
  252.     if (cueNode.tagName == 'p' || imageElement || imageUri) {
  253.       isContent = true;
  254.     }
  256.     const parentIsContent = isContent;
  258.     const spaceStyle = cueElement.attributes['xml:space'] ||
  259.         (collapseMultipleSpaces ? 'default' : 'preserve');
  261.     const localCollapseMultipleSpaces = spaceStyle == 'default';
  263.     // Parse any nested cues first.
  264.     const isLeafNode = cueElement.children.every(TXml.isText);
  265.     const nestedCues = [];
  266.     if (!isLeafNode) {
  267.       // Otherwise, recurse into the children.  Text nodes will convert into
  268.       // anonymous spans, which will then be leaf nodes.
  269.       for (const childNode of cueElement.children) {
  270.         const nestedCue = shaka.text.TtmlTextParser.parseCue_(
  271.             childNode,
  272.             timeContext,
  273.             rateInfo,
  274.             metadataElements,
  275.             styles,
  276.             regionElements,
  277.             cueRegions,
  278.             localCollapseMultipleSpaces,
  279.             cellResolution,
  280.             cueElement,
  281.             isContent,
  282.             uri,
  283.             images,
  284.         );
  286.         // This node may or may not generate a nested cue.
  287.         if (nestedCue) {
  288.           nestedCues.push(nestedCue);
  289.         }
  290.       }
  291.     }
  293.     const isNested = /** @type {boolean} */ (parentCueElement != null);
  295.     const textContent = TXml.getTextContents(cueElement);
  296.     // In this regex, "\S" means "non-whitespace character".
  297.     const hasTextContent = cueElement.children.length &&
  298.         textContent &&
  299.         /\S/.test(textContent);
  301.     const hasTimeAttributes =
  302.         cueElement.attributes['begin'] ||
  303.         cueElement.attributes['end'] ||
  304.         cueElement.attributes['dur'];
  306.     if (!hasTimeAttributes && !hasTextContent && cueElement.tagName != 'br' &&
  307.         nestedCues.length == 0) {
  308.       if (!isNested) {
  309.         // Disregards empty <p> elements without time attributes nor content.
  310.         // <p begin="..." smpte:backgroundImage="..." /> will go through,
  311.         // as some information could be held by its attributes.
  312.         // <p /> won't, as it would not be displayed.
  313.         return null;
  314.       } else if (localCollapseMultipleSpaces) {
  315.         // Disregards empty anonymous spans when (local) trim is true.
  316.         return null;
  317.       }
  318.     }
  320.     // Get local time attributes.
  321.     let {start, end} = shaka.text.TtmlTextParser.parseTime_(
  322.         cueElement, rateInfo);
  323.     // Resolve local time relative to parent elements.  Time elements can appear
  324.     // all the way up to 'body', but not 'tt'.
  325.     while (parentElement && TXml.isNode(parentElement) &&
  326.         parentElement.tagName != 'tt') {
  327.       ({start, end} = shaka.text.TtmlTextParser.resolveTime_(
  328.           parentElement, rateInfo, start, end));
  329.       parentElement =
  330.         /** @type {shaka.extern.xml.Node} */ (parentElement.parent);
  331.     }
  333.     if (start == null) {
  334.       start = 0;
  335.     }
  336.     start += timeContext.periodStart;
  338.     // If end is null, that means the duration is effectively infinite.
  339.     if (end == null) {
  340.       end = Infinity;
  341.     } else {
  342.       end += timeContext.periodStart;
  343.     }
  345.     // Clip times to segment boundaries.
  346.     // https://github.com/shaka-project/shaka-player/issues/4631
  347.     start = Math.max(start, timeContext.segmentStart);
  348.     end = Math.min(end, timeContext.segmentEnd);
  350.     if (!hasTimeAttributes && nestedCues.length > 0) {
  351.       // If no time is defined for this cue, base the timing information on
  352.       // the time of the nested cues. In the case of multiple nested cues with
  353.       // different start times, it is the text displayer's responsibility to
  354.       // make sure that only the appropriate nested cue is drawn at any given
  355.       // time.
  356.       start = Infinity;
  357.       end = 0;
  358.       for (const cue of nestedCues) {
  359.         start = Math.min(start, cue.startTime);
  360.         end = Math.max(end, cue.endTime);
  361.       }
  362.     }
  364.     if (cueElement.tagName == 'br') {
  365.       const cue = new shaka.text.Cue(start, end, '');
  366.       cue.lineBreak = true;
  367.       return cue;
  368.     }
  370.     let payload = '';
  371.     if (isLeafNode) {
  372.       // If the childNodes are all text, this is a leaf node.  Get the payload.
  373.       payload = StringUtils.htmlUnescape(
  374.           shaka.util.TXml.getTextContents(cueElement) || '');
  375.       if (localCollapseMultipleSpaces) {
  376.         // Collapse multiple spaces into one.
  377.         payload = payload.replace(/\s+/g, ' ');
  378.       }
  379.     }
  381.     const cue = new shaka.text.Cue(start, end, payload);
  382.     cue.nestedCues = nestedCues;
  384.     if (!isContent) {
  385.       // If this is not a <p> element or a <div> with images, and it has no
  386.       // parent that was a <p> element, then it's part of the outer containers
  387.       // (e.g. the <body> or a normal <div> element within it).
  388.       cue.isContainer = true;
  389.     }
  391.     if (cellResolution) {
  392.       cue.cellResolution = cellResolution;
  393.     }
  395.     // Get other properties if available.
  396.     const regionElement = shaka.text.TtmlTextParser.getElementsFromCollection_(
  397.         cueElement, 'region', regionElements, /* prefix= */ '')[0];
  398.     // Do not actually apply that region unless it is non-inherited, though.
  399.     // This makes it so that, if a parent element has a region, the children
  400.     // don't also all independently apply the positioning of that region.
  401.     if (cueElement.attributes['region']) {
  402.       if (regionElement && regionElement.attributes['xml:id']) {
  403.         const regionId = regionElement.attributes['xml:id'];
  404.         cue.region = cueRegions.filter((region) => region.id == regionId)[0];
  405.       }
  406.     }
  408.     let regionElementForStyle = regionElement;
  409.     if (parentCueElement && isNested && !cueElement.attributes['region'] &&
  410.       !cueElement.attributes['style']) {
  411.       regionElementForStyle =
  412.           shaka.text.TtmlTextParser.getElementsFromCollection_(
  413.               parentCueElement, 'region', regionElements, /* prefix= */ '')[0];
  414.     }
  416.     shaka.text.TtmlTextParser.addStyle_(
  417.         cue,
  418.         cueElement,
  419.         regionElementForStyle,
  420.         /** @type {!shaka.extern.xml.Node} */(imageElement),
  421.         imageUri,
  422.         styles,
  423.         /** isNested= */ parentIsContent, // "nested in a <div>" doesn't count.
  424.         /** isLeaf= */ (nestedCues.length == 0));
  426.     return cue;
  427.   }
  429.   /**
  430.    * Parses an Element into a TextTrackCue or VTTCue.
  431.    *
  432.    * @param {!shaka.extern.xml.Node} regionElement
  433.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  434.    * Defined in the top of tt element and used principally for images.
  435.    * @param {?string} globalExtent
  436.    * @return {shaka.text.CueRegion}
  437.    * @private
  438.    */
  439.   static parseCueRegion_(regionElement, styles, globalExtent) {
  440.     const TtmlTextParser = shaka.text.TtmlTextParser;
  441.     const region = new shaka.text.CueRegion();
  442.     const id = regionElement.attributes['xml:id'];
  443.     if (!id) {
  444.       shaka.log.warning('TtmlTextParser parser encountered a region with ' +
  445.                         'no id. Region will be ignored.');
  446.       return null;
  447.     }
  448.     region.id = id;
  450.     let globalResults = null;
  451.     if (globalExtent) {
  452.       globalResults = TtmlTextParser.percentValues_.exec(globalExtent) ||
  453.         TtmlTextParser.pixelValues_.exec(globalExtent);
  454.     }
  455.     const globalWidth = globalResults ? Number(globalResults[1]) : null;
  456.     const globalHeight = globalResults ? Number(globalResults[2]) : null;
  458.     let results = null;
  459.     let percentage = null;
  460.     const extent = TtmlTextParser.getStyleAttributeFromRegion_(
  461.         regionElement, styles, 'extent');
  462.     if (extent) {
  463.       percentage = TtmlTextParser.percentValues_.exec(extent);
  464.       results = percentage || TtmlTextParser.pixelValues_.exec(extent);
  465.       if (results != null) {
  466.         region.width = Number(results[1]);
  467.         region.height = Number(results[2]);
  469.         if (!percentage) {
  470.           if (globalWidth != null) {
  471.             region.width = region.width * 100 / globalWidth;
  472.           }
  473.           if (globalHeight != null) {
  474.             region.height = region.height * 100 / globalHeight;
  475.           }
  476.         }
  478.         region.widthUnits = percentage || globalWidth != null ?
  479.                            shaka.text.CueRegion.units.PERCENTAGE :
  480.                            shaka.text.CueRegion.units.PX;
  482.         region.heightUnits = percentage || globalHeight != null ?
  483.                            shaka.text.CueRegion.units.PERCENTAGE :
  484.                            shaka.text.CueRegion.units.PX;
  485.       }
  486.     }
  488.     const origin = TtmlTextParser.getStyleAttributeFromRegion_(
  489.         regionElement, styles, 'origin');
  490.     if (origin) {
  491.       percentage = TtmlTextParser.percentValues_.exec(origin);
  492.       results = percentage || TtmlTextParser.pixelValues_.exec(origin);
  493.       if (results != null) {
  494.         region.viewportAnchorX = Number(results[1]);
  495.         region.viewportAnchorY = Number(results[2]);
  497.         if (!percentage) {
  498.           if (globalHeight != null) {
  499.             region.viewportAnchorY = region.viewportAnchorY * 100 /
  500.               globalHeight;
  501.           }
  502.           if (globalWidth != null) {
  503.             region.viewportAnchorX = region.viewportAnchorX * 100 /
  504.               globalWidth;
  505.           }
  506.         } else if (!extent) {
  507.           region.width = 100 - region.viewportAnchorX;
  508.           region.widthUnits = shaka.text.CueRegion.units.PERCENTAGE;
  509.           region.height = 100 - region.viewportAnchorY;
  510.           region.heightUnits = shaka.text.CueRegion.units.PERCENTAGE;
  511.         }
  513.         region.viewportAnchorUnits = percentage || globalWidth != null ?
  514.                   shaka.text.CueRegion.units.PERCENTAGE :
  515.                   shaka.text.CueRegion.units.PX;
  516.       }
  517.     }
  519.     return region;
  520.   }
  522.   /**
  523.    * Ensures any TTML RGBA's alpha range of 0-255 is converted to 0-1.
  524.    * @param {string} color
  525.    * @return {string}
  526.    * @private
  527.    */
  528.   static convertTTMLrgbaToHTMLrgba_(color) {
  529.     const rgba = color.match(/rgba\(([^)]+)\)/);
  530.     if (rgba) {
  531.       const values = rgba[1].split(',');
  532.       if (values.length == 4) {
  533.         values[3] = String(Number(values[3]) / 255);
  534.         return 'rgba(' + values.join(',') + ')';
  535.       }
  536.     }
  537.     return color;
  538.   }
  540.   /**
  541.    * Adds applicable style properties to a cue.
  542.    *
  543.    * @param {!shaka.text.Cue} cue
  544.    * @param {!shaka.extern.xml.Node} cueElement
  545.    * @param {shaka.extern.xml.Node} region
  546.    * @param {shaka.extern.xml.Node} imageElement
  547.    * @param {?string} imageUri
  548.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  549.    * @param {boolean} isNested
  550.    * @param {boolean} isLeaf
  551.    * @private
  552.    */
  553.   static addStyle_(
  554.       cue, cueElement, region, imageElement, imageUri, styles,
  555.       isNested, isLeaf) {
  556.     const TtmlTextParser = shaka.text.TtmlTextParser;
  557.     const TXml = shaka.util.TXml;
  558.     const Cue = shaka.text.Cue;
  560.     // Styles should be inherited from regions, if a style property is not
  561.     // associated with a Content element (or an anonymous span).
  562.     const shouldInheritRegionStyles = isNested || isLeaf;
  564.     const direction = TtmlTextParser.getStyleAttribute_(
  565.         cueElement, region, styles, 'direction', shouldInheritRegionStyles);
  566.     if (direction == 'rtl') {
  567.       cue.direction = Cue.direction.HORIZONTAL_RIGHT_TO_LEFT;
  568.     }
  570.     // Direction attribute specifies one-dimentional writing direction
  571.     // (left to right or right to left). Writing mode specifies that
  572.     // plus whether text is vertical or horizontal.
  573.     // They should not contradict each other. If they do, we give
  574.     // preference to writing mode.
  575.     const writingMode = TtmlTextParser.getStyleAttribute_(
  576.         cueElement, region, styles, 'writingMode', shouldInheritRegionStyles);
  577.     // Set cue's direction if the text is horizontal, and cue's writingMode if
  578.     // it's vertical.
  579.     if (writingMode == 'tb' || writingMode == 'tblr') {
  580.       cue.writingMode = Cue.writingMode.VERTICAL_LEFT_TO_RIGHT;
  581.     } else if (writingMode == 'tbrl') {
  582.       cue.writingMode = Cue.writingMode.VERTICAL_RIGHT_TO_LEFT;
  583.     } else if (writingMode == 'rltb' || writingMode == 'rl') {
  584.       cue.direction = Cue.direction.HORIZONTAL_RIGHT_TO_LEFT;
  585.     } else if (writingMode) {
  586.       cue.direction = Cue.direction.HORIZONTAL_LEFT_TO_RIGHT;
  587.     }
  589.     const align = TtmlTextParser.getStyleAttribute_(
  590.         cueElement, region, styles, 'textAlign', true);
  591.     if (align) {
  592.       cue.positionAlign = TtmlTextParser.textAlignToPositionAlign_[align];
  593.       cue.lineAlign = TtmlTextParser.textAlignToLineAlign_[align];
  595.       goog.asserts.assert(align.toUpperCase() in Cue.textAlign,
  596.           align.toUpperCase() + ' Should be in Cue.textAlign values!');
  598.       cue.textAlign = Cue.textAlign[align.toUpperCase()];
  599.     } else {
  600.       // Default value is START in the TTML spec: https://bit.ly/32OGmvo
  601.       // But to make the subtitle render consitent with other players and the
  602.       // shaka.text.Cue we use CENTER
  603.       cue.textAlign = Cue.textAlign.CENTER;
  604.     }
  606.     const displayAlign = TtmlTextParser.getStyleAttribute_(
  607.         cueElement, region, styles, 'displayAlign', true);
  608.     if (displayAlign) {
  609.       goog.asserts.assert(displayAlign.toUpperCase() in Cue.displayAlign,
  610.           displayAlign.toUpperCase() +
  611.                           ' Should be in Cue.displayAlign values!');
  612.       cue.displayAlign = Cue.displayAlign[displayAlign.toUpperCase()];
  613.     }
  615.     const color = TtmlTextParser.getStyleAttribute_(
  616.         cueElement, region, styles, 'color', shouldInheritRegionStyles);
  617.     if (color) {
  618.       cue.color = TtmlTextParser.convertTTMLrgbaToHTMLrgba_(color);
  619.     }
  621.     // Background color should not be set on a container.  If this is a nested
  622.     // cue, you can set the background.  If it's a top-level that happens to
  623.     // also be a leaf, you can set the background.
  624.     // See https://github.com/shaka-project/shaka-player/issues/2623
  625.     // This used to be handled in the displayer, but that is confusing.  The Cue
  626.     // structure should reflect what you want to happen in the displayer, and
  627.     // the displayer shouldn't have to know about TTML.
  628.     const backgroundColor = TtmlTextParser.getStyleAttribute_(
  629.         cueElement, region, styles, 'backgroundColor',
  630.         shouldInheritRegionStyles);
  631.     if (backgroundColor) {
  632.       cue.backgroundColor =
  633.         TtmlTextParser.convertTTMLrgbaToHTMLrgba_(backgroundColor);
  634.     }
  636.     const border = TtmlTextParser.getStyleAttribute_(
  637.         cueElement, region, styles, 'border', shouldInheritRegionStyles);
  638.     if (border) {
  639.       cue.border = border;
  640.     }
  642.     const fontFamily = TtmlTextParser.getStyleAttribute_(
  643.         cueElement, region, styles, 'fontFamily', shouldInheritRegionStyles);
  644.     // See https://github.com/sandflow/imscJS/blob/1.1.3/src/main/js/html.js#L1384
  645.     if (fontFamily) {
  646.       switch (fontFamily) {
  647.         case 'monospaceSerif':
  648.           cue.fontFamily = 'Courier New,Liberation Mono,Courier,monospace';
  649.           break;
  650.         case 'proportionalSansSerif':
  651.           cue.fontFamily = 'Arial,Helvetica,Liberation Sans,sans-serif';
  652.           break;
  653.         case 'sansSerif':
  654.           cue.fontFamily = 'sans-serif';
  655.           break;
  656.         case 'monospaceSansSerif':
  657.           cue.fontFamily = 'Consolas,monospace';
  658.           break;
  659.         case 'proportionalSerif':
  660.           cue.fontFamily = 'serif';
  661.           break;
  662.         default:
  663.           cue.fontFamily = fontFamily.split(',').filter((font) => {
  664.             return font != 'default';
  665.           }).join(',');
  666.           break;
  667.       }
  668.     }
  670.     const fontWeight = TtmlTextParser.getStyleAttribute_(
  671.         cueElement, region, styles, 'fontWeight', shouldInheritRegionStyles);
  672.     if (fontWeight && fontWeight == 'bold') {
  673.       cue.fontWeight = Cue.fontWeight.BOLD;
  674.     }
  676.     const wrapOption = TtmlTextParser.getStyleAttribute_(
  677.         cueElement, region, styles, 'wrapOption', shouldInheritRegionStyles);
  678.     if (wrapOption && wrapOption == 'noWrap') {
  679.       cue.wrapLine = false;
  680.     } else {
  681.       cue.wrapLine = true;
  682.     }
  684.     const lineHeight = TtmlTextParser.getStyleAttribute_(
  685.         cueElement, region, styles, 'lineHeight', shouldInheritRegionStyles);
  686.     if (lineHeight && lineHeight.match(TtmlTextParser.unitValues_)) {
  687.       cue.lineHeight = lineHeight;
  688.     }
  690.     const fontSize = TtmlTextParser.getStyleAttribute_(
  691.         cueElement, region, styles, 'fontSize', shouldInheritRegionStyles);
  692.     if (fontSize) {
  693.       const isValidFontSizeUnit =
  694.           fontSize.match(TtmlTextParser.unitValues_) ||
  695.           fontSize.match(TtmlTextParser.percentValue_);
  697.       if (isValidFontSizeUnit) {
  698.         cue.fontSize = fontSize;
  699.       }
  700.     }
  702.     const fontStyle = TtmlTextParser.getStyleAttribute_(
  703.         cueElement, region, styles, 'fontStyle', shouldInheritRegionStyles);
  704.     if (fontStyle) {
  705.       goog.asserts.assert(fontStyle.toUpperCase() in Cue.fontStyle,
  706.           fontStyle.toUpperCase() +
  707.                           ' Should be in Cue.fontStyle values!');
  708.       cue.fontStyle = Cue.fontStyle[fontStyle.toUpperCase()];
  709.     }
  711.     if (imageElement) {
  712.       // According to the spec, we should use imageType (camelCase), but
  713.       // historically we have checked for imagetype (lowercase).
  714.       // This was the case since background image support was first introduced
  715.       // in PR #1859, in April 2019, and first released in v2.5.0.
  716.       // Now we check for both, although only imageType (camelCase) is to spec.
  717.       const backgroundImageType =
  718.           imageElement.attributes['imageType'] ||
  719.           imageElement.attributes['imagetype'];
  720.       const backgroundImageEncoding = imageElement.attributes['encoding'];
  721.       const backgroundImageData = (TXml.getTextContents(imageElement)).trim();
  722.       if (backgroundImageType == 'PNG' &&
  723.           backgroundImageEncoding == 'Base64' &&
  724.           backgroundImageData) {
  725.         cue.backgroundImage = 'data:image/png;base64,' + backgroundImageData;
  726.       }
  727.     } else if (imageUri) {
  728.       cue.backgroundImage = imageUri;
  729.     }
  731.     const textOutline = TtmlTextParser.getStyleAttribute_(
  732.         cueElement, region, styles, 'textOutline', shouldInheritRegionStyles);
  733.     if (textOutline) {
  734.       // tts:textOutline isn't natively supported by browsers, but it can be
  735.       // mostly replicated using the non-standard -webkit-text-stroke-width and
  736.       // -webkit-text-stroke-color properties.
  737.       const split = textOutline.split(' ');
  738.       if (split[0].match(TtmlTextParser.unitValues_)) {
  739.         // There is no defined color, so default to the text color.
  740.         cue.textStrokeColor = cue.color;
  741.       } else {
  742.         cue.textStrokeColor =
  743.             TtmlTextParser.convertTTMLrgbaToHTMLrgba_(split[0]);
  744.         split.shift();
  745.       }
  746.       if (split[0] && split[0].match(TtmlTextParser.unitValues_)) {
  747.         cue.textStrokeWidth = split[0];
  748.       } else {
  749.         // If there is no width, or the width is not a number, don't draw a
  750.         // border.
  751.         cue.textStrokeColor = '';
  752.       }
  753.       // There is an optional blur radius also, but we have no way of
  754.       // replicating that, so ignore it.
  755.     }
  757.     const letterSpacing = TtmlTextParser.getStyleAttribute_(
  758.         cueElement, region, styles, 'letterSpacing', shouldInheritRegionStyles);
  759.     if (letterSpacing && letterSpacing.match(TtmlTextParser.unitValues_)) {
  760.       cue.letterSpacing = letterSpacing;
  761.     }
  763.     const linePadding = TtmlTextParser.getStyleAttribute_(
  764.         cueElement, region, styles, 'linePadding', shouldInheritRegionStyles);
  765.     if (linePadding && linePadding.match(TtmlTextParser.unitValues_)) {
  766.       cue.linePadding = linePadding;
  767.     }
  769.     const opacity = TtmlTextParser.getStyleAttribute_(
  770.         cueElement, region, styles, 'opacity', shouldInheritRegionStyles);
  771.     if (opacity) {
  772.       cue.opacity = parseFloat(opacity);
  773.     }
  775.     // Text decoration is an array of values which can come both from the
  776.     // element's style or be inherited from elements' parent nodes. All of those
  777.     // values should be applied as long as they don't contradict each other. If
  778.     // they do, elements' own style gets preference.
  779.     const textDecorationRegion = TtmlTextParser.getStyleAttributeFromRegion_(
  780.         region, styles, 'textDecoration');
  781.     if (textDecorationRegion) {
  782.       TtmlTextParser.addTextDecoration_(cue, textDecorationRegion);
  783.     }
  785.     const textDecorationElement = TtmlTextParser.getStyleAttributeFromElement_(
  786.         cueElement, styles, 'textDecoration');
  787.     if (textDecorationElement) {
  788.       TtmlTextParser.addTextDecoration_(cue, textDecorationElement);
  789.     }
  791.     const textCombine = TtmlTextParser.getStyleAttribute_(
  792.         cueElement, region, styles, 'textCombine', shouldInheritRegionStyles);
  793.     if (textCombine) {
  794.       cue.textCombineUpright = textCombine;
  795.     }
  797.     const ruby = TtmlTextParser.getStyleAttribute_(
  798.         cueElement, region, styles, 'ruby', shouldInheritRegionStyles);
  799.     switch (ruby) {
  800.       case 'container':
  801.         cue.rubyTag = 'ruby';
  802.         break;
  803.       case 'text':
  804.         cue.rubyTag = 'rt';
  805.         break;
  806.     }
  807.   }
  809.   /**
  810.    * Parses text decoration values and adds/removes them to/from the cue.
  811.    *
  812.    * @param {!shaka.text.Cue} cue
  813.    * @param {string} decoration
  814.    * @private
  815.    */
  816.   static addTextDecoration_(cue, decoration) {
  817.     const Cue = shaka.text.Cue;
  818.     for (const value of decoration.split(' ')) {
  819.       switch (value) {
  820.         case 'underline':
  821.           if (!cue.textDecoration.includes(Cue.textDecoration.UNDERLINE)) {
  822.             cue.textDecoration.push(Cue.textDecoration.UNDERLINE);
  823.           }
  824.           break;
  825.         case 'noUnderline':
  826.           if (cue.textDecoration.includes(Cue.textDecoration.UNDERLINE)) {
  827.             shaka.util.ArrayUtils.remove(cue.textDecoration,
  828.                 Cue.textDecoration.UNDERLINE);
  829.           }
  830.           break;
  831.         case 'lineThrough':
  832.           if (!cue.textDecoration.includes(Cue.textDecoration.LINE_THROUGH)) {
  833.             cue.textDecoration.push(Cue.textDecoration.LINE_THROUGH);
  834.           }
  835.           break;
  836.         case 'noLineThrough':
  837.           if (cue.textDecoration.includes(Cue.textDecoration.LINE_THROUGH)) {
  838.             shaka.util.ArrayUtils.remove(cue.textDecoration,
  839.                 Cue.textDecoration.LINE_THROUGH);
  840.           }
  841.           break;
  842.         case 'overline':
  843.           if (!cue.textDecoration.includes(Cue.textDecoration.OVERLINE)) {
  844.             cue.textDecoration.push(Cue.textDecoration.OVERLINE);
  845.           }
  846.           break;
  847.         case 'noOverline':
  848.           if (cue.textDecoration.includes(Cue.textDecoration.OVERLINE)) {
  849.             shaka.util.ArrayUtils.remove(cue.textDecoration,
  850.                 Cue.textDecoration.OVERLINE);
  851.           }
  852.           break;
  853.       }
  854.     }
  855.   }
  857.   /**
  858.    * Finds a specified attribute on either the original cue element or its
  859.    * associated region and returns the value if the attribute was found.
  860.    *
  861.    * @param {!shaka.extern.xml.Node} cueElement
  862.    * @param {shaka.extern.xml.Node} region
  863.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  864.    * @param {string} attribute
  865.    * @param {boolean=} shouldInheritRegionStyles
  866.    * @return {?string}
  867.    * @private
  868.    */
  869.   static getStyleAttribute_(cueElement, region, styles, attribute,
  870.       shouldInheritRegionStyles=true) {
  871.     // An attribute can be specified on region level or in a styling block
  872.     // associated with the region or original element.
  873.     const TtmlTextParser = shaka.text.TtmlTextParser;
  874.     const attr = TtmlTextParser.getStyleAttributeFromElement_(
  875.         cueElement, styles, attribute);
  876.     if (attr) {
  877.       return attr;
  878.     }
  880.     if (shouldInheritRegionStyles) {
  881.       return TtmlTextParser.getStyleAttributeFromRegion_(
  882.           region, styles, attribute);
  883.     }
  884.     return null;
  885.   }
  887.   /**
  888.    * Finds a specified attribute on the element's associated region
  889.    * and returns the value if the attribute was found.
  890.    *
  891.    * @param {shaka.extern.xml.Node} region
  892.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  893.    * @param {string} attribute
  894.    * @return {?string}
  895.    * @private
  896.    */
  897.   static getStyleAttributeFromRegion_(region, styles, attribute) {
  898.     const TXml = shaka.util.TXml;
  899.     const ttsNs = shaka.text.TtmlTextParser.styleNs_;
  901.     if (!region) {
  902.       return null;
  903.     }
  905.     const attr = TXml.getAttributeNSList(region, ttsNs, attribute);
  906.     if (attr) {
  907.       return attr;
  908.     }
  910.     return shaka.text.TtmlTextParser.getInheritedStyleAttribute_(
  911.         region, styles, attribute);
  912.   }
  914.   /**
  915.    * Finds a specified attribute on the cue element and returns the value
  916.    * if the attribute was found.
  917.    *
  918.    * @param {!shaka.extern.xml.Node} cueElement
  919.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  920.    * @param {string} attribute
  921.    * @return {?string}
  922.    * @private
  923.    */
  924.   static getStyleAttributeFromElement_(cueElement, styles, attribute) {
  925.     const TXml = shaka.util.TXml;
  926.     const ttsNs = shaka.text.TtmlTextParser.styleNs_;
  928.     // Styling on elements should take precedence
  929.     // over the main styling attributes
  930.     const elementAttribute = TXml.getAttributeNSList(
  931.         cueElement,
  932.         ttsNs,
  933.         attribute);
  935.     if (elementAttribute) {
  936.       return elementAttribute;
  937.     }
  938.     return shaka.text.TtmlTextParser.getInheritedStyleAttribute_(
  939.         cueElement, styles, attribute);
  940.   }
  942.   /**
  943.    * Finds a specified attribute on an element's styles and the styles those
  944.    * styles inherit from.
  945.    *
  946.    * @param {!shaka.extern.xml.Node} element
  947.    * @param {!Array.<!shaka.extern.xml.Node>} styles
  948.    * @param {string} attribute
  949.    * @return {?string}
  950.    * @private
  951.    */
  952.   static getInheritedStyleAttribute_(element, styles, attribute) {
  953.     const TXml = shaka.util.TXml;
  954.     const ttsNs = shaka.text.TtmlTextParser.styleNs_;
  955.     const ebuttsNs = shaka.text.TtmlTextParser.styleEbuttsNs_;
  957.     const inheritedStyles =
  958.         shaka.text.TtmlTextParser.getElementsFromCollection_(
  959.             element, 'style', styles, /* prefix= */ '');
  961.     let styleValue = null;
  963.     // The last value in our styles stack takes the precedence over the others
  964.     for (let i = 0; i < inheritedStyles.length; i++) {
  965.       // Check ebu namespace first.
  966.       let styleAttributeValue = TXml.getAttributeNS(
  967.           inheritedStyles[i],
  968.           ebuttsNs,
  969.           attribute);
  971.       if (!styleAttributeValue) {
  972.         // Fall back to tts namespace.
  973.         styleAttributeValue = TXml.getAttributeNSList(
  974.             inheritedStyles[i],
  975.             ttsNs,
  976.             attribute);
  977.       }
  979.       if (!styleAttributeValue) {
  980.         // Next, check inheritance.
  981.         // Styles can inherit from other styles, so traverse up that chain.
  982.         styleAttributeValue =
  983.             shaka.text.TtmlTextParser.getStyleAttributeFromElement_(
  984.                 inheritedStyles[i], styles, attribute);
  985.       }
  987.       if (styleAttributeValue) {
  988.         styleValue = styleAttributeValue;
  989.       }
  990.     }
  992.     return styleValue;
  993.   }
  996.   /**
  997.    * Selects items from |collection| whose id matches |attributeName|
  998.    * from |element|.
  999.    *
  1000.    * @param {shaka.extern.xml.Node} element
  1001.    * @param {string} attributeName
  1002.    * @param {!Array.<shaka.extern.xml.Node>} collection
  1003.    * @param {string} prefixName
  1004.    * @param {string=} nsName
  1005.    * @return {!Array.<!shaka.extern.xml.Node>}
  1006.    * @private
  1007.    */
  1008.   static getElementsFromCollection_(
  1009.       element, attributeName, collection, prefixName, nsName) {
  1010.     const items = [];
  1012.     if (!element || collection.length < 1) {
  1013.       return items;
  1014.     }
  1016.     const attributeValue = shaka.text.TtmlTextParser.getInheritedAttribute_(
  1017.         element, attributeName, nsName);
  1019.     if (attributeValue) {
  1020.       // There could be multiple items in one attribute
  1021.       // <span style="style1 style2">A cue</span>
  1022.       const itemNames = attributeValue.split(' ');
  1024.       for (const name of itemNames) {
  1025.         for (const item of collection) {
  1026.           if ((prefixName + item.attributes['xml:id']) == name) {
  1027.             items.push(item);
  1028.             break;
  1029.           }
  1030.         }
  1031.       }
  1032.     }
  1034.     return items;
  1035.   }
  1038.   /**
  1039.    * Traverses upwards from a given node until a given attribute is found.
  1040.    *
  1041.    * @param {!shaka.extern.xml.Node} element
  1042.    * @param {string} attributeName
  1043.    * @param {string=} nsName
  1044.    * @return {?string}
  1045.    * @private
  1046.    */
  1047.   static getInheritedAttribute_(element, attributeName, nsName) {
  1048.     let ret = null;
  1049.     const TXml = shaka.util.TXml;
  1050.     while (!ret) {
  1051.       ret = nsName ?
  1052.           TXml.getAttributeNS(element, nsName, attributeName) :
  1053.           element.attributes[attributeName];
  1054.       if (ret) {
  1055.         break;
  1056.       }
  1058.       // Element.parentNode can lead to XMLDocument, which is not an Element and
  1059.       // has no getAttribute().
  1060.       const parentNode = element.parent;
  1061.       if (parentNode) {
  1062.         element = parentNode;
  1063.       } else {
  1064.         break;
  1065.       }
  1066.     }
  1067.     return ret;
  1068.   }
  1070.   /**
  1071.    * Factor parent/ancestor time attributes into the parsed time of a
  1072.    * child/descendent.
  1073.    *
  1074.    * @param {!shaka.extern.xml.Node} parentElement
  1075.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  1076.    * @param {?number} start The child's start time
  1077.    * @param {?number} end The child's end time
  1078.    * @return {{start: ?number, end: ?number}}
  1079.    * @private
  1080.    */
  1081.   static resolveTime_(parentElement, rateInfo, start, end) {
  1082.     const parentTime = shaka.text.TtmlTextParser.parseTime_(
  1083.         parentElement, rateInfo);
  1085.     if (start == null) {
  1086.       // No start time of your own?  Inherit from the parent.
  1087.       start = parentTime.start;
  1088.     } else {
  1089.       // Otherwise, the start time is relative to the parent's start time.
  1090.       if (parentTime.start != null) {
  1091.         start += parentTime.start;
  1092.       }
  1093.     }
  1095.     if (end == null) {
  1096.       // No end time of your own?  Inherit from the parent.
  1097.       end = parentTime.end;
  1098.     } else {
  1099.       // Otherwise, the end time is relative to the parent's _start_ time.
  1100.       // This is not a typo.  Both times are relative to the parent's _start_.
  1101.       if (parentTime.start != null) {
  1102.         end += parentTime.start;
  1103.       }
  1104.     }
  1106.     return {start, end};
  1107.   }
  1109.   /**
  1110.    * Parse TTML time attributes from the given element.
  1111.    *
  1112.    * @param {!shaka.extern.xml.Node} element
  1113.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  1114.    * @return {{start: ?number, end: ?number}}
  1115.    * @private
  1116.    */
  1117.   static parseTime_(element, rateInfo) {
  1118.     const start = shaka.text.TtmlTextParser.parseTimeAttribute_(
  1119.         element.attributes['begin'], rateInfo);
  1120.     let end = shaka.text.TtmlTextParser.parseTimeAttribute_(
  1121.         element.attributes['end'], rateInfo);
  1122.     const duration = shaka.text.TtmlTextParser.parseTimeAttribute_(
  1123.         element.attributes['dur'], rateInfo);
  1124.     if (end == null && duration != null) {
  1125.       end = start + duration;
  1126.     }
  1127.     return {start, end};
  1128.   }
  1130.   /**
  1131.    * Parses a TTML time from the given attribute text.
  1132.    *
  1133.    * @param {string} text
  1134.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  1135.    * @return {?number}
  1136.    * @private
  1137.    */
  1138.   static parseTimeAttribute_(text, rateInfo) {
  1139.     let ret = null;
  1140.     const TtmlTextParser = shaka.text.TtmlTextParser;
  1142.     if (TtmlTextParser.timeColonFormatFrames_.test(text)) {
  1143.       ret = TtmlTextParser.parseColonTimeWithFrames_(rateInfo, text);
  1144.     } else if (TtmlTextParser.timeColonFormat_.test(text)) {
  1145.       ret = TtmlTextParser.parseTimeFromRegex_(
  1146.           TtmlTextParser.timeColonFormat_, text);
  1147.     } else if (TtmlTextParser.timeColonFormatMilliseconds_.test(text)) {
  1148.       ret = TtmlTextParser.parseTimeFromRegex_(
  1149.           TtmlTextParser.timeColonFormatMilliseconds_, text);
  1150.     } else if (TtmlTextParser.timeFramesFormat_.test(text)) {
  1151.       ret = TtmlTextParser.parseFramesTime_(rateInfo, text);
  1152.     } else if (TtmlTextParser.timeTickFormat_.test(text)) {
  1153.       ret = TtmlTextParser.parseTickTime_(rateInfo, text);
  1154.     } else if (TtmlTextParser.timeHMSFormat_.test(text)) {
  1155.       ret = TtmlTextParser.parseTimeFromRegex_(
  1156.           TtmlTextParser.timeHMSFormat_, text);
  1157.     } else if (text) {
  1158.       // It's not empty or null, but it doesn't match a known format.
  1159.       throw new shaka.util.Error(
  1160.           shaka.util.Error.Severity.CRITICAL,
  1161.           shaka.util.Error.Category.TEXT,
  1162.           shaka.util.Error.Code.INVALID_TEXT_CUE,
  1163.           'Could not parse cue time range in TTML');
  1164.     }
  1166.     return ret;
  1167.   }
  1169.   /**
  1170.    * Parses a TTML time in frame format.
  1171.    *
  1172.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  1173.    * @param {string} text
  1174.    * @return {?number}
  1175.    * @private
  1176.    */
  1177.   static parseFramesTime_(rateInfo, text) {
  1178.     // 75f or 75.5f
  1179.     const results = shaka.text.TtmlTextParser.timeFramesFormat_.exec(text);
  1180.     const frames = Number(results[1]);
  1182.     return frames / rateInfo.frameRate;
  1183.   }
  1185.   /**
  1186.    * Parses a TTML time in tick format.
  1187.    *
  1188.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  1189.    * @param {string} text
  1190.    * @return {?number}
  1191.    * @private
  1192.    */
  1193.   static parseTickTime_(rateInfo, text) {
  1194.     // 50t or 50.5t
  1195.     const results = shaka.text.TtmlTextParser.timeTickFormat_.exec(text);
  1196.     const ticks = Number(results[1]);
  1198.     return ticks / rateInfo.tickRate;
  1199.   }
  1201.   /**
  1202.    * Parses a TTML colon formatted time containing frames.
  1203.    *
  1204.    * @param {!shaka.text.TtmlTextParser.RateInfo_} rateInfo
  1205.    * @param {string} text
  1206.    * @return {?number}
  1207.    * @private
  1208.    */
  1209.   static parseColonTimeWithFrames_(rateInfo, text) {
  1210.     // 01:02:43:07 ('07' is frames) or 01:02:43:07.1 (subframes)
  1211.     const results = shaka.text.TtmlTextParser.timeColonFormatFrames_.exec(text);
  1213.     const hours = Number(results[1]);
  1214.     const minutes = Number(results[2]);
  1215.     let seconds = Number(results[3]);
  1216.     let frames = Number(results[4]);
  1217.     const subframes = Number(results[5]) || 0;
  1219.     frames += subframes / rateInfo.subFrameRate;
  1220.     seconds += frames / rateInfo.frameRate;
  1222.     return seconds + (minutes * 60) + (hours * 3600);
  1223.   }
  1225.   /**
  1226.    * Parses a TTML time with a given regex. Expects regex to be some
  1227.    * sort of a time-matcher to match hours, minutes, seconds and milliseconds
  1228.    *
  1229.    * @param {!RegExp} regex
  1230.    * @param {string} text
  1231.    * @return {?number}
  1232.    * @private
  1233.    */
  1234.   static parseTimeFromRegex_(regex, text) {
  1235.     const results = regex.exec(text);
  1236.     if (results == null || results[0] == '') {
  1237.       return null;
  1238.     }
  1239.     // This capture is optional, but will still be in the array as undefined,
  1240.     // in which case it is 0.
  1241.     const hours = Number(results[1]) || 0;
  1242.     const minutes = Number(results[2]) || 0;
  1243.     const seconds = Number(results[3]) || 0;
  1244.     const milliseconds = Number(results[4]) || 0;
  1246.     return (milliseconds / 1000) + seconds + (minutes * 60) + (hours * 3600);
  1247.   }
  1249.   /**
  1250.    * If ttp:cellResolution provided returns cell resolution info
  1251.    * with number of columns and rows into which the Root Container
  1252.    * Region area is divided
  1253.    *
  1254.    * @param {?string} cellResolution
  1255.    * @return {?{columns: number, rows: number}}
  1256.    * @private
  1257.    */
  1258.   static getCellResolution_(cellResolution) {
  1259.     if (!cellResolution) {
  1260.       return null;
  1261.     }
  1262.     const matches = /^(\d+) (\d+)$/.exec(cellResolution);
  1264.     if (!matches) {
  1265.       return null;
  1266.     }
  1268.     const columns = parseInt(matches[1], 10);
  1269.     const rows = parseInt(matches[2], 10);
  1271.     return {columns, rows};
  1272.   }
  1273. };
  1275. /**
  1276.  * @summary
  1277.  * Contains information about frame/subframe rate
  1278.  * and frame rate multiplier for time in frame format.
  1279.  *
  1280.  * @example 01:02:03:04(4 frames) or 01:02:03:04.1(4 frames, 1 subframe)
  1281.  * @private
  1282.  */
  1283. shaka.text.TtmlTextParser.RateInfo_ = class {
  1284.   /**
  1285.    * @param {?string} frameRate
  1286.    * @param {?string} subFrameRate
  1287.    * @param {?string} frameRateMultiplier
  1288.    * @param {?string} tickRate
  1289.    */
  1290.   constructor(frameRate, subFrameRate, frameRateMultiplier, tickRate) {
  1291.     /**
  1292.      * @type {number}
  1293.      */
  1294.     this.frameRate = Number(frameRate) || 30;
  1296.     /**
  1297.      * @type {number}
  1298.      */
  1299.     this.subFrameRate = Number(subFrameRate) || 1;
  1301.     /**
  1302.      * @type {number}
  1303.      */
  1304.     this.tickRate = Number(tickRate);
  1305.     if (this.tickRate == 0) {
  1306.       if (frameRate) {
  1307.         this.tickRate = this.frameRate * this.subFrameRate;
  1308.       } else {
  1309.         this.tickRate = 1;
  1310.       }
  1311.     }
  1313.     if (frameRateMultiplier) {
  1314.       const multiplierResults = /^(\d+) (\d+)$/g.exec(frameRateMultiplier);
  1315.       if (multiplierResults) {
  1316.         const numerator = Number(multiplierResults[1]);
  1317.         const denominator = Number(multiplierResults[2]);
  1318.         const multiplierNum = numerator / denominator;
  1319.         this.frameRate *= multiplierNum;
  1320.       }
  1321.     }
  1322.   }
  1323. };
  1325. /**
  1326.  * @const
  1327.  * @private {!RegExp}
  1328.  * @example 50.17% 10%
  1329.  */
  1330. shaka.text.TtmlTextParser.percentValues_ =
  1331.     /^(\d{1,2}(?:\.\d+)?|100(?:\.0+)?)% (\d{1,2}(?:\.\d+)?|100(?:\.0+)?)%$/;
  1333. /**
  1334.  * @const
  1335.  * @private {!RegExp}
  1336.  * @example 0.6% 90% 300% 1000%
  1337.  */
  1338. shaka.text.TtmlTextParser.percentValue_ = /^(\d{1,4}(?:\.\d+)?|100)%$/;
  1340. /**
  1341.  * @const
  1342.  * @private {!RegExp}
  1343.  * @example 100px, 8em, 0.80c
  1344.  */
  1345. shaka.text.TtmlTextParser.unitValues_ = /^(\d+px|\d+em|\d*\.?\d+c)$/;
  1347. /**
  1348.  * @const
  1349.  * @private {!RegExp}
  1350.  * @example 100px
  1351.  */
  1352. shaka.text.TtmlTextParser.pixelValues_ = /^(\d+)px (\d+)px$/;
  1354. /**
  1355.  * @const
  1356.  * @private {!RegExp}
  1357.  * @example 00:00:40:07 (7 frames) or 00:00:40:07.1 (7 frames, 1 subframe)
  1358.  */
  1359. shaka.text.TtmlTextParser.timeColonFormatFrames_ =
  1360.     /^(\d{2,}):(\d{2}):(\d{2}):(\d{2})\.?(\d+)?$/;
  1362. /**
  1363.  * @const
  1364.  * @private {!RegExp}
  1365.  * @example 00:00:40 or 00:40
  1366.  */
  1367. shaka.text.TtmlTextParser.timeColonFormat_ = /^(?:(\d{2,}):)?(\d{2}):(\d{2})$/;
  1369. /**
  1370.  * @const
  1371.  * @private {!RegExp}
  1372.  * @example 01:02:43.0345555 or 02:43.03 or 02:45.5
  1373.  */
  1374. shaka.text.TtmlTextParser.timeColonFormatMilliseconds_ =
  1375.     /^(?:(\d{2,}):)?(\d{2}):(\d{2}\.\d+)$/;
  1377. /**
  1378.  * @const
  1379.  * @private {!RegExp}
  1380.  * @example 75f or 75.5f
  1381.  */
  1382. shaka.text.TtmlTextParser.timeFramesFormat_ = /^(\d*(?:\.\d*)?)f$/;
  1384. /**
  1385.  * @const
  1386.  * @private {!RegExp}
  1387.  * @example 50t or 50.5t
  1388.  */
  1389. shaka.text.TtmlTextParser.timeTickFormat_ = /^(\d*(?:\.\d*)?)t$/;
  1391. /**
  1392.  * @const
  1393.  * @private {!RegExp}
  1394.  * @example 3.45h, 3m or 4.20s
  1395.  */
  1396. shaka.text.TtmlTextParser.timeHMSFormat_ =
  1397.     new RegExp(['^(?:(\\d*(?:\\.\\d*)?)h)?',
  1398.       '(?:(\\d*(?:\\.\\d*)?)m)?',
  1399.       '(?:(\\d*(?:\\.\\d*)?)s)?',
  1400.       '(?:(\\d*(?:\\.\\d*)?)ms)?$'].join(''));
  1402. /**
  1403.  * @const
  1404.  * @private {!Object.<string, shaka.text.Cue.lineAlign>}
  1405.  */
  1406. shaka.text.TtmlTextParser.textAlignToLineAlign_ = {
  1407.   'left': shaka.text.Cue.lineAlign.START,
  1408.   'center': shaka.text.Cue.lineAlign.CENTER,
  1409.   'right': shaka.text.Cue.lineAlign.END,
  1410.   'start': shaka.text.Cue.lineAlign.START,
  1411.   'end': shaka.text.Cue.lineAlign.END,
  1412. };
  1414. /**
  1415.  * @const
  1416.  * @private {!Object.<string, shaka.text.Cue.positionAlign>}
  1417.  */
  1418. shaka.text.TtmlTextParser.textAlignToPositionAlign_ = {
  1419.   'left': shaka.text.Cue.positionAlign.LEFT,
  1420.   'center': shaka.text.Cue.positionAlign.CENTER,
  1421.   'right': shaka.text.Cue.positionAlign.RIGHT,
  1422. };
  1424. /**
  1425.  * The namespace URL for TTML parameters.  Can be assigned any name in the TTML
  1426.  * document, not just "ttp:", so we use this with getAttributeNS() to ensure
  1427.  * that we support arbitrary namespace names.
  1428.  *
  1429.  * @const {!Array.<string>}
  1430.  * @private
  1431.  */
  1432. shaka.text.TtmlTextParser.parameterNs_ = [
  1433.   'http://www.w3.org/ns/ttml#parameter',
  1434.   'http://www.w3.org/2006/10/ttaf1#parameter',
  1435. ];
  1437. /**
  1438.  * The namespace URL for TTML styles.  Can be assigned any name in the TTML
  1439.  * document, not just "tts:", so we use this with getAttributeNS() to ensure
  1440.  * that we support arbitrary namespace names.
  1441.  *
  1442.  * @const {!Array.<string>}
  1443.  * @private
  1444.  */
  1445. shaka.text.TtmlTextParser.styleNs_ = [
  1446.   'http://www.w3.org/ns/ttml#styling',
  1447.   'http://www.w3.org/2006/10/ttaf1#styling',
  1448. ];
  1450. /**
  1451.  * The namespace URL for EBU TTML styles.  Can be assigned any name in the TTML
  1452.  * document, not just "ebutts:", so we use this with getAttributeNS() to ensure
  1453.  * that we support arbitrary namespace names.
  1454.  *
  1455.  * @const {string}
  1456.  * @private
  1457.  */
  1458. shaka.text.TtmlTextParser.styleEbuttsNs_ = 'urn:ebu:tt:style';
  1460. /**
  1461.  * The supported namespace URLs for SMPTE fields.
  1462.  * @const {!Array.<string>}
  1463.  * @private
  1464.  */
  1465. shaka.text.TtmlTextParser.smpteNsList_ = [
  1466.   'http://www.smpte-ra.org/schemas/2052-1/2010/smpte-tt',
  1467.   'http://www.smpte-ra.org/schemas/2052-1/2013/smpte-tt',
  1468. ];
  1470. shaka.text.TextEngine.registerParser(
  1471.     'application/ttml+xml', () => new shaka.text.TtmlTextParser());