Source: lib/offline/download_info.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.offline.DownloadInfo');
  9. goog.require('shaka.util.Networking');
  10. goog.require('shaka.util.Uint8ArrayUtils');
  11. goog.requireType('shaka.media.InitSegmentReference');
  12. goog.requireType('shaka.media.SegmentReference');
  15. /**
  16.  * An object that represents a single segment, that the storage system will soon
  17.  * download, but has not yet started downloading.
  18.  */
  19. shaka.offline.DownloadInfo = class {
  20.   /**
  21.    * @param {shaka.media.SegmentReference|shaka.media.InitSegmentReference} ref
  22.    * @param {number} estimateId
  23.    * @param {number} groupId
  24.    * @param {boolean} isInitSegment
  25.    * @param {number} refPosition
  26.    */
  27.   constructor(ref, estimateId, groupId, isInitSegment, refPosition) {
  28.     /** @type {shaka.media.SegmentReference|shaka.media.InitSegmentReference} */
  29.     this.ref = ref;
  31.     /** @type {number} */
  32.     this.estimateId = estimateId;
  34.     /** @type {number} */
  35.     this.groupId = groupId;
  37.     /** @type {boolean} */
  38.     this.isInitSegment = isInitSegment;
  40.     /** @type {number} */
  41.     this.refPosition = refPosition;
  42.   }
  44.   /**
  45.    * Creates an ID that encapsulates all important information in the ref, which
  46.    * can then be used to check for equality.
  47.    * @param {shaka.media.SegmentReference|shaka.media.InitSegmentReference} ref
  48.    * @return {string}
  49.    */
  50.   static idForSegmentRef(ref) {
  51.     const segmentData = ref.getSegmentData();
  52.     if (segmentData) {
  53.       return shaka.util.Uint8ArrayUtils.toBase64(segmentData);
  54.     }
  55.     // Escape the URIs using encodeURI, to make sure that a weirdly formed URI
  56.     // cannot cause two unrelated refs to be considered equivalent.
  57.     const removeSprites = (uri) => {
  58.       return uri.split('#xywh=')[0];
  59.     };
  60.     return ref.getUris().map(
  61.         (uri) => '{' + encodeURI(removeSprites(uri)) + '}').join('') +
  62.         ':' + ref.startByte + ':' + ref.endByte;
  63.   }
  65.   /** @return {string} */
  66.   getRefId() {
  67.     return shaka.offline.DownloadInfo.idForSegmentRef(this.ref);
  68.   }
  70.   /**
  71.    * @param {shaka.extern.PlayerConfiguration} config
  72.    * @return {!shaka.extern.Request}
  73.    */
  74.   makeSegmentRequest(config) {
  75.     return shaka.util.Networking.createSegmentRequest(
  76.         this.ref.getUris(),
  77.         this.ref.startByte,
  78.         this.ref.endByte,
  79.         config.streaming.retryParameters);
  80.   }
  81. };