[camera_avfoundation] iOS: Fix crash when `enableAudio == false` by correcting guard condition #9949

juliendelarbre · 2025-09-02T21:20:34Z

Summary

This PR fixes an iOS crash that occurs when using the camera plugin with enableAudio: false and no NSMicrophoneUsageDescription in Info.plist.

Root cause:
In DefaultCamera.setUpCaptureSessionForAudioIfNeeded(), the guard currently allows audio setup to proceed even when audio is disabled:

// current (buggy)
guard !mediaSettings.enableAudio || !isAudioSetup else { return }

This evaluates to true when enableAudio == false, so the audio setup runs regardless.

Fix: Require audio to be enabled and not already set up before proceeding:

// fixed
guard mediaSettings.enableAudio && !isAudioSetup else { return }

This aligns behavior with the intended logic (“don’t set up audio twice or when audio is disabled”) and prevents the crash path on iOS when the microphone usage description is absent.

Affected file:
camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/DefaultCamera.swift
Proposed correction commit:
juliendelarbre@0635db4
Related Flutter issue & discussion:
flutter/flutter#174702 (comment)

Before / After

Before (buggy): audio setup runs when enableAudio == false, causing a crash on iOS if NSMicrophoneUsageDescription is missing.

After (fixed): audio setup is skipped when enableAudio == false; no crash, behavior matches API expectations.

Reproduction steps

Create a Flutter project targeting iOS.
Ensure ios/Runner/Info.plist does not contain NSMicrophoneUsageDescription.
Initialize CameraController with enableAudio: false.
Call startVideoRecording().
Observe crash (on current main); with this PR applied, no crash.

Linked Issues

Fixes flutter/flutter#174702

Documentation

No API changes; behavior now matches the documented intent. (Optional: add a short inline comment elaborating that audio setup is skipped when enableAudio == false.)

Pre-Review Checklist

flutter-dashboard · 2025-09-02T21:20:36Z

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

gemini-code-assist

Code Review

This pull request addresses a critical crash on iOS that occurs when the camera is used with enableAudio: false without the NSMicrophoneUsageDescription in Info.plist. The change corrects the logic in the guard statement within setUpCaptureSessionForAudioIfNeeded to ensure audio setup is only attempted when audio is explicitly enabled and has not already been configured. The fix is correct and directly resolves the reported issue by aligning the code's behavior with its intended logic.

hellohuanlin · 2025-09-03T00:51:36Z

can you add some tests so that it doesn't regress

juliendelarbre · 2025-09-03T12:27:24Z

@hellohuanlin, added some test.

juliendelarbre · 2025-09-09T15:08:59Z

/gemini review

gemini-code-assist

Code Review

This pull request correctly fixes a crash on iOS that occurred when enableAudio was set to false. The logical condition in the guard statement has been properly corrected to prevent the audio setup from running when it's disabled. The addition of new unit tests is a great improvement, as they cover both the enabled and disabled audio scenarios, ensuring the fix is robust and preventing future regressions. The changes to the test mocks to support this are also well-implemented. Overall, this is a solid contribution.

gemini-code-assist · 2025-09-09T15:10:08Z

packages/camera/camera_avfoundation/example/ios/RunnerTests/CameraSettingsTests.swift

+  func test_setUpCaptureSessionForAudioIfNeeded_skipsAudioSession_whenAudioDisabled() {
+    let settings = FCPPlatformMediaSettings.make(
+      with: testResolutionPreset,
+      framesPerSecond: NSNumber(value: testFramesPerSecond),
+      videoBitrate: NSNumber(value: testVideoBitrate),
+      audioBitrate: NSNumber(value: testAudioBitrate),
+      enableAudio: false
+    )
+
+    let wrapper = TestMediaSettingsAVWrapper(test: self, expectAudio: false)
+    let mockAudioSession = MockCaptureSession()
+
+    let configuration = CameraTestUtils.createTestCameraConfiguration()
+    configuration.mediaSettingsWrapper = wrapper
+    configuration.mediaSettings = settings
+    configuration.audioCaptureSession = mockAudioSession
+    let camera = CameraTestUtils.createTestCamera(configuration)
+
+    wait(
+      for: [
+        wrapper.lockExpectation,
+        wrapper.beginConfigurationExpectation,
+        wrapper.minFrameDurationExpectation,
+        wrapper.maxFrameDurationExpectation,
+        wrapper.commitConfigurationExpectation,
+        wrapper.unlockExpectation,
+      ],
+      timeout: 1,
+      enforceOrder: true
+    )
+
+    camera.startVideoRecording(completion: { _ in }, messengerForStreaming: nil)
+
+    wait(
+      for: [
+        wrapper.audioSettingsExpectation,
+        wrapper.videoSettingsExpectation,
+      ],
+      timeout: 1
+    )
+
+    XCTAssertEqual(
+      mockAudioSession.addedAudioOutputCount, 0,
+      "Audio session should not receive AVCaptureAudioDataOutput when enableAudio is false"
+    )
+  }
+
+  func test_setUpCaptureSessionForAudioIfNeeded_addsAudioSession_whenAudioEnabled() {
+    let settings = FCPPlatformMediaSettings.make(
+      with: testResolutionPreset,
+      framesPerSecond: NSNumber(value: testFramesPerSecond),
+      videoBitrate: NSNumber(value: testVideoBitrate),
+      audioBitrate: NSNumber(value: testAudioBitrate),
+      enableAudio: true
+    )
+
+    let wrapper = TestMediaSettingsAVWrapper(test: self, expectAudio: true)
+    let mockAudioSession = MockCaptureSession()
+
+    let configuration = CameraTestUtils.createTestCameraConfiguration()
+    configuration.mediaSettingsWrapper = wrapper
+    configuration.mediaSettings = settings
+    configuration.audioCaptureSession = mockAudioSession
+    let camera = CameraTestUtils.createTestCamera(configuration)
+
+    wait(
+      for: [
+        wrapper.lockExpectation,
+        wrapper.beginConfigurationExpectation,
+        wrapper.minFrameDurationExpectation,
+        wrapper.maxFrameDurationExpectation,
+        wrapper.commitConfigurationExpectation,
+        wrapper.unlockExpectation,
+      ],
+      timeout: 1,
+      enforceOrder: true
+    )
+
+    camera.startVideoRecording(completion: { _ in }, messengerForStreaming: nil)
+
+    wait(
+      for: [
+        wrapper.audioSettingsExpectation,
+        wrapper.videoSettingsExpectation,
+      ],
+      timeout: 1
+    )
+
+    XCTAssertGreaterThan(
+      mockAudioSession.addedAudioOutputCount, 0,
+      "Audio session should receive AVCaptureAudioDataOutput when enableAudio is true"
+    )
+  }
 }


The two new tests, test_setUpCaptureSessionForAudioIfNeeded_skipsAudioSession_whenAudioDisabled and test_setUpCaptureSessionForAudioIfNeeded_addsAudioSession_whenAudioEnabled, share a significant amount of setup and execution logic. To improve code clarity and maintainability, this duplicated code could be extracted into a private helper function.

This function could take enableAudio as a parameter, perform the common setup for the camera and mocks, and then return the mockAudioSession to be used for assertions in the individual tests.

Here is an example of how this could be structured:

private func performAudioSetupTest(enableAudio: Bool) -> MockCaptureSession { // ... common setup for settings, wrapper, mockAudioSession, configuration, and camera ... // ... first wait block for configuration ... camera.startVideoRecording(completion: { _ in }, messengerForStreaming: nil) // ... second wait block for recording start ... return mockAudioSession } func test_setUpCaptureSessionForAudioIfNeeded_skipsAudioSession_whenAudioDisabled() { let mockAudioSession = performAudioSetupTest(enableAudio: false) XCTAssertEqual( mockAudioSession.addedAudioOutputCount, 0, "Audio session should not receive AVCaptureAudioDataOutput when enableAudio is false" ) } func test_setUpCaptureSessionForAudioIfNeeded_addsAudioSession_whenAudioEnabled() { let mockAudioSession = performAudioSetupTest(enableAudio: true) XCTAssertGreaterThan( mockAudioSession.addedAudioOutputCount, 0, "Audio session should receive AVCaptureAudioDataOutput when enableAudio is true" ) }

This refactoring would make the tests more concise and easier to maintain.

hellohuanlin · 2025-09-12T18:39:22Z

packages/camera/camera_avfoundation/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.21+4
+
+* Fixes crash on iOS when `enableAudio` is false by correcting audio setup guard.


can remove by correcting audio setup guard since it's implementation details that audience doesn't care

juliendelarbre

Done

juliendelarbre · 2025-09-15T17:10:48Z

packages/camera/camera_avfoundation/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.21+4
+
+* Fixes crash on iOS when `enableAudio` is false by correcting audio setup guard.


juliendelarbre · 2025-10-02T10:04:29Z

Hello,
anything blocking about this ?
Thanks,

LouiseHsu

LGTM

…alse` by correcting guard condition (flutter/packages#9949)

flutter/packages@8ca6416...260f381 2025-10-08 jessiewong401@gmail.com Add Versioning to Gradle 9 Deprecation Change (flutter/packages#10187) 2025-10-07 julien@delarbre.biz [camera_avfoundation] iOS: Fix crash when `enableAudio == false` by correcting guard condition (flutter/packages#9949) 2025-10-07 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump androidx.fragment:fragment from 1.8.8 to 1.8.9 in /packages/local_auth/local_auth_android/android (flutter/packages#10111) 2025-10-07 10687576+bparrishMines@users.noreply.github.com [interactive_media_ads] Adds support for accessing data for an Ad (flutter/packages#9972) 2025-10-07 stuartmorgan@google.com [webview_flutter] Add Android geolocation README (flutter/packages#10166) 2025-10-07 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump com.google.guava:guava from 33.4.8-android to 33.5.0-android in /packages/espresso/android (flutter/packages#10047) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

Fix bug when enableAudio is False and video recording is requested

0635db4

juliendelarbre requested review from hellohuanlin and vashworth as code owners September 2, 2025 21:20

github-actions bot added p: camera platform-ios platform-macos labels Sep 2, 2025

gemini-code-assist bot reviewed Sep 2, 2025

View reviewed changes

juliendelarbre added 3 commits September 3, 2025 02:03

Merge branch 'flutter:main' into fix-video-recording-disabled-audio

b48b43f

Update CHANGELOG.md

559e563

Update pubspec.yaml

092a790

juliendelarbre and others added 3 commits September 3, 2025 10:02

Merge branch 'flutter:main' into fix-video-recording-disabled-audio

b6ab67e

Add test

e4656fe

Update formatting

d44fe6f

Merge branch 'flutter:main' into fix-video-recording-disabled-audio

c7375b8

stuartmorgan-g added the triage-ios Should be looked at in iOS triage label Sep 3, 2025

Merge branch 'main' into fix-video-recording-disabled-audio

ef0e572

gemini-code-assist bot reviewed Sep 9, 2025

View reviewed changes

hellohuanlin approved these changes Sep 12, 2025

View reviewed changes

juliendelarbre added 2 commits September 12, 2025 22:55

Merge branch 'main' into fix-video-recording-disabled-audio

3d3b031

Update CHANGELOG.md

d9b3ff8

juliendelarbre commented Sep 15, 2025

View reviewed changes

LouiseHsu self-requested a review September 25, 2025 21:55

LouiseHsu approved these changes Oct 2, 2025

View reviewed changes

Merge branch 'main' into fix-video-recording-disabled-audio

b662262

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 7, 2025

stuartmorgan-g removed the triage-ios Should be looked at in iOS triage label Oct 7, 2025

auto-submit bot merged commit 08aed5b into flutter:main Oct 7, 2025
80 checks passed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 8, 2025

08aed5bca [camera_avfoundation] iOS: Fix crash when `enableAudio == f…

130228c

…alse` by correcting guard condition (flutter/packages#9949)

engine-flutter-autoroll mentioned this pull request Oct 8, 2025

Roll Packages from 8ca6416d680d to 08aed5bca0b9 (5 revisions) flutter/flutter#176719

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 8, 2025

08aed5bca [camera_avfoundation] iOS: Fix crash when `enableAudio == f…

425c850

…alse` by correcting guard condition (flutter/packages#9949)

engine-flutter-autoroll mentioned this pull request Oct 8, 2025

Roll Packages from 8ca6416d680d to 260f381ad1e6 (6 revisions) flutter/flutter#176730

Merged

		@@ -1,3 +1,7 @@
		## 0.9.21+4

		* Fixes crash on iOS when `enableAudio` is false by correcting audio setup guard.

[camera_avfoundation] iOS: Fix crash when enableAudio == false by correcting guard condition #9949

[camera_avfoundation] iOS: Fix crash when enableAudio == false by correcting guard condition #9949

Uh oh!

Conversation

juliendelarbre commented Sep 2, 2025 • edited by stuartmorgan-g Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Before / After

Reproduction steps

Linked Issues

Documentation

Pre-Review Checklist

Uh oh!

flutter-dashboard bot commented Sep 2, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

hellohuanlin commented Sep 3, 2025

Uh oh!

juliendelarbre commented Sep 3, 2025

Uh oh!

juliendelarbre commented Sep 9, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

hellohuanlin Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

juliendelarbre Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

juliendelarbre left a comment

Choose a reason for hiding this comment

Uh oh!

juliendelarbre Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

juliendelarbre commented Oct 2, 2025

Uh oh!

LouiseHsu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[camera_avfoundation] iOS: Fix crash when `enableAudio == false` by correcting guard condition #9949

[camera_avfoundation] iOS: Fix crash when `enableAudio == false` by correcting guard condition #9949

juliendelarbre commented Sep 2, 2025 •

edited by stuartmorgan-g

Loading