feat: Dash-Industry-Forum#3610 minBufferToKeep

orange4glace · Apr 16, 2021 · 7d5ea48 · 7d5ea48
1 parent 9e1abfc
commit 7d5ea48
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -117,6 +117,7 @@ declare namespace dashjs {
             calcSegmentAvailabilityRangeFromTimeline?: boolean,
             bufferPruningInterval?: number;
             bufferToKeep?: number;
+            minBufferToKeep?: number;
             jumpGaps?: boolean;
             jumpLargeGaps?: boolean;
             smallGapLimit?: number;

diff --git a/samples/dash-if-reference-player/dashjs_config.json b/samples/dash-if-reference-player/dashjs_config.json
@@ -12,6 +12,7 @@
         "flushBufferAtTrackSwitch": false,
         "bufferPruningInterval": 10,
         "bufferToKeep": 20,
+        "minBufferToKeep": 0,
         "jumpGaps": true,
         "smallGapLimit": 1.5,
         "stableBufferTime": -1,

diff --git a/samples/offline/dashjs_config.json b/samples/offline/dashjs_config.json
@@ -11,6 +11,7 @@
         "fastSwitchEnabled": false,
         "bufferPruningInterval": 10,
         "bufferToKeep": 20,
+        "minBufferToKeep": 0,
         "jumpGaps": false,
         "smallGapLimit": 0.8,
         "stableBufferTime": -1,

diff --git a/src/core/Settings.js b/src/core/Settings.js
@@ -66,6 +66,7 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  *          reuseExistingSourceBuffers: true,
  *          bufferPruningInterval: 10,
  *          bufferToKeep: 20,
+ *          minBufferToKeep: 0,
  *          jumpGaps: true,
  *          jumpLargeGaps: true,
  *          smallGapLimit: 1.5,
@@ -322,6 +323,8 @@ import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest';
  *
  * Allows you to modify the buffer that is kept in source buffer in seconds.
  * 0|-----------bufferToPrune-----------|-----bufferToKeep-----|currentTime|
+ * @property {boolean} [minBufferToKeep=true]
+ * bufferToKeep can be changed by internally. Minimum value of bufferToKeep.
  * @property {boolean} [jumpGaps=true]
  * Sets whether player should jump small gaps (discontinuities) in the buffer.
  * @property {boolean} [jumpLargeGaps=true]
@@ -611,6 +614,7 @@ function Settings() {
             reuseExistingSourceBuffers: true,
             bufferPruningInterval: 10,
             bufferToKeep: 20,
+            minBufferToKeep: 0,
             jumpGaps: true,
             jumpLargeGaps: true,
             smallGapLimit: 1.5,

diff --git a/src/streaming/controllers/BufferController.js b/src/streaming/controllers/BufferController.js
@@ -630,7 +630,7 @@ function BufferController(config) {
         }
 
         const currentTime = playbackController.getTime();
-        let startRangeToKeep = Math.max(0, currentTime - settings.get().streaming.bufferToKeep);
+        let startRangeToKeep = Math.max(0, currentTime - Math.max(settings.get().streaming.minBufferToKeep, settings.get().streaming.bufferToKeep));
 
         const currentTimeRequest = fragmentModel.getRequests({
             state: FragmentModel.FRAGMENT_MODEL_EXECUTED,

diff --git a/test/unit/streaming.MediaPlayer.js b/test/unit/streaming.MediaPlayer.js
@@ -721,6 +721,16 @@ describe('MediaPlayer', function () {
             expect(BufferToKeep).to.equal(50);
         });
 
+        it('should configure MinBufferToKeep', function () {
+            let MinBufferToKeep = player.getSettings().streaming.minBufferToKeep;
+            expect(MinBufferToKeep).to.equal(20);
+
+            player.updateSettings({'streaming': {'minBufferToKeep': 50}});
+
+            MinBufferToKeep = player.getSettings().streaming.minBufferToKeep;
+            expect(MinBufferToKeep).to.equal(50);
+        });
+
         it('should configure BufferPruningInterval', function () {
             let BufferPruningInterval = player.getSettings().streaming.bufferPruningInterval;
             expect(BufferPruningInterval).to.equal(10);