shaka-player 3.2.4 → 3.2.5

package/CONTRIBUTING.md

@@ -3,8 +3,8 @@
 We'd love to accept your patches and contributions to this project.  There are
 just a few small guidelines you need to follow.
 
-1. File a bug at https://github.com/google/shaka-player/issues (if there isn't
-   one already).  If your patch is going to be large, you should start a
+1. File a bug at https://github.com/shaka-project/shaka-player/issues (if there
+   isn't one already).  If your patch is going to be large, you should start a
    discussion on GitHub first.
 
    Leave a comment to let us know that you are working on a PR for the issue.

package/CONTRIBUTORS

@@ -49,6 +49,7 @@ Esteban Dosztal <edosztal@gmail.com>
 Fadomire <fadomire@gmail.com>
 François Beaufort <fbeaufort@google.com>
 Gil Gonen <gil.gonen@gmail.com>
+Giorgio Gamberoni <giorgio.gamberoni@gmail.com>
 Giuseppe Samela <giuseppe.samela@gmail.com>
 Hichem Taoufik <hichem@code-it.fr>
 Itay Kinnrot <itay.kinnrot@kaltura.com>
@@ -64,6 +65,7 @@ John Bowers <john.bowers@verizondigitalmedia.com>
 Jonas Birmé <jonas.birme@eyevinn.se>
 Jono Ward <jonoward@gmail.com>
 Jozef Chúťka <jozefchutka@gmail.com>
+Jun Hong Chong <chongjunhong@gmail.com>
 Leandro Ribeiro Moreira <leandro.ribeiro.moreira@gmail.com>
 Lucas Gabriel Sánchez <unkiwii@gmail.com>
 Matias Russitto <russitto@gmail.com>

package/README.md

@@ -52,7 +52,7 @@ NOTES:
  - ⁶: These are expected to work, but are community-supported and untested by
    us.
      - Official support for LG WebOS TV:
-       https://github.com/google/shaka-player/issues/1330
+       https://github.com/shaka-project/shaka-player/issues/1330
 
 We support iOS 12+ through Apple's native HLS player.  We provide the same
 top-level API, but we just set the video's `src` element to the manifest/media.
@@ -65,7 +65,7 @@ features and similar APIs for native apps on iOS. This project uses its own
 media stack, which allows it to play content that would otherwise not be
 supported. This supports both DASH and HLS manifests.
 
-[Shaka Player Embedded]: https://github.com/google/shaka-player-embedded
+[Shaka Player Embedded]: https://github.com/shaka-project/shaka-player-embedded
 
 
 ## Manifest format support matrix
@@ -102,12 +102,12 @@ DASH features supported:
 DASH features **not** supported:
  - Xlink with actuate=onRequest
  - Manifests without any segment info:
-   https://github.com/google/shaka-player/issues/1088
+   https://github.com/shaka-project/shaka-player/issues/1088
  - Changing codecs during a presentation (unsupported by MSE)
  - Multiple trick mode tracks for the same resolution at varying framerates or
    bitrates
  - Timescales so large that timestamps cannot be represented as integers in
-   JavaScript (2^53): https://github.com/google/shaka-player/issues/1667
+   JavaScript (2^53): https://github.com/shaka-project/shaka-player/issues/1667
 
 
 ## HLS features
@@ -125,10 +125,10 @@ HLS features supported:
  - Encrypted content with FairPlay (Safari on macOS and iOS 12+ only)
 
 HLS features **not** supported:
- - Key rotation: https://github.com/google/shaka-player/issues/917
- - I-frame-only playlists: https://github.com/google/shaka-player/issues/742
+ - Key rotation: https://github.com/shaka-project/shaka-player/issues/917
+ - I-frame-only playlists: https://github.com/shaka-project/shaka-player/issues/742
  - Raw AAC, MP3, etc (without an MP4 container):
-   https://github.com/google/shaka-player/issues/2337
+   https://github.com/shaka-project/shaka-player/issues/2337
  - Low-latency streaming with blocking playlist reload
 
 [mux.js]: https://github.com/videojs/mux.js/releases

package/app-engine/README.md

@@ -0,0 +1,9 @@
+# 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

@@ -0,0 +1,14 @@
+# 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).
+
+ - main.py: A python service that queries available versions and generates the
+            index from a template.
+
+ - requirements.txt: Used by App Engine to install the necessary Python server
+                     requirements (Flask, App Engine API).
+
+ - templates/index.html: A Jinja2 template used to generate the index HTML.

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

@@ -0,0 +1,2 @@
+runtime: python39
+default_expiration: 1s

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

@@ -0,0 +1,162 @@
+# Shaka Player Version Index - Appspot Entrypoint
+# Copyright 2022 Google LLC
+# SPDX-License-Identifier: Apache-2.0
+
+# Generate an index of Shaka Player versions on appspot.
+
+import collections
+import google.appengine.api.modules
+import jinja2
+import os
+import random
+import re
+
+from flask import Flask, render_template
+
+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_version(name):
+  return re.match(r'v\d+-\d+-\d+(?:-.+)?', name)
+
+def appengine_version_to_package_version(version):
+  # Replace the first two dashes with dots.  More dashes indicate a prerelease
+  # version, as seen in "v2.0.0-beta3".
+  return version.replace('-', '.', 2)
+
+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_appengine_versions():
+  if os.getenv('SERVER_SOFTWARE', '').startswith('Google App Engine/'):
+    # NOTE: this doesn't return anything useful in a local dev server.
+    return google.appengine.api.modules.modules.get_versions()
+
+  # For a local dev server, fake it so we can test sorting.
+  fake_versions = [
+    'v1-6-0', 'v1-6-1', 'v1-6-2', 'v1-6-3', 'v1-6-4', 'v1-6-5',
+    'v2-0-0-beta', 'v2-0-0-beta2', 'v2-0-0-beta3', 'v2-0-0',
+    'v2-1-0', 'v2-1-1', 'v2-1-2',
+    'v2-2-1', 'v2-2-2-beta', 'v2-2-2-beta2', 'v2-2-2', 'v2-2-9', 'v2-2-10',
+  ]
+  random.shuffle(fake_versions)  # in-place shuffle
+  return fake_versions
+
+
+app = Flask(__name__)
+
+@app.route('/')
+def root():
+  appengine_versions = get_appengine_versions()
+  # Filter for release versions only.
+  appengine_versions = filter(is_release_version, appengine_versions)
+
+  # Now convert from appengine versions (v2-0-0) to package versions (v2.0.0).
+  versions = list(map(appengine_version_to_package_version, appengine_versions))
+  # 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
+
+  for i in version_metadata.values(): print(i)
+  return render_template('index.html', versions=version_metadata.values())

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

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

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

@@ -0,0 +1,114 @@
+<!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

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,61 @@
+# 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

@@ -0,0 +1,95 @@
+# 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)

package/app-engine/shaka-player-demo/posters/sources.txt

@@ -0,0 +1,46 @@
+Trek poster image derived from:
+  https://commons.wikimedia.org/wiki/File:Leonard_Nimoy_by_Gage_Skidmore_2.jpg
+Author:
+  https://commons.wikimedia.org/wiki/User:Gage
+License:
+  Creative Commons Share-Alike 3.0
+  http://creativecommons.org/licenses/by-sa/3.0/
+
+Zombie poster image derived from:
+  https://www.flickr.com/photos/ofsmallthings/8055153041
+Author:
+  https://www.flickr.com/photos/ofsmallthings/
+License:
+  Creative Commons Share-Alike 2.0
+  https://creativecommons.org/licenses/by-sa/2.0/
+
+Color bars April Fool's image from:
+  http://kittypizzadope.tumblr.com/post/66751567701
+Author:
+  unknown
+License:
+  unknown
+
+Party hat image from:
+  https://pixabay.com/en/party-hat-celebration-birthday-42329/
+Author:
+  unknown
+License:
+  Creative Commons 0 - Public Domain 1.0
+  https://creativecommons.org/publicdomain/zero/1.0/deed.en
+
+Party streamers image from:
+  https://pixabay.com/en/confetti-streamer-party-carnival-1925258/
+Author:
+  Unknown
+License:
+  Creative Commons 0 - Public Domain 1.0
+  https://creativecommons.org/publicdomain/zero/1.0/deed.en
+
+Fireworks image from:
+  https://pixabay.com/illustrations/fireworks-sylvester-pyrotechnics-2248223/
+Author:
+  https://pixabay.com/users/geralt-9301/
+License:
+  Simplified Pixabay License
+  https://pixabay.com/service/license/