feat(Stats): Add manifestPeriodCount to stats

externs/shaka/manifest.js

@@ -22,7 +22,8 @@
  *   ignoreManifestTimestampsInSegmentsMode: boolean,
  *   type: string,
  *   serviceDescription: ?shaka.extern.ServiceDescription,
- *   nextUrl: ?string
+ *   nextUrl: ?string,
+ *   periodCount: number
  * }}
  *
  * @description
@@ -96,6 +97,11 @@
  *   decrease latency.
  * @property {?string} nextUrl
  *   The next url to play.
+ * @property {number} periodCount
+ *   Number of periods found in a manifest. For DASH, it represents number of
+ *   Period elements in a manifest. If streaming protocol does not implement
+ *   period-like structure, it should be set to 1.
+ *   <i>Defaults to <code>1</code>.</i>
  *
  * @exportDoc
  */

externs/shaka/player.js

@@ -89,6 +89,7 @@ shaka.extern.StateChange;
  *   bytesDownloaded: number,
  *
  *   nonFatalErrorCount: number,
+ *   manifestPeriodCount: number,
  *
  *   switchHistory: !Array.<shaka.extern.TrackChoice>,
  *   stateHistory: !Array.<shaka.extern.StateChange>
@@ -175,6 +176,10 @@ shaka.extern.StateChange;
  *
  * @property {number} nonFatalErrorCount
  *   The amount of non fatal errors that occurred.  If nothing is loaded, NaN.
+ * @property {number} manifestPeriodCount
+ *   The amount of periods occurred in the manifest. For DASH it represents
+ *   number of Period elements in a manifest. For HLS & MSS it is always 1.
+ *   In src= mode or if nothing is loaded, NaN.
  *
  * @property {!Array.<shaka.extern.TrackChoice>} switchHistory
  *   A history of the stream changes.

lib/dash/dash_parser.js

@@ -759,6 +759,7 @@ shaka.dash.DashParser = class {
         type: shaka.media.ManifestParser.DASH,
         serviceDescription: this.parseServiceDescription_(mpd),
         nextUrl: this.parseMpdChaining_(mpd),
+        periodCount: periods.length,
       };
 
       // We only need to do clock sync when we're using presentation start
@@ -779,8 +780,8 @@ shaka.dash.DashParser = class {
       // maintain consistency from here on.
       presentationTimeline.lockStartTime();
     } else {
-      await this.postPeriodProcessing_(
-          periodsAndDuration.periods, /* isPatchUpdate= */ false);
+      this.manifest_.periodCount = periods.length;
+      await this.postPeriodProcessing_(periods, /* isPatchUpdate= */ false);
     }
 
     // Add text streams to correspond to closed captions.  This happens right
@@ -901,6 +902,7 @@ shaka.dash.DashParser = class {
     }
 
     if (newPeriods.length) {
+      this.manifest_.periodCount += newPeriods.length;
       await this.postPeriodProcessing_(newPeriods, /* isPatchUpdate= */ true);
     }
     if (this.manifestPatchContext_.type == 'static') {
@@ -981,6 +983,7 @@ shaka.dash.DashParser = class {
    */
   removePatchPeriod_(periodId) {
     const SegmentTemplate = shaka.dash.SegmentTemplate;
+    this.manifest_.periodCount--;
     for (const contextId of this.contextCache_.keys()) {
       if (contextId.startsWith(periodId)) {
         const context = this.contextCache_.get(contextId);

lib/hls/hls_parser.js

@@ -914,6 +914,7 @@ shaka.hls.HlsParser = class {
       type: shaka.media.ManifestParser.HLS,
       serviceDescription: null,
       nextUrl: null,
+      periodCount: 1,
     };
 
     // If there is no 'CODECS' attribute in the manifest and codec guessing is

lib/mss/mss_parser.js

@@ -420,6 +420,7 @@ shaka.mss.MssParser = class {
         type: shaka.media.ManifestParser.MSS,
         serviceDescription: null,
         nextUrl: null,
+        periodCount: 1,
       };
 
       // This is the first point where we have a meaningful presentation start

lib/offline/manifest_converter.js

@@ -94,6 +94,7 @@ shaka.offline.ManifestConverter = class {
       type: manifestDB.type || shaka.media.ManifestParser.UNKNOWN,
       serviceDescription: null,
       nextUrl: null,
+      periodCount: 1,
     };
   }
 

lib/player.js

@@ -5337,10 +5337,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         this.stats_.setLiveLatency(latency);
       }
 
-      if (this.manifest_ && this.manifest_.presentationTimeline) {
-        const maxSegmentDuration =
-            this.manifest_.presentationTimeline.getMaxSegmentDuration();
-        this.stats_.setMaxSegmentDuration(maxSegmentDuration);
+      if (this.manifest_) {
+        this.stats_.setManifestPeriodCount(this.manifest_.periodCount);
+        if (this.manifest_.presentationTimeline) {
+          const maxSegmentDuration =
+              this.manifest_.presentationTimeline.getMaxSegmentDuration();
+          this.stats_.setMaxSegmentDuration(maxSegmentDuration);
+        }
       }
 
       const estimate = this.abrManager_.getBandwidthEstimate();

lib/util/stats.js

@@ -69,6 +69,8 @@ shaka.util.Stats = class {
 
     /** @private {number} */
     this.nonFatalErrorCount_ = 0;
+    /** @private {number} */
+    this.manifestPeriodCount_ = NaN;
 
     /** @private {!shaka.util.StateHistory} */
     this.stateHistory_ = new shaka.util.StateHistory();
@@ -234,6 +236,13 @@ shaka.util.Stats = class {
     this.nonFatalErrorCount_++;
   }
 
+  /**
+   * @param {number} count
+   */
+  setManifestPeriodCount(count) {
+    this.manifestPeriodCount_ = count;
+  }
+
   /**
    * @return {!shaka.util.StateHistory}
    */
@@ -278,6 +287,7 @@ shaka.util.Stats = class {
       manifestSizeBytes: this.manifestSizeBytes_,
       bytesDownloaded: this.bytesDownloaded_,
       nonFatalErrorCount: this.nonFatalErrorCount_,
+      manifestPeriodCount: this.manifestPeriodCount_,
       stateHistory: this.stateHistory_.getCopy(),
       switchHistory: this.switchHistory_.getCopy(),
     };
@@ -313,6 +323,7 @@ shaka.util.Stats = class {
       manifestSizeBytes: NaN,
       bytesDownloaded: NaN,
       nonFatalErrorCount: NaN,
+      manifestPeriodCount: NaN,
       switchHistory: [],
       stateHistory: [],
     };

test/dash/dash_parser_live_unit.js

@@ -414,6 +414,7 @@ describe('DashParser Live', () => {
     Date.now = () => 5;
 
     const manifest = await parser.start('dummy://foo', playerInterface);
+    expect(manifest.periodCount).toBe(1);
     const variant = manifest.variants[0];
     const stream = variant.video;
     await stream.createSegmentIndex();
@@ -428,6 +429,8 @@ describe('DashParser Live', () => {
 
     await updateManifest();
 
+    expect(manifest.periodCount).toBe(2);
+
     // The update should have affected the same variant object we captured
     // before.  Now the entire first period should exist (0-10s), plus the next
     // two segments (10-14s).
@@ -507,6 +510,7 @@ describe('DashParser Live', () => {
     Date.now = () => 5;
 
     const manifest = await parser.start('dummy://foo', playerInterface);
+    expect(manifest.periodCount).toBe(1);
     const variant = manifest.variants[0];
     const stream = variant.video;
     await stream.createSegmentIndex();
@@ -520,6 +524,8 @@ describe('DashParser Live', () => {
 
     await updateManifest();
 
+    expect(manifest.periodCount).toBe(2);
+
     // The update should have affected the same variant object we captured
     // before.  Now the entire first period should exist (0-40s), plus the next
     // two segments of the second period(40-60s).

test/dash/dash_parser_patch_unit.js

@@ -304,6 +304,7 @@ describe('DashParser Patch', () => {
   describe('Period', () => {
     it('adds new period as an MPD child', async () => {
       const manifest = await parser.start('dummy://foo', playerInterface);
+      expect(manifest.periodCount).toBe(1);
       const stream = manifest.variants[0].video;
       const patchText = [
         `<Patch mpdId="${mpdId}"`,
@@ -326,13 +327,15 @@ describe('DashParser Patch', () => {
       expect(stream.matchedStreams.length).toBe(1);
 
       await updateManifest();
+      expect(manifest.periodCount).toBe(2);
       await stream.createSegmentIndex();
 
       expect(stream.matchedStreams.length).toBe(2);
     });
 
     it('adds new period as a Period successor', async () => {
       const manifest = await parser.start('dummy://foo', playerInterface);
+      expect(manifest.periodCount).toBe(1);
       const stream = manifest.variants[0].video;
       const patchText = [
         `<Patch mpdId="${mpdId}"`,
@@ -355,6 +358,7 @@ describe('DashParser Patch', () => {
       expect(stream.matchedStreams.length).toBe(1);
 
       await updateManifest();
+      expect(manifest.periodCount).toBe(2);
       await stream.createSegmentIndex();
 
       expect(stream.matchedStreams.length).toBe(2);

test/media/playhead_unit.js

@@ -138,6 +138,7 @@ describe('Playhead', () => {
       type: 'UNKNOWN',
       serviceDescription: null,
       nextUrl: null,
+      periodCount: 1,
     };
 
     config = shaka.util.PlayerConfiguration.createDefault().streaming;

test/media/streaming_engine_integration.js

@@ -606,6 +606,7 @@ describe('StreamingEngine', () => {
         type: 'UNKNOWN',
         serviceDescription: null,
         nextUrl: null,
+        periodCount: 1,
         variants: [{
           id: 1,
           video: {

test/player_integration.js

@@ -222,6 +222,7 @@ describe('Player', () => {
         bytesDownloaded: jasmine.any(Number),
 
         nonFatalErrorCount: jasmine.any(Number),
+        manifestPeriodCount: jasmine.any(Number),
 
         // We should have loaded the first Period by now, so we should have a
         // history.

test/test/util/manifest_generator.js

@@ -105,6 +105,8 @@ shaka.test.ManifestGenerator.Manifest = class {
     this.serviceDescription = null;
     /** @type {?string} */
     this.nextUrl = null;
+    /** @type {number} */
+    this.periodCount = 1;
 
 
     /** @type {shaka.extern.Manifest} */

test/test/util/streaming_engine_util.js

@@ -321,6 +321,7 @@ shaka.test.StreamingEngineUtil = class {
       type: 'UNKNOWN',
       serviceDescription: null,
       nextUrl: null,
+      periodCount: 1,
     };
 
     /** @type {shaka.extern.Variant} */

ui/statistics_button.js

@@ -121,6 +121,10 @@ shaka.ui.StatisticsButton = class extends shaka.ui.Element {
       return this.currentStats_[name] + ' (errors)';
     };
 
+    const parsePeriods = (name) => {
+      return this.currentStats_[name] + ' (periods)';
+    };
+
     const parseBytes = (name) => {
       const bytes = parseInt(this.currentStats_[name], 10);
       if (bytes > 1e6) {
@@ -156,6 +160,7 @@ shaka.ui.StatisticsButton = class extends shaka.ui.Element {
       'manifestSizeBytes': parseBytes,
       'bytesDownloaded': parseBytes,
       'nonFatalErrorCount': parseErrors,
+      'manifestPeriodCount': parsePeriods,
     };
 
     /** @private {shaka.util.Timer} */