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.

Community investigations (thanks to tomsons26) revealed that the Music.big handling was primarily a copy protection mechanism (SafeDisc) rather than for streaming audio. The engine attempted to read a specific file (often generalsa.sec) from the archive to verify a hash. Failure to read this file would trigger copy protection. This mechanism has been non-functional from the start and is now removed.

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

Author: xezon

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
 //============================================================================

Core/GameEngineDevice/Include/W3DDevice/Common/W3DRadar.h

@@ -110,6 +110,7 @@ class W3DRadar : public Radar
 	SurfaceClass *m_shroudSurface;								///< surface to shroud texture
 	void *m_shroudSurfaceBits;										///< shroud surface bits
 	int m_shroudSurfacePitch;											///< shroud surface pitch
+	WW3DFormat m_shroudSurfaceFormat;							///< shroud surface format
 	UnsignedInt m_shroudSurfacePixelSize;					///< shroud surface pixel size
 
 	Int m_textureWidth;														///< width for all radar textures

Core/GameEngineDevice/Source/W3DDevice/Common/System/W3DRadar.cpp

@@ -700,9 +700,11 @@ void W3DRadar::renderObjectList( const RadarObject *listHead, TextureClass *text
 
 	Player *player = rts::getObservedOrLocalPlayer();
 
+	SurfaceClass::SurfaceDescription surfaceDesc;
+	surface->Get_Description(surfaceDesc);
 	int pitch;
 	void *pBits = surface->Lock(&pitch);
-	const unsigned int bytesPerPixel = surface->Get_Bytes_Per_Pixel();
+	const unsigned int bytesPerPixel = Get_Bytes_Per_Pixel(surfaceDesc.Format);
 
 	for( const RadarObject *rObj = listHead; rObj; rObj = rObj->friend_getNext() )
 	{
@@ -718,7 +720,7 @@ void W3DRadar::renderObjectList( const RadarObject *listHead, TextureClass *text
 		radarPoint.y = pos->y / (m_mapExtent.height() / RADAR_CELL_HEIGHT);
 
 		// get the color we're going to draw in
-		Color c = rObj->getColor();
+		Color argbColor = rObj->getColor();
 
 		// adjust the alpha for stealth units so they "fade/blink" on the radar for the controller
 		// if( obj->getRadarPriority() == RADAR_PRIORITY_LOCAL_UNIT_ONLY )
@@ -727,7 +729,7 @@ void W3DRadar::renderObjectList( const RadarObject *listHead, TextureClass *text
 		if( obj->testStatus( OBJECT_STATUS_STEALTHED ) )
 		{
 			UnsignedByte r, g, b, a;
-			GameGetColorComponents( c, &r, &g, &b, &a );
+			GameGetColorComponents( argbColor, &r, &g, &b, &a );
 
 			const UnsignedInt framesForTransition = LOGICFRAMES_PER_SECOND;
 			const UnsignedByte minAlpha = 32;
@@ -737,25 +739,27 @@ void W3DRadar::renderObjectList( const RadarObject *listHead, TextureClass *text
 				a = REAL_TO_UNSIGNEDBYTE( ((alphaScale - 1.0f) * (255.0f - minAlpha)) + minAlpha );
 			else
 				a = REAL_TO_UNSIGNEDBYTE( (alphaScale * (255.0f - minAlpha)) + minAlpha );
-			c = GameMakeColor( r, g, b, a );
+			argbColor = GameMakeColor( r, g, b, a );
 
 		}
 
+		const unsigned int pixelColor = ARGB_Color_To_WW3D_Color(surfaceDesc.Format, argbColor);
+
 		// draw the blip, but make sure the points are legal
 		if( legalRadarPoint( radarPoint.x, radarPoint.y ) )
-			surface->Draw_Pixel( radarPoint.x, radarPoint.y, c, bytesPerPixel, pBits, pitch );
+			surface->Draw_Pixel( radarPoint.x, radarPoint.y, pixelColor, bytesPerPixel, pBits, pitch );
 
 		radarPoint.y++;
 		if( legalRadarPoint( radarPoint.x, radarPoint.y ) )
-			surface->Draw_Pixel( radarPoint.x, radarPoint.y, c, bytesPerPixel, pBits, pitch );
+			surface->Draw_Pixel( radarPoint.x, radarPoint.y, pixelColor, bytesPerPixel, pBits, pitch );
 
 		radarPoint.x++;
 		if( legalRadarPoint( radarPoint.x, radarPoint.y ) )
-			surface->Draw_Pixel( radarPoint.x, radarPoint.y, c, bytesPerPixel, pBits, pitch );
+			surface->Draw_Pixel( radarPoint.x, radarPoint.y, pixelColor, bytesPerPixel, pBits, pitch );
 
 		radarPoint.y--;
 		if( legalRadarPoint( radarPoint.x, radarPoint.y ) )
-			surface->Draw_Pixel( radarPoint.x, radarPoint.y, c, bytesPerPixel, pBits, pitch );
+			surface->Draw_Pixel( radarPoint.x, radarPoint.y, pixelColor, bytesPerPixel, pBits, pitch );
 
 	}
 
@@ -860,6 +864,7 @@ W3DRadar::W3DRadar( void )
 	m_shroudSurface = nullptr;
 	m_shroudSurfaceBits = nullptr;
 	m_shroudSurfacePitch = 0;
+	m_shroudSurfaceFormat = WW3D_FORMAT_UNKNOWN;
 	m_shroudSurfacePixelSize = 0;
 
 	m_textureWidth = RADAR_CELL_WIDTH;
@@ -1078,9 +1083,11 @@ void W3DRadar::buildTerrainTexture( TerrainLogic *terrain )
 	Coord3D worldPoint;
 	Bridge *bridge;
 
+	SurfaceClass::SurfaceDescription surfaceDesc;
+	surface->Get_Description(surfaceDesc);
 	int pitch;
 	void *pBits = surface->Lock(&pitch);
-	const unsigned int bytesPerPixel = surface->Get_Bytes_Per_Pixel();
+	const unsigned int bytesPerPixel = Get_Bytes_Per_Pixel(surfaceDesc.Format);
 
 	for( y = 0; y < m_textureHeight; y++ )
 	{
@@ -1269,7 +1276,8 @@ void W3DRadar::buildTerrainTexture( TerrainLogic *terrain )
 
 			// draw the pixel for the terrain at this point, note that because of the orientation
 			// of our world we draw it with positive y in the "up" direction
-			Color pixelColor = GameMakeColor( color.red * 255, color.green * 255, color.blue * 255, 255 );
+			const Color argbColor = GameMakeColor( color.red * 255, color.green * 255, color.blue * 255, 255 );
+			const unsigned int pixelColor = ARGB_Color_To_WW3D_Color(surfaceDesc.Format, argbColor);
 			surface->Draw_Pixel( x, y, pixelColor, bytesPerPixel, pBits, pitch );
 
 		}
@@ -1364,16 +1372,19 @@ void W3DRadar::setShroudLevel(Int shroudX, Int shroudY, CellShroudStatus setting
 		// This is expensive.
 		SurfaceClass* surface = m_shroudTexture->Get_Surface_Level();
 		DEBUG_ASSERTCRASH( surface, ("W3DRadar: Can't get surface for Shroud texture") );
+		SurfaceClass::SurfaceDescription surfaceDesc;
+		surface->Get_Description(surfaceDesc);
 		int pitch;
 		void *pBits = surface->Lock(&pitch);
-		const unsigned int bytesPerPixel = surface->Get_Bytes_Per_Pixel();
-		const Color color = GameMakeColor( 0, 0, 0, alpha );
+		const unsigned int bytesPerPixel = Get_Bytes_Per_Pixel(surfaceDesc.Format);
+		const Color argbColor = GameMakeColor( 0, 0, 0, alpha );
+		const unsigned int pixelColor = ARGB_Color_To_WW3D_Color(surfaceDesc.Format, argbColor);
 
 		for( Int y = radarMinY; y <= radarMaxY; ++y )
 		{
 			for( Int x = radarMinX; x <= radarMaxX; ++x )
 			{
-				surface->Draw_Pixel( x, y, color, bytesPerPixel, pBits, pitch );
+				surface->Draw_Pixel( x, y, pixelColor, bytesPerPixel, pBits, pitch );
 			}
 		}
 
@@ -1384,14 +1395,16 @@ void W3DRadar::setShroudLevel(Int shroudX, Int shroudY, CellShroudStatus setting
 	{
 		// This is cheap.
 		DEBUG_ASSERTCRASH(m_shroudSurfaceBits != nullptr, ("W3DRadar::setShroudLevel: m_shroudSurfaceBits is not expected null"));
+		DEBUG_ASSERTCRASH(m_shroudSurfaceFormat != WW3D_FORMAT_UNKNOWN, ("W3DRadar::setShroudLevel: m_shroudSurfaceFormat is not expected UNKNOWN"));
 		DEBUG_ASSERTCRASH(m_shroudSurfacePixelSize != 0, ("W3DRadar::setShroudLevel: m_shroudSurfacePixelSize is not expected 0"));
-		const Color color = GameMakeColor( 0, 0, 0, alpha );
+		const Color argbColor = GameMakeColor( 0, 0, 0, alpha );
+		const unsigned int pixelColor = ARGB_Color_To_WW3D_Color(m_shroudSurfaceFormat, argbColor);
 
 		for( Int y = radarMinY; y <= radarMaxY; ++y )
 		{
 			for( Int x = radarMinX; x <= radarMaxX; ++x )
 			{
-				m_shroudSurface->Draw_Pixel( x, y, color, m_shroudSurfacePixelSize, m_shroudSurfaceBits, m_shroudSurfacePitch );
+				m_shroudSurface->Draw_Pixel( x, y, pixelColor, m_shroudSurfacePixelSize, m_shroudSurfaceBits, m_shroudSurfacePitch );
 			}
 		}
 	}
@@ -1403,10 +1416,11 @@ void W3DRadar::beginSetShroudLevel()
 	m_shroudSurface = m_shroudTexture->Get_Surface_Level();
 	DEBUG_ASSERTCRASH( m_shroudSurface != nullptr, ("W3DRadar::beginSetShroudLevel: Can't get surface for Shroud texture") );
 
-	SurfaceClass::SurfaceDescription sd;
-	m_shroudSurface->Get_Description(sd);
+	SurfaceClass::SurfaceDescription surfaceDesc;
+	m_shroudSurface->Get_Description(surfaceDesc);
 	m_shroudSurfaceBits = m_shroudSurface->Lock(&m_shroudSurfacePitch);
-	m_shroudSurfacePixelSize = Get_Bytes_Per_Pixel(sd.Format);
+	m_shroudSurfaceFormat = surfaceDesc.Format;
+	m_shroudSurfacePixelSize = Get_Bytes_Per_Pixel(surfaceDesc.Format);
 }
 
 void W3DRadar::endSetShroudLevel()
@@ -1417,6 +1431,7 @@ void W3DRadar::endSetShroudLevel()
 		m_shroudSurface->Unlock();
 		m_shroudSurfaceBits = nullptr;
 		m_shroudSurfacePitch = 0;
+		m_shroudSurfaceFormat = WW3D_FORMAT_UNKNOWN;
 		m_shroudSurfacePixelSize = 0;
 	}
 	REF_PTR_RELEASE(m_shroudSurface);