feat: Remove CD management code

The Pull Request TheSuperHackers#2203 made by @fbraz3 on the upstream repository inspired a deeper audit of the legacy CD requirements in the engine. Beyond merely skipping the startup prompt, it was discovered that large portions of the engine's CD-management infrastructure have become vestigial in modern execution environments.

This commit implements a comprehensive modernization by pruning approximately 2,000 lines of dead code across the Core, Generals, and Zero Hour variants.

This plan assumes the Music.big(zh) archive is located in the local game directory. If it is missing from the local folder, music will simply not play instead of prompting the user.

Tested all parts (init, singleplayer, skirmish) where this code was active, didn't find any problems.

Author: Chapter5780

Core/GameEngine/CMakeLists.txt

@@ -19,7 +19,6 @@ set(GAMEENGINE_SRC
 #    Include/Common/BitFlagsIO.h
 #    Include/Common/BorderColors.h
 #    Include/Common/BuildAssistant.h
-#    Include/Common/CDManager.h
 #    Include/Common/ClientUpdateModule.h
 #    Include/Common/CommandLine.h
     Include/Common/crc.h
@@ -643,7 +642,6 @@ set(GAMEENGINE_SRC
     Source/Common/System/ArchiveFileSystem.cpp
     Source/Common/System/AsciiString.cpp
 #    Source/Common/System/BuildAssistant.cpp
-#    Source/Common/System/CDManager.cpp
 #    Source/Common/System/CriticalSection.cpp
 #    Source/Common/System/DataChunk.cpp
     Source/Common/System/Debug.cpp

Core/GameEngine/Include/Common/FileSystem.h

@@ -155,9 +155,6 @@ class FileSystem : public SubsystemInterface
 
 	Bool createDirectory(AsciiString directory); ///< create a directory of the given name.
 
-	Bool areMusicFilesOnCD();
-	void loadMusicFilesFromCD();
-	void unloadMusicFilesFromCD();
 
 	static AsciiString normalizePath(const AsciiString& path);	///< normalizes a file path. The path can refer to a directory. File path must be absolute, but does not need to exist. Returns an empty string on failure.
 	static Bool isPathInDirectory(const AsciiString& testPath, const AsciiString& basePath);	///< determines if a file path is within a base path. Both paths must be absolute, but do not need to exist.

Core/GameEngine/Include/Common/GameAudio.h

@@ -287,7 +287,6 @@ class AudioManager : public SubsystemInterface
 		virtual void closeAnySamplesUsingFile( const void *fileToClose ) = 0;
 
 		virtual Bool isMusicAlreadyLoaded(void) const;
-		virtual Bool isMusicPlayingFromCD(void) const { return m_musicPlayingFromCD; }
 
 		Bool getDisallowSpeech( void ) const { return m_disallowSpeech; }
 		void setDisallowSpeech( Bool disallowSpeech ) { m_disallowSpeech = disallowSpeech; }
@@ -370,7 +369,6 @@ class AudioManager : public SubsystemInterface
 		Bool m_volumeHasChanged		: 1;
 		Bool m_hardwareAccel			: 1;
 		Bool m_surroundSpeakers		: 1;
-		Bool m_musicPlayingFromCD : 1;
 
 		// Next 8
 		Bool m_disallowSpeech			: 1;

Core/GameEngine/Source/Common/Audio/GameAudio.cpp

@@ -149,8 +149,7 @@ AudioManager::AudioManager() :
 	m_music(nullptr),
 	m_sound(nullptr),
 	m_surroundSpeakers(FALSE),
-	m_hardwareAccel(FALSE),
-	m_musicPlayingFromCD(FALSE)
+	m_hardwareAccel(FALSE)
 {
 	m_adjustedVolumes.clear();
 	m_audioRequests.clear();
@@ -224,34 +223,6 @@ void AudioManager::init()
 	// do the miscellaneous sound files last so that we find the AudioEventRTS associated with the events.
 	ini.loadFileDirectory( "Data\\INI\\MiscAudio", INI_LOAD_OVERWRITE, nullptr);
 
-	// determine if one of the music tracks exists. Since their now BIGd, one implies all.
-	// If they don't exist, then attempt to load them from the CD.
-	if (!TheGlobalData->m_headless && !isMusicAlreadyLoaded())
-	{
-		m_musicPlayingFromCD = TRUE;
-		while (TRUE)
-		{
-			// @todo Unload any files from CD first. - jkmcd
-
-			TheFileSystem->loadMusicFilesFromCD();
-			if (isMusicAlreadyLoaded())
-			{
-				break;
-			}
-			// We loop infinitely on the splash screen if we don't allow breaking out of this loop.
-//#if !defined( RTS_DEBUG )
-			else
-			{
-				// Display the warning.
-
-				if (OSDisplayWarningBox("GUI:InsertCDPrompt", "GUI:InsertCDMessage", OSDBT_OK | OSDBT_CANCEL, OSDOF_SYSTEMMODAL | OSDOF_EXCLAMATIONICON) == OSDBT_CANCEL) {
-					//TheGameEngine->setQuitting(TRUE);  // Can't do this to WorldBuilder
-					break;
-				}
-			}
-//#endif
-		}
-	}
 
 	m_music = NEW MusicManager;
 	m_sound = NEW SoundManager;

Core/GameEngine/Source/Common/System/FileSystem.cpp

@@ -50,7 +50,6 @@
 #include "Common/FileSystem.h"
 
 #include "Common/ArchiveFileSystem.h"
-#include "Common/CDManager.h"
 #include "Common/GameAudio.h"
 #include "Common/LocalFileSystem.h"
 #include "Common/PerfTimer.h"
@@ -330,84 +329,6 @@ Bool FileSystem::createDirectory(AsciiString directory)
 	return FALSE;
 }
 
-//============================================================================
-// FileSystem::areMusicFilesOnCD
-//============================================================================
-Bool FileSystem::areMusicFilesOnCD()
-{
-#if 1
-	return TRUE;
-#else
-	if (!TheCDManager) {
-		DEBUG_LOG(("FileSystem::areMusicFilesOnCD() - No CD Manager; returning false"));
-		return FALSE;
-	}
-
-	AsciiString cdRoot;
-	Int dc = TheCDManager->driveCount();
-	for (Int i = 0; i < dc; ++i) {
-		DEBUG_LOG(("FileSystem::areMusicFilesOnCD() - checking drive %d", i));
-		CDDriveInterface *cdi = TheCDManager->getDrive(i);
-		if (!cdi) {
-			continue;
-		}
-
-		cdRoot = cdi->getPath();
-		if (!cdRoot.endsWith("\\"))
-			cdRoot.concat("\\");
-#if RTS_GENERALS
-		cdRoot.concat("gensec.big");
-#elif RTS_ZEROHOUR
-		cdRoot.concat("genseczh.big");
-#endif
-		DEBUG_LOG(("FileSystem::areMusicFilesOnCD() - checking for %s", cdRoot.str()));
-		File *musicBig = TheLocalFileSystem->openFile(cdRoot.str());
-		if (musicBig)
-		{
-			DEBUG_LOG(("FileSystem::areMusicFilesOnCD() - found it!"));
-			musicBig->close();
-			return TRUE;
-		}
-	}
-	return FALSE;
-#endif
-}
-//============================================================================
-// FileSystem::loadMusicFilesFromCD
-//============================================================================
-void FileSystem::loadMusicFilesFromCD()
-{
-	if (!TheCDManager) {
-		return;
-	}
-
-	AsciiString cdRoot;
-	Int dc = TheCDManager->driveCount();
-	for (Int i = 0; i < dc; ++i) {
-		CDDriveInterface *cdi = TheCDManager->getDrive(i);
-		if (!cdi) {
-			continue;
-		}
-
-		cdRoot = cdi->getPath();
-		if (TheArchiveFileSystem->loadBigFilesFromDirectory(cdRoot, MUSIC_BIG)) {
-			break;
-		}
-	}
-}
-
-//============================================================================
-// FileSystem::unloadMusicFilesFromCD
-//============================================================================
-void FileSystem::unloadMusicFilesFromCD()
-{
-	if (!(TheAudio && TheAudio->isMusicPlayingFromCD())) {
-		return;
-	}
-
-	TheArchiveFileSystem->closeArchiveFile( MUSIC_BIG );
-}
-
 //============================================================================
 // FileSystem::normalizePath
 //============================================================================

Generals/Code/GameEngine/CMakeLists.txt

@@ -16,7 +16,6 @@ set(GAMEENGINE_SRC
     Include/Common/BitFlags.h
     Include/Common/BitFlagsIO.h
     Include/Common/BuildAssistant.h
-    Include/Common/CDManager.h
     Include/Common/ClientUpdateModule.h
     Include/Common/CommandLine.h
 #    Include/Common/crc.h
@@ -134,7 +133,6 @@ set(GAMEENGINE_SRC
     Include/GameClient/AnimateWindowManager.h
 #    Include/GameClient/ChallengeGenerals.h
     Include/GameClient/CampaignManager.h
-    Include/GameClient/CDCheck.h
     Include/GameClient/ClientInstance.h
 #    Include/GameClient/ClientRandomValue.h
     Include/GameClient/Color.h
@@ -592,7 +590,6 @@ set(GAMEENGINE_SRC
 #    Source/Common/System/ArchiveFileSystem.cpp
 #    Source/Common/System/AsciiString.cpp
     Source/Common/System/BuildAssistant.cpp
-    Source/Common/System/CDManager.cpp
     Source/Common/System/CriticalSection.cpp
     Source/Common/System/DataChunk.cpp
 #    Source/Common/System/Debug.cpp