FMOD for Unity 2.01.07 seems to have broken the FMODStudioSettings class.
I can’t save in the editor without getting these errors:
FMOD: Cleaning up duplicate platform: ID = playInEditor, name = 'Play In Editor Settings', type = PlatformPlayInEditor
ArgumentException: An item with the same key has already been added. Key: playInEditor
FMOD: Cleaning up duplicate platform: ID = default, name = 'Default Settings', type = PlatformDefault
ArgumentException: An item with the same key has already been added. Key: default
NullReferenceException: Object reference not set to an instance of an object
FMODUnity.SettingsEditor.DisplayPlugins (System.String title, FMODUnity.Platform platform, FMODUnity.Platform+PropertyAccessor`1[T] property, System.Collections.Generic.Dictionary`2[TKey,TValue] expandState, System.String warning) (at Assets/Plugins/FMOD/src/Editor/SettingsEditor.cs:1028)
I believe this is a regression that basically makes the Unity integration unusable. Something to do with de-duplicating platforms in the Platforms map. At runtime there’s a series of NPEs related to platforms so actually I can’t run the game properly. Has anyone else run into this?
Stack Overflow here. I was unable to login to the forum for some reason so I posted there first.
I add all my platforms at the bottom of the settings
hit cmd+s, and it spits out those errors
try to remove those platforms, and I can’t remove iOS
try to delete the settings object, and it recreates without platforms.
hit cmd+s again, and it spits out those errors even without any platforms.
This seems to be unrecoverable, so I delete FMOD entirely, and then reinstall it.
Here’s the diff between the broken settings object, and the fresh install attached. I can reproduce the broken install by adding platforms and hitting cmd+s.
I’m on MacOS Catalina, Unity 2019.4.18f1. Here’s that diff.
I’ll try to get you a demo project tomorrow. Right now I can only reproduce it if I add a specific prefab to an empty scene. Perhaps some old information about the settings object is being serialized in the prefab and never updated.
I’ll work on it tomorrow. This bug is actually making it very difficult to use FMOD on my project.
Alright so I put together the bare minimum project I could that still reproduced the issue. I’m not prepared to share it on the open web, and in fact it still contains a lot of code/strings I can’t share.
If I delete the settings object, open an empty scene, and add/remove platforms, everything works. If I open a scene and add one of my prefabs to it, and do the same thing, I get the errors I mentioned.
I was reading the code in Settings.cs and it seems like the static initialization that happens when you’re creating a brand new settings object will populate the “Platforms” map while at the same time saving that map out to the Resources folder. Later, in OnEnable(), the Platform in the asset database will be == to the Platform of the same type in the Platforms map. So DestroyImmediate will destroy both the Platforms map instance of the Platform as well as the one loaded from the asset database resulting in an attempt to add “null” to the Platforms map multiple time.
OK so I’ve got that project I can’t really share with you, but I also put together this diff that I propose be applied to Settings.cs. I’d have made a pull request, but the github repo seems to be super far out of date.
I’m not sure if I understand correctly, but it sounds like you might have more than one Settings asset in your project. Is that the case? If so, that will be the cause of the issue - Settings is intended to be a singleton object.
If that is not the case, can you give us any more information about the prefab that triggers the issue? Are you able to share the project (or just the prefab) via a private upload? If you register your project at https://fmod.com/profile#projects, you should then be able to upload files at https://fmod.com/profile#uploads.
Thanks for taking a look! So there’s definitely only one settings file in my projects and I can delete it repeatedly and still reproduce the issue (when a scene with the prefab is loaded). If I completely unpack the prefab without changing anything else, that also solves the problem. It maybe more than one prefab too. But the contents of the prefab doesn’t seem to matter. If I unpack it, or delete a number of objects form inside it, or remove a component from it, the problem goes away. Doesn’t matter that the prefab has NO FMOD code in it.
I have no idea what’s causing the problem and haven’t had time to dig further. I can share the project with you, but someone would need to sign an NDA. I’m not sure who though. I guess whomever was going to look at the project?
Just to be clear though, that diff I posted did make the problem go away. Do you see anything in the diff that would cause FMOD to stop working, or am I safe to go forward using the diff?
OK, great! We’re happy to sign an NDA. Please email support@fmod.com with a link to this forum thread and we’ll take it from there.
I don’t think that diff will eliminate the duplicate platforms from the asset - you’re just not seeing the warnings any more because the code that checks for duplicates is gone.
Oh great! I’ll do that. My lawyer’s just drawing up our NDA and I should have it ready for next week. I also have the project ready to share.
To your second point, I think there’s a real problem with the duplicate check.
It’s not comparing the platform objects directly for equality. What’s on disk and what’s in memory are exactly the same objects in my case. So when you destroy one, you destroy both. That causes the errors for me.
I also don’t quite understand why at that stage of execution it’s a good idea to attempt to deduplicate in the first place. It seems like that function was intended to reset what’s in memory entirely and reload from disk.
But of course, I didn’t write the code so I have no idea the original intention.
I encountered the following errors with FMOD 2.01.07 and Unity 2019.4.17f1 on macOS 11.2.1:
ArgumentException: An item with the same key has already been added. Key: playInEditor
ArgumentException: An item with the same key has already been added. Key: default
ArgumentException: An item with the same key has already been added. Key: Default
etc.
This is how I fixed it. I had to edit the file Assets/Plugins/FMOD/src/Runtime/Settings.cs and made the following change to line 832:
if (existingPlatform != null && existingPlatform != newPlatform)
Thanks for the additional information. This does sound like the same issue @VoodooDetective is having - once we have their project we should be able to debug it further.
Hi, Apologies for the delay, to update on the NDA side of things: After review, we cannot accept every customer’s NDA that exposes us to unknown damages from perceived breaches, from many other countries with legal jurisdictions that are not our own. The risk to benefit ratio is too high.
The only recommendation is to send the data through to us regardless - based on our reputation as a company that has been in business for 20 years without any legal incident, or rename strings in your project if they are of sensitive nature.
We treat any customer data as confidential by default, and it is usually deleted after a case is closed.
Gotcha. Where I’m from, trust is earned and so far, I haven’t been given many reasons to trust you. The number of problems I’ve run into is scary to me and I have no way of knowing how far these troubles extend into your company. How can I trust that you are capable of safeguarding our data?
The help I’ve received here on the forum has been great, and I’d like to continue using FMOD, but where my company is concerned, I’m not taking chances. I’m sure you can understand as another person in charge of other people’s livelihoods.
THAT SAID, in my free time this past month, I’ve been able to strip all content I was worried about sharing from the reproduction so I can upload it now. It should be there.
