rx-player 4.0.0-dev.2023121900 → 4.0.0-rc.2

package/src/parsers/texttracks/ttml/html/generate_css_test_outline.ts

@@ -1,46 +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 isNonEmptyString from "../../../../utils/is_non_empty_string";
-
-/**
- * Try to replicate the textOutline TTML style property into CSS.
- *
- * We mock it throught the text-shadow property, translating the TTML thickness
- * into blur radius and the blur-radius into... nothing.
- *
- * @param {string} color
- * @param {string|number} thickness
- * @returns {string}
- */
-export default function generateCSSTextOutline(
-  color : string,
-  thickness : string|number
-) : string {
-  let thick = thickness;
-  if (isNonEmptyString(thickness) && thickness.trim().endsWith("%")) {
-    // As em and % are basically equivalent in CSS
-    // (they both are relative to the font-size
-    // of the current element)
-    // We convert the non supported % into the supported em
-    thick = thickness.trim().slice(0, -1);
-    thick = (parseInt(thick, 10) / 100).toString() + "em";
-  }
-  return `-1px -1px ${thick} ${color},` +
-         `1px -1px ${thick} ${color},` +
-         `-1px 1px ${thick} ${color},` +
-         `1px 1px ${thick} ${color}`;
-}

package/src/parsers/texttracks/ttml/html/index.ts

@@ -1,23 +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.
- */
-
-/**
- * /!\ This file is feature-switchable.
- * It always should be imported through the `features` object.
- */
-
-import parseTTMLStringToDIV from "./parse_ttml_to_div";
-export default parseTTMLStringToDIV;

package/src/parsers/texttracks/ttml/html/parse_cue.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.
- */
-
-import getTimeDelimiters from "../get_time_delimiters";
-import { IParsedTTMLCue } from "../parse_ttml";
-import createElement from "./create_element";
-
-export interface ITTMLHTMLCue { start : number;
-                                end: number;
-                                element : HTMLElement; }
-
-/**
- * @param {Object} parsedCue
- * @returns {Object|null}
- */
-export default function parseCue(
-  parsedCue: IParsedTTMLCue
-) : ITTMLHTMLCue|null {
-  const {
-    paragraph,
-    ttParams,
-    body,
-    regionStyles,
-    idStyles,
-    paragraphStyle,
-    timeOffset,
-    shouldTrimWhiteSpace,
-  } = parsedCue;
-
-  // Disregard empty elements:
-  // TTML allows for empty elements like <div></div>.
-  // If paragraph has neither time attributes, nor
-  // non-whitespace text, don't try to make a cue out of it.
-  if (!paragraph.hasAttribute("begin") &&
-      !paragraph.hasAttribute("end") &&
-      /^\s*$/.test(paragraph.textContent === null ? "" : paragraph.textContent))
-  {
-    return null;
-  }
-
-  const { cellResolution } = ttParams;
-  const { start, end } = getTimeDelimiters(paragraph, ttParams);
-  const element = createElement(paragraph,
-                                body,
-                                regionStyles,
-                                idStyles,
-                                paragraphStyle,
-                                { cellResolution, shouldTrimWhiteSpace });
-  return { start: start + timeOffset,
-           end: end + timeOffset,
-           element };
-}

package/src/parsers/texttracks/ttml/html/parse_ttml_to_div.ts

@@ -1,58 +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 parseTtml from "../parse_ttml";
-import {
-  applyDefaultTTMLStyle,
-  shouldApplyDefaultTTMLStyle,
-} from "./apply_default_ttml_paragraph_style";
-import parseCue, { ITTMLHTMLCue } from "./parse_cue";
-
-/**
- * Create array of objects which should represent the given TTML text track.
- * These objects have the following structure
- *   - start {Number}: start time, in seconds, at which the cue should
- *     be displayed
- *   - end {Number}: end time, in seconds, at which the cue should
- *     be displayed
- *   - element {HTMLElement}: <div> element representing the cue, with the
- *     right style. This div should then be appended to an element having
- *     the exact size of the wanted region the text track provide cues for.
- *
- * 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
- */
-export default function parseTTMLToDiv(
-  str : string,
-  timeOffset : number
-): ITTMLHTMLCue[] {
-  const parsedCues = parseTtml(str, timeOffset);
-  const cues: ITTMLHTMLCue[] = [];
-  for (let i = 0; i < parsedCues.length; i++) {
-    const { paragraphStyle } = parsedCues[i];
-    if (shouldApplyDefaultTTMLStyle(paragraphStyle)) {
-      applyDefaultTTMLStyle(paragraphStyle);
-    }
-    const cue = parseCue(parsedCues[i]);
-    if (cue !== null) {
-      cues.push(cue);
-    }
-  }
-  return cues;
-}

package/src/parsers/texttracks/ttml/html/ttml_color_to_css_color.ts

@@ -1,68 +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 {
-  REGXP_4_HEX_COLOR,
-  REGXP_8_HEX_COLOR,
-  REGXP_RGBA_COLOR,
-  REGXP_RGB_COLOR,
-} from "../regexps";
-
-/**
- * Translate a color indicated in TTML-style to a CSS-style color.
- * @param {string} color
- * @returns {string} color
- */
-export default function ttmlColorToCSSColor(color : string) : string {
-  // TODO check all possible color fomats
-  let regRes;
-
-  regRes = REGXP_8_HEX_COLOR.exec(color);
-  if (regRes != null) {
-    return "rgba(" +
-      String(parseInt(regRes[1], 16)) + "," +
-      String(parseInt(regRes[2], 16)) + "," +
-      String(parseInt(regRes[3], 16)) + "," +
-      String(parseInt(regRes[4], 16) / 255) + ")";
-  }
-
-  regRes = REGXP_4_HEX_COLOR.exec(color);
-  if (regRes != null) {
-    return "rgba(" +
-      String(parseInt(regRes[1] + regRes[1], 16)) + "," +
-      String(parseInt(regRes[2] + regRes[2], 16)) + "," +
-      String(parseInt(regRes[3] + regRes[3], 16)) + "," +
-      String(parseInt(regRes[4] + regRes[4], 16) / 255) + ")";
-  }
-
-  regRes = REGXP_RGB_COLOR.exec(color);
-  if (regRes != null) {
-    return "rgb(" +
-      String(+regRes[1]) + "," +
-      String(+regRes[2]) + "," +
-      String(+regRes[3]) + ")";
-  }
-
-  regRes = REGXP_RGBA_COLOR.exec(color);
-  if (regRes != null) {
-    return "rgba(" +
-      String(+regRes[1]) + "," +
-      String(+regRes[2]) + "," +
-      String(+regRes[3]) + "," +
-      String(+regRes[4] / 255) + ")";
-  }
-  return color;
-}

package/src/parsers/texttracks/ttml/native/index.ts

@@ -1,23 +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.
- */
-
-/**
- * /!\ This file is feature-switchable.
- * It always should be imported through the `features` object.
- */
-
-import parseTTMLStringToVTT from "./parse_ttml_to_vtt";
-export default parseTTMLStringToVTT;

package/src/parsers/texttracks/ttml/native/parse_cue.ts

@@ -1,245 +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 {
-  ICompatVTTCue,
-  isVTTCue,
-  makeVTTCue,
-} from "../../../../compat";
-import isNonEmptyString from "../../../../utils/is_non_empty_string";
-import {
-  IStyleList,
-} from "../get_styling";
-import getTimeDelimiters from "../get_time_delimiters";
-import { IParsedTTMLCue } from "../parse_ttml";
-import { REGXP_PERCENT_VALUES } from "../regexps";
-import {
-  isLineBreakElement,
-  isSpanElement,
-} from "../xml_utils";
-
-const TEXT_ALIGN_TO_LIGN_ALIGN : Partial<Record<string, string>> = {
-  left: "start",
-  center: "center",
-  right: "end",
-  start: "start",
-  end: "end",
-};
-
-/**
- * @type {Object}
- */
-const TEXT_ALIGN_TO_POSITION_ALIGN : Partial<Record<string, string>> = {
-  left: "line-left",
-  center: "center",
-  right: "line-right",
-};
-
-/**
- * Parses an Element into a TextTrackCue or VTTCue.
- * /!\ Mutates the given cueElement Element
- * @param {Element} paragraph
- * @param {Number} offset
- * @param {Array.<Object>} styles
- * @param {Array.<Object>} regions
- * @param {Object} paragraphStyle
- * @param {Object} ttParams
- * @param {Boolean} shouldTrimWhiteSpace
- * @returns {TextTrackCue|null}
- */
-export default function parseCue(
-  parsedCue: IParsedTTMLCue
-) : ICompatVTTCue|TextTrackCue|null {
-  const {
-    paragraph,
-    timeOffset,
-    paragraphStyle,
-    ttParams,
-    shouldTrimWhiteSpace,
-  } = parsedCue;
-
-  // Disregard empty elements:
-  // TTML allows for empty elements like <div></div>.
-  // If paragraph has neither time attributes, nor
-  // non-whitespace text, don't try to make a cue out of it.
-  if (!paragraph.hasAttribute("begin") && !paragraph.hasAttribute("end") &&
-      /^\s*$/.test(paragraph.textContent === null ? "" : paragraph.textContent)
-  ) {
-    return null;
-  }
-
-  const { start, end } = getTimeDelimiters(paragraph, ttParams);
-  const text = generateTextContent(paragraph, shouldTrimWhiteSpace);
-  const cue = makeVTTCue(start + timeOffset, end + timeOffset, text);
-  if (cue === null) {
-    return null;
-  }
-  if (isVTTCue(cue)) {
-    addStyle(cue, paragraphStyle);
-  }
-  return cue;
-}
-
-/**
- * Generate text to display for a given paragraph.
- * @param {Element} paragraph - The <p> tag.
- * @param {Boolean} shouldTrimWhiteSpaceForParagraph
- * @returns {string}
- */
-function generateTextContent(
-  paragraph : Element,
-  shouldTrimWhiteSpaceForParagraph : boolean
-) : string {
-  /**
-   * Recursive function, taking a node in argument and returning the
-   * corresponding string.
-   * @param {Node} node - the node in question
-   * @returns {string}
-   */
-  function loop(
-    node : Node,
-    shouldTrimWhiteSpaceFromParent : boolean
-  ) : string {
-    const childNodes = node.childNodes;
-    let text = "";
-    for (let i = 0; i < childNodes.length; i++) {
-      const currentNode = childNodes[i];
-      if (currentNode.nodeName === "#text") {
-        let textContent = currentNode.textContent;
-        if (textContent === null) {
-          textContent = "";
-        }
-
-        if (shouldTrimWhiteSpaceFromParent) {
-          // 1. Trim leading and trailing whitespace.
-          // 2. Collapse multiple spaces into one.
-          let trimmed = textContent.trim();
-          trimmed = trimmed.replace(/\s+/g, " ");
-          textContent = trimmed;
-        }
-
-        // DOM Parser turns HTML escape caracters into caracters,
-        // that may be misinterpreted by VTTCue API (typically, less-than sign
-        // and greater-than sign can be interpreted as HTML tags signs).
-        // Original escaped caracters must be conserved.
-        const escapedTextContent = textContent
-          .replace(/&|\u0026/g, "&amp;")
-          .replace(/<|\u003C/g, "&lt;")
-          .replace(/>|\u2265/g, "&gt;")
-          .replace(/\u200E/g, "&lrm;")
-          .replace(/\u200F/g, "&rlm;")
-          .replace(/\u00A0/g, "&nbsp;");
-
-        text += escapedTextContent;
-      } else if (isLineBreakElement(currentNode)) {
-        text += "\n";
-      } else if (
-        isSpanElement(currentNode) &&
-        currentNode.nodeType === Node.ELEMENT_NODE &&
-        currentNode.childNodes.length > 0
-      ) {
-        const spaceAttribute = (currentNode as Element).getAttribute("xml:space");
-        const shouldTrimWhiteSpaceForSpan = isNonEmptyString(spaceAttribute) ?
-          spaceAttribute === "default" :
-          shouldTrimWhiteSpaceFromParent;
-
-        text += loop(currentNode, shouldTrimWhiteSpaceForSpan);
-      }
-    }
-    return text;
-  }
-  return loop(paragraph, shouldTrimWhiteSpaceForParagraph);
-}
-
-/**
- * Adds applicable style properties to a cue.
- * /!\ Mutates cue argument.
- * @param {VTTCue} cue
- * @param {Object} style
- */
-function addStyle(cue : ICompatVTTCue, style : IStyleList) {
-  const extent = style.extent;
-  if (isNonEmptyString(extent)) {
-    const results = REGXP_PERCENT_VALUES.exec(extent);
-    if (results != null) {
-      // Use width value of the extent attribute for size.
-      // Height value is ignored.
-      cue.size = Number(results[1]);
-    }
-  }
-
-  const writingMode = style.writingMode;
-  // let isVerticalText = true;
-  switch (writingMode) {
-    case "tb":
-    case "tblr":
-      cue.vertical = "lr";
-      break;
-    case "tbrl":
-      cue.vertical = "rl";
-      break;
-    default:
-      // isVerticalText = false;
-      break;
-  }
-
-  const origin = style.origin;
-  if (isNonEmptyString(origin)) {
-    const results = REGXP_PERCENT_VALUES.exec(origin);
-    if (results != null) {
-      // for vertical text use first coordinate of tts:origin
-      // to represent line of the cue and second - for position.
-      // Otherwise (horizontal), use them the other way around.
-      // if (isVerticalText) {
-        // TODO check and uncomment
-        // cue.position = Number(results[2]);
-        // cue.line = Number(results[1]);
-      // } else {
-        // TODO check and uncomment
-        // cue.position = Number(results[1]);
-        // cue.line = Number(results[2]);
-      // }
-      // A boolean indicating whether the line is an integer
-      // number of lines (using the line dimensions of the first
-      // line of the cue), or whether it is a percentage of the
-      // dimension of the video. The flag is set to true when lines
-      // are counted, and false otherwise.
-      // TODO check and uncomment
-      // cue.snapToLines = false;
-    }
-  }
-
-  const align = style.align;
-  if (isNonEmptyString(align)) {
-    cue.align = align;
-    if (align === "center") {
-      if (cue.align !== "center") {
-        // Workaround for a Chrome bug http://crbug.com/663797
-        // Chrome does not support align = "center"
-        cue.align = "middle";
-      }
-      cue.position = "auto";
-    }
-
-    const positionAlign = TEXT_ALIGN_TO_POSITION_ALIGN[align];
-    cue.positionAlign = positionAlign === undefined ? "" :
-                                                      positionAlign;
-
-    const lineAlign = TEXT_ALIGN_TO_LIGN_ALIGN[align];
-    cue.lineAlign = lineAlign === undefined ? "" :
-                                              lineAlign;
-  }
-}

package/src/parsers/texttracks/ttml/native/parse_ttml_to_vtt.ts

@@ -1,39 +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 { ICompatVTTCue } from "../../../../compat";
-import parseTtml from "../parse_ttml";
-import parseCue from "./parse_cue";
-
-/**
- * @param str
- * @param timeOffset
- */
-export default function parseTtmlToNative(
-  str : string,
-  timeOffset : number
-): Array<TextTrackCue | ICompatVTTCue> {
-  const parsedCues = parseTtml(str, timeOffset);
-  const cues: Array<TextTrackCue | ICompatVTTCue> = [];
-  for (let i = 0; i < parsedCues.length; i++) {
-    const parsedCue = parsedCues[i];
-    const cue = parseCue(parsedCue);
-    if (cue !== null) {
-      cues.push(cue);
-    }
-  }
-  return cues;
-}