[GEN][ZH] Synchronize GameAudio and MilesAudio implementations between Generals and ZH

[Mauller]

merge by rebase - MilesAudioManager inherits from GameAudio so is dependent if MilesAudioManager ever needs reverting.

This PR makes the changes required to synchronize the audio implementations between Generals and Zero hour.

Most changes are backports to Generals, while some small tweaks are made to zero hour to match generals.

This PR also removes some instances where the empty stopAllAmbientBy functions were being called in gamelogic and fxListDie.

[Mauller]

I think the generals way of handling this might have been better on memory.

Playing audio will only ever be a single type which gets set on m_type so im not sure where they were going with doing this.

[OmniBlade]

I tend to agree and suggest removing the commenting out in ZH rather than back porting it to Gen.

[xezon]

Yes it looks like it should be a union. The difference is that in Zero Hour these are 0 initialized. But in Generals they are probably also zero initialized because of the Game Memory.

[Mauller]

I will revert the zero hour way of doing it and Null initialise one of the members in both.

That should make sure the memory is initialised then.

[Mauller]

Although the functionality for these is empty at the moment, it appears that the idea was to use them to stop ambient audio in specific circumstances.

Ambient audio seems to be constantly playing sound effects that occur in the background. These have some code within generals that would have paused them when the in game menu loaded.

The other situation could be that they get paused when out of range etc. But i think audio culling is handled elsewhere.

And since Generals has code that calls these, it's probably better to port them forward to zero hour during the synchronisation.

[xezon]

Perhaps this was just legacy code that was meant to be removed? There are these 2 functions:

Drawable::startAmbientSound
Drawable::stopAmbientSound

I suspect these are all we need to start and stop ambient audio on drawables?

Generals

In Generals there are these 2 calls to stopAllAmbientsBy:

void GameLogic::setGamePaused( Bool paused, Bool pauseMusic )
	...
	if(paused)
	{
	...
	}
	else
	{
	...
		while( drawable )
		{
			drawable->startAmbientSound();
			TheAudio->stopAllAmbientsBy( drawable );
			drawable = drawable->getNextDrawable(); // <--- This call makes no sense
		}
	}
...

void FXListDie::onDie( const DamageInfo *damageInfo )
{
	...
	if (d->m_defaultDeathFX)
	{
		// if the object has any ambient sound(s), kill 'em now.
		TheAudio->stopAllAmbientsBy(getObject());
		
		if (d->m_orientToObject)
		{
		...

Zero Hour

void FXListDie::onDie( const DamageInfo *damageInfo )
{
	...
	if (d->m_defaultDeathFX)
	{
		if (d->m_orientToObject)
		{
		...
}

I suggest to remove these virtual functions from Generals because they have no use in both titles.

[Mauller]

Yeah, if we don't think they are useful In the end I will remove them from both variants.

Will then make a followup PR to correct any code that used them.

Will also check the situation with the FXList variant wanting to kill ambient sounds on an object, I don't think Generals or zero hour puts ambient sounds on objects and only puts them on drawables.

[Mauller]

Yeah looks like only drawables have ambient sounds on them.

So the object version of the function would have needed to check if the object had a drawable, then it would have to disable the sound on the drawable if it had one.

Removed the instances of these functions in GameAudio and MilesAudioManager.

[Mauller]

Updated and addressed the discussed points above, will push a small followup PR to remove the stragling bits of code associated with the removed interface functions from GameAudio.

[Mauller]

Had to make a small push again to include the removal of calls to stopAllAmbientSoundsBy() since the build pipeline would fail otherwise for the generals build.

There are so few instances where these functions are called that it might as well be a part of this PR.

[xezon]

Is this change meant to be merged with rebase or not?

Commit number 3 of this change appears to error:

Error: D:\a\GeneralsGameCode\GeneralsGameCode\Generals\Code\GameEngine\Source\GameLogic\Object\Die\FXListDie.cpp(69) : error C2039: 'stopAllAmbientsBy' : is not a member of 'AudioManager'

[Mauller]

Is this change meant to be merged with rebase or not?

Commit number 3 of this change appears to error:

Error: D:\a\GeneralsGameCode\GeneralsGameCode\Generals\Code\GameEngine\Source\GameLogic\Object\Die\FXListDie.cpp(69) : error C2039: 'stopAllAmbientsBy' : is not a member of 'AudioManager'

The build of this PR should be fixed with the last commit i made to add removing those calls to stopAllAmbientsBy

since MilesAudioManager inherits from GameAudio, those two commits are kind of interdependent, so i thought it would be better to squash and merge this.

But merging by rebase should be okay, i tweaked the PR description above to cover this.

[xezon]

If commit number 3 fails to compile on its own, then it cannot be merged with rebase.

[Mauller]

If commit number 3 fails to compile on its own, then it cannot be merged with rebase.

Reordered the commits to break the problematic dependency.