shaka-player 2.5.1 → 2.5.5

package/.csslintrc

@@ -0,0 +1,13 @@
+{
+    "extends": "stylelint-config-standard",
+    "rules": {
+      "font-family-no-missing-generic-family-keyword": null,
+      "declaration-block-single-line-max-declarations": null,
+      "max-line-length": [ 80, {
+        ignorePattern: "/^@import\\s+/",
+      }],
+      "selector-list-comma-newline-after": "never-multi-line",
+      "selector-pseudo-element-colon-notation": "single",
+      "unit-whitelist": ["em", "%", "px", "s", "deg", "vmin", "ms", "vh"]
+    }
+}

package/AUTHORS

@@ -32,7 +32,9 @@ Jonas Birmé <jonas.birme@eyevinn.se>
 Jozef Chúťka <jozefchutka@gmail.com>
 JW Player <*@jwplayer.com>
 Lucas Gabriel Sánchez <unkiwii@gmail.com>
+Matthias Van Parijs <matvp91@gmail.com>
 Mattias Wadman <mattias.wadman@gmail.com>
+Mohamed Rashid <ge_rashid@hotmail.co.uk>
 Morten Hansen <mimo@mimo-design.com>
 Nick Desaulniers <nick@mozilla.com>
 Oskar Arvidsson <oskar@irock.se>
@@ -50,3 +52,4 @@ Tomas Tichy <mr.tichyt@gmail.com>
 Toshihiro Suzuki <t.suzuki326@gmail.com>
 uStudio Inc. <*@ustudio.com>
 Verizon Digital Media Services <*@verizondigitalmedia.com>
+Adrián Gómez Llorente <adgllorente@gmail.com>

package/CHANGELOG.md

@@ -1,3 +1,159 @@
+## 2.5.5 (2019-08-23)
+
+New Features:
+  - Conditionally remove FairPlay formatting
+    - https://github.com/google/shaka-player/issues/1951
+  - Add sessionId field to network request
+  - Make it easier to add custom overflow menu items
+    - https://github.com/google/shaka-player/issues/2091
+  - Add clearBufferOnQualityChange field to UI config
+    - https://github.com/google/shaka-player/issues/1733
+  - Allow filtering out failed HLS text tracks
+    - https://github.com/google/shaka-player/issues/2065
+  - Parse Accessibility tag into text "kind"
+    - https://github.com/google/shaka-player/issues/2060
+  - Re-add MediaSession API
+    - https://github.com/google/shaka-player/issues/1934
+  - Skip WebM streams in HLS instead of throwing
+    - https://github.com/google/shaka-player/issues/2108
+  - Convert `<mspr:pro>` elements to `pssh` init data
+    - https://github.com/google/shaka-player/pull/2106
+    - https://github.com/google/shaka-player/issues/2058
+
+Bugfixes:
+  - Fix duplicate resolution entries in UI menu
+    - https://github.com/google/shaka-player/issues/2085
+  - Fix missing tracks, race on time during startup
+    - https://github.com/google/shaka-player/issues/2045
+  - Fix spinner position on IE11
+    - https://github.com/google/shaka-player/issues/2084
+  - Fix seek bar coloring when nothing buffered
+  - Fix scroll behavior on page load
+    - https://github.com/google/shaka-player/issues/2063
+  - Don't create a UI if the app already has one
+    - https://github.com/google/shaka-player/issues/2073
+  - Fix text display styling when fullscreen
+    - https://github.com/google/shaka-player/issues/2051
+  - Don't enter fullscreen on double click on bottom bar
+    - https://github.com/google/shaka-player/issues/2053
+  - Avoid errors when video ends
+    - https://github.com/google/shaka-player/issues/2050
+  - Fix fullscreen behavior on double click and rotate
+    - https://github.com/google/shaka-player/issues/2043
+  - Fix bug when clicking PIP button while casting
+    - https://github.com/google/shaka-player/issues/2044
+  - Fix CEA captions with multi-Period content
+    - https://github.com/google/shaka-player/issues/2075
+    - https://github.com/google/shaka-player/issues/2094
+
+Demo App:
+  - Added more HLS demo assets
+    - https://github.com/google/shaka-player/issues/2035
+  - Exit PIP on unload in the demo
+    - https://github.com/google/shaka-player/issues/2055
+  - Re-added hidden 'noinput' param to demo
+
+
+## 2.5.4 (2019-07-19)
+
+Bugfixes:
+  - Default to transparent SMPTE-TT subtitle background
+    - https://github.com/google/shaka-player/pull/2033
+  - Fix seek bar on iOS
+    - https://github.com/google/shaka-player/issues/1918
+    - https://github.com/google/shaka-player/pull/2036
+  - Allow whitespace in TTML subtitles
+    - https://github.com/google/shaka-player/issues/2028
+    - https://github.com/google/shaka-player/pull/2030
+  - Fix play button positioning on IE 11
+    - https://github.com/google/shaka-player/issues/2026
+  - Match UI style with Chrome's native controls
+  - Stop constant spurious time updates in UI
+  - Fix volume slider jumping around while casting
+    - https://github.com/google/shaka-player/issues/1913
+  - Fix missing seek bar in short VOD clips
+    - https://github.com/google/shaka-player/issues/2018
+  - Fix demo app in Firefox private mode
+    - https://github.com/google/shaka-player/issues/1926
+  - Ignore case in MIME type checks
+    - https://github.com/google/shaka-player/issues/1991
+  - Fix problems with casting
+    - https://github.com/google/shaka-player/issues/1948
+
+New Features:
+  - Add command-line arg to change the test timeout.
+
+
+## 2.5.3 (2019-07-03)
+
+Bugfixes:
+  - Fix DASH bug when ignoring minBufferTime
+    - https://github.com/google/shaka-player/issues/2015
+  - Avoid changing variant when switching text lang
+    - https://github.com/google/shaka-player/issues/2010
+  - Work around platform bug when seeking to end
+    - https://github.com/google/shaka-player/issues/1967
+  - Allow apps to extend shaka.ui.Element
+    - https://github.com/google/shaka-player/issues/2011
+  - Fix bug when adding text streams while not streaming text
+    - https://github.com/google/shaka-player/issues/1938
+  - Fix edge case when switching text in multi-Period content
+    - https://github.com/google/shaka-player/issues/1774
+  - Fix playback rate bug on IE11
+  - Make fast forwarding work when video is paused
+    - https://github.com/google/shaka-player/issues/1801
+  - Fix stack overflow in StringUtils on some platforms
+    - https://github.com/google/shaka-player/issues/1985
+    - https://github.com/google/shaka-player/issues/1994
+  - Fix reading customData from standard Cast LOAD message
+    - https://github.com/google/shaka-player/issues/1989
+
+Docs:
+  - Fix constant name in UI tutorials
+    - https://github.com/google/shaka-player/issues/2005
+  - Update build output name in docs
+    - https://github.com/google/shaka-player/issues/1929
+
+New Features:
+  - Use trick play for fast forward when browser doesn't support high
+    playbackRate
+    - https://github.com/google/shaka-player/issues/1957
+
+
+## 2.5.2 (2019-06-10)
+
+Bugfixes:
+  - Avoid event listener leaks in the UI
+    - https://github.com/google/shaka-player/issues/1924
+  - Fix style errors in TextDisplayer
+    - https://github.com/google/shaka-player/issues/1852
+    - https://github.com/google/shaka-player/issues/1955
+  - Show spinner when buffering even if other controls are hidden
+    - https://github.com/google/shaka-player/issues/1921
+  - Don't recreate controls object on configure() calls
+    - https://github.com/google/shaka-player/issues/1948
+  - Fix UI compilation on Windows
+    - https://github.com/google/shaka-player/issues/1965
+
+New Features:
+  - Add originalUri as a property on shaka.extern.Response
+    - https://github.com/google/shaka-player/issues/1971
+    - https://github.com/google/shaka-player/pull/1972
+
+Demo App:
+  - Fix close button styling in compiled mode
+  - Fix config settings applied before playback begins
+    - https://github.com/google/shaka-player/issues/1976
+  - Change the style of the download/delete button
+  - Fix demo error display for large errors
+  - Improve cvox error check
+  - Switch to using tippy.js for tooltips
+
+Docs:
+  - Add a public roadmap document
+    - https://github.com/google/shaka-player/blob/master/roadmap.md
+
+
 ## 2.5.1 (2019-05-20)
 
 New Features:

package/CONTRIBUTORS

@@ -51,9 +51,11 @@ Jozef Chúťka <jozefchutka@gmail.com>
 Leandro Ribeiro Moreira <leandro.ribeiro.moreira@gmail.com>
 Lucas Gabriel Sánchez <unkiwii@gmail.com>
 Matias Russitto <russitto@gmail.com>
+Matthias Van Parijs <matvp91@gmail.com>
 Mattias Wadman <mattias.wadman@gmail.com>
 Michelle Zhuo <michellezhuo@google.com>
 Miloš Rašić <milos.rasic@gmail.com>
+Mohamed Rashid <ge_rashid@hotmail.co.uk>
 Morten Hansen <mimo@mimo-design.com>
 Natalie Harris <natalieharris@google.com>
 Nick Desaulniers <nick@mozilla.com>
@@ -82,3 +84,4 @@ Toshihiro Suzuki <t.suzuki326@gmail.com>
 Vasanth Polipelli <vasanthap@google.com>
 Vignesh Venkatasubramanian <vigneshv@google.com>
 Yohann Connell <robinconnell@google.com>
+Adrián Gómez Llorente <adgllorente@gmail.com>

package/README.md

@@ -14,6 +14,8 @@ video and audio using modern browser technologies. We try to keep the library
 light, simple, and free from third-party dependencies. Everything you need to
 build and deploy is in the sources.
 
+For details on what's coming next, see our [development roadmap](roadmap.md).
+
 [DASH]: http://dashif.org/
 [HLS]: https://developer.apple.com/streaming/
 [MediaSource Extensions]: https://www.w3.org/TR/media-source/
@@ -164,6 +166,7 @@ attributes.
 
 ## Important Links ##
 
+ * [development roadmap](roadmap.md)
  * [hosted demo](http://shaka-player-demo.appspot.com) (sources in `demo/`)
  * [hosted builds on cdnjs](https://cdnjs.com/libraries/shaka-player)
  * [hosted builds on Google Hosted Libraries](https://developers.google.com/speed/libraries/#shaka-player)

package/build/README.md

@@ -32,10 +32,10 @@ java -jar /path/to/shaka/third_party/closure/compiler.jar --language_in ...
 
 `build.py` is used to compile the library and can also be used to produce
 customized builds that contain only the features that your app requires.
-`build.py` accepts an optional argument `--name` which will set the name of
-the build, defaulting to `compiled`.  All other arguments are treated as
-commands describing what to include in the build.  If nothing is given, it
-will use `+@complete`.
+`build.py` accepts an optional argument `--name` which will set the name of the
+build, defaulting to `ui`.  All other arguments are treated as commands
+describing what to include in the build.  If nothing is given, it will use
+`+@complete`.
 
 A command is either an addition or a subtraction.  An addition is prefixed with
 a `+`; a subtraction with a `-`.  An addition will add the JavaScript file (or
@@ -108,7 +108,7 @@ used internally to determine dependencies and to determine the size of the
 compiled library.
 
 Before running the script, you have to compile it first.  Then you need to pass
-either the name of the build (e.g. `compiled`) or the path to the `.map` file.
+either the name of the build (e.g. `ui`) or the path to the `.map` file.
 You will also need to pass some arguments to determine the output you want.
 You must pass exactly one of the following:
 

package/build/apps.py

@@ -53,6 +53,8 @@ def compile_demo(force, is_debug):
   files.remove(os.path.join(base, 'demo', 'load.js'))
   # Remove service_worker.js as well.  This executes in a different context.
   files.remove(os.path.join(base, 'demo', 'service_worker.js'))
+  # Don't compile in the uncompiled require file.
+  files.remove(os.path.join(base, 'demo', 'demo_uncompiled.js'))
   # Add lib/debug/asserts.js, which is required for goog.assert.
   # TODO: This file should be inside third_party/closure instead.
   files.add(os.path.join(base, 'lib', 'debug', 'asserts.js'))
@@ -107,7 +109,6 @@ def compile_receiver(force, is_debug):
   files = set(get('demo', 'common') +
               get('demo', 'cast_receiver') +
               get('externs') + get('ui', 'externs') +
-              get('lib', 'debug') +
               get('third_party', 'closure'))
 
   # Add in the generated externs, so that the receiver compilation knows the
@@ -116,6 +117,7 @@ def compile_receiver(force, is_debug):
              else 'shaka-player.ui.externs.js')
 
   files.add(os.path.join(base, 'dist', externs))
+  files.add(os.path.join(base, 'lib', 'debug', 'asserts.js'))
 
   name = 'receiver.compiled' + ('.debug' if is_debug else '')
 

package/build/build.py

@@ -169,12 +169,14 @@ class Build(object):
     core_files = core_build.include
     if self.exclude & core_files:
       logging.error('Cannot exclude files from core')
+      return False
     self.include |= core_files
+    return True
 
   def has_ui(self):
     """Returns True if the UI library is in the build."""
     for path in self.include:
-      if '/ui/' in path:
+      if 'ui' in path.split(os.path.sep):
         return True
     return False
 
@@ -264,7 +266,8 @@ class Build(object):
       True on success; False on failure.
     """
     self.add_closure()
-    self.add_core()
+    if not self.add_core():
+      return False
     if self.has_ui():
       self.generate_localizations(locales, force)
 

package/build/check.py

@@ -54,6 +54,22 @@ def check_js_lint(args):
   return linter.lint(fix=args.fix, force=args.force)
 
 
+def check_css_lint(args):
+  """Runs the CSS linter."""
+  logging.info('Linting CSS...')
+
+  match = re.compile(r'.*\.(less|css)$')
+  base = shakaBuildHelpers.get_source_base()
+  def get(*path_components):
+    return shakaBuildHelpers.get_all_files(
+        os.path.join(base, *path_components), match)
+  files = (get('ui') + get('demo'));
+  config_path = os.path.join(base, '.csslintrc')
+
+  linter = compiler.CssLinter(files, config_path)
+  return linter.lint(fix=args.fix, force=args.force)
+
+
 def check_html_lint(args):
   """Runs the HTML linter."""
   logging.info('Linting HTML...')
@@ -169,6 +185,7 @@ def main(args):
   steps = [
       check_js_lint,
       check_html_lint,
+      check_css_lint,
       check_complete,
       check_tests,
   ]

package/build/compiler.py

@@ -21,6 +21,7 @@ import os
 import re
 import shutil
 import subprocess
+import sys
 
 import generateLocalizations
 import shakaBuildHelpers
@@ -55,6 +56,14 @@ def _must_build(output, source_files):
     # Some input files have changed, so we should build again.
     return True
 
+  # Look at all the Python modules that are loaded.  If any of them have
+  # changed, it may affect the build.
+  this_path = os.path.dirname(os.path.abspath(__file__))
+  for module in sys.modules.values():
+    path = getattr(module, '__file__', None)
+    if path and os.path.exists(path) and os.path.getmtime(path) > build_time:
+      return True
+
   logging.warning('No changes detected, skipping. Use --force to override.')
   return False
 
@@ -297,6 +306,46 @@ class Linter(object):
     return True
 
 
+class CssLinter(object):
+  def __init__(self, source_files, config_path):
+    self.source_files = _canonicalize_source_files(source_files)
+    self.config_path = config_path
+    self.output = _get_source_path('dist/.csslintstamp')
+
+  def lint(self, fix=False, force=False):
+    """Run CSS linter checks on the files in |self.source_files|.
+
+    Args:
+      fix: If True, ask the linter to fix what errors it can automatically.
+      force: Run linter checks even if the inputs have not changed.
+
+    Returns:
+      True on success; False on failure.
+    """
+    deps = self.source_files + [self.config_path]
+    if not force and not _must_build(self.output, deps):
+      return True
+
+    stylelint = shakaBuildHelpers.get_node_binary('stylelint')
+    cmd_line = stylelint + ['--config', self.config_path] + self.source_files
+    # Disables globbing, since that messes up our nightly tests, and we don't
+    # use it anyway.
+    # This is currently a flag added in a fork we maintain, but there is a pull
+    # request in progress for this.
+    # See: https://github.com/stylelint/stylelint/issues/4193
+    cmd_line += ['--disable-globbing'];
+
+    if fix:
+      cmd_line += ['--fix']
+
+    if shakaBuildHelpers.execute_get_code(cmd_line) != 0:
+      return False
+
+    # Update the timestamp of the file that tracks when we last updated.
+    _update_timestamp(self.output)
+    return True
+
+
 class HtmlLinter(object):
   def __init__(self, source_files, config_path):
     self.source_files = _canonicalize_source_files(source_files)

package/build/conformance.textproto

@@ -107,6 +107,7 @@ requirement: {
   error_message: 'Using "console" is not allowed; '
                  'use shaka.log instead'
   whitelist_regexp: 'demo/'
+  whitelist_regexp: 'lib/debug/log.js'
   whitelist_regexp: 'third_party/closure/'
   whitelist_regexp: 'test/test/boot.js'
 }

package/build/docs.py

@@ -50,11 +50,5 @@ def main(args):
   return 0
 
 
-# TODO: Remove this alias.  It is here for backward compatibility until private
-# scripts depending on it can be updated.
-def build_docs(args):
-  return main(args)
-
-
 if __name__ == '__main__':
   shakaBuildHelpers.run_main(main)

package/build/generateExterns.js

@@ -48,14 +48,6 @@ const fs = require('fs');
 // The annotations we will consider "exporting" a symbol.
 const EXPORT_REGEX = /@(?:export|exportInterface|expose)\b/;
 
-// Install ES6/ES7 polyfills for old versions of nodejs.
-if (!global.Set) {
-  require('es6-shim');
-}
-if (!Array.prototype.includes) {
-  require('array-includes').shim();
-}
-
 
 /**
  * Topological sort of general objects using a DFS approach.
@@ -370,9 +362,18 @@ function createExternFromExportNode(names, node) {
 
   // Find this.foo = bar in the constructor, and potentially generate externs
   // for that, too.
-  if (node.expression.type == 'AssignmentExpression' &&
-      comment.includes('@constructor')) {
-    externString += createExternsFromConstructor(name, node.expression.right);
+  if (node.expression.type == 'AssignmentExpression') {
+    const rightSide = node.expression.right;
+
+    if (rightSide.type == 'FunctionExpression' &&
+        comment.includes('@constructor')) {
+      externString += createExternsFromConstructor(name, rightSide);
+    } else if (rightSide.type == 'ClassExpression') {
+      const ctor = getClassConstructor(node.expression.right);
+      if (ctor) {
+        externString += createExternsFromConstructor(name, ctor);
+      }
+    }
   }
   return externString;
 }
@@ -393,18 +394,65 @@ function createExternMethod(node) {
   //   value: FunctionExpression,
   // }
   let comment = getLeadingBlockComment(node);
+  const id = getIdentifierString(node.key);
+  if (!comment) {
+    if (id == 'constructor') {
+      // ES6 constructors don't necessarily need comments; a comment along the
+      // lines of "Creates a Foo object." doesn't really add anything.
+      comment = '';
+    } else {
+      throw new Error('No leading block comment for: ' + id);
+    }
+  }
   comment = removeExportAnnotationsFromComment(comment);
 
   const params = getFunctionParameters(node.value);
-  const id = getIdentifierString(node.key);
 
-  let methodString = '  ' + comment + '\n  ';
-  if (node.static) methodString += 'static ';
+  let methodString = (comment ? '  ' + comment + '\n' : '') + '  ';
+  if (node.static) {
+    methodString += 'static ';
+  }
   methodString += id + '(' + params + ') {}';
   return methodString;
 }
 
 
+/**
+ * Find the constructor of an ES6 class, if it exists.
+ *
+ * @param {ASTNode} className
+ * @return {ASTNode}
+ */
+function getClassConstructor(classNode) {
+  // Example class node: {
+  //   type: 'ClassExpression',
+  //   body: {
+  //     type: 'ClassBody',
+  //     body: [ MethodDefinition, ... ],
+  //   }
+  // }
+  //
+  // Example method node: {
+  //   type: 'MethodDefinition',
+  //   key: { type: 'Identifier', name: 'constructor' },
+  //   value: {
+  //     type: 'FunctionExpression',
+  //     params: [ [Identifier], [Identifier], [Identifier] ],
+  //     body: { type: 'BlockStatement', body: [Array] },
+  // }
+
+  console.assert(classNode.type == 'ClassExpression');
+
+  for (const member of classNode.body.body) {
+    if (member.type == 'MethodDefinition' && member.key.name == 'constructor') {
+      return member.value;
+    }
+  }
+
+  return null;
+}
+
+
 /**
  * @param {string} name The name of the thing we are assigning.
  * @param {ASTNode} node An assignment node from the abstract syntax tree.
@@ -508,19 +556,23 @@ function createExternsFromConstructor(className, constructorNode) {
   // /** @exportInterface @type {number} */
   // FooLike.prototype.bar;
   //
-  // /** @constructor @export @implements {FooLike} */
-  // Foo = function() {
-  //   /** @override @exportInterface */
-  //   this.bar = 10;
+  // /** @export @implements {FooLike} */
+  // class Foo {
+  //   constructor() {
+  //     /** @override @exportInterface */
+  //     this.bar = 10;
+  //   }
   // };
   //
   // Example externs:
   //
   // /**
   //  * Generated by createExternFromExportNode:
-  //  * @constructor @implements {FooLike}
+  //  * @implements {FooLike}
   //  */
-  // Foo = function() {}
+  // class Foo {
+  //   constructor() {}
+  // }
   //
   // /**
   //  * Generated by createExternsFromConstructor:

package/build/install-linux-prereqs.sh

@@ -56,11 +56,11 @@ 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 v6+.
+# newer version.  We require v8+.
 
-if node --version 2>/dev/null | grep -q 'v\([6-9]\|1[0-9]\)'; then
+if node --version 2>/dev/null | grep -q 'v\([89]\|1[0-9]\)'; then
   echo "*****" 1>&2
-  echo "NodeJS v6+ detected.  No update needed." 1>&2
+  echo "NodeJS v8+ detected.  No update needed." 1>&2
   echo "*****" 1>&2
 else
   if node --version &>/dev/null; then
@@ -99,7 +99,7 @@ else
       fi
     else
       echo "*****" 1>&2
-      echo "You will need to upgrade NodeJS yourself to v6+." 1>&2
+      echo "You will need to upgrade NodeJS yourself to v8+." 1>&2
       echo "*****" 1>&2
       exit 1
     fi

package/build/shakaBuildHelpers.py

@@ -20,6 +20,8 @@ This uses two environment variables to help with debugging the scripts:
   RAISE_INTERRUPT - Will raise keyboard interrupts rather than swallowing them.
 """
 
+from __future__ import print_function
+
 import errno
 import json
 import logging
@@ -286,7 +288,7 @@ def update_node_modules():
   # Check the version of npm.
   version = execute_get_output([cmd, '-v']).decode('utf8')
 
-  if _parse_version(version) < _parse_version('1.3.12'):
+  if _parse_version(version) < _parse_version('5.0.0'):
     logging.error('npm version is too old, please upgrade.  e.g.:')
     logging.error('  npm install -g npm')
     return False
@@ -295,12 +297,9 @@ def update_node_modules():
   # Actually change directories instead of using npm --prefix.
   # See npm/npm#17027 and google/shaka-player#776 for more details.
   with InDir(base):
-    if _parse_version(version) >= _parse_version('5.0.0'):
-      # npm update seems to be the wrong thing in npm v5, so use install.
-      # See google/shaka-player#854 for more details.
-      execute_get_output([cmd, 'install'])
-    else:
-      execute_get_output([cmd, 'update'])
+    # npm update seems to be the wrong thing in npm v5, so use install.
+    # See google/shaka-player#854 for more details.
+    execute_get_output([cmd, 'install'])
 
   # Update the timestamp of the file that tracks when we last updated.
   open(_node_modules_last_update_path(), 'w').close()
@@ -324,6 +323,6 @@ def run_main(main):
   except KeyboardInterrupt:
     if os.environ.get('RAISE_INTERRUPT'):
       raise
-    print >> sys.stderr  # Clear the current line that has ^C on it.
+    print(file=sys.stderr)  # Clear the current line that has ^C on it.
     logging.error('Keyboard interrupt')
     sys.exit(1)