shaka-player 4.0.2 → 4.0.5

package/test/util/string_utils_unit.js

@@ -5,6 +5,29 @@
  */
 
 describe('StringUtils', () => {
+  describe('with TextDecoder', () => {
+    if (window.TextDecoder) {
+      defineStringUtilTests();
+    }
+  });
+
+  describe('without TextDecoder', () => {
+    let originalTextDecoder;
+
+    beforeAll(() => {
+      originalTextDecoder = window.TextDecoder;
+      window['TextDecoder'] = null;
+    });
+
+    afterAll(() => {
+      window.TextDecoder = originalTextDecoder;
+    });
+
+    defineStringUtilTests();
+  });
+});
+
+function defineStringUtilTests() {
   const StringUtils = shaka.util.StringUtils;
 
   it('parses fromUTF8', () => {
@@ -16,19 +39,34 @@ describe('StringUtils', () => {
   });
 
   it('won\'t break if given cut-off UTF8 character', () => {
-    // This array contains the first half of a 2-byte UTF8 character, stranded
-    // at the very end of the string.
-    const arr1 = [0x53, 0x61, 0x6e, 0x20, 0x4a, 0x6f, 0x73, 0x81];
+    const arr1 = [0x53, 0x61, 0x6e, 0x20, 0x4a, 0x6f, 0x73, 0xc3, 0xa9];
     expect(StringUtils.fromUTF8(new Uint8Array(arr1)))
+        .toBe('San Jos\u00E9');
+
+    // This array contains the first half of a 2-byte UTF8 character
+    // (0xc3 0xa9 = é).  The half-character is stranded at the very end of the
+    // string.
+    const arr = [0x53, 0x61, 0x6e, 0x20, 0x4a, 0x6f, 0x73, 0xc3];
+    expect(StringUtils.fromUTF8(new Uint8Array(arr)))
         .toBe('San Jos\uFFFD');
+  });
 
-    // For reasons I don't know, it seems like 0xE9 cannot be the start of a
-    // UTF8 character.  Perhaps it is a reserved number?
-    const arr2 = [0x4a, 0x6f, 0x73, 0xE9, 0x33, 0x33, 0x20, 0x53, 0x61, 0x6e];
-    expect(StringUtils.fromUTF8(new Uint8Array(arr2)))
+  it('won\'t break if given an invalid UTF-8 sequence', () => {
+    // 0xe9 0x33 0x33 is an invalid UTF-8 sequence.
+    const arr = [0x4a, 0x6f, 0x73, 0xE9, 0x33, 0x33, 0x20, 0x53, 0x61, 0x6e];
+    expect(StringUtils.fromUTF8(new Uint8Array(arr)))
         .toBe('Jos\uFFFD33 San');
   });
 
+  it('can handle an 8-byte character', () => {
+    // This is the UTF-8 encoding of the US flag emoji.
+    // It decodes into two Unicode codepoints, which becomes 4 JavaScript
+    // UTF-16 characters.
+    const arr = [0xf0, 0x9f, 0x87, 0xba, 0xf0, 0x9f, 0x87, 0xb8];
+    expect(StringUtils.fromUTF8(new Uint8Array(arr)))
+        .toBe('\uD83C\uDDFA\uD83C\uDDF8');
+  });
+
   it('strips the BOM in fromUTF8', () => {
     // This is 4 Unicode characters, the last will be split into a surrogate
     // pair.
@@ -125,4 +163,4 @@ describe('StringUtils', () => {
     expect(StringUtils.fromUTF16(buffer, true).length)
         .toBe(buffer.byteLength / 2);
   });
-});
+}

package/ui/text_selection.js

@@ -111,11 +111,11 @@ shaka.ui.TextSelection = class extends shaka.ui.SettingsMenu {
   onCaptionStateChange_() {
     if (this.player.isTextTrackVisible()) {
       this.icon.textContent =
-          shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS_OFF;
+          shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS;
       this.button.ariaPressed = 'true';
     } else {
       this.icon.textContent =
-          shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS;
+          shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS_OFF;
       this.button.ariaPressed = 'false';
     }
 

package/app-engine/README.md

@@ -1,9 +0,0 @@
-# Google App Engine Code
-
-This folder contains source code for the services we run on Google App Engine
-(appspot.com).
-
- - shaka-player-demo: Our hosted demo on https://shaka-player-demo.appspot.com/
-
- - demo-version-index: An index of Shaka Player releases and demos, hosted at
-                       https://index-dot-shaka-player-demo.appspot.com/

package/app-engine/demo-version-index/README.md

@@ -1,14 +0,0 @@
-# Google App Engine Version Index
-
-This folder contains everything necessary to host an index of Shaka Player
-releases and demos at https://index-dot-shaka-player-demo.appspot.com/
-
- - app.yaml: App Engine config file.  Defines the runtime (Python 3).
-
- - generate.py: A python script that generates the index's static content from
-                a template.
-
- - requirements.txt: Used by App Engine to install the necessary Python server
-                     requirements (Flask).
-
- - templates/index.html: A Jinja2 template used to generate the index HTML.

package/app-engine/demo-version-index/app.yaml

@@ -1,28 +0,0 @@
-# Copyright 2022 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.
-
-runtime: python39
-default_expiration: 1h
-
-handlers:
-# Server static/index.html as the root.
-- url: /
-  secure: always
-  static_files: static/index.html
-  upload: static/index.html
-# Any other requests are served from the static/ folder.
-- url: /(.+)
-  secure: always
-  static_files: static/\1
-  upload: static/.+

package/app-engine/demo-version-index/generate.py

@@ -1,164 +0,0 @@
-#!/usr/bin/env python3
-
-# Shaka Player Version Index Generator
-# Copyright 2022 Google LLC
-# SPDX-License-Identifier: Apache-2.0
-
-# Generate an index of Shaka Player versions on appspot.
-
-import collections
-import jinja2
-import os
-import re
-import subprocess
-
-DEMO_URL_TEMPLATE = 'https://{0}-dot-shaka-player-demo.appspot.com/'
-
-# In Google Hosted Libraries
-HOSTED_URL_TEMPLATE = 'https://ajax.googleapis.com/ajax/libs/shaka-player/{0}/shaka-player.{1}'
-
-# Before Google Hosted Libraries, v1 appspot URLs
-V1_URL_TEMPLATE = 'https://{0}-dot-shaka-player-demo.appspot.com/shaka-player.{1}'
-# Before Google Hosted Libraries, v2 appspot URLs
-V2_URL_TEMPLATE = 'https://{0}-dot-shaka-player-demo.appspot.com/dist/shaka-player.{1}'
-
-def version_to_demo_url(v):
-  return DEMO_URL_TEMPLATE.format(v.replace('.', '-'))
-
-def version_to_lib_url(v):
-  if v == 'nightly':
-    return V2_URL_TEMPLATE.format(v, 'compiled.js')
-  elif (version_key(v) == version_key('v1.6.5') or
-      version_key(v) >= version_key('v2.0.6')):
-    return HOSTED_URL_TEMPLATE.format(v.replace('v', ''), 'compiled.js')
-  elif version_key(v) >= version_key('v2.0.0-beta'):
-    return V2_URL_TEMPLATE.format(v.replace('.', '-'), 'compiled.js')
-  else:
-    return V1_URL_TEMPLATE.format(v.replace('.', '-'), 'compiled.js')
-
-def version_to_ui_lib_url(v):
-  if v == 'nightly':
-    return V2_URL_TEMPLATE.format(v, 'ui.js')
-  elif version_key(v) >= version_key('v2.5.0'):
-    return HOSTED_URL_TEMPLATE.format(v.replace('v', ''), 'ui.js')
-  else:
-    return None
-
-def version_to_lib_externs_url(v):
-  if v == 'nightly':
-    return V2_URL_TEMPLATE.format(v, 'compiled.externs.js')
-  elif version_key(v) >= version_key('v2.0.6'):
-    return HOSTED_URL_TEMPLATE.format(v.replace('v', ''), 'compiled.externs.js')
-  else:
-    return None
-
-def version_to_ui_lib_externs_url(v):
-  if v == 'nightly':
-    return V2_URL_TEMPLATE.format(v, 'ui.externs.js')
-  elif version_key(v) >= version_key('v2.5.0'):
-    return HOSTED_URL_TEMPLATE.format(v.replace('v', ''), 'ui.externs.js')
-  else:
-    return None
-
-def version_to_lib_defs_url(v):
-  if v == 'nightly':
-    return V2_URL_TEMPLATE.format(v, 'compiled.d.ts')
-  elif version_key(v) >= version_key('v3.0.6'):
-    return HOSTED_URL_TEMPLATE.format(v.replace('v', ''), 'compiled.d.ts')
-  else:
-    return None
-
-def version_to_ui_lib_defs_url(v):
-  if v == 'nightly':
-    return V2_URL_TEMPLATE.format(v, 'ui.d.ts')
-  elif version_key(v) >= version_key('v3.0.6'):
-    return HOSTED_URL_TEMPLATE.format(v.replace('v', ''), 'ui.d.ts')
-  else:
-    return None
-
-def version_to_metadata(v):
-  return {
-    'version': v,
-    'best': False,  # Corrected later in another loop
-    'demo': version_to_demo_url(v),
-    'lib': version_to_lib_url(v),
-    'ui_lib': version_to_ui_lib_url(v),
-    'lib_externs': version_to_lib_externs_url(v),
-    'ui_lib_externs': version_to_ui_lib_externs_url(v),
-    'lib_defs': version_to_lib_defs_url(v),
-    'ui_lib_defs': version_to_ui_lib_defs_url(v),
-  }
-
-def is_release_tag(name):
-  matches = re.match(r'v\d+\.\d+\.\d+(-.+)?', name)
-  # Doesn't match, not a version tag.
-  if not matches:
-    return False
-  # A "master" (old) or "main" (new) tag, indicating the state of the main
-  # branch at the time of a release.  Not an actual version in itself, though.
-  if matches.group(1) == '-master' or matches.group(1) == '-main':
-    return False
-  # For historical reasons, these oldest few tags are not currently deployed to
-  # appengine.  All other matching tags are, though.
-  if name in ['v1.2.0', 'v1.2.1', 'v1.2.2', 'v1.2.3']:
-    return False
-  return True
-
-def version_key(version):
-  if version == 'nightly':
-    # A false version number for nightly, greater than any actual release
-    # version.
-    return [float('inf')]
-
-  assert version[0] == 'v'
-  main_version, _, suffix = version[1:].partition('-')
-  if not suffix:
-    suffix = '}}}'  # this puts main releases after prerelease versions
-  version_tuple = [int(x) for x in main_version.split('.')]
-  return version_tuple + [suffix]
-
-def get_release_tags():
-  output = subprocess.check_output(['git', 'tag'], text=True)
-  return list(filter(is_release_tag, output.split('\n')))
-
-def generate():
-  # Get all release tags.
-  versions = get_release_tags()
-  # Now sort, putting prerelease versions ahead of the corresponding release.
-  versions.sort(key=version_key)
-
-  version_metadata = collections.OrderedDict()
-  latest_by_branch = {}
-  for v in versions:
-    version_metadata[v] = version_to_metadata(v)
-
-    # Because |versions| is already sorted, we can just overwrite the entry
-    # in the latest_by_branch dictionary.
-    branch_key = tuple(version_key(v)[0:2])
-    latest_by_branch[branch_key] = v
-
-  for v in latest_by_branch.values():
-    version_metadata[v]['best'] = True
-
-  # Append nightly rather than filter for it, so that it always appears at the
-  # end of the list.
-  version_metadata['nightly'] = version_to_metadata('nightly')
-  version_metadata['nightly']['best'] = True
-
-  # Debug: uncomment to see a list of version metadata objects.
-  #for i in version_metadata.values(): print(i)
-
-  script_path = os.path.dirname(__file__)
-  template_path = os.path.join(script_path, 'templates', 'index.html')
-  output_path = os.path.join(script_path, 'static', 'index.html')
-
-  os.makedirs(os.path.dirname(output_path), exist_ok=True)
-
-  with open(template_path, 'r') as template_file:
-    with open(output_path, 'w') as output_file:
-      template = jinja2.Template(template_file.read())
-      output = template.render(versions=version_metadata.values())
-      output_file.write(output)
-
-if __name__ == '__main__':
-  generate()

package/app-engine/demo-version-index/main.py

@@ -1,11 +0,0 @@
-# Shaka Player Version Index - Appspot Entrypoint
-# Copyright 2022 Google LLC
-# SPDX-License-Identifier: Apache-2.0
-
-# In the App Engine Python 3 runtime, you must have an entrypoint, even if all
-# content is static and no routes are defined.  This seems pretty weird, and
-# wasn't required in the Python 2 runtime.
-
-from flask import Flask
-
-app = Flask(__name__)

package/app-engine/demo-version-index/requirements.txt

@@ -1,5 +0,0 @@
-# Shaka Player Version Index - Appspot Python Runtime Requirements
-# Copyright 2022 Google LLC
-# SPDX-License-Identifier: Apache-2.0
-
-Flask==2.0.3

package/app-engine/demo-version-index/templates/index.html

@@ -1,114 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Shaka Player Demo - Version Index</title>
-    <style>
-
-#background {
-  top: 0;
-  left: 0;
-  bottom: 0;
-  right: 0;
-  position: fixed;
-  z-index: -1;
-
-  background:
-    url(https://shaka-player-demo.appspot.com/assets/poster.jpg)
-    no-repeat center center fixed;
-  background-size: contain;
-
-  opacity: 0.4;
-  filter: sepia(50%);
-}
-
-#links {
-  margin: 20px;
-}
-
-#links a {
-  margin: 0.5em;
-  padding: 0.5em;
-
-  border: 2px solid black;
-  background-color: #006;
-
-  font-size: 110%;
-  color: white;
-  font-weight: bold;
-  text-decoration: none;
-}
-
-table.best tr.old {
-  display: none;
-}
-
-th, td {
-  border: 1px solid black;
-  padding: 0.2em 2em;
-}
-
-table.best tr.best-even,
-table.all tr:nth-child(2n) {
-  background-color: rgba(0,0,0,0.1);
-}
-
-    </style>
-    <script>
-      function display(which) {
-        table.class = 'which';
-      }
-    </script>
-  </head>
-  <body>
-    <div id="background"></div>
-
-    <h1>Shaka Player release demos on appspot</h1>
-
-    <div id="links">
-      <a href="#" onclick="table.className = 'best'">Best versions</a>
-      <a href="#" onclick="table.className = 'all'">All versions</a>
-    </div>
-
-    <table id="table" class="best">
-      <tr><th>Version</th></tr>
-      {% set best_counter = 0 %}
-      {% for v in versions %}
-      {% if v.best %}
-      <tr class="best {{'best-even' if best_counter % 2 == 0 else ''}}">
-      {% set best_counter = best_counter + 1 %}
-      {% else %}
-      <tr class="old">
-      {% endif %}
-        <th>{{ v.version }}</th>
-        <td><a href="{{ v.demo }}">demo</a></td>
-        <td><a href="{{ v.lib }}">non-UI library</a></td>
-        <td>
-          {% if v.ui_lib %}
-          <a href="{{ v.ui_lib }}">UI-enabled library</a>
-          {% endif %}
-        </td>
-        <td>
-          {% if v.lib_externs %}
-          <a href="{{ v.lib_externs }}">non-UI externs</a>
-          {% endif %}
-        </td>
-        <td>
-          {% if v.ui_lib_externs %}
-          <a href="{{ v.ui_lib_externs }}">UI-enabled externs</a>
-          {% endif %}
-        </td>
-        <td>
-          {% if v.lib_defs %}
-          <a href="{{ v.lib_defs }}">non-UI typescript defs</a>
-          {% endif %}
-        </td>
-        <td>
-          {% if v.ui_lib_defs %}
-          <a href="{{ v.ui_lib_defs }}">UI-enabled typescript defs</a>
-          {% endif %}
-        </td>
-      </tr>
-      {% endfor %}
-    </table>
-  </body>
-</html>

package/app-engine/shaka-player-demo/README.md

@@ -1,18 +0,0 @@
-# Google App Engine Demo
-
-This folder contains everything necessary to host our demo on
-https://shaka-player-demo.appspot.com/
-
- - app.yaml: App Engine config file.  Defines cache expiration and how specific
-             URLs are mapped to specific files.
-
- - main.py: A catch-all python service to serve any non-static files.  This
-            handles HTTP redirects for the root path (this is the only way to
-            do HTTP redirects in App Engine) and the poster service (which
-            returns special poster images on certain days).
-
- - requirements.txt: Used by App Engine to install the necessary Python server
-                     requirements (Flask).
-
- - time.txt: A static file used for time sync in the client.  Configured with
-             special response headers for cross-origin access.

package/app-engine/shaka-player-demo/app.yaml

@@ -1,61 +0,0 @@
-# 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.
-
-runtime: python39
-default_expiration: 5m
-
-handlers:
-# A static file used for clock sync in the demo app
-- url: /time.txt
-  static_files: time.txt
-  upload: time.txt
-  expiration: 0
-  http_headers:
-    Access-Control-Allow-Origin: "*"
-    Access-Control-Allow-Headers: "If-Modified-Since,Range,Origin"
-    Access-Control-Expose-Headers: "Date"
-    Access-Control-Max-Age: "2592000"
-
-# These used to exist in the repo, but have been generated server-side for many
-# years now.
-- url: /assets/poster.jpg
-  script: auto
-- url: /assets/audioOnly.gif
-  script: auto
-
-# Serve favicon.ico from the demo folder.
-- url: /favicon.ico
-  secure: always
-  static_files: demo/favicon.ico
-  upload: demo/favicon.ico
-
-# For these folders, serve their indexes.
-- url: /docs/api/
-  secure: always
-  static_files: docs/api/index.html
-  upload: docs/api/index.html
-- url: /demo/
-  secure: always
-  static_files: demo/index.html
-  upload: demo/index.html
-- url: /demo/
-  secure: always
-  static_files: demo/index.html
-  upload: demo/index.html
-
-# Serve everything else directly.
-- url: /(.+)
-  secure: always
-  static_files: \1
-  upload: .+

package/app-engine/shaka-player-demo/main.py

@@ -1,95 +0,0 @@
-# Shaka Player Demo - Appspot Entrypoint
-# Copyright 2022 Google LLC
-# SPDX-License-Identifier: Apache-2.0
-
-# Most of the app is served as static content.  Any exceptions go here.
-
-import datetime
-import os
-
-from flask import Flask, make_response, redirect, request, send_file
-
-
-app = Flask(__name__)
-
-
-# Redirect root requests to /demo.
-@app.route('/')
-def root():
-  return redirect('/demo/', code=302)
-
-
-# A Doodle-like service to change the poster on certain days.
-# All posters are chosen based on the current date in PST.
-
-from posters import VIDEO_POSTERS, VIDEO_DEFAULT, AUDIO_POSTERS, AUDIO_DEFAULT
-
-
-# Timezone info for PST.
-# I'm ignoring DST to avoid complicating the code.
-class PST(datetime.tzinfo):
-  def utcoffset(self, dt):
-    return datetime.timedelta(hours=-8)
-
-  def dst(self, dt):
-    return datetime.timedelta(0)
-
-  def tzname(self, dt):
-    return 'PST'
-
-
-def get_poster(poster_map, default_poster):
-  now = datetime.datetime.now(PST())
-  today = (now.month, now.day)
-  today_with_year = (now.month, now.day, now.year)
-  midnight = datetime.datetime(now.year, now.month, now.day, tzinfo=PST())
-  local_expiration = midnight + datetime.timedelta(days=1)
-  max_age = (local_expiration - now).total_seconds()
-
-  # For internal debugging and testing of the poster service, we can override
-  # the date.  To set an override, open /assets/poster.jpg and run this in the
-  # JS console:
-  #   document.cookie="posterdate=10-31"
-  # To clear an override, run:
-  #   document.cookie="posterdate="
-  override = request.cookies.get('posterdate')
-  if override:
-    override_tuple = [int(x) for x in override.split('-')]
-    print('Date override:', repr(override_tuple))
-
-    if len(override_tuple) == 3:
-      # Override includes year.
-      today_with_year = tuple(override_tuple)
-      today = tuple(override_tuple[0:2])
-    elif len(override_tuple) == 2:
-      # Override does not include year, so add the current year.
-      today_with_year = tuple(override_tuple + [now.year])
-      today = tuple(override_tuple)
-    else:
-      # Bad override format.  Ignore the year, but add a response header to
-      # indicate that the override failed.  For internal debugging of the
-      # poster service.
-      print('Bad date override:', override, file=sys.stderr)
-
-  # Prefer a poster for this specific year.
-  name = poster_map.get(today_with_year, poster_map.get(today, default_poster))
-  path = 'posters/%s' % name
-
-  response = make_response(
-      send_file(path, last_modified=midnight, max_age=max_age))
-
-  response.headers['Access-Control-Allow-Origin'] = '*'
-  response.headers['Access-Control-Allow-Headers'] = 'If-Modified-Since,Range'
-  response.headers['Access-Control-Expose-Headers'] = 'Date'
-  response.headers['Access-Control-Max-Age'] = '2592000'
-
-  return response
-
-
-@app.route('/assets/poster.jpg')
-def get_video_poster():
-  return get_poster(VIDEO_POSTERS, VIDEO_DEFAULT)
-
-@app.route('/assets/audioOnly.gif')
-def get_audio_poster():
-  return get_poster(AUDIO_POSTERS, AUDIO_DEFAULT)