[camera] add video stabilization

packages/camera/camera/AUTHORS

@@ -64,3 +64,4 @@ Aleksandr Yurkovskiy <sanekyy@gmail.com>
 Anton Borries <mail@antonborri.es>
 Alex Li <google@alexv525.com>
 Rahul Raj <64.rahulraj@gmail.com>
+Rui Craveiro <ruicraveiro@squarealfa.com>

packages/camera/camera/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.12.0
+
+* Adds support for video stabilization.
+
 ## 0.11.0+2
 
 * Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.

packages/camera/camera/example/pubspec.yaml

@@ -28,9 +28,10 @@ dev_dependencies:
   integration_test:
     sdk: flutter
 
-dependency_overrides:
-  camera_web:
-    path: ../../camera_web
-
 flutter:
   uses-material-design: true
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {camera: {path: ../../../camera/camera}, camera_android_camerax: {path: ../../../camera/camera_android_camerax}, 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

@@ -12,6 +12,7 @@ export 'package:camera_platform_interface/camera_platform_interface.dart'
         FocusMode,
         ImageFormatGroup,
         ResolutionPreset,
+        VideoStabilizationMode,
         XFile;
 
 export 'src/camera_controller.dart';

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

@@ -54,6 +54,7 @@ class CameraValue {
     this.recordingOrientation,
     this.isPreviewPaused = false,
     this.previewPauseOrientation,
+    this.videoStabilizationMode = VideoStabilizationMode.off,
   }) : _isRecordingPaused = isRecordingPaused;
 
   /// Creates a new camera controller state for an uninitialized controller.
@@ -72,6 +73,7 @@ class CameraValue {
           deviceOrientation: DeviceOrientation.portraitUp,
           isPreviewPaused: false,
           description: description,
+          videoStabilizationMode: VideoStabilizationMode.off,
         );
 
   /// 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 video stabilization mode in
+  final VideoStabilizationMode videoStabilizationMode;
+
   /// 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,
+    VideoStabilizationMode? videoStabilizationMode,
   }) {
     return CameraValue(
       isInitialized: isInitialized ?? this.isInitialized,
@@ -198,6 +204,8 @@ class CameraValue {
       previewPauseOrientation: previewPauseOrientation == null
           ? this.previewPauseOrientation
           : previewPauseOrientation.orNull,
+      videoStabilizationMode:
+          videoStabilizationMode ?? this.videoStabilizationMode,
     );
   }
 
@@ -219,6 +227,7 @@ class CameraValue {
         'recordingOrientation: $recordingOrientation, '
         'isPreviewPaused: $isPreviewPaused, '
         'previewPausedOrientation: $previewPauseOrientation, '
+        'videoStabilizationMode: $videoStabilizationMode, '
         'description: $description)';
   }
 }
@@ -689,6 +698,40 @@ class CameraController extends ValueNotifier<CameraValue> {
     }
   }
 
+  /// Set the video stabilization mode for the selected camera.
+  ///
+  /// On Android (when using camera_android_camerax) and on iOS
+  /// the supplied [mode] value should be a mode in the list returned
+  /// by [getVideoStabilizationSupportedModes].
+  ///
+  /// Throws a [CameraException] when a not supported video stabilization
+  /// mode is supplied.
+  Future<void> setVideoStabilizationMode(VideoStabilizationMode mode) async {
+    _throwIfNotInitialized('setVideoStabilizationMode');
+    try {
+      await CameraPlatform.instance.setVideoStabilizationMode(_cameraId, mode);
+      value = value.copyWith(videoStabilizationMode: mode);
+    } on PlatformException catch (e) {
+      throw CameraException(e.code, e.message);
+    }
+  }
+
+  /// Gets a list of video stabilization modes that are supported for the selected camera.
+  ///
+  /// Will return the list of supported video stabilization modes
+  /// on Android (when using camera_android_camerax package) and
+  /// on iOS. Will return an empty list on all other platforms.
+  Future<Iterable<VideoStabilizationMode>>
+      getVideoStabilizationSupportedModes() {
+    _throwIfNotInitialized('isVideoStabilizationModeSupported');
+    try {
+      return CameraPlatform.instance
+          .getVideoStabilizationSupportedModes(_cameraId);
+    } on PlatformException catch (e) {
+      throw CameraException(e.code, e.message);
+    }
+  }
+
   /// Sets the flash mode for taking pictures.
   Future<void> setFlashMode(FlashMode mode) async {
     try {

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.11.0+2
+version: 0.12.0
 
 environment:
   sdk: ^3.3.0
@@ -21,9 +21,9 @@ flutter:
         default_package: camera_web
 
 dependencies:
-  camera_android_camerax: ^0.6.5
-  camera_avfoundation: ^0.9.15
-  camera_platform_interface: ^2.6.0
+  camera_android_camerax: ^0.7.0
+  camera_avfoundation: ^0.10.0
+  camera_platform_interface: ^2.9.0
   camera_web: ^0.3.3
   flutter:
     sdk: flutter
@@ -37,3 +37,8 @@ dev_dependencies:
 
 topics:
   - camera
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {camera_android_camerax: {path: ../../camera/camera_android_camerax}, camera_avfoundation: {path: ../../camera/camera_avfoundation}, camera_platform_interface: {path: ../../camera/camera_platform_interface}, camera_web: {path: ../../camera/camera_web}}

packages/camera/camera/test/camera_preview_test.dart

@@ -132,6 +132,13 @@ class FakeController extends ValueNotifier<CameraValue>
 
   @override
   CameraDescription get description => value.description;
+
+  @override
+  Future<void> setVideoStabilizationMode(VideoStabilizationMode mode) async {}
+
+  @override
+  Future<Iterable<VideoStabilizationMode>>
+      getVideoStabilizationSupportedModes() async => <VideoStabilizationMode>[];
 }
 
 void main() {

packages/camera/camera/test/camera_test.dart

@@ -1190,6 +1190,133 @@ void main() {
           .called(4);
     });
 
+    test('getVideoStabilizationSupportedModes() returns empty list', () async {
+      // arrange
+      final CameraController cameraController = CameraController(
+          const CameraDescription(
+              name: 'cam',
+              lensDirection: CameraLensDirection.back,
+              sensorOrientation: 90),
+          ResolutionPreset.max);
+
+      await cameraController.initialize();
+      when(CameraPlatform.instance
+              .getVideoStabilizationSupportedModes(mockInitializeCamera))
+          .thenAnswer((_) async => <VideoStabilizationMode>[]);
+
+      // act
+      final Iterable<VideoStabilizationMode> modes =
+          await cameraController.getVideoStabilizationSupportedModes();
+
+      // assert
+      expect(modes, <VideoStabilizationMode>[]);
+    });
+
+    test('getVideoStabilizationSupportedModes() returns off', () async {
+      // arrange
+      final CameraController cameraController = CameraController(
+          const CameraDescription(
+              name: 'cam',
+              lensDirection: CameraLensDirection.back,
+              sensorOrientation: 90),
+          ResolutionPreset.max);
+
+      await cameraController.initialize();
+      when(CameraPlatform.instance
+              .getVideoStabilizationSupportedModes(mockInitializeCamera))
+          .thenAnswer((_) async =>
+              <VideoStabilizationMode>[VideoStabilizationMode.off]);
+
+      // act
+      final Iterable<VideoStabilizationMode> modes =
+          await cameraController.getVideoStabilizationSupportedModes();
+
+      // assert
+      expect(modes, <VideoStabilizationMode>[VideoStabilizationMode.off]);
+    });
+
+    test('getVideoStabilizationSupportedModes() returns all modes', () async {
+      // arrange
+      final CameraController cameraController = CameraController(
+          const CameraDescription(
+              name: 'cam',
+              lensDirection: CameraLensDirection.back,
+              sensorOrientation: 90),
+          ResolutionPreset.max);
+
+      await cameraController.initialize();
+      when(CameraPlatform.instance
+              .getVideoStabilizationSupportedModes(mockInitializeCamera))
+          .thenAnswer((_) async => <VideoStabilizationMode>[
+                VideoStabilizationMode.off,
+                VideoStabilizationMode.on,
+                VideoStabilizationMode.standard,
+                VideoStabilizationMode.cinematic,
+                VideoStabilizationMode.cinematicExtended,
+              ]);
+
+      // act
+      final Iterable<VideoStabilizationMode> modes =
+          await cameraController.getVideoStabilizationSupportedModes();
+
+      // assert
+      expect(modes, <VideoStabilizationMode>[
+        VideoStabilizationMode.off,
+        VideoStabilizationMode.on,
+        VideoStabilizationMode.standard,
+        VideoStabilizationMode.cinematic,
+        VideoStabilizationMode.cinematicExtended,
+      ]);
+    });
+
+    test('setVideoStabilizationMode() calls CameraPlatform', () async {
+      final CameraController cameraController = CameraController(
+          const CameraDescription(
+              name: 'cam',
+              lensDirection: CameraLensDirection.back,
+              sensorOrientation: 90),
+          ResolutionPreset.max);
+      await cameraController.initialize();
+
+      await cameraController
+          .setVideoStabilizationMode(VideoStabilizationMode.off);
+
+      verify(CameraPlatform.instance.setVideoStabilizationMode(
+              cameraController.cameraId, VideoStabilizationMode.off))
+          .called(1);
+    });
+
+    test(
+        'setVideoStabilizationMode() 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.setVideoStabilizationMode(
+              cameraController.cameraId,
+              VideoStabilizationMode.cinematicExtended))
+          .thenThrow(
+        PlatformException(
+          code: 'TEST_ERROR',
+          message: 'This is a test error message',
+        ),
+      );
+
+      expect(
+          cameraController.setVideoStabilizationMode(
+              VideoStabilizationMode.cinematicExtended),
+          throwsA(isA<CameraException>().having(
+            (CameraException error) => error.description,
+            'TEST_ERROR',
+            'This is a test error message',
+          )));
+    });
+
     test('pausePreview() calls $CameraPlatform', () async {
       final CameraController cameraController = CameraController(
           const CameraDescription(
@@ -1602,6 +1729,23 @@ class MockCameraPlatform extends Mock
         Invocation.method(#setExposureOffset, <Object?>[cameraId, offset]),
         returnValue: Future<double>.value(1.0),
       ) as Future<double>;
+
+  @override
+  Future<Iterable<VideoStabilizationMode>> getVideoStabilizationSupportedModes(
+      int cameraId) {
+    return super.noSuchMethod(
+      Invocation.method(
+          #getVideoStabilizationSupportedModes, <Object?>[cameraId]),
+      returnValue: Future<Iterable<VideoStabilizationMode>>.value(
+          <VideoStabilizationMode>[]),
+    ) as Future<Iterable<VideoStabilizationMode>>;
+  }
+
+  @override
+  Future<void> setVideoStabilizationMode(
+          int cameraId, VideoStabilizationMode mode) async =>
+      super.noSuchMethod(Invocation.method(
+          #setVideoStabilizationMode, <Object?>[cameraId, mode]));
 }
 
 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,
+        videoStabilizationMode: VideoStabilizationMode.cinematic,
       );
 
       expect(cameraValue, isA<CameraValue>());
@@ -47,6 +48,8 @@ void main() {
       expect(cameraValue.recordingOrientation, DeviceOrientation.portraitUp);
       expect(cameraValue.isPreviewPaused, false);
       expect(cameraValue.previewPauseOrientation, DeviceOrientation.portraitUp);
+      expect(
+          cameraValue.videoStabilizationMode, VideoStabilizationMode.cinematic);
     });
 
     test('Can be created as uninitialized', () {
@@ -70,6 +73,7 @@ void main() {
       expect(cameraValue.recordingOrientation, null);
       expect(cameraValue.isPreviewPaused, isFalse);
       expect(cameraValue.previewPauseOrientation, null);
+      expect(cameraValue.videoStabilizationMode, VideoStabilizationMode.off);
     });
 
     test('Can be copied with isInitialized', () {
@@ -94,6 +98,7 @@ void main() {
       expect(cameraValue.recordingOrientation, null);
       expect(cameraValue.isPreviewPaused, isFalse);
       expect(cameraValue.previewPauseOrientation, null);
+      expect(cameraValue.videoStabilizationMode, VideoStabilizationMode.off);
     });
 
     test('Has aspectRatio after setting size', () {
@@ -144,10 +149,11 @@ void main() {
         isPreviewPaused: true,
         previewPauseOrientation: DeviceOrientation.portraitUp,
         description: FakeController.fakeDescription,
+        videoStabilizationMode: VideoStabilizationMode.cinematicExtended,
       );
 
       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, videoStabilizationMode: VideoStabilizationMode.cinematicExtended, description: CameraDescription(, CameraLensDirection.back, 0))');
     });
   });
 }

packages/camera/camera_android/CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ## 0.10.9+9
 
+* Updates camera_platform_interface lib to 2.9.0.
 * Updates lint checks to ignore NewerVersionAvailable.
 
 ## 0.10.9+8

packages/camera/camera_android/example/pubspec.yaml

@@ -31,3 +31,8 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {camera_android: {path: ../../../camera/camera_android}, camera_platform_interface: {path: ../../../camera/camera_platform_interface}}