Benchmark app frame time improvements (#1776)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
maplibre · Nov 3, 2023 · 8ad5f9c · 8ad5f9c
1 parent 827ced7
commit 8ad5f9c
Show file tree

Hide file tree

Showing 21 changed files with 245 additions and 102 deletions.
diff --git a/include/mbgl/map/map_observer.hpp b/include/mbgl/map/map_observer.hpp
@@ -42,7 +42,8 @@ class MapObserver {
         RenderMode mode;
         bool needsRepaint; // In continous mode, shows that there are ongoig transitions.
         bool placementChanged;
-        double frameTime;
+        double frameEncodingTime;
+        double frameRenderingTime;
     };
 
     virtual void onCameraWillChange(CameraChangeMode) {}

diff --git a/include/mbgl/renderer/renderer_observer.hpp b/include/mbgl/renderer/renderer_observer.hpp
@@ -36,7 +36,11 @@ class RendererObserver {
     virtual void onDidFinishRenderingFrame(RenderMode, bool /*repaint*/, bool /*placementChanged*/) {}
 
     /// End of frame, booleans flags that a repaint is required and that placement changed.
-    virtual void onDidFinishRenderingFrame(RenderMode mode, bool repaint, bool placementChanged, double /*frameTime*/) {
+    virtual void onDidFinishRenderingFrame(RenderMode mode,
+                                           bool repaint,
+                                           bool placementChanged,
+                                           double /*frameEncodingTime*/,
+                                           double /*frameRenderingTime*/) {
         onDidFinishRenderingFrame(mode, repaint, placementChanged);
     }
 

diff --git a/platform/BUILD.bazel b/platform/BUILD.bazel
@@ -232,7 +232,7 @@ objc_library(
 
 objc_library(
     name = "ios-benchapp",
-    copts = MAPLIBRE_FLAGS,
+    copts = CPP_FLAGS + MAPLIBRE_FLAGS,
     srcs = ["//platform/ios/benchmark:ios_benchmark_srcs"],
     hdrs = ["//platform/ios/benchmark:ios_benchmark_hdrs"],
     includes = [

diff --git a/platform/android/MapboxGLAndroidSDK/src/cpp/android_renderer_frontend.cpp b/platform/android/MapboxGLAndroidSDK/src/cpp/android_renderer_frontend.cpp
@@ -34,9 +34,11 @@ class ForwardingRendererObserver : public RendererObserver {
     void onDidFinishRenderingFrame(RenderMode mode,
                                    bool repaintNeeded,
                                    bool placementChanged,
-                                   double frameTime) override {
-        void (RendererObserver::*f)(RenderMode, bool, bool, double) = &RendererObserver::onDidFinishRenderingFrame;
-        delegate.invoke(f, mode, repaintNeeded, placementChanged, frameTime);
+                                   double frameEncodingTime,
+                                   double frameRenderingTime) override {
+        void (RendererObserver::*f)(
+            RenderMode, bool, bool, double, double) = &RendererObserver::onDidFinishRenderingFrame;
+        delegate.invoke(f, mode, repaintNeeded, placementChanged, frameEncodingTime, frameRenderingTime);
     }
 
     void onDidFinishRenderingMap() override { delegate.invoke(&RendererObserver::onDidFinishRenderingMap); }

diff --git a/platform/default/include/mbgl/gfx/headless_frontend.hpp b/platform/default/include/mbgl/gfx/headless_frontend.hpp
@@ -31,7 +31,8 @@ class HeadlessFrontend : public RendererFrontend {
                      float pixelRatio_,
                      gfx::HeadlessBackend::SwapBehaviour swapBehavior = gfx::HeadlessBackend::SwapBehaviour::NoFlush,
                      gfx::ContextMode mode = gfx::ContextMode::Unique,
-                     const std::optional<std::string>& localFontFamily = std::nullopt);
+                     const std::optional<std::string>& localFontFamily = std::nullopt,
+                     bool invalidateOnUpdate_ = true);
     ~HeadlessFrontend() override;
 
     void reset() override;
@@ -56,6 +57,7 @@ class HeadlessFrontend : public RendererFrontend {
     PremultipliedImage readStillImage();
     RenderResult render(Map&);
     void renderOnce(Map&);
+    void renderFrame();
 
     std::optional<TransformState> getTransformState() const;
 
@@ -66,6 +68,7 @@ class HeadlessFrontend : public RendererFrontend {
     std::atomic<double> frameTime;
     std::unique_ptr<gfx::HeadlessBackend> backend;
     util::AsyncTask asyncInvalidate;
+    bool invalidateOnUpdate;
 
     std::unique_ptr<Renderer> renderer;
     std::shared_ptr<UpdateParameters> updateParameters;

diff --git a/platform/default/src/mbgl/gfx/headless_frontend.cpp b/platform/default/src/mbgl/gfx/headless_frontend.cpp
@@ -21,31 +21,17 @@ HeadlessFrontend::HeadlessFrontend(Size size_,
                                    float pixelRatio_,
                                    gfx::HeadlessBackend::SwapBehaviour swapBehavior,
                                    const gfx::ContextMode contextMode,
-                                   const std::optional<std::string>& localFontFamily)
+                                   const std::optional<std::string>& localFontFamily,
+                                   bool invalidateOnUpdate_)
     : size(size_),
       pixelRatio(pixelRatio_),
       frameTime(0),
       backend(gfx::HeadlessBackend::Create(
           {static_cast<uint32_t>(size.width * pixelRatio), static_cast<uint32_t>(size.height * pixelRatio)},
           swapBehavior,
           contextMode)),
-      asyncInvalidate([this] {
-          if (renderer && updateParameters) {
-              auto startTime = mbgl::util::MonotonicTimer::now();
-              gfx::BackendScope guard{*getBackend()};
-
-              // onStyleImageMissing might be called during a render. The user
-              // implemented method could trigger a call to
-              // MLNRenderFrontend#update which overwrites `updateParameters`.
-              // Copy the shared pointer here so that the parameters aren't
-              // destroyed while `render(...)` is still using them.
-              auto updateParameters_ = updateParameters;
-              renderer->render(updateParameters_);
-
-              auto endTime = mbgl::util::MonotonicTimer::now();
-              frameTime = (endTime - startTime).count();
-          }
-      }),
+      asyncInvalidate([this] { renderFrame(); }),
+      invalidateOnUpdate(invalidateOnUpdate_),
       renderer(std::make_unique<Renderer>(*getBackend(), pixelRatio, localFontFamily)) {}
 
 HeadlessFrontend::~HeadlessFrontend() = default;
@@ -57,7 +43,9 @@ void HeadlessFrontend::reset() {
 
 void HeadlessFrontend::update(std::shared_ptr<UpdateParameters> updateParameters_) {
     updateParameters = updateParameters_;
-    asyncInvalidate.send();
+    if (invalidateOnUpdate) {
+        asyncInvalidate.send();
+    }
 }
 
 void HeadlessFrontend::setObserver(RendererObserver& observer_) {
@@ -169,6 +157,24 @@ void HeadlessFrontend::renderOnce(Map&) {
     util::RunLoop::Get()->runOnce();
 }
 
+void HeadlessFrontend::renderFrame() {
+    if (renderer && updateParameters) {
+        auto startTime = mbgl::util::MonotonicTimer::now();
+        gfx::BackendScope guard{*getBackend()};
+
+        // onStyleImageMissing might be called during a render. The user
+        // implemented method could trigger a call to
+        // MLNRenderFrontend#update which overwrites `updateParameters`.
+        // Copy the shared pointer here so that the parameters aren't
+        // destroyed while `render(...)` is still using them.
+        auto updateParameters_ = updateParameters;
+        renderer->render(updateParameters_);
+
+        auto endTime = mbgl::util::MonotonicTimer::now();
+        frameTime = (endTime - startTime).count();
+    }
+}
+
 std::optional<TransformState> HeadlessFrontend::getTransformState() const {
     if (updateParameters) {
         return updateParameters->transformState;

diff --git a/platform/default/src/mbgl/map/map_snapshotter.cpp b/platform/default/src/mbgl/map/map_snapshotter.cpp
@@ -39,9 +39,11 @@ class ForwardingRendererObserver final : public RendererObserver {
     void onDidFinishRenderingFrame(RenderMode mode,
                                    bool repaintNeeded,
                                    bool placementChanged,
-                                   double frameTime) override {
-        void (RendererObserver::*f)(RenderMode, bool, bool, double) = &RendererObserver::onDidFinishRenderingFrame;
-        delegate.invoke(f, mode, repaintNeeded, placementChanged, frameTime);
+                                   double frameEncodingTime,
+                                   double frameRenderingTime) override {
+        void (RendererObserver::*f)(
+            RenderMode, bool, bool, double, double) = &RendererObserver::onDidFinishRenderingFrame;
+        delegate.invoke(f, mode, repaintNeeded, placementChanged, frameEncodingTime, frameRenderingTime);
     }
 
     void onStyleImageMissing(const std::string& image, const StyleImageMissingCallback& cb) override {
@@ -84,11 +86,13 @@ class SnapshotterRenderer final : public RendererObserver {
     void onDidFinishRenderingFrame(RenderMode mode,
                                    bool repaintNeeded,
                                    bool placementChanged,
-                                   double frameTime) override {
+                                   double frameEncodingTime,
+                                   double frameRenderingTime) override {
         if (mode == RenderMode::Full && hasPendingStillImageRequest) {
             stillImage = frontend.readStillImage();
         }
-        rendererObserver->onDidFinishRenderingFrame(mode, repaintNeeded, placementChanged, frameTime);
+        rendererObserver->onDidFinishRenderingFrame(
+            mode, repaintNeeded, placementChanged, frameEncodingTime, frameRenderingTime);
     }
 
     void onStyleImageMissing(const std::string& id, const StyleImageMissingCallback& done) override {

diff --git a/platform/ios/app/MBXViewController.m b/platform/ios/app/MBXViewController.m
@@ -2478,9 +2478,9 @@ - (void)updateHUD {
     return features;
 }
 
-- (void)mapViewDidFinishRenderingFrame:(MLNMapView *)mapView fullyRendered:(BOOL)fullyRendered frameTime:(double)frameTime {
+- (void)mapViewDidFinishRenderingFrame:(MLNMapView *)mapView fullyRendered:(BOOL)fullyRendered frameEncodingTime:(double)frameEncodingTime frameRenderingTime:(double)frameRenderingTime {
     if (self.frameTimeGraphEnabled) {
-        [self.frameTimeGraphView updatePathWithFrameDuration:frameTime];
+        [self.frameTimeGraphView updatePathWithFrameDuration:frameEncodingTime];
     }
 }
 

diff --git a/platform/ios/benchmark/BUILD.bazel b/platform/ios/benchmark/BUILD.bazel
@@ -3,8 +3,8 @@ load("//platform/ios/bazel:macros.bzl", "info_plist")
 filegroup(
     name = "ios_benchmark_srcs",
     srcs = [
-        "main.m",
-        "MBXBenchAppDelegate.m",
+        "main.mm",
+        "MBXBenchAppDelegate.mm",
         "MBXBenchViewController.mm",
         "locations.cpp",
     ],

diff --git a/platform/ios/benchmark/MBXBenchAppDelegate.m → ...form/ios/benchmark/MBXBenchAppDelegate.mm b/platform/ios/benchmark/MBXBenchAppDelegate.m → ...form/ios/benchmark/MBXBenchAppDelegate.mm