[ZH] Implement Headless Mode (TheSuperHackers#651)

Author: helmutbuhler

GeneralsMD/Code/GameEngine/Include/Common/GameAudio.h

@@ -372,6 +372,57 @@ class AudioManager : public SubsystemInterface
 		Bool m_disallowSpeech			: 1;
 };
 
+// TheSuperHackers @feature helmutbuhler 17/05/2025
+// AudioManager that does nothing. Used for Headless Mode.
+class AudioManagerDummy : public AudioManager
+{
+#if defined(RTS_DEBUG) || defined(RTS_INTERNAL)
+	virtual void audioDebugDisplay(DebugDisplayInterface* dd, void* userData, FILE* fp) {}
+#endif
+	virtual void stopAudio(AudioAffect which) {}
+	virtual void pauseAudio(AudioAffect which) {}
+	virtual void resumeAudio(AudioAffect which) {}
+	virtual void pauseAmbient(Bool shouldPause) {}
+	virtual void killAudioEventImmediately(AudioHandle audioEvent) {}
+	virtual void nextMusicTrack() {}
+	virtual void prevMusicTrack() {}
+	virtual Bool isMusicPlaying() const { return false; }
+	virtual Bool hasMusicTrackCompleted(const AsciiString& trackName, Int numberOfTimes) const { return false; }
+	virtual AsciiString getMusicTrackName() const { return ""; }
+	virtual void openDevice() {}
+	virtual void closeDevice() {}
+	virtual void* getDevice() { return NULL; }
+	virtual void notifyOfAudioCompletion(UnsignedInt audioCompleted, UnsignedInt flags) {}
+	virtual UnsignedInt getProviderCount(void) const { return 0; };
+	virtual AsciiString getProviderName(UnsignedInt providerNum) const { return ""; }
+	virtual UnsignedInt getProviderIndex(AsciiString providerName) const { return 0; }
+	virtual void selectProvider(UnsignedInt providerNdx) {}
+	virtual void unselectProvider(void) {}
+	virtual UnsignedInt getSelectedProvider(void) const { return 0; }
+	virtual void setSpeakerType(UnsignedInt speakerType) {}
+	virtual UnsignedInt getSpeakerType(void) { return 0; }
+	virtual UnsignedInt getNum2DSamples(void) const { return 0; }
+	virtual UnsignedInt getNum3DSamples(void) const { return 0; }
+	virtual UnsignedInt getNumStreams(void) const { return 0; }
+	virtual Bool doesViolateLimit(AudioEventRTS* event) const { return false; }
+	virtual Bool isPlayingLowerPriority(AudioEventRTS* event) const { return false; }
+	virtual Bool isPlayingAlready(AudioEventRTS* event) const { return false; }
+	virtual Bool isObjectPlayingVoice(UnsignedInt objID) const { return false; }
+	virtual void adjustVolumeOfPlayingAudio(AsciiString eventName, Real newVolume) {}
+	virtual void removePlayingAudio(AsciiString eventName) {}
+	virtual void removeAllDisabledAudio() {}
+	virtual Bool has3DSensitiveStreamsPlaying(void) const { return false; }
+	virtual void* getHandleForBink(void) { return NULL; }
+	virtual void releaseHandleForBink(void) {}
+	virtual void friend_forcePlayAudioEventRTS(const AudioEventRTS* eventToPlay) {}
+	virtual void setPreferredProvider(AsciiString providerNdx) {}
+	virtual void setPreferredSpeaker(AsciiString speakerType) {}
+	virtual Real getFileLengthMS(AsciiString strToLoad) const { return -1; }
+	virtual void closeAnySamplesUsingFile(const void* fileToClose) {}
+	virtual void setDeviceListenerPosition(void) {}
+};
+
+
 extern AudioManager *TheAudio;
 
 #endif // __COMMON_GAMEAUDIO_H_

GeneralsMD/Code/GameEngine/Include/Common/GlobalData.h

@@ -100,6 +100,11 @@ class GlobalData : public SubsystemInterface
 	Bool m_dumpAssetUsage;
 	Int m_framesPerSecondLimit;
 	Int	m_chipSetType;	///<See W3DShaderManager::ChipsetType for options
+
+	// TheSuperHackers @feature helmutbuhler 11/04/2025
+	// Run game without graphics, input or audio.
+	Bool m_headless;
+	
 	Bool m_windowed;
 	Int m_xResolution;
 	Int m_yResolution;

GeneralsMD/Code/GameEngine/Include/Common/Radar.h

@@ -293,6 +293,16 @@ class Radar : public Snapshot,
 // EXTERNALS //////////////////////////////////////////////////////////////////////////////////////
 extern Radar *TheRadar;  ///< the radar singleton extern
 
+// TheSuperHackers @feature helmutbuhler 10/04/2025
+// Radar that does nothing. Used for Headless Mode.
+class RadarDummy : public Radar
+{
+public:
+	virtual void draw(Int pixelX, Int pixelY, Int width, Int height) { }
+	virtual void clearShroud() { }
+	virtual void setShroudLevel(Int x, Int y, CellShroudStatus setting) { }
+};
+
 #endif  // __RADAR_H_
 
 

GeneralsMD/Code/GameEngine/Include/GameClient/GameClient.h

@@ -259,4 +259,47 @@ inline Drawable* GameClient::findDrawableByID( const DrawableID id )
 // the singleton
 extern GameClient *TheGameClient;
 
+
+// TheSuperHackers @logic-client-separation helmutbuhler 11/04/2025
+// Some information about the architecture and headless mode:
+// The game is structurally separated into GameLogic and GameClient.
+// The Logic is responsible for everything that affects the game mechanic and what is synchronized over
+// the network. The Client is responsible for rendering, input, audio and similar stuff.
+// 
+// Unfortunately there are some places in the code that make the Logic depend on the Client.
+// (Search for @logic-client-separation)
+// That means if we want to run the game headless, we cannot just disable the Client. We need to disable
+// the parts in the Client that don't work in headless mode and need to keep the parts that are needed
+// to run the Logic.
+// The following describes which parts we disable in headless mode:
+//
+//	GameEngine:
+//		TheGameClient is partially disabled:
+//			TheKeyboard = NULL
+//			TheMouse = NULL
+//			TheDisplay is partially disabled:
+//				m_3DInterfaceScene = NULL
+//				m_2DScene = NULL
+//				m_3DScene = NULL
+//				(m_assetManager remains!)
+//			TheWindowManager = GameWindowManagerDummy
+//			TheIMEManager = NULL
+//			TheTerrainVisual is partially disabled:
+//				TheTerrainTracksRenderObjClassSystem = NULL
+//				TheW3DShadowManager = NULL
+//				TheWaterRenderObj = NULL
+//				TheSmudgeManager = NULL
+//				TheTerrainRenderObject is partially disabled:
+//					m_treeBuffer = NULL
+//					m_propBuffer = NULL
+//					m_bibBuffer = NULL
+//					m_bridgeBuffer is partially disabled:
+//						m_vertexBridge = NULL
+//						m_indexBridge = NULL
+//						m_vertexMaterial = NULL
+//					m_waypointBuffer = NULL
+//					m_roadBuffer = NULL
+//					m_shroud = NULL
+//		TheRadar = RadarDummy
+
 #endif // _GAME_INTERFACE_H_

GeneralsMD/Code/GameEngine/Include/GameClient/GameWindow.h

@@ -326,7 +326,7 @@ friend class GameWindowManager;
 	// window instance data
 	Int winSetInstanceData( WinInstanceData *data );  ///< copy over instance data
 	WinInstanceData *winGetInstanceData( void );  ///< get instance data
-	void *winGetUserData( void );  ///< get the window user data
+	virtual void *winGetUserData( void );  ///< get the window user data
 	void winSetUserData( void *userData );  ///< set the user data
 
 	// heirarchy methods
@@ -435,6 +435,16 @@ friend class GameWindowManager;
 
 };  // end class GameWindow
 
+// TheSuperHackers @feature helmutbuhler 24/04/2025
+// GameWindow that does nothing. Used for Headless Mode.
+class GameWindowDummy : public GameWindow
+{
+	MEMORY_POOL_GLUE_WITH_USERLOOKUP_CREATE(GameWindowDummy, "GameWindowDummy")
+public:
+	virtual void winDrawBorder() {}
+	virtual void* winGetUserData(void) { return NULL; }
+};
+
 // ModalWindow ----------------------------------------------------------------
 //-----------------------------------------------------------------------------
 class ModalWindow : public MemoryPoolObject

GeneralsMD/Code/GameEngine/Include/GameClient/GameWindowManager.h

@@ -379,7 +379,39 @@ extern WindowMsgHandledType PassMessagesToParentSystem( GameWindow *window,
 																															 WindowMsgData mData1, 
 																															 WindowMsgData mData2 );
 
-
+// TheSuperHackers @feature helmutbuhler 24/04/2025
+// GameWindowManager that does nothing. Used for Headless Mode.
+class GameWindowManagerDummy : public GameWindowManager
+{
+public:
+	virtual GameWindow *winGetWindowFromId(GameWindow *window, Int id);
+	virtual GameWindow *winCreateFromScript(AsciiString filenameString, WindowLayoutInfo *info);
+
+	virtual GameWindow *allocateNewWindow() { return newInstance(GameWindowDummy); }
+
+	virtual GameWinDrawFunc getPushButtonImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getPushButtonDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getCheckBoxImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getCheckBoxDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getRadioButtonImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getRadioButtonDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTabControlImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTabControlDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getListBoxImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getListBoxDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getComboBoxImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getComboBoxDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getHorizontalSliderImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getHorizontalSliderDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getVerticalSliderImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getVerticalSliderDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getProgressBarImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getProgressBarDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getStaticTextImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getStaticTextDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTextEntryImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTextEntryDrawFunc() { return NULL; }
+};
 
 #endif // __GAMEWINDOWMANAGER_H_
 

GeneralsMD/Code/GameEngine/Include/GameClient/Mouse.h

@@ -371,7 +371,20 @@ class Mouse : public SubsystemInterface
 
 };  // end class Mouse
 
-// INLINING ///////////////////////////////////////////////////////////////////
+// TheSuperHackers @feature helmutbuhler 17/05/2025
+// Mouse that does nothing. Used for Headless Mode.
+class MouseDummy : public Mouse
+{
+	virtual void parseIni() {}
+	virtual void update() {}
+	virtual void initCursorResources() {}
+	virtual void createStreamMessages() {}
+	virtual void setCursor(MouseCursor cursor) {}
+	virtual void capture() {}
+	virtual void releaseCapture() {}
+	virtual UnsignedByte getMouseEvent(MouseIO *result, Bool flush) { return MOUSE_NONE; }
+};
+
 
 // EXTERNALS //////////////////////////////////////////////////////////////////
 extern Mouse *TheMouse;  ///< extern mouse singleton definition

GeneralsMD/Code/GameEngine/Source/Common/CommandLine.cpp

@@ -862,6 +862,15 @@ Int parseQuickStart( char *args[], int num )
 	return 1;
 }
 
+Int parseHeadless( char *args[], int num )
+{
+	if (TheWritableGlobalData)
+	{
+		TheWritableGlobalData->m_headless = TRUE;
+	}
+	return 1;
+}
+
 Int parseConstantDebug( char *args[], int num )
 {
 	if (TheWritableGlobalData)
@@ -1206,6 +1215,10 @@ static CommandLineParam params[] =
 	{ "-quickstart", parseQuickStart },
 	{ "-useWaveEditor", parseUseWaveEditor },
 
+	// TheSuperHackers @feature helmutbuhler 11/04/2025
+	// This runs the game without a window, graphics, input and audio. Used for testing.
+	{ "-headless", parseHeadless },
+
 #if (defined(RTS_DEBUG) || defined(RTS_INTERNAL))
 	{ "-noaudio", parseNoAudio },
 	{ "-map", parseMapName },

GeneralsMD/Code/GameEngine/Source/Common/GameEngine.cpp

@@ -437,7 +437,7 @@ void GameEngine::init( int argc, char *argv[] )
   startTime64 = endTime64;//Reset the clock ////////////////////////////////////////////////////////
 	DEBUG_LOG(("%s", Buf));////////////////////////////////////////////////////////////////////////////
 	#endif/////////////////////////////////////////////////////////////////////////////////////////////
-		initSubsystem(TheAudio,"TheAudio", createAudioManager(), NULL);
+		initSubsystem(TheAudio,"TheAudio", TheGlobalData->m_headless ? NEW AudioManagerDummy : createAudioManager(), NULL);
 		if (!TheAudio->isMusicAlreadyLoaded())
 			setQuitting(TRUE);
 
@@ -513,7 +513,7 @@ void GameEngine::init( int argc, char *argv[] )
 		initSubsystem(TheCrateSystem,"TheCrateSystem", MSGNEW("GameEngineSubsystem") CrateSystem(), &xferCRC, "Data\\INI\\Default\\Crate.ini", "Data\\INI\\Crate.ini");
 		initSubsystem(ThePlayerList,"ThePlayerList", MSGNEW("GameEngineSubsystem") PlayerList(), NULL);
 		initSubsystem(TheRecorder,"TheRecorder", createRecorder(), NULL);
-		initSubsystem(TheRadar,"TheRadar", createRadar(), NULL);
+		initSubsystem(TheRadar,"TheRadar", TheGlobalData->m_headless ? NEW RadarDummy : createRadar(), NULL);
 		initSubsystem(TheVictoryConditions,"TheVictoryConditions", createVictoryConditions(), NULL);
 
 

GeneralsMD/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -613,6 +613,7 @@ GlobalData::GlobalData()
 	m_dumpAssetUsage = FALSE;
 	m_framesPerSecondLimit = 0;
 	m_chipSetType = 0;
+	m_headless = FALSE;
 	m_windowed = 0;
 	m_xResolution = 800;
 	m_yResolution = 600;