shaka-player 4.0.2 → 4.0.5

package/build/generateLocalizations.py

@@ -1,262 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright 2018 Google LLC
-#
-# 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.
-
-"""Generates Javascript to load compile-time localization data.
-
-This reads localization data at compile-time in a flat JSON-formatted
-dictionary.  The keys are message IDs, and the values are the translated
-strings.  For example:
-  {
-    "BEST_WISHES": "Merin sa haryalye alasse"
-  }
-
-Each locale's translations are read from a separate file.  For example, the path
-the Arabic data would be ui/locales/ar.json.
-"""
-
-import argparse
-import contextlib
-import json
-import os
-import sys
-import io
-import shakaBuildHelpers
-
-
-_INDENTATION = '  '
-
-# These are Google's "Tier 1" languages as of April 2019.
-DEFAULT_LOCALES = [
-    'ar',
-    'de',
-    'en',
-    'en-GB',
-    'es',
-    'es-419',
-    'fr',
-    'it',
-    'ja',
-    'ko',
-    'nl',
-    'pl',
-    'pt-BR',
-    'ru',
-    'th',
-    'tr',
-    'zh',
-    'zh-TW',
-]
-
-
-class Doc(object):
-  """A string builder class used to build out a tab-sensitive document."""
-
-  def __init__(self):
-    # All the lines that make-up this document.
-    self._lines = []
-
-    # Track each tab we need to insert ahead of the next line.
-    self._tab_level = 0
-
-  @contextlib.contextmanager
-  def Block(self):
-    """Starts a new tabbed block.
-
-    This should be used with |with| to ensure that the block closes.
-    """
-    self._tab_level += 1
-    yield
-    self._tab_level -= 1
-
-  def Code(self, block):
-    """Insert a block of code with the current tab level.
-
-    This will add the required leading white space to the line.
-    """
-    # Break the code block into each line of code
-    lines = block.split('\n')
-
-    for line in lines:
-      # Right-strip the line to avoid trailing white space. We do this on the
-      # full string so that tabbing will be removed if a blank line was added.
-      new_line = (_INDENTATION * self._tab_level) + line
-      self._lines.append(new_line.rstrip())
-
-  def ToString(self):
-    return '\n'.join(self._lines) + '\n'
-
-
-def AsQuotedString(input_string):
-  """Convert |input_string| into a quoted string."""
-  subs = [
-      ('\n', '\\n'),
-      ('\t', '\\t'),
-      ("'", "\\'")
-  ]
-
-  # Go through each substitution and replace any occurrences.
-  output_string = input_string
-  for before, after in subs:
-    output_string = output_string.replace(before, after)
-
-  # Lastly wrap the string in quotes.
-  return "'%s'" % output_string
-
-
-def GenerateLocalizations(localizations, class_name):
-  """Generates JavaScript code to insert the localization data.
-
-  This creates a function called "addTo" in the class called |class_name| that,
-  when called, will insert the data from |localizations|.
-
-  Args:
-    localizations: A map of string locale name to a map of string tag to the
-      string localization.
-    class_name: A string name of the class to put generated code into.
-
-  Returns:
-    A string containing the generated code.
-  """
-  doc = Doc()
-
-  doc.Code("""
-// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-// This file is auto-generated. DO NOT EDIT THIS FILE. If you need to:
-//   - change which locales are in this file, use the --locales option in
-//     "build/all.py" or "build/build.py"
-//   - change an entry for a specific locale, update "ui/locales/"
-//   - change anything else, update "build/generateLocalizations.py".
-//
-// To regenerate this file, run "build/generateLocalizations.py".
-// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-""")
-
-  # Insert a comment that the build scripts will read to determine the freshness
-  # of this output.  This will be compared against a list of locales in the
-  # current build to decide if the output needs to be regenerated.
-  # DO NOT change the formatting here without also updating the "compiler.py"
-  # module and the "GenerateLocalizations" class's "_locales_changed" method.
-  locale_list_string = ', '.join(sorted(localizations.keys()))
-  doc.Code('// LOCALES: %s' % locale_list_string)
-
-  doc.Code("goog.provide('%s');" % class_name)
-  doc.Code("goog.require('shaka.ui.Localization');")
-
-  doc.Code("""
-/**
- * Insert all localization data for the UI into |localization|. This should be
- * done BEFORE any listeners are added to the localization system (to avoid
- * callbacks for each insert) and should be done BEFORE changing to the initial
- * preferred locale (reduces the work needed to update the internal state after
- * each insert).
- *
- * @param {!shaka.ui.Localization} localization
- */""")
-
-  doc.Code('%s.addTo = function(localization) {' % class_name)
-
-  message_ids = set()
-
-  # Go through the locales in sorted order so that we will be consistent between
-  # runs.
-  for locale in sorted(localizations.keys()):
-    localization = localizations[locale]
-
-    with doc.Block():
-      quoted_locale = AsQuotedString(locale)
-      doc.Code('localization.insert(%s, new Map([' % quoted_locale)
-
-      with doc.Block():
-        # Make sure that we sort by the localization keys so that they will
-        # always be in the same order.
-        for key, value in sorted(localization.items()):
-          message_ids.add(key)
-          quoted_key = AsQuotedString(key)
-          quoted_value = AsQuotedString(value)
-          doc.Code('[%s, %s],' % (quoted_key, quoted_value))
-
-      doc.Code(']));')  # Close the call to insert.
-
-  doc.Code('};')  # Close the function.
-
-  doc.Code("""
-/**
- * @enum {string}
- * @const
- */
-%s.Ids = {""" % class_name)
-  for message_id in message_ids:
-    doc.Code('  %s: %s,' % (message_id, AsQuotedString(message_id)))
-  doc.Code('};')
-
-  return doc.ToString()
-
-
-def CreateParser():
-  """Create the argument parser for this application."""
-  base = shakaBuildHelpers.get_source_base()
-
-  parser = argparse.ArgumentParser(
-      description=__doc__,
-      formatter_class=argparse.RawDescriptionHelpFormatter)
-
-  parser.add_argument(
-      '--locales',
-      type=str,
-      nargs='+',
-      default=DEFAULT_LOCALES,
-      help='The list of locales to compile in (default %(default)r)')
-
-  parser.add_argument(
-      '--source',
-      type=str,
-      default=os.path.join(base, 'ui', 'locales'),
-      help='The folder path for JSON inputs')
-
-  parser.add_argument(
-      '--output',
-      type=str,
-      default=os.path.join(base, 'dist', 'locales.js'),
-      help='The file path for JavaScript output')
-
-  parser.add_argument(
-      '--class-name',
-      type=str,
-      default='shaka.ui.Locales',
-      help='The fully qualified class name for the JavaScript output')
-
-  return parser
-
-
-def main(args):
-  parser = CreateParser()
-  args = parser.parse_args(args)
-
-  combined_localizations = {}
-  for locale in args.locales:
-    path = os.path.join(args.source, locale + '.json')
-    with io.open(path, 'r', encoding='utf8') as f:
-      combined_localizations[locale] = json.load(f)
-
-  doc = GenerateLocalizations(combined_localizations, args.class_name)
-  with open(args.output, 'wb') as f:
-    f.write(doc.encode('utf-8'))
-
-  return args.output
-
-
-if __name__ == '__main__':
-  main(sys.argv[1:])

package/build/generateTsDefs.py

@@ -1,137 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright 2016 Google LLC
-#
-# 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.
-
-"""Generates TypeScript defs from Closure externs.
-
-This uses the Clutz tool from https://github.com/angular/clutz and then performs
-additional transformations to make the generated defs independent of Clutz.
-"""
-
-import argparse
-import os
-import re
-import sys
-
-import shakaBuildHelpers
-
-
-def GenerateTsDefs(inputs, output):
-  """Generates TypeScript defs from Closure externs.
-
-  Args:
-    inputs: A list of paths to Closure extern files.
-    output: A path to a TypeScript def output file.
-  """
-  clutz = shakaBuildHelpers.get_node_binary('@teppeis/clutz', 'clutz')
-
-  command = clutz + [
-      '--closure_env', 'BROWSER',
-      '--externs',
-  ] + inputs + [
-      '-o', '-',
-  ]
-
-  # Get the output of Clutz, then transform it to make it independent of Clutz
-  # and usable directly in TypeScript projects.
-  contents = shakaBuildHelpers.execute_get_output(command)
-
-  # Remove the prefix clutz puts on all namespaces.
-  contents = contents.replace(b'\xe0\xb2\xa0_\xe0\xb2\xa0.clutz.', b'')
-  # Replace "GlobalObject" (from Clutz) with TypeScript-native "object".
-  contents = re.sub(br'\bGlobalObject\b', b'object', contents)
-  # Remove "Global" from Clutz's Global{Date,Element,Event,EventTarget} and use
-  # their original definitions instead.
-  contents = re.sub(
-      br'\bGlobal(Date|Element|Event|EventTarget)\b', br'\1', contents)
-  # Remove "protected", which appears on some fields, and is only supported on
-  # methods.
-  contents = re.sub(br'^\s*protected ', b'', contents, flags=re.MULTILINE)
-  # Clutz really likes EventTargets, so it wants IAdManager to extend it twice.
-  contents = contents.replace(
-      b'extends EventTarget extends EventTarget',
-      b'extends EventTarget')
-  # Some types allow you to return a Promise or nothing, but the Clutz output of
-  # "Promise | null | undefined" doesn't work in TypeScript.  We need to use
-  # "Promise | void" instead.
-  contents = contents.replace(b'| null | undefined', b'| void')
-  # shaka.util.Error extends Error and implements shaka.extern.Error, but this
-  # confuses TypeScript when both are called "Error" in context of the namespace
-  # declaration for "shaka.util".  Therefore we need to declare this
-  # "GlobalError" type, which is already referenced by Clutz but never defined.
-  global_error_def = b'declare class GlobalError extends Error {}\n\n'
-  contents = global_error_def + contents
-  # There are some types that implement multiple interfaces, such as IReleasable
-  # and Iteratable.  Also, there are tools used inside Google that (for some
-  # reason) want to convert TS defs _BACK_ into Closure Compiler externs.  When
-  # that happens, these multiple implementors generate externs with broken
-  # @implements annotations.  Since this team can't control that process or
-  # those tools, we need to adjust our TS defs instead.  In these particular
-  # cases, thankfully, we can just remove the reference to the IReleasable
-  # interface, which is not needed outside the library.
-  # TODO: This only covers one very specific pattern, and could be brittle.
-  contents = contents.replace(
-      b'implements shaka.util.IReleasable , ', b'implements ')
-  # Finally, Clutz includes a bunch of basic defs for a browser environment
-  # generated from Closure compiler's builtins.  Remove these.
-  sections = re.split(br'\n(?=// Generated from .*)', contents)
-  sections = filter(
-      lambda s: not s.startswith(b'// Generated from externs.zip'),
-      sections)
-  contents = b'\n'.join(sections) + b'\n'
-
-  license_header_path = os.path.join(
-      shakaBuildHelpers.get_source_base(), 'build/license-header')
-
-  with open(license_header_path, 'rb') as f:
-    license_header = f.read()
-
-  with open(output, 'wb') as f:
-    f.write(license_header)
-    f.write(b'\n')
-    f.write(contents)
-
-
-def CreateParser():
-  """Create the argument parser for this application."""
-  base = shakaBuildHelpers.get_source_base()
-
-  parser = argparse.ArgumentParser(
-      description=__doc__,
-      formatter_class=argparse.RawDescriptionHelpFormatter)
-
-  parser.add_argument(
-      '--output',
-      type=str,
-      help='The file path for TypeScripts defs output')
-
-  parser.add_argument(
-      'input',
-      type=str,
-      nargs='+',
-      help='The Closure extern files to be converted to TypeScript defs')
-
-  return parser
-
-
-def main(args):
-  parser = CreateParser()
-  args = parser.parse_args(args)
-  GenerateTsDefs(args.input, args.output)
-  return 0
-
-
-if __name__ == '__main__':
-  main(sys.argv[1:])

package/build/install-linux-prereqs.sh

@@ -1,136 +0,0 @@
-#!/bin/bash
-
-# Installs prerequisites for Shaka Player development on Linux:
-#  - Git v1.9+ (to check out the code)
-#  - Python v2.7 (to run the build scripts)
-#  - Java Runtime Environment v8+ (to run the Closure compiler)
-#  - Apache (to serve the Shaka Player demo)
-#  - NodeJS v8+ (to run some build deps, such as jsdoc, karma, etc)
-
-# Tested on:
-#  - Ubuntu 16.04 LTS (Xenial)
-#  - Ubuntu 17.10 (Artful)
-#  - Debian 9 (Stretch)
-#  - gLinux
-
-# Tested with:
-#  - Fresh install, no nodejs/npm
-#  - Standard install of nodejs/npm
-#  - Previous install/upgrade of nodejs/npm through n or nvm
-
-# Not supported:
-#  - Ubuntu 14.04 LTS (Trusty) - Java 7
-#  - Debian 8 (Jessie) - Java 7
-#  - RHEL/CentOS 6 - python 2.6, git 1.7
-#  - RHEL/CentOS 7 - git 1.8
-
-
-# It's best not to run as root or with sudo, because we need to be able to
-# detect node versions installed locally for the user.
-if [[ $EUID == 0 ]]; then
-  echo "*****" 1>&2
-  echo "Please do not run as root." 1>&2
-  echo "This script will use sudo when needed." 1>&2
-  echo "*****" 1>&2
-  exit 1
-fi
-
-# Make sure this is an OS we can support.
-# "which apt" will return success if apt is found.
-if ! which apt &>/dev/null; then
-  echo "*****" 1>&2
-  echo "Could not find apt.  Unsupported Linux distribution!" 1>&2
-  echo "*****" 1>&2
-  exit 1
-fi
-
-# Exit if any command fails.
-set -e
-
-# Install prerequisites other than nodejs.  These package names work for both
-# Ubuntu and Debian, and may work for other derivatives as well.
-echo "*****" 1>&2
-echo "Updating packages and installing git, Python, JRE, and Apache." 1>&2
-echo "*****" 1>&2
-sudo apt -y update
-sudo apt -y install git python2.7 default-jre-headless apache2
-
-# NodeJS in Ubuntu and Debian is often out of date, so we may need to grab a
-# newer version.  We require v8+.
-
-if node --version 2>/dev/null | grep -q 'v\([89]\|1[0-9]\)'; then
-  echo "*****" 1>&2
-  echo "NodeJS v8+ detected.  No update needed." 1>&2
-  echo "*****" 1>&2
-else
-  if node --version &>/dev/null; then
-    echo "*****" 1>&2
-    echo "Old NodeJS version detected: $(node --version)." 1>&2
-    echo "A newer version is needed." 1>&2
-    echo "*****" 1>&2
-    read -r -p "Remove the existing version and install a new one? [Y/n] "
-    if [[ $REPLY =~ ^[Yy] ]] || [[ $REPLY == "" ]]; then
-      echo "*****" 1>&2
-      echo "Removing existing copies of nodejs." 1>&2
-      echo "*****" 1>&2
-
-      # Remove any old packaged copy of nodejs/npm.  Some of these commands may
-      # fail, for example if a package does not exist.  Ignore errors here.
-      sudo apt -y remove --purge nodejs || true
-      sudo apt -y remove --purge nodejs-dev || true
-      sudo apt -y remove --purge npm || true
-      sudo apt -y remove --purge libnode || true
-      sudo apt -y remove --purge libnode64 || true
-      sudo apt -y autoremove || true
-
-      # Remove any old symlinks or other copies.
-      sudo rm -f /usr/local/bin/node{,js} /usr/bin/node{,js}
-      sudo rm -f /usr/local/bin/npm /usr/bin/npm
-
-      # Remove any copies installed by "n".
-      sudo rm -rf /usr/local/n
-      # Remove any copies installed by "nvm".
-      if [[ ! -e "$NVM_DIR" ]]; then
-        NVM_DIR="$HOME/.nvm"
-      fi
-      # Safety check: before wiping out NVM_DIR, make sure it contains nvm.sh,
-      # so we don't somehow get tricked into rm -rf /
-      if [[ -e "$NVM_DIR" ]] && [[ -e "$NVM_DIR"/nvm.sh ]]; then
-        rm -rf "$NVM_DIR"
-        sed -i '/NVM_DIR/d' ~/.bashrc
-      fi
-    else
-      echo "*****" 1>&2
-      echo "You will need to upgrade NodeJS yourself to v8+." 1>&2
-      echo "*****" 1>&2
-      exit 1
-    fi
-  else
-    echo "*****" 1>&2
-    echo "NodeJS not found. We will install an up-to-date version for you." 1>&2
-    echo "*****" 1>&2
-  fi
-
-  available_node_version=$(apt-cache show nodejs \
-      | grep '^Version:' | cut -f 2 -d ' ')
-  available_node_major_version=$(echo "$available_node_version" \
-      | cut -f 1 -d '.')
-  if [ "$available_node_major_version" -gt "8" ]; then
-    sudo apt -y install nodejs npm
-    echo "*****" 1>&2
-    echo "NodeJS v$available_node_version installed from your distro." 1>&2
-    echo "*****" 1>&2
-  else
-    # Fetch a known-good copy of NodeJS from nodesource.com and install it.
-    # NodeJS v10.19.0 has npm v6.13.4.
-    deb_file=$(mktemp --suffix .deb)
-    curl -o "$deb_file" \
-        https://deb.nodesource.com/node_10.x/pool/main/n/nodejs/nodejs_10.19.0-1nodesource1_amd64.deb
-    sudo dpkg -i "$deb_file"
-    rm -f "$deb_file"
-
-    echo "*****" 1>&2
-    echo "NodeJS v10.19 installed from nodesource." 1>&2
-    echo "*****" 1>&2
-  fi
-fi

package/build/license-header

@@ -1,5 +0,0 @@
-/*! @license
- * Shaka Player
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */

package/build/misspellings.txt

@@ -1,39 +0,0 @@
-# A map of a regex to the suggested replacement.  The replacement can include
-# capture groups from the regex and will be ignored if the replacement is the
-# same as the match.
-{
-    r'(?i)arti?fi?ci?ai?l': 'artificial',
-    r'(?i)bandwith': 'bandwidth',
-    r'(?i)cur+ent': 'current',
-    r"(?i)doens?'t": "doesn't",
-    r'(?i)ful+screen': 'fullscreen',
-    r'(?i)futher': 'further',
-    r'(?i)gene?ra?tor': 'generator',
-    r'(?i)(?:(in|)n*)ac+ur+ate': r'\1accurate',
-    r'(?i)in?ter[ai]ble': 'iterable',
-    r'(?i)int(er|re)p(er|re)tation': 'interpretation',
-    r'(?i)langauge': 'language',
-    r'(?i)mananger': 'manager',
-    r'(?i)mani?fe?st': 'manifest',
-    r'(?i)mil+isecond': 'millisecond',
-    r'(?i)oc+ur+(?!ed|ing|ence)': 'occur',
-    r'(?i)oc+ur+(ed|ing|ence)': r'occurr\1',
-    r'(?i)oc+ur+ance': 'occurrence',
-    r'(?i)parrent': 'parent',
-    r'(?i)pol+yfil+': 'polyfill',
-    r'(?i)propogate': 'propagate',
-    r'(?i)refrence': 'reference',
-    r'(?i)substract': 'subtract',
-    # Only match an "s" if it is not part of "spy".
-    r'(?i)suc+e(?:(?!spy)s)+': 'success',
-    r'(?i)suc+es+ful+(?!y)': 'successful',
-    r'(?i)suc+es+ful+y': 'successfully',
-    r'(?i)tol+[ae]r+[ae]nce': 'tolerance',
-    r'(?i)uncomplied': 'uncompiled',
-    r'(?i)udpate': 'update',
-    r'(?i)wether': 'whether',
-    r'(?i)@returns': '@return',
-    r'(?i)varint': 'variant',
-    r'(?i)asynchronus': 'asynchronous',
-    r'(?i)deafult': 'default',
-}

package/build/pixelsChanged.js

@@ -1,35 +0,0 @@
-#!/usr/bin/env node
-/*! @license
- * Shaka Player
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview
- *
- * A node script that uses the Jimp module to compute the number of changed
- * pixels between two images.
- */
-
-const Jimp = require('jimp');
-
-/**
- * Compare two images and output the number of changed pixels.  Uses the same
- * node module as the comparisons done in the tests through Karma.
- *
- * @param {string} oldPath
- * @param {string} newPath
- */
-async function main(oldPath, newPath) {
-  const oldImage = await Jimp.read(oldPath);
-  const newImage = await Jimp.read(newPath);
-  const diff = Jimp.diff(oldImage, newImage, /* threshold= */ 0.07);
-  // "percent" is, surprisingly, a number between 0 and 1, not between 0 and
-  // 100.  Convert this to a number of pixels.
-  const pixelsChanged =
-      diff.percent * diff.image.bitmap.width * diff.image.bitmap.height;
-  console.log(pixelsChanged);
-}
-
-main(process.argv[2], process.argv[3]);