rx-player 3.33.0 → 3.33.1

package/src/parsers/texttracks/webvtt/html/create_styled_element.ts

@@ -1,95 +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 arrayIncludes from "../../../../utils/array_includes";
-import isNonEmptyString from "../../../../utils/is_non_empty_string";
-import { IStyleElements } from "./parse_style_block";
-
-/**
- * Construct an HTMLElement/TextNode representing the given node and apply
- * the right styling on it.
- * @param {Node} baseNode
- * @param {Array.<Object>} styleElements
- * @param {Array.<string>} styleClasses
- * @returns {Node}
- */
-export default function createStyledElement(
-  baseNode : Node,
-  styleElements : IStyleElements
-) : HTMLElement {
-  const HTMLTags = ["u", "i", "b"];
-  const authorizedNodeNames = ["u", "i", "b", "c", "#text"];
-
-  const mainNodeName = baseNode.nodeName.toLowerCase().split(".")[0];
-  let nodeWithStyle;
-  if (arrayIncludes(authorizedNodeNames, mainNodeName)) {
-    if (mainNodeName === "#text") {
-      const linifiedText = (baseNode as Text).wholeText
-        .split("\n");
-
-      nodeWithStyle = document.createElement("span");
-      for (let i = 0; i < linifiedText.length; i++) {
-        if (i > 0) {
-          nodeWithStyle.appendChild(document.createElement("br"));
-        }
-        if (linifiedText[i].length > 0) {
-          const textNode = document.createTextNode(linifiedText[i]);
-          nodeWithStyle.appendChild(textNode);
-        }
-      }
-    } else {
-      const nodeClasses = baseNode.nodeName.toLowerCase().split(".");
-      const styleContents : string[] = [];
-      nodeClasses.forEach(nodeClass => {
-        if (isNonEmptyString(styleElements[nodeClass])) {
-          styleContents.push(styleElements[nodeClass]);
-        }
-      });
-      if (styleContents.length !== 0) { // If style must be applied
-        const attr = document.createAttribute("style");
-        styleContents.forEach((styleContent) => {
-          attr.value += styleContent;
-        });
-        const nameClass = arrayIncludes(HTMLTags, mainNodeName) ?
-          mainNodeName : "span";
-        nodeWithStyle = document.createElement(nameClass);
-        nodeWithStyle.setAttributeNode(attr);
-      } else { // If style mustn't be applied. Rebuild element with tag name
-        const elementTag = !arrayIncludes(HTMLTags, mainNodeName) ?
-          "span" : mainNodeName;
-        nodeWithStyle = document.createElement(elementTag);
-      }
-      for (let j = 0; j < baseNode.childNodes.length; j++) {
-        const child = createStyledElement(
-          baseNode.childNodes[j],
-          styleElements
-        );
-        nodeWithStyle.appendChild(child);
-      }
-    }
-  } else {
-    nodeWithStyle = document.createElement("span");
-    for (let j = 0; j < baseNode.childNodes.length; j++) {
-      const child = createStyledElement(
-        baseNode.childNodes[j],
-        styleElements
-      );
-      nodeWithStyle.appendChild(child);
-    }
-  }
-
-  return nodeWithStyle;
-}

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

@@ -1,25 +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 parseWebVTTToDiv from "./parse_webvtt_to_div";
-export { IVTTHTMLCue } from "./to_html";
-
-export default parseWebVTTToDiv;

package/src/parsers/texttracks/webvtt/html/parse_style_block.ts

@@ -1,76 +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";
-import createDefaultStyleElements from "./create_default_style_elements";
-
-export interface IStyleElements { [className : string]: string }
-
-/**
- * Parse style element from WebVTT.
- * @param {Array.<Array.<string>>} styleBlocks
- * @return {Object}
- */
-export default function parseStyleBlocks(
-  styleBlocks : string[][]
-) : { classes : IStyleElements;
-      global : string; }
-{
-  const classes : IStyleElements = createDefaultStyleElements();
-  let global = "";
-
-  styleBlocks.forEach((styleBlock) => {
-    if (styleBlock.length >= 2) {
-      for (let index = 1; index < styleBlock.length; index++) {
-        let line = styleBlock[index];
-        if (Array.isArray(/::cue {/.exec(line))) {
-          line = styleBlock[++index];
-          while (isNonEmptyString(line) && (!(Array.isArray(/}/.exec(line)) ||
-                                              line.length === 0))) {
-            global += line;
-            line = styleBlock[++index];
-          }
-        } else {
-          const classNames : string[] = [];
-          let cueClassLine = /::cue\(\.?(.*?)\)(?:,| {)/.exec(line);
-          while (isNonEmptyString(line) && Array.isArray(cueClassLine)) {
-            classNames.push(cueClassLine[1]);
-            line = styleBlock[++index];
-            cueClassLine = /::cue\(\.?(.*?)\)(?:,| {)/.exec(line);
-          }
-
-          let styleContent = "";
-          while (isNonEmptyString(line) && (!(Array.isArray(/}/.exec(line)) ||
-                                              line.length === 0)))
-          {
-            styleContent += line;
-            line = styleBlock[++index];
-          }
-
-          classNames.forEach((className) => {
-            const styleElement = classes[className];
-            if (styleElement === undefined) {
-              classes[className] = styleContent;
-            } else {
-              classes[className] += styleContent;
-            }
-          });
-        }
-      }
-    }
-  });
-  return { classes, global };
-}

package/src/parsers/texttracks/webvtt/html/parse_webvtt_to_div.ts

@@ -1,67 +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 getCueBlocks from "../get_cue_blocks";
-import getStyleBlocks from "../get_style_blocks";
-import parseCueBlock from "../parse_cue_block";
-import { getFirstLineAfterHeader } from "../utils";
-import parseStyleBlocks from "./parse_style_block";
-import toHTML, {
-  IVTTHTMLCue,
-} from "./to_html";
-
-/**
- * Parse WebVTT from text. Returns an array with:
- * - start : start of current cue, in seconds
- * - end : end of current cue, in seconds
- * - content : HTML formatted cue.
- *
- * Global style is parsed and applied to div element.
- * Specific style is parsed and applied to class element.
- *
- * @throws Error - Throws if the given WebVTT string is invalid.
- * @param {string} text - The whole webvtt subtitles to parse
- * @param {Number} timeOffset - Offset to add to start and end times, in seconds
- * @return {Array.<Object>}
- */
-export default function parseWebVTT(
-  text : string,
-  timeOffset : number
-) : IVTTHTMLCue[] {
-  const newLineChar = /\r\n|\n|\r/g; // CRLF|LF|CR
-  const linified = text.split(newLineChar);
-
-  const cuesArray : IVTTHTMLCue[] = [];
-  if (/^WEBVTT( |\t|\n|\r|$)/.exec(linified[0]) === null) {
-    throw new Error("Can't parse WebVTT: Invalid File.");
-  }
-
-  const firstLineAfterHeader = getFirstLineAfterHeader(linified);
-  const styleBlocks = getStyleBlocks(linified, firstLineAfterHeader);
-  const cueBlocks = getCueBlocks(linified, firstLineAfterHeader);
-
-  const styles = parseStyleBlocks(styleBlocks);
-
-  for (let i = 0; i < cueBlocks.length; i++) {
-    const cueObject = parseCueBlock(cueBlocks[i], timeOffset);
-
-    if (cueObject != null) {
-      const htmlCue = toHTML(cueObject, styles);
-      cuesArray.push(htmlCue);
-    }
-  }
-  return cuesArray;
-}

package/src/parsers/texttracks/webvtt/html/to_html.ts

@@ -1,96 +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";
-import convertPayloadToHTML from "./convert_payload_to_html";
-import createStyleAttribute from "./create_style_attribute";
-import { IStyleElements } from "./parse_style_block";
-
-export interface IVTTHTMLCue { start : number;
-                               end: number;
-                               element : HTMLElement; }
-
-/**
- * Parse cue block into an object with the following properties:
- *   - start {number}: start time at which the cue should be displayed
- *   - end {number}: end time at which the cue should be displayed
- *   - element {HTMLElement}: the cue text, translated into an HTMLElement
- *
- * Returns undefined if the cue block could not be parsed.
- * @param {Array.<string>} cueBlock
- * @param {Number} timeOffset
- * @param {Array.<Object>} classes
- * @returns {Object|undefined}
- */
-export default function toHTML(
-  cueObj : { start : number;
-             end : number;
-             settings: Partial<Record<string, string>>;
-             header? : string | undefined;
-             payload : string[]; },
-  styling : { classes : IStyleElements;
-              global? : string | undefined; }
-) : IVTTHTMLCue {
-  const { start, end, settings, header, payload } = cueObj;
-
-  const region = document.createElement("div");
-  const regionAttr = document.createAttribute("style");
-  regionAttr.value =
-    "width:100%;" +
-    "height:100%;" +
-    "display:flex;" +
-    "flex-direction:column;" +
-    "justify-content:flex-end;" +
-    "align-items:center;";
-  region.setAttributeNode(regionAttr);
-
-  // Get content, format and apply style.
-  const pElement = document.createElement("p");
-  const pAttr = createStyleAttribute(settings);
-  pElement.setAttributeNode(pAttr);
-
-  const spanElement = document.createElement("span");
-  const attr = document.createAttribute("style");
-
-  // set color and background-color default values, as indicated in:
-  // https://www.w3.org/TR/webvtt1/#applying-css-properties
-  attr.value =
-    "background-color:rgba(0,0,0,0.8);" +
-    "color:white;";
-  spanElement.setAttributeNode(attr);
-
-  const { global, classes } = styling;
-  const localStyle = isNonEmptyString(header) ? classes[header] :
-                                                undefined;
-  const styles = [global, localStyle]
-    .filter((s) => s !== undefined)
-    .join("");
-
-  attr.value += styles;
-  spanElement.setAttributeNode(attr);
-
-  convertPayloadToHTML(payload.join("\n"), classes)
-    .forEach(element => {
-      spanElement.appendChild(element);
-    });
-
-  region.appendChild(pElement) ;
-  pElement.appendChild(spanElement);
-
-  return { start,
-           end,
-           element: region };
-}

package/src/parsers/texttracks/webvtt/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 parseVTTStringToVTTCues from "./parse_vtt_to_cues";
-export default parseVTTStringToVTTCues;

package/src/parsers/texttracks/webvtt/native/parse_vtt_to_cues.ts

@@ -1,70 +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 {
-  ICompatVTTCue,
-  isVTTCue,
-} from "../../../../compat/index";
-import getCueBlocks from "../get_cue_blocks";
-import parseCueBlock from "../parse_cue_block";
-import { getFirstLineAfterHeader } from "../utils";
-import setSettingsOnCue from "./set_settings_on_cue";
-import toNativeCue from "./to_native_cue";
-
-// Simple VTT to ICompatVTTCue parser:
-// Just parse cues and associated settings.
-// Does not take into consideration STYLE and REGION blocks.
-
-/**
- * Parse whole WEBVTT file into an array of cues, to be inserted in a video's
- * TrackElement.
- * @param {string} vttStr
- * @param {Number} timeOffset
- * @returns {Array.<ICompatVTTCue|TextTrackCue>}
- */
-export default function parseVTTStringToVTTCues(
-  vttStr : string,
-  timeOffset : number
-) : Array<TextTrackCue|ICompatVTTCue> {
-  // WEBVTT authorize CRLF, LF or CR as line terminators
-  const lines = vttStr.split(/\r\n|\n|\r/);
-
-  if (!(/^WEBVTT($| |\t)/.test(lines[0]))) {
-    throw new Error("Can't parse WebVTT: Invalid file.");
-  }
-
-  const firstLineAfterHeader = getFirstLineAfterHeader(lines);
-  const cueBlocks : string[][] = getCueBlocks(lines, firstLineAfterHeader);
-  const cues : Array<ICompatVTTCue|TextTrackCue> = [];
-  for (let i = 0; i < cueBlocks.length; i++) {
-    const cueObject = parseCueBlock(cueBlocks[i], timeOffset);
-    if (cueObject != null) {
-      const nativeCue = toNativeCue(cueObject);
-      if (nativeCue != null) {
-        if (isVTTCue(nativeCue)) {
-          setSettingsOnCue(cueObject.settings, nativeCue);
-        }
-        cues.push(nativeCue);
-      }
-    }
-  }
-  return cues;
-}

package/src/parsers/texttracks/webvtt/native/set_settings_on_cue.ts

@@ -1,95 +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/index";
-import arrayIncludes from "../../../../utils/array_includes";
-import isNonEmptyString from "../../../../utils/is_non_empty_string";
-
-/**
- * Add the corresponding settings on the given cue.
- * /!\ Mutates the cue given.
- * @param {Object} settings - settings for the cue, as a key-value object.
- * @param {ICompatVTTCue|TextTrackCue} cue
- */
-export default function setSettingsOnCue(
-  settings : Partial<Record<string, string>>,
-  cue : ICompatVTTCue
-) : void {
-  if (isNonEmptyString(settings.vertical) &&
-      (settings.vertical === "rl" || settings.vertical === "lr"))
-  {
-    cue.vertical = settings.vertical;
-  }
-
-  if (isNonEmptyString(settings.line)) {
-
-    // Capture groups:
-    //   1 -> percentage position
-    //   2 -> optional decimals from percentage position
-    //   3 -> optional follow-up of the string indicating alignment value
-    //   4 -> alignment value
-    const percentagePosition = /^(\d+(\.\d+)?)%(,([a-z]+))?/;
-    const percentageMatches = percentagePosition.exec(settings.line);
-    if (Array.isArray(percentageMatches)) {
-      cue.line = Number(percentageMatches[1]);
-      cue.snapToLines = false;
-      if (arrayIncludes(["start", "center", "end"], percentageMatches[4])) {
-        cue.lineAlign = percentageMatches[4];
-      }
-    } else {
-      // Capture groups:
-      //   1 -> line number
-      //   2 -> optional follow-up of the string indicating alignment value
-      //   3 -> alignment value
-      const linePosition = /^(-?\d+)(,([a-z]+))?/;
-      const lineMatches = linePosition.exec(settings.line);
-
-      if (Array.isArray(lineMatches)) {
-        cue.line = Number(lineMatches[1]);
-        cue.snapToLines = true;
-
-        if (arrayIncludes(["start", "center", "end"], lineMatches[3])) {
-          cue.lineAlign = lineMatches[3];
-        }
-      }
-    }
-  }
-
-  if (isNonEmptyString(settings.position)) {
-    const positionRegex = /^([\d\.]+)%(?:,(line-left|line-right|center))?$/;
-    const positionArr = positionRegex.exec(settings.position);
-    if (Array.isArray(positionArr) && positionArr.length >= 2) {
-      const position = parseInt(positionArr[1], 10);
-      if (!isNaN(position)) {
-        cue.position = position;
-
-        if (positionArr[2] !== undefined) {
-          cue.positionAlign = positionArr[2];
-        }
-      }
-    }
-  }
-
-  if (isNonEmptyString(settings.size)) {
-    cue.size = settings.size;
-  }
-
-  if (typeof settings.align === "string" &&
-      arrayIncludes(["start", "center", "end", "left"], settings.align))
-  {
-    cue.align  = settings.align;
-  }
-}

package/src/parsers/texttracks/webvtt/native/to_native_cue.ts

@@ -1,34 +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,
-  makeVTTCue,
-} from "../../../../compat/index";
-
-/**
- * @param {Object} cue Object
- * @returns {TextTrackCue|ICompatVTTCue|null}
- */
-export default function toNativeCue(cueObj : {
-  start : number;
-  end : number;
-  payload : string[];
-}) : ICompatVTTCue|TextTrackCue|null {
-  const { start, end, payload } = cueObj;
-  const text = payload.join("\n");
-  return makeVTTCue(start, end, text);
-}