Flutter Linux Embedder
fl_compositor_opengl.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #include "fl_compositor_opengl.h"
6 
7 #include <epoxy/egl.h>
8 #include <epoxy/gl.h>
9 
10 #include <cstring>
11 
12 #include "flutter/common/constants.h"
13 #include "flutter/shell/platform/embedder/embedder.h"
17 
19  GObject parent_instance;
20 
21  // TRUE if glBlitFramebuffer can be used to composite the first layer.
22  gboolean can_blit;
23 
24  // TRUE if fences can be used to synchronize frames with other contexts.
25  gboolean can_fence;
26 
27  // Flutter OpenGL contexts.
28  FlOpenGLManager* opengl_manager;
29 
30  // Shader program used to composite layers.
31  FlCompositorOpenGLShader* shader;
32 };
33 
34 G_DEFINE_TYPE(FlCompositorOpenGL, fl_compositor_opengl, G_TYPE_OBJECT)
35 
36 static void fl_compositor_opengl_dispose(GObject* object) {
37  FlCompositorOpenGL* self = FL_COMPOSITOR_OPENGL(object);
38 
39  g_clear_object(&self->shader);
40  g_clear_object(&self->opengl_manager);
41 
42  G_OBJECT_CLASS(fl_compositor_opengl_parent_class)->dispose(object);
43 }
44 
45 static void fl_compositor_opengl_class_init(FlCompositorOpenGLClass* klass) {
46  G_OBJECT_CLASS(klass)->dispose = fl_compositor_opengl_dispose;
47 }
48 
49 static void fl_compositor_opengl_init(FlCompositorOpenGL* self) {}
50 
51 FlCompositorOpenGL* fl_compositor_opengl_new(FlOpenGLManager* opengl_manager) {
52  FlCompositorOpenGL* self = FL_COMPOSITOR_OPENGL(
53  g_object_new(fl_compositor_opengl_get_type(), nullptr));
54 
55  self->opengl_manager = FL_OPENGL_MANAGER(g_object_ref(opengl_manager));
56  self->shader = fl_compositor_opengl_shader_new(opengl_manager);
57 
58  // Determine once whether glBlitFramebuffer is available on this driver.
59  fl_opengl_manager_make_current(opengl_manager);
60  self->can_blit = fl_opengl_manager_can_blit(opengl_manager);
61  self->can_fence = fl_opengl_manager_can_fence(opengl_manager);
62 
63  return self;
64 }
65 
66 static void composite_layer(FlCompositorOpenGL* self,
67  FlFramebuffer* framebuffer,
68  double x,
69  double y,
70  int width,
71  int height) {
72  double scale_x =
73  static_cast<double>(fl_framebuffer_get_width(framebuffer)) / width;
74  double scale_y =
75  static_cast<double>(fl_framebuffer_get_height(framebuffer)) / height;
77  (2 * x / width) + scale_x - 1.0,
78  1.0 - (2 * y / height) - scale_y);
79  fl_compositor_opengl_shader_set_scale(self->shader, scale_x, scale_y);
80 
81  GLuint texture_id = fl_framebuffer_get_texture_id(framebuffer);
82  glBindTexture(GL_TEXTURE_2D, texture_id);
83 
84  glDrawArrays(GL_TRIANGLES, 0, 6);
85 }
86 
87 void fl_compositor_opengl_composite_layers(FlCompositorOpenGL* self,
88  const FlutterLayer** layers,
89  size_t layers_count) {
90  // Save bindings that are set by this function. All bindings must be restored
91  // to their original values because Skia expects that its bindings have not
92  // been altered.
93  GLint saved_texture_binding;
94  glGetIntegerv(GL_TEXTURE_BINDING_2D, &saved_texture_binding);
95  GLint saved_vao_binding;
96  glGetIntegerv(GL_VERTEX_ARRAY_BINDING, &saved_vao_binding);
97  GLint saved_array_buffer_binding;
98  glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &saved_array_buffer_binding);
99  GLint saved_read_framebuffer_binding;
100  glGetIntegerv(GL_READ_FRAMEBUFFER_BINDING, &saved_read_framebuffer_binding);
101  GLint saved_current_program;
102  glGetIntegerv(GL_CURRENT_PROGRAM, &saved_current_program);
103  GLboolean saved_scissor_test = glIsEnabled(GL_SCISSOR_TEST);
104  GLboolean saved_blend = glIsEnabled(GL_BLEND);
105  GLint saved_src_rgb;
106  glGetIntegerv(GL_BLEND_SRC_RGB, &saved_src_rgb);
107  GLint saved_src_alpha;
108  glGetIntegerv(GL_BLEND_SRC_ALPHA, &saved_src_alpha);
109  GLint saved_dst_rgb;
110  glGetIntegerv(GL_BLEND_DST_RGB, &saved_dst_rgb);
111  GLint saved_dst_alpha;
112  glGetIntegerv(GL_BLEND_DST_ALPHA, &saved_dst_alpha);
113  GLfloat saved_clear_color[4] = {0.0, 0.0, 0.0, 0.0};
114  glGetFloatv(GL_COLOR_CLEAR_VALUE, saved_clear_color);
115 
116  size_t width = layers_count > 0 ? layers[0]->size.width : 0;
117  size_t height = layers_count > 0 ? layers[0]->size.height : 0;
118 
119  // FIXME(robert-ancell): The vertex array is the same for all views, but
120  // cannot be shared in OpenGL. Find a way to not generate this every time.
121  GLuint vao;
122  glGenVertexArrays(1, &vao);
123  glBindVertexArray(vao);
124 
125  glEnable(GL_BLEND);
126  glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
127 
128  fl_compositor_opengl_shader_use(self->shader);
129 
130  // Disable the scissor test as it can affect blit operations.
131  // Prevents regressions like: https://github.com/flutter/flutter/issues/140828
132  // See OpenGL specification version 4.6, section 18.3.1.
133  glDisable(GL_SCISSOR_TEST);
134 
135  glClearColor(0.0, 0.0, 0.0, 0.0);
136  glClear(GL_COLOR_BUFFER_BIT);
137 
138  gboolean first_layer = TRUE;
139  for (size_t i = 0; i < layers_count; ++i) {
140  const FlutterLayer* layer = layers[i];
141  switch (layer->type) {
142  case kFlutterLayerContentTypeBackingStore: {
143  const FlutterBackingStore* backing_store = layer->backing_store;
144  FlFramebuffer* layer_framebuffer =
145  FL_FRAMEBUFFER(backing_store->open_gl.framebuffer.user_data);
146  // The first layer can be blitted, and following layers composited with
147  // this. If glBlitFramebuffer is unavailable, composite the first layer
148  // with the shader instead.
149  if (first_layer && self->can_blit) {
150  glBindFramebuffer(GL_READ_FRAMEBUFFER,
151  fl_framebuffer_get_id(layer_framebuffer));
152  glBlitFramebuffer(layer->offset.x, layer->offset.y, layer->size.width,
153  layer->size.height, layer->offset.x,
154  layer->offset.y, layer->size.width,
155  layer->size.height, GL_COLOR_BUFFER_BIT,
156  GL_NEAREST);
157  } else {
158  composite_layer(self, layer_framebuffer, layer->offset.x,
159  layer->offset.y, width, height);
160  }
161  first_layer = FALSE;
162  } break;
163  case kFlutterLayerContentTypePlatformView: {
164  // TODO(robert-ancell) Not implemented -
165  // https://github.com/flutter/flutter/issues/41724
166  } break;
167  }
168  }
169  glFlush();
170 
171  glDeleteVertexArrays(1, &vao);
172 
173  if (saved_blend) {
174  glEnable(GL_BLEND);
175  } else {
176  glDisable(GL_BLEND);
177  }
178  if (saved_scissor_test) {
179  glEnable(GL_SCISSOR_TEST);
180  } else {
181  glDisable(GL_SCISSOR_TEST);
182  }
183 
184  glClearColor(saved_clear_color[0], saved_clear_color[1], saved_clear_color[2],
185  saved_clear_color[3]);
186  glBindTexture(GL_TEXTURE_2D, saved_texture_binding);
187  glBindVertexArray(saved_vao_binding);
188  glBindBuffer(GL_ARRAY_BUFFER, saved_array_buffer_binding);
189  glBindFramebuffer(GL_READ_FRAMEBUFFER, saved_read_framebuffer_binding);
190  glUseProgram(saved_current_program);
191  glBlendFuncSeparate(saved_src_rgb, saved_dst_rgb, saved_src_alpha,
192  saved_dst_alpha);
193 }
194 
196  FlCompositorOpenGL* self) {
197  g_return_val_if_fail(FL_IS_COMPOSITOR_OPENGL(self), nullptr);
198  return self->opengl_manager;
199 }
200 
201 gboolean fl_compositor_opengl_can_fence(FlCompositorOpenGL* self) {
202  g_return_val_if_fail(FL_IS_COMPOSITOR_OPENGL(self), FALSE);
203  return self->can_fence;
204 }
205 
207  size_t layers_count) {
208  // Every backing store in a frame is created by the same engine code from
209  // context-wide capabilities, so they all share a format and the first one
210  // describes the frame. Layers that aren't OpenGL framebuffer backing stores,
211  // e.g. platform views, don't have a format to match; fl_engine.cc only
212  // creates framebuffers, so there is nothing else to read a format from.
213  for (size_t i = 0; i < layers_count; i++) {
214  const FlutterLayer* layer = layers[i];
215  if (layer == nullptr ||
216  layer->type != kFlutterLayerContentTypeBackingStore ||
217  layer->backing_store == nullptr ||
218  layer->backing_store->type != kFlutterBackingStoreTypeOpenGL ||
219  layer->backing_store->open_gl.type !=
220  kFlutterOpenGLTargetTypeFramebuffer) {
221  continue;
222  }
223 
224  return layer->backing_store->open_gl.framebuffer.target == GL_BGRA8_EXT
225  ? GL_BGRA_EXT
226  : GL_RGBA;
227  }
228 
229  return GL_RGBA;
230 }
G_DEFINE_TYPE(FlBasicMessageChannelResponseHandle, fl_basic_message_channel_response_handle, G_TYPE_OBJECT) static void fl_basic_message_channel_response_handle_dispose(GObject *object)
static void fl_compositor_opengl_dispose(GObject *object)
void fl_compositor_opengl_composite_layers(FlCompositorOpenGL *self, const FlutterLayer **layers, size_t layers_count)
FlOpenGLManager * fl_compositor_opengl_get_opengl_manager(FlCompositorOpenGL *self)
static void fl_compositor_opengl_init(FlCompositorOpenGL *self)
static void fl_compositor_opengl_class_init(FlCompositorOpenGLClass *klass)
static void composite_layer(FlCompositorOpenGL *self, FlFramebuffer *framebuffer, double x, double y, int width, int height)
FlCompositorOpenGL * fl_compositor_opengl_new(FlOpenGLManager *opengl_manager)
GLint fl_compositor_opengl_get_frame_format(const FlutterLayer **layers, size_t layers_count)
gboolean fl_compositor_opengl_can_fence(FlCompositorOpenGL *self)
void fl_compositor_opengl_shader_set_offset(FlCompositorOpenGLShader *self, double x, double y)
FlCompositorOpenGLShader * fl_compositor_opengl_shader_new(FlOpenGLManager *opengl_manager)
void fl_compositor_opengl_shader_set_scale(FlCompositorOpenGLShader *self, double x, double y)
void fl_compositor_opengl_shader_use(FlCompositorOpenGLShader *self)
size_t fl_framebuffer_get_height(FlFramebuffer *self)
GLuint fl_framebuffer_get_id(FlFramebuffer *self)
size_t fl_framebuffer_get_width(FlFramebuffer *self)
GLuint fl_framebuffer_get_texture_id(FlFramebuffer *self)
gboolean fl_opengl_manager_can_blit(FlOpenGLManager *self)
gboolean fl_opengl_manager_make_current(FlOpenGLManager *self)
gboolean fl_opengl_manager_can_fence(FlOpenGLManager *self)
const uint8_t uint32_t uint32_t * height
const uint8_t uint32_t * width
const FlutterLayer size_t layers_count
const FlutterLayer ** layers
FlCompositorOpenGLShader * shader
FlOpenGLManager * opengl_manager
int64_t texture_id