remote-calibrator 0.3.0-rc.3 → 0.5.0-beta.10

package/src/gaze/gazeCalibration.js

@@ -1,6 +1,11 @@
 import RemoteCalibrator from '../core'
 
-import { constructInstructions, shuffle, blurAll } from '../components/utils'
+import {
+  constructInstructions,
+  shuffle,
+  blurAll,
+  safeExecuteFunc,
+} from '../components/utils'
 import { debug } from '../debug'
 import { bindKeys, unbindKeys } from '../components/keyBinder'
 import { phrases } from '../i18n'
@@ -60,8 +65,7 @@ RemoteCalibrator.prototype.calibrateGaze = function (options = {}, callback) {
     this._removeBackground() // Remove calibration background when the calibration finished
     unbindKeys(bindKeysFunction)
 
-    // TODO Pass timestamp into callback
-    if (callback && typeof callback === 'function') callback()
+    safeExecuteFunc(callback, { timestamp: new Date() })
   })
 
   const breakFunction = () => {
@@ -73,6 +77,11 @@ RemoteCalibrator.prototype.calibrateGaze = function (options = {}, callback) {
     originalStyles.video = false
     originalStyles.gazer = false
 
+    if (!this._trackingSetupFinishedStatus.gaze) {
+      this._trackingSetupFinishedStatus.gaze = true
+      this.endGaze()
+    }
+
     unbindKeys(bindKeysFunction)
   }
 
@@ -206,7 +215,8 @@ class GazeCalibrationDot {
       originalStyles.video = false
       originalStyles.gazer = false
 
-      this.endCalibrationCallback()
+      safeExecuteFunc(this.endCalibrationCallback)
+      this.RC._trackingSetupFinishedStatus.gaze = true
     }
   }
 

package/src/gaze/gazeTracker.js

@@ -1,7 +1,10 @@
 import webgazer from '../WebGazer4RC/src/index.mjs'
 
-import { toFixedNumber } from '../components/utils'
+import { safeExecuteFunc, toFixedNumber } from '../components/utils'
 import { checkWebgazerReady } from '../components/video'
+import Swal from 'sweetalert2'
+import { swalInfoOptions } from '../components/swalOptions'
+import { phrases } from '../i18n'
 
 /**
  * The gaze tracker object to wrap all gaze-related functions
@@ -32,7 +35,7 @@ export default class GazeTracker {
   begin({ pipWidthPx }, callback) {
     if (this.checkInitialized('gaze', true)) {
       if (!this._running.gaze) {
-        this.webgazer.begin()
+        this.webgazer.begin(this.videoFailed.bind(this))
         this._running.gaze = true
         this._runningVideo = true
       }
@@ -51,7 +54,7 @@ export default class GazeTracker {
     // Begin video only
     if (this.checkInitialized('distance', true)) {
       if (!this._runningVideo) {
-        this.webgazer.beginVideo()
+        this.webgazer.beginVideo(this.videoFailed.bind(this))
         this._runningVideo = true
       }
 
@@ -65,12 +68,24 @@ export default class GazeTracker {
     }
   }
 
+  videoFailed(videoInputs) {
+    Swal.fire({
+      ...swalInfoOptions(this.calibrator, { showIcon: true }),
+      icon: 'error',
+      iconColor: this.calibrator._CONST.COLOR.DARK_RED,
+      showConfirmButton: false,
+      html: videoInputs.length
+        ? phrases.RC_errorCameraUseDenied[this.calibrator.L]
+        : phrases.RC_errorNoCamera[this.calibrator.L],
+    })
+  }
+
   attachNewCallback(callback) {
     if (this.checkInitialized('gaze', true)) {
       this.webgazer.setGazeListener(d => {
         if (d) {
           const data = (this.calibrator.newGazePositionData = this.getData(d))
-          if (callback) callback(data)
+          safeExecuteFunc(callback, data)
         }
       })
     }
@@ -80,7 +95,7 @@ export default class GazeTracker {
     let data = (this.calibrator.newGazePositionData = this.getData(
       await this.webgazer.getCurrentPrediction()
     ))
-    if (callback) callback(data)
+    safeExecuteFunc(callback, data)
     return data
   }
 
@@ -95,10 +110,13 @@ GazeTracker.prototype._init = function (
 ) {
   if (!this.checkInitialized(task)) {
     if (task === 'gaze') {
-      this.webgazer.clearData()
-      this.webgazer.saveDataAcrossSessions(false)
+      // TODO Manually clear data
+      // this.webgazer.clearData()
+      // this.webgazer.saveDataAcrossSessions(false)
       this.webgazer.params.greedyLearner = greedyLearner
       this.webgazer.params.framerate = framerate
+      this.webgazer.params.getLatestVideoFrameTimestamp =
+        this._getLatestVideoTimestamp.bind(this)
       this.showGazer(showGazer)
     }
 
@@ -126,12 +144,15 @@ GazeTracker.prototype.checkInitialized = function (task, warning = false) {
 }
 
 GazeTracker.prototype.getData = function (d) {
+  let t = new Date()
   return {
     value: {
       x: toFixedNumber(d.x, this._toFixedN),
       y: toFixedNumber(d.y, this._toFixedN),
+      latencyMs:
+        t.getTime() - this.calibrator._tackingVideoFrameTimestamps.gaze, // latency
     },
-    timestamp: new Date(),
+    timestamp: t,
   }
 }
 
@@ -155,6 +176,8 @@ GazeTracker.prototype.end = function (type, endAll = false) {
     this._endGaze()
     if (endEverything && this.checkInitialized('distance'))
       this.calibrator.endDistance(false, false)
+
+    this.calibrator._tackingVideoFrameTimestamps.gaze = 0
   } else {
     // Distance
     this.defaultDistanceTrackCallback = null
@@ -187,8 +210,16 @@ GazeTracker.prototype._endGaze = function () {
 
   this.webgazer.params.greedyLearner = false
   this.webgazer.params.framerate = 60
+
+  this.webgazer.params.getLatestVideoFrameTimestamp = () => {}
 }
 
+GazeTracker.prototype._getLatestVideoTimestamp = function (t) {
+  this.calibrator._tackingVideoFrameTimestamps.gaze = t.getTime()
+}
+
+/* -------------------------------------------------------------------------- */
+
 GazeTracker.prototype.startStoringPoints = function () {
   this.webgazer.params.storingPoints = true
 }
@@ -218,7 +249,7 @@ GazeTracker.prototype.showGazer = function (show) {
 }
 
 GazeTracker.prototype.showVideo = function (show) {
-  this.webgazer.showVideo(show)
+  this.webgazer.showVideo(show, this.calibrator._params.videoOpacity)
 }
 
 GazeTracker.prototype.showFaceOverlay = function (show) {