Add SurfaceProducer.Callback lifecycle hooks

shell/platform/android/BUILD.gn

@@ -374,6 +374,7 @@ embedding_dependencies_jars = [
   "//third_party/android_embedding_dependencies/lib/lifecycle-common-java8-2.2.0.jar",
   "//third_party/android_embedding_dependencies/lib/lifecycle-livedata-2.0.0.jar",
   "//third_party/android_embedding_dependencies/lib/lifecycle-livedata-core-2.0.0.jar",
+  "//third_party/android_embedding_dependencies/lib/lifecycle-process-2.2.0.jar",
   "//third_party/android_embedding_dependencies/lib/lifecycle-runtime-2.2.0.jar",
   "//third_party/android_embedding_dependencies/lib/lifecycle-viewmodel-2.1.0.jar",
   "//third_party/android_embedding_dependencies/lib/loader-1.0.0.jar",

shell/platform/android/build.gradle

@@ -63,3 +63,7 @@ android {
     }
 }
 
+dependencies {
+    implementation 'androidx.lifecycle:lifecycle-process:2.2.0'
+}
+

shell/platform/android/io/flutter/embedding/engine/renderer/FlutterRenderer.java

@@ -24,6 +24,9 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
+import androidx.lifecycle.DefaultLifecycleObserver;
+import androidx.lifecycle.LifecycleOwner;
+import androidx.lifecycle.ProcessLifecycleOwner;
 import io.flutter.Log;
 import io.flutter.embedding.engine.FlutterJNI;
 import io.flutter.view.TextureRegistry;
@@ -78,6 +81,8 @@ public class FlutterRenderer implements TextureRegistry {
   private final Set<WeakReference<TextureRegistry.OnTrimMemoryListener>> onTrimMemoryListeners =
       new HashSet<>();
 
+  @NonNull private final List<SurfaceProducer> producers = new ArrayList<>();
+
   @NonNull
   private final FlutterUiDisplayListener flutterUiDisplayListener =
       new FlutterUiDisplayListener() {
@@ -95,6 +100,18 @@ public void onFlutterUiNoLongerDisplayed() {
   public FlutterRenderer(@NonNull FlutterJNI flutterJNI) {
     this.flutterJNI = flutterJNI;
     this.flutterJNI.addIsDisplayingFlutterUiListener(flutterUiDisplayListener);
+    ProcessLifecycleOwner.get()
+        .getLifecycle()
+        .addObserver(
+            new DefaultLifecycleObserver() {
+              @Override
+              public void onResume(@NonNull LifecycleOwner owner) {
+                Log.v(TAG, "onResume called; notifying SurfaceProducers");
+                for (SurfaceProducer producer : producers) {
+                  producer.surfaceRecreated();
+                }
+              }
+            });
   }
 
   /**
@@ -211,6 +228,7 @@ public SurfaceProducer createSurfaceProducer() {
       Log.v(TAG, "New SurfaceTextureSurfaceProducer ID: " + texture.id());
       entry = producer;
     }
+    producers.add(entry);
     return entry;
   }
 
@@ -453,6 +471,7 @@ final class ImageReaderSurfaceProducer
         new HashMap<ImageReader, PerImageReader>();
     private PerImage lastDequeuedImage = null;
     private PerImageReader lastReaderDequeuedFrom = null;
+    private SurfaceProducer.OnSurfaceRecreatedCallback callback = null;
 
     /** Internal class: state held per Image produced by ImageReaders. */
     private class PerImage {
@@ -732,6 +751,18 @@ private void maybeWaitOnFence(Image image) {
       this.id = id;
     }
 
+    @Override
+    public void surfaceRecreated() {
+      if (callback != null) {
+        callback.onSurfaceRecreated();
+      }
+    }
+
+    @Override
+    public void setOnSurfaceRecreatedCallback(SurfaceProducer.OnSurfaceRecreatedCallback callback) {
+      this.callback = callback;
+    }
+
     @Override
     public long id() {
       return id;

shell/platform/android/io/flutter/embedding/engine/renderer/SurfaceTextureSurfaceProducer.java

@@ -55,6 +55,17 @@ public void release() {
     released = true;
   }
 
+  @Override
+  public void surfaceRecreated() {
+    // Intentionally blank: SurfaceTextures don't need to be recreated.
+  }
+
+  @Override
+  public void setOnSurfaceRecreatedCallback(
+      TextureRegistry.SurfaceProducer.OnSurfaceRecreatedCallback callback) {
+    // Intentionally blank: SurfaceTextures don't need to be recreated.
+  }
+
   @Override
   @NonNull
   public SurfaceTexture getSurfaceTexture() {

shell/platform/android/io/flutter/view/TextureRegistry.java

@@ -7,6 +7,7 @@
 import android.graphics.SurfaceTexture;
 import android.media.Image;
 import android.view.Surface;
+import android.view.SurfaceHolder;
 import androidx.annotation.Keep;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -79,7 +80,12 @@ interface SurfaceProducer extends TextureEntry {
     int getHeight();
 
     /**
-     * Get a Surface that can be used to update the texture contents.
+     * Direct access to the surface object.
+     *
+     * <p>When using this API, you will usually need to implement {@link SurfaceHolder.Callback} and
+     * provide it to {@link #setOnSurfaceRecreatedCallback(OnSurfaceRecreatedCallback)} in order to
+     * be notified when a new surface has been created, such as after a backgrounded app has been\
+     * resumed.
      *
      * <p>NOTE: You should not cache the returned surface but instead invoke getSurface each time
      * you need to draw. The surface may change when the texture is resized or has its format
@@ -89,6 +95,35 @@ interface SurfaceProducer extends TextureEntry {
      */
     Surface getSurface();
 
+    /**
+     * Sets a callback that is notified when
+     *
+     * @param callback The callback to notify, or null to remove the callback.
+     */
+    void setOnSurfaceRecreatedCallback(OnSurfaceRecreatedCallback callback);
+
+    /** Callback invoked by {@link #setOnSurfaceRecreatedCallback(OnSurfaceRecreatedCallback)}. */
+    interface OnSurfaceRecreatedCallback {
+      /**
+       * Invoked when a new surface was forcibly recreated by {@link SurfaceProducer}.
+       *
+       * <p>Typically plugins will use this callback as a signal to redraw.
+       */
+      void onSurfaceRecreated();
+    }
+
+    /**
+     * @deprecated This method is not officially part of the public API surface and will be removed.
+     */
+    @Deprecated
+    @SuppressWarnings("DeprecatedIsStillUsed")
+    void surfaceRecreated();
+
+    /**
+     * @deprecated This method is not officially part of the public API surface and will be removed.
+     */
+    @Deprecated
+    @SuppressWarnings("DeprecatedIsStillUsed")
     void scheduleFrame();
   };
 

testing/scenario_app/android/app/gradle.lockfile

@@ -28,6 +28,7 @@ androidx.lifecycle:lifecycle-common-java8:2.2.0=debugAndroidTestCompileClasspath
 androidx.lifecycle:lifecycle-common:2.3.1=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath
 androidx.lifecycle:lifecycle-livedata-core:2.0.0=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath
 androidx.lifecycle:lifecycle-livedata:2.0.0=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath
+androidx.lifecycle:lifecycle-process:2.2.0=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath
 androidx.lifecycle:lifecycle-runtime:2.2.0=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath
 androidx.lifecycle:lifecycle-viewmodel:2.1.0=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath
 androidx.loader:loader:1.0.0=debugAndroidTestCompileClasspath,debugCompileClasspath,debugImplementationDependenciesMetadata,debugRuntimeClasspath,debugUnitTestCompileClasspath,debugUnitTestRuntimeClasspath,implementationDependenciesMetadata,releaseCompileClasspath,releaseImplementationDependenciesMetadata,releaseRuntimeClasspath,releaseUnitTestCompileClasspath,releaseUnitTestRuntimeClasspath

tools/androidx/files.json

@@ -13,17 +13,19 @@
     "url": "https://maven.google.com/androidx/lifecycle/lifecycle-common-java8/2.2.0/lifecycle-common-java8-2.2.0.jar",
     "out_file_name": "androidx_lifecycle_common_java8.jar",
     "maven_dependency": "androidx.lifecycle:lifecycle-common-java8:2.2.0",
-    "provides": [
-      "androidx.lifecycle.DefaultLifecycleObserver"
-    ]
+    "provides": ["androidx.lifecycle.DefaultLifecycleObserver"]
+  },
+  {
+    "url": "https://maven.google.com/androidx/lifecycle/lifecycle-process/2.2.0/lifecycle-process-2.2.0.aar",
+    "out_file_name": "androidx_lifecycle_process.aar",
+    "maven_dependency": "androidx.lifecycle:lifecycle-process:2.2.0",
+    "provides": ["androidx.lifecycle.ProcessLifecycleOwner"]
   },
   {
     "url": "https://maven.google.com/androidx/lifecycle/lifecycle-runtime/2.2.0/lifecycle-runtime-2.2.0.aar",
     "out_file_name": "androidx_lifecycle_runtime.aar",
     "maven_dependency": "androidx.lifecycle:lifecycle-runtime:2.2.0",
-    "provides": [
-      "androidx.lifecycle.LifecycleRegistry"
-    ]
+    "provides": ["androidx.lifecycle.LifecycleRegistry"]
   },
   {
     "url": "https://maven.google.com/androidx/fragment/fragment/1.1.0/fragment-1.1.0.aar",
@@ -54,17 +56,13 @@
     "url": "https://maven.google.com/androidx/tracing/tracing/1.0.0/tracing-1.0.0.aar",
     "out_file_name": "androidx_tracing.aar",
     "maven_dependency": "androidx.tracing:tracing:1.0.0",
-    "provides": [
-      "androidx.tracing.Trace"
-    ]
+    "provides": ["androidx.tracing.Trace"]
   },
   {
     "url": "https://dl.google.com/android/maven2/androidx/core/core/1.6.0/core-1.6.0.aar",
     "out_file_name": "androidx_core.aar",
     "maven_dependency": "androidx.core:core:1.6.0",
-    "provides": [
-      "androidx.core.view.WindowInsetsControllerCompat"
-    ]
+    "provides": ["androidx.core.view.WindowInsetsControllerCompat"]
   },
   {
     "url": "https://maven.google.com/androidx/window/window-java/1.0.0-beta04/window-java-1.0.0-beta04.aar",

tools/cipd/android_embedding_bundle/build.gradle

@@ -13,7 +13,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath "com.android.tools.build:gradle:3.5.0"
+        classpath "com.android.tools.build:gradle:7.0.2"
     }
 }