Ticket #9: t0009_visualreplay_v1_r16653.patch

source/network/NetTurnManager.cpp

@@ -462 +462 @@
 void CNetLocalTurnManager::OnSimulationMessage(CSimulationMessage* UNUSED(msg))
 {
     debug_warn(L"This should never be called");
 }
 
+CNetReplayTurnManager::CNetReplayTurnManager(CSimulation2& simulation, IReplayLogger& replay) :
+    CNetLocalTurnManager(simulation, replay)
+{
+}
+
+void CNetReplayTurnManager::StoreReplayCommand(u32 turn, int player, const std::string& command)
+{
+    m_ReplayCommands[turn][player].push_back(command);
+}
+
+void CNetReplayTurnManager::StoreReplayHash(u32 turn, const std::string& hash, bool quick)
+{
+    m_ReplayHash[turn] = std::make_pair(hash, quick);
+}
+
+void CNetReplayTurnManager::StoreReplayTurnLength(u32 turn, u32 turnLength)
+{
+    debug_printf("Setting turn %d length to %d\n", turn, turnLength);
+    m_ReplayTurnLengths[turn] = turnLength;
+
+    // Initialize turn length
+    if (turn == 0)
+        m_TurnLength = m_ReplayTurnLengths[0];
+}
 
+void CNetReplayTurnManager::StoreFinalReplayTurn(u32 turn)
+{
+    m_FinalReplayTurn = turn;
+}
+void CNetReplayTurnManager::NotifyFinishedUpdate(u32 turn)
+{
+    if (turn > m_FinalReplayTurn)
+        return;
+
+    DoTurn(turn);
+
+    // Compare hash, if it exists in the replay
+    if (m_ReplayHash.count(turn) == 0)
+        return;
+
+    std::string hash = m_ReplayHash[turn].first;
+    bool quick = m_ReplayHash[turn].second;
 
+    // Compute hash
+    std::string expectedHash;
+    bool ok = m_Simulation2.ComputeStateHash(expectedHash, quick);
+    expectedHash = Hexify(expectedHash);
+    ENSURE(ok);
+
+    if (hash != expectedHash)
+        debug_printf("Hash mismatch on turn %d (expected %s) (current %s)\n", turn, expectedHash.c_str(), hash.c_str());
+}
+
+void CNetReplayTurnManager::DoTurn(u32 turn)
+{
+    m_TurnLength = m_ReplayTurnLengths[turn];
+
+    // Add commands
+    std::map<int, std::vector<std::string> > playerCommands = m_ReplayCommands[turn];
+    std::map<int, std::vector<std::string> >::iterator it;
+    for (it = playerCommands.begin(); it != playerCommands.end(); ++it)
+    {
+        int player = it->first;
+        for (size_t i = 0; i < it->second.size(); ++i)
+        {
+            JS::RootedValue data(m_Simulation2.GetScriptInterface().GetContext());
+            m_Simulation2.GetScriptInterface().ParseJSON(it->second[i], &data);
+            AddCommand(m_ClientId, player, data, m_CurrentTurn + 1);
+        }
+    }
+}
 
 CNetServerTurnManager::CNetServerTurnManager(CNetServerWorker& server) :
     m_NetServer(server), m_ReadyTurn(1), m_TurnLength(DEFAULT_TURN_LENGTH_MP)
 {
     // The first turn we will actually execute is number 2,

source/network/NetTurnManager.h

@@ -20 +20 @@
 
 #include "simulation2/helpers/SimulationCommand.h"
 
 #include <list>
 #include <map>
-
+#include <vector>
 class CNetServerWorker;
 class CNetClient;
 class CSimulationMessage;
 class CSimulation2;
 class IReplayLogger;
@@ -187 +187 @@
     std::list<std::string> m_TimeWarpStates;
     std::string m_QuickSaveState; // TODO: should implement a proper disk-based quicksave system
     std::string m_QuickSaveMetadata;
 };
 
+
 /**
  * Implementation of CNetTurnManager for network clients.
  */
 class CNetClientTurnManager : public CNetTurnManager
 {
@@ -231 +232 @@
 
     virtual void NotifyFinishedUpdate(u32 turn);
 };
 
 
+
+/**
+ * Implementation of CNetTurnManager for replay games.
+ */
+class CNetReplayTurnManager : public CNetLocalTurnManager
+{
+public:
+    CNetReplayTurnManager(CSimulation2& simulation, IReplayLogger& replay);
+
+    void StoreReplayCommand(u32 turn, int player, const std::string& command);
+
+    void StoreReplayTurnLength(u32 turn, u32 turnLength);
+
+    void StoreReplayHash(u32 turn, const std::string& hash, bool quick);
+
+    void StoreFinalReplayTurn(u32 turn);
+
+
+protected:
+    virtual void NotifyFinishedUpdate(u32 turn);
+
+    void DoTurn(u32 turn);
+
+    // Contains the commands of every player on each turn
+    std::map<u32, std::map<int, std::vector<std::string> > > m_ReplayCommands;
+
+    // Contains the length of every turn
+    std::map<u32, u32 > m_ReplayTurnLengths;
+
+    // Contains all replay hash values and weather or not the quick hash method was used
+    std::map<u32, std::pair<std::string, bool> > m_ReplayHash;
+
+    // The number of the last turn in the replay
+    u32 m_FinalReplayTurn;
+
+};
 /**
  * The server-side counterpart to CNetClientTurnManager.
  * Records the turn state of each client, and sends turn advancement messages
  * when all clients are ready.
  *

source/ps/Game.cpp

@@ -61 +61 @@
 
 /**
  * Constructor
  *
  **/
-CGame::CGame(bool disableGraphics):
+CGame::CGame(bool disableGraphics, bool replayLog):
     m_World(new CWorld(this)),
     m_Simulation2(new CSimulation2(&m_World->GetUnitManager(), g_ScriptRuntime, m_World->GetTerrain())),
     m_GameView(disableGraphics ? NULL : new CGameView(this)),
     m_GameStarted(false),
     m_Paused(false),
     m_SimRate(1.0f),
     m_PlayerID(-1),
-    m_IsSavedGame(false)
+    m_IsSavedGame(false),
+    m_IsReplay(false),
+    m_ReplayStream(NULL)
 {
-    m_ReplayLogger = new CReplayLogger(m_Simulation2->GetScriptInterface());
     // TODO: should use CDummyReplayLogger unless activated by cmd-line arg, perhaps?
+    if (replayLog)
+        m_ReplayLogger = new CReplayLogger(m_Simulation2->GetScriptInterface());
+    else
+        m_ReplayLogger = new CDummyReplayLogger();
 
     // Need to set the CObjectManager references after various objects have
     // been initialised, so do it here rather than via the initialisers above.
     if (m_GameView)
         m_World->GetUnitManager().SetObjectManager(m_GameView->GetObjectManager());
 
     m_TurnManager = new CNetLocalTurnManager(*m_Simulation2, GetReplayLogger()); // this will get replaced if we're a net server/client
 
     m_Simulation2->LoadDefaultScripts();
 }
+int CGame::LoadReplayData()
+{
+    ENSURE(m_IsReplay);
+    ENSURE(!m_ReplayPath.empty());
+
+    CNetReplayTurnManager* replayTurnMgr = static_cast<CNetReplayTurnManager*>(GetTurnManager());
+
+    u32 currentTurn = 0;
+    std::string type;
+    while ((*m_ReplayStream >> type).good())
+    {
+        if (type == "turn")
+        {
+            u32 turn = 0;
+            u32 turnLength = 0;
+            *m_ReplayStream >> turn >> turnLength;
+            ENSURE(turn == currentTurn);
+            replayTurnMgr->StoreReplayTurnLength(currentTurn, turnLength);
+        }
+        else if (type == "cmd")
+        {
+            int player;
+            *m_ReplayStream >> player;
+
+            std::string line;
+            std::getline(*m_ReplayStream, line);
+            replayTurnMgr->StoreReplayCommand(currentTurn, player, line);
+        }
+        else if (type == "hash" || type == "hash-quick")
+        {
+            bool quick = (type == "hash-quick");
+            std::string replayHash;
+            *m_ReplayStream >> replayHash;
+            replayTurnMgr->StoreReplayHash(currentTurn, replayHash, quick);
+        }
+        else if (type == "end")
+        {
+            currentTurn++;
+        }
+        else
+        {
+            CancelLoad(L"Failed to load replay data (unrecognized content)");
+        }
+    }
+    m_FinalReplayTurn = currentTurn;
+    replayTurnMgr->StoreFinalReplayTurn(currentTurn);
+    return 0;
+}
+void CGame::StartReplay(const std::string& replayPath)
+{
+    m_IsReplay = true;
+    ScriptInterface& scriptInterface = m_Simulation2->GetScriptInterface();
+
+    SetTurnManager(new CNetReplayTurnManager(*m_Simulation2, GetReplayLogger()));
+
+    // TODO: IF FILE m_ReplayPath NOT EXISTS PRINT ERROR
 
+    m_ReplayPath = replayPath;
+    m_ReplayStream = new std::ifstream(m_ReplayPath.c_str());
+    if (!m_ReplayStream->good())
+    {
+        debug_printf("Could not open replay file!\n");
+        //TODO: how to exit properly? std::exit(0);?
+        ENSURE(m_ReplayStream->good());
+    }
+
+    std::string type;
+    ENSURE((*m_ReplayStream >> type).good() && type == "start");
+
+    std::string line;
+    std::getline(*m_ReplayStream, line);
+    JS::RootedValue attribs(scriptInterface.GetContext());
+    scriptInterface.ParseJSON(line, &attribs);
+    StartGame(&attribs, "");
+}
 /**
  * Destructor
  *
  **/
 CGame::~CGame()
@@ -99 +178 @@
     delete m_TurnManager;
     delete m_GameView;
     delete m_Simulation2;
     delete m_World;
     delete m_ReplayLogger;
+    delete m_ReplayStream;
 }
 
 void CGame::SetTurnManager(CNetTurnManager* turnManager)
 {
     if (m_TurnManager)
@@ -174 +254 @@
         RegMemFun(g_Renderer.GetSingletonPtr()->GetWaterManager(), &WaterManager::LoadWaterTextures, L"LoadWaterTextures", 80);
 
     if (m_IsSavedGame)
         RegMemFun(this, &CGame::LoadInitialState, L"Loading game", 1000);
 
+    if (m_IsReplay)
+        RegMemFun(this, &CGame::LoadReplayData, L"Loading replay data", 1000);
+
     LDR_EndRegistering();
 }
 
 int CGame::LoadInitialState()
 {
@@ -270 +353 @@
         m_TurnManager->SetPlayerID(m_PlayerID);
 }
 
 void CGame::StartGame(JS::MutableHandleValue attribs, const std::string& savedState)
 {
+    if (m_ReplayLogger != false)
     m_ReplayLogger->StartGame(attribs);
+
     RegisterInit(attribs, savedState);
 }
 
 // TODO: doInterpolate is optional because Atlas interpolates explicitly,
 // so that it has more control over the update rate. The game might want to
@@ -308 +393 @@
         {
             {
                 PROFILE3("gui sim update");
                 g_GUI->SendEventToAll("SimulationUpdate");
             }
+             if (m_IsReplay && m_TurnManager->GetCurrentTurn() == m_FinalReplayTurn)
+                 g_GUI->SendEventToAll("ReplayFinished");
 
             GetView()->GetLOSTexture().MakeDirty();
         }
         
         if (CRenderer::IsInitialised())

source/ps/Game.h

@@ -18 +18 @@
 #ifndef INCLUDED_GAME
 #define INCLUDED_GAME
 
 #include "ps/Errors.h"
 #include <vector>
-
+#include <map>
 #include "scriptinterface/ScriptVal.h"
 
 class CWorld;
 class CSimulation2;
 class CGameView;
@@ -63 +63 @@
     int m_PlayerID;
 
     CNetTurnManager* m_TurnManager;
 
 public:
-    CGame(bool disableGraphics = false);
+    CGame(bool disableGraphics = false, bool replayLog = true);
     ~CGame();
 
     /**
      * the game is paused and no updates will be performed if true.
      **/
     bool m_Paused;
 
     void StartGame(JS::MutableHandleValue attribs, const std::string& savedState);
     PSRETURN ReallyStartGame();
 
+    void StartReplay(const std::string& replayPath);
+
     /**
      * Periodic heartbeat that controls the process. performs all per-frame updates.
      * Simulation update is called and game status update is called.
      *
      * @param deltaRealTime Elapsed real time since last beat/frame, in seconds.
@@ -169 +171 @@
     std::vector<CColor> m_PlayerColors;
 
     int LoadInitialState();
     std::string m_InitialSavedState; // valid between RegisterInit and LoadInitialState
     bool m_IsSavedGame; // true if loading a saved game; false for a new game
+
+    int LoadReplayData();
+    std::string m_ReplayPath;
+    bool m_IsReplay;
+    std::istream* m_ReplayStream;
+    u32 m_FinalReplayTurn;
 };
 
 extern CGame *g_Game;
 
 #endif

source/ps/GameSetup/GameSetup.cpp

@@ -878 +878 @@
     // Initialise the low-quality rand function
     srand(time(NULL));  // NOTE: this rand should *not* be used for simulation!
 }
 
 bool Autostart(const CmdLineArgs& args);
+bool VisualReplay(const CmdLineArgs& args);
 
 bool Init(const CmdLineArgs& args, int flags)
 {
     h_mgr_init();
 
@@ -1071 +1072 @@
 
     ogl_WarnIfError();
 
     try
     {
-        if (!Autostart(args))
+        if (!VisualReplay(args) && !Autostart(args))
         {
             const bool setup_gui = ((flags & INIT_NO_GUI) == 0);
             // We only want to display the splash screen at startup
             shared_ptr<ScriptInterface> scriptInterface = g_GUI->GetScriptInterface();
             JSContext* cx = scriptInterface->GetContext();
@@ -1471 +1472 @@
     }
 
     return true;
 }
 
+bool VisualReplay(const CmdLineArgs& args)
+{
+    CStr replayPath = args.Get("replay-visual");
+
+    if (replayPath.empty())
+         return false;
+
+    g_Game = new CGame(false, false);
+
+    g_Game->SetPlayerID(-1);
+    g_Game->StartReplay(replayPath);
+
+    // TODO: Non progressive load can fail - need a decent way to handle this
+    LDR_NonprogressiveLoad();
+
+    PSRETURN ret = g_Game->ReallyStartGame();
+    ENSURE(ret == PSRETURN_OK);
+
+    ScriptInterface& scriptInterface = g_Game->GetSimulation2()->GetScriptInterface();
+
+    InitPs(true, L"page_session.xml", &scriptInterface, JS::UndefinedHandleValue);
+    return true;
+}
+
 void CancelLoad(const CStrW& message)
 {
     shared_ptr<ScriptInterface> pScriptInterface = g_GUI->GetActiveGUI()->GetScriptInterface();
     JSContext* cx = pScriptInterface->GetContext();
     JSAutoRequest rq(cx);

source/ps/Replay.h

@@ -54 +54 @@
  */
 class CDummyReplayLogger : public IReplayLogger
 {
 public:
     virtual void StartGame(JS::MutableHandleValue UNUSED(attribs)) { }
-    virtual void Turn(u32 UNUSED(n), u32 UNUSED(turnLength), const std::vector<SimulationCommand>& UNUSED(commands)) { }
+    virtual void Turn(u32 UNUSED(n), u32 UNUSED(turnLength), std::vector<SimulationCommand>& UNUSED(commands)) { }
     virtual void Hash(const std::string& UNUSED(hash), bool UNUSED(quick)) { }
 };
 
 /**
  * Implementation of IReplayLogger that saves data to a file in the logs directory.