Audio Zone Properties

[HifiExperiments]

Move the audio zone properties from the domain settings to entity properties (the domain settings are still there, but marked deprecated).

Thanks to @AleziaKurdis for the icon!

Notes:

• listenerAttenuationCoefficients is a number[], which we don't currently support in Create, so it's only modifiable by script
• the domain settings only allowed axis aligned zones. now, we support rotated zone boxes. we don't yet support other zone shapes, e.g. if you have a spherical zone it will still use a box for audio purposes.
• the domain settings seemed to prioritize zones based on the order in which they were defined. now, we use the zone with the smallest volume (similar to how we determine which zone to render)

I tested a bit by myself but this could use testing with multiple people.

Testing:

• Make sure the new Zone properties work in Create (you can modify listenerAttenuationCoefficients via the console):

• audio.reverbEnabled: If reverb should be enabled for listeners in this zone.
• audio.reverbTime: The time (seconds) for the reverb tail to decay by 60dB.
• audio.reverbWetLevel: Adjusts the wet/dry percentage, from completely dry (0%) to completely wet (100%).
• audio.listenerZones: A list of entity IDs representing listener zones with this zone as a source.
• audio.listenerAttenuationCoefficients: A list of attenuation coefficients.

• Note: listenerZones and listenerAttenuationCoefficients must have the same length, otherwise they are ignored
• if you're willing, make sure the audio zone settings in the domain settings still work

Funding

This project is funded through NGI0 Entrust, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

[vegaslon]

when I tested it I only saw a button for reverb in the create app and a buttons to add listener zones, if I tried to set anything it was not save.

[HifiExperiments]

@vegaslon bleh my bad. reverbTime and reverbWetLevel only show when reverbEnabled is true, but that one wasn't working, and then the multipleZonesSelection couldn't handle group properties. everything should be fixed now!

[vegaslon]

not sure if it is a bad configuration but when I loaded a domain with audio zones created in the domain settings the audio mixer keeps crashing.

[HifiExperiments]

@vegaslon do you have any other details? I don't see any crashes when I do:

[vegaslon]

audio mixer is crashing even when I delete the audio enviroments from settings

[HifiExperiments]

do you have a stack trace? or is there anything else in the domain?

[vegaslon]

if I dump another domains backup into it the crashing stops, so it much just be that specific domain

[HifiExperiments]

could you share the problematic backup (here or in discord) and I could look into it?

[vegaslon]

That fixed the audio mixer crashing on that domain. Still need to find other people to stand around in various audio zones to make sure everything is in order.

[vegaslon]

After testing with multiple clients it seems to work, The listenerAttenuationCoefficients not being in the create app is troublesome but I do not believe the scope of the work was to add brand new functionality into the create app to handle number[].

It works with just adding zones in the client or just zones in the domain settings and works with a mixture of the two.

[HifiExperiments]

@vegaslon thank you so much for the thorough testing! agreed that it's annoying about listenerAttenuationCoefficients. I think ideally we would even have a tool for selecting the zone + coefficient together, rather than two separate fields, since they are linked...but unfortunately that's beyond my scripting ability. I can file a follow up issue for that once we merge this.

otherwise this is ready for review (and merge)!

[HifiExperiments]

@daleglass @ksuprynowicz thank you friends!