Simplify asset list progression and make interstitial logging more consistent

#7180

Author: robwalch

src/controller/interstitials-controller.ts

@@ -1044,17 +1044,7 @@ export default class InterstitialsController
     if (interstitial) {
       const itemIndex = schedule.findEventIndex(parentIdentifier);
       const assetListIndex = schedule.findAssetIndex(interstitial, time);
-      const validAssetIndex = getNextAssetIndex(
-        interstitial,
-        assetListIndex - 1,
-        true,
-      );
-      if (validAssetIndex === -1) {
-        // If -1 then there is no valid asset to play
-        this.advanceAfterAssetEnded(interstitial, itemIndex, assetListIndex);
-        return;
-      }
-      this.setSchedulePosition(itemIndex, validAssetIndex);
+      this.advanceAfterAssetEnded(interstitial, itemIndex, assetListIndex - 1);
     }
   }
 
@@ -1174,17 +1164,15 @@ export default class InterstitialsController
           interstitial,
           this.timelinePos,
         );
-        const validAssetListIndex = getNextAssetIndex(
+        const assetIndexCandidate = getNextAssetIndex(
           interstitial,
           assetListIndex - 1,
-          true,
         );
-        if (validAssetListIndex === -1) {
-          // If -1 then there is no valid asset to play
+        if (interstitial.isAssetPastPlayoutLimit(assetIndexCandidate)) {
           this.advanceAfterAssetEnded(interstitial, index, assetListIndex);
           return;
         }
-        assetListIndex = validAssetListIndex;
+        assetListIndex = assetIndexCandidate;
       }
       // Ensure Interstitial is enqueued
       const waitingItem = this.waitingItem;
@@ -1334,7 +1322,7 @@ export default class InterstitialsController
     if (!scheduleItems) {
       return;
     }
-    this.log(`resumed ${segmentToString(scheduledItem)}`);
+    this.log(`INTERSTITIALS_PRIMARY_RESUMED ${segmentToString(scheduledItem)}`);
     this.hls.trigger(Events.INTERSTITIALS_PRIMARY_RESUMED, {
       schedule: scheduleItems.slice(0),
       scheduleIndex: index,
@@ -1596,7 +1584,7 @@ export default class InterstitialsController
     const interstitialsUpdated = !!(
       interstitialEvents.length || removedIds.length
     );
-    if (interstitialsUpdated) {
+    if (interstitialsUpdated || previousItems) {
       this.log(
         `INTERSTITIALS_UPDATED (${
           interstitialEvents.length
@@ -1893,16 +1881,16 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
         item.start,
         Math.min(item.end, this.timelinePos),
       );
+      const timeRemaining = bufferingPlayer
+        ? bufferingPlayer.remaining
+        : bufferingLast
+          ? bufferingLast.end - this.timelinePos
+          : 0;
+      this.log(
+        `INTERSTITIALS_BUFFERED_TO_BOUNDARY ${segmentToString(item)}` +
+          (bufferingLast ? ` (${timeRemaining.toFixed(2)} remaining)` : ''),
+      );
       if (!this.playbackDisabled) {
-        const timeRemaining = bufferingPlayer
-          ? bufferingPlayer.remaining
-          : bufferingLast
-            ? bufferingLast.end - this.timelinePos
-            : 0;
-        this.log(
-          `buffered to boundary ${segmentToString(item)}` +
-            (bufferingLast ? ` (${timeRemaining.toFixed(2)} remaining)` : ''),
-        );
         if (isInterstitial) {
           // primary fragment loading will exit early in base-stream-controller while `bufferingItem` is set to an Interstitial block
           item.event.assetList.forEach((asset) => {
@@ -2133,7 +2121,6 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
     assetItem: InterstitialAssetItem,
     assetListIndex: number,
   ): HlsAssetPlayer {
-    this.log(`create HLSAssetPlayer for ${eventAssetToString(assetItem)}`);
     const primary = this.hls;
     const userConfig = primary.userConfig;
     let videoPreference = userConfig.videoPreference;
@@ -2273,10 +2260,7 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
       const nextAssetIndex = getNextAssetIndex(interstitial, assetListIndex);
       const item = this.schedule.items?.[scheduleIndex];
       if (this.isInterstitial(item)) {
-        if (
-          assetListIndex !== -1 &&
-          !interstitial.isAssetPastPlayoutLimit(nextAssetIndex)
-        ) {
+        if (!interstitial.isAssetPastPlayoutLimit(nextAssetIndex)) {
           this.bufferedToItem(item, nextAssetIndex);
         } else {
           const nextItem = this.schedule.items?.[scheduleIndex + 1];
@@ -2355,7 +2339,9 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
         error.message,
       );
     });
-
+    this.log(
+      `INTERSTITIAL_ASSET_PLAYER_CREATED ${eventAssetToString(assetItem)}`,
+    );
     this.hls.trigger(Events.INTERSTITIAL_ASSET_PLAYER_CREATED, {
       asset: assetItem,
       assetListIndex,
@@ -2434,7 +2420,7 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
         delete playingAsset.error;
       }
       this.log(
-        `INTERSTITIAL_ASSET_STARTED ${assetListIndex + 1}/${assetListLength} ${player}`,
+        `INTERSTITIAL_ASSET_STARTED ${assetListIndex + 1}/${assetListLength} ${eventAssetToString(assetItem)}`,
       );
       this.hls.trigger(Events.INTERSTITIAL_ASSET_STARTED, {
         asset: assetItem,
@@ -2485,7 +2471,7 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
         !isCompatibleTrackChange(activeTracks, player.tracks)
       ) {
         const error = new Error(
-          `Asset "${assetId}" SourceBuffer tracks ('${Object.keys(player.tracks)}') are not compatible with primary content tracks ('${Object.keys(activeTracks)}')`,
+          `Asset ${eventAssetToString(assetItem)} SourceBuffer tracks ('${Object.keys(player.tracks)}') are not compatible with primary content tracks ('${Object.keys(activeTracks)}')`,
         );
         const errorData: ErrorData = {
           fatal: true,
@@ -2536,7 +2522,9 @@ Schedule: ${scheduleItems.map((seg) => segmentToString(seg))} pos: ${this.timeli
       scheduleIndex,
       player,
     });
-    this.warn(`Asset item error: ${data.error}`);
+    this.warn(
+      `INTERSTITIAL_ASSET_ERROR ${eventAssetToString(assetItem)} ${data.error}`,
+    );
     this.hls.trigger(Events.INTERSTITIAL_ASSET_ERROR, interstitialAssetError);
     if (!data.fatal) {
       return;

src/loader/interstitial-event.ts

@@ -118,14 +118,17 @@ export class InterstitialEvent {
   }
 
   public isAssetPastPlayoutLimit(assetIndex: number): boolean {
-    if (assetIndex >= this.assetList.length) {
+    if (assetIndex > 0 && assetIndex >= this.assetList.length) {
       return true;
     }
     const playoutLimit = this.playoutLimit;
     if (assetIndex <= 0 || isNaN(playoutLimit)) {
       return false;
     }
-    const assetOffset = this.assetList[assetIndex].startOffset;
+    if (playoutLimit === 0) {
+      return true;
+    }
+    const assetOffset = this.assetList[assetIndex]?.startOffset || 0;
     return assetOffset > playoutLimit;
   }
 
@@ -316,16 +319,10 @@ export function getInterstitialUrl(
 export function getNextAssetIndex(
   interstitial: InterstitialEvent,
   assetListIndex: number,
-  inBounds?: boolean,
 ): number {
   while (interstitial.assetList[++assetListIndex]?.error) {
     /* no-op */
   }
-  if (inBounds && assetListIndex) {
-    if (assetListIndex >= interstitial.assetList.length) {
-      return -1;
-    }
-  }
   return assetListIndex;
 }