compositor_opengl.cc

Go to the documentation of this file.

// Copyright 2013 The Flutter 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 "flutter/shell/platform/windows/compositor_opengl.h"
 
#include "GLES3/gl3.h"
#include "flutter/fml/logging.h"
#include "flutter/shell/platform/windows/flutter_windows_engine.h"
#include "flutter/shell/platform/windows/flutter_windows_view.h"
 
namespace flutter {
 
namespace {
 
constexpr uint32_t kWindowFrameBufferId = 0;
 
// The metadata for an OpenGL framebuffer backing store.
struct FramebufferBackingStore {
  uint32_t framebuffer_id = 0;
  uint32_t texture_id = 0;
  uint32_t color_renderbuffer_id = 0;
  uint32_t depth_stencil_id = 0;
};
 
typedef const impeller::GLProc<decltype(glBlitFramebuffer)> BlitFramebufferProc;
 
const BlitFramebufferProc& GetBlitFramebufferProc(
    const impeller::ProcTableGLES& gl) {
  if (gl.BlitFramebuffer.IsAvailable()) {
    return gl.BlitFramebuffer;
  } else if (gl.BlitFramebufferANGLE.IsAvailable()) {
    return gl.BlitFramebufferANGLE;
  }
 
  // CompositorOpenGL::Initialize verifies that a blit procedure is available.
  FML_UNREACHABLE();
}
 
}  // namespace
 
CompositorOpenGL::CompositorOpenGL(FlutterWindowsEngine* engine,
                                   impeller::ProcTableGLES::Resolver resolver,
                                   bool enable_impeller)
    : engine_(engine), resolver_(resolver), enable_impeller_(enable_impeller) {}
 
bool CompositorOpenGL::CreateBackingStore(
    const FlutterBackingStoreConfig& config,
    FlutterBackingStore* result) {
  if (!is_initialized_ && !Initialize()) {
    return false;
  }
 
  auto store = std::make_unique<FramebufferBackingStore>();
 
  gl_->GenFramebuffers(1, &store->framebuffer_id);
  gl_->BindFramebuffer(GL_FRAMEBUFFER, store->framebuffer_id);
 
  if (enable_impeller_) {
    if (supports_implicit_msaa_) {
      gl_->GenTextures(1, &store->texture_id);
      gl_->BindTexture(GL_TEXTURE_2D, store->texture_id);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
      gl_->TexImage2D(GL_TEXTURE_2D, 0, format_.sized_format, config.size.width,
                      config.size.height, 0, format_.general_format,
                      GL_UNSIGNED_BYTE, nullptr);
      gl_->BindTexture(GL_TEXTURE_2D, 0);
 
      // MSAA color attachment
      gl_->FramebufferTexture2DMultisampleEXT(
          GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D,
          store->texture_id, 0, 4);
 
      // Impeller always requires depth/stencil attachment.
      gl_->GenRenderbuffers(1, &store->depth_stencil_id);
      gl_->BindRenderbuffer(GL_RENDERBUFFER, store->depth_stencil_id);
      gl_->RenderbufferStorageMultisampleEXT(
          GL_RENDERBUFFER, 4, GL_DEPTH24_STENCIL8, config.size.width,
          config.size.height);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_ATTACHMENT,
                                   GL_RENDERBUFFER, store->depth_stencil_id);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT,
                                   GL_RENDERBUFFER, store->depth_stencil_id);
    } else if (supports_offscreen_msaa_) {
      // MSAA color renderbuffer attachment
      gl_->GenRenderbuffers(1, &store->color_renderbuffer_id);
      gl_->BindRenderbuffer(GL_RENDERBUFFER, store->color_renderbuffer_id);
      gl_->RenderbufferStorageMultisample(
          GL_RENDERBUFFER, 4, format_.sized_format, config.size.width,
          config.size.height);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
                                   GL_RENDERBUFFER,
                                   store->color_renderbuffer_id);
 
      // MSAA depth/stencil attachment
      gl_->GenRenderbuffers(1, &store->depth_stencil_id);
      gl_->BindRenderbuffer(GL_RENDERBUFFER, store->depth_stencil_id);
      gl_->RenderbufferStorageMultisample(
          GL_RENDERBUFFER, 4, GL_DEPTH24_STENCIL8, config.size.width,
          config.size.height);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_ATTACHMENT,
                                   GL_RENDERBUFFER, store->depth_stencil_id);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT,
                                   GL_RENDERBUFFER, store->depth_stencil_id);
    } else {
      gl_->GenTextures(1, &store->texture_id);
      gl_->BindTexture(GL_TEXTURE_2D, store->texture_id);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
      gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
      gl_->TexImage2D(GL_TEXTURE_2D, 0, format_.sized_format, config.size.width,
                      config.size.height, 0, format_.general_format,
                      GL_UNSIGNED_BYTE, nullptr);
      gl_->BindTexture(GL_TEXTURE_2D, 0);
 
      gl_->FramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
                                GL_TEXTURE_2D, store->texture_id, 0);
 
      gl_->GenRenderbuffers(1, &store->depth_stencil_id);
      gl_->BindRenderbuffer(GL_RENDERBUFFER, store->depth_stencil_id);
      gl_->RenderbufferStorage(GL_RENDERBUFFER, GL_DEPTH24_STENCIL8,
                               config.size.width, config.size.height);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_ATTACHMENT,
                                   GL_RENDERBUFFER, store->depth_stencil_id);
      gl_->FramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT,
                                   GL_RENDERBUFFER, store->depth_stencil_id);
    }
  } else {
    gl_->GenTextures(1, &store->texture_id);
    gl_->BindTexture(GL_TEXTURE_2D, store->texture_id);
    gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
    gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
    gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
    gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
    gl_->TexImage2D(GL_TEXTURE_2D, 0, format_.sized_format, config.size.width,
                    config.size.height, 0, format_.general_format,
                    GL_UNSIGNED_BYTE, nullptr);
    gl_->BindTexture(GL_TEXTURE_2D, 0);
 
    gl_->FramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
                              GL_TEXTURE_2D, store->texture_id, 0);
  }
 
  result->type = kFlutterBackingStoreTypeOpenGL;
  result->open_gl.type = kFlutterOpenGLTargetTypeFramebuffer;
  result->open_gl.framebuffer.name = store->framebuffer_id;
  result->open_gl.framebuffer.target = format_.sized_format;
  result->open_gl.framebuffer.user_data = store.release();
  result->open_gl.framebuffer.destruction_callback = [](void* user_data) {
    // Backing store destroyed in `CompositorOpenGL::CollectBackingStore`, set
    // on FlutterCompositor.collect_backing_store_callback during engine start.
  };
  return true;
}
 
bool CompositorOpenGL::CollectBackingStore(const FlutterBackingStore* store) {
  FML_DCHECK(is_initialized_);
  FML_DCHECK(store->type == kFlutterBackingStoreTypeOpenGL);
  FML_DCHECK(store->open_gl.type == kFlutterOpenGLTargetTypeFramebuffer);
 
  auto user_data = static_cast<FramebufferBackingStore*>(
      store->open_gl.framebuffer.user_data);
 
  gl_->DeleteFramebuffers(1, &user_data->framebuffer_id);
  if (user_data->texture_id != 0) {
    gl_->DeleteTextures(1, &user_data->texture_id);
  }
  if (user_data->color_renderbuffer_id != 0) {
    gl_->DeleteRenderbuffers(1, &user_data->color_renderbuffer_id);
  }
  if (user_data->depth_stencil_id != 0) {
    gl_->DeleteRenderbuffers(1, &user_data->depth_stencil_id);
  }
 
  delete user_data;
  return true;
}
 
bool CompositorOpenGL::Present(FlutterWindowsView* view,
                               const FlutterLayer** layers,
                               size_t layers_count) {
  FML_DCHECK(view != nullptr);
 
  // Clear the view if there are no layers to present.
  if (layers_count == 0) {
    // Normally the compositor is initialized when the first backing store is
    // created. However, on an empty frame no backing stores are created and
    // the present needs to initialize the compositor.
    if (!is_initialized_ && !Initialize()) {
      return false;
    }
 
    return Clear(view);
  }
 
  // TODO: Support compositing layers and platform views.
  // See: https://github.com/flutter/flutter/issues/31713
  FML_DCHECK(is_initialized_);
  FML_DCHECK(layers_count == 1);
  FML_DCHECK(layers[0]->offset.x == 0 && layers[0]->offset.y == 0);
  FML_DCHECK(layers[0]->type == kFlutterLayerContentTypeBackingStore);
  FML_DCHECK(layers[0]->backing_store->type == kFlutterBackingStoreTypeOpenGL);
  FML_DCHECK(layers[0]->backing_store->open_gl.type ==
             kFlutterOpenGLTargetTypeFramebuffer);
 
  auto width = layers[0]->size.width;
  auto height = layers[0]->size.height;
 
  // Check if this frame can be presented. This resizes the surface if a resize
  // is pending and |width| and |height| match the target size.
  if (!view->OnFrameGenerated(width, height)) {
    return false;
  }
 
  // |OnFrameGenerated| should return false if the surface isn't valid.
  FML_DCHECK(view->surface() != nullptr);
  FML_DCHECK(view->surface()->IsValid());
 
  egl::WindowSurface* surface = view->surface();
  if (!surface->MakeCurrent()) {
    return false;
  }
 
  auto source_id = layers[0]->backing_store->open_gl.framebuffer.name;
 
  // Disable the scissor test as it can affect blit operations.
  // Prevents regressions like: https://github.com/flutter/flutter/issues/140828
  // See OpenGL specification version 4.6, section 18.3.1.
  gl_->Disable(GL_SCISSOR_TEST);
  gl_->BindFramebuffer(GL_READ_FRAMEBUFFER, source_id);
  gl_->BindFramebuffer(GL_DRAW_FRAMEBUFFER, kWindowFrameBufferId);
 
  auto blitFramebuffer = GetBlitFramebufferProc(*gl_);
  blitFramebuffer(0,                    // srcX0
                  0,                    // srcY0
                  width,                // srcX1
                  height,               // srcY1
                  0,                    // dstX0
                  0,                    // dstY0
                  width,                // dstX1
                  height,               // dstY1
                  GL_COLOR_BUFFER_BIT,  // mask
                  GL_NEAREST            // filter
  );
 
  if (!surface->SwapBuffers()) {
    return false;
  }
 
  view->OnFramePresented();
  return true;
}
 
bool CompositorOpenGL::Initialize() {
  FML_DCHECK(!is_initialized_);
 
  egl::Manager* manager = engine_->egl_manager();
  if (!manager) {
    return false;
  }
 
  if (!manager->render_context()->MakeCurrent()) {
    return false;
  }
 
  gl_ = std::make_unique<impeller::ProcTableGLES>(resolver_);
  if (!gl_->IsValid()) {
    gl_.reset();
    return false;
  }
 
  if (gl_->GetDescription()->HasExtension("GL_EXT_texture_format_BGRA8888")) {
    format_.sized_format = GL_BGRA8_EXT;
    format_.general_format = GL_BGRA_EXT;
  } else {
    format_.sized_format = GL_RGBA8;
    format_.general_format = GL_RGBA;
  }
 
  if (!gl_->BlitFramebuffer.IsAvailable() &&
      !gl_->BlitFramebufferANGLE.IsAvailable()) {
    FML_LOG(ERROR) << "Unable to find OpenGL blit framebuffer procedure.";
    return false;
  }
 
  supports_implicit_msaa_ =
      gl_->GetCapabilities()->SupportsImplicitResolvingMSAA();
  supports_offscreen_msaa_ = gl_->GetCapabilities()->SupportsOffscreenMSAA();
 
  if (enable_impeller_ && !supports_implicit_msaa_ &&
      !supports_offscreen_msaa_) {
    // TODO(190362): I suspect this branch is never taken since ANGLE will
    // support offscreen MSAA. We should investigate removing this branch and
    // the implicit MSAA branch in the rendering functions.
    FML_LOG(WARNING) << "Rendering without MSAA.";
  }
 
  is_initialized_ = true;
  return true;
}
 
bool CompositorOpenGL::Clear(FlutterWindowsView* view) {
  FML_DCHECK(is_initialized_);
 
  // Check if this frame can be presented. This resizes the surface if needed.
  if (!view->OnEmptyFrameGenerated()) {
    return false;
  }
 
  // |OnEmptyFrameGenerated| should return false if the surface isn't valid.
  FML_DCHECK(view->surface() != nullptr);
  FML_DCHECK(view->surface()->IsValid());
 
  egl::WindowSurface* surface = view->surface();
  if (!surface->MakeCurrent()) {
    return false;
  }
 
  gl_->ClearColor(0.0f, 0.0f, 0.0f, 0.0f);
  gl_->Clear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
 
  if (!surface->SwapBuffers()) {
    return false;
  }
 
  view->OnFramePresented();
  return true;
}
 
}  // namespace flutter