feat: Store bandwidth info inside references. (#6825)

Issue #6725

---------

Co-authored-by: Álvaro Velad Galván <[email protected]>

Author: theodab

lib/dash/segment_base.js

@@ -194,6 +194,7 @@ shaka.dash.SegmentBase = class {
     for (const ref of references) {
       ref.codecs = context.representation.codecs;
       ref.mimeType = context.representation.mimeType;
+      ref.bandwidth = context.bandwidth;
     }
 
     presentationTimeline.notifySegments(references);

lib/dash/segment_list.js

@@ -62,7 +62,7 @@ shaka.dash.SegmentList = class {
         context.periodInfo.start, context.periodInfo.duration,
         info.startNumber, context.representation.getBaseUris, info,
         initSegmentReference, aesKey, context.representation.mimeType,
-        context.representation.codecs, context.urlParams);
+        context.representation.codecs, context.bandwidth, context.urlParams);
 
     const isNew = !segmentIndex;
     if (segmentIndex) {
@@ -203,13 +203,14 @@ shaka.dash.SegmentList = class {
    * @param {shaka.extern.aesKey|undefined} aesKey
    * @param {string} mimeType
    * @param {string} codecs
+   * @param {number} bandwidth
    * @param {function():string} urlParams
    * @return {!Array.<!shaka.media.SegmentReference>}
    * @private
    */
   static createSegmentReferences_(
       periodStart, periodDuration, startNumber, getBaseUris, info,
-      initSegmentReference, aesKey, mimeType, codecs, urlParams) {
+      initSegmentReference, aesKey, mimeType, codecs, bandwidth, urlParams) {
     const ManifestParserUtils = shaka.util.ManifestParserUtils;
 
     let max = info.mediaSegments.length;
@@ -274,6 +275,7 @@ shaka.dash.SegmentList = class {
           aesKey);
       ref.codecs = codecs;
       ref.mimeType = mimeType;
+      ref.bandwidth = bandwidth;
       references.push(ref);
       prevEndTime = endTime;
     }

lib/dash/segment_template.js

@@ -275,6 +275,7 @@ shaka.dash.SegmentTemplate = class {
       indexTemplate: index,
       mimeType: context.representation.mimeType,
       codecs: context.representation.codecs,
+      bandwidth: context.bandwidth,
       numChunks: numChunks,
     };
   }
@@ -589,6 +590,7 @@ shaka.dash.SegmentTemplate = class {
           aesKey);
       ref.codecs = context.representation.codecs;
       ref.mimeType = context.representation.mimeType;
+      ref.bandwidth = context.bandwidth;
       // This is necessary information for thumbnail streams:
       ref.trueEndTime = trueSegmentEnd;
       return ref;
@@ -1003,6 +1005,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
       }
       const codecs = this.templateInfo_.codecs;
       const mimeType = this.templateInfo_.mimeType;
+      const bandwidth = this.templateInfo_.bandwidth;
 
       const partialSegmentRefs = [];
 
@@ -1048,6 +1051,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
             this.aesKey_);
         partial.codecs = codecs;
         partial.mimeType = mimeType;
+        partial.bandwidth = bandwidth;
         if (this.segmentSequenceCadence_ == 0) {
           if (i > 0) {
             partial.markAsNonIndependent();
@@ -1095,6 +1099,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
       ref.codecs = codecs;
       ref.mimeType = mimeType;
       ref.trueEndTime = trueSegmentEnd;
+      ref.bandwidth = bandwidth;
       this.references[correctedPosition] = ref;
     }
 
@@ -1132,6 +1137,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
  *   indexTemplate: ?string,
  *   mimeType: string,
  *   codecs: string,
+ *   bandwidth: number,
  *   numChunks: number
  * }}
  *
@@ -1158,6 +1164,8 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
  *   The mimeType.
  * @property {string} codecs
  *   The codecs.
+ * @property {number} bandwidth
+ *   The bandwidth.
  * @property {number} numChunks
  *   The number of chunks in each segment.
  */

lib/media/segment_reference.js

@@ -321,6 +321,9 @@ shaka.media.SegmentReference = class {
     /** @type {?string} */
     this.mimeType = null;
 
+    /** @type {?number} */
+    this.bandwidth = null;
+
     /** @type {BufferSource|null} */
     this.segmentData = null;
   }

lib/player.js

@@ -6256,7 +6256,7 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       const info = /** @type {!shaka.extern.PlaybackStreamInfo} */ ({
         'codecs': reference.codecs || stream.codecs,
         'mimeType': reference.mimeType || stream.mimeType,
-        'bandwidth': stream.bandwidth,
+        'bandwidth': reference.bandwidth || stream.bandwidth,
       });
       if (stream.type == ContentType.VIDEO) {
         output['video'] = info;

test/dash/dash_parser_live_unit.js

@@ -114,7 +114,7 @@ describe('DashParser Live', () => {
    */
   function cloneRefs(references) {
     return references.map((ref) => {
-      return new shaka.media.SegmentReference(
+      const clone = new shaka.media.SegmentReference(
           ref.startTime,
           ref.endTime,
           ref.getUrisInner,
@@ -124,6 +124,10 @@ describe('DashParser Live', () => {
           ref.timestampOffset,
           ref.appendWindowStart,
           ref.appendWindowEnd);
+      clone.codecs = ref.codecs;
+      clone.mimeType = ref.mimeType;
+      clone.bandwidth = ref.bandwidth;
+      return clone;
     });
   }
 

test/dash/dash_parser_segment_template_unit.js

@@ -926,6 +926,7 @@ function makeTemplateInfo(timeline) {
     'indexTemplate': null,
     'mimeType': 'video/mp4',
     'codecs': 'avc1.42E01E',
+    'bandwidth': 0,
     'numChunks': 0,
   };
 }

test/test/util/manifest_parser_util.js

@@ -96,6 +96,9 @@ shaka.test.ManifestParser = class {
         /* tileDuration= */ undefined,
         syncTime);
     ref.discontinuitySequence = /** @type {?} */(jasmine.any(Number));
+    ref.bandwidth = /** @type {?} */(new shaka.test.AnyOrNull(Number));
+    ref.codecs = /** @type {?} */(jasmine.any(String));
+    ref.mimeType = /** @type {?} */(jasmine.any(String));
     return ref;
   }
 };

test/test/util/util.js

@@ -28,6 +28,36 @@ shaka.test.StatusPromise = class {
   }
 };
 
+shaka.test.AnyOrNull = class {
+  /** @param {Function} factory */
+  constructor(factory) {
+    /** @type {!Object} */
+    this.any = jasmine.any(factory);
+  }
+
+  /**
+   * @param {?Object} other
+   * @return {boolean}
+   * @suppress {checkTypes}
+   */
+  asymmetricMatch(other) {
+    if (other == null) {
+      return true;
+    } else {
+      return this.any.asymmetricMatch(other);
+    }
+  }
+
+  /**
+   * @return {boolean}
+   * @suppress {checkTypes}
+   */
+  jasmineToString() {
+    return this.any.jasmineToString()
+        .replace('jasmine.any', 'shaka.test.AnyOrNull');
+  }
+};
+
 shaka.test.Util = class {
   /**
    * Fakes an event loop. Each tick processes some number of instantaneous