FeatureHandling.h

/*
 *  Copyright (C) 2014-2024 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "input/joysticks/JoystickTypes.h"

#include <chrono>
#include <memory>

namespace KODI
{
namespace JOYSTICK
{
class CDriverPrimitive;
class IInputHandler;
class IButtonMap;

class CJoystickFeature;
using FeaturePtr = std::shared_ptr<CJoystickFeature>;

class CJoystickFeature
{
public:
  CJoystickFeature(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  virtual ~CJoystickFeature() = default;

  virtual bool OnDigitalMotion(const CDriverPrimitive& source, bool bPressed) = 0;

  virtual bool OnAnalogMotion(const CDriverPrimitive& source, float magnitude) = 0;

  virtual void ProcessMotions(void) = 0;

  bool AcceptsInput(bool bActivation);

protected:
  void ResetMotion();

  void StartMotion();

  bool InMotion() const;

  unsigned int MotionTimeMs() const;

  const FeatureName m_name;
  IInputHandler* const m_handler;
  IButtonMap* const m_buttonMap;
  const bool m_bEnabled;

private:
  std::chrono::time_point<std::chrono::steady_clock> m_motionStartTimeMs;
};

class CScalarFeature : public CJoystickFeature
{
public:
  CScalarFeature(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  ~CScalarFeature() override = default;

  // implementation of CJoystickFeature
  bool OnDigitalMotion(const CDriverPrimitive& source, bool bPressed) override;
  bool OnAnalogMotion(const CDriverPrimitive& source, float magnitude) override;
  void ProcessMotions() override;

private:
  bool OnDigitalMotion(bool bPressed);
  bool OnAnalogMotion(float magnitude);

  void ProcessDigitalMotion();
  void ProcessAnalogMotion();

  // State variables
  INPUT_TYPE m_inputType = INPUT_TYPE::UNKNOWN;
  bool m_bDigitalState = false;
  bool m_bInitialPressHandled = false;

  // Analog state variables
  float m_analogState = 0.0f; // The current magnitude
  float m_bActivated = false; // Set to true when first activated (magnitude > 0.0)
  bool m_bDiscrete = true; // Set to false when a non-discrete axis is detected
};

class CFeatureAxis
{
public:
  CFeatureAxis(void) { Reset(); }

  void SetPositiveDistance(float distance) { m_positiveDistance = distance; }

  void SetNegativeDistance(float distance) { m_negativeDistance = distance; }

  float GetPosition(void) const { return m_positiveDistance - m_negativeDistance; }

  void Reset(void) { m_positiveDistance = m_negativeDistance = 0.0f; }

protected:
  float m_positiveDistance;
  float m_negativeDistance;
};

class CAxisFeature : public CJoystickFeature
{
public:
  CAxisFeature(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  ~CAxisFeature() override = default;

  // partial implementation of CJoystickFeature
  bool OnDigitalMotion(const CDriverPrimitive& source, bool bPressed) override;
  void ProcessMotions() override;

protected:
  CFeatureAxis m_axis;

  float m_state = 0.0f;
};

class CWheel : public CAxisFeature
{
public:
  CWheel(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  ~CWheel() override = default;

  // partial implementation of CJoystickFeature
  bool OnAnalogMotion(const CDriverPrimitive& source, float magnitude) override;
};

class CThrottle : public CAxisFeature
{
public:
  CThrottle(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  ~CThrottle() override = default;

  // partial implementation of CJoystickFeature
  bool OnAnalogMotion(const CDriverPrimitive& source, float magnitude) override;
};

class CAnalogStick : public CJoystickFeature
{
public:
  CAnalogStick(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  ~CAnalogStick() override = default;

  // implementation of CJoystickFeature
  bool OnDigitalMotion(const CDriverPrimitive& source, bool bPressed) override;
  bool OnAnalogMotion(const CDriverPrimitive& source, float magnitude) override;
  void ProcessMotions() override;

protected:
  CFeatureAxis m_vertAxis;
  CFeatureAxis m_horizAxis;

  float m_vertState = 0.0f;
  float m_horizState = 0.0f;
};

class CAccelerometer : public CJoystickFeature
{
public:
  CAccelerometer(const FeatureName& name, IInputHandler* handler, IButtonMap* buttonMap);
  ~CAccelerometer() override = default;

  // implementation of CJoystickFeature
  bool OnDigitalMotion(const CDriverPrimitive& source, bool bPressed) override;
  bool OnAnalogMotion(const CDriverPrimitive& source, float magnitude) override;
  void ProcessMotions() override;

protected:
  CFeatureAxis m_xAxis;
  CFeatureAxis m_yAxis;
  CFeatureAxis m_zAxis;

  float m_xAxisState = 0.0f;
  float m_yAxisState = 0.0f;
  float m_zAxisState = 0.0f;
};
} // namespace JOYSTICK
} // namespace KODI