feat: maxDevicePixelRatio limits the browser's value (#6825)

video-dev · Nov 14, 2024 · f53373f · f53373f
1 parent a878ad3
commit f53373f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/api-extractor/report/hls.js.api.md b/api-extractor/report/hls.js.api.md
@@ -2159,6 +2159,7 @@ export type HlsConfig = {
     enableSoftwareAES: boolean;
     minAutoBitrate: number;
     ignoreDevicePixelRatio: boolean;
+    maxDevicePixelRatio: number;
     preferManagedMediaSource: boolean;
     timelineOffset?: number;
     loader: {

diff --git a/docs/API.md b/docs/API.md
@@ -21,6 +21,7 @@ See [API Reference](https://hlsjs-dev.video-dev.org/api-docs/) for a complete li
   - [`capLevelToPlayerSize`](#capleveltoplayersize)
   - [`capLevelOnFPSDrop`](#caplevelonfpsdrop)
   - [`ignoreDevicePixelRatio`](#ignoredevicepixelratio)
+  - [`maxDevicePixelRatio`](#maxdevicepixelratio)
   - [`debug`](#debug)
   - [`autoStartLoad`](#autostartload)
   - [`startPosition`](#startposition)
@@ -526,6 +527,12 @@ This configuration will be applied by default to all instances.
 - when set to true, calculations related to player size will ignore browser `devicePixelRatio`.
 - when set to false, calculations related to player size will respect browser `devicePixelRatio`.
 
+### `maxDevicePixelRatio`
+
+(default: `Number.POSITIVE_INFINITY`)
+
+- when set, calculations related to player size will limit the browser's `devicePixelRatio` to this specified value.
+
 ### `debug`
 
 (default: `false`)

diff --git a/src/config.ts b/src/config.ts
@@ -272,6 +272,7 @@ export type HlsConfig = {
   enableSoftwareAES: boolean;
   minAutoBitrate: number;
   ignoreDevicePixelRatio: boolean;
+  maxDevicePixelRatio: number;
   preferManagedMediaSource: boolean;
   timelineOffset?: number;
   loader: { new (confg: HlsConfig): Loader<LoaderContext> };
@@ -356,6 +357,7 @@ export const hlsDefaultConfig: HlsConfig = {
   capLevelOnFPSDrop: false, // used by fps-controller
   capLevelToPlayerSize: false, // used by cap-level-controller
   ignoreDevicePixelRatio: false, // used by cap-level-controller
+  maxDevicePixelRatio: Number.POSITIVE_INFINITY, // used by cap-level-controller
   preferManagedMediaSource: true,
   initialLiveManifestSize: 1, // used by stream-controller
   maxBufferLength: 30, // used by stream-controller

diff --git a/src/controller/cap-level-controller.ts b/src/controller/cap-level-controller.ts
@@ -258,7 +258,7 @@ class CapLevelController implements ComponentAPI {
       }
     }
 
-    return pixelRatio;
+    return Math.min(pixelRatio, this.hls.config.maxDevicePixelRatio);
   }
 
   private isLevelAllowed(level: Level): boolean {
-Original file line number
+Diff line change
@@ Expand Up / @@ -258,7 +258,7 @@ class CapLevelController implements ComponentAPI { @@
           }
         }
-        return pixelRatio;
+        return Math.min(pixelRatio, this.hls.config.maxDevicePixelRatio);
       }
       private isLevelAllowed(level: Level): boolean {
@@ Expand Down @@