sensor consistency

- accel should include gravity, be in g, not m/s^2
- remote retropad should enable sensors on screen change
- ios should change gravity on screen rotation
- update doc. when the legend becomes fact, print the legend

Author: warmenhoven

cores/libretro-net-retropad/net_retropad_core.c

@@ -435,33 +435,71 @@ static void sensors_init(void)
    struct retro_sensor_interface sensor_interface = {0};
    if (NETRETROPAD_CORE_PREFIX(environ_cb)(RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE, &sensor_interface))
    {
-      NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Sensor interface supported, enabling.\n");
+      NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Sensor interface supported.\n");
       NETRETROPAD_CORE_PREFIX(sensor_get_input_cb) = sensor_interface.get_sensor_input;
       NETRETROPAD_CORE_PREFIX(sensor_set_state_cb) = sensor_interface.set_sensor_state;
+   }
+}
 
-      if (NETRETROPAD_CORE_PREFIX(sensor_set_state_cb) && NETRETROPAD_CORE_PREFIX(sensor_get_input_cb))
-      {
-         if (NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ACCELEROMETER_ENABLE, EVENT_RATE))
-         {
-            tilt_sensor_enabled = true;
-            NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Tilt sensor enabled.\n");
-         }
+static void sensors_enable(void)
+{
+   if (!NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)
+       || !NETRETROPAD_CORE_PREFIX(sensor_get_input_cb))
+      sensors_init();
+   if (!NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)
+       || !NETRETROPAD_CORE_PREFIX(sensor_get_input_cb))
+      return;
 
-         if (NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_GYROSCOPE_ENABLE, EVENT_RATE))
-         {
-            gyro_sensor_enabled = true;
-            NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Gyro sensor enabled.\n");
-         }
+   if (!tilt_sensor_enabled
+       && NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ACCELEROMETER_ENABLE, EVENT_RATE))
+   {
+      tilt_sensor_enabled = true;
+      NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Tilt sensor enabled.\n");
+   }
 
-         if (NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ILLUMINANCE_ENABLE, EVENT_RATE))
-         {
-            lux_sensor_enabled = true;
-            NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Lux sensor enabled.\n");
-         }
-      }
+   if (!gyro_sensor_enabled
+       && NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_GYROSCOPE_ENABLE, EVENT_RATE))
+   {
+      gyro_sensor_enabled = true;
+      NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Gyro sensor enabled.\n");
+   }
+
+   if (!lux_sensor_enabled
+       && NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ILLUMINANCE_ENABLE, EVENT_RATE))
+   {
+      lux_sensor_enabled = true;
+      NETRETROPAD_CORE_PREFIX(log_cb)(RETRO_LOG_DEBUG,"[Remote RetroPad] Lux sensor enabled.\n");
    }
 }
 
+static void sensors_disable(void)
+{
+   if (!NETRETROPAD_CORE_PREFIX(sensor_set_state_cb))
+      return;
+
+   if (tilt_sensor_enabled)
+   {
+      NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ACCELEROMETER_DISABLE, EVENT_RATE);
+      tilt_sensor_enabled = false;
+   }
+
+   if (gyro_sensor_enabled)
+   {
+      NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_GYROSCOPE_DISABLE, EVENT_RATE);
+      gyro_sensor_enabled = false;
+   }
+
+   if (lux_sensor_enabled)
+   {
+      NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ILLUMINANCE_DISABLE, EVENT_RATE);
+      lux_sensor_enabled = false;
+   }
+
+   memset(tilt_sensor_values, 0, sizeof(tilt_sensor_values));
+   memset(gyro_sensor_values, 0, sizeof(gyro_sensor_values));
+   lux_sensor_value = 0.0f;
+}
+
 static void draw_background(void)
 {
    if (frame_buf)
@@ -510,12 +548,22 @@ static void draw_background(void)
 
 static void flip_screen(void)
 {
+   unsigned prev_screen = current_screen;
    if      (current_screen == NETRETROPAD_SCREEN_PAD)
       current_screen = NETRETROPAD_SCREEN_KEYBOARD;
    else if (current_screen == NETRETROPAD_SCREEN_KEYBOARD)
       current_screen = NETRETROPAD_SCREEN_SENSORS;
    else if (current_screen == NETRETROPAD_SCREEN_SENSORS)
       current_screen = NETRETROPAD_SCREEN_PAD;
+
+   if (prev_screen != current_screen)
+   {
+      if (current_screen == NETRETROPAD_SCREEN_SENSORS)
+         sensors_enable();
+      else if (prev_screen == NETRETROPAD_SCREEN_SENSORS)
+         sensors_disable();
+   }
+
    draw_background();
 }
 
@@ -555,12 +603,22 @@ void NETRETROPAD_CORE_PREFIX(retro_deinit)(void)
       descriptors[i]->value = NULL;
    }
 
-   if (NETRETROPAD_CORE_PREFIX(sensor_set_state_cb) && NETRETROPAD_CORE_PREFIX(sensor_get_input_cb))
-   {
-      NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ACCELEROMETER_DISABLE, EVENT_RATE);
-      NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_GYROSCOPE_DISABLE, EVENT_RATE);
-      NETRETROPAD_CORE_PREFIX(sensor_set_state_cb)(0, RETRO_SENSOR_ILLUMINANCE_DISABLE, EVENT_RATE);
-   }
+   sensors_disable();
+   NETRETROPAD_CORE_PREFIX(sensor_get_input_cb) = NULL;
+   NETRETROPAD_CORE_PREFIX(sensor_set_state_cb) = NULL;
+   memset(sensor_item_colors, 0, sizeof(sensor_item_colors));
+
+   current_frame          = 0;
+   current_screen         = NETRETROPAD_SCREEN_PAD;
+   next_teststep_frame    = 0;
+   current_test_step      = 0;
+   last_test_step         = MAX_TEST_STEPS + 1;
+   input_state_validated  = 0;
+   combo_state_validated  = 0;
+   memset(keyboard_state_validated, 0, sizeof(keyboard_state_validated));
+   dump_state_blocked     = false;
+   hide_analog_mismatch   = true;
+   mouse_type             = 0;
 }
 
 unsigned NETRETROPAD_CORE_PREFIX(retro_api_version)(void)
@@ -901,9 +959,6 @@ void NETRETROPAD_CORE_PREFIX(retro_run)(void)
    if (NETRETROPAD_CORE_PREFIX(environ_cb)(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) && updated)
       netretropad_check_variables();
 
-   if (!current_frame && current_screen == NETRETROPAD_SCREEN_SENSORS)
-      sensors_init();
-
    current_frame++;
    /* Update input states and send them if needed */
    retropad_update_input();
@@ -971,6 +1026,10 @@ void NETRETROPAD_CORE_PREFIX(retro_run)(void)
    }
 
    /* Accelerometer and gyroscope. */
+   if (current_screen == NETRETROPAD_SCREEN_SENSORS
+       && !tilt_sensor_enabled && !gyro_sensor_enabled && !lux_sensor_enabled)
+      sensors_enable();
+
    if (tilt_sensor_enabled)
    {
       tilt_sensor_values[0] = NETRETROPAD_CORE_PREFIX(sensor_get_input_cb)(0, RETRO_SENSOR_ACCELEROMETER_X);
@@ -1008,7 +1067,7 @@ void NETRETROPAD_CORE_PREFIX(retro_run)(void)
          /* Accelerometer display range: from 0 to 1g, covering tilt from a horizontal to a vertical position. */
          if (i < 3)
          {
-            value         = tilt_sensor_values[i]/9.81;
+            value         = tilt_sensor_values[i];
             median_index += (i+1)*10;
          }
          else if (i < 6)

input/drivers/android_input.c

@@ -2056,11 +2056,11 @@ static float android_input_get_sensor_input(void *data,
       switch (id)
       {
          case RETRO_SENSOR_ACCELEROMETER_X:
-            return android->accelerometer_state.x;
+            return android->accelerometer_state.x / 9.80665f;
          case RETRO_SENSOR_ACCELEROMETER_Y:
-            return android->accelerometer_state.y;
+            return android->accelerometer_state.y / 9.80665f;
          case RETRO_SENSOR_ACCELEROMETER_Z:
-            return android->accelerometer_state.z;
+            return android->accelerometer_state.z / 9.80665f;
          case RETRO_SENSOR_GYROSCOPE_X:
             return android->gyroscope_state.x;
          case RETRO_SENSOR_GYROSCOPE_Y:

input/drivers/cocoa_input.m

@@ -839,6 +839,36 @@ static bool cocoa_input_set_sensor_state(void *data, unsigned port,
 #endif
 }
 
+#if TARGET_OS_IOS && defined(HAVE_COREMOTION)
+/* Rotate a 2D sensor vector from the device's hardware coordinate frame
+ * to the current screen coordinate frame.  Accelerometer and gyroscope
+ * X/Y axes are fixed to the hardware (portrait) orientation, so they need
+ * remapping when the interface is in landscape or upside-down. */
+static void cocoa_sensor_rotate_xy(float *x, float *y)
+{
+   float rawX = *x, rawY = *y;
+   UIInterfaceOrientation orient =
+         [[UIApplication sharedApplication] statusBarOrientation];
+   switch (orient)
+   {
+      case UIInterfaceOrientationLandscapeLeft:
+         *x =  rawY;
+         *y = -rawX;
+         break;
+      case UIInterfaceOrientationLandscapeRight:
+         *x = -rawY;
+         *y =  rawX;
+         break;
+      case UIInterfaceOrientationPortraitUpsideDown:
+         *x = -rawX;
+         *y = -rawY;
+         break;
+      default:
+         break;
+   }
+}
+#endif
+
 static float cocoa_input_get_sensor_input(void *data, unsigned port, unsigned id)
 {
 #ifdef HAVE_MFI
@@ -875,15 +905,30 @@ static float cocoa_input_get_sensor_input(void *data, unsigned port, unsigned id
       switch (id)
       {
          case RETRO_SENSOR_ACCELEROMETER_X:
-            return motionManager.deviceMotion.gravity.x + motionManager.deviceMotion.userAcceleration.x;
          case RETRO_SENSOR_ACCELEROMETER_Y:
-            return motionManager.deviceMotion.gravity.y + motionManager.deviceMotion.userAcceleration.y;
+         {
+            float x = motionManager.deviceMotion.gravity.x
+                  + motionManager.deviceMotion.userAcceleration.x;
+            float y = motionManager.deviceMotion.gravity.y
+                  + motionManager.deviceMotion.userAcceleration.y;
+#if TARGET_OS_IOS
+            cocoa_sensor_rotate_xy(&x, &y);
+#endif
+            return (id == RETRO_SENSOR_ACCELEROMETER_X) ? x : y;
+         }
          case RETRO_SENSOR_ACCELEROMETER_Z:
-            return motionManager.deviceMotion.gravity.z + motionManager.deviceMotion.userAcceleration.z;
+            return motionManager.deviceMotion.gravity.z
+                  + motionManager.deviceMotion.userAcceleration.z;
          case RETRO_SENSOR_GYROSCOPE_X:
-            return motionManager.deviceMotion.rotationRate.x;
          case RETRO_SENSOR_GYROSCOPE_Y:
-            return motionManager.deviceMotion.rotationRate.y;
+         {
+            float x = motionManager.deviceMotion.rotationRate.x;
+            float y = motionManager.deviceMotion.rotationRate.y;
+#if TARGET_OS_IOS
+            cocoa_sensor_rotate_xy(&x, &y);
+#endif
+            return (id == RETRO_SENSOR_GYROSCOPE_X) ? x : y;
+         }
          case RETRO_SENSOR_GYROSCOPE_Z:
             return motionManager.deviceMotion.rotationRate.z;
       }

input/input_driver.c

@@ -4699,9 +4699,11 @@ void input_mapper_reset(void *data)
 bool input_set_sensor_state(unsigned port,
       enum retro_sensor_action action, unsigned rate)
 {
-   bool input_sensors_enable   = config_get_ptr()->bools.input_sensors_enable;
+   settings_t *settings        = config_get_ptr();
+   bool input_sensors_enable   = settings->bools.input_sensors_enable;
+   unsigned joy_idx            = settings->uints.input_joypad_index[port];
    return input_driver_set_sensor(
-      port, input_sensors_enable, action, rate);
+      joy_idx, input_sensors_enable, action, rate);
 }
 
 const char *joypad_driver_name(unsigned i)
@@ -4746,12 +4748,13 @@ float input_get_sensor_state(unsigned port, unsigned id)
 {
    settings_t *settings      = config_get_ptr();
    bool input_sensors_enable = settings->bools.input_sensors_enable;
+   unsigned joy_idx          = settings->uints.input_joypad_index[port];
    float sensitivity         = 1.0f;
    if (id >= RETRO_SENSOR_ACCELEROMETER_X && id <= RETRO_SENSOR_ACCELEROMETER_Z)
       sensitivity = settings->floats.input_sensor_accelerometer_sensitivity;
    else if (id >= RETRO_SENSOR_GYROSCOPE_X && id <= RETRO_SENSOR_GYROSCOPE_Z)
       sensitivity = settings->floats.input_sensor_gyroscope_sensitivity;
-   return input_driver_get_sensor(port, input_sensors_enable, id) * sensitivity;
+   return input_driver_get_sensor(joy_idx, input_sensors_enable, id) * sensitivity;
 }
 
 /**

libretro-common/include/libretro.h

@@ -4479,23 +4479,27 @@ enum retro_sensor_action
 /* Id values for SENSOR types. */
 
 /**
- * Returns the device's acceleration along its local X axis minus the effect of gravity, in m/s^2.
+ * Returns the device's acceleration along its local X axis, in g (standard gravity, 9.80665 m/s^2).
+ * Includes the effect of gravity;
+ * a device at rest on a table will have values close to 0, 0, 1.
  *
- * Positive values mean that the device is accelerating to the right.
+ * Positive values mean that the device is accelerating to the right,
  * assuming the user is looking at it head-on.
  */
 #define RETRO_SENSOR_ACCELEROMETER_X 0
 
 /**
- * Returns the device's acceleration along its local Y axis minus the effect of gravity, in m/s^2.
+ * Returns the device's acceleration along its local Y axis, in g (standard gravity, 9.80665 m/s^2).
+ * Includes the effect of gravity.
  *
  * Positive values mean that the device is accelerating upwards,
  * assuming the user is looking at it head-on.
  */
 #define RETRO_SENSOR_ACCELEROMETER_Y 1
 
 /**
- * Returns the the device's acceleration along its local Z axis minus the effect of gravity, in m/s^2.
+ * Returns the device's acceleration along its local Z axis, in g (standard gravity, 9.80665 m/s^2).
+ * Includes the effect of gravity.
  *
  * Positive values indicate forward acceleration towards the user,
  * assuming the user is looking at the device head-on.