pymol-open-source/contrib/vr/OpenVRStub.cpp

/*
OpenVR for PyMOL Copyright Notice
=====================================

The OpenVR for PyMOL source code is copyrighted, but you can freely use and
copy it as long as you don't change or remove any of the Copyright notices.
OpenVR for PyMOL is made available under the following open-source license
terms:

------------------------------------------------------------------------------
Copyright (c) 2018 EPAM Systems, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
------------------------------------------------------------------------------

*/

// system headers
#include <cstring>

// this headers
#include "OpenVRStub.h"

// local headers
#include "OpenVRStubDevice.h"

static bool _stubEnabled = false;
static vr::IVRSystem* _stubSystem = nullptr;
static vr::IVRCompositor* _stubCompositor = nullptr;
static vr::IVRInput* _stubInput = nullptr;

namespace vr {
namespace stub {

void VR_StubEnable(bool on /* = true */)
{
  _stubEnabled = on;
}

bool VR_IsStubEnabled()
{
  return _stubEnabled;
}

IVRSystem* VRSystem()
{
  return _stubEnabled ? _stubSystem : vr::VRSystem();
}

IVRCompositor* VRCompositor()
{
  return _stubEnabled ? _stubCompositor : vr::VRCompositor();
}

IVRInput* VRInput()
{
  return _stubEnabled ? _stubInput : vr::VRInput();
}

IVRSystem *VR_Init(EVRInitError *peError, EVRApplicationType eApplicationType, const char *pStartupInfo /* = nullptr */)
{
  // pass-through
  if (!_stubEnabled) {
    return vr::VR_Init(peError, eApplicationType, pStartupInfo);
  }

#if defined(_PYMOL_OPENVR_MINOR) && _PYMOL_OPENVR_MINOR > 1
  // stub requires openvr 1.0.x
  printf("compile with openvr 1.0.x and -D_PYMOL_OPENVR_MINOR=0 for stub support\n");
#else
  // create a stub
  _stubSystem = new VRSystemStub();
  _stubCompositor = new VRCompositorStub();
  _stubInput = new VRInputStub();
#endif

  if (peError)
    *peError = vr::VRInitError_None;

  return _stubSystem;
}

void VR_Shutdown()
{
  // pass-through
  if (!_stubEnabled) {
    vr::VR_Shutdown();
  }

  // destroy stubs
  if (_stubCompositor) {
    delete _stubCompositor;
    _stubCompositor = nullptr;
  }
  if (_stubSystem) {
    delete _stubSystem;
    _stubSystem = nullptr;
  }
}

bool VR_IsHmdPresent()
{
  // pass-through
  if (!_stubEnabled) {
    return vr::VR_IsHmdPresent();
  }
  return true;
}

const char *VR_GetVRInitErrorAsEnglishDescription(EVRInitError error)
{
  return vr::VR_GetVRInitErrorAsEnglishDescription(error);
}

void VRSystemStub::GetRecommendedRenderTargetSize(uint32_t *pnWidth, uint32_t *pnHeight)
{
  *pnWidth = 1512;
  *pnHeight = 1680;
}

void VRSystemStub::GetProjectionRaw(EVREye eEye, float *pfLeft, float *pfRight, float *pfTop, float *pfBottom)
{
  if (eEye == Eye_Left) {
    *pfLeft = -1.39666343f;
    *pfRight = 1.23994398f;
    *pfTop = -1.47110546f;
    *pfBottom = 1.45868433f;
  } else {
    *pfLeft = -1.24060011f;
    *pfRight = 1.39432383f;
    *pfTop = -1.46788049f;
    *pfBottom = 1.46032500f;
  }
}

HmdMatrix34_t VRSystemStub::GetEyeToHeadTransform(EVREye eEye)
{
  static HmdMatrix34_t matrix[] = {{{
    {1.000000000, 0.000000000, 0.000000000, -0.0321500003},
    {0.000000000, 1.000000000, 0.000000000,  0.000000000},
    {0.000000000, 0.000000000, 1.000000000,  0.0149999997},
  }}, {{
    {1.000000000, 0.000000000, 0.000000000, 0.0321500003},
    {0.000000000, 1.000000000, 0.000000000, 0.0000000000},
    {0.000000000, 0.000000000, 1.000000000, 0.0149999997},
  }}};
  return matrix[eEye];
}

ETrackedDeviceClass VRSystemStub::GetTrackedDeviceClass(vr::TrackedDeviceIndex_t unDeviceIndex)
{
  Device_t const* device = DeviceList_t::GetDevice(unDeviceIndex);
  return device ? device->deviceClass : TrackedDeviceClass_Invalid;
}

uint32_t VRSystemStub::GetStringTrackedDeviceProperty(vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, char *pchValue, uint32_t unBufferSize, ETrackedPropertyError *pError /* = 0L */)
{
  if (pchValue != nullptr && unBufferSize != 0)
    *pchValue = 0;

  Device_t const* device = DeviceList_t::GetDevice(unDeviceIndex);
  if (!device) {
    if (pError)
      *pError = TrackedProp_InvalidDevice;
    return 0;
  }

  DeviceProperty_t const* property = device->FindProperty(prop);
  if (!property) {
    if (pError)
      *pError = TrackedProp_UnknownProperty;
    return 0;
  }

  return property->Get(pchValue, unBufferSize, pError);
}

bool VRSystemStub::PollNextEvent( VREvent_t *pEvent, uint32_t uncbVREvent )
{
  return false;
}

EVRCompositorError VRCompositorStub::WaitGetPoses(TrackedDevicePose_t* pRenderPoseArray, uint32_t unRenderPoseArrayCount, TrackedDevicePose_t* pGamePoseArray, uint32_t unGamePoseArrayCount)
{
  static HmdMatrix34_t matrix = {{
    {1.000000000, 0.000000000, 0.000000000,  0.000000000},
    {0.000000000, 1.000000000, 0.000000000,  1.000000000},
    {0.000000000, 0.000000000, 1.000000000,  0.000000000},
  }};

  for (uint32_t nDevice = 0; nDevice < vr::k_unMaxTrackedDeviceCount; nDevice++) {
    if (_stubSystem->GetTrackedDeviceClass(nDevice) == vr::TrackedDeviceClass_HMD) {
      vr::TrackedDevicePose_t &pose = pRenderPoseArray[nDevice];
      std::memcpy((void *)&pose.mDeviceToAbsoluteTracking, (const void *)&matrix, sizeof (float) * 12);
      pose.bPoseIsValid = true;
      pose.bDeviceIsConnected = true;
      pose.eTrackingResult = vr::TrackingResult_Running_OK;
    }
  }
  return VRCompositorError_None;
}

EVRCompositorError VRCompositorStub::Submit(EVREye eEye, const Texture_t *pTexture, const VRTextureBounds_t* pBounds /* = 0 */, EVRSubmitFlags nSubmitFlags /* = Submit_Default */)
{
  return VRCompositorError_None;
}

EVRInputError VRInputStub::GetDigitalActionData( VRActionHandle_t action, InputDigitalActionData_t *pActionData, uint32_t unActionDataSize, VRInputValueHandle_t ulRestrictToDevice )
{
  pActionData->bActive = false;
  pActionData->activeOrigin = (VRInputValueHandle_t)0xFACEFACE;
  pActionData->bState = false;
  pActionData->bChanged = false;
  pActionData->fUpdateTime = 0.0f;
  return VRInputError_None;
}

EVRInputError VRInputStub::GetAnalogActionData( VRActionHandle_t action, InputAnalogActionData_t *pActionData, uint32_t unActionDataSize, VRInputValueHandle_t ulRestrictToDevice )
{
  pActionData->bActive = false;
  pActionData->activeOrigin = (VRInputValueHandle_t)0xFACEFACE;
  pActionData->x = pActionData->y = pActionData->z = 0.0f;
  pActionData->deltaX = pActionData->deltaY = pActionData->deltaZ = 0.0f;
  pActionData->fUpdateTime = 0.0f;
  return VRInputError_None;
}

EVRInputError VRInputStub::GetPoseActionData( VRActionHandle_t action, ETrackingUniverseOrigin eOrigin, float fPredictedSecondsFromNow, InputPoseActionData_t *pActionData, uint32_t unActionDataSize, VRInputValueHandle_t ulRestrictToDevice )
{
  pActionData->bActive = false;
  pActionData->activeOrigin = (VRInputValueHandle_t)0xFACEFACE;
  memset(&pActionData->pose, 0, sizeof(TrackedDevicePose_t));
  pActionData->pose.mDeviceToAbsoluteTracking.m[0][0] = 1.0f;
  pActionData->pose.mDeviceToAbsoluteTracking.m[1][1] = 1.0f;
  pActionData->pose.mDeviceToAbsoluteTracking.m[2][2] = 1.0f;
  return VRInputError_None;
}


} // stub
} // vr