Merge branch 'master' into refactor/nullable-network-details

Author: ondreian

.eslintrc.js

@@ -1,3 +1,12 @@
+const asyncKeywordConstraintMsg =
+  'The async keyword adds a `regenerator` dependency in the hls.js ES5 output not allowed in v1 due to bundle size constraints.';
+const selfVsWindowGlobalMsg =
+  'Use `self` instead of `window` to access the global context everywhere (including workers).';
+const arrayFindCompatibilityMsg =
+  'Usage of Array find methods is restricted for compatibility.';
+const arrayFindIndexCompatibilityMsg =
+  'Usage of Array findIndex methods is restricted for compatibility.';
+
 module.exports = {
   env: { browser: true, commonjs: true, es6: true },
   globals: {
@@ -27,20 +36,13 @@ module.exports = {
       2,
       {
         name: 'window',
-        message:
-          'Use `self` instead of `window` to access the global context everywhere (including workers).',
+        message: selfVsWindowGlobalMsg,
       },
       { name: 'SourceBuffer', message: 'Use `self.SourceBuffer`' },
       { name: 'setTimeout', message: 'Use `self.setTimeout`' },
       { name: 'setInterval', message: 'Use `self.setInterval`' },
     ],
 
-    'no-restricted-properties': [
-      2,
-      { property: 'findIndex' }, // Intended to block usage of Array.prototype.findIndex
-      { property: 'find' }, // Intended to block usage of Array.prototype.find
-    ],
-
     'import/first': 1,
     'no-var': 1,
     'no-empty': 1,
@@ -67,6 +69,31 @@ module.exports = {
         'no-unused-vars': 0,
         'no-undef': 0,
         'no-use-before-define': 'off',
+        'no-restricted-syntax': [
+          'error',
+          {
+            selector: 'FunctionDeclaration[async=true]',
+            message: asyncKeywordConstraintMsg,
+          },
+          {
+            selector: 'ArrowFunctionExpression[async=true]',
+            message: asyncKeywordConstraintMsg,
+          },
+          {
+            selector: 'MethodDefinition[value.async=true]',
+            message: asyncKeywordConstraintMsg,
+          },
+          {
+            selector:
+              'MemberExpression[property.name="find"][object.type="Identifier"]',
+            message: arrayFindCompatibilityMsg,
+          },
+          {
+            selector:
+              'MemberExpression[property.name="findIndex"][object.type="Identifier"]',
+            message: arrayFindIndexCompatibilityMsg,
+          },
+        ],
         'import/order': [
           'warn',
           {
@@ -98,6 +125,8 @@ module.exports = {
         '@typescript-eslint/consistent-type-imports': 'error',
         '@typescript-eslint/no-import-type-side-effects': 'error',
         '@typescript-eslint/no-restricted-imports': 'error',
+        '@typescript-eslint/no-floating-promises': 'error',
+        '@typescript-eslint/no-misused-promises': 'error',
       },
     },
   ],

api-extractor/report/hls.js.api.md

@@ -394,6 +394,8 @@ export class BaseStreamController extends TaskLoop implements NetworkComponentAP
     // (undocumented)
     protected checkLiveUpdate(details: LevelDetails): void;
     // (undocumented)
+    protected checkRetryDate(): void;
+    // (undocumented)
     protected clearTrackerIfNeeded(frag: Fragment): void;
     // (undocumented)
     protected config: HlsConfig;
@@ -530,8 +532,6 @@ export class BaseStreamController extends TaskLoop implements NetworkComponentAP
     // (undocumented)
     protected resetLoadingState(): void;
     // (undocumented)
-    protected resetStartWhenNotLoaded(level: Level | null): void;
-    // (undocumented)
     protected resetTransmuxer(): void;
     // (undocumented)
     protected resetWhenMissingContext(chunkMeta: ChunkMetadata | Fragment): void;
@@ -1191,8 +1191,8 @@ export type EMEControllerConfig = {
     licenseResponseCallback?: (this: Hls, xhr: XMLHttpRequest, url: string, keyContext: MediaKeySessionContext) => ArrayBuffer;
     emeEnabled: boolean;
     widevineLicenseUrl?: string;
-    drmSystems: DRMSystemsConfiguration;
-    drmSystemOptions: DRMSystemOptions;
+    drmSystems: DRMSystemsConfiguration | undefined;
+    drmSystemOptions: DRMSystemOptions | undefined;
     requestMediaKeySystemAccessFunc: MediaKeyFunc | null;
     requireKeySystemAccessOnStart: boolean;
 };
@@ -1206,9 +1206,11 @@ export const enum ErrorActionFlags {
     // (undocumented)
     MoveAllAlternatesMatchingHost = 1,
     // (undocumented)
+    MoveAllAlternatesMatchingKey = 4,
+    // (undocumented)
     None = 0,
     // (undocumented)
-    SwitchToSDR = 4
+    SwitchToSDR = 8
 }
 
 // Warning: (ae-missing-release-tag) "ErrorController" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -1241,6 +1243,8 @@ export interface ErrorData {
     // (undocumented)
     context?: PlaylistLoaderContext;
     // (undocumented)
+    decryptdata?: LevelKey;
+    // (undocumented)
     details: ErrorDetails;
     // @deprecated (undocumented)
     err?: {
@@ -2983,8 +2987,8 @@ export interface KeyLoadedData {
 // Warning: (ae-missing-release-tag) "KeyLoader" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export class KeyLoader implements ComponentAPI {
-    constructor(config: HlsConfig);
+export class KeyLoader extends Logger implements ComponentAPI {
+    constructor(config: HlsConfig, logger: ILogger);
     // (undocumented)
     abort(type?: PlaylistLevelType): void;
     // (undocumented)
@@ -3001,10 +3005,6 @@ export class KeyLoader implements ComponentAPI {
     // (undocumented)
     emeController: EMEController | null;
     // (undocumented)
-    keyUriToKeyInfo: {
-        [keyuri: string]: KeyLoaderInfo;
-    };
-    // (undocumented)
     load(frag: Fragment): Promise<KeyLoadedData>;
     // (undocumented)
     loadClear(loadingFrag: Fragment, encryptedFragments: Fragment[], startFragRequested: boolean): null | Promise<void>;
@@ -3280,6 +3280,8 @@ export class LevelDetails {
     // (undocumented)
     get fragmentStart(): number;
     // (undocumented)
+    hasKey(levelKey: LevelKey): boolean;
+    // (undocumented)
     get hasProgramDateTime(): boolean;
     // (undocumented)
     hasVariableRefs: boolean;

docs/API.md

@@ -362,7 +362,7 @@ It should not be used in response to non-fatal hls.js error events.
 ```js
 let attemptedErrorRecovery = null;
 
-video.addEventListener('error', (event) {
+video.addEventListener('error', (event) => {
   const mediaError = event.currentTarget.error;
   if (mediaError.code === mediaError.MEDIA_ERR_DECODE) {
     const now = Date.now();
@@ -380,11 +380,19 @@ hls.on(Hls.Events.ERROR, function (name, data) {
       case Hls.ErrorTypes.MEDIA_ERROR: {
         const now = Date.now();
         if (!attemptedErrorRecovery || now - attemptedErrorRecovery > 5000) {
-          console.log('Fatal media error encountered (' + video.error + + '), attempting to recover');
+          console.log(
+            'Fatal media error encountered (' +
+              video.error +
+              +'), attempting to recover',
+          );
           attemptedErrorRecovery = now;
           hls.recoverMediaError();
         } else {
-          console.log('Skipping media error recovery (only ' + (now - attemptedErrorRecovery) + 'ms since last error)');
+          console.log(
+            'Skipping media error recovery (only ' +
+              (now - attemptedErrorRecovery) +
+              'ms since last error)',
+          );
         }
         break;
       }
@@ -561,7 +569,9 @@ This configuration will be applied by default to all instances.
 
 (default: `false`)
 
-Setting `config.debug = true;` will turn on debug logs on JS console.
+Setting `config.debug = true` enables JavaScript debug console logs. Debug mode also disables catching exceptions in even handler callbacks.
+In debug mode, when an event listener throws, the exception is not caught. This allows uncaught exeptions to trigger the JavaScript debugger.
+In production mode (`config.debug = false`), exceptions that are caught in event handlers are redispatched as errors with `type: OTHER_ERROR, details: INTERNAL_EXCEPTION, error: <caught exception>`.
 
 A logger object could also be provided for custom logging: `config.debug = customLogger;`.
 
@@ -756,10 +766,10 @@ Decreasing this value will mean that each stall will have less affect on `hls.ta
 
 (default: `Infinity`)
 
-maximum delay allowed from edge of live, expressed in multiple of `EXT-X-TARGETDURATION`.
-if set to 10, the player will seek back to `liveSyncDurationCount` whenever the next fragment to be loaded is older than N-10, N being the last fragment of the live playlist.
-If set, this value must be stricly superior to `liveSyncDurationCount`
-a value too close from `liveSyncDurationCount` is likely to cause playback stalls.
+Maximum delay allowed from edge of live, expressed in multiple of `EXT-X-TARGETDURATION`.
+If set to 10, the player will seek back to `liveSyncDurationCount` whenever the next fragment to be loaded is older than N-10, N being the last fragment of the live playlist.
+If set, this value must be strictly superior to `liveSyncDurationCount`.
+A value too close from `liveSyncDurationCount` is likely to cause playback stalls.
 
 ### `liveSyncDuration`
 
@@ -776,7 +786,7 @@ A value too low (inferior to ~3 segment durations) is likely to cause playback s
 
 Alternative parameter to `liveMaxLatencyDurationCount`, expressed in seconds vs number of segments.
 If defined in the configuration object, `liveMaxLatencyDuration` will take precedence over the default `liveMaxLatencyDurationCount`.
-If set, this value must be stricly superior to `liveSyncDuration` which must be defined as well.
+If set, this value must be strictly superior to `liveSyncDuration` which must be defined as well.
 You can't define this parameter and either `liveSyncDurationCount` or `liveMaxLatencyDurationCount` in your configuration object at the same time.
 A value too close from `liveSyncDuration` is likely to cause playback stalls.
 

src/config.ts

@@ -119,8 +119,8 @@ export type EMEControllerConfig = {
   ) => ArrayBuffer;
   emeEnabled: boolean;
   widevineLicenseUrl?: string;
-  drmSystems: DRMSystemsConfiguration;
-  drmSystemOptions: DRMSystemOptions;
+  drmSystems: DRMSystemsConfiguration | undefined;
+  drmSystemOptions: DRMSystemOptions | undefined;
   requestMediaKeySystemAccessFunc: MediaKeyFunc | null;
   requireKeySystemAccessOnStart: boolean;
 };

src/controller/abr-controller.ts

@@ -845,43 +845,49 @@ class AbrController extends Logger implements AbrComponentAPI {
             mediaCapabilities,
             this.supportedCache,
           );
-          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: "${
-                  decodingInfo.error
-                }" for level ${index} ${stringify(decodingInfo)}`,
-              );
-            } else if (!decodingInfo.supported) {
-              this.warn(
-                `Unsupported MediaCapabilities decodingInfo result for level ${index} ${stringify(
-                  decodingInfo,
-                )}`,
-              );
-              if (index > -1 && levels.length > 1) {
-                this.log(`Removing unsupported level ${index}`);
-                this.hls.removeLevel(index);
-                if (this.hls.loadLevel === -1) {
-                  this.hls.nextLoadLevel = 0;
+          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: "${
+                    decodingInfo.error
+                  }" for level ${index} ${stringify(decodingInfo)}`,
+                );
+              } else if (!decodingInfo.supported) {
+                this.warn(
+                  `Unsupported MediaCapabilities decodingInfo result for level ${index} ${stringify(
+                    decodingInfo,
+                  )}`,
+                );
+                if (index > -1 && levels.length > 1) {
+                  this.log(`Removing unsupported level ${index}`);
+                  this.hls.removeLevel(index);
+                  if (this.hls.loadLevel === -1) {
+                    this.hls.nextLoadLevel = 0;
+                  }
                 }
+              } else if (
+                decodingInfo.decodingInfoResults.some(
+                  (info) =>
+                    info.smooth === false || info.powerEfficient === false,
+                )
+              ) {
+                this.log(
+                  `MediaCapabilities decodingInfo for level ${index} not smooth or powerEfficient: ${stringify(decodingInfo)}`,
+                );
               }
-            } else if (
-              decodingInfo.decodingInfoResults.some(
-                (info) =>
-                  info.smooth === false || info.powerEfficient === false,
-              )
-            ) {
-              this.log(
-                `MediaCapabilities decodingInfo for level ${index} not smooth or powerEfficient: ${stringify(decodingInfo)}`,
+            })
+            .catch((error) => {
+              this.warn(
+                `Error handling MediaCapabilities decodingInfo: ${error}`,
               );
-            }
-          });
+            });
         } else {
           levelInfo.supportedResult = SUPPORTED_INFO_DEFAULT;
         }

src/controller/audio-stream-controller.ts

@@ -255,15 +255,7 @@ class AudioStreamController
         break;
       }
       case State.FRAG_LOADING_WAITING_RETRY: {
-        const now = performance.now();
-        const retryDate = this.retryDate;
-        // if current time is gt than retryDate, or if media seeking let's switch to IDLE state to retry loading
-        if (!retryDate || now >= retryDate || this.media?.seeking) {
-          const { levels, trackId } = this;
-          this.log('RetryDate reached, switch back to IDLE state');
-          this.resetStartWhenNotLoaded(levels?.[trackId] || null);
-          this.state = State.IDLE;
-        }
+        this.checkRetryDate();
         break;
       }
       case State.WAITING_INIT_PTS: {