Made sound system optional #6629

ThomasFOG · 2019-01-06T23:16:07Z

Hey there,

This PR should make Microsoft.Xna.Framework.Media and Microsoft.Xna.Framework.Audio optional so that no sound system is initialized if none of those namespace are used. This should make MonoGame friendly to third party sound engine like FMOD or Wwise.

It addresses:

[OpenAL] Wrong exception type when binaries are missing #6515 exception types are now consistent (it's either DllNotFoundException or NoAudioHardwareException)
Lack of OpenAL DLLs shouldn't be fatal. #6107 if no SoundEffect Song MediaPlayer Microphone or DynamicSoundEffectInstance are used, OpenAL won't get loaded and the dll can be removed from release packages
Startup crash when speakers are not plugged in #4717 this error can now be caught through SoundEffect.Initialize() and developers can make it so it is not fatal

As suggested previously, sound engine initialization is now done whenever SoundEffect Song MediaPlayer Microphone or DynamicSoundEffectInstance are constructed.
It is however possible to manually initialize the SoundEffect API by calling SoundEffect.Initialize(). This allows developers to get any initialization errors and act accordingly (e.g. disabling sound, or make it fatal).

Fixes #6515 #6107 #4717

@Jjagg @cra0zy
@tomspilman if this goes through, I'll try to get the console repos' compliant.

Jjagg

Awesome PR! Thanks @mrhelmut :)
I made some comments, actually partly about existing code but made obvious in this PR.

MonoGame.Framework/Audio/OpenALSoundController.cs

MonoGame.Framework/Audio/SoundEffect.OpenAL.cs

MonoGame.Framework/Audio/SoundEffect.cs

MonoGame.Framework/Media/Song.NVorbis.cs

ThomasFOG · 2019-01-07T12:47:31Z

Thanks! I'm going to refactor the controller instance management, it has been a bit messy for quite too long.

ThomasFOG · 2019-01-07T20:50:35Z

@Jjagg I think I got things clean up. Let me know how it goes for you.

EDIT: forgot Android, brb.

ThomasFOG · 2019-01-07T21:02:36Z

Ready for review.

MonoGame.Framework/Audio/SoundEffect.OpenAL.cs

Jjagg · 2019-01-07T22:56:13Z

Looks good to me! Gonna hold off a little bit in case anyone else wants to go over this, but will merge if not.

harry-cpp · 2019-01-08T14:16:24Z

MonoGame.Framework/Audio/Microphone.cs

@@ -128,7 +129,7 @@ public static ReadOnlyCollection<Microphone> All
        /// </summary>
        public static Microphone Default
        {
-            get { return _default; }
+            get { SoundEffect.Initialize(); return _default; }


Write code like this in the static initializer instead of static property.

Just so there is no confusion, ie:

static Microphone() { SoundEffect.Initialize(); }

You could also use static constructors in few other places.

I think it's better to check if initialization was done properly on every call, rather than do it only once. It makes behavior more predictable. Static initializers complicate control flow because you can't be sure when they'll be called.

They get called during first access to their respective class.

The thing is, Default and ```All`` are the microphone entry points, but you have to initialize the sound API to populate the microphones, and the Microphone class is static by design...
Unless we change the design of the Microphone class, I don't think we can do anything else than having this in a static field. I'm not a fan of static classes because this kind of design problems.

Alternative proposition: not initializing the sound API at all in the Microphone class, and throw if All/Default are accessed while not initialized. Forcing users to either call SoundEffect.Initialize() or to use the auto initialization when loading content.

I've seen static classes initializing without obvious calls to them, so I'd feel more comfortable with not having any library loading happening inside static ctor/fields.

For the same reason, I don't quite like OpenAL.NativeLibrary being initialized statically. I think I'm going to change that too.

We should not change the API by forcing explicit initialization. If we could have a fresh API, I'd definitely want to make it explicit though.

How about just checking if Audio systems can be initialized on game run?

For the same reason, I don't quite like OpenAL.NativeLibrary being initialized statically. I think I'm going to change that too.

Please don't, those are just wrappers. Think of them as DllImport statements :P

Sure, but they do load the dll if the static ctor kicks in, which we want to avoid to not mess up with third party sound engine.

But if we can't get the sound api to initialize in a non static way for Microphone, there's no point in removing the static initialization from OpenAL anyway because it'll still be around within Microphone.

I am more suspicious of Microphone than I am of OpenAL. I'd prefer to not add a static constructor to Microphone.

If we'd like to be 100% safe, I'd suggest to move static initialization out of OpenAL func loading and manually load them (to have a perfect control on the "when" and "how").

ThomasFOG · 2019-01-14T08:57:09Z

After giving some thoughts about static initializers, I believe that we are 100% fine with OpenAL statically loading the binary. I assume that people not willing to use OpenAL will remove the dll from their distribution, which doesn't trigger any error if OpenAL tries to load anyway (unless SoundEffect.Initialize() is called, but then it's the expected behavior).

I am however not in favor of having Microphone use a static initializer to initialize the sound API. As of now everything would be fine, but we have no control over what could reference Microphone and possibly trigger its initializer. For safety, I prefer to have the initialization upon accessing the microphones list.

@Jjagg @cra0zy What do you think? If it's ok to you, then it should be good to go.

Jjagg · 2019-01-14T09:02:56Z

That's fine by me.

ThomasFOG · 2019-02-07T10:14:01Z

@cra0zy Could you share your thoughts about the current status of this PR? It would be cool to move forward.

I've been running on this PR for quite some time now, using FMOD.

harry-cpp · 2019-02-09T15:51:47Z

Looks fine to me, sorry for the delay.

Jjagg · 2019-02-10T19:48:02Z

Thanks @mrhelmut! Merging this :D

ThomasFOG added 2 commits January 6, 2019 23:44

Optional sound engine initialization

cb201a1

Better exception type handling

5fabc90

ThomasFOG mentioned this pull request Jan 6, 2019

[OpenAL] Wrong exception type when binaries are missing #6515

Closed

Fixed Microphone.Default initialization

02349f4

Jjagg requested changes Jan 7, 2019

View reviewed changes

OpenAL context initialization refactor

ae7526c

Fix mobile OpenAL init

d14d4f7

Jjagg reviewed Jan 7, 2019

View reviewed changes

MonoGame.Framework/Audio/SoundEffect.OpenAL.cs Outdated Show resolved Hide resolved

Remove extra whitespace

050c2e5

Jjagg approved these changes Jan 7, 2019

View reviewed changes

harry-cpp requested changes Jan 8, 2019

View reviewed changes

harry-cpp approved these changes Feb 9, 2019

View reviewed changes

Jjagg merged commit 72919dc into MonoGame:develop Feb 10, 2019

This was referenced Feb 10, 2019

Lack of OpenAL DLLs shouldn't be fatal. #6107

Closed

Startup crash when speakers are not plugged in #4717

Closed

ThomasFOG deleted the optionalSound branch February 20, 2019 07:59

kimimaru4000 mentioned this pull request Mar 17, 2019

Fix crash on game start on Android 8.1(or possiblly other android ver… #6680

Closed

ololomax mentioned this pull request Mar 21, 2019

Android OpenAL crash on startup #6685

Closed

tomspilman added this to the 3.8 Release milestone Aug 1, 2020

tomspilman changed the title ~~Optional sound system~~ Made sound system optional Aug 1, 2020

Apostolique mentioned this pull request Oct 8, 2020

MG3.8 - can't initialise audio on Android 6.0 and 7.1 #7335

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Made sound system optional #6629

Made sound system optional #6629

ThomasFOG commented Jan 6, 2019 •

edited

Loading

Jjagg left a comment

ThomasFOG commented Jan 7, 2019

ThomasFOG commented Jan 7, 2019 •

edited

Loading

ThomasFOG commented Jan 7, 2019

Jjagg commented Jan 7, 2019

harry-cpp Jan 8, 2019

harry-cpp Jan 8, 2019

harry-cpp Jan 8, 2019

Jjagg Jan 8, 2019

harry-cpp Jan 8, 2019

ThomasFOG Jan 8, 2019

Jjagg Jan 8, 2019

harry-cpp Jan 8, 2019

ThomasFOG Jan 8, 2019

ThomasFOG Jan 9, 2019

ThomasFOG commented Jan 14, 2019

Jjagg commented Jan 14, 2019

ThomasFOG commented Feb 7, 2019 •

edited

Loading

harry-cpp commented Feb 9, 2019

Jjagg commented Feb 10, 2019

Made sound system optional #6629

Made sound system optional #6629

Conversation

ThomasFOG commented Jan 6, 2019 • edited Loading

Jjagg left a comment

Choose a reason for hiding this comment

ThomasFOG commented Jan 7, 2019

ThomasFOG commented Jan 7, 2019 • edited Loading

ThomasFOG commented Jan 7, 2019

Jjagg commented Jan 7, 2019

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

ThomasFOG commented Jan 14, 2019

Jjagg commented Jan 14, 2019

ThomasFOG commented Feb 7, 2019 • edited Loading

harry-cpp commented Feb 9, 2019

Jjagg commented Feb 10, 2019

ThomasFOG commented Jan 6, 2019 •

edited

Loading

ThomasFOG commented Jan 7, 2019 •

edited

Loading

ThomasFOG commented Feb 7, 2019 •

edited

Loading