xamarin-macios/tests/monotouch-test/AudioUnit/AUParameterNodeTest.cs

//
// Unit tests for AUParameterNode
//
// Authors:
//	Oleg Demchenko (oleg.demchenko@xamarin.com)
//
// Copyright 2016 Xamarin Inc. All rights reserved.
//

#if !__WATCHOS__ && XAMCORE_2_0

using System;
using System.Threading;

using NUnit.Framework;

using Foundation;
using AudioUnit;

namespace monotouchtest {
	[TestFixture]
	[Preserve (AllMembers = true)]
	public class AUParameterNodeTest {
		[Test]
		public void CreateTokenByAddingParameterRecordingObserver ()
		{
			if (!TestRuntime.CheckSystemAndSDKVersion (9, 0))
				Assert.Ignore ("Ignoring AudioUnitv3 tests: Requires iOS9+");

			const ulong address = 0;
			const float newValue = 10f;

			bool recordingObserverInvoked = false;
			var completion = new ManualResetEvent (false);

			using (var parameter = CreateAUParameter ()) {
				using (var tree = AUParameterTree.CreateTree (new AUParameterNode[] { parameter })) {
					var recordingObserver = tree.CreateTokenByAddingParameterRecordingObserver ((nint numberOfEvents, ref AURecordedParameterEvent events) => {
						Assert.True (numberOfEvents == 1,
							$"Number of events was wrong. Expected {1} but was {numberOfEvents}");

						Assert.True (events.Address == address,
							$"Address was wrong. Expected {address} but was {events.Address}");

						Assert.True (events.Value == newValue,
							$"Value was wrong. Expected {newValue} but was {events.Value}");

						recordingObserverInvoked = true;
						completion.Set ();
					});

					Assert.True (recordingObserver.ObserverToken != IntPtr.Zero, "TokenByAddingParameterRecordingObserver return zero pointer for recording observer.");
					parameter.Value = newValue;

					completion.WaitOne (TimeSpan.FromSeconds (1));
					Assert.True (recordingObserverInvoked, "Recording observer was not invoked when paramter value was changed.");
				}
			}
		}

		[Test]
		public void RemoveParameterObserver ()
		{
			if (!TestRuntime.CheckSystemAndSDKVersion (9, 0))
				Assert.Ignore ("Ignoring AudioUnitv3 tests: Requires iOS9+");

			const ulong address = 0;
			const float newValue = 10f;

			bool recordingObserverInvoked = false;
			var completion = new ManualResetEvent (false);

			using (var parameter = CreateAUParameter ()) {
				using (var tree = AUParameterTree.CreateTree (new AUParameterNode[] { parameter })) {
					var recordingObserver = tree.CreateTokenByAddingParameterRecordingObserver ((nint numberOfEvents, ref AURecordedParameterEvent events) => {
						recordingObserverInvoked = true;
						completion.Set ();
					});

					tree.RemoveParameterObserver (recordingObserver);

					Assert.True (recordingObserver.ObserverToken != IntPtr.Zero, "TokenByAddingParameterRecordingObserver return zero pointer for recording observer.");
					parameter.Value = newValue;

					completion.WaitOne (TimeSpan.FromSeconds (1));
					Assert.False (recordingObserverInvoked, "Recording observer was invoked however observer it should be removed already.");
				}
			}
		}

		[Test]
		public void ImplementorStringFromValueCallback ()
		{
			if (!TestRuntime.CheckSystemAndSDKVersion (9, 0))
				Assert.Ignore ("Ignoring AudioUnitv3 tests: Requires iOS9+");

			const float floatValue = 10f;
			const string expectedStringValue = "10";

			bool implementorCallbackInvoked = false;

			using (var parameter = CreateAUParameter ()) {
				parameter.ImplementorStringFromValueCallback = new AUImplementorStringFromValueCallback ((AUParameter param, ref float? value) => {
					Assert.True (floatValue == value.Value,
						$"Passed float value was incorrect. Expected {floatValue} but was {value}");

					Assert.True (param.Identifier == parameter.Identifier,
						$"Passed AUParameter was incorrect. Expected {parameter.Identifier} but was {param.Identifier}");

					implementorCallbackInvoked = true;
					return (NSString)value.ToString ();
				});

				var str = parameter.GetString (floatValue);

				Assert.True (implementorCallbackInvoked, "StringValueFrom callback was not invoked.");
				Assert.True (str == expectedStringValue,
					$"String doesn't match. Expected {expectedStringValue}, actual {str}");
			}
		}

		[Test]
		public void ImplementorValueFromStringCallback ()
		{
			if (!TestRuntime.CheckSystemAndSDKVersion (9, 0))
				Assert.Ignore ("Ignoring AudioUnitv3 tests: Requires iOS9+");

			const float expectedValue = 10f;
			const string stringValue = "10";

			bool implementorCallbackInvoked = false;

			using (var parameter = CreateAUParameter ()) {
				parameter.ImplementorValueFromStringCallback = new AUImplementorValueFromStringCallback ((param, str) => {
					Assert.True (str == stringValue,
						$"Passed string value was incorrect. Expected {stringValue} but was {str}");

					Assert.True (param.Identifier == parameter.Identifier,
						$"Passed AUParameter was incorrect. Expected {parameter.Identifier} but was {param.Identifier}");

					implementorCallbackInvoked = true;
					return Single.Parse (str);
				});

				var value = parameter.GetValue (stringValue);

				Assert.True (implementorCallbackInvoked, "ValueFromString callback was not invoked.");
				Assert.False (Math.Abs (value - expectedValue) > float.Epsilon,
					$"Values doesn't match. Expected {expectedValue}, actual {value}");
			}
		}

		// TODO: Test temporary ignored.
		// Reason: ImplementorDisplayNameWithLengthCallback never invoked when user requests truncated version of node's name.
		// Objc/Swift code demosntrates the same behavior.
		// Waiting for comments/fix from Apple.
		[Test, Ignore]
		public void ImplementorDisplayNameWithLengthCallback ()
		{
			if (!TestRuntime.CheckSystemAndSDKVersion (9, 0))
				Assert.Ignore ("Ignoring AudioUnitv3 tests: Requires iOS9+");

			const string displayName = "Resonance";
			const int length = 5;

			bool implementorCallbackInvoked = false;
			string expectedTruncatedName = displayName.Substring (0, length);

			using (var parameter = CreateAUParameter ()) {
				parameter.ImplementorDisplayNameWithLengthCallback = new AUImplementorDisplayNameWithLengthCallback ((node, desiredLength) => {
					Assert.True (length == desiredLength, "Passed length value is incorrect.");
					Assert.True (node.Identifier == parameter.Identifier,
						$"Passed AUParameterNode was incorrect. Expected {parameter.Identifier} but was {node.Identifier}");

					implementorCallbackInvoked = true;
					return node.DisplayName.Substring (0, (int)desiredLength);
				});

				var s = parameter.GetDisplayName (length);
				Assert.True (implementorCallbackInvoked, "Display name callback was not invoked.");
				Assert.True (expectedTruncatedName == s, $"Truncated node display name was incorrect. Expected {expectedTruncatedName} but was {s}");
			}
		}

		static AUParameter CreateAUParameter ()
		{
			return AUParameterTree.CreateParameter ("resonance", "Resonance", 0, -20, 20, AudioUnitParameterUnit.Decibels, null, (AudioUnitParameterOptions)0, null, null);
		}
	}
}

#endif // !__WATCHOS__ && XAMCORE_2_0