dom/vr/VRServiceTest.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_VRServiceTest_h_
   8 #define mozilla_dom_VRServiceTest_h_
   9
  10 #include "mozilla/DOMEventTargetHelper.h"
  11 #include "mozilla/dom/TypedArray.h"
  12 #include "mozilla/dom/VRServiceTestBinding.h"
  13
  14 #include "gfxVR.h"
  15
  16 namespace mozilla {
  17 namespace gfx {
  18 enum class VRDisplayCapabilityFlags : uint16_t;
  19 enum class VRPuppet_Command : uint64_t;
  20 }  // namespace gfx
  21 namespace dom {
  22 enum class GamepadCapabilityFlags : uint16_t;
  23
  24 class VRMockDisplay final : public DOMEventTargetHelper {
  25  public:
  26   NS_DECL_ISUPPORTS_INHERITED
  27   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(VRMockDisplay, DOMEventTargetHelper)
  28
  29   explicit VRMockDisplay(VRServiceTest* aVRServiceTest);
  30
  31   void Create();
  32   void Clear();
  33
  34   void SetConnected(bool aConnected);
  35   bool Connected() const;
  36   void SetMounted(bool aMounted);
  37   bool Mounted() const;
  38   void SetCapPosition(bool aEnabled);
  39   bool CapPosition() const;
  40   void SetCapOrientation(bool aEnabled);
  41   bool CapOrientation() const;
  42   void SetCapPresent(bool aEnabled);
  43   bool CapPresent() const;
  44   void SetCapExternal(bool aEnabled);
  45   bool CapExternal() const;
  46   void SetCapAngularAcceleration(bool aEnabled);
  47   bool CapAngularAcceleration() const;
  48   void SetCapLinearAcceleration(bool aEnabled);
  49   bool CapLinearAcceleration() const;
  50   void SetCapStageParameters(bool aEnabled);
  51   bool CapStageParameters() const;
  52   void SetCapMountDetection(bool aEnabled);
  53   bool CapMountDetection() const;
  54   void SetCapPositionEmulated(bool aEnabled);
  55   bool CapPositionEmulated() const;
  56   void SetEyeFOV(VREye aEye, double aUpDegree, double aRightDegree,
  57                  double aDownDegree, double aLeftDegree);
  58   void SetEyeOffset(VREye aEye, double aOffsetX, double aOffsetY,
  59                     double aOffsetZ);
  60   void SetEyeResolution(uint32_t aRenderWidth, uint32_t aRenderHeight);
  61   void SetStageSize(double aWidth, double aHeight);
  62   void SetSittingToStandingTransform(const Float32Array& aTransform,
  63                                      ErrorResult& aRv);
  64   void SetPose(const Nullable<Float32Array>& aPosition,
  65                const Nullable<Float32Array>& aLinearVelocity,
  66                const Nullable<Float32Array>& aLinearAcceleration,
  67                const Nullable<Float32Array>& aOrientation,
  68                const Nullable<Float32Array>& aAngularVelocity,
  69                const Nullable<Float32Array>& aAngularAcceleration,
  70                ErrorResult& aRv);
  71   virtual JSObject* WrapObject(JSContext* aCx,
  72                                JS::Handle<JSObject*> aGivenProto) override;
  73
  74  private:
  75   ~VRMockDisplay() = default;
  76   gfx::VRDisplayState& DisplayState() const;
  77   gfx::VRHMDSensorState& SensorState() const;
  78   void SetCapFlag(gfx::VRDisplayCapabilityFlags aFlag, bool aEnabled);
  79   bool GetCapFlag(gfx::VRDisplayCapabilityFlags aFlag) const;
  80
  81   RefPtr<VRServiceTest> mVRServiceTest;
  82 };
  83
  84 class VRMockController : public DOMEventTargetHelper {
  85  public:
  86   NS_DECL_ISUPPORTS_INHERITED
  87   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(VRMockController,
  88                                            DOMEventTargetHelper)
  89
  90   VRMockController(VRServiceTest* aVRServiceTest, uint32_t aControllerIdx);
  91   void Create();
  92   void Clear();
  93   void SetHand(GamepadHand aHand);
  94   GamepadHand Hand() const;
  95   void SetCapPosition(bool aEnabled);
  96   bool CapPosition() const;
  97   void SetCapOrientation(bool aEnabled);
  98   bool CapOrientation() const;
  99   void SetCapAngularAcceleration(bool aEnabled);
 100   bool CapAngularAcceleration() const;
 101   void SetCapLinearAcceleration(bool aEnabled);
 102   bool CapLinearAcceleration() const;
 103   void SetAxisCount(uint32_t aCount);
 104   uint32_t AxisCount() const;
 105   void SetButtonCount(uint32_t aCount);
 106   uint32_t ButtonCount() const;
 107   void SetHapticCount(uint32_t aCount);
 108   uint32_t HapticCount() const;
 109   void SetButtonPressed(uint32_t aButtonIdx, bool aPressed);
 110   void SetButtonTouched(uint32_t aButtonIdx, bool aTouched);
 111   void SetButtonTrigger(uint32_t aButtonIdx, double aTrigger);
 112   void SetAxisValue(uint32_t aAxisIdx, double aValue);
 113   void SetPose(const Nullable<Float32Array>& aPosition,
 114                const Nullable<Float32Array>& aLinearVelocity,
 115                const Nullable<Float32Array>& aLinearAcceleration,
 116                const Nullable<Float32Array>& aOrientation,
 117                const Nullable<Float32Array>& aAngularVelocity,
 118                const Nullable<Float32Array>& aAngularAcceleration,
 119                ErrorResult& aRv);
 120
 121   virtual JSObject* WrapObject(JSContext* aCx,
 122                                JS::Handle<JSObject*> aGivenProto) override;
 123
 124  private:
 125   ~VRMockController() = default;
 126   gfx::VRControllerState& ControllerState() const;
 127   void SetCapFlag(GamepadCapabilityFlags aFlag, bool aEnabled);
 128   bool GetCapFlag(GamepadCapabilityFlags aFlag) const;
 129   RefPtr<VRServiceTest> mVRServiceTest;
 130   uint32_t mControllerIdx;
 131 };
 132
 133 class VRServiceTest final : public DOMEventTargetHelper {
 134  public:
 135   NS_DECL_ISUPPORTS_INHERITED
 136   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(VRServiceTest, DOMEventTargetHelper)
 137
 138   // WebIDL interface
 139
 140   void ClearAll();
 141   void ClearController(uint32_t aControllerIdx);
 142   void Commit();
 143   void End();
 144   already_AddRefed<Promise> Run(ErrorResult& aRv);
 145   already_AddRefed<Promise> Reset(ErrorResult& aRv);
 146   VRMockDisplay* GetVRDisplay();
 147   VRMockController* GetVRController(uint32_t aControllerIdx, ErrorResult& aRv);
 148   void Timeout(uint32_t aDuration);
 149   void Wait(uint32_t aDuration);
 150   void WaitSubmit();
 151   void WaitPresentationStart();
 152   void WaitPresentationEnd();
 153   void WaitHapticIntensity(uint32_t aControllerIdx, uint32_t aHapticIdx,
 154                            double aIntensity, ErrorResult& aRv);
 155   void CaptureFrame();
 156   void AcknowledgeFrame();
 157   void RejectFrame();
 158   void StartTimer();
 159   void StopTimer();
 160
 161   // Implementation
 162   void Shutdown();
 163   void AddCommand(uint64_t aCommand);
 164   static already_AddRefed<VRServiceTest> CreateTestService(
 165       nsPIDOMWindowInner* aWindow);
 166   virtual JSObject* WrapObject(JSContext* aCx,
 167                                JS::Handle<JSObject*> aGivenProto) override;
 168   gfx::VRSystemState& SystemState();
 169
 170  private:
 171   explicit VRServiceTest(nsPIDOMWindowInner* aWindow);
 172   ~VRServiceTest() = default;
 173   void EncodeData();
 174
 175   RefPtr<VRMockDisplay> mDisplay;
 176   nsTArray<RefPtr<VRMockController>> mControllers;
 177   nsCOMPtr<nsPIDOMWindowInner> mWindow;
 178   // mPendingState records the state of the emulated VR hardware, including
 179   // changes that have not yet been committed to the command buffer.
 180   gfx::VRSystemState mPendingState;
 181   // mEncodedState records the state of the emulate VR hardware at the end
 182   // of the last committed transaction, submitted with VRServiceTest::Commit().
 183   // mPendingState represents the resulting state if all of the commands in
 184   // mCommandBuffer have been played back.
 185   gfx::VRSystemState mEncodedState;
 186   // mCommandBuffer encodes a sequence of steps to be executed asynchronously by
 187   // the simulated VR hardware.  The steps are encoded as a stream of uint64's,
 188   // using the format described in gfx/vr/VRPuppetCommandBuffer.h
 189   // mCommandBuffer includes only complete transactions, which will be played
 190   // back such that multiple values in VRSystemState will be updated atomically.
 191   // When the command buffer is submitted to the PuppetSession, with
 192   // VRServiceTest::Run(), it is cleared  to ensure that the commands are not
 193   // sent redundantly in subsequent VRServicetest::Run() calls.
 194   // VRServiceTest::Commit() will perform a binary comparison of mPendingState
 195   // and mEncodedState to determine what instructions need to be appended to
 196   // mCommandBuffer.
 197   // VRServiceTest::Reset() will effectively cancel all transactions and clear
 198   // mCommandBuffer before submitting the reset request to the PuppetSession.
 199   nsTArray<uint64_t> mCommandBuffer;
 200   bool mShuttingDown;
 201 };
 202
 203 }  // namespace dom
 204 }  // namespace mozilla
 205
 206 #endif  // mozilla_dom_VRServiceTest_h_