RSSA-1511 - Allow to set an extra offset when the player jumps a gap (#18)

* Added jumpGapsWithCeilOffset config

* Added documentation

* fixed compiling issue

Author: guilleccc

externs/shaka/player.js

@@ -786,6 +786,7 @@ shaka.extern.ManifestConfiguration;
  *   gapDetectionThreshold: number,
  *   smallGapLimit: number,
  *   jumpLargeGaps: boolean,
+ *   jumpGapsWithCeilOffset: number,
  *   durationBackoff: number,
  *   forceTransmuxTS: boolean,
  *   safeSeekOffset: number,
@@ -850,6 +851,12 @@ shaka.extern.ManifestConfiguration;
  *   call <code>preventDefault()</code> on the event, the Player will jump the
  *   gap.  If <code>false</code>, then the event will be raised, but the gap
  *   will not be jumped.
+ * @property {number} jumpGapsWithCeilOffset
+ *   This value allows to set an extra offset in case the gap jumping is not
+ *   enough to restore playback.
+ *   By default this value is <code>0</code>, on which case it will jump to
+ *   the start of the next buffer.
+ *   By setting for instance <code>1</code>, it will jump to ceil(startBuffer+1)
  * @property {number} durationBackoff
  *   By default, we will not allow seeking to exactly the duration of a
  *   presentation.  This field is the number of seconds before duration we will

lib/media/gap_jumping_controller.js

@@ -194,9 +194,12 @@ shaka.media.GapJumpingController = class {
       return;
     }
 
+    const jumpOffset = this.config_.jumpGapsWithCeilOffset;
+
     // StreamingEngine can buffer past the seek end, but still don't allow
     // seeking past it.
-    const jumpTo = buffered.start(gapIndex);
+    let jumpTo = buffered.start(gapIndex);
+    jumpTo = jumpOffset ? Math.ceil(jumpTo + jumpOffset) : jumpTo;
     const seekEnd = this.timeline_.getSeekRangeEnd();
     if (jumpTo >= seekEnd) {
       return;
@@ -236,6 +239,11 @@ shaka.media.GapJumpingController = class {
         shaka.log.info(
             'Jumping forward', jumpSize,
             'seconds because of gap before start time of', jumpTo);
+      } else if (jumpOffset) {
+        shaka.log.info(
+            'Jumping forward', jumpSize, 'seconds because of gap starting at',
+            buffered.end(gapIndex - 1), 'and ending at', jumpTo,
+            'with an jumpGapsWithCeilOffset of', jumpOffset);
       } else {
         shaka.log.info(
             'Jumping forward', jumpSize, 'seconds because of gap starting at',

lib/util/player_configuration.js

@@ -138,6 +138,7 @@ shaka.util.PlayerConfiguration = class {
       gapDetectionThreshold: 0.1,
       smallGapLimit: 0.5,
       jumpLargeGaps: false,
+      jumpGapsWithCeilOffset: 0,
       durationBackoff: 1,
       forceTransmuxTS: false,
       // Offset by 5 seconds since Chromecast takes a few seconds to start

package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.2.10-norigin.2",
+  "version": "3.2.10-norigin.3",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [