Windows: Add Direct3D texture interopability support

Author: jnschulze

ci/licenses_golden/licenses_flutter

@@ -1578,8 +1578,12 @@ FILE: ../../../flutter/shell/platform/windows/display_helper_winuwp.h
 FILE: ../../../flutter/shell/platform/windows/dpi_utils_win32.cc
 FILE: ../../../flutter/shell/platform/windows/dpi_utils_win32.h
 FILE: ../../../flutter/shell/platform/windows/dpi_utils_win32_unittests.cc
-FILE: ../../../flutter/shell/platform/windows/external_texture_gl.cc
-FILE: ../../../flutter/shell/platform/windows/external_texture_gl.h
+FILE: ../../../flutter/shell/platform/windows/external_texture.cc
+FILE: ../../../flutter/shell/platform/windows/external_texture.h
+FILE: ../../../flutter/shell/platform/windows/external_texture_d3d.cc
+FILE: ../../../flutter/shell/platform/windows/external_texture_d3d.h
+FILE: ../../../flutter/shell/platform/windows/external_texture_pixelbuffer.cc
+FILE: ../../../flutter/shell/platform/windows/external_texture_pixelbuffer.h
 FILE: ../../../flutter/shell/platform/windows/flutter_key_map.cc
 FILE: ../../../flutter/shell/platform/windows/flutter_project_bundle.cc
 FILE: ../../../flutter/shell/platform/windows/flutter_project_bundle.h

shell/platform/common/client_wrapper/core_implementations.cc

@@ -174,6 +174,20 @@ int64_t TextureRegistrarImpl::RegisterTexture(TextureVariant* texture) {
     return texture_id;
   }
 
+  if (auto gpu_surface_texture = std::get_if<GpuSurfaceTexture>(texture)) {
+    FlutterDesktopTextureInfo info = {};
+    info.type = kFlutterDesktopGpuSurfaceTexture;
+    auto& desc = info.gpu_surface_descriptor;
+    desc.handle = gpu_surface_texture->handle();
+    desc.width = gpu_surface_texture->width();
+    desc.height = gpu_surface_texture->height();
+    desc.format = gpu_surface_texture->format();
+
+    int64_t texture_id = FlutterDesktopTextureRegistrarRegisterExternalTexture(
+        texture_registrar_ref_, &info);
+    return texture_id;
+  }
+
   std::cerr << "Attempting to register unknown texture variant." << std::endl;
   return -1;
 }  // namespace flutter

shell/platform/common/client_wrapper/include/flutter/texture_registrar.h

@@ -42,10 +42,29 @@ class PixelBufferTexture {
   const CopyBufferCallback copy_buffer_callback_;
 };
 
+class GpuSurfaceTexture {
+ public:
+  GpuSurfaceTexture(
+      void* handle,
+      size_t width,
+      size_t height,
+      FlutterDesktopPixelFormat format = kFlutterDesktopPixelFormatNone)
+      : handle_(handle), width_(width), height_(height), format_(format) {}
+
+  constexpr size_t width() const { return width_; }
+  constexpr size_t height() const { return height_; }
+  constexpr void* handle() const { return handle_; }
+  constexpr FlutterDesktopPixelFormat format() const { return format_; }
+
+ private:
+  const size_t width_;
+  const size_t height_;
+  void* const handle_;
+  const FlutterDesktopPixelFormat format_;
+};
+
 // The available texture variants.
-// Only PixelBufferTexture is currently implemented.
-// Other variants are expected to be added in the future.
-typedef std::variant<PixelBufferTexture> TextureVariant;
+typedef std::variant<PixelBufferTexture, GpuSurfaceTexture> TextureVariant;
 
 // An object keeping track of external textures.
 //

shell/platform/common/public/flutter_texture_registrar.h

@@ -22,10 +22,24 @@ typedef struct FlutterDesktopTextureRegistrar*
 // Possible values for the type specified in FlutterDesktopTextureInfo.
 // Additional types may be added in the future.
 typedef enum {
-  // A Pixel buffer-based texture.
-  kFlutterDesktopPixelBufferTexture
+  // A generic pixel buffer-based texture.
+  kFlutterDesktopPixelBufferTexture,
+  // A platform-specific GPU surface-backed texture.
+  kFlutterDesktopGpuSurfaceTexture
 } FlutterDesktopTextureType;
 
+// Supported pixel formats.
+typedef enum {
+  // Uninitialized.
+  kFlutterDesktopPixelFormatNone,
+  // Represents a 32-bit RGBA color format with 8 bits each for red, green, blue
+  // and alpha.
+  kFlutterDesktopPixelFormatRGBA8888,
+  // Represents a 32-bit BGRA color format with 8 bits each for blue, green, red
+  // and alpha.
+  kFlutterDesktopPixelFormatBGRA8888
+} FlutterDesktopPixelFormat;
+
 // An image buffer object.
 typedef struct {
   // The pixel data buffer.
@@ -36,6 +50,19 @@ typedef struct {
   size_t height;
 } FlutterDesktopPixelBuffer;
 
+// A GPU surface descriptor.
+typedef struct {
+  // The surface handle.
+  // For DirectX textures, this is the shared handle of an IDXGIResource.
+  void* handle;
+  // The width of the surface.
+  size_t width;
+  // The height of the surface.
+  size_t height;
+  // The pixel format which might by optional depending on the surface type.
+  FlutterDesktopPixelFormat format;
+} FlutterDesktopGpuSurfaceDescriptor;
+
 // The pixel buffer copy callback definition provided to
 // the Flutter engine to copy the texture.
 // It is invoked with the intended surface size specified by |width| and
@@ -62,6 +89,7 @@ typedef struct {
   FlutterDesktopTextureType type;
   union {
     FlutterDesktopPixelBufferTextureConfig pixel_buffer_config;
+    FlutterDesktopGpuSurfaceDescriptor gpu_surface_descriptor;
   };
 } FlutterDesktopTextureInfo;
 

shell/platform/windows/BUILD.gn

@@ -53,8 +53,12 @@ source_set("flutter_windows_source") {
     "angle_surface_manager.h",
     "cursor_handler.cc",
     "cursor_handler.h",
-    "external_texture_gl.cc",
-    "external_texture_gl.h",
+    "external_texture.cc",
+    "external_texture.h",
+    "external_texture_d3d.cc",
+    "external_texture_d3d.h",
+    "external_texture_pixelbuffer.cc",
+    "external_texture_pixelbuffer.h",
     "flutter_key_map.cc",
     "flutter_project_bundle.cc",
     "flutter_project_bundle.h",

shell/platform/windows/angle_surface_manager.h

@@ -69,6 +69,10 @@ class AngleSurfaceManager {
   // not null.
   EGLBoolean SwapBuffers();
 
+  EGLDisplay egl_display() const { return egl_display_; };
+
+  EGLConfig egl_config() const { return egl_config_; }
+
  private:
   bool Initialize();
   void CleanUp();

shell/platform/windows/external_texture.cc

@@ -0,0 +1,33 @@
+// 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/external_texture.h"
+
+namespace flutter {
+
+const GlProcs& ResolveGlFunctions() {
+  static struct GlProcs procs = {};
+  static bool initialized = false;
+
+  if (!initialized) {
+    procs.glGenTextures =
+        reinterpret_cast<glGenTexturesProc>(eglGetProcAddress("glGenTextures"));
+    procs.glDeleteTextures = reinterpret_cast<glDeleteTexturesProc>(
+        eglGetProcAddress("glDeleteTextures"));
+    procs.glBindTexture =
+        reinterpret_cast<glBindTextureProc>(eglGetProcAddress("glBindTexture"));
+    procs.glTexParameteri = reinterpret_cast<glTexParameteriProc>(
+        eglGetProcAddress("glTexParameteri"));
+    procs.glTexImage2D =
+        reinterpret_cast<glTexImage2DProc>(eglGetProcAddress("glTexImage2D"));
+
+    procs.valid = procs.glGenTextures && procs.glDeleteTextures &&
+                  procs.glBindTexture && procs.glTexParameteri &&
+                  procs.glTexImage2D;
+    initialized = true;
+  }
+  return procs;
+}
+
+}  // namespace flutter

shell/platform/windows/external_texture.h

@@ -0,0 +1,61 @@
+// 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.
+
+#ifndef FLUTTER_SHELL_PLATFORM_WINDOWS_EXTERNAL_TEXTURE_H_
+#define FLUTTER_SHELL_PLATFORM_WINDOWS_EXTERNAL_TEXTURE_H_
+
+#include "flutter/shell/platform/embedder/embedder.h"
+
+#include <EGL/egl.h>
+#include <EGL/eglext.h>
+#include <GLES2/gl2.h>
+#include <GLES2/gl2ext.h>
+
+namespace flutter {
+
+typedef void (*glGenTexturesProc)(GLsizei n, GLuint* textures);
+typedef void (*glDeleteTexturesProc)(GLsizei n, const GLuint* textures);
+typedef void (*glBindTextureProc)(GLenum target, GLuint texture);
+typedef void (*glTexParameteriProc)(GLenum target, GLenum pname, GLint param);
+typedef void (*glTexImage2DProc)(GLenum target,
+                                 GLint level,
+                                 GLint internalformat,
+                                 GLsizei width,
+                                 GLsizei height,
+                                 GLint border,
+                                 GLenum format,
+                                 GLenum type,
+                                 const void* data);
+
+// A struct containing pointers to resolved gl* functions.
+struct GlProcs {
+  glGenTexturesProc glGenTextures;
+  glDeleteTexturesProc glDeleteTextures;
+  glBindTextureProc glBindTexture;
+  glTexParameteriProc glTexParameteri;
+  glTexImage2DProc glTexImage2D;
+  bool valid;
+};
+
+const GlProcs& ResolveGlFunctions();
+
+// Abstract external texture.
+class ExternalTexture {
+ public:
+  virtual ~ExternalTexture() = default;
+
+  // Returns the unique id of this texture.
+  int64_t texture_id() const { return reinterpret_cast<int64_t>(this); };
+
+  // Attempts to populate the specified |opengl_texture| with texture details
+  // such as the name, width, height and the pixel format.
+  // Returns true on success.
+  virtual bool PopulateTexture(size_t width,
+                               size_t height,
+                               FlutterOpenGLTexture* opengl_texture) = 0;
+};
+
+}  // namespace flutter
+
+#endif  // FLUTTER_SHELL_PLATFORM_WINDOWS_EXTERNAL_TEXTURE_H_

shell/platform/windows/external_texture_d3d.cc

@@ -0,0 +1,94 @@
+// 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/external_texture_d3d.h"
+
+namespace flutter {
+
+std::unique_ptr<ExternalTextureD3D>
+ExternalTextureD3D::MakeFromSurfaceDescriptor(
+    const FlutterDesktopGpuSurfaceDescriptor* descriptor,
+    AngleSurfaceManager* surface_manager) {
+  EGLSurface surface = EGL_NO_SURFACE;
+  EGLint attributes[] = {EGL_WIDTH,
+                         static_cast<EGLint>(descriptor->width),
+                         EGL_HEIGHT,
+                         static_cast<EGLint>(descriptor->height),
+                         EGL_TEXTURE_TARGET,
+                         EGL_TEXTURE_2D,
+                         EGL_TEXTURE_FORMAT,
+                         EGL_TEXTURE_RGBA,  // always EGL_TEXTURE_RGBA
+                         EGL_NONE};
+
+  surface = eglCreatePbufferFromClientBuffer(
+      surface_manager->egl_display(), EGL_D3D_TEXTURE_2D_SHARE_HANDLE_ANGLE,
+      descriptor->handle, surface_manager->egl_config(), attributes);
+
+  if (surface == EGL_NO_SURFACE) {
+    return {};
+  }
+
+  return std::unique_ptr<ExternalTextureD3D>(
+      new ExternalTextureD3D(surface_manager->egl_display(), surface,
+                             descriptor->width, descriptor->height));
+}
+
+ExternalTextureD3D::ExternalTextureD3D(EGLDisplay egl_display,
+                                       EGLSurface surface,
+                                       size_t width,
+                                       size_t height)
+    : egl_surface_(surface),
+      width_(width),
+      height_(height),
+      egl_display_(egl_display) {}
+
+ExternalTextureD3D::~ExternalTextureD3D() {
+  if (egl_surface_) {
+    eglDestroySurface(egl_display_, egl_surface_);
+  }
+
+  const auto& gl = ResolveGlFunctions();
+  if (gl.valid && gl_texture_ != 0) {
+    gl.glDeleteTextures(1, &gl_texture_);
+  }
+}
+
+bool ExternalTextureD3D::PopulateTexture(size_t width,
+                                         size_t height,
+                                         FlutterOpenGLTexture* opengl_texture) {
+  const auto& gl = ResolveGlFunctions();
+
+  if (gl_texture_ == 0) {
+    gl.glGenTextures(1, &gl_texture_);
+
+    gl.glBindTexture(GL_TEXTURE_2D, gl_texture_);
+
+    gl.glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_BORDER);
+    gl.glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_BORDER);
+
+    gl.glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
+    gl.glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
+
+    if (eglBindTexImage(egl_display_, egl_surface_, EGL_BACK_BUFFER) !=
+        EGL_TRUE) {
+      gl.glDeleteTextures(1, &gl_texture_);
+      gl_texture_ = 0;
+      return false;
+    }
+  } else {
+    gl.glBindTexture(GL_TEXTURE_2D, gl_texture_);
+  }
+
+  opengl_texture->target = GL_TEXTURE_2D;
+  opengl_texture->name = gl_texture_;
+  opengl_texture->format = GL_RGBA8;
+  opengl_texture->destruction_callback = nullptr;
+  opengl_texture->user_data = nullptr;
+  opengl_texture->width = width_;
+  opengl_texture->height = height_;
+
+  return true;
+}
+
+}  // namespace flutter

shell/platform/windows/external_texture_d3d.h

@@ -0,0 +1,47 @@
+// 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.
+
+#ifndef FLUTTER_SHELL_PLATFORM_WINDOWS_EXTERNAL_TEXTURE_D3D_H_
+#define FLUTTER_SHELL_PLATFORM_WINDOWS_EXTERNAL_TEXTURE_D3D_H_
+
+#include <stdint.h>
+
+#include <memory>
+
+#include "flutter/shell/platform/common/public/flutter_texture_registrar.h"
+#include "flutter/shell/platform/windows/angle_surface_manager.h"
+#include "flutter/shell/platform/windows/external_texture.h"
+
+namespace flutter {
+
+// An external texture that is backed by a DXGI surface.
+class ExternalTextureD3D : public ExternalTexture {
+ public:
+  // Creates a texture using the provided FlutterDesktopGpuSurfaceDescriptor.
+  static std::unique_ptr<ExternalTextureD3D> MakeFromSurfaceDescriptor(
+      const FlutterDesktopGpuSurfaceDescriptor* descriptor,
+      AngleSurfaceManager* surface_manager);
+
+  bool PopulateTexture(size_t width,
+                       size_t height,
+                       FlutterOpenGLTexture* opengl_texture) override;
+
+  virtual ~ExternalTextureD3D();
+
+ private:
+  EGLDisplay egl_display_;
+  EGLSurface egl_surface_;
+  GLuint gl_texture_ = 0;
+  size_t width_;
+  size_t height_;
+
+  ExternalTextureD3D(EGLDisplay egl_display,
+                     EGLSurface egl_surface,
+                     size_t width,
+                     size_t height);
+};
+
+}  // namespace flutter
+
+#endif  // FLUTTER_SHELL_PLATFORM_WINDOWS_EXTERNAL_TEXTURE_D3D_H_