Add photo mode support

packages/camera/camera/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.10.6
+
+* Adds `CaptureMode` as a parameter to allow configuring the camera for taking photos or videos. `CaptureMode.photo` selects an appropriate 4:3 aspect ratio depending on the `ResolutionPreset`.
+
 ## 0.10.5+5
 
 * Fixes bug where old camera resources were not disposed when switching between camera descriptions.

packages/camera/camera/example/pubspec.yaml

@@ -30,3 +30,8 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins
+dependency_overrides:
+   {camera: {path: ../../../camera/camera}, camera_android: {path: ../../../camera/camera_android}, camera_avfoundation: {path: ../../../camera/camera_avfoundation}, camera_platform_interface: {path: ../../../camera/camera_platform_interface}, camera_web: {path: ../../../camera/camera_web}}

packages/camera/camera/lib/camera.dart

@@ -7,6 +7,7 @@ export 'package:camera_platform_interface/camera_platform_interface.dart'
         CameraDescription,
         CameraException,
         CameraLensDirection,
+        CaptureMode,
         FlashMode,
         ExposureMode,
         FocusMode,

packages/camera/camera/lib/src/camera_controller.dart

@@ -50,6 +50,7 @@ class CameraValue {
     required this.focusPointSupported,
     required this.deviceOrientation,
     required this.description,
+    required this.captureMode,
     this.lockedCaptureOrientation,
     this.recordingOrientation,
     this.isPreviewPaused = false,
@@ -72,6 +73,7 @@ class CameraValue {
           deviceOrientation: DeviceOrientation.portraitUp,
           isPreviewPaused: false,
           description: description,
+          captureMode: CaptureMode.video,
         );
 
   /// True after [CameraController.initialize] has completed successfully.
@@ -148,6 +150,9 @@ class CameraValue {
   /// The properties of the camera device controlled by this controller.
   final CameraDescription description;
 
+  /// The current capture mode.
+  final CaptureMode captureMode;
+
   /// Creates a modified copy of the object.
   ///
   /// Explicitly specified fields get the specified value, all other fields get
@@ -171,6 +176,7 @@ class CameraValue {
     bool? isPreviewPaused,
     CameraDescription? description,
     Optional<DeviceOrientation>? previewPauseOrientation,
+    CaptureMode? captureMode,
   }) {
     return CameraValue(
       isInitialized: isInitialized ?? this.isInitialized,
@@ -198,6 +204,7 @@ class CameraValue {
       previewPauseOrientation: previewPauseOrientation == null
           ? this.previewPauseOrientation
           : previewPauseOrientation.orNull,
+      captureMode: captureMode ?? this.captureMode,
     );
   }
 
@@ -219,7 +226,8 @@ class CameraValue {
         'recordingOrientation: $recordingOrientation, '
         'isPreviewPaused: $isPreviewPaused, '
         'previewPausedOrientation: $previewPauseOrientation, '
-        'description: $description)';
+        'description: $description, '
+        'captureMode: $captureMode)';
   }
 }
 
@@ -343,6 +351,8 @@ class CameraController extends ValueNotifier<CameraValue> {
             .then((CameraInitializedEvent event) => event.exposureMode),
         focusMode: await initializeCompleter.future
             .then((CameraInitializedEvent event) => event.focusMode),
+        captureMode: await initializeCompleter.future
+            .then((CameraInitializedEvent event) => event.captureMode),
         exposurePointSupported: await initializeCompleter.future.then(
             (CameraInitializedEvent event) => event.exposurePointSupported),
         focusPointSupported: await initializeCompleter.future
@@ -529,6 +539,12 @@ class CameraController extends ValueNotifier<CameraValue> {
         'startVideoRecording was called when a recording is already started.',
       );
     }
+    if (value.captureMode == CaptureMode.photo) {
+      throw CameraException(
+        'The camera is configured for still images.',
+        'startVideoRecording was called when the camera was configured for still images.',
+      );
+    }
 
     Function(CameraImageData image)? streamCallback;
     if (onAvailable != null) {
@@ -610,6 +626,13 @@ class CameraController extends ValueNotifier<CameraValue> {
         'resumeVideoRecording was called when no video is recording.',
       );
     }
+    if (value.captureMode == CaptureMode.photo) {
+      throw CameraException(
+        'The camera is configured for still images.',
+        'resumeVideoRecording was called when the camera was configured for still images.',
+      );
+    }
+
     try {
       await CameraPlatform.instance.resumeVideoRecording(_cameraId);
       value = value.copyWith(isRecordingPaused: false);
@@ -682,6 +705,18 @@ class CameraController extends ValueNotifier<CameraValue> {
     }
   }
 
+  /// Sets the capture mode for the camera.
+  Future<void> setCaptureMode(CaptureMode mode) async {
+    _throwIfNotInitialized('setCaptureMode');
+    try {
+      final Size? previewSize =
+          await CameraPlatform.instance.setCaptureMode(_cameraId, mode);
+      value = value.copyWith(captureMode: mode, previewSize: previewSize);
+    } on PlatformException catch (e) {
+      throw CameraException(e.code, e.message);
+    }
+  }
+
   /// Sets the exposure point for automatically determining the exposure value.
   ///
   /// Supplying a `null` value will reset the exposure point to it's default

packages/camera/camera/pubspec.yaml

@@ -4,7 +4,7 @@ description: A Flutter plugin for controlling the camera. Supports previewing
   Dart.
 repository: https://github.com/flutter/packages/tree/main/packages/camera/camera
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
-version: 0.10.5+5
+version: 0.11.0
 
 environment:
   sdk: ">=2.19.0 <4.0.0"
@@ -21,10 +21,10 @@ flutter:
         default_package: camera_web
 
 dependencies:
-  camera_android: ^0.10.7
-  camera_avfoundation: ^0.9.13
-  camera_platform_interface: ^2.5.0
-  camera_web: ^0.3.1
+  camera_android: ^0.10.9
+  camera_avfoundation: ^0.9.14
+  camera_platform_interface: ^2.5.3
+  camera_web: ^0.3.2
   flutter:
     sdk: flutter
   flutter_plugin_android_lifecycle: ^2.0.2
@@ -39,3 +39,8 @@ dev_dependencies:
 
 topics:
   - camera
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins
+dependency_overrides:
+   {camera_android: {path: ../../camera/camera_android}, camera_avfoundation: {path: ../../camera/camera_avfoundation}, camera_platform_interface: {path: ../../camera/camera_platform_interface}}

packages/camera/camera/test/camera_preview_test.dart

@@ -120,6 +120,9 @@ class FakeController extends ValueNotifier<CameraValue>
   @override
   Future<void> setDescription(CameraDescription description) async {}
 
+  @override
+  Future<void> setCaptureMode(CaptureMode captureMode) async {}
+
   @override
   CameraDescription get description => value.description;
 }

packages/camera/camera/test/camera_test.dart

@@ -36,6 +36,7 @@ CameraInitializedEvent get mockOnCameraInitializedEvent =>
       true,
       FocusMode.auto,
       true,
+      CaptureMode.video,
     );
 
 DeviceOrientationChangedEvent get mockOnDeviceOrientationChangedEvent =>
@@ -1401,6 +1402,52 @@ void main() {
             'This is a test error message',
           )));
     });
+
+    test('setCaptureMode() calls $CameraPlatform', () async {
+      final CameraController cameraController = CameraController(
+          const CameraDescription(
+              name: 'cam',
+              lensDirection: CameraLensDirection.back,
+              sensorOrientation: 90),
+          ResolutionPreset.max);
+      await cameraController.initialize();
+      when(CameraPlatform.instance
+              .setCaptureMode(mockInitializeCamera, CaptureMode.photo))
+          .thenAnswer((_) => Future<Size?>.value(const Size(640, 480)));
+      await cameraController.setCaptureMode(CaptureMode.photo);
+
+      verify(CameraPlatform.instance
+              .setCaptureMode(cameraController.cameraId, CaptureMode.photo))
+          .called(1);
+    });
+
+    test('setCaptureMode throws $CameraException on $PlatformException',
+        () async {
+      final CameraController cameraController = CameraController(
+          const CameraDescription(
+              name: 'cam',
+              lensDirection: CameraLensDirection.back,
+              sensorOrientation: 90),
+          ResolutionPreset.max);
+      await cameraController.initialize();
+
+      when(CameraPlatform.instance
+              .setCaptureMode(cameraController.cameraId, CaptureMode.photo))
+          .thenThrow(
+        PlatformException(
+          code: 'TEST_ERROR',
+          message: 'This is a test error message',
+        ),
+      );
+
+      expect(
+          cameraController.setCaptureMode(CaptureMode.photo),
+          throwsA(isA<CameraException>().having(
+            (CameraException error) => error.description,
+            'TEST_ERROR',
+            'This is a test error message',
+          )));
+    });
   });
 }
 
@@ -1554,6 +1601,13 @@ class MockCameraPlatform extends Mock
         Invocation.method(#setExposureOffset, <Object?>[cameraId, offset]),
         returnValue: Future<double>.value(1.0),
       ) as Future<double>;
+
+  @override
+  Future<Size?> setCaptureMode(int? cameraId, CaptureMode mode) async =>
+      super.noSuchMethod(
+        Invocation.method(#setCaptureMode, <Object?>[cameraId, mode]),
+        returnValue: Future<Size?>.value(const Size(680, 480)),
+      ) as Future<Size?>;
 }
 
 class MockCameraDescription extends CameraDescription {

packages/camera/camera/test/camera_value_test.dart

@@ -28,6 +28,7 @@ void main() {
         focusPointSupported: true,
         previewPauseOrientation: DeviceOrientation.portraitUp,
         description: FakeController.fakeDescription,
+        captureMode: CaptureMode.video,
       );
 
       expect(cameraValue, isA<CameraValue>());
@@ -144,10 +145,11 @@ void main() {
         isPreviewPaused: true,
         previewPauseOrientation: DeviceOrientation.portraitUp,
         description: FakeController.fakeDescription,
+        captureMode: CaptureMode.video,
       );
 
       expect(cameraValue.toString(),
-          'CameraValue(isRecordingVideo: false, isInitialized: false, errorDescription: null, previewSize: Size(10.0, 10.0), isStreamingImages: false, flashMode: FlashMode.auto, exposureMode: ExposureMode.auto, focusMode: FocusMode.auto, exposurePointSupported: true, focusPointSupported: true, deviceOrientation: DeviceOrientation.portraitUp, lockedCaptureOrientation: DeviceOrientation.portraitUp, recordingOrientation: DeviceOrientation.portraitUp, isPreviewPaused: true, previewPausedOrientation: DeviceOrientation.portraitUp, description: CameraDescription(, CameraLensDirection.back, 0))');
+          'CameraValue(isRecordingVideo: false, isInitialized: false, errorDescription: null, previewSize: Size(10.0, 10.0), isStreamingImages: false, flashMode: FlashMode.auto, exposureMode: ExposureMode.auto, focusMode: FocusMode.auto, exposurePointSupported: true, focusPointSupported: true, deviceOrientation: DeviceOrientation.portraitUp, lockedCaptureOrientation: DeviceOrientation.portraitUp, recordingOrientation: DeviceOrientation.portraitUp, isPreviewPaused: true, previewPausedOrientation: DeviceOrientation.portraitUp, description: CameraDescription(, CameraLensDirection.back, 0), captureMode: CaptureMode.video)');
     });
   });
 }

packages/camera/camera_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.10.9
+
+* Adds `CaptureMode` as a parameter to allow configuring the camera for taking photos or videos. `CaptureMode.photo` selects an appropriate 4:3 aspect ratio depending on the `ResolutionPreset`.
+
 ## 0.10.8+13
 
 * Updates annotations lib to 1.7.0.

packages/camera/camera_android/android/src/main/java/io/flutter/plugins/camera/Camera.java

@@ -59,6 +59,7 @@
 import io.flutter.plugins.camera.media.ImageStreamReader;
 import io.flutter.plugins.camera.media.MediaRecorderBuilder;
 import io.flutter.plugins.camera.types.CameraCaptureProperties;
+import io.flutter.plugins.camera.types.CaptureMode;
 import io.flutter.plugins.camera.types.CaptureTimeoutsWrapper;
 import io.flutter.view.TextureRegistry.SurfaceTextureEntry;
 import java.io.File;
@@ -68,6 +69,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.concurrent.Executors;
 
 @FunctionalInterface
@@ -207,7 +209,12 @@ public Camera(
     this.resolutionPreset = resolutionPreset;
     this.cameraFeatures =
         CameraFeatures.init(
-            cameraFeatureFactory, cameraProperties, activity, dartMessenger, resolutionPreset);
+            cameraFeatureFactory,
+            cameraProperties,
+            activity,
+            dartMessenger,
+            resolutionPreset,
+            CaptureMode.video);
 
     // Create capture callback.
     captureTimeouts = new CaptureTimeoutsWrapper(3000, 3000);
@@ -326,7 +333,8 @@ public void onOpened(@NonNull CameraDevice device) {
                     cameraFeatures.getExposureLock().getValue(),
                     cameraFeatures.getAutoFocus().getValue(),
                     cameraFeatures.getExposurePoint().checkIsSupported(),
-                    cameraFeatures.getFocusPoint().checkIsSupported());
+                    cameraFeatures.getFocusPoint().checkIsSupported(),
+                    resolutionFeature.getCaptureMode());
               }
             } catch (Exception e) {
               if (BuildConfig.DEBUG) {
@@ -409,7 +417,6 @@ private void createCaptureSession(
         resolutionFeature.getPreviewSize().getHeight());
     Surface flutterSurface = new Surface(surfaceTexture);
     previewRequestBuilder.addTarget(flutterSurface);
-
     List<Surface> remainingSurfaces = Arrays.asList(surfaces);
     if (templateType != CameraDevice.TEMPLATE_PREVIEW) {
       // If it is not preview mode, add all surfaces as targets
@@ -502,7 +509,7 @@ private void createCaptureSession(
     cameraDevice.createCaptureSession(surfaces, callback, backgroundHandler);
   }
 
-  // Send a repeating request to refresh  capture session.
+  // Send a repeating request to refresh capture session.
   void refreshPreviewCaptureSession(
       @Nullable Runnable onSuccessCallback, @NonNull ErrorCallback onErrorCallback) {
     Log.i(TAG, "refreshPreviewCaptureSession");
@@ -972,6 +979,36 @@ public void setFocusMode(final Result result, @NonNull FocusMode newMode) {
     }
   }
 
+  /**
+   * Sets new capture mode from dart
+   *
+   * @param result Flutter result.
+   * @param newMode New mode.
+   */
+  public void setCaptureMode(@NonNull final Result result, @NonNull CaptureMode newMode) {
+    // Re-initalises the camera with the appropriate capture mode.
+    stopAndReleaseCamera();
+    cameraFeatures =
+        CameraFeatures.init(
+            cameraFeatureFactory,
+            cameraProperties,
+            activity,
+            dartMessenger,
+            resolutionPreset,
+            newMode);
+    try {
+      open(imageFormatGroup);
+    } catch (CameraAccessException e) {
+      result.error("setDescriptionWhileRecordingFailed", e.getMessage(), null);
+    }
+
+    final ResolutionFeature resolutionFeature = cameraFeatures.getResolution();
+    Map<String, Integer> previewSize = new HashMap<String, Integer>();
+    previewSize.put("previewWidth", resolutionFeature.getPreviewSize().getWidth());
+    previewSize.put("previewHeight", resolutionFeature.getPreviewSize().getHeight());
+    result.success(previewSize);
+  }
+
   /**
    * Sets new focus point from dart.
    *
@@ -1309,7 +1346,12 @@ public void setDescriptionWhileRecording(
     cameraProperties = properties;
     cameraFeatures =
         CameraFeatures.init(
-            cameraFeatureFactory, cameraProperties, activity, dartMessenger, resolutionPreset);
+            cameraFeatureFactory,
+            cameraProperties,
+            activity,
+            dartMessenger,
+            resolutionPreset,
+            cameraFeatures.getResolution().getCaptureMode());
     cameraFeatures.setAutoFocus(
         cameraFeatureFactory.createAutoFocusFeature(cameraProperties, true));
     try {