[camera]request access permission for audio

packages/camera/camera/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.6
+
+* Adds audio access permission handling logic on iOS to fix an issue with `prepareForVideoRecording` not awaiting for the audio permission request result.
+
 ## 0.9.5+1
 
 * Suppresses warnings for pre-iOS-11 codepaths.

packages/camera/camera/example/ios/RunnerTests/CameraCaptureSessionQueueRaceConditionTests.m

@@ -29,11 +29,12 @@ - (void)testFixForCaptureSessionQueueNullPointerCrashDueToRaceCondition {
                     result:^(id _Nullable result) {
                       [disposeExpectation fulfill];
                     }];
-  [camera createCameraOnSessionQueueWithCreateMethodCall:createCall
-                                                  result:[[FLTThreadSafeFlutterResult alloc]
-                                                             initWithResult:^(id _Nullable result) {
-                                                               [createExpectation fulfill];
-                                                             }]];
+  [camera createCameraOnCaptureSessionQueueWithCreateMethodCall:createCall
+                                                         result:[[FLTThreadSafeFlutterResult alloc]
+                                                                    initWithResult:^(
+                                                                        id _Nullable result) {
+                                                                      [createExpectation fulfill];
+                                                                    }]];
   [self waitForExpectationsWithTimeout:1 handler:nil];
   // `captureSessionQueue` must not be nil after `create` call. Otherwise a nil
   // `captureSessionQueue` passed into `AVCaptureVideoDataOutput::setSampleBufferDelegate:queue:`

packages/camera/camera/example/ios/RunnerTests/CameraMethodChannelTests.m

@@ -36,7 +36,7 @@ - (void)testCreate_ShouldCallResultOnMainThread {
       methodCallWithMethodName:@"create"
                      arguments:@{@"resolutionPreset" : @"medium", @"enableAudio" : @(1)}];
 
-  [camera createCameraOnSessionQueueWithCreateMethodCall:call result:resultObject];
+  [camera createCameraOnCaptureSessionQueueWithCreateMethodCall:call result:resultObject];
   [self waitForExpectationsWithTimeout:1 handler:nil];
 
   // Verify the result

packages/camera/camera/example/ios/RunnerTests/CameraPermissionTests.m

@@ -15,6 +15,8 @@ @interface CameraPermissionTests : XCTestCase
 
 @implementation CameraPermissionTests
 
+#pragma mark - camera permissions
+
 - (void)testRequestCameraPermission_completeWithoutErrorIfPrevoiuslyAuthorized {
   XCTestExpectation *expectation =
       [self expectationWithDescription:
@@ -24,7 +26,7 @@ - (void)testRequestCameraPermission_completeWithoutErrorIfPrevoiuslyAuthorized {
   OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeVideo])
       .andReturn(AVAuthorizationStatusAuthorized);
 
-  FLTRequestCameraPermissionWithCompletionHandler(^(FlutterError *error) {
+  FLTRequestCameraPermission(/*forAudio*/ false, ^(FlutterError *error) {
     if (error == nil) {
       [expectation fulfill];
     }
@@ -44,7 +46,7 @@ - (void)testRequestCameraPermission_completeWithErrorIfPreviouslyDenied {
   id mockDevice = OCMClassMock([AVCaptureDevice class]);
   OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeVideo])
       .andReturn(AVAuthorizationStatusDenied);
-  FLTRequestCameraPermissionWithCompletionHandler(^(FlutterError *error) {
+  FLTRequestCameraPermission(/*forAudio*/ false, ^(FlutterError *error) {
     if ([error isEqual:expectedError]) {
       [expectation fulfill];
     }
@@ -63,7 +65,7 @@ - (void)testRequestCameraPermission_completeWithErrorIfRestricted {
   OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeVideo])
       .andReturn(AVAuthorizationStatusRestricted);
 
-  FLTRequestCameraPermissionWithCompletionHandler(^(FlutterError *error) {
+  FLTRequestCameraPermission(/*forAudio*/ false, ^(FlutterError *error) {
     if ([error isEqual:expectedError]) {
       [expectation fulfill];
     }
@@ -85,7 +87,7 @@ - (void)testRequestCameraPermission_completeWithoutErrorIfUserGrantAccess {
                                 return YES;
                               }]]);
 
-  FLTRequestCameraPermissionWithCompletionHandler(^(FlutterError *error) {
+  FLTRequestCameraPermission(/*forAudio*/ false, ^(FlutterError *error) {
     if (error == nil) {
       [grantedExpectation fulfill];
     }
@@ -111,7 +113,113 @@ - (void)testRequestCameraPermission_completeWithErrorIfUserDenyAccess {
                                 block(NO);
                                 return YES;
                               }]]);
-  FLTRequestCameraPermissionWithCompletionHandler(^(FlutterError *error) {
+  FLTRequestCameraPermission(/*forAudio*/ false, ^(FlutterError *error) {
+    if ([error isEqual:expectedError]) {
+      [expectation fulfill];
+    }
+  });
+
+  [self waitForExpectationsWithTimeout:1 handler:nil];
+}
+
+#pragma mark - audio permissions
+
+- (void)testRequestAudioPermission_completeWithoutErrorIfPrevoiuslyAuthorized {
+  XCTestExpectation *expectation =
+      [self expectationWithDescription:
+                @"Must copmlete without error if audio access was previously authorized."];
+
+  id mockDevice = OCMClassMock([AVCaptureDevice class]);
+  OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeAudio])
+      .andReturn(AVAuthorizationStatusAuthorized);
+
+  FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
+    if (error == nil) {
+      [expectation fulfill];
+    }
+  });
+  [self waitForExpectationsWithTimeout:1 handler:nil];
+}
+- (void)testRequestAudioPermission_completeWithErrorIfPreviouslyDenied {
+  XCTestExpectation *expectation =
+      [self expectationWithDescription:
+                @"Must complete with error if audio access was previously denied."];
+  FlutterError *expectedError =
+      [FlutterError errorWithCode:@"AudioAccessDeniedWithoutPrompt"
+                          message:@"User has previously denied the audio access request. Go to "
+                                  @"Settings to enable audio access."
+                          details:nil];
+
+  id mockDevice = OCMClassMock([AVCaptureDevice class]);
+  OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeAudio])
+      .andReturn(AVAuthorizationStatusDenied);
+  FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
+    if ([error isEqual:expectedError]) {
+      [expectation fulfill];
+    }
+  });
+  [self waitForExpectationsWithTimeout:1 handler:nil];
+}
+
+- (void)testRequestAudioPermission_completeWithErrorIfRestricted {
+  XCTestExpectation *expectation =
+      [self expectationWithDescription:@"Must complete with error if audio access is restricted."];
+  FlutterError *expectedError = [FlutterError errorWithCode:@"AudioAccessRestricted"
+                                                    message:@"Audio access is restricted. "
+                                                    details:nil];
+
+  id mockDevice = OCMClassMock([AVCaptureDevice class]);
+  OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeAudio])
+      .andReturn(AVAuthorizationStatusRestricted);
+
+  FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
+    if ([error isEqual:expectedError]) {
+      [expectation fulfill];
+    }
+  });
+  [self waitForExpectationsWithTimeout:1 handler:nil];
+}
+
+- (void)testRequestAudioPermission_completeWithoutErrorIfUserGrantAccess {
+  XCTestExpectation *grantedExpectation = [self
+      expectationWithDescription:@"Must complete without error if user choose to grant access"];
+
+  id mockDevice = OCMClassMock([AVCaptureDevice class]);
+  OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeAudio])
+      .andReturn(AVAuthorizationStatusNotDetermined);
+  // Mimic user choosing "allow" in permission dialog.
+  OCMStub([mockDevice requestAccessForMediaType:AVMediaTypeAudio
+                              completionHandler:[OCMArg checkWithBlock:^BOOL(void (^block)(BOOL)) {
+                                block(YES);
+                                return YES;
+                              }]]);
+
+  FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
+    if (error == nil) {
+      [grantedExpectation fulfill];
+    }
+  });
+  [self waitForExpectationsWithTimeout:1 handler:nil];
+}
+
+- (void)testRequestAudioPermission_completeWithErrorIfUserDenyAccess {
+  XCTestExpectation *expectation =
+      [self expectationWithDescription:@"Must complete with error if user choose to deny access"];
+  FlutterError *expectedError = [FlutterError errorWithCode:@"AudioAccessDenied"
+                                                    message:@"User denied the audio access request."
+                                                    details:nil];
+
+  id mockDevice = OCMClassMock([AVCaptureDevice class]);
+  OCMStub([mockDevice authorizationStatusForMediaType:AVMediaTypeAudio])
+      .andReturn(AVAuthorizationStatusNotDetermined);
+
+  // Mimic user choosing "deny" in permission dialog.
+  OCMStub([mockDevice requestAccessForMediaType:AVMediaTypeAudio
+                              completionHandler:[OCMArg checkWithBlock:^BOOL(void (^block)(BOOL)) {
+                                block(NO);
+                                return YES;
+                              }]]);
+  FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
     if ([error isEqual:expectedError]) {
       [expectation fulfill];
     }

packages/camera/camera/ios/Classes/CameraPermissionUtils.h

@@ -13,8 +13,11 @@ typedef void (^FLTCameraPermissionRequestCompletionHandler)(FlutterError *);
 /// screen. Otherwise AVFoundation simply returns the user's previous choice, and in this case the
 /// user will have to update the choice in Settings app.
 ///
+///
+/// @param forAudio Requests for `AVMediaTypeAudio` permission if `forAudio` is true, and
+/// `AVMediaTypeVideo` permission otherwise.
 /// @param handler if access permission is (or was previously) granted, completion handler will be
 /// called without error; Otherwise completion handler will be called with error. Handler can be
 /// called on an arbitrary dispatch queue.
-extern void FLTRequestCameraPermissionWithCompletionHandler(
-    FLTCameraPermissionRequestCompletionHandler handler);
+extern void FLTRequestCameraPermission(BOOL forAudio,
+                                       FLTCameraPermissionRequestCompletionHandler handler);

packages/camera/camera/ios/Classes/CameraPermissionUtils.m

@@ -5,34 +5,73 @@
 @import AVFoundation;
 #import "CameraPermissionUtils.h"
 
-void FLTRequestCameraPermissionWithCompletionHandler(
-    FLTCameraPermissionRequestCompletionHandler handler) {
-  switch ([AVCaptureDevice authorizationStatusForMediaType:AVMediaTypeVideo]) {
+void FLTRequestCameraPermission(BOOL forAudio,
+                                FLTCameraPermissionRequestCompletionHandler handler) {
+  AVMediaType mediaType;
+  if (forAudio) {
+    mediaType = AVMediaTypeAudio;
+  } else {
+    mediaType = AVMediaTypeVideo;
+  }
+
+  switch ([AVCaptureDevice authorizationStatusForMediaType:mediaType]) {
     case AVAuthorizationStatusAuthorized:
       handler(nil);
       break;
-    case AVAuthorizationStatusDenied:
-      handler([FlutterError errorWithCode:@"CameraAccessDeniedWithoutPrompt"
-                                  message:@"User has previously denied the camera access request. "
-                                          @"Go to Settings to enable camera access."
-                                  details:nil]);
+    case AVAuthorizationStatusDenied: {
+      FlutterError *flutterError;
+      if (forAudio) {
+        flutterError =
+            [FlutterError errorWithCode:@"AudioAccessDeniedWithoutPrompt"
+                                message:@"User has previously denied the audio access request. "
+                                        @"Go to Settings to enable audio access."
+                                details:nil];
+      } else {
+        flutterError =
+            [FlutterError errorWithCode:@"CameraAccessDeniedWithoutPrompt"
+                                message:@"User has previously denied the camera access request. "
+                                        @"Go to Settings to enable camera access."
+                                details:nil];
+      }
+      handler(flutterError);
       break;
-    case AVAuthorizationStatusRestricted:
-      handler([FlutterError errorWithCode:@"CameraAccessRestricted"
-                                  message:@"Camera access is restricted. "
-                                  details:nil]);
+    }
+    case AVAuthorizationStatusRestricted: {
+      FlutterError *flutterError;
+      if (forAudio) {
+        flutterError = [FlutterError errorWithCode:@"AudioAccessRestricted"
+                                           message:@"Audio access is restricted. "
+                                           details:nil];
+      } else {
+        flutterError = [FlutterError errorWithCode:@"CameraAccessRestricted"
+                                           message:@"Camera access is restricted. "
+                                           details:nil];
+      }
+      handler(flutterError);
       break;
+    }
     case AVAuthorizationStatusNotDetermined: {
-      [AVCaptureDevice
-          requestAccessForMediaType:AVMediaTypeVideo
-                  completionHandler:^(BOOL granted) {
-                    // handler can be invoked on an arbitrary dispatch queue.
-                    handler(granted ? nil
-                                    : [FlutterError
-                                          errorWithCode:@"CameraAccessDenied"
-                                                message:@"User denied the camera access request."
-                                                details:nil]);
-                  }];
+      [AVCaptureDevice requestAccessForMediaType:mediaType
+                               completionHandler:^(BOOL granted) {
+                                 // handler can be invoked on an arbitrary dispatch queue.
+                                 if (granted) {
+                                   handler(nil);
+                                 } else {
+                                   FlutterError *flutterError;
+                                   if (forAudio) {
+                                     flutterError = [FlutterError
+                                         errorWithCode:@"AudioAccessDenied"
+                                               message:@"User denied the audio access request."
+                                               details:nil];
+                                   } else {
+                                     flutterError = [FlutterError
+                                         errorWithCode:@"CameraAccessDenied"
+                                               message:@"User denied the camera access request."
+                                               details:nil];
+                                   }
+                                   handler(flutterError);
+                                 }
+                               }];
       break;
     }
   }

packages/camera/camera/ios/Classes/CameraPlugin.m

@@ -132,12 +132,12 @@ - (void)handleMethodCallAsync:(FlutterMethodCall *)call
       [result sendNotImplemented];
     }
   } else if ([@"create" isEqualToString:call.method]) {
-    FLTRequestCameraPermissionWithCompletionHandler(^(FlutterError *error) {
+    FLTRequestCameraPermission(/*forAudio*/ false, ^(FlutterError *error) {
       // Create FLTCam only if granted camera access.
       if (error) {
         [result sendFlutterError:error];
       } else {
-        [self createCameraOnSessionQueueWithCreateMethodCall:call result:result];
+        [self createCameraOnCaptureSessionQueueWithCreateMethodCall:call result:result];
       }
     });
   } else if ([@"startImageStream" isEqualToString:call.method]) {
@@ -194,8 +194,17 @@ - (void)handleMethodCallAsync:(FlutterMethodCall *)call
       [_camera close];
       [result sendSuccess];
     } else if ([@"prepareForVideoRecording" isEqualToString:call.method]) {
-      [_camera setUpCaptureSessionForAudio];
-      [result sendSuccess];
+      FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
+        // Setup audio capture session only if granted audio access
+        if (error) {
+          [result sendFlutterError:error];
+        } else {
+          dispatch_async(self.captureSessionQueue, ^{
+            [self.camera setUpCaptureSessionForAudio];
+            [result sendSuccess];
+          });
+        }
+      });
     } else if ([@"startVideoRecording" isEqualToString:call.method]) {
       [_camera startVideoRecordingWithResult:result];
     } else if ([@"stopVideoRecording" isEqualToString:call.method]) {
@@ -258,8 +267,8 @@ - (void)handleMethodCallAsync:(FlutterMethodCall *)call
   }
 }
 
-- (void)createCameraOnSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
-                                                result:(FLTThreadSafeFlutterResult *)result {
+- (void)createCameraOnCaptureSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
+                                                       result:(FLTThreadSafeFlutterResult *)result {
   dispatch_async(self.captureSessionQueue, ^{
     NSString *cameraName = createMethodCall.arguments[@"cameraName"];
     NSString *resolutionPreset = createMethodCall.arguments[@"resolutionPreset"];

packages/camera/camera/ios/Classes/CameraPlugin_Test.h

@@ -38,10 +38,10 @@
 /// that triggered the orientation change.
 - (void)orientationChanged:(NSNotification *)notification;
 
-/// Creates FLTCam on session queue and reports the creation result.
+/// Creates FLTCam on capture session queue and reports the creation result.
 /// @param createMethodCall the create method call
 /// @param result a thread safe flutter result wrapper object to report creation result.
-- (void)createCameraOnSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
-                                                result:(FLTThreadSafeFlutterResult *)result;
+- (void)createCameraOnCaptureSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
+                                                       result:(FLTThreadSafeFlutterResult *)result;
 
 @end

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/plugins/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.9.5+1
+version: 0.9.6
 
 environment:
   sdk: ">=2.14.0 <3.0.0"