[camerax] Make fixes required to swap camera_android_camerax for camera_android

packages/camera/camera_android_camerax/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.6.5
+
+* Modifies `stopVideoRecording` to ensure the method only returns when the recorded video finishes saving to a file.
+* Adds empty implementation for `setDescriptionWhileRecording` and leaves a todo to add this feature.
+
 ## 0.6.4+1
 
 * Adds empty implementation for `prepareForVideoRecording` since this optimization is not used on Android.

packages/camera/camera_android_camerax/README.md

@@ -37,6 +37,9 @@ use cases, the plugin behaves according to the following:
     video recording and image streaming is supported, but concurrent video recording, image
     streaming, and image capture is not supported.
 
+### `setDescriptionWhileRecording` is unimplemented [Issue #148013][148013]
+`setDescriptionWhileRecording`, used to switch cameras while recording video, is currently unimplemented.
+
 ### 240p resolution configuration for video recording
 
 240p resolution configuration for video recording is unsupported by CameraX,
@@ -64,11 +67,4 @@ For more information on contributing to this plugin, see [`CONTRIBUTING.md`](CON
 [6]: https://developer.android.com/media/camera/camerax/architecture#combine-use-cases
 [7]: https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_3
 [8]: https://developer.android.com/reference/android/hardware/camera2/CameraMetadata#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED
-[120462]: https://github.com/flutter/flutter/issues/120462
-[125915]: https://github.com/flutter/flutter/issues/125915
-[120715]: https://github.com/flutter/flutter/issues/120715
-[120468]: https://github.com/flutter/flutter/issues/120468
-[120467]: https://github.com/flutter/flutter/issues/120467
-[125371]: https://github.com/flutter/flutter/issues/125371
-[126477]: https://github.com/flutter/flutter/issues/126477
-[127896]: https://github.com/flutter/flutter/issues/127896
+[148013]: https://github.com/flutter/flutter/issues/148013

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

@@ -2144,6 +2144,15 @@ public void create(@NonNull Long identifierArg, @NonNull Reply<Void> callback) {
           new ArrayList<Object>(Collections.singletonList(identifierArg)),
           channelReply -> callback.reply(null));
     }
+
+    public void onVideoRecordingFinalized(@NonNull Reply<Void> callback) {
+      BasicMessageChannel<Object> channel =
+          new BasicMessageChannel<>(
+              binaryMessenger,
+              "dev.flutter.pigeon.PendingRecordingFlutterApi.onVideoRecordingFinalized",
+              getCodec());
+      channel.send(null, channelReply -> callback.reply(null));
+    }
   }
   /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
   public interface RecordingHostApi {

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

@@ -22,4 +22,8 @@ public PendingRecordingFlutterApiImpl(
   void create(@NonNull PendingRecording pendingRecording, @Nullable Reply<Void> reply) {
     create(instanceManager.addHostCreatedInstance(pendingRecording), reply);
   }
+
+  void sendVideoRecordingFinalizedEvent(@NonNull Reply<Void> reply) {
+    super.onVideoRecordingFinalized(reply);
+  }
 }

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

@@ -24,6 +24,8 @@ public class PendingRecordingHostApiImpl implements PendingRecordingHostApi {
 
   @VisibleForTesting @NonNull public CameraXProxy cameraXProxy = new CameraXProxy();
 
+  @VisibleForTesting PendingRecordingFlutterApiImpl pendingRecordingFlutterApi;
+
   @VisibleForTesting SystemServicesFlutterApiImpl systemServicesFlutterApi;
 
   @VisibleForTesting RecordingFlutterApiImpl recordingFlutterApi;
@@ -37,6 +39,8 @@ public PendingRecordingHostApiImpl(
     this.context = context;
     systemServicesFlutterApi = cameraXProxy.createSystemServicesFlutterApiImpl(binaryMessenger);
     recordingFlutterApi = new RecordingFlutterApiImpl(binaryMessenger, instanceManager);
+    pendingRecordingFlutterApi =
+        new PendingRecordingFlutterApiImpl(binaryMessenger, instanceManager);
   }
 
   /** Sets the context, which is used to get the {@link Executor} needed to start the recording. */
@@ -77,6 +81,7 @@ public Executor getExecutor() {
   @VisibleForTesting
   public void handleVideoRecordEvent(@NonNull VideoRecordEvent event) {
     if (event instanceof VideoRecordEvent.Finalize) {
+      pendingRecordingFlutterApi.sendVideoRecordingFinalizedEvent(reply -> {});
       VideoRecordEvent.Finalize castedEvent = (VideoRecordEvent.Finalize) event;
       if (castedEvent.hasError()) {
         String cameraErrorMessage;

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

@@ -41,6 +41,7 @@ public class PendingRecordingTest {
   @Mock public RecordingFlutterApiImpl mockRecordingFlutterApi;
   @Mock public Context mockContext;
   @Mock public SystemServicesFlutterApiImpl mockSystemServicesFlutterApi;
+  @Mock public PendingRecordingFlutterApiImpl mockPendingRecordingFlutterApi;
   @Mock public VideoRecordEvent.Finalize event;
   @Mock public Throwable throwable;
 
@@ -80,6 +81,7 @@ public void testHandleVideoRecordEventSendsError() {
     PendingRecordingHostApiImpl pendingRecordingHostApi =
         new PendingRecordingHostApiImpl(mockBinaryMessenger, testInstanceManager, mockContext);
     pendingRecordingHostApi.systemServicesFlutterApi = mockSystemServicesFlutterApi;
+    pendingRecordingHostApi.pendingRecordingFlutterApi = mockPendingRecordingFlutterApi;
     final String eventMessage = "example failure message";
 
     when(event.hasError()).thenReturn(true);
@@ -89,9 +91,25 @@ public void testHandleVideoRecordEventSendsError() {
 
     pendingRecordingHostApi.handleVideoRecordEvent(event);
 
+    verify(mockPendingRecordingFlutterApi).sendVideoRecordingFinalizedEvent(any());
     verify(mockSystemServicesFlutterApi).sendCameraError(eq(eventMessage), any());
   }
 
+  @Test
+  public void handleVideoRecordEvent_SendsVideoRecordingFinalizedEvent() {
+    PendingRecordingHostApiImpl pendingRecordingHostApi =
+        new PendingRecordingHostApiImpl(mockBinaryMessenger, testInstanceManager, mockContext);
+    pendingRecordingHostApi.pendingRecordingFlutterApi = mockPendingRecordingFlutterApi;
+    final String eventMessage = "example failure message";
+
+    when(event.hasError()).thenReturn(false);
+    doNothing().when(mockSystemServicesFlutterApi).sendCameraError(any(), any());
+
+    pendingRecordingHostApi.handleVideoRecordEvent(event);
+
+    verify(mockPendingRecordingFlutterApi).sendVideoRecordingFinalizedEvent(any());
+  }
+
   @Test
   public void flutterApiCreateTest() {
     final PendingRecordingFlutterApiImpl spyPendingRecordingFlutterApi =

packages/camera/camera_android_camerax/example/integration_test/integration_test.dart

@@ -13,6 +13,7 @@ import 'package:camera_platform_interface/camera_platform_interface.dart';
 import 'package:flutter/painting.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
+import 'package:video_player/video_player.dart';
 
 void main() {
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
@@ -178,4 +179,86 @@ void main() {
       }
     }
   });
+
+  testWidgets('Video capture records valid video', (WidgetTester tester) async {
+    final List<CameraDescription> cameras = await availableCameras();
+    if (cameras.isEmpty) {
+      return;
+    }
+
+    final CameraController controller = CameraController(cameras[0],
+        mediaSettings:
+            const MediaSettings(resolutionPreset: ResolutionPreset.low));
+    await controller.initialize();
+    await controller.prepareForVideoRecording();
+
+    await controller.startVideoRecording();
+    final int recordingStart = DateTime.now().millisecondsSinceEpoch;
+
+    sleep(const Duration(seconds: 2));
+
+    final XFile file = await controller.stopVideoRecording();
+    final int recordingTime =
+        DateTime.now().millisecondsSinceEpoch - recordingStart;
+
+    final File videoFile = File(file.path);
+    final VideoPlayerController videoController = VideoPlayerController.file(
+      videoFile,
+    );
+    await videoController.initialize();
+    final int duration = videoController.value.duration.inMilliseconds;
+    await videoController.dispose();
+
+    expect(duration, lessThan(recordingTime));
+  });
+
+  testWidgets('Pause and resume video recording', (WidgetTester tester) async {
+    final List<CameraDescription> cameras = await availableCameras();
+    if (cameras.isEmpty) {
+      return;
+    }
+
+    final CameraController controller = CameraController(cameras[0],
+        mediaSettings:
+            const MediaSettings(resolutionPreset: ResolutionPreset.low));
+    await controller.initialize();
+    await controller.prepareForVideoRecording();
+
+    int startPause;
+    int timePaused = 0;
+
+    await controller.startVideoRecording();
+    final int recordingStart = DateTime.now().millisecondsSinceEpoch;
+    sleep(const Duration(milliseconds: 500));
+
+    await controller.pauseVideoRecording();
+    startPause = DateTime.now().millisecondsSinceEpoch;
+    sleep(const Duration(milliseconds: 500));
+    await controller.resumeVideoRecording();
+    timePaused += DateTime.now().millisecondsSinceEpoch - startPause;
+
+    sleep(const Duration(milliseconds: 500));
+
+    await controller.pauseVideoRecording();
+    startPause = DateTime.now().millisecondsSinceEpoch;
+    sleep(const Duration(milliseconds: 500));
+    await controller.resumeVideoRecording();
+    timePaused += DateTime.now().millisecondsSinceEpoch - startPause;
+
+    sleep(const Duration(milliseconds: 500));
+
+    final XFile file = await controller.stopVideoRecording();
+    final int recordingTime =
+        DateTime.now().millisecondsSinceEpoch - recordingStart;
+
+    final File videoFile = File(file.path);
+    final VideoPlayerController videoController = VideoPlayerController.file(
+      videoFile,
+    );
+    await videoController.initialize();
+    final int duration = videoController.value.duration.inMilliseconds;
+    await videoController.dispose();
+
+    expect(duration, lessThan(recordingTime - timePaused));
+  });
 }

packages/camera/camera_android_camerax/lib/src/android_camera_camerax.dart

@@ -113,6 +113,12 @@ class AndroidCameraCameraX extends CameraPlatform {
   @visibleForTesting
   String? videoOutputPath;
 
+  /// Stream queue to pick up finalized viceo recording events in
+  /// [stopVideoRecording].
+  final StreamQueue<void> videoRecordingFinalizedStreamQueue =
+      StreamQueue<void>(
+          PendingRecording.videoRecordingFinalizedStreamController.stream);
+
   /// Whether or not [preview] has been bound to the lifecycle of the camera by
   /// [createCamera].
   @visibleForTesting
@@ -122,7 +128,7 @@ class AndroidCameraCameraX extends CameraPlatform {
 
   /// The prefix used to create the filename for video recording files.
   @visibleForTesting
-  final String videoPrefix = 'MOV';
+  final String videoPrefix = 'REC';
 
   /// The [ImageCapture] instance that can be configured to capture a still image.
   @visibleForTesting
@@ -777,6 +783,15 @@ class AndroidCameraCameraX extends CameraPlatform {
     await _unbindUseCaseFromLifecycle(preview!);
   }
 
+  /// Sets the active camera while recording.
+  ///
+  /// Currently unsupported, so is a no-op.
+  @override
+  Future<void> setDescriptionWhileRecording(CameraDescription description) {
+    // TODO(camsim99): Implement this feature, see https://github.com/flutter/flutter/issues/148013.
+    return Future<void>.value();
+  }
+
   /// Resume the paused preview for the selected camera.
   ///
   /// [cameraId] not used.
@@ -955,8 +970,7 @@ class AndroidCameraCameraX extends CameraPlatform {
           .setTargetRotation(await proxy.getDefaultDisplayRotation());
     }
 
-    videoOutputPath =
-        await SystemServices.getTempFilePath(videoPrefix, '.temp');
+    videoOutputPath = await SystemServices.getTempFilePath(videoPrefix, '.mp4');
     pendingRecording = await recorder!.prepareRecording(videoOutputPath!);
     recording = await pendingRecording!.start();
 
@@ -979,21 +993,22 @@ class AndroidCameraCameraX extends CameraPlatform {
           'Attempting to stop a '
               'video recording while no recording is in progress.');
     }
+
+    /// Stop the active recording and wiat for the video recording to be finalized.
+    await recording!.close();
+    await videoRecordingFinalizedStreamQueue.next;
+    recording = null;
+    pendingRecording = null;
+
     if (videoOutputPath == null) {
-      // Stop the current active recording as we will be unable to complete it
-      // in this error case.
-      await recording!.close();
-      recording = null;
-      pendingRecording = null;
+      // Handle any errors with finalizing video recording.
       throw CameraException(
           'INVALID_PATH',
           'The platform did not return a path '
               'while reporting success. The platform should always '
               'return a valid path or report an error.');
     }
-    await recording!.close();
-    recording = null;
-    pendingRecording = null;
+
     await _unbindUseCaseFromLifecycle(videoCapture!);
     return XFile(videoOutputPath!);
   }

packages/camera/camera_android_camerax/lib/src/camerax_library.g.dart

@@ -1585,6 +1585,8 @@ abstract class PendingRecordingFlutterApi {
 
   void create(int identifier);
 
+  void onVideoRecordingFinalized();
+
   static void setup(PendingRecordingFlutterApi? api,
       {BinaryMessenger? binaryMessenger}) {
     {
@@ -1606,6 +1608,21 @@ abstract class PendingRecordingFlutterApi {
         });
       }
     }
+    {
+      final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.PendingRecordingFlutterApi.onVideoRecordingFinalized',
+          codec,
+          binaryMessenger: binaryMessenger);
+      if (api == null) {
+        channel.setMessageHandler(null);
+      } else {
+        channel.setMessageHandler((Object? message) async {
+          // ignore message
+          api.onVideoRecordingFinalized();
+          return;
+        });
+      }
+    }
   }
 }
 

packages/camera/camera_android_camerax/lib/src/pending_recording.dart

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'dart:async';
+
 import 'package:flutter/services.dart' show BinaryMessenger;
 import 'package:meta/meta.dart' show immutable;
 
@@ -30,6 +32,10 @@ class PendingRecording extends JavaObject {
 
   late final PendingRecordingHostApiImpl _api;
 
+  /// Stream that emits an event when the corresponding video recording is finalized.
+  static final StreamController<void> videoRecordingFinalizedStreamController =
+      StreamController<void>.broadcast();
+
   /// Starts the recording, making it an active recording.
   Future<Recording> start() {
     return _api.startFromInstance(this);
@@ -100,4 +106,9 @@ class PendingRecordingFlutterApiImpl extends PendingRecordingFlutterApi {
       );
     });
   }
+
+  @override
+  void onVideoRecordingFinalized() {
+    PendingRecording.videoRecordingFinalizedStreamController.add(null);
+  }
 }

packages/camera/camera_android_camerax/pigeons/camerax_library.dart

@@ -325,6 +325,8 @@ abstract class PendingRecordingHostApi {
 @FlutterApi()
 abstract class PendingRecordingFlutterApi {
   void create(int identifier);
+
+  void onVideoRecordingFinalized();
 }
 
 @HostApi(dartHostTestHandler: 'TestRecordingHostApi')

packages/camera/camera_android_camerax/pubspec.yaml

@@ -2,7 +2,7 @@ name: camera_android_camerax
 description: Android implementation of the camera plugin using the CameraX library.
 repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_android_camerax
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
-version: 0.6.4+1
+version: 0.6.5
 
 environment:
   sdk: ^3.1.0