rx-player 3.33.0 → 3.33.1

package/src/parsers/texttracks/ttml/parse_ttml.ts

@@ -1,206 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import arrayFind from "../../../utils/array_find";
-import isNonEmptyString from "../../../utils/is_non_empty_string";
-import objectAssign from "../../../utils/object_assign";
-import getParameters, { ITTParameters } from "./get_parameters";
-import {
-  getStylingAttributes,
-  getStylingFromElement,
-  IStyleObject,
-} from "./get_styling";
-import resolveStylesInheritance from "./resolve_styles_inheritance";
-import {
-  getParentDivElements,
-  getBodyNode,
-  getRegionNodes,
-  getStyleNodes,
-  getTextNodes,
-} from "./xml_utils";
-
-const STYLE_ATTRIBUTES = [ "align",
-                           "backgroundColor",
-                           "color",
-                           "direction",
-                           "display",
-                           "displayAlign",
-                           "extent",
-                           "fontFamily",
-                           "fontSize",
-                           "fontStyle",
-                           "fontWeight",
-                           "lineHeight",
-                           "opacity",
-                           "origin",
-                           "overflow",
-                           "padding",
-                           "textAlign",
-                           "textDecoration",
-                           "textOutline",
-                           "unicodeBidi",
-                           "visibility",
-                           "wrapOption",
-                           "writingMode",
-
-                           // Not managed anywhere for now
-                           // "showBackground",
-                           // "zIndex",
-];
-
-export interface IParsedTTMLCue { /** The DOM Element that contains text node */
-                                  paragraph: Element;
-                                  /** An offset to apply to cues start and end */
-                                  timeOffset: number;
-                                  /** An array of objects containing TTML styles */
-                                  idStyles: IStyleObject[];
-                                  /** An array of objects containing region TTML style */
-                                  regionStyles: IStyleObject[];
-                                  /** An object containing paragraph style */
-                                  paragraphStyle: Partial<Record<string, string>>;
-                                  /** An object containing TTML parameters */
-                                  ttParams: ITTParameters;
-                                  shouldTrimWhiteSpace: boolean;
-                                  /** TTML body as a DOM Element */
-                                  body: Element | null; }
-
-/**
- * Create array of objects which should represent the given TTML text track.
- * TODO TTML parsing is still pretty heavy on the CPU.
- * Optimizations have been done, principally to avoid using too much XML APIs,
- * but we can still do better.
- * @param {string} str
- * @param {Number} timeOffset
- * @returns {Array.<Object>}
- */
-export default function parseTTMLString(
-  str : string,
-  timeOffset : number
-) : IParsedTTMLCue[] {
-  const cues : IParsedTTMLCue[] = [];
-  const xml = new DOMParser().parseFromString(str, "text/xml");
-
-  if (xml !== null && xml !== undefined) {
-    const tts = xml.getElementsByTagName("tt");
-    let tt: Element = tts[0];
-    if (tt === undefined) {
-      // EBU-TT sometimes namespaces tt, by "tt:"
-      // Just catch all namespaces to play it safe
-      const namespacedTT = xml.getElementsByTagNameNS("*", "tt");
-      tt = namespacedTT[0];
-      if (tt === undefined) {
-        throw new Error("invalid XML");
-      }
-    }
-
-    const body = getBodyNode(tt);
-    const styleNodes = getStyleNodes(tt);
-    const regionNodes = getRegionNodes(tt);
-    const paragraphNodes = getTextNodes(tt);
-    const ttParams = getParameters(tt);
-
-    // construct idStyles array based on the xml as an optimization
-    const idStyles : IStyleObject[]  = [];
-    for (let i = 0; i <= styleNodes.length - 1; i++) {
-      const styleNode = styleNodes[i];
-      if (styleNode instanceof Element) {
-        const styleID = styleNode.getAttribute("xml:id");
-        if (styleID !== null) {
-          const subStyles = styleNode.getAttribute("style");
-          const extendsStyles = subStyles === null ? [] :
-                                                     subStyles.split(" ");
-          idStyles.push({ id: styleID,
-                          style: getStylingFromElement(styleNode),
-                          extendsStyles });
-        }
-      }
-    }
-
-    resolveStylesInheritance(idStyles);
-
-    // construct regionStyles array based on the xml as an optimization
-    const regionStyles : IStyleObject[] = [];
-    for (let i = 0; i <= regionNodes.length - 1; i++) {
-      const regionNode = regionNodes[i];
-      if (regionNode instanceof Element) {
-        const regionID = regionNode.getAttribute("xml:id");
-        if (regionID !== null) {
-          let regionStyle = getStylingFromElement(regionNode);
-          const associatedStyleID = regionNode.getAttribute("style");
-          if (isNonEmptyString(associatedStyleID)) {
-            const style = arrayFind(idStyles, (x) => x.id === associatedStyleID);
-            if (style !== undefined) {
-              regionStyle = objectAssign({}, style.style, regionStyle);
-            }
-          }
-          regionStyles.push({ id: regionID,
-                              style: regionStyle,
-
-                              // already handled
-                              extendsStyles: [] });
-        }
-      }
-    }
-
-    // Computing the style takes a lot of ressources.
-    // To avoid too much re-computation, let's compute the body style right
-    // now and do the rest progressively.
-
-    // TODO Compute corresponding CSS style here (as soon as we now the TTML
-    // style) to speed up the process even more.
-    const bodyStyle = getStylingAttributes(
-      STYLE_ATTRIBUTES, body !== null ? [body] : [], idStyles, regionStyles);
-
-    const bodySpaceAttribute = body !== null ? body.getAttribute("xml:space") :
-                                               undefined;
-    const shouldTrimWhiteSpaceOnBody = bodySpaceAttribute === "default" ||
-                                       ttParams.spaceStyle === "default";
-
-    for (let i = 0; i < paragraphNodes.length; i++) {
-      const paragraph = paragraphNodes[i];
-      if (paragraph instanceof Element) {
-        const divs = getParentDivElements(paragraph);
-        const paragraphStyle = objectAssign({},
-                                            bodyStyle,
-                                            getStylingAttributes(STYLE_ATTRIBUTES,
-                                                                 [paragraph,
-                                                                  ...divs],
-                                                                 idStyles,
-                                                                 regionStyles));
-
-        const paragraphSpaceAttribute = paragraph.getAttribute("xml:space");
-        const shouldTrimWhiteSpace =
-          isNonEmptyString(paragraphSpaceAttribute) ?
-            paragraphSpaceAttribute === "default" :
-            shouldTrimWhiteSpaceOnBody;
-
-        const cue = { paragraph,
-                      timeOffset,
-                      idStyles,
-                      regionStyles,
-                      body,
-                      paragraphStyle,
-                      ttParams,
-                      shouldTrimWhiteSpace };
-
-        if (cue !== null) {
-          cues.push(cue);
-        }
-      }
-    }
-  }
-  return cues;
-}

package/src/parsers/texttracks/ttml/regexps.ts

@@ -1,65 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// examples: 00:00:40:07 (7 frames) or 00:00:40:07.1 (7 frames, 1 subframe)
-const REGXP_TIME_COLON_FRAMES =
-  /^(\d{2,}):(\d{2}):(\d{2}):(\d{2})\.?(\d+)?$/;
-
-// examples: 00:00:40:07 (7 frames) or 00:00:40:07.1 (7 frames, 1 subframe)
-const REGXP_TIME_COLON = /^(?:(\d{2,}):)?(\d{2}):(\d{2})$/;
-
-// examples: 01:02:43.0345555 or 02:43.03
-const REGXP_TIME_COLON_MS = /^(?:(\d{2,}):)?(\d{2}):(\d{2}\.\d{2,})$/;
-
-// examples: 75f or 75.5f
-const REGXP_TIME_FRAMES = /^(\d*\.?\d*)f$/;
-
-// examples: 50t or 50.5t
-const REGXP_TIME_TICK = /^(\d*\.?\d*)t$/;
-
-// examples: 3.45h, 3m or 4.20s
-const REGXP_TIME_HMS =
-  /^(?:(\d*\.?\d*)h)?(?:(\d*\.?\d*)m)?(?:(\d*\.?\d*)s)?(?:(\d*\.?\d*)ms)?$/;
-
-// examples: 50% 10%
-const REGXP_PERCENT_VALUES = /^(\d{1,2}|100)% (\d{1,2}|100)%$/;
-
-const REGXP_LENGTH = /^((?:\+|\-)?\d*(?:\.\d+)?)(px|em|c|%|rh|rw)$/;
-
-const REGXP_8_HEX_COLOR =
-  /^#([0-9A-f]{2})([0-9A-f]{2})([0-9A-f]{2})([0-9A-f]{2})$/;
-const REGXP_4_HEX_COLOR = /^#([0-9A-f])([0-9A-f])([0-9A-f])([0-9A-f])$/;
-
-const REGXP_RGB_COLOR =
-  /^rgb\( *(\d+) *, *(\d+) *, *(\d+) *\)/;
-
-const REGXP_RGBA_COLOR =
-  /^rgba\( *(\d+) *, *(\d+) *, *(\d+) *, *(\d+) *\)/;
-
-export {
-  REGXP_4_HEX_COLOR,
-  REGXP_8_HEX_COLOR,
-  REGXP_RGB_COLOR,
-  REGXP_RGBA_COLOR,
-  REGXP_LENGTH,
-  REGXP_PERCENT_VALUES,
-  REGXP_TIME_COLON,
-  REGXP_TIME_COLON_FRAMES,
-  REGXP_TIME_COLON_MS,
-  REGXP_TIME_FRAMES,
-  REGXP_TIME_HMS,
-  REGXP_TIME_TICK,
-};

package/src/parsers/texttracks/ttml/resolve_styles_inheritance.ts

@@ -1,84 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import log from "../../../log";
-import arrayFindIndex from "../../../utils/array_find_index";
-import arrayIncludes from "../../../utils/array_includes";
-import objectAssign from "../../../utils/object_assign";
-import { IStyleObject } from "./get_styling";
-
-/**
- * Transform all styles inheriting from other styles to the same styles but with
- * the inheritance removed (by resolving those inheritance here).
- *
- * Note that the original style object is directly mutated with every
- * inheritance they had resolved and removed.
- *
- * To make a pseudo-code analogy this would be equivalent to transform those
- * two classes:
- * ```
- * class A {
- *   methodA() {}
- * }
- *
- * class B extends A {
- *   method B() {}
- * }
- * ```
- * into the same two classes without inheritance:
- * ```
- * class A {
- *   methodA() {}
- * }
- * class B {
- *   methodA() {} // inherited from class A
- *   methodB() {}
- * }
- * ```
- *
- * Doing this here allows to simplify further treatment of those styles.
- * @param {Array.<Object>} styles
- */
-export default function resolveStylesInheritance(
-  styles : IStyleObject[]
-) : void {
-  // keep track of all the indexes parsed to avoid infinite loops
-  const recursivelyBrowsedIndexes : number[] = [];
-  function resolveStyleInheritance(styleElt : IStyleObject, index : number) {
-    recursivelyBrowsedIndexes.push(index);
-    for (let j = 0; j < styleElt.extendsStyles.length; j++) {
-      const extendedStyleID = styleElt.extendsStyles[j];
-      const extendedStyleIndex = arrayFindIndex(styles,
-                                                (x) => x.id === extendedStyleID);
-      if (extendedStyleIndex < 0) {
-        log.warn("TTML Parser: unknown style inheritance: " + extendedStyleID);
-      } else {
-        const extendedStyle = styles[extendedStyleIndex];
-        if (arrayIncludes(recursivelyBrowsedIndexes, extendedStyleIndex)) {
-          log.warn("TTML Parser: infinite style inheritance loop avoided");
-        } else {
-          resolveStyleInheritance(extendedStyle, extendedStyleIndex);
-        }
-        styleElt.style = objectAssign({}, extendedStyle.style, styleElt.style);
-      }
-    }
-    styleElt.extendsStyles.length = 0;
-  }
-  for (let i = 0; i < styles.length; i++) {
-    resolveStyleInheritance(styles[i], i);
-    recursivelyBrowsedIndexes.length = 0; // reset
-  }
-}

package/src/parsers/texttracks/ttml/time_parsing.ts

@@ -1,156 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Parse TTML Time formats to seconds.
- *
- * Largely inspired from what the shaka-player does for TTML time parsing.
- * But rewritten to a more rx-player style.
- */
-
-import { ITTParameters } from "./get_parameters";
-import {
-  REGXP_TIME_COLON,
-  REGXP_TIME_COLON_FRAMES,
-  REGXP_TIME_COLON_MS,
-  REGXP_TIME_FRAMES,
-  REGXP_TIME_HMS,
-  REGXP_TIME_TICK,
-} from "./regexps";
-
-/**
- * Parses a TTML time into seconds.
- * @param {string} text
- * @param {Object} ttParams
- * @returns {Number|undefined}
- */
-function parseTime(
-  text : string,
-  ttParams : ITTParameters
-) : number|undefined|null {
-  if (REGXP_TIME_COLON_FRAMES.test(text)) {
-    return parseColonTimeWithFrames(ttParams, text);
-
-  } else if (REGXP_TIME_COLON.test(text)) {
-    return parseTimeFromRegExp(REGXP_TIME_COLON, text);
-
-  } else if (REGXP_TIME_COLON_MS.test(text)) {
-    return parseTimeFromRegExp(REGXP_TIME_COLON_MS, text);
-
-  } else if (REGXP_TIME_FRAMES.test(text)) {
-    return parseFramesTime(ttParams, text);
-
-  } else if (REGXP_TIME_TICK.test(text)) {
-    return parseTickTime(ttParams, text);
-
-  } else if (REGXP_TIME_HMS.test(text)) {
-    return parseTimeFromRegExp(REGXP_TIME_HMS, text);
-  }
-}
-
-/**
- * Parses a TTML time in frame format
- * @param {Object} ttParams
- * @param {string} text
- * @returns {Number}
- */
-function parseFramesTime(ttParams : ITTParameters, text : string) : number {
-  // 75f or 75.5f
-  // (We cast as we're sure the regexp is respected here)
-  const results = REGXP_TIME_FRAMES.exec(text) as RegExpExecArray;
-  const frames = Number(results[1]);
-  return frames / ttParams.frameRate;
-}
-
-/**
- * Parses a TTML time in tick format
- * @param {Object} ttParams
- * @param {string} text
- * @returns {Number}
- */
-function parseTickTime(ttParams : ITTParameters, text : string) : number {
-  // 50t or 50.5t
-  // (We cast as we're sure the regexp is respected here)
-  const results = REGXP_TIME_TICK.exec(text) as RegExpExecArray;
-  const ticks = Number(results[1]);
-  return ticks / ttParams.tickRate;
-}
-
-/**
- * Parses a TTML colon formatted time containing frames
- * @param {Object} ttParams
- * @param {string} text
- * @returns {Number}
- */
-function parseColonTimeWithFrames(
-  ttParams : ITTParameters,
-  text : string
-) : number {
-  // 01:02:43:07 ("07" is frames) or 01:02:43:07.1 (subframes)
-  // (We cast as we're sure the regexp is respected here)
-  const results = REGXP_TIME_COLON_FRAMES.exec(text) as RegExpExecArray;
-
-  const hours = Number(results[1]);
-  const minutes = Number(results[2]);
-  let seconds = Number(results[3]);
-  let frames = Number(results[4]);
-  let subframes = Number(results[5]);
-  if (isNaN(subframes)) {
-    subframes = 0;
-  }
-
-  frames += subframes / ttParams.subFrameRate;
-  seconds += frames / ttParams.frameRate;
-
-  return seconds + (minutes * 60) + (hours * 3600);
-}
-
-/**
- * Parses a TTML time with a given regex. Expects regex to be some
- * sort of a time-matcher to match hours, minutes, seconds and milliseconds
- *
- * @param {RegExp} regex
- * @param {string} text
- * @returns {number|null}
- */
-function parseTimeFromRegExp(regex : RegExp, text : string) : number|null {
-  const results = regex.exec(text);
-  if (results === null || results[0] === "") {
-    return null;
-  }
-  // This capture is optional, but will still be in the array as undefined,
-  // default to 0.
-  let hours = Number(results[1]);
-  if (isNaN(hours)) {
-    hours = 0;
-  }
-  let minutes = Number(results[2]);
-  if (isNaN(minutes)) {
-    minutes = 0;
-  }
-  let seconds = Number(results[3]);
-  if (isNaN(seconds)) {
-    seconds = 0;
-  }
-  let milliseconds = Number(results[4]);
-  if (isNaN(milliseconds)) {
-    milliseconds = 0;
-  }
-
-  return (milliseconds / 1000) + seconds + (minutes * 60) + (hours * 3600);
-}
-
-export default parseTime;

package/src/parsers/texttracks/ttml/xml_utils.ts

@@ -1,166 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Returns the parent elements which have the given tagName, by order of
- * closeness relative to our element.
- * @param {Element|Node} element
- * @param {string} tagName
- * @returns {Array.<Element>}
- */
-export function getParentElementsByTagName(
-  element : Element|Node,
-  tagName : string
-) : Element[] {
-  if (!(element.parentNode instanceof Element)) {
-    return [];
-  }
-
-  function constructArray(_element : Element) : Element[] {
-    const elements : Element[] = [];
-    if (_element.tagName.toLowerCase() === tagName.toLowerCase()) {
-      elements.push(_element);
-    }
-
-    const parentNode = _element.parentNode;
-    if (parentNode instanceof Element) {
-      elements.push(...constructArray(parentNode));
-    }
-
-    return elements;
-  }
-  return constructArray(element.parentNode);
-}
-
-/**
- * Returns the parent elements which have the given tagName, by order of
- * closeness relative to our element.
- * @param {Element|Node} element
- * @returns {Array.<Element>}
- */
-export function getParentDivElements(element: Element | Node) : Element[] {
-  let divs = getParentElementsByTagName(element, "div");
-  if (divs.length === 0) {
-    const ttDivs = getParentElementsByTagName(element, "tt:div");
-    if (ttDivs.length > 0) {
-      divs = ttDivs;
-    }
-  }
-  return divs;
-}
-
-/**
- * Returns the first notion of the attribute encountered in the list of elemnts
- * given.
- * @param {string} attribute
- * @param {Array.<Element>} elements
- * @returns {string|undefined}
- */
-export function getAttributeInElements(
-  attribute : string, elements : Element[]
-) : string|undefined {
-  for (let i = 0; i <= elements.length - 1; i++) {
-    const element = elements[i];
-    if (element !== undefined) {
-      const directAttrValue = element.getAttribute(attribute);
-      if (directAttrValue != null) {
-        return directAttrValue;
-      }
-    }
-  }
-}
-
-/**
- * @param {Element} tt
- * @returns {Element}
- */
-export function getBodyNode(tt : Element) : Element|null {
-  const bodyNodes = tt.getElementsByTagName("body");
-  if (bodyNodes.length > 0) {
-    return bodyNodes[0];
-  }
-  const namespacedBodyNodes = tt.getElementsByTagName("tt:body");
-  if (namespacedBodyNodes.length > 0) {
-    return namespacedBodyNodes[0];
-  }
-  return null;
-}
-
-/**
- * @param {Element} tt - <tt> node
- * @returns {Array.<Element>}
- */
-export function getStyleNodes(tt : Element) : HTMLCollectionOf<Element> {
-  const styleNodes = tt.getElementsByTagName("style");
-  if (styleNodes.length > 0) {
-    return styleNodes;
-  }
-  const namespacedStyleNodes = tt.getElementsByTagName("tt:style");
-  if (namespacedStyleNodes.length > 0) {
-    return namespacedStyleNodes;
-  }
-  return styleNodes;
-}
-
-/**
- * @param {Element} tt - <tt> node
- * @returns {Array.<Element>}
- */
-export function getRegionNodes(tt : Element) : HTMLCollectionOf<Element> {
-  const regionNodes = tt.getElementsByTagName("region");
-  if (regionNodes.length > 0) {
-    return regionNodes;
-  }
-  const namespacedRegionNodes = tt.getElementsByTagName("tt:region");
-  if (namespacedRegionNodes.length > 0) {
-    return namespacedRegionNodes;
-  }
-  return regionNodes;
-}
-
-/**
- * @param {Element} tt - <tt> node
- * @returns {Array.<Element>}
- */
-export function getTextNodes(tt : Element) : HTMLCollectionOf<Element> {
-  const pNodes = tt.getElementsByTagName("p");
-  if (pNodes.length > 0) {
-    return pNodes;
-  }
-  const namespacedPNodes = tt.getElementsByTagName("tt:p");
-  if (namespacedPNodes.length > 0) {
-    return namespacedPNodes;
-  }
-  return pNodes;
-}
-
-/**
- * Returns true if the given node corresponds to a TTML line break element.
- * @param {Node} node
- * @returns {boolean}
- */
-export function isLineBreakElement(node : Node) : boolean {
-  return node.nodeName === "br" || node.nodeName === "tt:br";
-}
-
-/**
- * Returns true if the given node corresponds to a TTML span element.
- * @param {Node} node
- * @returns {boolean}
- */
-export function isSpanElement(node : Node) : boolean {
-  return node.nodeName === "span" || node.nodeName === "tt:span";
-}