Ticket #9: visualreplay-WIP-r16530.patch

source/network/NetTurnManager.cpp

@@ -455 +455 @@
         bool ok = m_Simulation2.ComputeStateHash(hash);
         ENSURE(ok);
     }
     m_Replay.Hash(hash);
 #endif
 }
 
 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;
+}
 
+void CNetReplayTurnManager::StoreFinalReplayTurn(u32 turn)
+{
+    m_FinalReplayTurn = turn;
+}
+void CNetReplayTurnManager::NotifyFinishedUpdate(u32 turn)
+{
+    // TODO: replay starts with turn 0, not 1
+    turn--;
 
+    // TODO: this also doesnt seem right, should be > instead of >= but goes one element too far otherwise
+    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);
+
+    // TODO: currently an OOS occurs on every turn
+    // debug_printf("Comparing hash %s with %s\n", expectedHash.c_str(), hash.c_str());
+
+    if (hash != expectedHash)
+    {
+        // TODO: THROW ERROR MESSAGE, send net message?
+    }
+
+}
+
+void CNetReplayTurnManager::DoTurn(u32 turn)
+{
+    // set turn length
+    m_TurnLength = m_ReplayTurnLengths[turn];
+
+    // debug_printf("For turn %d setting turn length to %d\n", turn, m_TurnLength);
+
+    // 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,
     // so store dummy values into the saved lengths list
     m_SavedTurnLengths.push_back(0);
     m_SavedTurnLengths.push_back(0);
 }
 
 void CNetServerTurnManager::NotifyFinishedClientCommands(int client, u32 turn)
 {

source/network/NetTurnManager.h

@@ -13 +13 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef INCLUDED_NETTURNMANAGER
 #define INCLUDED_NETTURNMANAGER
 
 #include "simulation2/helpers/SimulationCommand.h"
 
 #include <list>
 #include <map>
-
+#include <vector>
 class CNetServerWorker;
 class CNetClient;
 class CSimulationMessage;
 class CSimulation2;
 class IReplayLogger;
 
 /*
  * This file deals with the logic of the network turn system. The basic idea is as in
  * http://www.gamasutra.com/view/feature/3094/1500_archers_on_a_288_network_.php?print=1
  *
  * Each player performs the simulation for turn N.
  * User input is translated into commands scheduled for execution in turn N+2 which are
@@ -180 +180 @@
 
     bool m_HasSyncError;
 
     IReplayLogger& m_Replay;
 
 private:
     size_t m_TimeWarpNumTurns; // 0 if disabled
     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
 {
 public:
     CNetClientTurnManager(CSimulation2& simulation, CNetClient& client, int clientId, IReplayLogger& replay);
 
     virtual void OnSimulationMessage(CSimulationMessage* msg);
 
     virtual void PostCommand(JS::HandleValue data);
     
@@ -224 +225 @@
 
     virtual void OnSimulationMessage(CSimulationMessage* msg);
 
     virtual void PostCommand(JS::HandleValue data);
 
 protected:
     virtual void NotifyFinishedOwnCommands(u32 turn);
 
     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.
  *
  * Thread-safety:
  * - This is constructed and used by CNetServerWorker in the network server thread.
  */
 class CNetServerTurnManager
 {
     NONCOPYABLE(CNetServerTurnManager);
 public:

source/ps/Game.cpp

@@ -54 +54 @@
 extern bool g_GameRestarted;
 extern GameLoopState* g_AtlasGameLoop;
 
 /**
  * Globally accessible pointer to the CGame object.
  **/
 CGame *g_Game=NULL;
 
 /**
  * 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 + 1;
+    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()
 {
     // Again, the in-game call tree is going to be different to the main menu one.
     if (CProfileManager::IsInitialised())
         g_Profiler.StructuralReset();
 
     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)
         delete m_TurnManager;
 
     m_TurnManager = turnManager;
 
     if (m_TurnManager)
         m_TurnManager->SetPlayerID(m_PlayerID);
 }
@@ -167 +247 @@
         JS::RootedValue settings(cx);
         scriptInterface.GetProperty(attribs, "map", mapFile);
         scriptInterface.GetProperty(attribs, "settings", &settings);
 
         m_World->RegisterInit(mapFile, scriptInterface.GetJSRuntime(), settings, m_PlayerID);
     }
     if (m_GameView)
         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()
 {
     ENSURE(m_IsSavedGame);
     ENSURE(!m_InitialSavedState.empty());
 
     std::string state;
     m_InitialSavedState.swap(state); // deletes the original to save a bit of memory
 
     std::stringstream stream(state);
@@ -263 +346 @@
     return m_PlayerID;
 }
 
 void CGame::SetPlayerID(int playerID)
 {
     m_PlayerID = playerID;
     if (m_TurnManager)
         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
 // do the same, and then doInterpolate should be redundant and removed.
 
 bool CGame::Update(const double deltaRealTime, bool doInterpolate)
 {
     if (m_Paused)
         return true;
 
@@ -301 +386 @@
         // At the normal sim rate, we currently want to render at least one
         // frame per simulation turn, so let maxTurns be 1. But for fast-forward
         // sim rates we want to allow more, so it's not bounded by framerate,
         // so just use the sim rate itself as the number of turns per frame.
         size_t maxTurns = (size_t)m_SimRate;
 
         if (m_TurnManager->Update(deltaSimTime, maxTurns))
         {
             {
                 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())
             g_Renderer.GetTimeManager().Update(deltaSimTime);
     }
 
     if (doInterpolate)
     {
         m_TurnManager->Interpolate(deltaSimTime, deltaRealTime);
 

source/ps/Game.h

@@ -11 +11 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef INCLUDED_GAME
 #define INCLUDED_GAME
 
 #include "ps/Errors.h"
 #include <vector>
-
+#include <map>
 #include "scriptinterface/ScriptVal.h"
 
 class CWorld;
 class CSimulation2;
 class CGameView;
 class CNetTurnManager;
 class IReplayLogger;
 struct CColor;
 
 /**
  * The container that holds the rules, resources and attributes of the game.
  * The CGame object is responsible for creating a game that is defined by
@@ -56 +56 @@
      **/
     bool m_GameStarted;
     /**
      * Timescale multiplier for simulation rate.
      **/
     float m_SimRate;
 
     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.
      * @param doInterpolate Perform graphics interpolation if true.
      * @return bool false if it can't keep up with the desired simulation rate
      *  indicating that you might want to render less frequently.
      */
     bool Update(const double deltaRealTime, bool doInterpolate = true);
 
     void Interpolate(float simFrameLength, float realFrameLength);
@@ -162 +164 @@
     IReplayLogger& GetReplayLogger() const
     {   return *m_ReplayLogger; }
 
 private:
     void RegisterInit(const JS::HandleValue attribs, const std::string& savedState);
     IReplayLogger* m_ReplayLogger;
 
     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

@@ -871 +871 @@
     // before launching Atlas)
 #if MUST_INIT_X11
     int status = XInitThreads();
     if (status == 0)
         debug_printf("Error enabling thread-safety via XInitThreads\n");
 #endif
 
     // 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();
 
     // Do this as soon as possible, because it chdirs
     // and will mess up the error reporting if anything
     // crashes before the working directory is set.
     InitVfs(args, flags);
 
     // This must come after VFS init, which sets the current directory
     // (required for finding our output log files).
@@ -1064 +1065 @@
         g_Shadows = false;
     }
 
     ogl_WarnIfError();
     InitRenderer();
 
     InitInput();
 
     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();
             JSAutoRequest rq(cx);
             JS::RootedValue data(cx);
             if (g_GUI)
             {
                 scriptInterface->Eval("({})", &data);
                 scriptInterface->SetProperty(data, "isStartup", true);
             }
@@ -1464 +1465 @@
 
         LDR_NonprogressiveLoad();
 
         PSRETURN ret = g_Game->ReallyStartGame();
         ENSURE(ret == PSRETURN_OK);
 
         InitPs(true, L"page_session.xml", NULL, JS::UndefinedHandleValue);
     }
 
     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);
     
     JS::RootedValue global(cx, pScriptInterface->GetGlobalObject());
     // Cancel loader
     LDR_Cancel();
 
     // Call the cancelOnError GUI function, defined in ..gui/common/functions_utility_error.js
     // So all GUI pages that load games should include this script

source/ps/Replay.h

@@ -47 +47 @@
      * Optional hash of simulation state (for sync checking).
      */
     virtual void Hash(const std::string& hash, bool quick) = 0;
 };
 
 /**
  * Implementation of IReplayLogger that simply throws away all data.
  */
 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.
  */
 class CReplayLogger : public IReplayLogger
 {
     NONCOPYABLE(CReplayLogger);
 public:
     CReplayLogger(ScriptInterface& scriptInterface);
     ~CReplayLogger();