164 lines
7.7 KiB
C#
164 lines
7.7 KiB
C#
/*******************************************************************************
|
|
The content of this file includes portions of the proprietary AUDIOKINETIC Wwise
|
|
Technology released in source code form as part of the game integration package.
|
|
The content of this file may not be used without valid licenses to the
|
|
AUDIOKINETIC Wwise Technology.
|
|
Note that the use of the game engine is subject to the Unity(R) Terms of
|
|
Service at https://unity3d.com/legal/terms-of-service
|
|
|
|
License Usage
|
|
|
|
Licensees holding valid licenses to the AUDIOKINETIC Wwise Technology may use
|
|
this file in accordance with the end user license agreement provided with the
|
|
software or, alternatively, in accordance with the terms contained
|
|
in a written agreement between you and Audiokinetic Inc.
|
|
Copyright (c) 2025 Audiokinetic Inc.
|
|
*******************************************************************************/
|
|
|
|
#if ! (UNITY_DASHBOARD_WIDGET || UNITY_WEBPLAYER || UNITY_WII || UNITY_WIIU || UNITY_NACL || UNITY_FLASH || UNITY_BLACKBERRY) // Disable under unsupported platforms.
|
|
/// <summary>
|
|
/// This class represents an example audio input manager and is responsible for managing the audio sample and format
|
|
/// callbacks provided to the Wwise Audio Input plug-in.
|
|
/// </summary>
|
|
public static class AkAudioInputManager
|
|
{
|
|
/// <summary>
|
|
/// Sanitized audio format delegate to be used by classes that implement audio input plug-ins. The samples are ALWAYS
|
|
/// set to be non-interleaved 32-bit float.
|
|
/// </summary>
|
|
/// <param name="playingID">The playingID of a sound that uses the audio input plug-in.</param>
|
|
/// <param name="format">The C# analog of the C++ AkAudioFormat class.</param>
|
|
public delegate void AudioFormatDelegate(uint playingID, AkAudioFormat format);
|
|
|
|
/// <summary>
|
|
/// Audio format delegate that is sent to C++.
|
|
/// </summary>
|
|
[System.Runtime.InteropServices.UnmanagedFunctionPointer(System.Runtime.InteropServices.CallingConvention.StdCall)]
|
|
public delegate void AudioFormatInteropDelegate(uint playingID, System.IntPtr format);
|
|
|
|
/// <summary>
|
|
/// Sanitized audio sample delegate to be used by classes that implement audio input plug-ins. For every event posted,
|
|
/// this delegate is called once per audio frame for each channel until the delegates for all the channels associated
|
|
/// with this event return false.
|
|
/// </summary>
|
|
/// <param name="playingID">The playingID of a sound that uses the audio input plug-in.</param>
|
|
/// <param name="channelIndex">The number of the channel associated with this specific invocation of the delegate.</param>
|
|
/// <param name="samples">The sample array that MUST be filled even when returning false.</param>
|
|
/// <returns>Return true when more sample frames are require and false when complete.</returns>
|
|
public delegate bool AudioSamplesDelegate(uint playingID, uint channelIndex, float[] samples);
|
|
|
|
/// <summary>
|
|
/// Audio sample delegate that is sent to C++.
|
|
/// </summary>
|
|
[System.Runtime.InteropServices.UnmanagedFunctionPointer(System.Runtime.InteropServices.CallingConvention.StdCall)]
|
|
public delegate bool AudioSamplesInteropDelegate(uint playingID,
|
|
[System.Runtime.InteropServices.In]
|
|
[System.Runtime.InteropServices.Out]
|
|
[System.Runtime.InteropServices.MarshalAs(System.Runtime.InteropServices.UnmanagedType.LPArray, SizeParamIndex = 3)]
|
|
float[] samples, uint channelIndex, uint frames);
|
|
|
|
private static bool initialized;
|
|
|
|
private static readonly System.Collections.Generic.Dictionary<uint, AudioSamplesDelegate> audioSamplesDelegates =
|
|
new System.Collections.Generic.Dictionary<uint, AudioSamplesDelegate>();
|
|
|
|
private static readonly System.Collections.Generic.Dictionary<uint, AudioFormatDelegate> audioFormatDelegates =
|
|
new System.Collections.Generic.Dictionary<uint, AudioFormatDelegate>();
|
|
|
|
private static readonly AkAudioFormat audioFormat = new AkAudioFormat();
|
|
private static readonly AudioSamplesInteropDelegate audioSamplesDelegate = InternalAudioSamplesDelegate;
|
|
private static readonly AudioFormatInteropDelegate audioFormatDelegate = InternalAudioFormatDelegate;
|
|
|
|
/// <summary>
|
|
/// This method is used to post events that use the Wwise Audio Input plug-in.
|
|
/// </summary>
|
|
/// <param name="akEventID">The ID of the event to post.</param>
|
|
/// <param name="gameObject">The GameObject that the event will be posted on.</param>
|
|
/// <param name="sampleDelegate">The C# audio sample delegate.</param>
|
|
/// <param name="formatDelegate">
|
|
/// The C# audio format delegate. If not specified, defaults to a mono source running at the
|
|
/// sample rate of the sound engine.
|
|
/// </param>
|
|
/// <returns>The playingID of the newly instantiated sound associated with the posted event.</returns>
|
|
public static uint PostAudioInputEvent(uint akEventID, UnityEngine.GameObject gameObject,
|
|
AudioSamplesDelegate sampleDelegate, AudioFormatDelegate formatDelegate = null)
|
|
{
|
|
TryInitialize();
|
|
var playingID =
|
|
AkUnitySoundEngine.PostEvent(akEventID, gameObject, (uint) AkCallbackType.AK_EndOfEvent, EventCallback, null);
|
|
AddPlayingID(playingID, sampleDelegate, formatDelegate);
|
|
return playingID;
|
|
}
|
|
|
|
/// <summary>
|
|
/// This method is used to post events that use the Wwise Audio Input plug-in.
|
|
/// </summary>
|
|
/// <param name="akEventName">The name of the event to post.</param>
|
|
/// <param name="gameObject">The GameObject that the event will be posted on.</param>
|
|
/// <param name="sampleDelegate">The C# audio sample delegate.</param>
|
|
/// <param name="formatDelegate">
|
|
/// The C# audio format delegate. If not specified, defaults to a mono source running at the
|
|
/// sample rate of the sound engine.
|
|
/// </param>
|
|
/// <returns>The playingID of the newly instantiated sound associated with the posted event.</returns>
|
|
public static uint PostAudioInputEvent(string akEventName, UnityEngine.GameObject gameObject,
|
|
AudioSamplesDelegate sampleDelegate, AudioFormatDelegate formatDelegate = null)
|
|
{
|
|
TryInitialize();
|
|
var playingID =
|
|
AkUnitySoundEngine.PostEvent(akEventName, gameObject, (uint) AkCallbackType.AK_EndOfEvent, EventCallback, null);
|
|
AddPlayingID(playingID, sampleDelegate, formatDelegate);
|
|
return playingID;
|
|
}
|
|
|
|
[AOT.MonoPInvokeCallback(typeof(AudioSamplesInteropDelegate))]
|
|
private static bool InternalAudioSamplesDelegate(uint playingID, float[] samples, uint channelIndex, uint frames)
|
|
{
|
|
return audioSamplesDelegates.ContainsKey(playingID) &&
|
|
audioSamplesDelegates[playingID](playingID, channelIndex, samples);
|
|
}
|
|
|
|
[AOT.MonoPInvokeCallback(typeof(AudioFormatInteropDelegate))]
|
|
private static void InternalAudioFormatDelegate(uint playingID, System.IntPtr format)
|
|
{
|
|
if (audioFormatDelegates.ContainsKey(playingID))
|
|
{
|
|
audioFormat.setCPtr(format);
|
|
audioFormatDelegates[playingID](playingID, audioFormat);
|
|
}
|
|
}
|
|
|
|
private static void TryInitialize()
|
|
{
|
|
if (!initialized)
|
|
{
|
|
initialized = true;
|
|
AkUnitySoundEngine.SetAudioInputCallbacks(audioSamplesDelegate, audioFormatDelegate);
|
|
}
|
|
}
|
|
|
|
private static void AddPlayingID(uint playingID, AudioSamplesDelegate sampleDelegate,
|
|
AudioFormatDelegate formatDelegate)
|
|
{
|
|
if (playingID == AkUnitySoundEngine.AK_INVALID_PLAYING_ID || sampleDelegate == null)
|
|
return;
|
|
|
|
audioSamplesDelegates.Add(playingID, sampleDelegate);
|
|
if (formatDelegate != null)
|
|
audioFormatDelegates.Add(playingID, formatDelegate);
|
|
}
|
|
|
|
private static void EventCallback(object cookie, AkCallbackType type, AkCallbackInfo callbackInfo)
|
|
{
|
|
if (type == AkCallbackType.AK_EndOfEvent)
|
|
{
|
|
var info = callbackInfo as AkEventCallbackInfo;
|
|
if (info != null)
|
|
{
|
|
audioSamplesDelegates.Remove(info.playingID);
|
|
audioFormatDelegates.Remove(info.playingID);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
#endif // #if ! (UNITY_DASHBOARD_WIDGET || UNITY_WEBPLAYER || UNITY_WII || UNITY_WIIU || UNITY_NACL || UNITY_FLASH || UNITY_BLACKBERRY) // Disable under unsupported platforms. |