[RGen] Add AVFoundation trampoline tests.

[mandel-macaque]

Add tests for all the AVFoundation delegates that we know about.

[mandel-macaque]

bgen generated code:

[UnmanagedFunctionPointerAttribute (CallingConvention.Cdecl)]
[UserDelegateType (typeof (global::AVFoundation.AVAssetImageGenerateAsynchronouslyForTimeCompletionHandler))]
unsafe internal delegate void DAVAssetImageGenerateAsynchronouslyForTimeCompletionHandler (IntPtr block, NativeHandle imageRef, global::CoreMedia.CMTime actualTime, NativeHandle error);

[mandel-macaque]

bgen generated code:

internal static unsafe void Invoke (IntPtr block, NativeHandle imageRef, global::CoreMedia.CMTime actualTime, NativeHandle error) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVAssetImageGenerateAsynchronouslyForTimeCompletionHandler> (block);
	if (del is not null) {
		del (imageRef == IntPtr.Zero ? null! : new CoreGraphics.CGImage (imageRef, false), actualTime,  Runtime.GetNSObject<NSError> (error)!);
	}
}

Notice the diff between the two, rgen is calling the GetINativeObject factory method, which will do the correct thing for a IntPtr.Zero

[mandel-macaque]

bgen generated code:

del (requestedTime, imageRef, actualTime, (AVAssetImageGeneratorResult) (long) result,  Runtime.GetNSObject<NSError> (error)!);

Only diff is the usage of 'global'.

[mandel-macaque]

bgen code:

unsafe internal delegate void DAVAssetImageGeneratorCompletionHandler2 (IntPtr block, global::CoreMedia.CMTime requestedTime, NativeHandle imageRef, global::CoreMedia.CMTime actualTime, IntPtr result, NativeHandle error);

[mandel-macaque]

bgen code:

del (requestedTime, imageRef == IntPtr.Zero ? null! : new CoreGraphics.CGImage (imageRef, false), actualTime, (AVAssetImageGeneratorResult) (long) result,  Runtime.GetNSObject<NSError> (error)!);

The diff is the usage of the GetINativeObject factory method.

[mandel-macaque]

bgen code:

unsafe internal delegate void DAVAssetPlaybackAssistantLoadPlaybackConfigurationOptionsHandler (IntPtr block, NativeHandle playbackConfigurationOptions);

[mandel-macaque]

bgen code:

del (CFArray.StringArrayFromHandle (playbackConfigurationOptions)!);

The diff is the usage of the 'global' alias.

[mandel-macaque]

bgen code:

unsafe internal delegate NativeHandle DAVAudioConverterInputHandler (IntPtr block, uint inNumberOfPackets, global::AVFoundation.AVAudioConverterInputStatus* outStatus);

@rolfbjarne this is an interesting case. bgen uses a pointer to the enumerator value:

	/// <summary>Enumerates the state of the input stream.</summary>
	/// <remarks>To be added.</remarks>
	[MacCatalyst (13, 1)]
	[Native]
	public enum AVAudioConverterInputStatus : long {
		/// <summary>To be added.</summary>
		HaveData = 0,
		/// <summary>To be added.</summary>
		NoDataNow = 1,
		/// <summary>To be added.</summary>
		EndOfStream = 2,
	}

The enum backing field is a long, which maps to an IntPtr. AFAIK the correct thing is to lower the enum value to its backing type, and since it is a long, we should use a IntPtr. Did I do the lowering wrong or is it not needed?

[rolfbjarne]

Technically lowering an enum value to IntPtr is correct, but since we don't support 32-bit on any platform anymore, it will always be 64-bit values, which means it doesn't really matter.

[mandel-macaque]

bgen code:

[Preserve (Conditional = true)]
[UnmanagedCallersOnly]
[UserDelegateType (typeof (global::AVFoundation.AVAudioConverterInputHandler))]
internal static unsafe NativeHandle Invoke (IntPtr block, uint inNumberOfPackets, global::AVFoundation.AVAudioConverterInputStatus* outStatus) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVAudioConverterInputHandler> (block);
	var retval = del (inNumberOfPackets, out global::System.Runtime.CompilerServices.Unsafe.AsRef<global::AVFoundation.AVAudioConverterInputStatus> (outStatus));
	return Runtime.RetainAndAutoreleaseNSObject (retval);
}

There are a few diffs here:

1. rgen inits the outStatus to the default.
2. rgen checks if the del is null, it it is, it returns the default.

AFAIk we need to always check for del to be null, since BlockLiteral.GetTarget returns a nullable value, which means that we always need to init the out variable to its default and we need to make sure we return the default of NativeHandle which AFAIK is a null ptr.

[rolfbjarne]

If BlockLiteral.GetTarget returns null, something went very wrong, so IMHO it's better to throw an exception in that case.

[mandel-macaque]

I can create a PR with that and rather than return the default we throw the error. Any exception in particular?

[rolfbjarne]

Something like this:

throw ErrorHelper.CreateError (8059, Errors.MX8059, "Unable to find a delegate to invoke for the block 0xdeadf000d (delegate type: AVFoundation.AVAudioConverterInputHandler).");

You'll have to add the error message to tools/mtouch/Errors.resx.

[mandel-macaque]

bgen code:

unsafe internal delegate IntPtr DAVAudioEngineManualRenderingBlock (IntPtr block, uint numberOfFrames, NativeHandle outBuffer, int* outError);

[mandel-macaque]

bgen code:

internal static unsafe IntPtr Invoke (IntPtr block, uint numberOfFrames, NativeHandle outBuffer, int* outError) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVAudioEngineManualRenderingBlock> (block);
	var retval = del (numberOfFrames, new global::AudioToolbox.AudioBuffers (outBuffer), ref global::System.Runtime.CompilerServices.Unsafe.AsRef<int> (outError));
	return (IntPtr) (long) retval;
}

Similar issue:

1. We init outError before the call.
2. We check for del no to be null.

The rest of the code is the same.

[mandel-macaque]

bgen:

unsafe internal delegate NativeHandle DAVAudioIONodeInputBlock (IntPtr block, uint frameCount);

[mandel-macaque]

bgen:

internal static unsafe NativeHandle Invoke (IntPtr block, uint frameCount) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVAudioIONodeInputBlock> (block);
	var retval = del (frameCount);
	return Runtime.RetainAndAutoreleaseNativeObject (retval);
}

[mandel-macaque]

Bug, should be @event and not event. There seems to be an issue on how we are getting the parameter name from the delegate declaration:

delegate void AVAudioInputNodeMutedSpeechEventListener (AVAudioVoiceProcessingSpeechActivityEvent @event);

For some reason we are losing the '@' which should not happen.

[mandel-macaque]

Fix in #22930

[rolfbjarne]

If BlockLiteral.GetTarget returns null, something went very wrong, so IMHO it's better to throw an exception in that case.

[rolfbjarne]

Technically lowering an enum value to IntPtr is correct, but since we don't support 32-bit on any platform anymore, it will always be 64-bit values, which means it doesn't really matter.

[vs-mobiletools-engineering-service2]

✅ [CI Build #5a32fc5] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 5a32fc59f62ff96e036062bbc2c0ca6049f6fc94 [PR build]

[vs-mobiletools-engineering-service2]

✅ [CI Build #c144157] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: c1441578211fd7bb2476877929fb324df2179668 [PR build]

[vs-mobiletools-engineering-service2]

💻 [CI Build #c144157] Tests on macOS X64 - Mac Sonoma (14) passed 💻

✅ All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent
Hash: c1441578211fd7bb2476877929fb324df2179668 [PR build]

[vs-mobiletools-engineering-service2]

💻 [CI Build #c144157] Tests on macOS M1 - Mac Monterey (12) passed 💻

✅ All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent
Hash: c1441578211fd7bb2476877929fb324df2179668 [PR build]

[mandel-macaque]

bgen generated:

[UnmanagedFunctionPointerAttribute (CallingConvention.Cdecl)]
[UserDelegateType (typeof (global::AVFoundation.AVMutableCompositionInsertHandler))]
unsafe internal delegate void DAVMutableCompositionInsertHandler (IntPtr block, NativeHandle error);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle error) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVMutableCompositionInsertHandler> (block);
	if (del is not null) {
		del ( Runtime.GetNSObject<NSError> (error)!);
	}
}

[mandel-macaque]

We probably want not to do GetNSObject<NSError?>. They should always use the non nullable class, will create a PR with that fixed.

[mandel-macaque]

fixed: #22941

[mandel-macaque]

bgen generated code:

[UnmanagedFunctionPointerAttribute (CallingConvention.Cdecl)]
[UserDelegateType (typeof (global::AVFoundation.AVMutableVideoCompositionCreateApplier))]
unsafe internal delegate void DAVMutableVideoCompositionCreateApplier (IntPtr block, NativeHandle request);

[mandel-macaque]

bgen generated code:

internal static unsafe void Invoke (IntPtr block, NativeHandle request) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVMutableVideoCompositionCreateApplier> (block);
	if (del is not null) {
		del ( Runtime.GetNSObject<AVAsynchronousCIImageFilteringRequest> (request)!);
	}
}

[mandel-macaque]

bgen generated:

[UnmanagedFunctionPointerAttribute (CallingConvention.Cdecl)]
[UserDelegateType (typeof (global::AVFoundation.AVMutableVideoCompositionCreateCallback))]
unsafe internal delegate void DAVMutableVideoCompositionCreateCallback (IntPtr block, NativeHandle videoComposition, NativeHandle error);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle videoComposition, NativeHandle error) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVMutableVideoCompositionCreateCallback> (block);
	if (del is not null) {
		del ( Runtime.GetNSObject<AVMutableVideoComposition> (videoComposition)!,  Runtime.GetNSObject<NSError> (error)!);
	}
}

[mandel-macaque]

bgen generated:

[UnmanagedFunctionPointerAttribute (CallingConvention.Cdecl)]
[UserDelegateType (typeof (global::AVFoundation.AVPlayerItemIntegratedTimelineAddBoundaryTimeObserverCallback))]
unsafe internal delegate void DAVPlayerItemIntegratedTimelineAddBoundaryTimeObserverCallback (IntPtr block, byte success);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, byte success) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVPlayerItemIntegratedTimelineAddBoundaryTimeObserverCallback> (block);
	if (del is not null) {
		del (success != 0);
	}
}

[mandel-macaque]

bgen generated:

[UnmanagedFunctionPointerAttribute (CallingConvention.Cdecl)]
[UserDelegateType (typeof (global::AVFoundation.AVPlayerItemIntegratedTimelineAddPeriodicTimeObserverCallback))]
unsafe internal delegate void DAVPlayerItemIntegratedTimelineAddPeriodicTimeObserverCallback (IntPtr block, global::CoreMedia.CMTime time);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, global::CoreMedia.CMTime time) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVPlayerItemIntegratedTimelineAddPeriodicTimeObserverCallback> (block);
	if (del is not null) {
		del (time);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVPlayerItemIntegratedTimelineSeekCallback (IntPtr block, byte success);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, byte success) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVPlayerItemIntegratedTimelineSeekCallback> (block);
	if (del is not null) {
		del (success != 0);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVRequestAccessStatus (IntPtr block, byte accessGranted);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, byte accessGranted) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVRequestAccessStatus> (block);
	if (del is not null) {
		del (accessGranted != 0);
	}
}
	

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVSampleBufferGeneratorBatchMakeReadyCallback (IntPtr block, NativeHandle error);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle error) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVSampleBufferGeneratorBatchMakeReadyCallback> (block);
	if (del is not null) {
		del ( Runtime.GetNSObject<NSError> (error)!);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVSampleBufferVideoRendererLoadVideoPerformanceMetricsCallback (IntPtr block, NativeHandle videoPerformanceMetrics);

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVSpeechSynthesisProviderOutputBlock (IntPtr block, NativeHandle markers, NativeHandle request);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle markers, NativeHandle request) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVSpeechSynthesisProviderOutputBlock> (block);
	if (del is not null) {
		del (CFArray.ArrayFromHandle<global::AVFoundation.AVSpeechSynthesisMarker> (markers)!,  Runtime.GetNSObject<AVSpeechSynthesisProviderRequest> (request)!);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVSpeechSynthesizerBufferCallback (IntPtr block, NativeHandle buffer);
```

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle buffer) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVSpeechSynthesizerBufferCallback> (block);
	if (del is not null) {
		del ( Runtime.GetNSObject<AVAudioBuffer> (buffer)!);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVSpeechSynthesizerMarkerCallback (IntPtr block, NativeHandle markers);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle markers) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVSpeechSynthesizerMarkerCallback> (block);
	if (del is not null) {
		del (CFArray.ArrayFromHandle<global::AVFoundation.AVSpeechSynthesisMarker> (markers)!);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVSpeechSynthesizerRequestPersonalVoiceAuthorizationCallback (IntPtr block, UIntPtr status);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, UIntPtr status) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVSpeechSynthesizerRequestPersonalVoiceAuthorizationCallback> (block);
	if (del is not null) {
		del ((AVSpeechSynthesisPersonalVoiceAuthorizationStatus) (ulong) status);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVVideoCompositionCreateApplier (IntPtr block, NativeHandle applier);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, NativeHandle applier) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVVideoCompositionCreateApplier> (block);
	if (del is not null) {
		del ( Runtime.GetNSObject<AVAsynchronousCIImageFilteringRequest> (applier)!);
	}
}

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVVideoCompositionCreateCallback (IntPtr block, NativeHandle videoComposition, NativeHandle error);

[mandel-macaque]

bgen generated:

unsafe internal delegate void DAVVideoCompositionDetermineValidityCallback (IntPtr block, byte isValid, NativeHandle error);

[mandel-macaque]

bgen generated:

internal static unsafe void Invoke (IntPtr block, byte isValid, NativeHandle error) {
	var del = BlockLiteral.GetTarget<global::AVFoundation.AVVideoCompositionDetermineValidityCallback> (block);
	if (del is not null) {
		del (isValid != 0,  Runtime.GetNSObject<NSError> (error)!);
	}
}