UAudioBank #1274

DaveSullivanAtWork · 2017-10-31T14:57:37Z

Update to the UAudioManager system.
The main purpose of this update was to bring the spatial sound support up to date with the changes in the spatilaizer and to separate out the audio event data from the scene. This allows for "skinnable" sound such as dynamically loading the correct sound bank based on language or user preferences.

Moved all the event data to a ScriptableObject.
Added export to audiobank option if events are present in the UAudioManager component.
Added support for unity volume curve to spatial sounds.
Removed deprecated spatailizer properties and associated audio event data.
Removed LowPass curve (it was unused).
Removed UAudioMiniManager, this system directly referenced scene objects, thus was not supportable as an asset.
Updated the sample.

…r component.

… spatialized sounds.

StephenHodgson · 2017-10-31T15:36:06Z

Assets/HoloToolkit-Examples/SpatialSound/Scripts/UAudioManagerTest.cs

@@ -17,13 +17,17 @@ private IEnumerator ContinouslyPlaySounds()
        {
            while (true)
            {
-                UAudioManager.Instance.PlayEvent("Laser");
+                UAudioManager.Instance.PlayEvent("Vocals3d");


Is there a way we can make this not based on strings?

Every event needs a unique ID and to support audio event banks in downloadable asset bundles I'd like to avoid any build time dependencies (i.e. generating an ID table). There are several ideas kicking around in my head on how to do this, but each one requires some more thought / discussion.
For a pure unity editor experience, we could provide an editor attribute that would convert (in this case) a string field into a dropdown to select an event from, but this still doesn't help with the potential of event renaming and the connection being "lost".
Perhaps this is one for a future update after more thought.

You might be able to do something similar with how we handle voice keywords and commands in the main toolkit, with a serialized array.

I've added a custom property drawer to alleviate having to enter string values manually.

StephenHodgson · 2017-10-31T15:36:45Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/ActiveEvent.cs

+                    source.SetCustomCurve(AudioSourceCurveType.CustomRolloff, audioEvent.AttenuationCurve);
+                    //source.SetCustomCurve(AudioSourceCurveType.SpatialBlend, audioEvent.SpatialCurve);
+                    //source.SetCustomCurve(AudioSourceCurveType.Spread, audioEvent.SpreadCurve);
+                    //source.SetCustomCurve(AudioSourceCurveType.ReverbZoneMix, audioEvent.ReverbCurve);


If these are no longer needed, we can remove them outright.

StephenHodgson · 2017-10-31T15:36:58Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/AudioBank.cs

+    {
+        public T[] Events;
+    }
+


nit: extra line space

Trimmed the space.

StephenHodgson · 2017-10-31T15:37:55Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/AudioEvent.cs

-        [Tooltip("The lowpass attenuation curve for simple 3D sounds. Only used when positioning is set to 3D")]
-        public AnimationCurve LowPassCurve = AnimationCurve.EaseInOut(0f, 0f, 1f, 0f); // by default no lowpass
+        //[Tooltip("The lowpass attenuation curve for simple 3D sounds. Only used when positioning is set to 3D")]
+        //public AnimationCurve LowPassCurve = AnimationCurve.EaseInOut(0f, 0f, 1f, 0f); // by default no lowpass


We can remove these as well.

StephenHodgson · 2017-10-31T15:40:07Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/SpatialSoundSettings.cs

-            MinGain,
-            MaxGain,
-            UnityGainDistance
+            RoomSize = 1


How will this affect people already using the parameters?
Will they get out of index exceptions?
Maybe we should catch these where it's used and reassign them, or warn the users that the parameter is set incorrectly.

It shouldn't, as these values map to the parameter indices in the spatializer plugin (in fact, they wind up cast as an int when calling into the plugin).

We should be safe, this enum is private to the class, and the functions that used them are now marked obsolete and have no code in them.

StephenHodgson · 2017-10-31T15:40:58Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/SpatialSoundSettings.cs

@@ -61,29 +59,29 @@ public static void SetRoomSize(AudioSource audioSource, SpatialSoundRoomSizes ro
        /// </summary>
        /// <param name="audioSource">The AudioSource on which the minimum gain will be set.</param>
        /// <param name="room">The desired minimum gain, in decibels.</param>
+        [Obsolete("This parameter is no longer used, use the unity volume curve.")]


Awesome! Could you also call out the new ClassName.MethodName() in this way please?

Updated the warning text.

There isn't really a new function, volume attenuation is now controlled by the unity volume curve on the audio source. This is now a parameter in the audio event and replaces the Min/Max gain and UnityGainDistance parameters that used to be in the audio event.

Add an [AudioEvent] attribute to a string field to replace the default UI with a dropdown. Right-Click on the dropdown to enable/disable bank names in the list.

StephenHodgson · 2017-11-12T18:23:03Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/Editor/UAudioManagerBaseEditor.cs

+        { 
+            // Don't show this if there are no embedded events in this audio manager
+            if (MyTarget.EditorEvents == null || MyTarget.EditorEvents.Length == 0)
+                return;


nit: braces.

StephenHodgson · 2017-11-12T18:24:35Z

Assets/HoloToolkit/SpatialSound/Scripts/UAudioManager/UAudioManagerBase.cs

        [SerializeField]
+        [System.Obsolete]


What replaces this?
What is the new usage?
Why didn't the usages get updated in the EditorEvents down below?

StephenHodgson · 2017-11-21T17:34:31Z

@DaveSullivanAtWork What are the steps for devs to update to the new system?

Trying to write this up for the next release.

DaveSullivanAtWork · 2017-11-23T10:20:30Z

@StephenHodgson

Open existing project and Inspect the UAudioManager.
Use the Export button to create a bank from the existing embedded data.

That should be it.

You can now move the generated asset around and rename it as required. (Default asset name is ConvertedAudioBank)

Points to note:
You may need to adjust the falloff curve and distance of spatialized sounds due to changes in the underlying spatializer library.

PJBowron · 2018-05-10T15:49:57Z

Note: Addresses #1211

David Sullivan and others added 7 commits October 27, 2017 15:25

Removed UAudioMiniManager

3ba484b

Moved audio data to be stored in an asset instead of the UAudioManage…

dced771

…r component.

Added unity volume attenuation curve to spatial sounds.

19eae90

Added 3d version of vocals to highlight the difference between 3d and…

7822a33

… spatialized sounds.

Removed the obsolete parameters MinGain, MaxGain and UnityGainDistance.

178c57c

Added file header comments.

7d7207c

Hooked up the BanksChanged() virtual to rebuild the event dictionary.

4a7e06e

StephenHodgson reviewed Oct 31, 2017

View reviewed changes

DaveSullivanAtWork added 2 commits October 31, 2017 17:01

Updates from code review.

90c9b89

Added a custom property drawer for selecting an audio event.

77bd112

Add an [AudioEvent] attribute to a string field to replace the default UI with a dropdown. Right-Click on the dropdown to enable/disable bank names in the list.

StephenHodgson approved these changes Nov 3, 2017

View reviewed changes

witian merged commit 9950c99 into microsoft:master Nov 7, 2017

StephenHodgson reviewed Nov 12, 2017

View reviewed changes

StephenHodgson added the BREAKING CHANGE label Nov 21, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UAudioBank #1274

UAudioBank #1274

DaveSullivanAtWork commented Oct 31, 2017

StephenHodgson Oct 31, 2017

DaveSullivanAtWork Oct 31, 2017

StephenHodgson Oct 31, 2017

DaveSullivanAtWork Nov 1, 2017

StephenHodgson Oct 31, 2017

DaveSullivanAtWork Oct 31, 2017

StephenHodgson Oct 31, 2017

DaveSullivanAtWork Oct 31, 2017

StephenHodgson Oct 31, 2017

DaveSullivanAtWork Oct 31, 2017

StephenHodgson Oct 31, 2017 •

edited

david-c-kline Oct 31, 2017

DaveSullivanAtWork Oct 31, 2017

StephenHodgson Oct 31, 2017 •

edited

DaveSullivanAtWork Oct 31, 2017

DaveSullivanAtWork Oct 31, 2017

StephenHodgson Nov 12, 2017

StephenHodgson Nov 12, 2017 •

edited

StephenHodgson commented Nov 21, 2017 •

edited

DaveSullivanAtWork commented Nov 23, 2017

PJBowron commented May 10, 2018

UAudioBank #1274

UAudioBank #1274

Conversation

DaveSullivanAtWork commented Oct 31, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenHodgson Oct 31, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenHodgson Oct 31, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenHodgson Nov 12, 2017 • edited

Choose a reason for hiding this comment

StephenHodgson commented Nov 21, 2017 • edited

DaveSullivanAtWork commented Nov 23, 2017

PJBowron commented May 10, 2018

StephenHodgson Oct 31, 2017 •

edited

StephenHodgson Oct 31, 2017 •

edited

StephenHodgson Nov 12, 2017 •

edited

StephenHodgson commented Nov 21, 2017 •

edited