blob: edbd2c37892f21a318c6803525b4f2081b02da7b [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "gpu/ipc/service/direct_composition_child_surface_win.h"
#include <d3d11_1.h>
#include <dcomptypes.h>
#include "base/macros.h"
#include "base/metrics/histogram_macros.h"
#include "base/synchronization/waitable_event.h"
#include "base/trace_event/trace_event.h"
#include "base/win/windows_version.h"
#include "ui/display/display_switches.h"
#include "ui/gfx/native_widget_types.h"
#include "ui/gl/egl_util.h"
#include "ui/gl/gl_angle_util_win.h"
#include "ui/gl/gl_context.h"
#include "ui/gl/gl_surface_egl.h"
#include "ui/gl/scoped_make_current.h"
#ifndef EGL_ANGLE_flexible_surface_compatibility
#define EGL_ANGLE_flexible_surface_compatibility 1
#define EGL_FLEXIBLE_SURFACE_COMPATIBILITY_SUPPORTED_ANGLE 0x33A6
#endif /* EGL_ANGLE_flexible_surface_compatibility */
#ifndef EGL_ANGLE_d3d_texture_client_buffer
#define EGL_ANGLE_d3d_texture_client_buffer 1
#define EGL_D3D_TEXTURE_ANGLE 0x33A3
#endif /* EGL_ANGLE_d3d_texture_client_buffer */
namespace gpu {
namespace {
// Only one DirectComposition surface can be rendered into at a time. Track
// here which IDCompositionSurface is being rendered into. If another context
// is made current, then this surface will be suspended.
IDCompositionSurface* g_current_surface;
// Returns true if swap chain tearing is supported.
bool IsSwapChainTearingSupported() {
static const bool supported = [] {
// Swap chain tearing is used only if vsync is disabled explicitly.
if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
switches::kDisableGpuVsync))
return false;
// Swap chain tearing is supported only on Windows 10 Anniversary Edition
// (Redstone 1) and above.
if (base::win::GetVersion() < base::win::VERSION_WIN10_RS1)
return false;
Microsoft::WRL::ComPtr<ID3D11Device> d3d11_device =
gl::QueryD3D11DeviceObjectFromANGLE();
if (!d3d11_device) {
DLOG(ERROR) << "Not using swap chain tearing because failed to retrieve "
"D3D11 device from ANGLE";
return false;
}
Microsoft::WRL::ComPtr<IDXGIDevice> dxgi_device;
d3d11_device.As(&dxgi_device);
DCHECK(dxgi_device);
Microsoft::WRL::ComPtr<IDXGIAdapter> dxgi_adapter;
dxgi_device->GetAdapter(&dxgi_adapter);
DCHECK(dxgi_adapter);
Microsoft::WRL::ComPtr<IDXGIFactory5> dxgi_factory;
if (FAILED(dxgi_adapter->GetParent(IID_PPV_ARGS(&dxgi_factory)))) {
DLOG(ERROR) << "Not using swap chain tearing because failed to retrieve "
"IDXGIFactory5 interface";
return false;
}
BOOL present_allow_tearing = FALSE;
DCHECK(dxgi_factory);
if (FAILED(dxgi_factory->CheckFeatureSupport(
DXGI_FEATURE_PRESENT_ALLOW_TEARING, &present_allow_tearing,
sizeof(present_allow_tearing)))) {
DLOG(ERROR)
<< "Not using swap chain tearing because CheckFeatureSupport failed";
return false;
}
return !!present_allow_tearing;
}();
return supported;
}
} // namespace
DirectCompositionChildSurfaceWin::DirectCompositionChildSurfaceWin() = default;
DirectCompositionChildSurfaceWin::~DirectCompositionChildSurfaceWin() {
Destroy();
}
bool DirectCompositionChildSurfaceWin::Initialize(gl::GLSurfaceFormat format) {
d3d11_device_ = gl::QueryD3D11DeviceObjectFromANGLE();
dcomp_device_ = gl::QueryDirectCompositionDevice(d3d11_device_);
if (!dcomp_device_)
return false;
EGLDisplay display = GetDisplay();
EGLint pbuffer_attribs[] = {
EGL_WIDTH,
1,
EGL_HEIGHT,
1,
EGL_FLEXIBLE_SURFACE_COMPATIBILITY_SUPPORTED_ANGLE,
EGL_TRUE,
EGL_NONE,
};
default_surface_ =
eglCreatePbufferSurface(display, GetConfig(), pbuffer_attribs);
if (!default_surface_) {
DLOG(ERROR) << "eglCreatePbufferSurface failed with error "
<< ui::GetLastEGLErrorString();
return false;
}
return true;
}
bool DirectCompositionChildSurfaceWin::ReleaseDrawTexture(bool will_discard) {
// At the end we'll MakeCurrent the same surface but its handle will be
// |default_surface_|.
ui::ScopedReleaseCurrent release_current;
if (real_surface_) {
eglDestroySurface(GetDisplay(), real_surface_);
real_surface_ = nullptr;
}
if (dcomp_surface_.Get() == g_current_surface)
g_current_surface = nullptr;
if (draw_texture_) {
draw_texture_.Reset();
if (dcomp_surface_) {
HRESULT hr = dcomp_surface_->EndDraw();
if (FAILED(hr)) {
DLOG(ERROR) << "EndDraw failed with error " << std::hex << hr;
return false;
}
dcomp_surface_serial_++;
} else if (!will_discard) {
bool allow_tearing = IsSwapChainTearingSupported();
UINT interval = first_swap_ || !vsync_enabled_ || allow_tearing ? 0 : 1;
UINT flags = allow_tearing ? DXGI_PRESENT_ALLOW_TEARING : 0;
DXGI_PRESENT_PARAMETERS params = {};
RECT dirty_rect = swap_rect_.ToRECT();
params.DirtyRectsCount = 1;
params.pDirtyRects = &dirty_rect;
HRESULT hr = swap_chain_->Present1(interval, flags, &params);
// Ignore DXGI_STATUS_OCCLUDED since that's not an error but only
// indicates that the window is occluded and we can stop rendering.
if (FAILED(hr) && hr != DXGI_STATUS_OCCLUDED) {
DLOG(ERROR) << "Present1 failed with error " << std::hex << hr;
return false;
}
if (first_swap_) {
// Wait for the GPU to finish executing its commands before
// committing the DirectComposition tree, or else the swapchain
// may flicker black when it's first presented.
first_swap_ = false;
Microsoft::WRL::ComPtr<IDXGIDevice2> dxgi_device2;
d3d11_device_.As(&dxgi_device2);
DCHECK(dxgi_device2);
base::WaitableEvent event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
hr = dxgi_device2->EnqueueSetEvent(event.handle());
DCHECK(SUCCEEDED(hr));
event.Wait();
}
}
}
return true;
}
void DirectCompositionChildSurfaceWin::Destroy() {
if (default_surface_) {
if (!eglDestroySurface(GetDisplay(), default_surface_)) {
DLOG(ERROR) << "eglDestroySurface failed with error "
<< ui::GetLastEGLErrorString();
}
default_surface_ = nullptr;
}
if (real_surface_) {
if (!eglDestroySurface(GetDisplay(), real_surface_)) {
DLOG(ERROR) << "eglDestroySurface failed with error "
<< ui::GetLastEGLErrorString();
}
real_surface_ = nullptr;
}
if (dcomp_surface_ && (dcomp_surface_.Get() == g_current_surface)) {
HRESULT hr = dcomp_surface_->EndDraw();
if (FAILED(hr))
DLOG(ERROR) << "EndDraw failed with error " << std::hex << hr;
g_current_surface = nullptr;
}
draw_texture_.Reset();
dcomp_surface_.Reset();
}
gfx::Size DirectCompositionChildSurfaceWin::GetSize() {
return size_;
}
bool DirectCompositionChildSurfaceWin::IsOffscreen() {
return false;
}
void* DirectCompositionChildSurfaceWin::GetHandle() {
return real_surface_ ? real_surface_ : default_surface_;
}
gfx::SwapResult DirectCompositionChildSurfaceWin::SwapBuffers(
PresentationCallback callback) {
// PresentationCallback is handled by DirectCompositionSurfaceWin. The child
// surface doesn't need provide presentation feedback.
DCHECK(!callback);
if (!ReleaseDrawTexture(false /* will_discard */))
return gfx::SwapResult::SWAP_FAILED;
return gfx::SwapResult::SWAP_ACK;
}
bool DirectCompositionChildSurfaceWin::FlipsVertically() const {
return true;
}
bool DirectCompositionChildSurfaceWin::SupportsPostSubBuffer() {
return true;
}
bool DirectCompositionChildSurfaceWin::OnMakeCurrent(gl::GLContext* context) {
if (g_current_surface != dcomp_surface_.Get()) {
if (g_current_surface) {
HRESULT hr = g_current_surface->SuspendDraw();
if (FAILED(hr)) {
DLOG(ERROR) << "SuspendDraw failed with error " << std::hex << hr;
return false;
}
g_current_surface = nullptr;
}
if (draw_texture_) {
HRESULT hr = dcomp_surface_->ResumeDraw();
if (FAILED(hr)) {
DLOG(ERROR) << "ResumeDraw failed with error " << std::hex << hr;
return false;
}
g_current_surface = dcomp_surface_.Get();
}
}
return true;
}
bool DirectCompositionChildSurfaceWin::SupportsDCLayers() const {
return true;
}
bool DirectCompositionChildSurfaceWin::SetDrawRectangle(
const gfx::Rect& rectangle) {
if (!gfx::Rect(size_).Contains(rectangle)) {
DLOG(ERROR) << "Draw rectangle must be contained within size of surface";
return false;
}
if (draw_texture_) {
DLOG(ERROR) << "SetDrawRectangle must be called only once per swap buffers";
return false;
}
DCHECK(!real_surface_);
DCHECK(!g_current_surface);
if (gfx::Rect(size_) != rectangle && !swap_chain_ && !dcomp_surface_) {
DLOG(ERROR) << "First draw to surface must draw to everything";
return false;
}
// At the end we'll MakeCurrent the same surface but its handle will be
// |real_surface_|.
ui::ScopedReleaseCurrent release_current;
DXGI_FORMAT output_format =
is_hdr_ ? DXGI_FORMAT_R16G16B16A16_FLOAT : DXGI_FORMAT_B8G8R8A8_UNORM;
if (enable_dc_layers_ && !dcomp_surface_) {
TRACE_EVENT2("gpu", "DirectCompositionChildSurfaceWin::CreateSurface",
"width", size_.width(), "height", size_.height());
swap_chain_.Reset();
// Always treat as premultiplied, because an underlay could cause it to
// become transparent.
HRESULT hr = dcomp_device_->CreateSurface(
size_.width(), size_.height(), output_format,
DXGI_ALPHA_MODE_PREMULTIPLIED, &dcomp_surface_);
if (FAILED(hr)) {
DLOG(ERROR) << "CreateSurface failed with error " << std::hex << hr;
return false;
}
} else if (!enable_dc_layers_ && !swap_chain_) {
TRACE_EVENT2("gpu", "DirectCompositionChildSurfaceWin::CreateSwapChain",
"width", size_.width(), "height", size_.height());
dcomp_surface_.Reset();
DXGI_ALPHA_MODE alpha_mode =
has_alpha_ ? DXGI_ALPHA_MODE_PREMULTIPLIED : DXGI_ALPHA_MODE_IGNORE;
Microsoft::WRL::ComPtr<IDXGIDevice> dxgi_device;
d3d11_device_.As(&dxgi_device);
DCHECK(dxgi_device);
Microsoft::WRL::ComPtr<IDXGIAdapter> dxgi_adapter;
dxgi_device->GetAdapter(&dxgi_adapter);
DCHECK(dxgi_adapter);
Microsoft::WRL::ComPtr<IDXGIFactory2> dxgi_factory;
dxgi_adapter->GetParent(IID_PPV_ARGS(&dxgi_factory));
DCHECK(dxgi_factory);
DXGI_SWAP_CHAIN_DESC1 desc = {};
desc.Width = size_.width();
desc.Height = size_.height();
desc.Format = output_format;
desc.Stereo = FALSE;
desc.SampleDesc.Count = 1;
desc.BufferCount = 2;
desc.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT;
desc.Scaling = DXGI_SCALING_STRETCH;
desc.SwapEffect = DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL;
desc.AlphaMode = alpha_mode;
desc.Flags =
IsSwapChainTearingSupported() ? DXGI_SWAP_CHAIN_FLAG_ALLOW_TEARING : 0;
HRESULT hr = dxgi_factory->CreateSwapChainForComposition(
d3d11_device_.Get(), &desc, nullptr, &swap_chain_);
first_swap_ = true;
if (FAILED(hr)) {
DLOG(ERROR) << "CreateSwapChainForComposition failed with error "
<< std::hex << hr;
return false;
}
}
swap_rect_ = rectangle;
draw_offset_ = gfx::Vector2d();
if (dcomp_surface_) {
POINT update_offset;
const RECT rect = rectangle.ToRECT();
HRESULT hr = dcomp_surface_->BeginDraw(&rect, IID_PPV_ARGS(&draw_texture_),
&update_offset);
if (FAILED(hr)) {
DLOG(ERROR) << "BeginDraw failed with error " << std::hex << hr;
return false;
}
draw_offset_ = gfx::Point(update_offset) - rectangle.origin();
} else {
swap_chain_->GetBuffer(0, IID_PPV_ARGS(&draw_texture_));
}
DCHECK(draw_texture_);
g_current_surface = dcomp_surface_.Get();
EGLint pbuffer_attribs[] = {
EGL_WIDTH,
size_.width(),
EGL_HEIGHT,
size_.height(),
EGL_FLEXIBLE_SURFACE_COMPATIBILITY_SUPPORTED_ANGLE,
EGL_TRUE,
EGL_NONE,
};
EGLClientBuffer buffer =
reinterpret_cast<EGLClientBuffer>(draw_texture_.Get());
real_surface_ =
eglCreatePbufferFromClientBuffer(GetDisplay(), EGL_D3D_TEXTURE_ANGLE,
buffer, GetConfig(), pbuffer_attribs);
if (!real_surface_) {
DLOG(ERROR) << "eglCreatePbufferFromClientBuffer failed with error "
<< ui::GetLastEGLErrorString();
return false;
}
return true;
}
gfx::Vector2d DirectCompositionChildSurfaceWin::GetDrawOffset() const {
return draw_offset_;
}
void DirectCompositionChildSurfaceWin::SetVSyncEnabled(bool enabled) {
vsync_enabled_ = enabled;
}
bool DirectCompositionChildSurfaceWin::Resize(const gfx::Size& size,
float scale_factor,
ColorSpace color_space,
bool has_alpha) {
bool size_changed = size != size_;
bool is_hdr = color_space == ColorSpace::SCRGB_LINEAR;
bool hdr_changed = is_hdr != is_hdr_;
bool alpha_changed = has_alpha != has_alpha_;
if (!size_changed && !hdr_changed && !alpha_changed)
return true;
// This will release indirect references to swap chain (|real_surface_|) by
// binding |default_surface_| as the default framebuffer.
if (!ReleaseDrawTexture(true /* will_discard */))
return false;
size_ = size;
is_hdr_ = is_hdr;
has_alpha_ = has_alpha;
// ResizeBuffers can't change alpha blending mode.
if (swap_chain_ && !alpha_changed) {
DXGI_FORMAT format =
is_hdr_ ? DXGI_FORMAT_R16G16B16A16_FLOAT : DXGI_FORMAT_B8G8R8A8_UNORM;
UINT flags =
IsSwapChainTearingSupported() ? DXGI_SWAP_CHAIN_FLAG_ALLOW_TEARING : 0;
HRESULT hr = swap_chain_->ResizeBuffers(2 /* BufferCount */, size.width(),
size.height(), format, flags);
UMA_HISTOGRAM_BOOLEAN("GPU.DirectComposition.SwapChainResizeResult",
SUCCEEDED(hr));
if (SUCCEEDED(hr))
return true;
DLOG(ERROR) << "ResizeBuffers failed with error 0x" << std::hex << hr;
}
// Next SetDrawRectangle call will recreate the swap chain or surface.
swap_chain_.Reset();
dcomp_surface_.Reset();
return true;
}
bool DirectCompositionChildSurfaceWin::SetEnableDCLayers(bool enable) {
if (enable_dc_layers_ == enable)
return true;
enable_dc_layers_ = enable;
// Next SetDrawRectangle call will recreate the swap chain or surface.
if (!ReleaseDrawTexture(true /* will_discard */))
return false;
swap_chain_.Reset();
dcomp_surface_.Reset();
return true;
}
} // namespace gpu