refactor(milesaudiomanager): Clean up and simplify MilesAudioManager (TheSuperHackers#2718)

Author: xezon

Core/GameEngine/Include/Common/GameAudio.h

@@ -177,11 +177,10 @@ class AudioManager : public SubsystemInterface
 		AsciiString prevTrackName(const AsciiString& currentTrack );
 
 		// changing music tracks
-		virtual void nextMusicTrack() = 0;
-		virtual void prevMusicTrack() = 0;
+		virtual AsciiString nextMusicTrack() = 0;
+		virtual AsciiString prevMusicTrack() = 0;
 		virtual Bool isMusicPlaying() const = 0;
 		virtual Bool hasMusicTrackCompleted( const AsciiString& trackName, Int numberOfTimes ) const = 0;
-		virtual AsciiString getMusicTrackName() const = 0;
 
 		virtual void setAudioEventEnabled( AsciiString eventToAffect, Bool enable );
 		virtual void setAudioEventVolumeOverride( AsciiString eventToAffect, Real newVolume );

Core/GameEngineDevice/Include/MilesAudioDevice/MilesAudioManager.h

@@ -40,7 +40,6 @@ enum PlayingStatus CPP_11(: Int)
 {
 	PS_Playing,
 	PS_Stopped,
-	PS_Paused
 };
 
 enum PlayingWhich CPP_11(: Int)
@@ -60,22 +59,24 @@ struct PlayingAudio
 		HSTREAM m_stream;
 	};
 
-	PlayingAudioType m_type;
-	volatile PlayingStatus m_status;	// This member is adjusted by another running thread.
 	AudioEventRTS *m_audioEventRTS;
-	void *m_file;		// The file that was opened to play this
+	void *m_file; // The file that was opened to play this
+	PlayingAudioType m_type;
+	volatile PlayingStatus m_status; // This member is adjusted by another running thread.
+	Int m_framesFaded;
 	Bool m_requestStop;
 	Bool m_cleanupAudioEventRTS;
-	Int m_framesFaded;
 
-	PlayingAudio() :
-		m_type(PAT_INVALID),
-		m_audioEventRTS(nullptr),
-		m_requestStop(false),
-		m_cleanupAudioEventRTS(true),
-		m_sample(nullptr),
-		m_framesFaded(0)
-	{ }
+	PlayingAudio()
+		: m_sample(nullptr)
+		, m_audioEventRTS(nullptr)
+		, m_file(nullptr)
+		, m_type(PAT_INVALID)
+		, m_status(PS_Playing)
+		, m_framesFaded(0)
+		, m_requestStop(false)
+		, m_cleanupAudioEventRTS(true)
+	{}
 };
 
 struct ProviderInfo
@@ -114,7 +115,7 @@ class AudioFileCache
 		// End Protected by mutex
 
 		// Note: These functions should be used for informational purposes only. For speed reasons,
-		// they are not protected by the mutex, so they are not guarenteed to be valid if called from
+		// they are not protected by the mutex, so they are not guaranteed to be valid if called from
 		// outside the audio cache. They should be used as a rough estimate only.
 		UnsignedInt getCurrentlyUsedSize() const { return m_currentlyUsedSize; }
 		UnsignedInt getMaxSize() const { return m_maxSize; }
@@ -150,12 +151,10 @@ class MilesAudioManager : public AudioManager
 		MilesAudioManager();
 		virtual ~MilesAudioManager() override;
 
-
-		virtual void nextMusicTrack() override;
-		virtual void prevMusicTrack() override;
+		virtual AsciiString nextMusicTrack() override;
+		virtual AsciiString prevMusicTrack() override;
 		virtual Bool isMusicPlaying() const override;
 		virtual Bool hasMusicTrackCompleted( const AsciiString& trackName, Int numberOfTimes ) const override;
-		virtual AsciiString getMusicTrackName() const override;
 
 		virtual void openDevice() override;
 		virtual void closeDevice() override;
@@ -172,8 +171,8 @@ class MilesAudioManager : public AudioManager
 		///< NOTE NOTE NOTE !!DO NOT USE THIS IN FOR GAMELOGIC PURPOSES!! NOTE NOTE NOTE
 		virtual Bool isCurrentlyPlaying( AudioHandle handle ) override;
 
-		virtual void notifyOfAudioCompletion( UnsignedInt audioCompleted, UnsignedInt flags ) override;
-		virtual PlayingAudio *findPlayingAudioFrom( UnsignedInt audioCompleted, UnsignedInt flags );
+		virtual void notifyOfAudioCompletion( UnsignedInt handle, UnsignedInt flags ) override;
+		virtual PlayingAudio *findPlayingAudioFrom( UnsignedInt handle, UnsignedInt flags );
 
 		virtual UnsignedInt getProviderCount() const override;
 		virtual AsciiString getProviderName( UnsignedInt providerNum ) const override;
@@ -208,7 +207,6 @@ class MilesAudioManager : public AudioManager
 		virtual void processRequestList() override;
 		virtual void processPlayingList();
 		virtual void processFadingList();
-		virtual void processStoppedList();
 
 		Bool shouldProcessRequestThisFrame( AudioRequest *req ) const;
 		void adjustRequest( AudioRequest *req );
@@ -243,7 +241,6 @@ class MilesAudioManager : public AudioManager
 		void *playSample( AudioEventRTS *event, HSAMPLE sample );
 		void *playSample3D( AudioEventRTS *event, H3DSAMPLE sample3D );
 
-	protected:
 		void buildProviderList();
 		void createListener();
 		void initDelayFilter();
@@ -262,6 +259,9 @@ class MilesAudioManager : public AudioManager
 		void releaseMilesHandles( PlayingAudio *release );
 		void releasePlayingAudio( PlayingAudio *release );
 
+		PlayingAudio *findActiveMusic( const AsciiString *trackName = nullptr );
+		const PlayingAudio *findActiveMusic( const AsciiString* trackName = nullptr ) const;
+
 		void stopAllAudioImmediately();
 		void freeAllMilesHandles();
 
@@ -272,7 +272,6 @@ class MilesAudioManager : public AudioManager
 
 		void stopAllSpeech();
 
-	protected:
 		void initFilters( HSAMPLE sample, AudioEventRTS *eventInfo );
 		void initFilters3D( H3DSAMPLE sample, AudioEventRTS *eventInfo, const Coord3D *pos );
 
@@ -298,23 +297,16 @@ class MilesAudioManager : public AudioManager
 		std::list<HSAMPLE> m_availableSamples;
 		std::list<H3DSAMPLE> m_available3DSamples;
 
-		// Currently Playing stuff. Useful if we have to preempt it.
+		// Currently Playing audio. Useful if we have to preempt it.
 		// This should rarely if ever happen, as we mirror this in Sounds, and attempt to
 		// keep preemption from taking place here.
 		std::list<PlayingAudio *> m_playingSounds;
 		std::list<PlayingAudio *> m_playing3DSounds;
 		std::list<PlayingAudio *> m_playingStreams;
 
-		// Currently fading stuff. At this point, we just want to let it finish fading, when it is
-		// done it should be added to the completed list, then "freed" and the counts should be updated
-		// on the next update
+		// Currently fading music. We just let it finish fading, then release it.
 		std::list<PlayingAudio *> m_fadingAudio;
 
-		// Stuff that is done playing (either because it has finished or because it was killed)
-		// This stuff should be cleaned up during the next update cycle. This includes updating counts
-		// in the sound engine
-		std::list<PlayingAudio *> m_stoppedAudio;
-
 		AudioFileCache *m_audioCache;
 		PlayingAudio *m_binkHandle;
 		UnsignedInt m_num2DSamples;
@@ -343,17 +335,16 @@ class MilesAudioManagerDummy : public MilesAudioManager
 	virtual void resumeAudio(AudioAffect which) override {}
 	virtual void pauseAmbient(Bool shouldPause) override {}
 	virtual void killAudioEventImmediately(AudioHandle audioEvent) override {}
-	virtual void nextMusicTrack() override {}
-	virtual void prevMusicTrack() override {}
+	virtual AsciiString nextMusicTrack() override { return AsciiString::TheEmptyString; }
+	virtual AsciiString prevMusicTrack() override { return AsciiString::TheEmptyString; }
 	virtual Bool isMusicPlaying() const override { return false; }
 	virtual Bool hasMusicTrackCompleted(const AsciiString& trackName, Int numberOfTimes) const override { return false; }
-	virtual AsciiString getMusicTrackName() const override { return ""; }
 	//virtual void openDevice() override {}
 	//virtual void closeDevice() override {}
 	//virtual void* getDevice() override { return nullptr; }
 	virtual void notifyOfAudioCompletion(UnsignedInt audioCompleted, UnsignedInt flags) override {}
 	virtual UnsignedInt getProviderCount() const override { return 0; };
-	virtual AsciiString getProviderName(UnsignedInt providerNum) const override { return ""; }
+	virtual AsciiString getProviderName(UnsignedInt providerNum) const override { return AsciiString::TheEmptyString; }
 	virtual UnsignedInt getProviderIndex(AsciiString providerName) const override { return 0; }
 	virtual void selectProvider(UnsignedInt providerNdx) override {}
 	virtual void unselectProvider() override {}