shaka-player 4.0.2 → 4.0.5

package/build/subprocessWindowsPatch.py

@@ -1,103 +0,0 @@
-# Copyright 2021 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.
-
-"""Monkeypatch subprocess on Windows to find .CMD scripts.
-
-Without this patch, subprocess fails to find .CMD scripts on Windows, even
-though these are executables and should be treated as such according to the
-PATHEXT environment variable.
-
-Many people "work around" this issue on Windows with subprocess's shell=True
-argument, but this comes with a risk of shell injection vulnerabilities.
-
-Another solution is to explicitly add ".CMD" to the end of some commands on
-Windows, but this breaks portability and requires "if windows" to be scattered
-around a codebase.
-
-This monkeypatch allows the caller of subprocess to stop worrying about Windows
-nuances and to go back to the security best practice of shell=False.  Any .CMD
-script that would be found by the Windows shell will now be found by
-subprocess.  And because we're using the standard Windows PATHEXT environment
-variable, this can be extended to other types of executable scripts, as well.
-"""
-
-import os
-import subprocess
-import sys
-
-
-# NOTE: All of the higher-level methods eventually delegate to Popen, so we
-# only patch that one method.
-#   run => Popen
-#   call => Popen
-#   check_call => call => Popen
-#   check_output => run => Popen
-
-# These environment variables should almost certainly exist, but these are
-# defaults in case they are missing.
-DEFAULT_PATHEXT = '.COM;.EXE;.BAT;.CMD'
-DEFAULT_PATH = r'C:\WINDOWS\system32;C:\WINDOWS'
-
-
-def resolve(exe):
-  """Resolve a command name into a full path to the executable."""
-
-  if '/' in exe or '\\' in exe or ':' in exe:
-    # This is a path, so don't modify it.
-    return exe
-
-  if '.' in exe:
-    # This has an extension already.  Don't search for an extension.
-    exe_names = [exe]
-  else:
-    # This is a command name without an extension, so check for every extension
-    # in PATHEXT.
-    extensions = os.environ.get('PATHEXT', DEFAULT_PATHEXT).split(';')
-    exe_names = [exe + ext for ext in extensions]
-
-  exe_paths = os.environ.get('PATH', DEFAULT_PATH).split(';')
-
-  for path in exe_paths:
-    for name in exe_names:
-      candidate = os.path.join(path, name)
-      if os.access(candidate, os.X_OK):  # If executable
-        return candidate
-
-  # Failed to resolve, so return the original name and let Popen fail with a
-  # natural-looking error complaining that this command cannot be found.
-  return exe
-
-
-real_Popen = subprocess.Popen
-
-
-def Popen(args, *more_args, **kwargs):
-  """A patch to install over subprocess.Popen."""
-
-  # If the first argument is a list, resolve the command name, which is the
-  # first item in the list.
-  if isinstance(args, list):
-    args[0] = resolve(args[0])
-
-  # Delegate to the real Popen implementation.
-  return real_Popen(args, *more_args, **kwargs)
-
-
-# Only patch win32, but not cygwin.  Cygwin works correctly already.
-if sys.platform == 'win32':
-  # Patch over Popen.
-  subprocess.Popen = Popen
-  # Copy the docstring from the real Popen into the patch, so that
-  # help(subprocess.Popen) is still relatively sane with this patch installed.
-  Popen.__doc__ = real_Popen.__doc__

package/build/test.py

@@ -1,541 +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.
-
-"""Runs unit and integrations tests on the library."""
-
-import argparse
-import json
-import logging
-import os
-import platform
-import re
-
-import build
-import gendeps
-import shakaBuildHelpers
-
-
-# Set a higher default for capture_timeout in grid mode.  If the test gets
-# queued by the grid, this may prevent Karma from killing the session while
-# waiting.
-LOCAL_CAPTURE_TIMEOUT = 1 * 60 * 1000  # 1m in ms
-SELENIUM_CAPTURE_TIMEOUT = 10 * 60 * 1000  # 10m in ms
-
-
-class _HandleMixedListsAction(argparse.Action):
-  '''Action to handle comma-separated and space-separated lists.
-
-     When input can be given as a comma-separated list or a space-
-     separated list, default actions and types don't work. For example
-     if you had |'a,b,c' 'd'| you can get |['a,b,c', 'd']| or
-     |[['a','b','c'], 'd']|.
-
-     This action will expand the comma-separated lists and merge then with
-     the space separated lists so you will get |['a', 'b', 'c', 'd']|.
-  '''
-
-  def __call__(self, parser, namespace, new_values, option_string=None):
-    merged = getattr(namespace, self.dest) or []
-    for value in new_values:
-      merged += value.split(',')
-    setattr(namespace, self.dest, merged)
-
-
-class _HandleKeyValuePairs(argparse.Action):
-  '''Action to handle key-value pairs and convert to a dictionary.
-
-     Input is a key-value pair separated by '='.
-     These keys and values are stored in a dictionary which can accumulate
-     multiple values from the command-line.
-  '''
-
-  def __call__(self, parser, namespace, new_argument, option_string=None):
-    merged = getattr(namespace, self.dest) or {}
-    key, value = new_argument.split('=', 1)
-    merged[key] = value
-    setattr(namespace, self.dest, merged)
-
-def _KeyValueValidator(argument):
-    '''To validate the option has a key value pair format.
-
-      When you forget to provide the option in key=value format,
-      it reminds you by throwing an error before executing any tests.
-    '''
-
-    keyValuePair = [str for str in argument.split('=') if str != ''];
-
-    if len(keyValuePair) == 2:
-      return argument
-    else:
-      raise argparse.ArgumentTypeError(
-        'Received %s but expecting format of key=value' % argument
-      ) 
-
-def _IntGreaterThanZero(x):
-  i = int(x)
-  if i <= 0:
-    raise argparse.ArgumentTypeError('%s is not greater than zero' % x)
-  return i
-
-
-def _GetDefaultBrowsers():
-  """Use the platform name to get which browsers can be tested."""
-
-  if shakaBuildHelpers.is_linux():
-    # For MP4 support on Linux Firefox, install gstreamer1.0-libav.
-    # Opera on Linux only supports MP4 for Ubuntu 15.04+, so it is not in the
-    # default list of browsers for Linux at this time.
-    return ['Chrome','Edge','Firefox']
-
-  if shakaBuildHelpers.is_darwin():
-    return ['Chrome','Edge','Firefox','Safari']
-
-  if shakaBuildHelpers.is_windows() or shakaBuildHelpers.is_cygwin():
-    return ['Chrome','Edge','Firefox','IE']
-
-  raise Error('Unrecognized system: %s' % platform.uname()[0])
-
-
-# TODO(joeyparrish): When internal tools using this Launcher system are removed,
-# simplify this whole mess.
-class Launcher:
-  """A stateful object for parsing arguments and running Karma commands.
-
-     A launcher that holds the state of parsing arguments and builds and
-     executes the resulting Karma command. The process is split into sections so
-     that other scripts can inject their own logic between calls.
-
-     For example:
-       l = Launcher('Launch Karma tests')
-       l.parser.add_argument('custom_flag')
-       l.ParseArguments(args)
-       l.ResolveBrowsers(['Chrome'])
-       if l.parsed_args.custom_flag:
-         do_custom_logic
-      l.RunCommand(karma_conf_path)
-  """
-
-  def __init__(self, description):
-    self.karma_config = {}
-    self.parsed_args = None
-    self.parser = argparse.ArgumentParser(
-        description=description,
-        formatter_class=argparse.RawDescriptionHelpFormatter)
-
-    running_commands = self.parser.add_argument_group(
-        'Running',
-        'These commands affect how tests are run.')
-    logging_commands = self.parser.add_argument_group(
-        'Logging',
-        'These commands affect what gets logged and how the logs will appear.')
-    networking_commands = self.parser.add_argument_group(
-        'Networking',
-        'These commands affect how Karma works over a network.')
-    pre_launch_commands = self.parser.add_argument_group(
-        'Pre-Launch',
-        'These commands are handled before the tests start running.')
-
-
-    running_commands.add_argument(
-        '--browsers',
-        help='Specify which browsers to run tests on as a space-separated or '
-             'comma-separated list. Use "--browsers help" to see a list of '
-             'available browsers on this platform.',
-        action=_HandleMixedListsAction,
-        nargs='+')
-    running_commands.add_argument(
-        '--exclude-browsers',
-        help='Browsers to skip as a comma-separated or space-separated list.',
-        action=_HandleMixedListsAction,
-        nargs='+')
-    running_commands.add_argument(
-        '--no-browsers',
-        help='Instead of Karma starting browsers, Karma will wait for a '
-             'browser to connect to it.',
-        action='store_true')
-    running_commands.add_argument(
-        '--single-run',
-        help='Run the test when browsers capture and exit.',
-        dest='single_run',
-        action='store_true',
-        default=True)
-    running_commands.add_argument(
-        '--no-single-run',
-        help='Do not shut down Karma when tests are complete.',
-        dest='single_run',
-        action='store_false')
-    running_commands.add_argument(
-        '--random',
-        help='Run the tests in a random order. This can be used with --seed '
-             'to control the random order. If used without --seed, a seed '
-             'will be generated.',
-        action='store_true')
-    running_commands.add_argument(
-        '--seed',
-        help='Set the seed that will be used by --random. If used without '
-             '--random, this will have no effect.',
-        type=int)
-    running_commands.add_argument(
-        '--filter',
-        help='Specify a regular expression to limit which tests run.',
-        type=str,
-        dest='filter')
-    running_commands.add_argument(
-        '--use-xvfb',
-        help='Run tests without opening browser windows. Requires Linux '
-             'and xvfb.',
-        action='store_true')
-    running_commands.add_argument(
-        '--quick',
-        help='Skip integration tests.',
-        action='store_true')
-    running_commands.add_argument(
-        '--external',
-        help='Run tests that require external resources. This will require a '
-             'fast connection to the open internet.',
-        action='store_true')
-    running_commands.add_argument(
-        '--drm',
-        help='Run tests that require DRM (on by default).',
-        default=True,
-        action='store_true')
-    running_commands.add_argument(
-        '--no-drm', '--nodrm',
-        help='Skip tests that require DRM (opposite of --drm).',
-        dest='drm',
-        action='store_false')
-    running_commands.add_argument(
-        '--quarantined',
-        help='Run tests that have been quarantined.',
-        action='store_true')
-    running_commands.add_argument(
-        '--runs',
-        help='Set the number of times each test should run. (default '
-             '%(default)s) ',
-        type=_IntGreaterThanZero,
-        default=1,
-        dest='runs')
-    running_commands.add_argument(
-        '--uncompiled',
-        help='Use the uncompiled source code when running the tests. This can '
-             'be used to make debugging easier.',
-        action='store_true')
-    running_commands.add_argument(
-        '--auto-watch',
-        help='Auto watch source files and run on change.',
-        dest='auto_watch',
-        action='store_true',
-        default=False)
-    running_commands.add_argument(
-        '--no-auto-watch',
-        help='Do not watch source files',
-        dest='auto_watch',
-        action='store_false')
-    running_commands.add_argument(
-        '--capture-timeout',
-        help='Kill the browser if it does not capture in the given time [ms]. '
-             '(default {} for local, {} for Selenium)'.format(
-                 LOCAL_CAPTURE_TIMEOUT, SELENIUM_CAPTURE_TIMEOUT),
-        type=int)
-    running_commands.add_argument(
-        '--delay-tests',
-        help='Insert an artificial delay between tests, in seconds. '
-             'This can be helpful when tracking down asynchronous test '
-             'pollution, in which an async process belonging to one test may '
-             'trigger a failure after other tests have begun. '
-             '(default %(const)s)',
-        type=int,
-        default=None,
-        const=2,
-        nargs='?')
-    running_commands.add_argument(
-        '--spec-hide-passed',
-        help='If provided, configure the spec reporter to hide passing tests.',
-        action='store_true',
-        default=False)
-    running_commands.add_argument(
-        '--test-custom-asset',
-        help='Run asset playback tests on a custom manifest URI.',
-        type=str,
-        default=None)
-    running_commands.add_argument(
-        '--test-custom-license-server',
-        help='Configure license servers for the custom asset playback test. '
-             'May be specified multiple times to configure multiple key '
-             'systems.',
-        type=_KeyValueValidator,
-        metavar='KEY_SYSTEM_ID=LICENSE_SERVER_URI',
-        action=_HandleKeyValuePairs)
-    running_commands.add_argument(
-        '--test-timeout',
-        help='Sets the test timeout value [ms] (default %(default)s)',
-        dest='test_timeout',
-        default=120000,
-        type=int)
-    running_commands.add_argument(
-        '--no-babel',
-        help="Don't use Babel to convert ES6 to ES5.",
-        dest='babel',
-        action='store_false')
-    running_commands.add_argument(
-        '--grid-address',
-        help='Address (hostname:port) of a Selenium grid to run tests on.')
-    running_commands.add_argument(
-        '--grid-config',
-        help='Path to a yaml config defining Selenium grid browsers. '
-             '(See docs/selenium-grid-config.md)')
-
-
-    logging_commands.add_argument(
-        '--colors',
-        help='Use colors when reporting and printing logs.',
-        action='store_true',
-        dest='colors',
-        default=True)
-    logging_commands.add_argument(
-        '--no-colors',
-        help='Do not use colors when reporting or printing logs',
-        action='store_false',
-        dest='colors')
-    logging_commands.add_argument(
-        '--log-level',
-        help='Set the type of log messages that Karma will print.',
-        choices=['disable', 'error', 'warn', 'info', 'debug'],
-        default='error')
-    logging_commands.add_argument(
-        '--html-coverage-report',
-        help='Generate HTML-formatted code coverage reports in the "coverage" '
-             'folder.',
-        action='store_true')
-    logging_commands.add_argument(
-        '--enable-logging',
-        help='Print log messages from tests and limits the type of log '
-             'messages printed. If --enable-logging is not given, no logs '
-             'will be printed.  (default %(const)s)',
-        choices=['none', 'error', 'warning', 'info', 'debug', 'v1', 'v2'],
-        default='none',
-        const='info',
-        dest='logging',
-        nargs='?')
-    logging_commands.add_argument(
-        '--reporters',
-        help='Specify which reporters to use as a space-separated or '
-             'comma-separated list. Possible options are dots, progress, '
-             'junit, growl, or coverage.',
-        action=_HandleMixedListsAction,
-        nargs='+')
-    logging_commands.add_argument(
-        '--report-slower-than',
-        help='Report tests that are slower than the given time [ms].',
-        type=int)
-
-
-    networking_commands.add_argument(
-       '--port',
-        help='Port where the server is running.',
-        type=int)
-    networking_commands.add_argument(
-        '--hostname',
-        help='Specify the hostname to be used when capturing browsers. This '
-             'defaults to localhost.',
-        default='localhost')
-    networking_commands.add_argument(
-        '--tls-key',
-        help='Specify a TLS key to serve tests over HTTPs.')
-    networking_commands.add_argument(
-        '--tls-cert',
-        help='Specify a TLS cert to serve tests over HTTPs.')
-    networking_commands.add_argument(
-        '--lets-encrypt-folder',
-        help="Specify a Let's Encrypt folder to search for the latest key and "
-             "cert, to serve tests over HTTPs.  This overrides --tls-key and "
-             "--tls-cert.")
-
-
-    pre_launch_commands.add_argument(
-        '--force',
-        help='Force a rebuild of the project before running tests. This will '
-             'have no effect if --no-build is set.',
-        action='store_true')
-    pre_launch_commands.add_argument(
-        '--no-build',
-        help='Skip building the project before running tests.',
-        action='store_false',
-        dest='build',
-        default=True)
-    pre_launch_commands.add_argument(
-        '--print-command',
-        help='Print the command passed to Karma before passing it to Karma.',
-        action='store_true')
-
-
-  def ParseArguments(self, args):
-    """Parse the given arguments.
-
-       Uses the parser definition to parse |args| and populates
-       |self.karma_config|.
-    """
-
-    self.parsed_args = self.parser.parse_args(args)
-    self.karma_config = {}
-
-    pass_through = [
-      'auto_watch',
-      'babel',
-      'browsers',
-      'capture_timeout',
-      'colors',
-      'delay_tests',
-      'drm',
-      'exclude_browsers',
-      'external',
-      'filter',
-      'grid_address',
-      'grid_config',
-      'hostname',
-      'html_coverage_report',
-      'log_level',
-      'logging',
-      'no_browsers',
-      'port',
-      'quarantined',
-      'quick',
-      'random',
-      'reporters',
-      'report_slower_than',
-      'seed',
-      'single_run',
-      'spec_hide_passed',
-      'test_custom_asset',
-      'test_custom_license_server',
-      'test_timeout',
-      'tls_key',
-      'tls_cert',
-      'uncompiled',
-    ]
-
-    # Check each value before setting it to avoid passing null values.
-    for name in pass_through:
-      value = getattr(self.parsed_args, name, None)
-      if value is not None:
-        self.karma_config[name] = value
-
-    if not self.parsed_args.capture_timeout:
-      # The default for capture_timeout depends on whether or not we are using
-      # a Selenium grid.
-      if self.parsed_args.grid_config:
-        self.karma_config['capture_timeout'] = SELENIUM_CAPTURE_TIMEOUT
-      else:
-        self.karma_config['capture_timeout'] = LOCAL_CAPTURE_TIMEOUT
-
-    self._HandleLetsEncryptConfig()
-
-  def _HandleLetsEncryptConfig(self):
-    folder = self.parsed_args.lets_encrypt_folder
-    if not folder:
-      return
-
-    max_serial_number = 0
-    # Go through the contents of the folder to find the latest key & cert.
-    for file_name in os.listdir(folder):
-      matches = re.match(r'(?:privkey|fullchain)(\d+).pem', file_name)
-      if matches:
-        serial_number = int(matches.group(1))
-        max_serial_number = max(max_serial_number, serial_number)
-
-    self.karma_config['tls_key'] = os.path.join(
-        folder, 'privkey{}.pem'.format(max_serial_number))
-    self.karma_config['tls_cert'] = os.path.join(
-        folder, 'fullchain{}.pem'.format(max_serial_number))
-
-  def ResolveBrowsers(self, default_browsers):
-    """Decide what browsers we should use.
-
-       This is separate from ParseArguments so that other tools can insert
-       additional logic to derive a browser list from the parsed arguments.
-    """
-    assert(default_browsers and len(default_browsers))
-    self.karma_config['default_browsers'] = default_browsers
-
-  def RunCommand(self, karma_conf):
-    """Build a command and send it to Karma for execution.
-
-       Uses |self.parsed_args| and |self.karma_config| to build and run a Karma
-       command.
-    """
-    if self.parsed_args.use_xvfb and not shakaBuildHelpers.is_linux():
-      logging.error('xvfb can only be used on Linux')
-      return 1
-
-    if not shakaBuildHelpers.update_node_modules():
-      logging.error('Failed to update node modules')
-      return 1
-
-    karma = shakaBuildHelpers.get_node_binary('karma')
-    cmd = ['xvfb-run', '--auto-servernum'] if self.parsed_args.use_xvfb else []
-    cmd += karma + ['start']
-    cmd += [karma_conf] if karma_conf else []
-    cmd += ['--settings', json.dumps(self.karma_config)]
-
-    # There is no need to print a status here as the gendep and build
-    # calls will print their own status updates.
-    if self.parsed_args.build:
-      if gendeps.main([]) != 0:
-        logging.error('Failed to generate project dependencies')
-        return 1
-
-      if build.main(['--force'] if self.parsed_args.force else []) != 0:
-        logging.error('Failed to build project')
-        return 1
-
-    # Before Running the command, print the command.
-    if self.parsed_args.print_command:
-      logging.info('Karma Run Command')
-      logging.info('%s', cmd)
-
-    # Run the command.
-    results = []
-    for run in range(self.parsed_args.runs):
-      logging.info('Running test (%d / %d, %d failed so far)...',
-          run + 1, self.parsed_args.runs, len(results) - results.count(0))
-      results.append(shakaBuildHelpers.execute_get_code(cmd))
-
-    # Print a summary of the results.
-    if self.parsed_args.runs > 1:
-      logging.info('All runs completed. %d / %d runs passed.',
-                   results.count(0),
-                   len(results))
-      logging.info('Results (exit code): %r', results)
-    else:
-      logging.info('Run complete')
-      logging.info('Result (exit code): %d', results[0])
-
-    return 0 if all(result == 0 for result in results) else 1
-
-
-def Run(args):
-  launcher = Launcher('Shaka Player Test Runner Script')
-  launcher.ParseArguments(args)
-  launcher.ResolveBrowsers(_GetDefaultBrowsers())
-  return launcher.RunCommand(None)
-
-
-def main(args):
-  return Run(args)
-
-
-if __name__ == '__main__':
-  shakaBuildHelpers.run_main(main)

package/build/types/ads

@@ -1,8 +0,0 @@
-# Ad Insertion Functionality
-
-+../../lib/ads/ad_manager.js
-+../../lib/ads/ads_stats.js
-+../../lib/ads/client_side_ad.js
-+../../lib/ads/client_side_ad_manager.js
-+../../lib/ads/server_side_ad.js
-+../../lib/ads/server_side_ad_manager.js

package/build/types/cast

@@ -1,6 +0,0 @@
-# Cast support.
-
-+../../lib/cast/cast_proxy.js
-+../../lib/cast/cast_receiver.js
-+../../lib/cast/cast_sender.js
-+../../lib/cast/cast_utils.js

package/build/types/cea

@@ -1,13 +0,0 @@
-# Inband closed caption support.
-
-+../../lib/cea/cea_decoder.js
-+../../lib/cea/cea_utils.js
-+../../lib/cea/cea608_data_channel.js
-+../../lib/cea/cea608_memory.js
-+../../lib/cea/cea708_service.js
-+../../lib/cea/cea708_window.js
-+../../lib/cea/dtvcc_packet_builder.js
-+../../lib/cea/i_caption_decoder.js
-+../../lib/cea/i_cea_parser.js
-+../../lib/cea/mp4_cea_parser.js
-+../../lib/cea/sei_processor.js

package/build/types/complete

@@ -1,9 +0,0 @@
-# The complete library, containing every available plugin.
-
-+@ads
-+@cast
-+@networking
-+@manifests
-+@polyfill
-+@text
-+@ui