[camera] add video stabilization

packages/camera/camera/AUTHORS

@@ -64,3 +64,4 @@ Aleksandr Yurkovskiy <[email protected]>
 Anton Borries <[email protected]>
 Alex Li <[email protected]>
 Rahul Raj <[email protected]>
+Rui Craveiro <[email protected]>

packages/camera/camera/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.12.0
+
+* Adds support for video stabilization.
+
 ## 0.11.1
 
 * Adds API support query for image streaming.

packages/camera/camera/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: {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)';
   }
 }
@@ -687,6 +696,80 @@ 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 [getSupportedVideoStabilizationModes].
+  ///
+  /// When [allowFallback] is true (default) and when
+  /// the camera supports any video stabilization other than
+  /// [VideoStabilizationMode.off], then the camera will
+  /// be set to the best video stabilization mode up to, and including, [mode].
+  ///
+  /// When either [allowFallback] is false or the only
+  /// supported video stabilization mode is [VideoStabilizationMode.off],
+  /// and if [mode] is not one of the supported modes,
+  /// then it throws an [ArgumentError].
+  Future<void> setVideoStabilizationMode(
+    VideoStabilizationMode mode, {
+    bool allowFallback = true,
+  }) async {
+    _throwIfNotInitialized('setVideoStabilizationMode');
+    try {
+      final VideoStabilizationMode requestMode =
+          allowFallback ? await _getVideoStabilizationFallbackMode(mode) : mode;
+
+      await CameraPlatform.instance
+          .setVideoStabilizationMode(_cameraId, requestMode);
+      value = value.copyWith(videoStabilizationMode: mode);
+    } on PlatformException catch (e) {
+      throw CameraException(e.code, e.message);
+    }
+  }
+
+  Future<VideoStabilizationMode> _getVideoStabilizationFallbackMode(
+      VideoStabilizationMode mode) async {
+    final Iterable<VideoStabilizationMode> supportedModes = await CameraPlatform
+        .instance
+        .getSupportedVideoStabilizationModes(_cameraId);
+
+    // if there are no supported modes or if the only supported mode is Off
+    // and something else is requested, then we throw an ArgumentError.
+    if (supportedModes.isEmpty ||
+        (mode != VideoStabilizationMode.off &&
+            supportedModes.every((VideoStabilizationMode sm) =>
+                sm == VideoStabilizationMode.off))) {
+      throw ArgumentError('Unavailable video stabilization mode.', 'mode');
+    }
+
+    VideoStabilizationMode requestMode = VideoStabilizationMode.off;
+    for (final VideoStabilizationMode supportedMode in supportedModes) {
+      if (supportedMode.index <= mode.index &&
+          supportedMode.index >= requestMode.index) {
+        requestMode = supportedMode;
+      }
+    }
+
+    return requestMode;
+  }
+
+  /// 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. Throws an [UnimplementedError] on all other platforms.
+  Future<Iterable<VideoStabilizationMode>>
+      getSupportedVideoStabilizationModes() {
+    _throwIfNotInitialized('isVideoStabilizationModeSupported');
+    try {
+      return CameraPlatform.instance
+          .getSupportedVideoStabilizationModes(_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.1
+version: 0.12.0
 
 environment:
   sdk: ^3.6.0
@@ -21,9 +21,9 @@ flutter:
         default_package: camera_web
 
 dependencies:
-  camera_android_camerax: ^0.6.13
-  camera_avfoundation: ^0.9.18
-  camera_platform_interface: ^2.9.0
+  camera_android_camerax: ^0.7.0
+  camera_avfoundation: ^0.10.0
+  camera_platform_interface: ^2.10.0
   camera_web: ^0.3.3
   flutter:
     sdk: flutter
@@ -38,3 +38,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

@@ -133,6 +133,16 @@ class FakeController extends ValueNotifier<CameraValue>
   @override
   CameraDescription get description => value.description;
 
+  @override
+  Future<void> setVideoStabilizationMode(
+    VideoStabilizationMode mode, {
+    bool allowFallback = true,
+  }) async {}
+
+  @override
+  Future<Iterable<VideoStabilizationMode>>
+      getSupportedVideoStabilizationModes() async => <VideoStabilizationMode>[];
+
   @override
   bool supportsImageStreaming() => true;
 }