[camerax] Implement resolution configuration (flutter#3799)

Adds resolution configuration for all camera use cases. Also makes minor updates to related documentation.

Fixes flutter/flutter#120462.

packages/camera/camera_android_camerax/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.0+17
+
+* Implements resolution configuration for all camera use cases.
+
 ## 0.5.0+16
 
 * Adds pub topics to package metadata.

packages/camera/camera_android_camerax/README.md

@@ -24,16 +24,18 @@ dependencies:
 
 ## Missing features and limitations
 
-### Resolution configuration \[[Issue #120462][120462]\]
 
-Any specified `ResolutionPreset` wll go unused in favor of CameraX defaults and
-`onCameraResolutionChanged` is unimplemented.
+### 240p resolution configuration for video recording
+
+240p resolution configuration for video recording is unsupported by CameraX,
+and thus, the plugin will fall back to 480p if configured with a
+`ResolutionPreset`.
 
 ### Locking/Unlocking capture orientation \[[Issue #125915][125915]\]
 
 `lockCaptureOrientation` & `unLockCaptureOrientation` are unimplemented.
 
-### Flash mode configuration \[[Issue #120715][120715]\]
+### Torch mode \[[Issue #120715][120715]\]
 
 Calling `setFlashMode` with mode `FlashMode.torch` currently does nothing.
 

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

@@ -9,7 +9,7 @@
 import androidx.camera.video.FallbackStrategy;
 import androidx.camera.video.Quality;
 import io.flutter.plugins.camerax.GeneratedCameraXLibrary.FallbackStrategyHostApi;
-import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQualityConstraint;
+import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQuality;
 import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoResolutionFallbackRule;
 
 /**
@@ -28,20 +28,18 @@ public class FallbackStrategyHostApiImpl implements FallbackStrategyHostApi {
   public static class FallbackStrategyProxy {
     /** Creates an instance of {@link FallbackStrategy}. */
     public @NonNull FallbackStrategy create(
-        @NonNull VideoQualityConstraint videoQualityConstraint,
-        @NonNull VideoResolutionFallbackRule fallbackRule) {
-      Quality videoQuality =
-          QualitySelectorHostApiImpl.getQualityFromVideoQualityConstraint(videoQualityConstraint);
+        @NonNull VideoQuality videoQuality, @NonNull VideoResolutionFallbackRule fallbackRule) {
+      Quality quality = QualitySelectorHostApiImpl.getQualityFromVideoQuality(videoQuality);
 
       switch (fallbackRule) {
         case HIGHER_QUALITY_OR_LOWER_THAN:
-          return FallbackStrategy.higherQualityOrLowerThan(videoQuality);
+          return FallbackStrategy.higherQualityOrLowerThan(quality);
         case HIGHER_QUALITY_THAN:
-          return FallbackStrategy.higherQualityThan(videoQuality);
+          return FallbackStrategy.higherQualityThan(quality);
         case LOWER_QUALITY_OR_HIGHER_THAN:
-          return FallbackStrategy.lowerQualityOrHigherThan(videoQuality);
+          return FallbackStrategy.lowerQualityOrHigherThan(quality);
         case LOWER_QUALITY_THAN:
-          return FallbackStrategy.lowerQualityThan(videoQuality);
+          return FallbackStrategy.lowerQualityThan(quality);
       }
       throw new IllegalArgumentException(
           "Specified fallback rule " + fallbackRule + " unrecognized.");
@@ -75,9 +73,8 @@ public FallbackStrategyHostApiImpl(@NonNull InstanceManager instanceManager) {
   @Override
   public void create(
       @NonNull Long identifier,
-      @NonNull VideoQualityConstraint videoQualityConstraint,
+      @NonNull VideoQuality videoQuality,
       @NonNull VideoResolutionFallbackRule fallbackRule) {
-    instanceManager.addDartCreatedInstance(
-        proxy.create(videoQualityConstraint, fallbackRule), identifier);
+    instanceManager.addDartCreatedInstance(proxy.create(videoQuality, fallbackRule), identifier);
   }
 }

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

@@ -112,7 +112,7 @@ private LiveDataSupportedType(final int index) {
    *
    * <p>See https://developer.android.com/reference/androidx/camera/video/Quality.
    */
-  public enum VideoQualityConstraint {
+  public enum VideoQuality {
     SD(0),
     HD(1),
     FHD(2),
@@ -122,12 +122,16 @@ public enum VideoQualityConstraint {
 
     final int index;
 
-    private VideoQualityConstraint(final int index) {
+    private VideoQuality(final int index) {
       this.index = index;
     }
   }
 
-  /** Fallback rules for selecting video resolution. */
+  /**
+   * Fallback rules for selecting video resolution.
+   *
+   * <p>See https://developer.android.com/reference/androidx/camera/video/FallbackStrategy.
+   */
   public enum VideoResolutionFallbackRule {
     HIGHER_QUALITY_OR_LOWER_THAN(0),
     HIGHER_QUALITY_THAN(1),
@@ -472,6 +476,59 @@ ArrayList<Object> toList() {
     }
   }
 
+  /**
+   * Convenience class for sending lists of [Quality]s.
+   *
+   * <p>Generated class from Pigeon that represents data sent in messages.
+   */
+  public static final class VideoQualityData {
+    private @NonNull VideoQuality quality;
+
+    public @NonNull VideoQuality getQuality() {
+      return quality;
+    }
+
+    public void setQuality(@NonNull VideoQuality setterArg) {
+      if (setterArg == null) {
+        throw new IllegalStateException("Nonnull field \"quality\" is null.");
+      }
+      this.quality = setterArg;
+    }
+
+    /** Constructor is non-public to enforce null safety; use Builder. */
+    VideoQualityData() {}
+
+    public static final class Builder {
+
+      private @Nullable VideoQuality quality;
+
+      public @NonNull Builder setQuality(@NonNull VideoQuality setterArg) {
+        this.quality = setterArg;
+        return this;
+      }
+
+      public @NonNull VideoQualityData build() {
+        VideoQualityData pigeonReturn = new VideoQualityData();
+        pigeonReturn.setQuality(quality);
+        return pigeonReturn;
+      }
+    }
+
+    @NonNull
+    ArrayList<Object> toList() {
+      ArrayList<Object> toListResult = new ArrayList<Object>(1);
+      toListResult.add(quality == null ? null : quality.index);
+      return toListResult;
+    }
+
+    static @NonNull VideoQualityData fromList(@NonNull ArrayList<Object> list) {
+      VideoQualityData pigeonResult = new VideoQualityData();
+      Object quality = list.get(0);
+      pigeonResult.setQuality(quality == null ? null : VideoQuality.values()[(int) quality]);
+      return pigeonResult;
+    }
+  }
+
   public interface Result<T> {
     @SuppressWarnings("UnknownNullness")
     void success(T result);
@@ -2991,6 +3048,8 @@ protected Object readValueOfType(byte type, @NonNull ByteBuffer buffer) {
       switch (type) {
         case (byte) 128:
           return ResolutionInfo.fromList((ArrayList<Object>) readValue(buffer));
+        case (byte) 129:
+          return VideoQualityData.fromList((ArrayList<Object>) readValue(buffer));
         default:
           return super.readValueOfType(type, buffer);
       }
@@ -3001,6 +3060,9 @@ protected void writeValue(@NonNull ByteArrayOutputStream stream, Object value) {
       if (value instanceof ResolutionInfo) {
         stream.write(128);
         writeValue(stream, ((ResolutionInfo) value).toList());
+      } else if (value instanceof VideoQualityData) {
+        stream.write(129);
+        writeValue(stream, ((VideoQualityData) value).toList());
       } else {
         super.writeValue(stream, value);
       }
@@ -3012,12 +3074,11 @@ public interface QualitySelectorHostApi {
 
     void create(
         @NonNull Long identifier,
-        @NonNull List<Long> videoQualityConstraintIndexList,
+        @NonNull List<VideoQualityData> videoQualityDataList,
         @Nullable Long fallbackStrategyId);
 
     @NonNull
-    ResolutionInfo getResolution(
-        @NonNull Long cameraInfoId, @NonNull VideoQualityConstraint quality);
+    ResolutionInfo getResolution(@NonNull Long cameraInfoId, @NonNull VideoQuality quality);
 
     /** The codec used by QualitySelectorHostApi. */
     static @NonNull MessageCodec<Object> getCodec() {
@@ -3039,12 +3100,13 @@ static void setup(
                 ArrayList<Object> wrapped = new ArrayList<Object>();
                 ArrayList<Object> args = (ArrayList<Object>) message;
                 Number identifierArg = (Number) args.get(0);
-                List<Long> videoQualityConstraintIndexListArg = (List<Long>) args.get(1);
+                List<VideoQualityData> videoQualityDataListArg =
+                    (List<VideoQualityData>) args.get(1);
                 Number fallbackStrategyIdArg = (Number) args.get(2);
                 try {
                   api.create(
                       (identifierArg == null) ? null : identifierArg.longValue(),
-                      videoQualityConstraintIndexListArg,
+                      videoQualityDataListArg,
                       (fallbackStrategyIdArg == null) ? null : fallbackStrategyIdArg.longValue());
                   wrapped.add(0, null);
                 } catch (Throwable exception) {
@@ -3069,8 +3131,8 @@ static void setup(
                 ArrayList<Object> wrapped = new ArrayList<Object>();
                 ArrayList<Object> args = (ArrayList<Object>) message;
                 Number cameraInfoIdArg = (Number) args.get(0);
-                VideoQualityConstraint qualityArg =
-                    args.get(1) == null ? null : VideoQualityConstraint.values()[(int) args.get(1)];
+                VideoQuality qualityArg =
+                    args.get(1) == null ? null : VideoQuality.values()[(int) args.get(1)];
                 try {
                   ResolutionInfo output =
                       api.getResolution(
@@ -3094,7 +3156,7 @@ public interface FallbackStrategyHostApi {
 
     void create(
         @NonNull Long identifier,
-        @NonNull VideoQualityConstraint quality,
+        @NonNull VideoQuality quality,
         @NonNull VideoResolutionFallbackRule fallbackRule);
 
     /** The codec used by FallbackStrategyHostApi. */
@@ -3117,8 +3179,8 @@ static void setup(
                 ArrayList<Object> wrapped = new ArrayList<Object>();
                 ArrayList<Object> args = (ArrayList<Object>) message;
                 Number identifierArg = (Number) args.get(0);
-                VideoQualityConstraint qualityArg =
-                    args.get(1) == null ? null : VideoQualityConstraint.values()[(int) args.get(1)];
+                VideoQuality qualityArg =
+                    args.get(1) == null ? null : VideoQuality.values()[(int) args.get(1)];
                 VideoResolutionFallbackRule fallbackRuleArg =
                     args.get(2) == null
                         ? null

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

@@ -13,7 +13,8 @@
 import androidx.camera.video.QualitySelector;
 import io.flutter.plugins.camerax.GeneratedCameraXLibrary.QualitySelectorHostApi;
 import io.flutter.plugins.camerax.GeneratedCameraXLibrary.ResolutionInfo;
-import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQualityConstraint;
+import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQuality;
+import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQualityData;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
@@ -34,12 +35,12 @@ public class QualitySelectorHostApiImpl implements QualitySelectorHostApi {
   public static class QualitySelectorProxy {
     /** Creates an instance of {@link QualitySelector}. */
     public @NonNull QualitySelector create(
-        @NonNull List<Long> videoQualityConstraintIndexList,
+        @NonNull List<VideoQualityData> videoQualityDataList,
         @Nullable FallbackStrategy fallbackStrategy) {
-      // Convert each index of VideoQualityConstraint to Quality.
+      // Convert each index of VideoQuality to Quality.
       List<Quality> qualityList = new ArrayList<Quality>();
-      for (Long qualityIndex : videoQualityConstraintIndexList) {
-        qualityList.add(getQualityConstant(qualityIndex));
+      for (VideoQualityData videoQualityData : videoQualityDataList) {
+        qualityList.add(getQualityFromVideoQuality(videoQualityData.getQuality()));
       }
 
       boolean fallbackStrategySpecified = fallbackStrategy != null;
@@ -57,12 +58,6 @@ public static class QualitySelectorProxy {
           ? QualitySelector.fromOrderedList(qualityList, fallbackStrategy)
           : QualitySelector.fromOrderedList(qualityList);
     }
-
-    /** Converts from index of {@link VideoQualityConstraint} to {@link Quality}. */
-    private Quality getQualityConstant(@NonNull Long qualityIndex) {
-      VideoQualityConstraint quality = VideoQualityConstraint.values()[qualityIndex.intValue()];
-      return getQualityFromVideoQualityConstraint(quality);
-    }
   }
 
   /**
@@ -93,11 +88,11 @@ public QualitySelectorHostApiImpl(@NonNull InstanceManager instanceManager) {
   @Override
   public void create(
       @NonNull Long identifier,
-      @NonNull List<Long> videoQualityConstraintIndexList,
+      @NonNull List<VideoQualityData> videoQualityDataList,
       @Nullable Long fallbackStrategyIdentifier) {
     instanceManager.addDartCreatedInstance(
         proxy.create(
-            videoQualityConstraintIndexList,
+            videoQualityDataList,
             fallbackStrategyIdentifier == null
                 ? null
                 : Objects.requireNonNull(instanceManager.getInstance(fallbackStrategyIdentifier))),
@@ -110,24 +105,23 @@ public void create(
    */
   @Override
   public @NonNull ResolutionInfo getResolution(
-      @NonNull Long cameraInfoIdentifier, @NonNull VideoQualityConstraint quality) {
+      @NonNull Long cameraInfoIdentifier, @NonNull VideoQuality quality) {
     final Size result =
         QualitySelector.getResolution(
             Objects.requireNonNull(instanceManager.getInstance(cameraInfoIdentifier)),
-            getQualityFromVideoQualityConstraint(quality));
+            getQualityFromVideoQuality(quality));
     return new ResolutionInfo.Builder()
         .setWidth(Long.valueOf(result.getWidth()))
         .setHeight(Long.valueOf(result.getHeight()))
         .build();
   }
 
   /**
-   * Converts the specified {@link VideoQualityConstraint} to a {@link Quality} that is understood
+   * Converts the specified {@link VideoQuality to a {@link Quality} that is understood
    * by CameraX.
    */
-  public static @NonNull Quality getQualityFromVideoQualityConstraint(
-      @NonNull VideoQualityConstraint videoQualityConstraint) {
-    switch (videoQualityConstraint) {
+  public static @NonNull Quality getQualityFromVideoQuality(@NonNull VideoQuality videoQuality) {
+    switch (videoQuality) {
       case SD:
         return Quality.SD;
       case HD:
@@ -142,8 +136,6 @@ public void create(
         return Quality.HIGHEST;
     }
     throw new IllegalArgumentException(
-        "VideoQualityConstraint "
-            + videoQualityConstraint
-            + " is unhandled by QualitySelectorHostApiImpl.");
+        "VideoQuality " + videoQuality + " is unhandled by QualitySelectorHostApiImpl.");
   }
 }

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

@@ -11,7 +11,7 @@
 
 import androidx.camera.video.FallbackStrategy;
 import androidx.camera.video.Quality;
-import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQualityConstraint;
+import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoQuality;
 import io.flutter.plugins.camerax.GeneratedCameraXLibrary.VideoResolutionFallbackRule;
 import org.junit.After;
 import org.junit.Before;
@@ -48,11 +48,11 @@ public void hostApiCreate_makesCallToCreateExpectedFallbackStrategy() {
 
     try (MockedStatic<FallbackStrategy> mockedFallbackStrategy =
         mockStatic(FallbackStrategy.class)) {
-      for (VideoQualityConstraint videoQualityConstraint : VideoQualityConstraint.values()) {
+      for (VideoQuality videoQuality : VideoQuality.values()) {
         for (VideoResolutionFallbackRule fallbackRule : VideoResolutionFallbackRule.values()) {
-          // Determine expected Quality based on videoQualityConstraint being tested.
+          // Determine expected Quality based on videoQuality being tested.
           Quality convertedQuality = null;
-          switch (videoQualityConstraint) {
+          switch (videoQuality) {
             case SD:
               convertedQuality = Quality.SD;
               break;
@@ -72,10 +72,7 @@ public void hostApiCreate_makesCallToCreateExpectedFallbackStrategy() {
               convertedQuality = Quality.HIGHEST;
               break;
             default:
-              fail(
-                  "The VideoQualityConstraint "
-                      + videoQualityConstraint.toString()
-                      + "is unhandled by this test.");
+              fail("The VideoQuality " + videoQuality.toString() + "is unhandled by this test.");
           }
           // Set Quality as final local variable to avoid error about using non-final (or effecitvely final) local variables in lambda expressions.
           final Quality expectedQuality = convertedQuality;
@@ -108,7 +105,7 @@ public void hostApiCreate_makesCallToCreateExpectedFallbackStrategy() {
                       + fallbackRule.toString()
                       + "is unhandled by this test.");
           }
-          hostApi.create(instanceIdentifier, videoQualityConstraint, fallbackRule);
+          hostApi.create(instanceIdentifier, videoQuality, fallbackRule);
           assertEquals(instanceManager.getInstance(instanceIdentifier), mockFallbackStrategy);
 
           // Clear/reset FallbackStrategy mock and InstanceManager.