Reland: [macOS] Use CVDisplayLink to drive repaint

ci/licenses_golden/licenses_flutter

@@ -36592,6 +36592,7 @@ ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterCom
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterCompositor.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDartProject.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDartProject_Internal.h + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDisplayLinkTest.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderExternalTextureTest.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.mm + ../../../flutter/LICENSE
@@ -36641,7 +36642,10 @@ ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterTex
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizer.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizer.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizerTest.mm + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterTimeConverter.h + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterTimeConverter.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterUmbrellaImportTests.m + ../../../flutter/LICENSE
+ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterVSyncWaiterTest.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterView.h + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterView.mm + ../../../flutter/LICENSE
 ORIGIN: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterViewController.mm + ../../../flutter/LICENSE
@@ -39457,6 +39461,9 @@ FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterCompo
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterCompositor.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDartProject.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDartProject_Internal.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDisplayLink.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDisplayLink.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterDisplayLinkTest.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderExternalTextureTest.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.mm
@@ -39506,7 +39513,12 @@ FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterTextu
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizer.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizer.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterThreadSynchronizerTest.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterTimeConverter.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterTimeConverter.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterUmbrellaImportTests.m
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterVSyncWaiter.h
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterVSyncWaiter.mm
+FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterVSyncWaiterTest.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterView.h
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterView.mm
 FILE: ../../../flutter/shell/platform/darwin/macos/framework/Source/FlutterViewController.mm

shell/platform/darwin/macos/BUILD.gn

@@ -66,6 +66,8 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterCompositor.mm",
     "framework/Source/FlutterDartProject.mm",
     "framework/Source/FlutterDartProject_Internal.h",
+    "framework/Source/FlutterDisplayLink.h",
+    "framework/Source/FlutterDisplayLink.mm",
     "framework/Source/FlutterEmbedderKeyResponder.h",
     "framework/Source/FlutterEmbedderKeyResponder.mm",
     "framework/Source/FlutterEngine.mm",
@@ -101,6 +103,10 @@ source_set("flutter_framework_source") {
     "framework/Source/FlutterTextureRegistrar.mm",
     "framework/Source/FlutterThreadSynchronizer.h",
     "framework/Source/FlutterThreadSynchronizer.mm",
+    "framework/Source/FlutterTimeConverter.h",
+    "framework/Source/FlutterTimeConverter.mm",
+    "framework/Source/FlutterVSyncWaiter.h",
+    "framework/Source/FlutterVSyncWaiter.mm",
     "framework/Source/FlutterView.h",
     "framework/Source/FlutterView.mm",
     "framework/Source/FlutterViewController.mm",
@@ -173,6 +179,7 @@ executable("flutter_desktop_darwin_unittests") {
     "framework/Source/FlutterAppDelegateTest.mm",
     "framework/Source/FlutterAppLifecycleDelegateTest.mm",
     "framework/Source/FlutterChannelKeyResponderTest.mm",
+    "framework/Source/FlutterDisplayLinkTest.mm",
     "framework/Source/FlutterEmbedderExternalTextureTest.mm",
     "framework/Source/FlutterEmbedderKeyResponderTest.mm",
     "framework/Source/FlutterEngineTest.mm",
@@ -187,6 +194,7 @@ executable("flutter_desktop_darwin_unittests") {
     "framework/Source/FlutterTextInputPluginTest.mm",
     "framework/Source/FlutterTextInputSemanticsObjectTest.mm",
     "framework/Source/FlutterThreadSynchronizerTest.mm",
+    "framework/Source/FlutterVSyncWaiterTest.mm",
     "framework/Source/FlutterViewControllerTest.mm",
     "framework/Source/FlutterViewControllerTestUtils.h",
     "framework/Source/FlutterViewControllerTestUtils.mm",

shell/platform/darwin/macos/framework/Source/FlutterCompositor.h

@@ -10,13 +10,18 @@
 
 #include "flutter/fml/macros.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController.h"
+#import "flutter/shell/platform/darwin/macos/framework/Source/FlutterTimeConverter.h"
 #import "flutter/shell/platform/darwin/macos/framework/Source/FlutterViewProvider.h"
 #include "flutter/shell/platform/embedder/embedder.h"
 
 @class FlutterMutatorView;
 
 namespace flutter {
 
+class PlatformViewLayer;
+
+typedef std::pair<PlatformViewLayer, size_t> PlatformViewLayerWithIndex;
+
 // FlutterCompositor creates and manages the backing stores used for
 // rendering Flutter content and presents Flutter content and Platform views.
 // Platform views are not yet supported.
@@ -30,6 +35,7 @@ class FlutterCompositor {
   // which are used for presenting and creating backing stores.
   // It must not be null, and is typically FlutterViewEngineProvider.
   explicit FlutterCompositor(id<FlutterViewProvider> view_provider,
+                             FlutterTimeConverter* time_converter,
                              FlutterPlatformViewController* platform_views_controller);
 
   ~FlutterCompositor() = default;
@@ -55,19 +61,21 @@ class FlutterCompositor {
 
  private:
   void PresentPlatformViews(FlutterView* default_base_view,
-                            const FlutterLayer** layers,
-                            size_t layers_count);
+                            const std::vector<PlatformViewLayerWithIndex>& platform_views_layers);
 
   // Presents the platform view layer represented by `layer`. `layer_index` is
   // used to position the layer in the z-axis. If the layer does not have a
   // superview, it will become subview of `default_base_view`.
   FlutterMutatorView* PresentPlatformView(FlutterView* default_base_view,
-                                          const FlutterLayer* layer,
-                                          size_t layer_position);
+                                          const PlatformViewLayer& layer,
+                                          size_t index);
 
   // Where the compositor can query FlutterViews. Must not be null.
   id<FlutterViewProvider> const view_provider_;
 
+  // Converts between engine time and core animation media time.
+  FlutterTimeConverter* const time_converter_;
+
   // The controller used to manage creation and deletion of platform views.
   const FlutterPlatformViewController* platform_view_controller_;
 

shell/platform/darwin/macos/framework/Source/FlutterCompositor.mm

@@ -9,9 +9,24 @@
 
 namespace flutter {
 
+namespace {
+std::vector<PlatformViewLayerWithIndex> CopyPlatformViewLayers(const FlutterLayer** layers,
+                                                               size_t layer_count) {
+  std::vector<PlatformViewLayerWithIndex> platform_views;
+  for (size_t i = 0; i < layer_count; i++) {
+    if (layers[i]->type == kFlutterLayerContentTypePlatformView) {
+      platform_views.push_back(std::make_pair(PlatformViewLayer(layers[i]), i));
+    }
+  }
+  return platform_views;
+}
+}  // namespace
+
 FlutterCompositor::FlutterCompositor(id<FlutterViewProvider> view_provider,
+                                     FlutterTimeConverter* time_converter,
                                      FlutterPlatformViewController* platform_view_controller)
     : view_provider_(view_provider),
+      time_converter_(time_converter),
       platform_view_controller_(platform_view_controller),
       mutator_views_([NSMapTable strongToStrongObjectsMapTable]) {
   FML_CHECK(view_provider != nullptr) << "view_provider cannot be nullptr";
@@ -69,28 +84,38 @@
     }
   }
 
-  [view.surfaceManager present:surfaces
-                        notify:^{
-                          PresentPlatformViews(view, layers, layers_count);
-                        }];
+  CFTimeInterval presentation_time = 0;
+
+  if (layers_count > 0 && layers[0]->presentation_time != 0) {
+    presentation_time = [time_converter_ engineTimeToCAMediaTime:layers[0]->presentation_time];
+  }
+
+  // Notify block below may be called asynchronously, hence the need to copy
+  // the layer information instead of passing the original pointers from embedder.
+  auto platform_views_layers = std::make_shared<std::vector<PlatformViewLayerWithIndex>>(
+      CopyPlatformViewLayers(layers, layers_count));
+
+  [view.surfaceManager presentSurfaces:surfaces
+                                atTime:presentation_time
+                                notify:^{
+                                  PresentPlatformViews(view, *platform_views_layers);
+                                }];
 
   return true;
 }
 
-void FlutterCompositor::PresentPlatformViews(FlutterView* default_base_view,
-                                             const FlutterLayer** layers,
-                                             size_t layers_count) {
+void FlutterCompositor::PresentPlatformViews(
+    FlutterView* default_base_view,
+    const std::vector<PlatformViewLayerWithIndex>& platform_views) {
   FML_DCHECK([[NSThread currentThread] isMainThread])
       << "Must be on the main thread to present platform views";
 
   // Active mutator views for this frame.
   NSMutableArray<FlutterMutatorView*>* present_mutators = [NSMutableArray array];
 
-  for (size_t i = 0; i < layers_count; i++) {
-    FlutterLayer* layer = (FlutterLayer*)layers[i];
-    if (layer->type == kFlutterLayerContentTypePlatformView) {
-      [present_mutators addObject:PresentPlatformView(default_base_view, layer, i)];
-    }
+  for (const auto& platform_view : platform_views) {
+    [present_mutators addObject:PresentPlatformView(default_base_view, platform_view.first,
+                                                    platform_view.second)];
   }
 
   NSMutableArray<FlutterMutatorView*>* obsolete_mutators =
@@ -106,12 +131,12 @@
 }
 
 FlutterMutatorView* FlutterCompositor::PresentPlatformView(FlutterView* default_base_view,
-                                                           const FlutterLayer* layer,
-                                                           size_t layer_position) {
+                                                           const PlatformViewLayer& layer,
+                                                           size_t index) {
   FML_DCHECK([[NSThread currentThread] isMainThread])
       << "Must be on the main thread to present platform views";
 
-  int64_t platform_view_id = layer->platform_view->identifier;
+  int64_t platform_view_id = layer.identifier();
   NSView* platform_view = [platform_view_controller_ platformViewWithID:platform_view_id];
 
   FML_DCHECK(platform_view) << "Platform view not found for id: " << platform_view_id;
@@ -124,8 +149,8 @@
     [default_base_view addSubview:container];
   }
 
-  container.layer.zPosition = layer_position;
-  [container applyFlutterLayer:layer];
+  container.layer.zPosition = index;
+  [container applyFlutterLayer:&layer];
 
   return container;
 }

shell/platform/darwin/macos/framework/Source/FlutterDisplayLink.h

@@ -0,0 +1,40 @@
+#ifndef FLUTTER_SHELL_PLATFORM_DARWIN_MACOS_FRAMEWORK_SOURCE_FLUTTERDISPLAYLINK_H_
+#define FLUTTER_SHELL_PLATFORM_DARWIN_MACOS_FRAMEWORK_SOURCE_FLUTTERDISPLAYLINK_H_
+
+#import <AppKit/AppKit.h>
+
+@protocol FlutterDisplayLinkDelegate <NSObject>
+- (void)onDisplayLink:(CFTimeInterval)timestamp targetTimestamp:(CFTimeInterval)targetTimestamp;
+@end
+
+/// Provides notifications of display refresh.
+///
+/// Internally FlutterDisplayLink will use at most one CVDisplayLink per
+/// screen shared for all views belonging to that screen. This is necessary
+/// because each CVDisplayLink comes with its own thread.
+@interface FlutterDisplayLink : NSObject
+
+/// Creates new instance tied to provided NSView. FlutterDisplayLink
+/// will track view display changes transparently to synchronize
+/// update with display refresh.
+/// This function must be called on the main thread.
++ (instancetype)displayLinkWithView:(NSView*)view;
+
+/// Delegate must be set on main thread. Delegate method will be called on
+/// on display link thread.
+@property(nonatomic, weak) id<FlutterDisplayLinkDelegate> delegate;
+
+/// Pauses and resumes the display link. May be called from any thread.
+@property(readwrite) BOOL paused;
+
+/// Returns the nominal refresh period of the display to which the view
+/// currently belongs (in seconds). If view does not belong to any display,
+/// returns 0. Can be called from any thread.
+@property(readonly) CFTimeInterval nominalOutputRefreshPeriod;
+
+/// Invalidates the display link. Must be called on the main thread.
+- (void)invalidate;
+
+@end
+
+#endif  // FLUTTER_SHELL_PLATFORM_DARWIN_MACOS_FRAMEWORK_SOURCE_FLUTTERDISPLAYLINK_H_