Add experimental function `MapView.setSnapshotLegacyMode (#2423) (#2463)

* Add experimental  function

* Fixes

Author: kiryldz

CHANGELOG.md

@@ -2,7 +2,12 @@
 
 Mapbox welcomes participation and contributions from everyone.
 
+# main
+
 # 10.17.1
+## Features ✨ and improvements 🏁
+* Add experimental `MapView.setSnapshotLegacyMode` function to help avoiding `MapView.snapshot` native crash on some Samsung devices running Android 14.
+
 ## Bug fixes 🐞
 * Fix memory leak when camera animations are skipped.
 
@@ -15,7 +20,6 @@ Mapbox welcomes participation and contributions from everyone.
 ## Dependencies
 * Update gl-native to v10.17.0 and common to v23.9.2.
 
-
 # 10.16.6 March 04, 2024
 ## Bug fixes 🐞
 * Fix rare crash in `LocationServiceImpl` on startup.

sdk/api/PublicRelease/metalava.txt

@@ -129,6 +129,7 @@ package com.mapbox.maps {
     method @com.mapbox.maps.MapboxExperimental public boolean removeWidget(com.mapbox.maps.renderer.widget.Widget widget);
     method public void setMaximumFps(@IntRange(from=1, to=Int.MAX_VALUE.toLong()) int fps);
     method public void setOnFpsChangedListener(com.mapbox.maps.renderer.OnFpsChangedListener listener);
+    method @com.mapbox.maps.MapboxExperimental public final void setSnapshotLegacyMode(boolean enabled);
     method public android.graphics.Bitmap? snapshot();
     method public void snapshot(com.mapbox.maps.MapView.OnSnapshotReady listener);
     property public final com.mapbox.maps.viewannotation.ViewAnnotationManager viewAnnotationManager;

sdk/api/sdk.api

@@ -131,6 +131,7 @@ public class com/mapbox/maps/MapView : android/widget/FrameLayout, com/mapbox/ma
 	public fun removeWidget (Lcom/mapbox/maps/renderer/widget/Widget;)Z
 	public fun setMaximumFps (I)V
 	public fun setOnFpsChangedListener (Lcom/mapbox/maps/renderer/OnFpsChangedListener;)V
+	public final fun setSnapshotLegacyMode (Z)V
 	public fun snapshot ()Landroid/graphics/Bitmap;
 	public fun snapshot (Lcom/mapbox/maps/MapView$OnSnapshotReady;)V
 }

sdk/src/main/java/com/mapbox/maps/MapView.kt

@@ -284,6 +284,20 @@ open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable {
     mapController.snapshot(listener)
   }
 
+  /**
+   * Set whether legacy mode should be used for [snapshot].
+   *
+   * Legacy mode is not that efficient (as it blocks map rendering when making the snapshot)
+   * but may help with vendor specific issues like described in
+   * https://github.com/mapbox/mapbox-maps-android/issues/2280.
+   *
+   * @param enabled enables legacy mode when True and disables otherwise.
+   */
+  @MapboxExperimental
+  fun setSnapshotLegacyMode(enabled: Boolean) {
+    mapController.renderer.snapshotLegacyModeEnabled = enabled
+  }
+
   /**
    * Set new maximum FPS for map rendering.
    *

sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderer.kt

@@ -44,6 +44,12 @@ internal abstract class MapboxRenderer : MapClient {
     }
   }
 
+  internal var snapshotLegacyModeEnabled = false
+    @MainThread
+    get
+    @MainThread
+    set
+
   @UiThread
   fun onDestroy() {
     widgetRenderer.cleanUpAllWidgets()
@@ -144,13 +150,14 @@ internal abstract class MapboxRenderer : MapClient {
     }
     val lock = ReentrantLock()
     val waitCondition = lock.newCondition()
+    val legacyMode = snapshotLegacyModeEnabled
     lock.withLock {
       var snapshot: Bitmap? = null
       renderThread.queueRenderEvent(
         RenderEvent(
           runnable = {
             lock.withLock {
-              snapshot = performSnapshot()
+              snapshot = performSnapshot(legacyMode)
               waitCondition.signal()
             }
           },
@@ -169,9 +176,10 @@ internal abstract class MapboxRenderer : MapClient {
       logE(TAG, "Could not take map snapshot because map is not ready yet.")
       listener.onSnapshotReady(null)
     }
+    val legacyMode = snapshotLegacyModeEnabled
     renderThread.queueRenderEvent(
       RenderEvent(
-        runnable = { listener.onSnapshotReady(performSnapshot()) },
+        runnable = { listener.onSnapshotReady(performSnapshot(legacyMode)) },
         needRender = true,
         eventType = EventType.DEFAULT
       )
@@ -194,15 +202,15 @@ internal abstract class MapboxRenderer : MapClient {
   }
 
   @WorkerThread
-  private fun performSnapshot(): Bitmap? {
+  private fun performSnapshot(legacyMode: Boolean): Bitmap? {
     if (width == 0 && height == 0) {
       logE(TAG, "Could not take map snapshot because map is not ready yet.")
       return null
     }
 
-    if (pixelReader == null || pixelReader?.width != width || pixelReader?.height != height) {
+    if (pixelReader == null || pixelReader?.width != width || pixelReader?.height != height || pixelReader?.legacyMode != legacyMode) {
       pixelReader?.release()
-      pixelReader = PixelReader(width, height)
+      pixelReader = PixelReader(width, height, legacyMode)
     }
     val pixelReader = pixelReader!!
 
@@ -231,15 +239,15 @@ internal abstract class MapboxRenderer : MapClient {
       }
     } catch (e: Throwable) {
       logW(TAG, "Exception ${e.localizedMessage} happened when reading pixels")
-      if (pixelReader.supportsPbo) {
+      if (!pixelReader.legacyMode) {
         logW(TAG, "Re-creating PixelReader with no PBO support and making snapshot again")
         pixelReader.release()
         this.pixelReader = PixelReader(
           width = pixelReader.width,
           height = pixelReader.height,
-          supportsPbo = false
+          legacyMode = true
         )
-        return performSnapshot()
+        return performSnapshot(legacyMode = true)
       }
     }
     return null

sdk/src/main/java/com/mapbox/maps/renderer/gl/PixelReader.kt

@@ -17,13 +17,23 @@ import java.nio.IntBuffer
  * 2. By using single PBO with `glReadPixels` on newer devices in order not to block GPU pipeline.
  *
  * Inspired by http://www.songho.ca/opengl/gl_pbo.html
+ *
+ * @param width width in pixels to read
+ * @param height height in pixels to read
+ * @param legacyMode if true we read pixels without using PBO (use glReadPixels).
+ *  Otherwise, we use PBO for faster reading if it is supported.
  */
 internal class PixelReader(
   val width: Int,
   val height: Int,
-  @ChecksSdkIntAtLeast(api = Build.VERSION_CODES.N)
-  internal val supportsPbo: Boolean = Build.VERSION.SDK_INT >= Build.VERSION_CODES.N
+  val legacyMode: Boolean,
 ) {
+  @ChecksSdkIntAtLeast(api = Build.VERSION_CODES.N)
+  private val supportsPbo: Boolean = if (legacyMode)
+    false
+  else
+    Build.VERSION.SDK_INT >= Build.VERSION_CODES.N
+
   private val bufferSize = width * height * channelNum
   private var buffer = ByteBuffer
     .allocateDirect(bufferSize)