[savestates] Added game state persistence built on a new save game da…

…tabase. RetroPlayer can automatically load previous game state on file open, and 9 slots are available for hotkey-based save state storage.

Makefile.in

@@ -50,6 +50,7 @@ DIRECTORY_ARCHIVES=$(DVDPLAYER_ARCHIVES) \
                    xbmc/filesystem/filesystem.a \
                    xbmc/games/games.a \
                    xbmc/games/libretro/libretro.a \
+                   xbmc/games/savegames/savegames.a \
                    xbmc/games/tags/gameinfotags.a \
                    xbmc/games/windows/gamewindows.a \
                    xbmc/guilib/guilib.a \

language/English/strings.po

@@ -5978,7 +5978,29 @@ msgctxt "#15022"
 msgid "Maximum rewind time"
 msgstr ""
 
-#empty strings from id 15023 to 15051
+#empty string with id 15023
+
+#: xbmc/settings/GUISettings.cpp
+msgctxt "#15024"
+msgid "Automatically load previous game state"
+msgstr ""
+
+#: xbmc/settings/GUISettings.cpp
+msgctxt "#15025"
+msgid "Save game state every 30 seconds"
+msgstr ""
+
+#: xbmc/games/savegames/Savegame.cpp
+msgctxt "#15026"
+msgid "Autosave on %s"
+msgstr ""
+
+#: xbmc/games/savegames/Savegame.cpp
+msgctxt "#15027"
+msgid "Slot %d"
+msgstr ""
+
+#empty strings from id 15028 to 15051
 
 msgctxt "#15052"
 msgid "Password"

project/VS2010Express/XBMC.vcxproj

@@ -600,6 +600,8 @@
     <ClCompile Include="..\..\xbmc\games\GameFileLoader.cpp" />
     <ClCompile Include="..\..\xbmc\games\GameManager.cpp" />
     <ClCompile Include="..\..\xbmc\games\libretro\LibretroEnvironment.cpp" />
+    <ClCompile Include="..\..\xbmc\games\savegames\SavestateDatabase.cpp" />
+    <ClCompile Include="..\..\xbmc\games\savegames\Savestate.cpp" />
     <ClCompile Include="..\..\xbmc\games\SerialState.cpp" />
     <ClCompile Include="..\..\xbmc\games\windows\GUIViewStateWindowGames.cpp" />
     <ClCompile Include="..\..\xbmc\games\windows\GUIWindowGames.cpp" />
@@ -1079,6 +1081,8 @@
     <ClInclude Include="..\..\xbmc\games\GameManager.h" />
     <ClInclude Include="..\..\xbmc\games\libretro\libretro.h" />
     <ClInclude Include="..\..\xbmc\games\libretro\LibretroEnvironment.h" />
+    <ClInclude Include="..\..\xbmc\games\savegames\SavestateDatabase.h" />
+    <ClInclude Include="..\..\xbmc\games\savegames\Savestate.h" />
     <ClInclude Include="..\..\xbmc\games\SerialState.h" />
     <ClInclude Include="..\..\xbmc\games\windows\GUIViewStateWindowGames.h" />
     <ClInclude Include="..\..\xbmc\games\windows\GUIWindowGames.h" />

project/VS2010Express/XBMC.vcxproj.filters

@@ -304,6 +304,9 @@
     <Filter Include="dbwrappers\test">
       <UniqueIdentifier>{43dbf5f1-ffdc-4fd5-8f6c-5f38f89b192f}</UniqueIdentifier>
     </Filter>
+    <Filter Include="games\savegames">
+      <UniqueIdentifier>{42e2939e-467c-4c7f-bb3e-b4860c19e9e0}</UniqueIdentifier>
+    </Filter>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="..\..\xbmc\win32\pch.cpp">
@@ -3063,6 +3066,12 @@
     <ClCompile Include="..\..\xbmc\dbwrappers\test\TestDynamicDatabase.cpp">
       <Filter>dbwrappers\test</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\xbmc\games\savegames\SavestateDatabase.cpp">
+      <Filter>games\savegames</Filter>
+    </ClCompile>
+    <ClCompile Include="..\..\xbmc\games\savegames\Savestate.cpp">
+      <Filter>games\savegames</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\..\xbmc\win32\pch.h">
@@ -5972,6 +5981,12 @@
     <ClInclude Include="..\..\xbmc\utils\IDeserializable.h">
       <Filter>utils</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\xbmc\games\savegames\SavestateDatabase.h">
+      <Filter>games\savegames</Filter>
+    </ClInclude>
+    <ClInclude Include="..\..\xbmc\games\savegames\Savestate.h">
+      <Filter>games\savegames</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="..\..\xbmc\win32\XBMC_PC.rc">

system/keymaps/keyboard.xml

@@ -262,6 +262,25 @@
       <d>JoypadY</d>
       <a>JoypadL</a>
       <s>JoypadR</s>
+      <one>Load1</one>
+      <two>Load2</two>
+      <three>Load3</three>
+      <four>Load4</four>
+      <five>Load5</five>
+      <six>Load6</six>
+      <seven>Load7</seven>
+      <eight>Load8</eight>
+      <nine>Load9</nine>
+      <!-- US keyboard. May need changes for other locales -->
+      <exclaim>Save1</exclaim>
+      <at>Save2</at>
+      <hash>Save3</hash>
+      <dollar>Save4</dollar>
+      <percent>Save5</percent>
+      <caret>Save6</caret>
+      <ampersand>Save7</ampersand>
+      <asterisk>Save8</asterisk>
+      <leftbracket>Save9</leftbracket>
     </keyboard>
   </FullscreenGame>
   <VideoTimeSeek>

xbmc/Application.cpp

@@ -2890,6 +2890,13 @@ bool CApplication::OnAction(const CAction &action)
     }
   }
 
+  if (IsPlayingGame() && ((ACTION_SAVE <= action.GetID() && action.GetID() <= ACTION_SAVE9) ||
+                          (ACTION_LOAD <= action.GetID() && action.GetID() <= ACTION_LOAD9)))
+  {
+    m_pPlayer->OnAction(action.GetID());
+    return true;
+  }
+
   if (g_peripherals.OnAction(action))
     return true;
 

xbmc/DatabaseManager.cpp

@@ -27,6 +27,7 @@
 #include "video/VideoDatabase.h"
 #include "pvr/PVRDatabase.h"
 #include "epg/EpgDatabase.h"
+#include "games/savegames/SavestateDatabase.h"
 #include "settings/AdvancedSettings.h"
 
 using namespace std;
@@ -63,6 +64,7 @@ void CDatabaseManager::Initialize(bool addonsOnly)
   { CVideoDatabase db; UpdateDatabase(db, &g_advancedSettings.m_databaseVideo); }
   { CPVRDatabase db; UpdateDatabase(db, &g_advancedSettings.m_databaseTV); }
   { CEpgDatabase db; UpdateDatabase(db, &g_advancedSettings.m_databaseEpg); }
+  { CSavestateDatabase db; UpdateDatabase(db, &g_advancedSettings.m_databaseSavestates); }
   CLog::Log(LOGDEBUG, "%s, updating databases... DONE", __FUNCTION__);
 }
 

xbmc/FileItem.cpp

@@ -534,6 +534,7 @@ const CFileItem& CFileItem::operator=(const CFileItem& item)
   m_lStartOffset = item.m_lStartOffset;
   m_lStartPartNumber = item.m_lStartPartNumber;
   m_lEndOffset = item.m_lEndOffset;
+  m_startSaveState = item.m_startSaveState;
   m_strDVDLabel = item.m_strDVDLabel;
   m_strTitle = item.m_strTitle;
   m_iprogramCount = item.m_iprogramCount;
@@ -571,6 +572,7 @@ void CFileItem::Reset()
   m_lStartOffset = 0;
   m_lStartPartNumber = 1;
   m_lEndOffset = 0;
+  m_startSaveState.Empty();
   m_iprogramCount = 0;
   m_idepth = 1;
   m_iLockMode = LOCK_MODE_EVERYONE;
@@ -621,6 +623,7 @@ void CFileItem::Archive(CArchive& ar)
     ar << m_lStartOffset;
     ar << m_lStartPartNumber;
     ar << m_lEndOffset;
+    ar << m_startSaveState;
     ar << m_iLockMode;
     ar << m_strLockCode;
     ar << m_iBadPwdCount;
@@ -675,6 +678,7 @@ void CFileItem::Archive(CArchive& ar)
     ar >> m_lStartOffset;
     ar >> m_lStartPartNumber;
     ar >> m_lEndOffset;
+    ar >> m_startSaveState;
     int temp;
     ar >> temp;
     m_iLockMode = (LockType)temp;

xbmc/FileItem.h

@@ -398,6 +398,7 @@ class CFileItem :
   int m_lStartOffset;
   int m_lStartPartNumber;
   int m_lEndOffset;
+  CStdString m_startSaveState;
   LockType m_iLockMode;
   CStdString m_strLockCode;
   int m_iHasLock; // 0 - no lock 1 - lock, but unlocked 2 - locked

xbmc/GUIInfoManager.cpp

@@ -4346,6 +4346,12 @@ CStdString CGUIInfoManager::GetItemLabel(const CFileItem *item, int info, CStdSt
         if (item->GetMusicInfoTag()->GetDuration() > 0)
           duration = StringUtils::SecondsToTimeString(item->GetMusicInfoTag()->GetDuration());
       }
+      else if (item->HasProperty("duration"))
+      {
+        // The "duration" property is set for savestate file items, as they
+        // have no dedicated info tag.
+        duration = StringUtils::SecondsToTimeString((long)item->GetProperty("duration").asInteger());
+      }
       return duration;
     }
   case LISTITEM_PLOT:

xbmc/cores/RetroPlayer/RetroPlayer.cpp

@@ -33,6 +33,7 @@
 #include "guilib/GUIWindowManager.h"
 #include "guilib/Key.h"
 #include "settings/GUISettings.h"
+#include "threads/SystemClock.h" // Should auto-save tracking be in GameClient.cpp?
 #include "URL.h"
 #include "utils/log.h"
 #include "utils/StringUtils.h"
@@ -72,7 +73,17 @@ bool CRetroPlayer::OpenFile(const CFileItem& file, const CPlayerOptions& options
   m_bStop = false;
 
   if (IsRunning())
+  {
+    // If the same file was provided, load the appropriate save state
+    if (m_gameClient && file.GetPath().Equals(m_file.GetPath()))
+    {
+      if (!file.m_startSaveState.empty())
+        return m_gameClient->Load(file.m_startSaveState);
+      else
+        return m_gameClient->AutoLoad();
+    }
     CloseFile();
+  }
 
   // Get game info tag (from a mutable file item, if necessary)
   const GAME_INFO::CGameInfoTag *tag = file.GetGameInfoTag();
@@ -203,6 +214,7 @@ bool CRetroPlayer::InstallGameClient(CFileItem file, GameClientPtr &result) cons
         }
       }
     }
+
     file.ClearProperty("gameclient"); // don't want this to interfere later on
   }
 
@@ -401,6 +413,38 @@ bool CRetroPlayer::OnAction(const CAction &action)
   if (!IsPlaying())
     return false;
 
+  switch (action.GetID())
+  {
+  case ACTION_SAVE:
+    return m_gameClient->AutoSave();
+  case ACTION_SAVE1:
+  case ACTION_SAVE2:
+  case ACTION_SAVE3:
+  case ACTION_SAVE4:
+  case ACTION_SAVE5:
+  case ACTION_SAVE6:
+  case ACTION_SAVE7:
+  case ACTION_SAVE8:
+  case ACTION_SAVE9:
+    return m_gameClient->Save(action.GetID() - ACTION_SAVE1 + 1);
+  case ACTION_LOAD:
+    if (m_playSpeed <= 0)
+      ToFFRW(1);
+    return m_gameClient->AutoLoad();
+  case ACTION_LOAD1:
+  case ACTION_LOAD2:
+  case ACTION_LOAD3:
+  case ACTION_LOAD4:
+  case ACTION_LOAD5:
+  case ACTION_LOAD6:
+  case ACTION_LOAD7:
+  case ACTION_LOAD8:
+  case ACTION_LOAD9:
+    if (m_playSpeed <= 0)
+      ToFFRW(1);
+    return m_gameClient->Load(action.GetID() - ACTION_LOAD1 + 1);
+  }
+
   return false;
 }
 
@@ -441,6 +485,8 @@ void CRetroPlayer::Process()
 
   m_video.GoForth(framerate, m_PlayerOptions.fullscreen);
 
+  unsigned int saveTimer = XbmcThreads::SystemClockMillis();
+
   const double frametime = 1000 * 1000 / framerate; // microseconds
   double nextpts = CDVDClock::GetAbsoluteClock() + frametime;
   CLog::Log(LOGDEBUG, "RetroPlayer: Beginning loop de loop");
@@ -469,6 +515,13 @@ void CRetroPlayer::Process()
     // If the game client uses single frame audio, render those now
     m_audio.Flush();
 
+    if (g_guiSettings.GetBool("games.autosave") &&
+      XbmcThreads::SystemClockMillis() - saveTimer > 30000) // every 30 seconds
+    {
+      m_gameClient->AutoSave();
+      saveTimer = XbmcThreads::SystemClockMillis();
+    }
+
     // Slow down (increase nextpts) if we're playing catchup after stalling
     if (nextpts < CDVDClock::GetAbsoluteClock())
       nextpts = CDVDClock::GetAbsoluteClock();
@@ -485,6 +538,8 @@ void CRetroPlayer::Process()
   }
 
   m_bStop = true;
+
+  // Save the game before the video cuts out
   m_gameClient->CloseFile();
 
   m_video.StopThread(true);

xbmc/cores/RetroPlayer/RetroPlayer.h

@@ -113,6 +113,9 @@ class CRetroPlayer : public IPlayer, public CThread
   virtual int64_t GetTime();
   virtual int64_t GetTotalTime();
 
+  bool Save(unsigned int slot) { return m_gameClient && m_gameClient->Save(slot); }
+  bool Save(const CStdString &label) { return m_gameClient && m_gameClient->Save(label); }
+  bool Load(const CStdString &saveStatePath) { return m_gameClient && m_gameClient->Load(saveStatePath); }
 
 protected:
   virtual void Process();

xbmc/filesystem/SpecialProtocol.cpp

@@ -134,6 +134,8 @@ CStdString CSpecialProtocol::TranslatePath(const CURL &url)
     URIUtils::AddFileToFolder(g_settings.GetDatabaseFolder(), FileName, translatedPath);
   else if (RootDir.Equals("thumbnails"))
     URIUtils::AddFileToFolder(g_settings.GetThumbnailsFolder(), FileName, translatedPath);
+  else if (RootDir.Equals("savegames"))
+    URIUtils::AddFileToFolder(g_settings.GetSavegamesFolder(), FileName, translatedPath);
   else if (RootDir.Equals("recordings") || RootDir.Equals("cdrips"))
     URIUtils::AddFileToFolder(g_guiSettings.GetString("audiocds.recordingpath", false), FileName, translatedPath);
   else if (RootDir.Equals("screenshots"))