0.8.2

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "frameeyeosc"
-version = "0.8.1"
+version = "0.8.2"
 edition = "2024"
 license = "MIT"
 description = "Sends Steam Frame eye tracking (gaze and eyelids) to VRChat over OSC"

panel/CMakeLists.txt

@@ -43,6 +43,7 @@ add_executable(frameeyeosc-panel
   src/changelog.cpp
   src/command.cpp
   src/config.cpp
+  src/contrib.cpp
   src/diag.cpp
   src/draw.cpp
   src/eyecam.cpp
@@ -155,6 +156,7 @@ add_executable(panel-test tests/panel_test.cpp
   src/changelog.cpp
   src/command.cpp
   src/config.cpp
+  src/contrib.cpp
   src/diag.cpp
   src/draw.cpp
   src/eyecam.cpp
@@ -211,6 +213,18 @@ target_compile_options(eyecam-test PRIVATE -Wall -Wextra)
 target_link_libraries(eyecam-test PRIVATE Threads::Threads)
 add_test(NAME eyecam COMMAND eyecam-test)
 
+# "Help train the AI" (contrib.{h,cpp}: the steps and their sizes against eyecam's protocol files, info.txt, following a
+# step's recording and the re-wear in eyecam-rec's status, the screens, the tar headers, and on folders in $TMPDIR
+# making, moving into, packing (unpacked again with tar and zstd) and deleting a contribution, and a whole session):
+# panel/build/contrib-test
+add_executable(contrib-test tests/contrib_test.cpp src/contrib.cpp src/eyecam.cpp src/i18n.cpp src/json.cpp
+  src/setup_tools.cpp src/recorder.cpp)
+target_include_directories(contrib-test PRIVATE src)
+target_compile_definitions(contrib-test PRIVATE EYECAM_SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}/../tools/eyecam")
+target_compile_options(contrib-test PRIVATE -Wall -Wextra)
+target_link_libraries(contrib-test PRIVATE Threads::Threads)
+add_test(NAME contrib COMMAND contrib-test)
+
 # The diagnostics page's texts and code (diag.{h,cpp}: the cards, the diagnostic code, SteamOS's version, SHA-256),
 # without cairo: panel/build/diag-test
 add_executable(diag-test tests/diag_test.cpp src/diag.cpp src/eyecam.cpp src/i18n.cpp src/json.cpp src/status.cpp

panel/src/action_socket.cpp

@@ -120,6 +120,12 @@ Decision decide(Action action, const State& state) {
                 return {Code::BusyRecenter, "busy (a re-center is running; use --action stop)", Effect::None};
             }
             if (state.fitActive) return {Code::BusyFit, "busy (a fit is running; use --action stop)", Effect::None};
+            // The eye cameras calibrating: the user looks where its steps say (up and down too), so a fit's dot would
+            // pull the eyes away from them and measure the wrong look (the fit buttons are grey meanwhile). Told with
+            // the eye cameras' code and "calibrating", which frame-aux-shortcuts shows as their calibration
+            if (state.camerasCalibrating) {
+                return {Code::NoCameras, "busy (the eye cameras are calibrating)", Effect::None};
+            }
             // The buttons are grey while frameeyeosc doesn't run; without eye data (the headset off, most often)
             // nothing could be measured
             if (!state.running) return {Code::NoFrameeyeosc, "frameeyeosc is not running", Effect::None};

panel/src/action_socket.h

@@ -51,7 +51,8 @@ enum class Code {
     NoEyeData = 9,     ///< frameeyeosc runs, but no eye data comes in (the headset off, or eye tracking stopped)
     BusyRecenter = 10, ///< a re-center is running (also the automatic one after putting the headset on)
     NoCameras = 11,    ///< relearn: the eye cameras aren't in use or not ready (off, not set up, eyecam-rec not running
-                       ///< or busy, no eye video), or eyecam-rec said no
+                       ///< or busy, no eye video), or eyecam-rec said no. Also recenter, fit and relearn while the eye
+                       ///< cameras calibrate, with "calibrating" in the text (what frame-aux-shortcuts looks for)
 };
 
 /** The actions (more can follow: pause / resume sending, the eye cameras' calibration, the gaze dots). */
@@ -92,6 +93,8 @@ struct State {
     /** The eye cameras drive the eyelids (or learn to) and eyecam-rec reads them live, idle with the eye video
      *  (eyecam::relearnAllowed: what the "Relearn my eyes" button needs) */
     bool camerasReady = false;
+    /** The eye cameras are calibrating (eyecam::calibrationUnderWay): the fit buttons are grey meanwhile */
+    bool camerasCalibrating = false;
 };
 
 /** What the panel then does. */
@@ -115,8 +118,9 @@ struct Decision {
  * Decide what an action does now, with the conditions of the button it stands for: the fit buttons need frameeyeosc
  * running and their values not locked, and not while a fit runs (they are hidden then; only "Stop" shows). The
  * re-center also needs a gaze fit, like the automatic one after putting the headset on, and both need eye data.
- * Relearning needs the eye cameras ready, and waits for a fit too (the fit measures the eyelids). Checked in that
- * order: busy, frameeyeosc, eye data, then the action's own.
+ * Relearning needs the eye cameras ready, and waits for a fit too (the fit measures the eyelids). None of the three
+ * starts while the eye cameras calibrate (the user looks where its steps say). Checked in that order: busy (a fit,
+ * then the calibration), frameeyeosc, eye data, then the action's own.
  * @param action the action
  * @param state the panel's state now
  * @return the code, the reply's text and what to do

panel/src/auto_recenter.cpp

@@ -99,6 +99,8 @@ Step Watcher::update(double now, const Inputs& in) {
         }
     }
     wasRunning_ = in.running;
+    // (a calibration over: the next one is said again)
+    if (!in.camerasCalibrating) calibLogged_ = false;
     // How long an eye has read shut on Valve's eye server while tracked (a blink is not long enough)
     if (!(in.running && tracking_ && (in.valveShut[0] || in.valveShut[1]))) {
         shutSince_ = NAN;
@@ -144,6 +146,15 @@ Step Watcher::update(double now, const Inputs& in) {
     } else if (in.fitActive) {
         step.log = disarm("an eye fit was started");
     } else if (in.running && tracking_ && onFor_ >= kSettleSec && !dashboardOpen && now - closedAt_ >= kClosedSec) {
+        // Would start now, but the eye cameras are calibrating: the user looks where its steps say (up and down too),
+        // so the dot would pull the eyes away from them and measure the wrong look. Waits for its end, said once
+        if (in.camerasCalibrating) {
+            if (!calibLogged_) {
+                calibLogged_ = true;
+                step.log = "auto re-center: waiting for the eye cameras' calibration to end";
+            }
+            return step;
+        }
         // Would start now, but SteamVR's startup dashboard is still to come: started now, it would be stopped as it
         // opens. Said once
         if (startupWait_) {

panel/src/auto_recenter.h

@@ -63,6 +63,7 @@ struct Inputs {
     bool valveShut[2] = {false, false};  ///< Valve's eye server reads the eye below kOpenFloor (left, right)
     bool camerasWarming = false;         ///< the eye cameras' eyelids wait for eyecam-rec's warm-up
                                          ///< (eyecam::recenterAwaitsWarmup)
+    bool camerasCalibrating = false;     ///< the eye cameras are calibrating (eyecam::calibrationUnderWay)
 };
 
 /** What to do after an update. */
@@ -80,9 +81,11 @@ struct Step {
  * the dashboard stopped is tried again, kDashboardRetries times at most in a wearing (fitEnded); any other end is
  * final for the wearing. While Valve's eye server reads an eye shut
  * (it can get stuck at 0 for a whole wear) and the eye cameras are still warming up, no sample would count, so it
- * waits for the warm-up (up to kCameraWaitSec): the eye camera's eyelid counts for that eye after it. Time while
- * frameeyeosc is not running counts for nothing (a restart while worn does not look like putting the headset on); the time since the last
- * update counts for the state seen then, so a suspend right after taking the headset off counts as off.
+ * waits for the warm-up (up to kCameraWaitSec): the eye camera's eyelid counts for that eye after it. While the eye
+ * cameras calibrate (the user looking up and down as told), it waits for the calibration to end, however long.
+ * Time while frameeyeosc is not running counts for nothing (a restart while worn does not look like putting the
+ * headset on); the time since the last update counts for the state seen then, so a suspend right after taking the
+ * headset off counts as off.
  */
 class Watcher {
 public:
@@ -146,6 +149,7 @@ class Watcher {
     double startupFrom_ = 0.0;   ///< ...since the connect or the wake...
     const char* startupAfter_ = "";  ///< ...which ("connecting" / "waking up")...
     bool startupLogged_ = false;     ///< ...and a re-center has waited for it (said once)
+    bool calibLogged_ = false;   ///< a re-center has waited for the eye cameras' calibration running now (said once)
     double shutSince_ = NAN;     ///< since when an eye has read shut on Valve's eye server (NaN: neither does)
     double holdSince_ = NAN;     ///< since when this wearing's start is held back for the eye cameras (NaN: it isn't)
     double clearSince_ = NAN;    ///< ...and since when that no longer holds (NaN: it still does)

panel/src/config.cpp

@@ -150,6 +150,7 @@ const std::vector<SettingSpec>& settingSpecs() {
         {key::kGazeDeadzone, SettingType::Number, 0.005, "", 0.0, 0.2, 0.005, 3},
         {key::kGazeHoldBelow, SettingType::Number, 0.5, "", 0.05, 1.0, 0.05, 2},
         {key::kIndependentEyes, SettingType::Bool, 0, "", 0, 1, 1, 0},
+        {key::kOwnEyeGaze, SettingType::Number, 0.0, "", 0.0, 1.0, 0.05, 2},
         {key::kLidMinCutoff, SettingType::Number, 6.0, "", 0.5, 30.0, 0.5, 1},
         {key::kLidBeta, SettingType::Number, 5.0, "", 0.0, 30.0, 0.5, 1},
         {key::kLidClosed, SettingType::Number, 0.30, "", 0.0, 1.5, 0.01, 2},

panel/src/config.h

@@ -77,6 +77,8 @@ constexpr const char* kGazeDCutoff = "gaze_d_cutoff";
 constexpr const char* kGazeDeadzone = "gaze_deadzone";
 constexpr const char* kGazeHoldBelow = "gaze_hold_below";
 constexpr const char* kIndependentEyes = "independent_eyes";
+/** With independent_eyes in v2: how much of each eye's own sideways gaze is sent, 0 (the default) to 1. */
+constexpr const char* kOwnEyeGaze = "own_eye_gaze";
 constexpr const char* kLidMinCutoff = "lid_min_cutoff";
 constexpr const char* kLidBeta = "lid_beta";
 constexpr const char* kLidClosed = "lid_closed";