[camerax] Re-land SurfaceProducer migration with fix for camera preview rotation

packages/camera/camera_android_camerax/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.6.6
+
+* Adds logic to support building a camera preview with Android `Surface`s not backed by a `SurfaceTexture`
+  to which CameraX cannot not automatically apply the transformation required to achieve the correct rotation.
+* Re-lands support for Impeller.
+* Updates example app's minimum supported SDK version to Flutter 3.22/Dart 3.4.
+
 ## 0.6.5+5
 
 * Reverts changes to support Impeller.

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/Camera2CameraInfoHostApiImpl.java

@@ -29,26 +29,30 @@ public class Camera2CameraInfoHostApiImpl implements Camera2CameraInfoHostApi {
 
   /** Proxy for methods of {@link Camera2CameraInfo}. */
   @VisibleForTesting
+  @OptIn(markerClass = ExperimentalCamera2Interop.class)
   public static class Camera2CameraInfoProxy {
 
     @NonNull
-    @OptIn(markerClass = ExperimentalCamera2Interop.class)
     public Camera2CameraInfo createFrom(@NonNull CameraInfo cameraInfo) {
       return Camera2CameraInfo.from(cameraInfo);
     }
 
     @NonNull
-    @OptIn(markerClass = ExperimentalCamera2Interop.class)
     public Integer getSupportedHardwareLevel(@NonNull Camera2CameraInfo camera2CameraInfo) {
       return camera2CameraInfo.getCameraCharacteristic(
           CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL);
     }
 
     @NonNull
-    @OptIn(markerClass = ExperimentalCamera2Interop.class)
     public String getCameraId(@NonNull Camera2CameraInfo camera2CameraInfo) {
       return camera2CameraInfo.getCameraId();
     }
+
+    @NonNull
+    public Long getSensorOrientation(@NonNull Camera2CameraInfo camera2CameraInfo) {
+      return Long.valueOf(
+          camera2CameraInfo.getCameraCharacteristic(CameraCharacteristics.SENSOR_ORIENTATION));
+    }
   }
 
   /**
@@ -105,6 +109,12 @@ public String getCameraId(@NonNull Long identifier) {
     return proxy.getCameraId(getCamera2CameraInfoInstance(identifier));
   }
 
+  @Override
+  @NonNull
+  public Long getSensorOrientation(@NonNull Long identifier) {
+    return proxy.getSensorOrientation(getCamera2CameraInfoInstance(identifier));
+  }
+
   private Camera2CameraInfo getCamera2CameraInfoInstance(@NonNull Long identifier) {
     return Objects.requireNonNull(instanceManager.getInstance(identifier));
   }

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/CameraXProxy.java

@@ -5,9 +5,7 @@
 package io.flutter.plugins.camerax;
 
 import android.app.Activity;
-import android.graphics.SurfaceTexture;
 import android.util.Size;
-import android.view.Surface;
 import androidx.annotation.NonNull;
 import androidx.camera.core.CameraSelector;
 import androidx.camera.core.ImageAnalysis;
@@ -51,11 +49,6 @@ public class CameraXProxy {
     return new Preview.Builder();
   }
 
-  /** Creates a {@link Surface} instance from the specified {@link SurfaceTexture}. */
-  public @NonNull Surface createSurface(@NonNull SurfaceTexture surfaceTexture) {
-    return new Surface(surfaceTexture);
-  }
-
   /**
    * Creates an instance of the {@link SystemServicesFlutterApiImpl}.
    *

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/DeviceOrientationManager.java

@@ -52,8 +52,7 @@ interface DeviceOrientationChangeCallback {
    * Starts listening to the device's sensors or UI for orientation updates.
    *
    * <p>When orientation information is updated, the callback method of the {@link
-   * DeviceOrientationChangeCallback} is called with the new orientation. This latest value can also
-   * be retrieved through the {@link #getVideoOrientation()} accessor.
+   * DeviceOrientationChangeCallback} is called with the new orientation.
    *
    * <p>If the device's ACCELEROMETER_ROTATION setting is enabled the {@link
    * DeviceOrientationManager} will report orientation updates based on the sensor information. If

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/DeviceOrientationManagerHostApiImpl.java

@@ -95,7 +95,8 @@ public void stopListeningForDeviceOrientationChange() {
    * for instance for more information on how this default value is used.
    */
   @Override
-  public @NonNull Long getDefaultDisplayRotation() {
+  @NonNull
+  public Long getDefaultDisplayRotation() {
     int defaultRotation;
     try {
       defaultRotation = deviceOrientationManager.getDefaultRotation();
@@ -106,4 +107,11 @@ public void stopListeningForDeviceOrientationChange() {
 
     return Long.valueOf(defaultRotation);
   }
+
+  /** Gets current UI orientation based on the current device orientation and rotation. */
+  @Override
+  @NonNull
+  public String getUiOrientation() {
+    return serializeDeviceOrientation(deviceOrientationManager.getUIOrientation());
+  }
 }

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/GeneratedCameraXLibrary.java

@@ -1441,6 +1441,9 @@ void requestCameraPermissions(
     @NonNull
     String getTempFilePath(@NonNull String prefix, @NonNull String suffix);
 
+    @NonNull
+    Boolean isUsingSurfaceTextureForPreview();
+
     /** The codec used by SystemServicesHostApi. */
     static @NonNull MessageCodec<Object> getCodec() {
       return SystemServicesHostApiCodec.INSTANCE;
@@ -1508,6 +1511,29 @@ public void error(Throwable error) {
           channel.setMessageHandler(null);
         }
       }
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.SystemServicesHostApi.isUsingSurfaceTextureForPreview",
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<Object>();
+                try {
+                  Boolean output = api.isUsingSurfaceTextureForPreview();
+                  wrapped.add(0, output);
+                } catch (Throwable exception) {
+                  ArrayList<Object> wrappedError = wrapError(exception);
+                  wrapped = wrappedError;
+                }
+                reply.reply(wrapped);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
     }
   }
   /** Generated class from Pigeon that represents Flutter messages that can be called from Java. */
@@ -1550,6 +1576,9 @@ void startListeningForDeviceOrientationChange(
     @NonNull
     Long getDefaultDisplayRotation();
 
+    @NonNull
+    String getUiOrientation();
+
     /** The codec used by DeviceOrientationManagerHostApi. */
     static @NonNull MessageCodec<Object> getCodec() {
       return new StandardMessageCodec();
@@ -1634,6 +1663,29 @@ static void setup(
           channel.setMessageHandler(null);
         }
       }
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.DeviceOrientationManagerHostApi.getUiOrientation",
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<Object>();
+                try {
+                  String output = api.getUiOrientation();
+                  wrapped.add(0, output);
+                } catch (Throwable exception) {
+                  ArrayList<Object> wrappedError = wrapError(exception);
+                  wrapped = wrappedError;
+                }
+                reply.reply(wrapped);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
     }
   }
   /** Generated class from Pigeon that represents Flutter messages that can be called from Java. */
@@ -4389,6 +4441,9 @@ public interface Camera2CameraInfoHostApi {
     @NonNull
     String getCameraId(@NonNull Long identifier);
 
+    @NonNull
+    Long getSensorOrientation(@NonNull Long identifier);
+
     /** The codec used by Camera2CameraInfoHostApi. */
     static @NonNull MessageCodec<Object> getCodec() {
       return new StandardMessageCodec();
@@ -4481,6 +4536,33 @@ static void setup(
           channel.setMessageHandler(null);
         }
       }
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.Camera2CameraInfoHostApi.getSensorOrientation",
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<Object>();
+                ArrayList<Object> args = (ArrayList<Object>) message;
+                Number identifierArg = (Number) args.get(0);
+                try {
+                  Long output =
+                      api.getSensorOrientation(
+                          (identifierArg == null) ? null : identifierArg.longValue());
+                  wrapped.add(0, output);
+                } catch (Throwable exception) {
+                  ArrayList<Object> wrappedError = wrapError(exception);
+                  wrapped = wrappedError;
+                }
+                reply.reply(wrapped);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
     }
   }
   /** Generated class from Pigeon that represents Flutter messages that can be called from Java. */

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/PreviewHostApiImpl.java

@@ -4,7 +4,6 @@
 
 package io.flutter.plugins.camerax;
 
-import android.graphics.SurfaceTexture;
 import android.util.Size;
 import android.view.Surface;
 import androidx.annotation.NonNull;
@@ -25,7 +24,7 @@ public class PreviewHostApiImpl implements PreviewHostApi {
   private final TextureRegistry textureRegistry;
 
   @VisibleForTesting public @NonNull CameraXProxy cameraXProxy = new CameraXProxy();
-  @VisibleForTesting public @Nullable TextureRegistry.SurfaceTextureEntry flutterSurfaceTexture;
+  @VisibleForTesting public @Nullable TextureRegistry.SurfaceProducer flutterSurfaceProducer;
 
   public PreviewHostApiImpl(
       @NonNull BinaryMessenger binaryMessenger,
@@ -62,12 +61,11 @@ public void create(
   @Override
   public @NonNull Long setSurfaceProvider(@NonNull Long identifier) {
     Preview preview = getPreviewInstance(identifier);
-    flutterSurfaceTexture = textureRegistry.createSurfaceTexture();
-    SurfaceTexture surfaceTexture = flutterSurfaceTexture.surfaceTexture();
-    Preview.SurfaceProvider surfaceProvider = createSurfaceProvider(surfaceTexture);
+    flutterSurfaceProducer = textureRegistry.createSurfaceProducer();
+    Preview.SurfaceProvider surfaceProvider = createSurfaceProvider(flutterSurfaceProducer);
     preview.setSurfaceProvider(surfaceProvider);
 
-    return flutterSurfaceTexture.id();
+    return flutterSurfaceProducer.id();
   }
 
   /**
@@ -76,13 +74,13 @@ public void create(
    */
   @VisibleForTesting
   public @NonNull Preview.SurfaceProvider createSurfaceProvider(
-      @NonNull SurfaceTexture surfaceTexture) {
+      @NonNull TextureRegistry.SurfaceProducer surfaceProducer) {
     return new Preview.SurfaceProvider() {
       @Override
       public void onSurfaceRequested(@NonNull SurfaceRequest request) {
-        surfaceTexture.setDefaultBufferSize(
+        surfaceProducer.setSize(
             request.getResolution().getWidth(), request.getResolution().getHeight());
-        Surface flutterSurface = cameraXProxy.createSurface(surfaceTexture);
+        Surface flutterSurface = surfaceProducer.getSurface();
         request.provideSurface(
             flutterSurface,
             Executors.newSingleThreadExecutor(),
@@ -133,8 +131,8 @@ String getProvideSurfaceErrorDescription(int resultCode) {
    */
   @Override
   public void releaseFlutterSurfaceTexture() {
-    if (flutterSurfaceTexture != null) {
-      flutterSurfaceTexture.release();
+    if (flutterSurfaceProducer != null) {
+      flutterSurfaceProducer.release();
     }
   }
 

packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/SystemServicesHostApiImpl.java

@@ -6,6 +6,7 @@
 
 import android.app.Activity;
 import android.content.Context;
+import android.os.Build;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
@@ -103,4 +104,17 @@ public String getTempFilePath(@NonNull String prefix, @NonNull String suffix) {
           null);
     }
   }
+
+  /**
+   * Returns whether or not a {@code SurfaceTexture} backs the {@code Surface} provided to CameraX
+   * to build the camera preview.
+   *
+   * <p>This is determined by the engine, who uses {@code SurfaceTexture}s on Android SDKs 29 and
+   * below.
+   */
+  @Override
+  @NonNull
+  public Boolean isUsingSurfaceTextureForPreview() {
+    return Build.VERSION.SDK_INT <= 29;
+  }
 }

packages/camera/camera_android_camerax/android/src/test/java/io/flutter/plugins/camerax/DeviceOrientationManagerWrapperTest.java

@@ -93,4 +93,16 @@ public void getDefaultDisplayRotation_returnsExpectedRotation() {
 
     assertEquals(hostApi.getDefaultDisplayRotation(), Long.valueOf(defaultRotation));
   }
+
+  @Test
+  public void getUiOrientation_returnsExpectedOrientation() {
+    final DeviceOrientationManagerHostApiImpl hostApi =
+        new DeviceOrientationManagerHostApiImpl(mockBinaryMessenger, mockInstanceManager);
+    final DeviceOrientation uiOrientation = DeviceOrientation.LANDSCAPE_LEFT;
+
+    hostApi.deviceOrientationManager = mockDeviceOrientationManager;
+    when(mockDeviceOrientationManager.getUIOrientation()).thenReturn(uiOrientation);
+
+    assertEquals(hostApi.getUiOrientation(), uiOrientation.toString());
+  }
 }