shaka-player 4.2.5 → 4.3.1

package/test/test/util/id3_generator.js

@@ -0,0 +1,100 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @summary
+ * A helper class used to generate ID3 metadata.
+ */
+shaka.test.Id3Generator = class {
+  /**
+   * Generate an ID3 from a frames.
+   *
+   * @param {!Uint8Array} frames
+   * @param {boolean=} extendedHeader
+   * @return {!Uint8Array}
+   */
+  static generateId3(frames, extendedHeader = false) {
+    const Id3Generator = shaka.test.Id3Generator;
+    const Uint8ArrayUtils = shaka.util.Uint8ArrayUtils;
+    let result = Uint8ArrayUtils.concat(
+        Id3Generator.stringToInts_('ID3'),
+        new Uint8Array([
+          0x03, 0x00,             // version 3.0 of ID3v2 (aka ID3v.2.3.0)
+          0x40,                   // flags. include an extended header
+          0x00, 0x00, 0x00, 0x00, // size. set later
+          // extended header
+          0x00, 0x00, 0x00, 0x06, // extended header size. no CRC
+          0x00, 0x00,             // extended flags
+          0x00, 0x00, 0x00, 0x02,  // size of padding
+        ]),
+        frames);
+    if (!extendedHeader) {
+      result = Uint8ArrayUtils.concat(
+          Id3Generator.stringToInts_('ID3'),
+          new Uint8Array([
+            0x03, 0x00,             // version 3.0 of ID3v2 (aka ID3v.2.3.0)
+            0x00,                   // flags
+            0x00, 0x00, 0x00, 0x00, // size. set later
+          ]),
+          frames);
+    }
+
+    // size is stored as a sequence of four 7-bit integers with the
+    // high bit of each byte set to zero
+    const size = result.length - 10;
+
+    result[6] = (size >>> 21) & 0x7f;
+    result[7] = (size >>> 14) & 0x7f;
+    result[8] = (size >>> 7) & 0x7f;
+    result[9] = size & 0x7f;
+
+    return result;
+  }
+
+  /**
+   * Generate an ID3 frame from a type and value.
+   *
+   * @param {string} type
+   * @param {!Uint8Array} value
+   * @return {!Uint8Array}
+   */
+  static generateId3Frame(type, value) {
+    goog.asserts.assert(type, 'type must be non-null');
+    goog.asserts.assert(type.length == 4, 'type must contain 4 characters');
+    const Id3Generator = shaka.test.Id3Generator;
+    const Uint8ArrayUtils = shaka.util.Uint8ArrayUtils;
+    const result = Uint8ArrayUtils.concat(
+        Id3Generator.stringToInts_(type),
+        new Uint8Array([
+          0x00, 0x00, 0x00, 0x00, // size
+          0xe0, 0x00,             // flags
+        ]),
+        value);
+
+    // set the size
+    const size = result.length - 10;
+
+    result[4] = (size >>> 21) & 0x7f;
+    result[5] = (size >>> 14) & 0x7f;
+    result[6] = (size >>> 7) & 0x7f;
+    result[7] = size & 0x7f;
+
+    return result;
+  }
+
+  /**
+   * @param {string} string
+   * @return {!Uint8Array}
+   * @private
+   */
+  static stringToInts_(string) {
+    const result = [];
+    for (let i = 0; i < string.length; i++) {
+      result[i] = string.charCodeAt(i);
+    }
+    return new Uint8Array(result);
+  }
+};

package/test/test/util/manifest_generator.js

@@ -393,8 +393,8 @@ shaka.test.ManifestGenerator.DrmInfo = class {
     this.videoRobustness = '';
     /** @type {Uint8Array} */
     this.serverCertificate = null;
-    /** @type {Array.<shaka.extern.InitDataOverride>} */
-    this.initData = null;
+    /** @type {!Array.<shaka.extern.InitDataOverride>} */
+    this.initData = [];
     /** @type {Set.<string>} */
     this.keyIds = new Set();
     /** @type {string} */
@@ -422,10 +422,7 @@ shaka.test.ManifestGenerator.DrmInfo = class {
    * @param {!Uint8Array} buffer
    */
   addInitData(type, buffer) {
-    if (!this.initData) {
-      this.initData = [];
-    }
-    this.initData.push({initData: buffer, initDataType: type});
+    this.initData.push({initData: buffer, initDataType: type, keyId: null});
   }
 
   /**

package/test/test/util/simple_fakes.js

@@ -512,5 +512,9 @@ shaka.test.FakeTransmuxer = class {
     /** @type {!jasmine.Spy} */
     this.transmux =
         jasmine.createSpy('transmux').and.returnValue(Promise.resolve(output));
+
+    /** @type {!jasmine.Spy} */
+    this.getOrginalMimeType =
+        jasmine.createSpy('getOrginalMimeType').and.returnValue('mimeType');
   }
 };

package/test/test/util/stream_generator.js

@@ -287,6 +287,44 @@ shaka.test.TSVodStreamGenerator = class {
   }
 };
 
+/**
+ * @summary
+ * Simulates an HLS, video-on-demand, aac stream.  The StreamGenerator assumes
+ * the stream contains a single segment.
+ *
+ * @implements {shaka.test.IStreamGenerator}
+ */
+shaka.test.AACVodStreamGenerator = class {
+  /** @param {string} segmentUri The URI of the segment. */
+  constructor(segmentUri) {
+    /** @private {string} */
+    this.segmentUri_ = segmentUri;
+
+    /** @private {ArrayBuffer} */
+    this.segment_ = null;
+  }
+
+  /** @override */
+  async init() {
+    const segment = await shaka.test.Util.fetch(this.segmentUri_);
+    this.segment_ = segment;
+  }
+
+  /** @override */
+  getInitSegment(time) {
+    goog.asserts.assert(false, 'getInitSegment not implemented for HLS VOD.');
+    return new ArrayBuffer(0);
+  }
+
+  /** @override */
+  getSegment(position, wallClockTime) {
+    goog.asserts.assert(
+        this.segment_,
+        'init() must be called before getSegment().');
+    return this.segment_;
+  }
+};
+
 /**
  * @summary
  * Simulates a DASH, video-on-demand, MP4 stream.  The StreamGenerator loops a

package/test/test/util/test_scheme.js

@@ -52,7 +52,8 @@ let ExtraMetadataType;
  *   duration: number,
  *   licenseServers: (!Object.<string, string>|undefined),
  *   licenseRequestHeaders: (!Object.<string, string>|undefined),
- *   sequenceMode: boolean
+ *   customizeStream: (function(shaka.test.ManifestGenerator.Stream)|undefined),
+ *   sequenceMode: (boolean|undefined)
  * }}
  */
 let MetadataType;
@@ -175,6 +176,9 @@ shaka.test.TestScheme = class {
         return new shaka.test.TSVodStreamGenerator(
             metadata.segmentUri, metadata.segmentDuration);
       }
+      if (metadata.segmentUri.includes('.aac')) {
+        return new shaka.test.AACVodStreamGenerator(metadata.segmentUri);
+      }
       return new shaka.test.Mp4VodStreamGenerator(
           metadata.initSegmentUri, metadata.mdhdOffset, metadata.segmentUri,
           metadata.tfdtOffset, metadata.segmentDuration);
@@ -244,6 +248,10 @@ shaka.test.TestScheme = class {
           });
         }
       }
+
+      if (data.customizeStream) {
+        data.customizeStream(stream);
+      }
     }
 
     /**
@@ -280,7 +288,7 @@ shaka.test.TestScheme = class {
 
       const manifest = shaka.test.ManifestGenerator.generate((manifest) => {
         manifest.presentationTimeline.setDuration(data.duration);
-        manifest.sequenceMode = data.sequenceMode;
+        manifest.sequenceMode = data.sequenceMode || false;
 
         const videoResolutions = data.videoResolutions || [undefined];
         const audioLanguages = data.audioLanguages ||
@@ -514,7 +522,6 @@ shaka.test.TestScheme.DATA = {
     audio: sintelAudioSegment,
     text: vttSegment,
     duration: 30,
-    sequenceMode: false,
   },
 
   // Like 'sintel', but flagged as sequence mode.
@@ -531,7 +538,6 @@ shaka.test.TestScheme.DATA = {
     video: sintelVideoSegment,
     audio: sintelAudioSegment,
     duration: 300,
-    sequenceMode: false,
   },
 
   // Like 'sintel' above, but with languages and delayed setup.
@@ -548,7 +554,6 @@ shaka.test.TestScheme.DATA = {
       language: 'fa',  // Necessary to repro #1696
     }),
     duration: 30,
-    sequenceMode: false,
   },
 
   'sintel_multi_lingual_multi_res': {
@@ -562,20 +567,17 @@ shaka.test.TestScheme.DATA = {
     audioLanguages: ['en', 'es'],
     textLanguages: ['zh', 'fr'],
     duration: 30,
-    sequenceMode: false,
   },
 
   'sintel_audio_only': {
     audio: sintelAudioSegment,
     duration: 30,
-    sequenceMode: false,
   },
 
   'sintel_no_text': {
     video: sintelVideoSegment,
     audio: sintelAudioSegment,
     duration: 30,
-    sequenceMode: false,
   },
 
   // https://github.com/shaka-project/shaka-player/issues/2553
@@ -584,7 +586,6 @@ shaka.test.TestScheme.DATA = {
     text: vttSegment,
     textLanguages: ['de', 'de'],  // one of these is the "forced subs" track
     duration: 30,
-    sequenceMode: false,
   },
 
   'sintel-enc': {
@@ -593,7 +594,19 @@ shaka.test.TestScheme.DATA = {
     text: vttSegment,
     licenseServers: widevineDrmServers,
     duration: 30,
-    sequenceMode: false,
+  },
+
+  // Equivalent to what you get with HLS METHOD=SAMPLE-AES, KEYFORMAT=identity.
+  // Requires explicit clear keys or license server configuration.
+  'sintel-hls-clearkey': {
+    video: sintelEncryptedVideo,
+    audio: sintelEncryptedAudio,
+    duration: 30,
+    sequenceMode: true,
+    customizeStream: (stream) => {
+      stream.encrypted = true;
+      stream.addDrmInfo('org.w3.clearkey');
+    },
   },
 
   'multidrm': {
@@ -603,7 +616,6 @@ shaka.test.TestScheme.DATA = {
     licenseServers: axinomDrmServers,
     licenseRequestHeaders: axinomDrmHeaders,
     duration: 30,
-    sequenceMode: false,
   },
 
   'multidrm_no_init_data': {
@@ -616,7 +628,6 @@ shaka.test.TestScheme.DATA = {
     licenseServers: axinomDrmServers,
     licenseRequestHeaders: axinomDrmHeaders,
     duration: 30,
-    sequenceMode: false,
   },
 
   'cea-708_ts': {
@@ -630,7 +641,6 @@ shaka.test.TestScheme.DATA = {
       mimeType: 'application/cea-608',
     },
     duration: 30,
-    sequenceMode: false,
   },
 
   'cea-708_mp4': {
@@ -645,7 +655,26 @@ shaka.test.TestScheme.DATA = {
       closedCaptions: new Map([['CC1', 'en']]),
     },
     duration: 30,
-    sequenceMode: false,
+  },
+
+  'id3-metadata_ts': {
+    audio: {
+      segmentUri: '/base/test/test/assets/id3-metadata.ts',
+      mimeType: 'video/mp2t',
+      codecs: 'mp4a.40.5',
+      segmentDuration: 5,
+    },
+    duration: 4.99,
+  },
+
+  'id3-metadata_aac': {
+    audio: {
+      segmentUri: '/base/test/test/assets/id3-metadata.aac',
+      mimeType: 'audio/aac',
+      codecs: '',
+      segmentDuration: 9.98458,
+    },
+    duration: 9.98458,
   },
 };
 

package/test/text/vtt_text_parser_unit.js

@@ -849,6 +849,17 @@ describe('VttTextParser', () => {
         {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
   });
 
+  it('support escaped html payload', () => {
+    verifyHelper(
+        [
+          {startTime: 20.1, endTime: 40.505, payload: '"Test & 1"'},
+        ],
+        'WEBVTT\n\n' +
+        '00:00:20.100 --> 00:00:40.505\n' +
+        '"Test & 1"',
+        {periodStart: 0, segmentStart: 0, segmentEnd: 0, vttOffset: 0});
+  });
+
   it('supports specific style blocks', () => {
     verifyHelper(
         [

package/test/util/id3_utils_unit.js

@@ -0,0 +1,116 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+describe('Id3Utils', () => {
+  const Id3Utils = shaka.util.Id3Utils;
+  const Id3Generator = shaka.test.Id3Generator;
+  const BufferUtils = shaka.util.BufferUtils;
+
+  it('no valid data produces empty output', () => {
+    expect(Id3Utils.getID3Frames(new Uint8Array([]))).toEqual([]);
+  });
+
+  it('parse a TXXX frame', () => {
+    const txxxValue = new Uint8Array([3, 65, 0, 83, 104, 97, 107, 97]);
+    const txxxFrame = Id3Generator.generateId3Frame('TXXX', txxxValue);
+    const txxxID3 = Id3Generator.generateId3(txxxFrame);
+    const expectedID3 = [
+      {
+        key: 'TXXX',
+        description: 'A',
+        data: 'Shaka',
+      },
+    ];
+    expect(Id3Utils.getID3Frames(txxxID3)).toEqual(expectedID3);
+  });
+
+  it('parse a TXXX frame with extended header', () => {
+    const txxxValue = new Uint8Array([3, 65, 0, 83, 104, 97, 107, 97]);
+    const txxxFrame = Id3Generator.generateId3Frame('TXXX', txxxValue);
+    const txxxID3 = Id3Generator.generateId3(txxxFrame, true);
+    const expectedID3 = [
+      {
+        key: 'TXXX',
+        description: 'A',
+        data: 'Shaka',
+      },
+    ];
+    expect(Id3Utils.getID3Frames(txxxID3)).toEqual(expectedID3);
+  });
+
+  it('parse a TCOP frame', () => {
+    const tcopValue = new Uint8Array(
+        [3, 83, 104, 97, 107, 97, 32, 50, 48, 49, 54]);
+    const tcopFrame = Id3Generator.generateId3Frame('TCOP', tcopValue);
+    const tcopID3 = Id3Generator.generateId3(tcopFrame);
+    const expectedID3 = [
+      {
+        key: 'TCOP',
+        description: '',
+        data: 'Shaka 2016',
+      },
+    ];
+    expect(Id3Utils.getID3Frames(tcopID3)).toEqual(expectedID3);
+  });
+
+  it('parse a WXXX frame', () => {
+    const wxxxValue = new Uint8Array(
+        [3, 65, 0, 103, 111, 111, 103, 108, 101, 46, 99, 111, 109]);
+    const wxxxFrame = Id3Generator.generateId3Frame('WXXX', wxxxValue);
+    const wxxxID3 = Id3Generator.generateId3(wxxxFrame);
+    const expectedID3 = [
+      {
+        key: 'WXXX',
+        description: 'A',
+        data: 'google.com',
+      },
+    ];
+    expect(Id3Utils.getID3Frames(wxxxID3)).toEqual(expectedID3);
+  });
+
+  it('parse a WCOP frame', () => {
+    const wcopValue = new Uint8Array(
+        [103, 111, 111, 103, 108, 101, 46, 99, 111, 109]);
+    const wcopFrame = Id3Generator.generateId3Frame('WCOP', wcopValue);
+    const wcopID3 = Id3Generator.generateId3(wcopFrame);
+    const expectedID3 = [
+      {
+        key: 'WCOP',
+        description: '',
+        data: 'google.com',
+      },
+    ];
+    expect(Id3Utils.getID3Frames(wcopID3)).toEqual(expectedID3);
+  });
+
+  it('parse a PRIV frame', () => {
+    const privValue = new Uint8Array([65, 0, 83, 104, 97, 107]);
+    const privFrame = Id3Generator.generateId3Frame('PRIV', privValue);
+    const privID3 = Id3Generator.generateId3(privFrame);
+    const expectedID3 = [
+      {
+        key: 'PRIV',
+        description: 'A',
+        data: BufferUtils.toArrayBuffer(new Uint8Array([83, 104, 97, 107])),
+      },
+    ];
+    expect(Id3Utils.getID3Frames(privID3)).toEqual(expectedID3);
+  });
+
+  it('parse an unknown frame', () => {
+    const unknownValue = new Uint8Array([83, 104, 97, 107]);
+    const unknownFrame = Id3Generator.generateId3Frame('XXXX', unknownValue);
+    const unknownID3 = Id3Generator.generateId3(unknownFrame);
+    const expectedID3 = [
+      {
+        key: 'XXXX',
+        description: '',
+        data: BufferUtils.toArrayBuffer(new Uint8Array([83, 104, 97, 107])),
+      },
+    ];
+    expect(Id3Utils.getID3Frames(unknownID3)).toEqual(expectedID3);
+  });
+});

package/test/util/ts_parser_unit.js

@@ -0,0 +1,77 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+describe('TsParser', () => {
+  const Util = shaka.test.Util;
+  const BufferUtils = shaka.util.BufferUtils;
+
+  it('probes a TS segment', async () => {
+    const responses = await Promise.all([
+      Util.fetch('/base/test/test/assets/video.ts'),
+      Util.fetch('/base/test/test/assets/audio.ts'),
+    ]);
+    const videoSegment = BufferUtils.toUint8(responses[0]);
+    const audioSegment = BufferUtils.toUint8(responses[1]);
+    expect(shaka.util.TsParser.probe(videoSegment)).toBeTruthy();
+    expect(shaka.util.TsParser.probe(audioSegment)).toBeTruthy();
+  });
+
+  it('probes a non TS segment', async () => {
+    const responses = await Promise.all([
+      Util.fetch('/base/test/test/assets/small.mp4'),
+    ]);
+    const nonTsSegment = BufferUtils.toUint8(responses[0]);
+    expect(shaka.util.TsParser.probe(nonTsSegment)).toBeFalsy();
+  });
+
+  it('parses a TS segment', async () => {
+    const responses = await Promise.all([
+      Util.fetch('/base/test/test/assets/video.ts'),
+      Util.fetch('/base/test/test/assets/audio.ts'),
+    ]);
+    const videoSegment = BufferUtils.toUint8(responses[0]);
+    const audioSegment = BufferUtils.toUint8(responses[1]);
+    expect(new shaka.util.TsParser().parse(videoSegment)).toBeDefined();
+    expect(new shaka.util.TsParser().parse(audioSegment)).toBeDefined();
+  });
+
+  it('parses a TS segment with metadata', async () => {
+    const responses = await Promise.all([
+      Util.fetch('/base/test/test/assets/id3-metadata.ts'),
+    ]);
+    const tsSegment = BufferUtils.toUint8(responses[0]);
+    const metadata = new shaka.util.TsParser().parse(tsSegment)
+        .getMetadata();
+    expect(metadata).toBeTruthy();
+    expect(metadata.length).toBe(2);
+    const firstMetadata = metadata[0];
+    expect(firstMetadata.frames.length).toBe(2);
+    const secondMetadata = metadata[1];
+    expect(secondMetadata.frames.length).toBe(2);
+  });
+
+  it('get the start time from a TS segment', async () => {
+    const responses = await Promise.all([
+      Util.fetch('/base/test/test/assets/id3-metadata.ts'),
+    ]);
+    const tsSegment = BufferUtils.toUint8(responses[0]);
+    const starttime = new shaka.util.TsParser().parse(tsSegment)
+        .getStartTime();
+    expect(starttime.audio).toBeCloseTo(90019.586, 3);
+    expect(starttime.video).toBe(null);
+  });
+
+  it('get the codecs from a TS segment', async () => {
+    const responses = await Promise.all([
+      Util.fetch('/base/test/test/assets/id3-metadata.ts'),
+    ]);
+    const tsSegment = BufferUtils.toUint8(responses[0]);
+    const codecs = new shaka.util.TsParser().parse(tsSegment)
+        .getCodecs();
+    expect(codecs.audio).toBe('aac');
+    expect(codecs.video).toBe('');
+  });
+});

package/third_party/closure-uri/uri.js

@@ -798,7 +798,7 @@ goog.Uri.QueryData.prototype.add = function(key, value) {
   // Invalidate the cache.
   this.encodedQuery_ = null;
 
-  var values = this.keyMap_.hasOwnProperty(key) && this.keyMap_[key];
+  var values = this.keyMap_.hasOwnProperty(key) ? this.keyMap_[key] : null;
   if (!values) {
     this.keyMap_[key] = (values = []);
   }

package/ui/less/containers.less

@@ -98,6 +98,13 @@
   }
 }
 
+/* A container for all canvas for LCEVC decoding
+ * Sits inside .shaka-video-container, on top of (Z axis) .shaka-video, and
+ * below (Y axis) .shaka-play-button-container. */
+.shaka-canvas-container {
+  .overlay-child();
+}
+
 /* Container for controls positioned at the bottom of the video container:
  * controls button panel and the seek bar. */
 .shaka-bottom-controls {

package/ui/ui.js

@@ -290,6 +290,12 @@ shaka.ui.Overlay = class {
     const videos = document.querySelectorAll(
         '[data-shaka-player]');
 
+    // Look for elements marked 'data-shaka-player-canvas'
+    // on the page. These will be used to create our default
+    // UI.
+    const canvases = document.querySelectorAll(
+        '[data-shaka-player-canvas]');
+
     if (!videos.length && !containers.length) {
       // No elements have been tagged with shaka attributes.
     } else if (videos.length && !containers.length) {
@@ -307,8 +313,21 @@ shaka.ui.Overlay = class {
         const videoParent = video.parentElement;
         videoParent.replaceChild(container, video);
         container.appendChild(video);
-
-        shaka.ui.Overlay.setupUIandAutoLoad_(container, video);
+        let currentCanvas = null;
+        for (const canvas of canvases) {
+          goog.asserts.assert(canvas.tagName.toLowerCase() == 'canvas',
+              'Should be a canvas element!');
+          if (canvas.parentElement == container) {
+            currentCanvas = canvas;
+            break;
+          }
+        }
+        if (!currentCanvas) {
+          currentCanvas = document.createElement('canvas');
+          currentCanvas.classList.add('shaka-canvas-container');
+          container.appendChild(currentCanvas);
+        }
+        shaka.ui.Overlay.setupUIandAutoLoad_(container, video, currentCanvas);
       }
     } else {
       for (const container of containers) {
@@ -336,9 +355,25 @@ shaka.ui.Overlay = class {
           container.appendChild(currentVideo);
         }
 
+        let currentCanvas = null;
+        for (const canvas of canvases) {
+          goog.asserts.assert(canvas.tagName.toLowerCase() == 'canvas',
+              'Should be a canvas element!');
+          if (canvas.parentElement == container) {
+            currentCanvas = canvas;
+            break;
+          }
+        }
+        if (!currentCanvas) {
+          currentCanvas = document.createElement('canvas');
+          currentCanvas.classList.add('shaka-canvas-container');
+          container.appendChild(currentCanvas);
+        }
+
         try {
           // eslint-disable-next-line no-await-in-loop
-          await shaka.ui.Overlay.setupUIandAutoLoad_(container, currentVideo);
+          await shaka.ui.Overlay.setupUIandAutoLoad_(
+              container, currentVideo, currentCanvas);
         } catch (e) {
           // This can fail if, for example, not every player file has loaded.
           // Ad-block is a likely cause for this sort of failure.
@@ -377,9 +412,10 @@ shaka.ui.Overlay = class {
   /**
    * @param {!Element} container
    * @param {!Element} video
+   * @param {!Element} canvas
    * @private
    */
-  static async setupUIandAutoLoad_(container, video) {
+  static async setupUIandAutoLoad_(container, video, canvas) {
     // Create the UI
     const player = new shaka.Player(
         shaka.util.Dom.asHTMLMediaElement(video));
@@ -387,6 +423,9 @@ shaka.ui.Overlay = class {
         shaka.util.Dom.asHTMLElement(container),
         shaka.util.Dom.asHTMLMediaElement(video));
 
+    // Attach Canvas used for LCEVC Decoding
+    player.attachCanvas(/** @type {HTMLCanvasElement} */(canvas));
+
     // Get and configure cast app id.
     let castAppId = '';