shaka-player 4.1.1 → 4.2.0

package/lib/util/string_utils.js

@@ -11,6 +11,7 @@ goog.require('shaka.log');
 goog.require('shaka.util.BufferUtils');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.Lazy');
+goog.require('shaka.util.Platform');
 
 
 /**
@@ -37,18 +38,84 @@ shaka.util.StringUtils = class {
       uint8 = uint8.subarray(3);
     }
 
-    // Use the TextDecoder interface to decode the text.  This has the advantage
-    // compared to the previously-standard decodeUriComponent that it will
-    // continue parsing even if it finds an invalid UTF8 character, rather than
-    // stop and throw an error.
-    const utf8decoder = new TextDecoder();
-    const decoded = utf8decoder.decode(uint8);
-    if (decoded.includes('\uFFFD')) {
-      shaka.log.alwaysError('Decoded string contains an "unknown character" ' +
-                            'codepoint.  That probably means the UTF8 ' +
-                            'encoding was incorrect!');
+    if (window.TextDecoder && !shaka.util.Platform.isPS4()) {
+      // Use the TextDecoder interface to decode the text.  This has the
+      // advantage compared to the previously-standard decodeUriComponent that
+      // it will continue parsing even if it finds an invalid UTF8 character,
+      // rather than stop and throw an error.
+      const utf8decoder = new TextDecoder();
+      const decoded = utf8decoder.decode(uint8);
+      if (decoded.includes('\uFFFD')) {
+        shaka.log.alwaysError('Decoded string contains an "unknown character' +
+                              '" codepoint.  That probably means the UTF8 ' +
+                              'encoding was incorrect!');
+      }
+      return decoded;
+    } else {
+      // Homebrewed UTF-8 decoder based on
+      // https://en.wikipedia.org/wiki/UTF-8#Encoding
+      // Unlike decodeURIComponent, won't throw on bad encoding.
+      // In this way, it is similar to TextDecoder.
+
+      let decoded = '';
+      for (let i = 0; i < uint8.length; ++i) {
+        // By default, the "replacement character" codepoint.
+        let codePoint = 0xFFFD;
+
+        // Top bit is 0, 1-byte encoding.
+        if ((uint8[i] & 0x80) == 0) {
+          codePoint = uint8[i];
+
+        // Top 3 bits of byte 0 are 110, top 2 bits of byte 1 are 10,
+        // 2-byte encoding.
+        } else if (uint8.length >= i + 2 &&
+            (uint8[i] & 0xe0) == 0xc0 &&
+            (uint8[i + 1] & 0xc0) == 0x80) {
+          codePoint = ((uint8[i] & 0x1f) << 6) |
+                      ((uint8[i + 1] & 0x3f));
+          i += 1;  // Consume one extra byte.
+
+        // Top 4 bits of byte 0 are 1110, top 2 bits of byte 1 and 2 are 10,
+        // 3-byte encoding.
+        } else if (uint8.length >= i + 3 &&
+            (uint8[i] & 0xf0) == 0xe0 &&
+            (uint8[i + 1] & 0xc0) == 0x80 &&
+            (uint8[i + 2] & 0xc0) == 0x80) {
+          codePoint = ((uint8[i] & 0x0f) << 12) |
+                      ((uint8[i + 1] & 0x3f) << 6) |
+                      ((uint8[i + 2] & 0x3f));
+          i += 2;  // Consume two extra bytes.
+
+        // Top 5 bits of byte 0 are 11110, top 2 bits of byte 1, 2 and 3 are 10,
+        // 4-byte encoding.
+        } else if (uint8.length >= i + 4 &&
+            (uint8[i] & 0xf1) == 0xf0 &&
+            (uint8[i + 1] & 0xc0) == 0x80 &&
+            (uint8[i + 2] & 0xc0) == 0x80 &&
+            (uint8[i + 3] & 0xc0) == 0x80) {
+          codePoint = ((uint8[i] & 0x07) << 18) |
+                      ((uint8[i + 1] & 0x3f) << 12) |
+                      ((uint8[i + 2] & 0x3f) << 6) |
+                      ((uint8[i + 3] & 0x3f));
+          i += 3;  // Consume three extra bytes.
+        }
+
+        // JavaScript strings are a series of UTF-16 characters.
+        if (codePoint <= 0xffff) {
+          decoded += String.fromCharCode(codePoint);
+        } else {
+          // UTF-16 surrogate-pair encoding, based on
+          // https://en.wikipedia.org/wiki/UTF-16#Description
+          const baseCodePoint = codePoint - 0x10000;
+          const highPart = baseCodePoint >> 10;
+          const lowPart = baseCodePoint & 0x3ff;
+          decoded += String.fromCharCode(0xd800 + highPart);
+          decoded += String.fromCharCode(0xdc00 + lowPart);
+        }
+      }
+
+      return decoded;
     }
-    return decoded;
   }
 
 
@@ -141,8 +208,30 @@ shaka.util.StringUtils = class {
    * @export
    */
   static toUTF8(str) {
-    const utf8Encoder = new TextEncoder();
-    return shaka.util.BufferUtils.toArrayBuffer(utf8Encoder.encode(str));
+    if (window.TextEncoder && !shaka.util.Platform.isPS4()) {
+      const utf8Encoder = new TextEncoder();
+      return shaka.util.BufferUtils.toArrayBuffer(utf8Encoder.encode(str));
+    } else {
+      // http://stackoverflow.com/a/13691499
+      // Converts the given string to a URI encoded string.  If a character
+      // falls in the ASCII range, it is not converted; otherwise it will be
+      // converted to a series of URI escape sequences according to UTF-8.
+      // Example: 'g#€' -> 'g#%E3%82%AC'
+      const encoded = encodeURIComponent(str);
+      // Convert each escape sequence individually into a character.  Each
+      // escape sequence is interpreted as a code-point, so if an escape
+      // sequence happens to be part of a multi-byte sequence, each byte will
+      // be converted to a single character.
+      // Example: 'g#%E3%82%AC' -> '\x67\x35\xe3\x82\xac'
+      const utf8 = unescape(encoded);
+
+      const result = new Uint8Array(utf8.length);
+      for (let i = 0; i < utf8.length; i++) {
+        const item = utf8[i];
+        result[i] = item.charCodeAt(0);
+      }
+      return shaka.util.BufferUtils.toArrayBuffer(result);
+    }
   }
 
 

package/maintained-branches.md

@@ -0,0 +1,15 @@
+# Maintained Shaka Player Branches
+
+We are currently maintaining the following branches of Shaka Player:
+
+ - v4.1 (latest)
+ - v4.0 (previous)
+ - v3.3 (LTS until April 30, 2023)
+ - v3.2 (in use by the Cast Application Framework)
+
+Other branches are no longer receiving bug fixes, and we recommend you upgrade
+to a maintained branch.  For details on upgrading, please see our
+[upgrade guide](https://shaka-player-demo.appspot.com/docs/api/tutorial-upgrade.html).
+
+For more information on how these branches are chosen, please refer to our
+[Branch Maintenance Policy](https://shaka-project.github.io/maintenance/shaka-player.html#branch-maintenance-policy).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [
@@ -27,7 +27,6 @@
     "eslint-config-google": "^0.14.0",
     "eslint-plugin-shaka-rules": "file:./build/eslint-plugin-shaka-rules",
     "esprima": "^4.0.1",
-    "fastestsmallesttextencoderdecoder": "^1.0.22",
     "fontfaceonload": "^1.0.2",
     "google-closure-compiler-java": "^20220301.0.0",
     "google-closure-deps": "https://gitpkg.now.sh/google/closure-library/closure-deps?d7736da6",
@@ -50,7 +49,7 @@
     "less": "https://gitpkg.now.sh/joeyparrish/less.js/packages/less?28c63a43",
     "less-plugin-clean-css": "github:austingardner/less-plugin-clean-css#4e9e77bf",
     "material-design-lite": "^1.3.0",
-    "mux.js": "^6.1.0",
+    "mux.js": "^6.2.0",
     "open-sans-fonts": "^1.6.2",
     "postcss-less": "^6.0.0",
     "pwacompat": "^2.0.17",
@@ -71,7 +70,6 @@
       "dialog-polyfill/dist/dialog-polyfill.js",
       "eme-encryption-scheme-polyfill/index.js",
       "es6-promise-polyfill/promise.min.js",
-      "fastestsmallesttextencoderdecoder/EncoderDecoderTogether.min.js",
       "google-closure-library/closure/goog/base.js",
       "less/dist/less.js",
       "material-design-lite/dist/material.indigo-blue.min.css",
@@ -96,7 +94,7 @@
     "prepublishOnly": "python build/checkversion.py && python build/all.py --force"
   },
   "dependencies": {
-    "eme-encryption-scheme-polyfill": "^2.0.5"
+    "eme-encryption-scheme-polyfill": "^2.1.1"
   },
   "engines": {
     "node": ">=14"

package/shaka-player.uncompiled.js

@@ -38,6 +38,7 @@ goog.require('shaka.polyfill.Fullscreen');
 goog.require('shaka.polyfill.MediaSource');
 goog.require('shaka.polyfill.MediaCapabilities');
 goog.require('shaka.polyfill.Orientation');
+goog.require('shaka.polyfill.PatchedMediaKeysApple');
 goog.require('shaka.polyfill.PatchedMediaKeysNop');
 goog.require('shaka.polyfill.PatchedMediaKeysWebkit');
 goog.require('shaka.polyfill.PiPWebkit');

package/test/hls/hls_parser_unit.js

@@ -33,6 +33,8 @@ describe('HlsParser', () => {
   let segmentData;
   /** @type {!Uint8Array} */
   let selfInitializingSegmentData;
+  /** @type {!Uint8Array} */
+  let aes128Key;
 
   afterEach(() => {
     shaka.log.alwaysWarn = originalAlwaysWarn;
@@ -75,6 +77,11 @@ describe('HlsParser', () => {
     selfInitializingSegmentData =
         shaka.util.Uint8ArrayUtils.concat(initSegmentData, segmentData);
 
+    aes128Key = new Uint8Array([
+      0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+      0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+    ]);
+
     fakeNetEngine = new shaka.test.FakeNetworkingEngine();
 
     config = shaka.util.PlayerConfiguration.createDefault().manifest;
@@ -2432,7 +2439,7 @@ describe('HlsParser', () => {
     expect(initSegments[1].getUris()[0]).toBe('test:/init2.mp4');
   });
 
-  it('drops variants encrypted with AES-128', async () => {
+  it('parses variants encrypted with AES-128', async () => {
     const master = [
       '#EXTM3U\n',
       '#EXT-X-STREAM-INF:BANDWIDTH=200,CODECS="avc1,mp4a",',
@@ -2441,10 +2448,15 @@ describe('HlsParser', () => {
       '#EXT-X-STREAM-INF:BANDWIDTH=300,CODECS="avc1,mp4a",',
       'RESOLUTION=960x540,FRAME-RATE=120,AUDIO="aud2"\n',
       'video2\n',
+      '#EXT-X-STREAM-INF:BANDWIDTH=300,CODECS="avc1,mp4a",',
+      'RESOLUTION=960x540,FRAME-RATE=120,AUDIO="aud3"\n',
+      'video3\n',
       '#EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="aud1",LANGUAGE="eng",',
       'URI="audio"\n',
       '#EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="aud2",LANGUAGE="fr",',
       'URI="audio2"\n',
+      '#EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="aud3",LANGUAGE="de",',
+      'URI="audio3"\n',
     ].join('');
 
     const media = [
@@ -2456,17 +2468,26 @@ describe('HlsParser', () => {
       'main.mp4',
     ].join('');
 
-    const mediaWithAesEncryption = [
+    const mediaWithMp4AesEncryption = [
       '#EXTM3U\n',
       '#EXT-X-PLAYLIST-TYPE:VOD\n',
       '#EXT-X-KEY:METHOD=AES-128,',
-      'URI="800k.key\n',
+      'URI="800k.key"\n',
       '#EXT-X-MAP:URI="init.mp4",BYTERANGE="616@0"\n',
       '#EXTINF:5,\n',
       '#EXT-X-BYTERANGE:121090@616\n',
       'main.mp4',
     ].join('');
 
+    const mediaWithTSAesEncryption = [
+      '#EXTM3U\n',
+      '#EXT-X-PLAYLIST-TYPE:VOD\n',
+      '#EXT-X-KEY:METHOD=AES-128,',
+      'URI="800k.key"\n',
+      '#EXTINF:5,\n',
+      'main.ts',
+    ].join('');
+
     const manifest = shaka.test.ManifestGenerator.generate((manifest) => {
       manifest.anyTimeline();
       manifest.addPartialVariant((variant) => {
@@ -2478,6 +2499,24 @@ describe('HlsParser', () => {
           stream.language = 'en';
         });
       });
+      manifest.addPartialVariant((variant) => {
+        variant.bandwidth = 300;
+        variant.addPartialStream(ContentType.VIDEO, (stream) => {
+          stream.size(960, 540);
+        });
+        variant.addPartialStream(ContentType.AUDIO, (stream) => {
+          stream.language = 'fr';
+        });
+      });
+      manifest.addPartialVariant((variant) => {
+        variant.bandwidth = 300;
+        variant.addPartialStream(ContentType.VIDEO, (stream) => {
+          stream.size(960, 540);
+        });
+        variant.addPartialStream(ContentType.AUDIO, (stream) => {
+          stream.language = 'de';
+        });
+      });
       manifest.sequenceMode = true;
     });
 
@@ -2485,12 +2524,15 @@ describe('HlsParser', () => {
         .setResponseText('test:/master', master)
         .setResponseText('test:/audio', media)
         .setResponseText('test:/audio2', media)
+        .setResponseText('test:/audio3', media)
         .setResponseText('test:/video', media)
-        .setResponseText('test:/video2', mediaWithAesEncryption)
+        .setResponseText('test:/video2', mediaWithMp4AesEncryption)
+        .setResponseText('test:/video3', mediaWithTSAesEncryption)
         .setResponseText('test:/main.vtt', vttText)
         .setResponseValue('test:/init.mp4', initSegmentData)
         .setResponseValue('test:/main.mp4', segmentData)
         .setResponseValue('test:/main.test', segmentData)
+        .setResponseValue('test:/800k.key', aes128Key)
         .setResponseValue('test:/selfInit.mp4', selfInitializingSegmentData);
 
     const actual = await parser.start('test:/master', playerInterface);
@@ -2674,7 +2716,9 @@ describe('HlsParser', () => {
           .setResponseText('test:/video', media)
           .setResponseValue('test:/main.exe', segmentData)
           .setResponseValue('test:/init.mp4', initSegmentData)
-          .setResponseValue('test:/main.mp4', segmentData);
+          .setResponseValue('test:/main.mp4', segmentData)
+          .setResponseValue('data:text/plain;base64,AAECAwQFBgcICQoLDA0ODw==',
+              aes128Key);
 
       await expectAsync(parser.start('test:/master', playerInterface))
           .toBeRejectedWith(Util.jasmineError(error));
@@ -2708,34 +2752,6 @@ describe('HlsParser', () => {
       await verifyError(master, media, error);
     });
 
-    it('if all variants are encrypted with AES-128', async () => {
-      const master = [
-        '#EXTM3U\n',
-        '#EXT-X-STREAM-INF:BANDWIDTH=200,CODECS="avc1",',
-        'RESOLUTION=960x540,FRAME-RATE=60\n',
-        'video\n',
-      ].join('');
-
-      const media = [
-        '#EXTM3U\n',
-        '#EXT-X-TARGETDURATION:6\n',
-        '#EXT-X-PLAYLIST-TYPE:VOD\n',
-        '#EXT-X-KEY:METHOD=AES-128,',
-        'URI="data:text/plain;base64\n',
-        '#EXT-X-MAP:URI="init.mp4"\n',
-        '#EXTINF:5,\n',
-        '#EXT-X-BYTERANGE:121090@616\n',
-        'main.mp4',
-      ].join('');
-
-      const error = new shaka.util.Error(
-          shaka.util.Error.Severity.CRITICAL,
-          shaka.util.Error.Category.MANIFEST,
-          Code.HLS_AES_128_ENCRYPTION_NOT_SUPPORTED);
-
-      await verifyError(master, media, error);
-    });
-
     describe('if required attributes are missing', () => {
       /**
        * @param {string} master

package/test/media/drm_engine_integration.js

@@ -209,10 +209,10 @@ describe('DrmEngine', () => {
       await drmEngine.initForPlayback(variants, manifest.offlineSessionIds);
       await drmEngine.attach(video);
       await mediaSourceEngine.appendBuffer(
-          ContentType.VIDEO, videoInitSegment, null, null,
+          ContentType.VIDEO, videoInitSegment, null,
           /* hasClosedCaptions= */ false);
       await mediaSourceEngine.appendBuffer(
-          ContentType.AUDIO, audioInitSegment, null, null,
+          ContentType.AUDIO, audioInitSegment, null,
           /* hasClosedCaptions= */ false);
       await encryptedEventSeen;
       // With PlayReady, a persistent license policy can cause a different
@@ -245,11 +245,13 @@ describe('DrmEngine', () => {
         }
       }
 
+      const reference = dummyReference(0, 10);
+
       await mediaSourceEngine.appendBuffer(
-          ContentType.VIDEO, videoSegment, 0, 10,
+          ContentType.VIDEO, videoSegment, reference,
           /* hasClosedCaptions= */ false);
       await mediaSourceEngine.appendBuffer(
-          ContentType.AUDIO, audioSegment, 0, 10,
+          ContentType.AUDIO, audioSegment, reference,
           /* hasClosedCaptions= */ false);
 
       expect(video.buffered.end(0)).toBeGreaterThan(0);
@@ -305,10 +307,10 @@ describe('DrmEngine', () => {
       await drmEngine.initForPlayback(variants, manifest.offlineSessionIds);
       await drmEngine.attach(video);
       await mediaSourceEngine.appendBuffer(
-          ContentType.VIDEO, videoInitSegment, null, null,
+          ContentType.VIDEO, videoInitSegment, null,
           /* hasClosedCaptions= */ false);
       await mediaSourceEngine.appendBuffer(
-          ContentType.AUDIO, audioInitSegment, null, null,
+          ContentType.AUDIO, audioInitSegment, null,
           /* hasClosedCaptions= */ false);
       await encryptedEventSeen;
 
@@ -326,11 +328,13 @@ describe('DrmEngine', () => {
         }
       }
 
+      const reference = dummyReference(0, 10);
+
       await mediaSourceEngine.appendBuffer(
-          ContentType.VIDEO, videoSegment, 0, 10,
+          ContentType.VIDEO, videoSegment, reference,
           /* hasClosedCaptions= */ false);
       await mediaSourceEngine.appendBuffer(
-          ContentType.AUDIO, audioSegment, 0, 10,
+          ContentType.AUDIO, audioSegment, reference,
           /* hasClosedCaptions= */ false);
 
       expect(video.buffered.end(0)).toBeGreaterThan(0);
@@ -345,4 +349,16 @@ describe('DrmEngine', () => {
       expect(video.currentTime).toBeGreaterThan(0);
     });
   });  // describe('ClearKey')
+
+  function dummyReference(startTime, endTime) {
+    return new shaka.media.SegmentReference(
+        startTime, endTime,
+        /* uris= */ () => ['foo://bar'],
+        /* startByte= */ 0,
+        /* endByte= */ null,
+        /* initSegmentReference= */ null,
+        /* timestampOffset= */ 0,
+        /* appendWindowStart= */ 0,
+        /* appendWindowEnd= */ Infinity);
+  }
 });

package/test/media/media_source_engine_integration.js

@@ -57,32 +57,32 @@ describe('MediaSourceEngine', () => {
 
   function appendInit(type) {
     const segment = generators[type].getInitSegment(Date.now() / 1000);
+    const reference = null;
     return mediaSourceEngine.appendBuffer(
-        type, segment, null, null, /* hasClosedCaptions= */ false);
+        type, segment, reference, /* hasClosedCaptions= */ false);
   }
 
   function append(type, segmentNumber) {
     const segment = generators[type]
         .getSegment(segmentNumber, Date.now() / 1000);
+    const reference = dummyReference(type, segmentNumber);
     return mediaSourceEngine.appendBuffer(
-        type, segment, null, null, /* hasClosedCaptions= */ false);
+        type, segment, reference, /* hasClosedCaptions= */ false);
   }
 
-  // The start time and end time should be null for init segment with closed
-  // captions.
   function appendInitWithClosedCaptions(type) {
     const segment = generators[type].getInitSegment(Date.now() / 1000);
-    return mediaSourceEngine.appendBuffer(type, segment, /* startTime= */ null,
-        /* endTime= */ null, /* hasClosedCaptions= */ true);
+    const reference = null;
+    return mediaSourceEngine.appendBuffer(
+        type, segment, reference, /* hasClosedCaptions= */ true);
   }
 
-  // The start time and end time should be valid for the segments with closed
-  // captions.
   function appendWithClosedCaptions(type, segmentNumber) {
     const segment = generators[type]
         .getSegment(segmentNumber, Date.now() / 1000);
-    return mediaSourceEngine.appendBuffer(type, segment, /* startTime= */ 0,
-        /* endTime= */ 2, /* hasClosedCaptions= */ true);
+    const reference = dummyReference(type, segmentNumber);
+    return mediaSourceEngine.appendBuffer(
+        type, segment, reference, /* hasClosedCaptions= */ true);
   }
 
   function buffered(type, time) {
@@ -93,6 +93,20 @@ describe('MediaSourceEngine', () => {
     return mediaSourceEngine.bufferStart(type);
   }
 
+  function dummyReference(type, segmentNumber) {
+    const start = segmentNumber * metadata[type].segmentDuration;
+    const end = (segmentNumber + 1) * metadata[type].segmentDuration;
+    return new shaka.media.SegmentReference(
+        start, end,
+        /* uris= */ () => ['foo://bar'],
+        /* startByte= */ 0,
+        /* endByte= */ null,
+        /* initSegmentReference= */ null,
+        /* timestampOffset= */ 0,
+        /* appendWindowStart= */ 0,
+        /* appendWindowEnd= */ Infinity);
+  }
+
   function remove(type, segmentNumber) {
     const start = segmentNumber * metadata[type].segmentDuration;
     const end = (segmentNumber + 1) * metadata[type].segmentDuration;