hls.js 1.5.6-0.canary.9999 → 1.5.6

package/package.json

@@ -58,39 +58,39 @@
     "test:func:sauce": "SAUCE=1 UA=safari OS='OS X 10.15' BABEL_ENV=development mocha --require @babel/register tests/functional/auto/setup.js --timeout 40000 --exit",
     "type-check": "tsc --noEmit",
     "type-check:watch": "npm run type-check -- --watch",
-    "prepare": "husky"
+    "prepare": "husky install"
   },
   "devDependencies": {
-    "@babel/core": "7.23.9",
+    "@babel/core": "7.23.7",
     "@babel/helper-module-imports": "7.22.15",
     "@babel/plugin-proposal-class-properties": "7.18.6",
     "@babel/plugin-proposal-object-rest-spread": "7.20.7",
     "@babel/plugin-proposal-optional-chaining": "7.21.0",
     "@babel/plugin-transform-object-assign": "7.23.3",
-    "@babel/preset-env": "7.23.9",
+    "@babel/preset-env": "7.23.7",
     "@babel/preset-typescript": "7.23.3",
     "@babel/register": "7.23.7",
-    "@microsoft/api-documenter": "7.23.23",
-    "@microsoft/api-extractor": "7.40.1",
+    "@microsoft/api-documenter": "7.23.16",
+    "@microsoft/api-extractor": "7.39.1",
     "@rollup/plugin-alias": "5.1.0",
     "@rollup/plugin-babel": "6.0.4",
     "@rollup/plugin-commonjs": "25.0.7",
     "@rollup/plugin-node-resolve": "15.2.3",
     "@rollup/plugin-replace": "5.0.5",
     "@rollup/plugin-terser": "0.4.4",
-    "@rollup/plugin-typescript": "11.1.6",
-    "@svta/common-media-library": "0.6.2",
+    "@rollup/plugin-typescript": "11.1.5",
+    "@svta/common-media-library": "0.6.1",
     "@types/chai": "4.3.11",
     "@types/chart.js": "2.9.41",
     "@types/mocha": "10.0.6",
     "@types/sinon-chai": "3.2.12",
-    "@typescript-eslint/eslint-plugin": "6.21.0",
-    "@typescript-eslint/parser": "6.21.0",
+    "@typescript-eslint/eslint-plugin": "6.17.0",
+    "@typescript-eslint/parser": "6.17.0",
     "babel-loader": "9.1.3",
     "babel-plugin-transform-remove-console": "6.9.4",
-    "chai": "4.4.1",
+    "chai": "4.3.10",
     "chart.js": "2.9.4",
-    "chromedriver": "121.0.0",
+    "chromedriver": "120.0.1",
     "doctoc": "2.2.1",
     "es-check": "7.1.1",
     "eslint": "8.56.0",
@@ -101,7 +101,7 @@
     "eslint-plugin-promise": "6.1.1",
     "eventemitter3": "5.0.1",
     "http-server": "14.1.1",
-    "husky": "9.0.10",
+    "husky": "8.0.3",
     "jsonpack": "1.1.5",
     "karma": "6.4.2",
     "karma-chrome-launcher": "3.2.0",
@@ -111,24 +111,24 @@
     "karma-rollup-preprocessor": "github:jlmakes/karma-rollup-preprocessor#7a7268d91149307b3cf2888ee4e65ccd079955a3",
     "karma-sinon-chai": "2.0.2",
     "karma-sourcemap-loader": "0.4.0",
-    "lint-staged": "15.2.2",
+    "lint-staged": "15.2.0",
     "markdown-styles": "3.2.0",
     "micromatch": "4.0.5",
     "mocha": "10.2.0",
     "node-fetch": "3.3.2",
-    "npm-run-all2": "5.0.2",
-    "prettier": "3.2.4",
+    "npm-run-all": "4.1.5",
+    "prettier": "3.1.1",
     "promise-polyfill": "8.3.0",
-    "rollup": "4.9.6",
+    "rollup": "4.9.4",
     "rollup-plugin-istanbul": "5.0.0",
     "sauce-connect-launcher": "1.3.2",
-    "selenium-webdriver": "4.17.0",
-    "semver": "7.6.0",
+    "selenium-webdriver": "4.16.0",
+    "semver": "7.5.4",
     "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
     "typescript": "5.3.3",
     "url-toolkit": "2.2.5",
-    "wrangler": "3.26.0"
+    "wrangler": "3.22.4"
   },
-  "version": "1.5.6-0.canary.9999"
+  "version": "1.5.6"
 }

package/src/config.ts

@@ -17,10 +17,10 @@ import XhrLoader from './utils/xhr-loader';
 import FetchLoader, { fetchSupported } from './utils/fetch-loader';
 import Cues from './utils/cues';
 import { requestMediaKeySystemAccess } from './utils/mediakeys-helper';
+import { ILogger, logger } from './utils/logger';
 
 import type Hls from './hls';
 import type { CuesInterface } from './utils/cues';
-import type { ILogger } from './utils/logger';
 import type { MediaKeyFunc, KeySystems } from './utils/mediakeys-helper';
 import type {
   FragmentLoaderContext,
@@ -558,7 +558,6 @@ function timelineConfig(): TimelineControllerConfig {
 export function mergeConfig(
   defaultConfig: HlsConfig,
   userConfig: Partial<HlsConfig>,
-  logger: ILogger,
 ): HlsConfig {
   if (
     (userConfig.liveSyncDurationCount ||
@@ -665,7 +664,7 @@ function deepCpy(obj: any): any {
 /**
  * @ignore
  */
-export function enableStreamingMode(config: HlsConfig, logger: ILogger) {
+export function enableStreamingMode(config) {
   const currentLoader = config.loader;
   if (currentLoader !== FetchLoader && currentLoader !== XhrLoader) {
     // If a developer has configured their own loader, respect that choice

package/src/controller/abr-controller.ts

@@ -2,7 +2,7 @@ import EwmaBandWidthEstimator from '../utils/ewma-bandwidth-estimator';
 import { Events } from '../events';
 import { ErrorDetails } from '../errors';
 import { PlaylistLevelType } from '../types/loader';
-import { Logger } from '../utils/logger';
+import { logger } from '../utils/logger';
 import {
   SUPPORTED_INFO_DEFAULT,
   getMediaDecodingInfoPromise,
@@ -31,7 +31,7 @@ import type {
 } from '../types/events';
 import type { AbrComponentAPI } from '../types/component-api';
 
-class AbrController extends Logger implements AbrComponentAPI {
+class AbrController implements AbrComponentAPI {
   protected hls: Hls;
   private lastLevelLoadSec: number = 0;
   private lastLoadedFragLevel: number = -1;
@@ -48,7 +48,6 @@ class AbrController extends Logger implements AbrComponentAPI {
   public bwEstimator: EwmaBandWidthEstimator;
 
   constructor(hls: Hls) {
-    super('abr', hls.logger);
     this.hls = hls;
     this.bwEstimator = this.initEstimator();
     this.registerListeners();
@@ -56,7 +55,7 @@ class AbrController extends Logger implements AbrComponentAPI {
 
   public resetEstimator(abrEwmaDefaultEstimate?: number) {
     if (abrEwmaDefaultEstimate) {
-      this.log(`setting initial bwe to ${abrEwmaDefaultEstimate}`);
+      logger.log(`setting initial bwe to ${abrEwmaDefaultEstimate}`);
       this.hls.config.abrEwmaDefaultEstimate = abrEwmaDefaultEstimate;
     }
     this.firstSelection = -1;
@@ -356,7 +355,7 @@ class AbrController extends Logger implements AbrComponentAPI {
     }
 
     this.clearTimer();
-    this.warn(`Fragment ${frag.sn}${
+    logger.warn(`[abr] Fragment ${frag.sn}${
       part ? ' part ' + part.index : ''
     } of level ${frag.level} is loading too slowly;
       Time to underbuffer: ${bufferStarvationDelay.toFixed(3)} s
@@ -480,8 +479,8 @@ class AbrController extends Logger implements AbrComponentAPI {
     }
     const firstLevel = this.hls.firstLevel;
     const clamped = Math.min(Math.max(firstLevel, minAutoLevel), maxAutoLevel);
-    this.warn(
-      `Could not find best starting auto level. Defaulting to first in playlist ${firstLevel} clamped to ${clamped}`,
+    logger.warn(
+      `[abr] Could not find best starting auto level. Defaulting to first in playlist ${firstLevel} clamped to ${clamped}`,
     );
     return clamped;
   }
@@ -534,27 +533,20 @@ class AbrController extends Logger implements AbrComponentAPI {
   }
 
   private getAutoLevelKey(): string {
-    return `${this.getBwEstimate()}_${this.hls.mainForwardBufferInfo?.len}`;
+    return `${this.getBwEstimate()}_${this.getStarvationDelay().toFixed(2)}`;
   }
 
   private getNextABRAutoLevel(): number {
     const { fragCurrent, partCurrent, hls } = this;
-    const { maxAutoLevel, config, minAutoLevel, media } = hls;
+    const { maxAutoLevel, config, minAutoLevel } = hls;
     const currentFragDuration = partCurrent
       ? partCurrent.duration
       : fragCurrent
         ? fragCurrent.duration
         : 0;
-
-    // playbackRate is the absolute value of the playback rate; if media.playbackRate is 0, we use 1 to load as
-    // if we're playing back at the normal rate.
-    const playbackRate =
-      media && media.playbackRate !== 0 ? Math.abs(media.playbackRate) : 1.0;
     const avgbw = this.getBwEstimate();
     // bufferStarvationDelay is the wall-clock time left until the playback buffer is exhausted.
-    const bufferInfo = hls.mainForwardBufferInfo;
-    const bufferStarvationDelay =
-      (bufferInfo ? bufferInfo.len : 0) / playbackRate;
+    const bufferStarvationDelay = this.getStarvationDelay();
 
     let bwFactor = config.abrBandWidthFactor;
     let bwUpFactor = config.abrBandWidthUpFactor;
@@ -592,8 +584,8 @@ class AbrController extends Logger implements AbrComponentAPI {
           ? Math.min(currentFragDuration, config.maxLoadingDelay)
           : config.maxLoadingDelay;
         maxStarvationDelay = maxLoadingDelay - bitrateTestDelay;
-        this.info(
-          `bitrate test took ${Math.round(
+        logger.info(
+          `[abr] bitrate test took ${Math.round(
             1000 * bitrateTestDelay,
           )}ms, set first fragment max fetchDuration to ${Math.round(
             1000 * maxStarvationDelay,
@@ -612,8 +604,8 @@ class AbrController extends Logger implements AbrComponentAPI {
       bwFactor,
       bwUpFactor,
     );
-    this.info(
-      `${
+    logger.info(
+      `[abr] ${
         bufferStarvationDelay ? 'rebuffering expected' : 'buffer is empty'
       }, optimal quality level ${bestLevel}`,
     );
@@ -630,6 +622,20 @@ class AbrController extends Logger implements AbrComponentAPI {
     return hls.loadLevel;
   }
 
+  private getStarvationDelay(): number {
+    const hls = this.hls;
+    const media = hls.media;
+    if (!media) {
+      return Infinity;
+    }
+    // playbackRate is the absolute value of the playback rate; if media.playbackRate is 0, we use 1 to load as
+    // if we're playing back at the normal rate.
+    const playbackRate =
+      media && media.playbackRate !== 0 ? Math.abs(media.playbackRate) : 1.0;
+    const bufferInfo = hls.mainForwardBufferInfo;
+    return (bufferInfo ? bufferInfo.len : 0) / playbackRate;
+  }
+
   private getBwEstimate(): number {
     return this.bwEstimator.canEstimate()
       ? this.bwEstimator.getEstimate()
@@ -692,7 +698,7 @@ class AbrController extends Logger implements AbrComponentAPI {
         : videoRanges[0];
       currentFrameRate = minFramerate;
       currentBw = Math.max(currentBw, minBitrate);
-      this.log(`picked start tier ${JSON.stringify(startTier)}`);
+      logger.log(`[abr] picked start tier ${JSON.stringify(startTier)}`);
     } else {
       currentCodecSet = level?.codecSet;
       currentVideoRange = level?.videoRange;
@@ -738,23 +744,26 @@ class AbrController extends Logger implements AbrComponentAPI {
             mediaCapabilities,
           );
           levelInfo.supportedPromise.then((decodingInfo) => {
+            if (!this.hls) {
+              return;
+            }
             levelInfo.supportedResult = decodingInfo;
             const levels = this.hls.levels;
             const index = levels.indexOf(levelInfo);
             if (decodingInfo.error) {
-              this.warn(
-                `MediaCapabilities decodingInfo error: "${
+              logger.warn(
+                `[abr] MediaCapabilities decodingInfo error: "${
                   decodingInfo.error
                 }" for level ${index} ${JSON.stringify(decodingInfo)}`,
               );
             } else if (!decodingInfo.supported) {
-              this.warn(
-                `Unsupported MediaCapabilities decodingInfo result for level ${index} ${JSON.stringify(
+              logger.warn(
+                `[abr] Unsupported MediaCapabilities decodingInfo result for level ${index} ${JSON.stringify(
                   decodingInfo,
                 )}`,
               );
               if (index > -1 && levels.length > 1) {
-                this.log(`Removing unsupported level ${index}`);
+                logger.log(`[abr] Removing unsupported level ${index}`);
                 this.hls.removeLevel(index);
               }
             }
@@ -833,8 +842,8 @@ class AbrController extends Logger implements AbrComponentAPI {
           (forcedAutoLevel === -1 || forcedAutoLevel !== loadLevel)
         ) {
           if (levelsSkipped.length) {
-            this.trace(
-              `Skipped level(s) ${levelsSkipped.join(
+            logger.trace(
+              `[abr] Skipped level(s) ${levelsSkipped.join(
                 ',',
               )} of ${maxAutoLevel} max with CODECS and VIDEO-RANGE:"${
                 levels[levelsSkipped[0]].codecs
@@ -843,8 +852,8 @@ class AbrController extends Logger implements AbrComponentAPI {
               }" ${currentVideoRange}`,
             );
           }
-          this.info(
-            `switch candidate:${selectionBaseLevel}->${i} adjustedbw(${Math.round(
+          logger.info(
+            `[abr] switch candidate:${selectionBaseLevel}->${i} adjustedbw(${Math.round(
               adjustedbw,
             )})-bitrate=${Math.round(
               adjustedbw - bitrate,

package/src/controller/audio-stream-controller.ts

@@ -71,27 +71,30 @@ class AudioStreamController
       hls,
       fragmentTracker,
       keyLoader,
-      'audio-stream-controller',
+      '[audio-stream-controller]',
       PlaylistLevelType.AUDIO,
     );
-    this.registerListeners();
+    this._registerListeners();
   }
 
   protected onHandlerDestroying() {
-    this.unregisterListeners();
+    this._unregisterListeners();
     super.onHandlerDestroying();
     this.mainDetails = null;
     this.bufferedTrack = null;
     this.switchingTrack = null;
   }
 
-  protected registerListeners() {
-    super.registerListeners();
+  private _registerListeners() {
     const { hls } = this;
+    hls.on(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+    hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+    hls.on(Events.MANIFEST_LOADING, this.onManifestLoading, this);
     hls.on(Events.LEVEL_LOADED, this.onLevelLoaded, this);
     hls.on(Events.AUDIO_TRACKS_UPDATED, this.onAudioTracksUpdated, this);
     hls.on(Events.AUDIO_TRACK_SWITCHING, this.onAudioTrackSwitching, this);
     hls.on(Events.AUDIO_TRACK_LOADED, this.onAudioTrackLoaded, this);
+    hls.on(Events.ERROR, this.onError, this);
     hls.on(Events.BUFFER_RESET, this.onBufferReset, this);
     hls.on(Events.BUFFER_CREATED, this.onBufferCreated, this);
     hls.on(Events.BUFFER_FLUSHING, this.onBufferFlushing, this);
@@ -100,16 +103,16 @@ class AudioStreamController
     hls.on(Events.FRAG_BUFFERED, this.onFragBuffered, this);
   }
 
-  protected unregisterListeners() {
+  private _unregisterListeners() {
     const { hls } = this;
-    if (!hls) {
-      return;
-    }
-    super.unregisterListeners();
+    hls.off(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+    hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+    hls.off(Events.MANIFEST_LOADING, this.onManifestLoading, this);
     hls.off(Events.LEVEL_LOADED, this.onLevelLoaded, this);
     hls.off(Events.AUDIO_TRACKS_UPDATED, this.onAudioTracksUpdated, this);
     hls.off(Events.AUDIO_TRACK_SWITCHING, this.onAudioTrackSwitching, this);
     hls.off(Events.AUDIO_TRACK_LOADED, this.onAudioTrackLoaded, this);
+    hls.off(Events.ERROR, this.onError, this);
     hls.off(Events.BUFFER_RESET, this.onBufferReset, this);
     hls.off(Events.BUFFER_CREATED, this.onBufferCreated, this);
     hls.off(Events.BUFFER_FLUSHING, this.onBufferFlushing, this);
@@ -278,14 +281,12 @@ class AudioStreamController
     const { hls, levels, media, trackId } = this;
     const config = hls.config;
 
-    // 1. if buffering is suspended
-    // 2. if video not attached AND
+    // 1. if video not attached AND
     //    start fragment already requested OR start frag prefetch not enabled
-    // 3. if tracks or track not loaded and selected
+    // 2. if tracks or track not loaded and selected
     // then exit loop
     // => if media not attached but start frag prefetch is enabled and start frag not requested yet, we will not exit loop
     if (
-      !this.buffering ||
       (!media && (this.startFragRequested || !config.startFragPrefetch)) ||
       !levels?.[trackId]
     ) {
@@ -712,7 +713,7 @@ class AudioStreamController
     this.fragBufferedComplete(frag, part);
   }
 
-  protected onError(event: Events.ERROR, data: ErrorData) {
+  private onError(event: Events.ERROR, data: ErrorData) {
     if (data.fatal) {
       this.state = State.ERROR;
       return;

package/src/controller/audio-track-controller.ts

@@ -33,7 +33,7 @@ class AudioTrackController extends BasePlaylistController {
   private selectDefaultTrack: boolean = true;
 
   constructor(hls: Hls) {
-    super(hls, 'audio-track-controller');
+    super(hls, '[audio-track-controller]');
     this.registerListeners();
   }
 

package/src/controller/base-playlist-controller.ts

@@ -5,7 +5,7 @@ import { computeReloadInterval, mergeDetails } from '../utils/level-helper';
 import { ErrorData } from '../types/events';
 import { getRetryDelay, isTimeoutError } from '../utils/error-helper';
 import { NetworkErrorAction } from './error-controller';
-import { Logger } from '../utils/logger';
+import { logger } from '../utils/logger';
 import type { LevelDetails } from '../loader/level-details';
 import type { MediaPlaylist } from '../types/media-playlist';
 import type {
@@ -14,17 +14,17 @@ import type {
   TrackLoadedData,
 } from '../types/events';
 
-export default class BasePlaylistController
-  extends Logger
-  implements NetworkComponentAPI
-{
+export default class BasePlaylistController implements NetworkComponentAPI {
   protected hls: Hls;
   protected timer: number = -1;
   protected requestScheduled: number = -1;
   protected canLoad: boolean = false;
+  protected log: (msg: any) => void;
+  protected warn: (msg: any) => void;
 
   constructor(hls: Hls, logPrefix: string) {
-    super(logPrefix, hls.logger);
+    this.log = logger.log.bind(logger, `${logPrefix}:`);
+    this.warn = logger.warn.bind(logger, `${logPrefix}:`);
     this.hls = hls;
   }
 
@@ -65,7 +65,7 @@ export default class BasePlaylistController
         try {
           uri = new self.URL(attr.URI, previous.url).href;
         } catch (error) {
-          this.warn(
+          logger.warn(
             `Could not construct new URL for Rendition Report: ${error}`,
           );
           uri = attr.URI || '';
@@ -192,19 +192,7 @@ export default class BasePlaylistController
           details.targetduration * 1.5,
         );
         if (currentGoal > 0) {
-          if (cdnAge > details.targetduration * 3) {
-            // Omit segment and part directives when the last response was more than 3 target durations ago,
-            this.log(
-              `Playlist last advanced ${lastAdvanced.toFixed(
-                2,
-              )}s ago. Omitting segment and part directives.`,
-            );
-            msn = undefined;
-            part = undefined;
-          } else if (
-            previousDetails?.tuneInGoal &&
-            cdnAge - details.partTarget > previousDetails.tuneInGoal
-          ) {
+          if (previousDetails && currentGoal > previousDetails.tuneInGoal) {
             // If we attempted to get the next or latest playlist update, but currentGoal increased,
             // then we either can't catchup, or the "age" header cannot be trusted.
             this.warn(