summaryrefslogtreecommitdiffstats
path: root/gfx/vr/ipc/VRLayerChild.cpp
blob: 57f69f7d2b1f3e4d35ec577ce1a442cd0e720432 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "VRLayerChild.h"

#include "mozilla/dom/HTMLCanvasElement.h"
#include "mozilla/layers/ImageBridgeChild.h"
#include "mozilla/layers/LayersMessages.h"  // for TimedTexture
#include "mozilla/layers/SyncObject.h"      // for SyncObjectClient
#include "mozilla/StaticPrefs_dom.h"
#include "mozilla/StaticPrefs_webgl.h"

#include "ClientWebGLContext.h"
#include "gfxPlatform.h"
#include "GLContext.h"
#include "GLScreenBuffer.h"
#include "SharedSurface.h"    // for SharedSurface
#include "SharedSurfaceGL.h"  // for SharedSurface

namespace mozilla::gfx {

VRLayerChild::VRLayerChild() { MOZ_COUNT_CTOR(VRLayerChild); }

VRLayerChild::~VRLayerChild() {
  ClearSurfaces();

  MOZ_COUNT_DTOR(VRLayerChild);
}

void VRLayerChild::Initialize(dom::HTMLCanvasElement* aCanvasElement,
                              const gfx::Rect& aLeftEyeRect,
                              const gfx::Rect& aRightEyeRect) {
  MOZ_ASSERT(aCanvasElement);
  mLeftEyeRect = aLeftEyeRect;
  mRightEyeRect = aRightEyeRect;
  mCanvasElement = aCanvasElement;
}

void VRLayerChild::SetXRFramebuffer(WebGLFramebufferJS* fb) {
  mFramebuffer = fb;
}

static constexpr bool kIsAndroid =
#if defined(MOZ_WIDGET_ANDROID)
    true;
#else
    false;
#endif

void VRLayerChild::SubmitFrame(const VRDisplayInfo& aDisplayInfo) {
  uint64_t frameId = aDisplayInfo.GetFrameId();

  // aFrameId will not increment unless the previuosly submitted
  // frame was received by the VR thread and submitted to the VR
  // compositor.  We early-exit here in the event that SubmitFrame
  // was called twice for the same aFrameId.
  if (!mCanvasElement || frameId == mLastSubmittedFrameId) {
    return;
  }

  const auto& webgl = mCanvasElement->GetWebGLContext();
  if (!webgl) return;

  // Keep the SharedSurfaceTextureClient alive long enough for
  // 1 extra frame, accomodating overlapped asynchronous rendering.
  mLastFrameTextureDesc = mThisFrameTextureDesc;

  bool getNewFrame = true;
  if (kIsAndroid) {
    /**
     * Do not blit WebGL to a SurfaceTexture until the last submitted frame is
     * already processed and the new frame poses are ready. SurfaceTextures need
     * to be released in the VR render thread in order to allow to be used again
     * in the WebGLContext GLScreenBuffer producer. Not doing so causes some
     * freezes, crashes or other undefined behaviour.
     */
    getNewFrame = (!mThisFrameTextureDesc ||
                   aDisplayInfo.mDisplayState.lastSubmittedFrameId ==
                       mLastSubmittedFrameId);
  }
  if (getNewFrame) {
    const RefPtr<layers::ImageBridgeChild> imageBridge =
        layers::ImageBridgeChild::GetSingleton();

    auto texType = layers::TextureType::Unknown;
    if (imageBridge) {
      texType = layers::PreferredCanvasTextureType(imageBridge);
    }
    if (kIsAndroid && StaticPrefs::webgl_enable_surface_texture()) {
      texType = layers::TextureType::AndroidNativeWindow;
    }

    webgl->Present(mFramebuffer, texType, true);
    mThisFrameTextureDesc = webgl->GetFrontBuffer(mFramebuffer, true);
  }

  mLastSubmittedFrameId = frameId;

  if (!mThisFrameTextureDesc) {
    gfxCriticalError() << "ToSurfaceDescriptor failed in "
                          "VRLayerChild::SubmitFrame";
    return;
  }

  SendSubmitFrame(*mThisFrameTextureDesc, frameId, mLeftEyeRect, mRightEyeRect);
}

bool VRLayerChild::IsIPCOpen() { return mIPCOpen; }

void VRLayerChild::ClearSurfaces() {
  mThisFrameTextureDesc = Nothing();
  mLastFrameTextureDesc = Nothing();
  const auto& webgl = mCanvasElement->GetWebGLContext();
  if (!mFramebuffer && webgl) {
    webgl->ClearVRSwapChain();
  }
}

void VRLayerChild::ActorDestroy(ActorDestroyReason aWhy) { mIPCOpen = false; }

// static
PVRLayerChild* VRLayerChild::CreateIPDLActor() {
  if (!StaticPrefs::dom_vr_enabled() && !StaticPrefs::dom_vr_webxr_enabled()) {
    return nullptr;
  }

  VRLayerChild* c = new VRLayerChild();
  c->AddIPDLReference();
  return c;
}

// static
bool VRLayerChild::DestroyIPDLActor(PVRLayerChild* actor) {
  static_cast<VRLayerChild*>(actor)->ReleaseIPDLReference();
  return true;
}

void VRLayerChild::AddIPDLReference() {
  MOZ_ASSERT(mIPCOpen == false);
  mIPCOpen = true;
  AddRef();
}
void VRLayerChild::ReleaseIPDLReference() {
  MOZ_ASSERT(mIPCOpen == false);
  Release();
}

}  // namespace mozilla::gfx