Implement permission request for Apple embedded platforms, fix microphone input #107233

migueldeicaza · 2025-06-06T21:06:00Z

Fixes godotengine/godot-proposals#12563 but also fixes the "Recording audio on iOS does not work" from 33885.

This now addresses all issues I spotted in #33885 and I have tested it against the Godot recording sample and it finally works on iOS.

…s://github.com/godotengine/godot/issues/107229

doc/classes/OS.xml

that the OS will provide us, cope with the fact that iOS will adjust the number of frames dynamically based on your session type. This should fix godotengine#33885

migueldeicaza · 2025-06-07T15:15:33Z

This pull request now also includes a fix for #33885

migueldeicaza · 2025-06-07T15:21:59Z

@akien-mga Now that this went from 'necessary enhancement to fix a bug' to 'fixes a five year old bug that has prevented recording from working on iOS', could we change the label from enhancement?

Calinou · 2025-06-09T15:01:34Z

I wonder how #106305 has been confirmed to be working by its author, since I expect camera access to also require a permission just like microphone access.

bruvzg · 2025-06-09T15:07:20Z

I wonder how #106305 has been confirmed to be working by its author

At least on macOS, camera server do auto request permission when feed is activated.

shiena · 2025-06-09T15:18:50Z

I wonder how #106305 has been confirmed to be working by its author, since I expect camera access to also require a permission just like microphone access.

I've created a test application where I've incorporated CameraTexture into the scene tree. As a result, you'll notice a camera access permission dialog appearing when the app launches.

bruvzg

Tested on 10. gen. iPad, recording seems to be working (note for testing, appropriate category should set in audio/general/ios/session_category project setting and permission description added in export config for it to work).

bruvzg · 2025-06-11T08:59:08Z

drivers/coreaudio/audio_driver_coreaudio.mm

 	bufferList.mBuffers[0].mDataByteSize = ad->input_buf.size() * sizeof(int16_t);

 	OSStatus result = AudioUnitRender(ad->input_unit, ioActionFlags, inTimeStamp, inBusNumber, inNumberFrames, &bufferList);
+	ad->input_buf.resize(inNumberFrames * ad->capture_channels);


inpuf_buf is not used for anything except temporary storage here, so if mData is nullptr, and the audio unit provide its own buffer it can be completely removed.

diff --git a/drivers/coreaudio/audio_driver_coreaudio.h b/drivers/coreaudio/audio_driver_coreaudio.h index 64c77fe97f..36f5eee73b 100644 --- a/drivers/coreaudio/audio_driver_coreaudio.h +++ b/drivers/coreaudio/audio_driver_coreaudio.h @@ -59,7 +59,7 @@ class AudioDriverCoreAudio : public AudioDriver { unsigned int capture_buffer_frames = 0; Vector<int32_t> samples_in; - Vector<int16_t> input_buf; + unsigned int buffer_size = 0; #ifdef MACOS_ENABLED PackedStringArray _get_device_list(bool capture = false); diff --git a/drivers/coreaudio/audio_driver_coreaudio.mm b/drivers/coreaudio/audio_driver_coreaudio.mm index fb870e4740..8763a1b933 100644 --- a/drivers/coreaudio/audio_driver_coreaudio.mm +++ b/drivers/coreaudio/audio_driver_coreaudio.mm @@ -243,10 +243,9 @@ bufferList.mNumberBuffers = 1; bufferList.mBuffers[0].mData = nullptr; bufferList.mBuffers[0].mNumberChannels = ad->capture_channels; - bufferList.mBuffers[0].mDataByteSize = ad->input_buf.size() * sizeof(int16_t); + bufferList.mBuffers[0].mDataByteSize = ad->buffer_size * sizeof(int16_t); OSStatus result = AudioUnitRender(ad->input_unit, ioActionFlags, inTimeStamp, inBusNumber, inNumberFrames, &bufferList); - ad->input_buf.resize(inNumberFrames * ad->capture_channels); if (result == noErr) { int16_t *data = (int16_t *)bufferList.mBuffers[0].mData; for (unsigned int i = 0; i < inNumberFrames * ad->capture_channels; i++) { @@ -459,8 +458,7 @@ // Sample rate is independent of channels (ref: https://stackoverflow.com/questions/11048825/audio-sample-frequency-rely-on-channels) capture_buffer_frames = closest_power_of_2(latency * (uint32_t)capture_mix_rate / (uint32_t)1000); - unsigned int buffer_size = capture_buffer_frames * capture_channels; - input_buf.resize(buffer_size); + buffer_size = capture_buffer_frames * capture_channels; AURenderCallbackStruct callback; memset(&callback, 0, sizeof(AURenderCallbackStruct));

AThousandShips · 2025-06-07T09:01:32Z

drivers/apple_embedded/os_apple_embedded.mm

+					get_main_loop()->emit_signal(SNAME("on_request_permissions_result"), p_name, granted);
+				}];
+			}
+		};


Suggested change

};

}

AThousandShips · 2025-06-09T15:19:57Z

doc/classes/OS.xml

+				- [code]OS.request_permission("appleembedded.permission.AUDIO_RECORD")[/code]
 				[b]Note:[/b] On Android, permission must be checked during export.
-				[b]Note:[/b] This method is implemented on Android and macOS.
+				[b]Note:[/b] This method is implemented on Android, macOS and visionOS platforms.


Suggested change

[b]Note:[/b] This method is implemented on Android, macOS and visionOS platforms.

[b]Note:[/b] This method is implemented on Android, macOS, and visionOS platforms.

Please use Oxford comma.

AThousandShips · 2025-06-09T15:20:13Z

doc/classes/OS.xml

 			<description>
 				On Android devices: Returns the list of dangerous permissions that have been granted.
 				On macOS: Returns the list of granted permissions and user selected folders accessible to the application (sandboxed applications only). Use the native file dialog to request folder access permission.
+				On iOS, VisionOS: Returns the list of granted permissions.


Suggested change

On iOS, VisionOS: Returns the list of granted permissions.

On iOS, visionOS: Returns the list of granted permissions.

akien-mga · 2025-06-12T14:23:39Z

While addressing review comments, please also:

Resolve the style issues, which currently prevent the rest of CI from running (https://github.com/godotengine/godot/actions/runs/15509113661/job/43667689824?pr=107233 )
- We recommend using our pre-commit hook for that: https://docs.godotengine.org/en/latest/contributing/development/code_style_guidelines.html#pre-commit-hook
Squash the commits so it's ready to merge as a single commit (or two if you want to split them logically with first implementing permission request support, and then fixing the microphone input using it).

migueldeicaza · 2025-06-20T03:05:42Z

Folks, apologies, but I am away for a month on vacation. Would appreciate if someone takes over this patch.

…nput Supersedes godotengine#107233 Fixes godotengine/godot-proposals#12563 Fixes godotengine#33885 Superseding Miguel's PR to get it in during the beta stage.

…nput Co-Authored-By: Miguel de Icaza <[email protected]> Supersedes godotengine#107233 Fixes godotengine/godot-proposals#12563 Fixes godotengine#33885 Superseding Miguel's PR to get it in during the beta stage.

akien-mga · 2025-06-25T14:03:19Z

Superseded by #107973. Thanks for the contribution!

…nput Co-Authored-By: Miguel de Icaza <[email protected]> Supersedes godotengine#107233 Fixes godotengine/godot-proposals#12563 Fixes godotengine#33885 Superseding Miguel's PR to get it in during the beta stage.

Implement permission request for Apple embedded platforms, fixes http…

7ded274

…s://github.com/godotengine/godot/issues/107229

migueldeicaza requested a review from a team as a code owner June 6, 2025 21:06

akien-mga requested a review from a team June 6, 2025 21:35

akien-mga added enhancement platform:ios topic:platforms labels Jun 6, 2025

akien-mga added this to the 4.x milestone Jun 6, 2025

syntaxerror247 reviewed Jun 7, 2025

View reviewed changes

doc/classes/OS.xml Outdated Show resolved Hide resolved

Instead of allocating and guessing the size of the number of frames

3ee7d0e

that the OS will provide us, cope with the fact that iOS will adjust the number of frames dynamically based on your session type. This should fix godotengine#33885

migueldeicaza requested a review from a team as a code owner June 7, 2025 15:12

Address feedback

7050beb

migueldeicaza mentioned this pull request Jun 7, 2025

AudioStreamMicrophone is broken on iOS hardware #33885

Closed

dsnopek added the bug label Jun 7, 2025

akien-mga changed the title ~~Implement permission request for Apple embedded platforms~~ Implement permission request for Apple embedded platforms, fix microphone input Jun 7, 2025

akien-mga added the topic:audio label Jun 7, 2025

bruvzg self-requested a review June 9, 2025 15:09

bruvzg approved these changes Jun 11, 2025

View reviewed changes

bruvzg modified the milestones: 4.x, 4.5 Jun 11, 2025

AThousandShips reviewed Jun 11, 2025

View reviewed changes

AThousandShips mentioned this pull request Jun 17, 2025

Godot crash #107610

Open

paddy-exe mentioned this pull request Jun 25, 2025

Add permission request for Apple embedded platforms, fix microphone input #107973

Merged

akien-mga closed this Jun 25, 2025

akien-mga added the archived label Jun 25, 2025

akien-mga removed this from the 4.5 milestone Jun 25, 2025

	[b]Note:[/b] This method is implemented on Android, macOS and visionOS platforms.
	[b]Note:[/b] This method is implemented on Android, macOS, and visionOS platforms.

	On iOS, VisionOS: Returns the list of granted permissions.
	On iOS, visionOS: Returns the list of granted permissions.

Uh oh!

Implement permission request for Apple embedded platforms, fix microphone input #107233

Implement permission request for Apple embedded platforms, fix microphone input #107233

Uh oh!

Conversation

migueldeicaza commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

migueldeicaza commented Jun 7, 2025 • edited by dsnopek Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

migueldeicaza commented Jun 7, 2025

Uh oh!

Calinou commented Jun 9, 2025

Uh oh!

bruvzg commented Jun 9, 2025

Uh oh!

shiena commented Jun 9, 2025

Uh oh!

bruvzg left a comment

Choose a reason for hiding this comment

Uh oh!

bruvzg Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

AThousandShips Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

AThousandShips Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

AThousandShips Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

akien-mga commented Jun 12, 2025

Uh oh!

migueldeicaza commented Jun 20, 2025

Uh oh!

akien-mga commented Jun 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

migueldeicaza commented Jun 6, 2025 •

edited

Loading

migueldeicaza commented Jun 7, 2025 •

edited by dsnopek

Loading