src/metrics_filter_interpreter_unittest.cc

// Copyright 2022 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <gtest/gtest.h>

#include "include/metrics_filter_interpreter.h"
#include "include/unittest_util.h"

namespace gestures {

namespace {

const HardwareProperties hwprops = {
  .right = 100, .bottom = 100,
  .res_x = 1, .res_y = 1,
  .orientation_minimum = -1,
  .orientation_maximum = 2,
  .max_finger_cnt = 5, .max_touch_cnt = 5,
  .supports_t5r2 = 0, .support_semi_mt = 0, .is_button_pad = 1,
  .has_wheel = 0, .wheel_is_hi_res = 0,
  .is_haptic_pad = 0,
};

}  // namespace

class MetricsFilterInterpreterTest : public ::testing::Test {};

class MetricsFilterInterpreterTestInterpreter : public Interpreter {
 public:
  MetricsFilterInterpreterTestInterpreter()
      : Interpreter(nullptr, nullptr, false),
        handle_timer_called_(false) {}

  virtual void SyncInterpret(HardwareState& hwstate, stime_t* timeout) {
    EXPECT_EQ(1, hwstate.finger_cnt);
    prev_ = hwstate.fingers[0];
  }

  virtual void HandleTimer(stime_t now, stime_t* timeout) {
    handle_timer_called_ = true;
  }

  FingerState prev_;
  bool handle_timer_called_;
};


TEST(MetricsFilterInterpreterTest, SimpleTestTouchpad) {
  MetricsFilterInterpreterTestInterpreter* base_interpreter =
      new MetricsFilterInterpreterTestInterpreter;
  MetricsFilterInterpreter interpreter(nullptr, base_interpreter, nullptr,
                                       GESTURES_DEVCLASS_TOUCHPAD);

  TestInterpreterWrapper wrapper(&interpreter, &hwprops);

  EXPECT_FALSE(base_interpreter->handle_timer_called_);
  wrapper.HandleTimer(0.0, nullptr);
  EXPECT_TRUE(base_interpreter->handle_timer_called_);

  FingerState finger_states[] = {
    // TM, Tm, WM, Wm, Press, Orientation, X, Y, TrID
    // Consistent movement for 16 frames
    {0, 0, 0, 0, 20, 0, 40, 20, 1, 0}, // 0
    {0, 0, 0, 0, 20, 0, 40, 25, 1, 0}, // 1
    {0, 0, 0, 0, 20, 0, 40, 30, 1, 0}, // 2
    {0, 0, 0, 0, 20, 0, 40, 35, 1, 0}, // 3
    {0, 0, 0, 0, 20, 0, 40, 40, 1, 0}, // 4
    {0, 0, 0, 0, 20, 0, 40, 45, 1, 0}, // 5
    {0, 0, 0, 0, 20, 0, 40, 50, 1, 0}, // 6
    {0, 0, 0, 0, 20, 0, 40, 55, 1, 0}, // 7
    {0, 0, 0, 0, 20, 0, 40, 60, 1, 0}, // 8
    {0, 0, 0, 0, 20, 0, 40, 65, 1, 0}, // 9
    {0, 0, 0, 0, 20, 0, 40, 70, 1, 0}, // 10
    {0, 0, 0, 0, 20, 0, 40, 75, 1, 0}, // 11
    {0, 0, 0, 0, 20, 0, 40, 80, 1, 0}, // 12
    {0, 0, 0, 0, 20, 0, 40, 85, 1, 0}, // 13
    {0, 0, 0, 0, 20, 0, 40, 90, 1, 0}, // 14
    {0, 0, 0, 0, 20, 0, 40, 95, 1, 0}, // 15
  };

  HardwareState hardware_states[] = {
    // time, buttons, finger count, touch count, finger states pointer
    make_hwstate(1.00, 0, 1, 1, &finger_states[0]),
    make_hwstate(1.01, 0, 1, 1, &finger_states[1]),
    make_hwstate(1.02, 0, 1, 1, &finger_states[2]),
    make_hwstate(1.03, 0, 1, 1, &finger_states[3]),
    make_hwstate(1.04, 0, 1, 1, &finger_states[4]),
    make_hwstate(1.05, 0, 1, 1, &finger_states[5]),
    make_hwstate(1.06, 0, 1, 1, &finger_states[6]),
    make_hwstate(1.07, 0, 1, 1, &finger_states[7]),
    make_hwstate(1.08, 0, 1, 1, &finger_states[8]),
    make_hwstate(1.09, 0, 1, 1, &finger_states[9]),
    make_hwstate(1.10, 0, 1, 1, &finger_states[10]),
    make_hwstate(1.11, 0, 1, 1, &finger_states[11]),
    make_hwstate(1.12, 0, 1, 1, &finger_states[12]),
    make_hwstate(1.13, 0, 1, 1, &finger_states[13]),
    make_hwstate(1.14, 0, 1, 1, &finger_states[14]),
    make_hwstate(1.15, 0, 1, 1, &finger_states[15]),
  };

  for (size_t i = 0; i < arraysize(hardware_states); i++) {
    wrapper.SyncInterpret(hardware_states[i], nullptr);
  }

  EXPECT_EQ(interpreter.devclass_, GESTURES_DEVCLASS_TOUCHPAD);
  EXPECT_EQ(interpreter.mouse_movement_session_index_, 0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_length, 0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_start, 0.0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_last, 0.0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_distance, 0.0);
  EXPECT_EQ(interpreter.noisy_ground_distance_threshold_.val_, 10.0);
  EXPECT_EQ(interpreter.noisy_ground_time_threshold_.val_, 0.1);
  EXPECT_EQ(interpreter.mouse_moving_time_threshold_.val_, 0.05);
  EXPECT_EQ(interpreter.mouse_control_warmup_sessions_.val_, 100);
}

TEST(MetricsFilterInterpreterTest, SimpleTestMultitouchMouse) {
  MetricsFilterInterpreterTestInterpreter* base_interpreter =
      new MetricsFilterInterpreterTestInterpreter;
  MetricsFilterInterpreter interpreter(nullptr, base_interpreter, nullptr,
                                       GESTURES_DEVCLASS_MULTITOUCH_MOUSE);

  TestInterpreterWrapper wrapper(&interpreter, &hwprops);

  EXPECT_FALSE(base_interpreter->handle_timer_called_);
  wrapper.HandleTimer(0.0, nullptr);
  EXPECT_TRUE(base_interpreter->handle_timer_called_);

  FingerState finger_states[] = {
    // TM, Tm, WM, Wm, Press, Orientation, X, Y, TrID
    // Consistent movement for 16 frames
    {0, 0, 0, 0, 20, 0, 40, 20, 1, 0}, // 0
    {0, 0, 0, 0, 20, 0, 40, 25, 1, 0}, // 1
    {0, 0, 0, 0, 20, 0, 40, 30, 1, 0}, // 2
    {0, 0, 0, 0, 20, 0, 40, 35, 1, 0}, // 3
    {0, 0, 0, 0, 20, 0, 40, 40, 1, 0}, // 4
    {0, 0, 0, 0, 20, 0, 40, 45, 1, 0}, // 5
    {0, 0, 0, 0, 20, 0, 40, 50, 1, 0}, // 6
    {0, 0, 0, 0, 20, 0, 40, 55, 1, 0}, // 7
    {0, 0, 0, 0, 20, 0, 40, 60, 1, 0}, // 8
    {0, 0, 0, 0, 20, 0, 40, 65, 1, 0}, // 9
    {0, 0, 0, 0, 20, 0, 40, 70, 1, 0}, // 10
    {0, 0, 0, 0, 20, 0, 40, 75, 1, 0}, // 11
    {0, 0, 0, 0, 20, 0, 40, 80, 1, 0}, // 12
    {0, 0, 0, 0, 20, 0, 40, 85, 1, 0}, // 13
    {0, 0, 0, 0, 20, 0, 40, 90, 1, 0}, // 14
    {0, 0, 0, 0, 20, 0, 40, 95, 1, 0}, // 15
  };

  HardwareState hardware_states[] = {
    // time, buttons, finger count, touch count, finger states pointer
    make_hwstate(1.00, 0, 1, 1, &finger_states[0]),
    make_hwstate(1.01, 0, 1, 1, &finger_states[1]),
    make_hwstate(1.02, 0, 1, 1, &finger_states[2]),
    make_hwstate(1.03, 0, 1, 1, &finger_states[3]),
    make_hwstate(1.04, 0, 1, 1, &finger_states[4]),
    make_hwstate(1.05, 0, 1, 1, &finger_states[5]),
    make_hwstate(1.06, 0, 1, 1, &finger_states[6]),
    make_hwstate(1.07, 0, 1, 1, &finger_states[7]),
    make_hwstate(1.08, 0, 1, 1, &finger_states[8]),
    make_hwstate(1.09, 0, 1, 1, &finger_states[9]),
    make_hwstate(1.10, 0, 1, 1, &finger_states[10]),
    make_hwstate(1.11, 0, 1, 1, &finger_states[11]),
    make_hwstate(1.12, 0, 1, 1, &finger_states[12]),
    make_hwstate(1.13, 0, 1, 1, &finger_states[13]),
    make_hwstate(1.14, 0, 1, 1, &finger_states[14]),
    make_hwstate(1.15, 0, 1, 1, &finger_states[15]),
  };

  for (size_t i = 0; i < arraysize(hardware_states); i++) {
    wrapper.SyncInterpret(hardware_states[i], nullptr);
  }

  EXPECT_EQ(interpreter.devclass_, GESTURES_DEVCLASS_MULTITOUCH_MOUSE);
  EXPECT_EQ(interpreter.mouse_movement_session_index_, 0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_length, 0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_start, 0.0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_last, 0.0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_distance, 0.0);
  EXPECT_EQ(interpreter.noisy_ground_distance_threshold_.val_, 10.0);
  EXPECT_EQ(interpreter.noisy_ground_time_threshold_.val_, 0.1);
  EXPECT_EQ(interpreter.mouse_moving_time_threshold_.val_, 0.05);
  EXPECT_EQ(interpreter.mouse_control_warmup_sessions_.val_, 100);
}

TEST(MetricsFilterInterpreterTest, SimpleTestPointingStick) {
  MetricsFilterInterpreterTestInterpreter* base_interpreter =
      new MetricsFilterInterpreterTestInterpreter;
  MetricsFilterInterpreter interpreter(nullptr, base_interpreter, nullptr,
                                       GESTURES_DEVCLASS_POINTING_STICK);

  TestInterpreterWrapper wrapper(&interpreter, &hwprops);

  EXPECT_FALSE(base_interpreter->handle_timer_called_);
  wrapper.HandleTimer(0.0, nullptr);
  EXPECT_TRUE(base_interpreter->handle_timer_called_);

  EXPECT_EQ(interpreter.devclass_, GESTURES_DEVCLASS_POINTING_STICK);
  EXPECT_EQ(interpreter.mouse_movement_session_index_, 0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_length, 0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_start, 0.0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_last, 0.0);
  EXPECT_EQ(interpreter.mouse_movement_current_session_distance, 0.0);
  EXPECT_EQ(interpreter.noisy_ground_distance_threshold_.val_, 10.0);
  EXPECT_EQ(interpreter.noisy_ground_time_threshold_.val_, 0.1);
  EXPECT_EQ(interpreter.mouse_moving_time_threshold_.val_, 0.05);
  EXPECT_EQ(interpreter.mouse_control_warmup_sessions_.val_, 100);
}

}  // namespace gestures